diff --git a/images/odc_customizing_developer_catalog.png b/images/odc_customizing_developer_catalog.png new file mode 100644 index 0000000000..8fd236feb7 Binary files /dev/null and b/images/odc_customizing_developer_catalog.png differ diff --git a/modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc b/modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc new file mode 100644 index 0000000000..b58c402f61 --- /dev/null +++ b/modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc @@ -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` + + + diff --git a/modules/odc_con_example-yaml-file-changes.adoc b/modules/odc_con_example-yaml-file-changes.adoc new file mode 100644 index 0000000000..dbb3d53238 --- /dev/null +++ b/modules/odc_con_example-yaml-file-changes.adoc @@ -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 + - ... +---- \ No newline at end of file diff --git a/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc new file mode 100644 index 0000000000..4756f9b4d4 --- /dev/null +++ b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc @@ -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. +==== + diff --git a/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc new file mode 100644 index 0000000000..a7f2041724 --- /dev/null +++ b/modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc @@ -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. +==== \ No newline at end of file diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index 2386eee0ef..7aa95145ef 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -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] \ No newline at end of file