|
1 | 1 | // Module included in the following assemblies: |
2 | 2 | // |
3 | | -// * operators/user/olm-installing-operators-in-namespace.adoc |
4 | | -// * operators/admin/olm-adding-operators-to-cluster.adoc |
5 | 3 | // * post_installation_configuration/preparing-for-users.adoc |
6 | 4 | // |
7 | 5 | // Module watched for changes by Ecosystem Catalog team: |
8 | 6 | // https://projects.engineering.redhat.com/projects/RHEC/summary |
9 | 7 |
|
10 | 8 |
|
11 | | -:_mod-docs-content-type: PROCEDURE |
| 9 | +:_mod-docs-content-type: CONCEPT |
12 | 10 | [id="olm-installing-operators-from-operatorhub-configure_{context}"] |
13 | | -= Configuring {product-title} to use Red Hat Operators |
| 11 | += About Operator Catalogs in {product-title} |
14 | 12 |
|
15 | | -In {product-title}, Red Hat Operators are not available by default. You can access and install these Operators if you have a pull secret from {cluster-manager-first} by editing the `OperatorHub` custom resource (CR). |
| 13 | +Out of the box {product-title} provides a catalog source for community operators. |
| 14 | +These operators are built and distributed by the community. |
| 15 | +There are ongoing efforts to make more operators available through a community operator catalog. |
16 | 16 |
|
17 | | -.Prerequisites |
| 17 | +Please note that the Red Hat Operators catalog is not available in {product-title}. According to the subscription agreement, these operators can be used only on OpenShift Container Platform clusters. |
18 | 18 |
|
19 | | -* Ensure that you have downloaded the {cluster-manager-url-pull} as shown in the installation procedure. |
20 | | -
|
21 | | -.Procedure |
22 | | - |
23 | | -To access the Red Hat Operators in an {product-title} cluster: |
24 | | - |
25 | | -. Edit the `OperatorHub` CR using the web console or CLI: |
26 | | - |
27 | | -.. Using the CLI: |
28 | | - |
29 | | -... Edit the `OperatorHub` CR: |
30 | | -+ |
31 | | -[source,terminal] |
32 | | ----- |
33 | | -$ oc edit OperatorHub cluster |
34 | | ----- |
35 | | - |
36 | | -... Add `redhat-operators` to the list of sources as `disabled: false`: |
37 | | -+ |
38 | | -.Example `OperatorHub` CR |
39 | | -[source,yaml] |
40 | | ----- |
41 | | -apiVersion: config.openshift.io/v1 |
42 | | -kind: OperatorHub |
43 | | -metadata: |
44 | | - name: cluster |
45 | | -spec: |
46 | | - disableAllDefaultSources: true |
47 | | - sources: |
48 | | - - disabled: false <1> |
49 | | - name: redhat-operators |
50 | | - - disabled: false |
51 | | - name: community-operators |
52 | | ----- |
53 | | -<1> Add the `name: redhat-operators` and `disabled: false` parameters. |
54 | | - |
55 | | -.. Using the web console: |
56 | | - |
57 | | -... Switch to the *Administration* -> *Custom Resource Definitions* page. |
58 | | - |
59 | | -... On the *Custom Resource Definitions* page, click *OperatorHub*. |
60 | | - |
61 | | -... On the *Custom Resource Definition Overview* page, click *Instances*. |
62 | | - |
63 | | -... On the *Instances* tab, click *cluster*. |
64 | | - |
65 | | -... On the *Instances* tab, click *YAML*. |
66 | | - |
67 | | -... In the YAML field, add `redhat-operators` to the list of sources as `disabled: false`: |
68 | | -+ |
69 | | -.Example `OperatorHub` CR |
70 | | -[source,yaml] |
71 | | ----- |
72 | | -apiVersion: config.openshift.io/v1 |
73 | | -kind: OperatorHub |
74 | | -metadata: |
75 | | - name: cluster |
76 | | -spec: |
77 | | - disableAllDefaultSources: true |
78 | | - sources: |
79 | | - - disabled: false <1> |
80 | | - name: redhat-operators |
81 | | - - disabled: false |
82 | | - name: community-operators |
83 | | ----- |
84 | | -<1> Add the `name: redhat-operators` and `disabled: false` parameters. |
85 | | - |
86 | | -... Click *Save*. |
87 | | - |
88 | | -. Log out of the web console, and then log back in. |
| 19 | +// In the future we may add a reference to OKDerators here. |
0 commit comments