Skip to content

Commit 9bf7967

Browse files
committed
Clarify CS object namespace usage
1 parent c767cd8 commit 9bf7967

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

modules/olm-creating-catalog-from-index.adoc

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
ifdef::openshift-origin[]
77
:index-image: catalog
88
:tag: latest
9+
:namespace: olm
910
endif::[]
1011
ifndef::openshift-origin[]
1112
:index-image: redhat-operator-index
1213
:tag: v{product-version}
14+
:namespace: openshift-marketplace
1315
endif::[]
1416
ifeval::["{context}" == "olm-restricted-networks"]
1517
:olm-restricted-networks:
@@ -44,7 +46,7 @@ endif::[]
4446
ifndef::olm-restricted-networks[]
4547
name: my-operator-catalog
4648
endif::[]
47-
namespace: openshift-marketplace
49+
namespace: {namespace} <.>
4850
spec:
4951
sourceType: grpc
5052
image: <registry>:<port>/<namespace>/{index-image}:{tag} <.>
@@ -54,6 +56,7 @@ spec:
5456
registryPoll: <.>
5557
interval: 30m
5658
----
59+
<.> If you want the catalog source to be available globally to users in all namespaces, specify the `{namespace}` namespace. Otherwise, you can specify a different namespace for the catalog to be scoped and available only for that namespace.
5760
ifdef::olm-restricted-networks[]
5861
<.> If you mirrored content to local files before uploading to a registry, remove any backslash (`/`) characters from the `metadata.name` field to avoid an "invalid resource name" error when you create the object.
5962
endif::[]
@@ -72,9 +75,9 @@ $ oc apply -f catalogSource.yaml
7275

7376
.. Check the pods:
7477
+
75-
[source,terminal]
78+
[source,terminal,subs="attributes+"]
7679
----
77-
$ oc get pods -n openshift-marketplace
80+
$ oc get pods -n {namespace}
7881
----
7982
+
8083
.Example output
@@ -87,9 +90,9 @@ marketplace-operator-d9f549946-96sgr 1/1 Running 0 26h
8790

8891
.. Check the catalog source:
8992
+
90-
[source,terminal]
93+
[source,terminal,subs="attributes+"]
9194
----
92-
$ oc get catalogsource -n openshift-marketplace
95+
$ oc get catalogsource -n {namespace}
9396
----
9497
+
9598
.Example output
@@ -101,9 +104,9 @@ my-operator-catalog My Operator Catalog grpc 5s
101104

102105
.. Check the package manifest:
103106
+
104-
[source,terminal]
107+
[source,terminal,subs="attributes+"]
105108
----
106-
$ oc get packagemanifest -n openshift-marketplace
109+
$ oc get packagemanifest -n {namespace}
107110
----
108111
+
109112
.Example output
@@ -117,6 +120,7 @@ You can now install the Operators from the *OperatorHub* page on your {product-t
117120

118121
:!index-image:
119122
:!tag:
123+
:!namespace:
120124
ifeval::["{context}" == "olm-restricted-networks"]
121125
:!olm-restricted-networks:
122126
endif::[]

0 commit comments

Comments
 (0)