mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
RHDEVDOCS-4281: Adding content for enabling or disabling Developer catalogs or sub-catalogs
This commit is contained in:
dsoni@redhat.com
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
2f19f5e159
commit
96821f773b
BIN
images/odc_customizing_developer_catalog.png
Normal file
BIN
images/odc_customizing_developer_catalog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.4 KiB |
@@ -0,0 +1,30 @@
|
||||
// Module included in the following assembly:
|
||||
//
|
||||
// * web_console/customizing-the-web-console.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
|
||||
[id="odc_con_customizing-a-developer-catalog-or-its-sub-catalogs_{context}"]
|
||||
= Developer catalog and sub-catalog customization
|
||||
|
||||
As a cluster administrator, you have the ability to organize and manage the Developer catalog or its sub-catalogs. You can enable or disable the sub-catalog types or disable the entire developer catalog.
|
||||
|
||||
The `developerCatalog.types` object includes the following parameters that you must define in a snippet to use them in the YAML view:
|
||||
|
||||
* `state`: Defines if a list of developer catalog types should be enabled or disabled.
|
||||
* `enabled`: Defines a list of developer catalog types (sub-catalogs) that are visible to users.
|
||||
* `disabled`: Defines a list of developer catalog types (sub-catalogs) that are not visible to users.
|
||||
|
||||
You can enable or disable the following developer catalog types (sub-catalogs) using the YAML view or the form view.
|
||||
|
||||
* `Builder Images`
|
||||
* `Templates`
|
||||
* `Devfiles`
|
||||
* `Samples`
|
||||
* `Helm Charts`
|
||||
* `Event Sources`
|
||||
* `Event Sinks`
|
||||
* `Operator Backed`
|
||||
|
||||
|
||||
|
||||
63
modules/odc_con_example-yaml-file-changes.adoc
Normal file
63
modules/odc_con_example-yaml-file-changes.adoc
Normal file
@@ -0,0 +1,63 @@
|
||||
// Module included in the following assembly:
|
||||
//
|
||||
// * web_console/customizing-the-web-console.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
|
||||
[id="con_example-yaml-file-changes_{context}"]
|
||||
= Example YAML file changes
|
||||
|
||||
You can dynamically add the following snippets in the YAML editor for customizing a developer catalog.
|
||||
|
||||
Use the following snippet to display all the sub-catalogs by setting the _state_ type to *Enabled*.
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: Console
|
||||
metadata:
|
||||
name: cluster
|
||||
...
|
||||
spec:
|
||||
customization:
|
||||
developerCatalog:
|
||||
categories:
|
||||
types:
|
||||
state: Enabled
|
||||
----
|
||||
|
||||
Use the following snippet to disable all sub-catalogs by setting the _state_ type to *Disabled*:
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: Console
|
||||
metadata:
|
||||
name: cluster
|
||||
...
|
||||
spec:
|
||||
customization:
|
||||
developerCatalog:
|
||||
categories:
|
||||
types:
|
||||
state: Disabled
|
||||
----
|
||||
|
||||
Use the following snippet when a cluster administrator defines a list of sub-catalogs, which are enabled in the Web Console.
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: Console
|
||||
metadata:
|
||||
name: cluster
|
||||
...
|
||||
spec:
|
||||
customization:
|
||||
developerCatalog:
|
||||
categories:
|
||||
types:
|
||||
state: Enabled
|
||||
enabled:
|
||||
- BuilderImage
|
||||
- Devfile
|
||||
- HelmChart
|
||||
- ...
|
||||
----
|
||||
@@ -0,0 +1,32 @@
|
||||
// Module included in the following assembly:
|
||||
//
|
||||
// * web_console/customizing-the-web-console.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
|
||||
[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view_{context}"]
|
||||
= Customizing a developer catalog or its sub-catalogs using the form view
|
||||
|
||||
You can customize a developer catalog by using the form view in the Web Console.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* An OpenShift web console session with cluster administrator privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings*.
|
||||
. Select the *Configuration* tab and click the *Console (operator.openshift.io)* resource.
|
||||
. Click *Actions* -> *Customize*.
|
||||
. In the respective sections, enable or disable the items in the list.
|
||||
+
|
||||
.Verification
|
||||
After you have customized the developer catalog, your changes are automatically saved in the system and take effect in the browser after a refresh.
|
||||
+
|
||||
image::odc_customizing_developer_catalog.png[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You can use a similar procedure to customize Web UI items such as Quick starts, Cluster roles, and Actions.
|
||||
====
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
// Module included in the following assembly:
|
||||
//
|
||||
// * web_console/customizing-the-web-console.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
|
||||
[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view_{context}"]
|
||||
= Customizing a developer catalog or its sub-catalogs using the YAML view
|
||||
|
||||
You can customize a developer catalog by editing the YAML content in the YAML view.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* An OpenShift web console session with cluster administrator privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Administrator* perspective of the web console, navigate to *Administration* -> *Cluster Settings*.
|
||||
. Select the *Configuration* tab, click the *Console (operator.openshift.io)* resource and view the *Details* page.
|
||||
. Click the *YAML* tab to open the editor and edit the YAML content as needed.
|
||||
+
|
||||
For example, to disable a developer catalog type, insert the following snippet that defines a list of disabled developer catalog resources:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: Console
|
||||
metadata:
|
||||
name: cluster
|
||||
...
|
||||
spec:
|
||||
customization:
|
||||
developerCatalog:
|
||||
categories:
|
||||
types:
|
||||
state: Disabled
|
||||
disabled:
|
||||
- BuilderImage
|
||||
- Devfile
|
||||
- HelmChart
|
||||
...
|
||||
----
|
||||
|
||||
. Click *Save*.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
By default, the developer catalog types are enabled in the Administrator view of the Web Console.
|
||||
====
|
||||
@@ -32,3 +32,11 @@ include::modules/odc-customizing-user-perspectives.adoc[leveloffset=+1]
|
||||
include::modules/odc-customizing-a-perspective-using-YAML-view.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/odc-customizing-a-perspective-using-form-view.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3]
|
||||
Reference in New Issue
Block a user