Skip to content

Commit f68b142

Browse files
authored
Merge pull request #27 from shawn-hurley/add-operator-group-to-install
Explaining the need for operator group during install docs
2 parents f420707 + f32871b commit f68b142

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

content/en/docs/Tasks/install-operator-with-olm.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@ description: >
66
[Once you've made your operator available in a catalog](/docs/tasks/make-operator-part-of-catalog/), or you've chosen an operator from the [list of operators available to be installed in the cluster](/docs/tasks/list-operators-available-to-install/), you can install your operator by creating a [`Subscription`](/docs/concepts/customresourcedefinitions/subscription/) to a specific [channel](/docs/concepts/glossary/#channel).
77
---
88

9+
Before installing an operator into a namespace, you will need to create an [OperatorGroup resource](/docs/concepts/crds/operatorgroup) in that namespace. The OperatorGroup must target namespaces such that it matches the operator's `installModes`.
10+
11+
For example, to install a cluster scoped operator into the `foo` namespace create an OperatorGroup like:
12+
13+
14+
```yaml
15+
apiVersion: operators.coreos.com/v1
16+
kind: OperatorGroup
17+
metadata:
18+
name: my-group
19+
namespace: foo
20+
```
21+
22+
After creating this resource you can create Subscriptions to install cluster scoped operators.
23+
924
```yaml
1025
apiVersion: operators.coreos.com/v1alpha1
1126
kind: Subscription
@@ -18,6 +33,7 @@ spec:
1833
source: <name-of-catalog-operator-is-part-of>
1934
sourceNamespace: <namespace-that-has-catalog>
2035
```
36+
2137
For example, if you want to install an operator named `my-operator`, from a catalog named `my-catalog` that is in the namespace `olm`, and you want to subscribe to the channel `stable`, your subscription yaml would look like this:
2238

2339
```yaml
@@ -51,4 +67,4 @@ NAME READY UP-TO-DATE AVAILABLE AGE
5167
<name-of-your-operator> 1/1 1 1 9m48s
5268
```
5369
54-
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](/docs/tasks/troubleshooting/clusterserviceversion/) to debug your installation.
70+
If the ClusterServiceVersion fails to show up or does not reach the `Succeeded` phase, please check the [troubleshooting documentation](/docs/tasks/troubleshooting/clusterserviceversion/) to debug your installation.

0 commit comments

Comments
 (0)