Skip to content

Commit 49f5fab

Browse files
gabriel-rhgabriel-rh
authored
Merge pull request #52218 from Dhruv-Soni11/RHDEVDOCS-4281
RHDEVDOCS-4281: Adding content for enabling or disabling Developer ca…
2 parents fd788cc + 20a467f commit 49f5fab

6 files changed

+182
-0
lines changed

‎images/odc_customizing_developer_catalog.png

7.37 KB
Loading

‎modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assembly:
2+
//
3+
// * web_console/customizing-the-web-console.adoc
4+
5+
:_content-type: CONCEPT
6+
7+
[id="odc_con_customizing-a-developer-catalog-or-its-sub-catalogs_{context}"]
8+
= Developer catalog and sub-catalog customization
9+
10+
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.
11+
12+
The `developerCatalog.types` object includes the following parameters that you must define in a snippet to use them in the YAML view:
13+
14+
* `state`: Defines if a list of developer catalog types should be enabled or disabled.
15+
* `enabled`: Defines a list of developer catalog types (sub-catalogs) that are visible to users.
16+
* `disabled`: Defines a list of developer catalog types (sub-catalogs) that are not visible to users.
17+
18+
You can enable or disable the following developer catalog types (sub-catalogs) using the YAML view or the form view.
19+
20+
* `Builder Images`
21+
* `Templates`
22+
* `Devfiles`
23+
* `Samples`
24+
* `Helm Charts`
25+
* `Event Sources`
26+
* `Event Sinks`
27+
* `Operator Backed`
28+
29+
30+

‎modules/odc_con_example-yaml-file-changes.adoc

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Module included in the following assembly:
2+
//
3+
// * web_console/customizing-the-web-console.adoc
4+
5+
:_content-type: CONCEPT
6+
7+
[id="con_example-yaml-file-changes_{context}"]
8+
= Example YAML file changes
9+
10+
You can dynamically add the following snippets in the YAML editor for customizing a developer catalog.
11+
12+
Use the following snippet to display all the sub-catalogs by setting the _state_ type to *Enabled*.
13+
[source,yaml]
14+
----
15+
apiVersion: operator.openshift.io/v1
16+
kind: Console
17+
metadata:
18+
name: cluster
19+
...
20+
spec:
21+
customization:
22+
developerCatalog:
23+
categories:
24+
types:
25+
state: Enabled
26+
----
27+
28+
Use the following snippet to disable all sub-catalogs by setting the _state_ type to *Disabled*:
29+
[source,yaml]
30+
----
31+
apiVersion: operator.openshift.io/v1
32+
kind: Console
33+
metadata:
34+
name: cluster
35+
...
36+
spec:
37+
customization:
38+
developerCatalog:
39+
categories:
40+
types:
41+
state: Disabled
42+
----
43+
44+
Use the following snippet when a cluster administrator defines a list of sub-catalogs, which are enabled in the Web Console.
45+
[source,yaml]
46+
----
47+
apiVersion: operator.openshift.io/v1
48+
kind: Console
49+
metadata:
50+
name: cluster
51+
...
52+
spec:
53+
customization:
54+
developerCatalog:
55+
categories:
56+
types:
57+
state: Enabled
58+
enabled:
59+
- BuilderImage
60+
- Devfile
61+
- HelmChart
62+
- ...
63+
----

‎modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Module included in the following assembly:
2+
//
3+
// * web_console/customizing-the-web-console.adoc
4+
5+
:_content-type: PROCEDURE
6+
7+
[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view_{context}"]
8+
= Customizing a developer catalog or its sub-catalogs using the form view
9+
10+
You can customize a developer catalog by using the form view in the Web Console.
11+
12+
.Prerequisites
13+
14+
* An OpenShift web console session with cluster administrator privileges.
15+
16+
.Procedure
17+
18+
. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings*.
19+
. Select the *Configuration* tab and click the *Console (operator.openshift.io)* resource.
20+
. Click *Actions* -> *Customize*.
21+
. In the respective sections, enable or disable the items in the list.
22+
+
23+
.Verification
24+
After you have customized the developer catalog, your changes are automatically saved in the system and take effect in the browser after a refresh.
25+
+
26+
image::odc_customizing_developer_catalog.png[]
27+
28+
[NOTE]
29+
====
30+
You can use a similar procedure to customize Web UI items such as Quick starts, Cluster roles, and Actions.
31+
====
32+

‎modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Module included in the following assembly:
2+
//
3+
// * web_console/customizing-the-web-console.adoc
4+
5+
:_content-type: PROCEDURE
6+
7+
[id="odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view_{context}"]
8+
= Customizing a developer catalog or its sub-catalogs using the YAML view
9+
10+
You can customize a developer catalog by editing the YAML content in the YAML view.
11+
12+
.Prerequisites
13+
14+
* An OpenShift web console session with cluster administrator privileges.
15+
16+
.Procedure
17+
18+
. In the *Administrator* perspective of the web console, navigate to *Administration* -> *Cluster Settings*.
19+
. Select the *Configuration* tab, click the *Console (operator.openshift.io)* resource and view the *Details* page.
20+
. Click the *YAML* tab to open the editor and edit the YAML content as needed.
21+
+
22+
For example, to disable a developer catalog type, insert the following snippet that defines a list of disabled developer catalog resources:
23+
+
24+
[source,yaml]
25+
----
26+
apiVersion: operator.openshift.io/v1
27+
kind: Console
28+
metadata:
29+
name: cluster
30+
...
31+
spec:
32+
customization:
33+
developerCatalog:
34+
categories:
35+
types:
36+
state: Disabled
37+
disabled:
38+
- BuilderImage
39+
- Devfile
40+
- HelmChart
41+
...
42+
----
43+
44+
. Click *Save*.
45+
46+
[NOTE]
47+
====
48+
By default, the developer catalog types are enabled in the Administrator view of the Web Console.
49+
====

‎web_console/customizing-the-web-console.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,11 @@ include::modules/odc-customizing-user-perspectives.adoc[leveloffset=+1]
3232
include::modules/odc-customizing-a-perspective-using-YAML-view.adoc[leveloffset=+2]
3333

3434
include::modules/odc-customizing-a-perspective-using-form-view.adoc[leveloffset=+2]
35+
36+
include::modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc[leveloffset=+1]
37+
38+
include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc[leveloffset=+2]
39+
40+
include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc[leveloffset=+2]
41+
42+
include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3]

0 commit comments

Comments
 (0)