Skip to content

Commit b0c49e6

Browse files
committed
[docs] Clarify community vs upstream-community OperatorSources
- Add a note to call out to not install both community and upstream-community OperatorSources on the same cluster - Move upstream-community-operators OperatorSource to deploy/upstream/
1 parent 33e7dfa commit b0c49e6

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Here is a description of the spec fields:
2525

2626
- `displayName` and `publisher` are optional and only needed for UI purposes.
2727

28-
Please see [here](deploy/examples/community.operatorsource.cr.yaml) for an example `OperatorSource`.
28+
Please see [here][community-operators] for an example `OperatorSource`.
2929

3030
If you want an `OperatorSource` to work with private app-registry repositories, please take a look at the [Private Repo Authentication](docs/how-to-authenticate-private-repositories.md) documentation.
3131

@@ -62,16 +62,17 @@ $ kubectl apply -f deploy/upstream
6262

6363
#### Installing an operator using Marketplace
6464

65-
The following section assumes that Marketplace was installed in the `marketplace` namespace. For Marketplace to function you need to have at least one `OperatorSource` CR present on the cluster. To get started you can use the `OperatorSource` for [upstream-community-operators](deploy/examples/upstream.operatorsource.cr.yaml). If you are on an OKD cluster, you can skip this step as the `OperatorSource` for [community-operators](deploy/examples/community.operatorsource.cr.yaml) is installed by default instead.
65+
The following section assumes that Marketplace was installed in the `marketplace` namespace. For Marketplace to function you need to have at least one `OperatorSource` CR present on the cluster. To get started you can use the `OperatorSource` for [upstream-community-operators]. If you are on an OKD cluster, you can skip this step as the `OperatorSource` for [community-operators] is installed by default instead.
6666
```bash
67-
$ kubectl apply -f deploy/examples/upstream.operatorsource.cr.yaml
67+
$ kubectl apply -f deploy/upstream/07_upstream_operatorsource.cr.yaml
6868
```
6969
Once the `OperatorSource` has been successfully deployed, you can discover the operators available using the following command:
7070
```bash
7171
$ kubectl get opsrc upstream-community-operators -o=custom-columns=NAME:.metadata.name,PACKAGES:.status.packages -n marketplace
7272
NAME PACKAGES
7373
upstream-community-operators federationv2,svcat,metering,etcd,prometheus,automationbroker,templateservicebroker,cluster-logging,jaeger,descheduler
7474
```
75+
**_Note_**: Please do not install [upstream-community-operators] and [community-operators] `OperatorSources` on the same cluster. The rule of thumb is to install [community-operators] on OpenShift clusters and [upstream-community-operators] on upstream Kubernetes clusters.
7576

7677
Now if you want to install the `descheduler` and `jaeger` operators, create a `CatalogSourceConfig` CR as shown below:
7778
```
@@ -157,7 +158,7 @@ $ kubectl delete catalogsourceconfig installed-upstream-community-operators -n m
157158

158159
Follow the steps [here](https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md) to upload operator artifacts to `quay.io`.
159160

160-
Once your operator artifact is pushed to `quay.io` you can use an `OperatorSource` to add your operator offering to Marketplace. An example `OperatorSource` is provided [here](deploy/examples/upstream.operatorsource.cr.yaml).
161+
Once your operator artifact is pushed to `quay.io` you can use an `OperatorSource` to add your operator offering to Marketplace. An example `OperatorSource` is provided [here][upstream-community-operators].
161162

162163
An `OperatorSource` must specify the `registryNamespace` the operator artifact was pushed to, and set the `name` and `namespace` for creating the `OperatorSource` on your cluster.
163164

@@ -174,3 +175,6 @@ You can also access private AppRegistry repositories via an authenticated `Opera
174175
## Marketplace End to End (e2e) Tests
175176

176177
A full writeup on Marketplace e2e testing can be found [here](docs/e2e-testing.md)
178+
179+
[upstream-community-operators]: deploy/upstream/07_upstream_operatorsource.cr.yaml
180+
[community-operators]: deploy/examples/community.operatorsource.cr.yaml
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)