You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<.> Name for the `CatalogSource` object. This value is also used as part of the name for the related pod that is created in the requested namespace.
61
-
<.> Namespace to create the catalog available. To make the catalog available cluster-wide in all namespaces, set this value to `{global_ns}`. The default Red Hat-provided catalog sources also use the `{global_ns}` namespace. Otherwise, set the value to a specific namespace to make the Operator only available in that namespace.
62
-
<.> Optional: To avoid cluster upgrades potentially leaving Operator installations in an unsupported state or without a continued update path, you can enable automatically changing your Operator catalog's index image version as part of cluster upgrades.
60
+
<1> Name for the `CatalogSource` object. This value is also used as part of the name for the related pod that is created in the requested namespace.
61
+
<2> Namespace to create the catalog available. To make the catalog available cluster-wide in all namespaces, set this value to `{global_ns}`. The default Red Hat-provided catalog sources also use the `{global_ns}` namespace. Otherwise, set the value to a specific namespace to make the Operator only available in that namespace.
62
+
<3> Optional: To avoid cluster upgrades potentially leaving Operator installations in an unsupported state or without a continued update path, you can enable automatically changing your Operator catalog's index image version as part of cluster upgrades.
63
63
+
64
64
Set the `olm.catalogImageTemplate` annotation to your index image name and use one or more of the Kubernetes cluster version variables as shown when constructing the template for the image tag. The annotation overwrites the `spec.image` field at run time. See the "Image template for custom catalog sources" section for more details.
65
-
<.> Display name for the catalog in the web console and CLI.
66
-
<.> Index image for the catalog. Optionally, can be omitted when using the `olm.catalogImageTemplate` annotation, which sets the pull spec at run time.
67
-
<.> Weight for the catalog source. OLM uses the weight for prioritization during dependency resolution. A higher weight indicates the catalog is preferred over lower-weighted catalogs.
68
-
<.> Source types include the following:
65
+
<4> Display name for the catalog in the web console and CLI.
66
+
<5> Index image for the catalog. Optionally, can be omitted when using the `olm.catalogImageTemplate` annotation, which sets the pull spec at run time.
67
+
<6> Weight for the catalog source. OLM uses the weight for prioritization during dependency resolution. A higher weight indicates the catalog is preferred over lower-weighted catalogs.
68
+
<7> Source types include the following:
69
69
+
70
70
--
71
71
* `grpc` with an `image` reference: OLM pulls the image and runs the pod, which is expected to serve a compliant API.
72
72
* `grpc` with an `address` field: OLM attempts to contact the gRPC API at the given address. This should not be used in most cases.
73
73
* `configmap`: OLM parses config map data and runs a pod that can serve the gRPC API over it.
74
74
--
75
-
<.> Automatically check for new versions at a given interval to stay up-to-date.
76
-
<.> Last observed state of the catalog connection. For example:
75
+
<8> Automatically check for new versions at a given interval to stay up-to-date.
76
+
<9> Last observed state of the catalog connection. For example:
77
77
+
78
78
--
79
79
* `READY`: A connection is successfully established.
@@ -82,8 +82,8 @@ Set the `olm.catalogImageTemplate` annotation to your index image name and use o
82
82
--
83
83
+
84
84
See link:https://grpc.github.io/grpc/core/md_doc_connectivity-semantics-and-api.html[States of Connectivity] in the gRPC documentation for more details.
85
-
<.> Latest time the container registry storing the catalog image was polled to ensure the image is up-to-date.
86
-
<.> Status information for the catalog's Operator Registry service.
85
+
<10> Latest time the container registry storing the catalog image was polled to ensure the image is up-to-date.
86
+
<11> Status information for the catalog's Operator Registry service.
87
87
====
88
88
89
89
Referencing the `name` of a `CatalogSource` object in a subscription instructs OLM where to search to find a requested Operator:
<1> 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.
61
+
<2> 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.
62
+
<3> Specify your index image.
63
+
<4> Specify your name or an organization name publishing the catalog.
64
+
<5> Catalog sources can automatically check for new versions to keep up to date.
<.> 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.
75
-
ifndef::olm-restricted-networks[]
76
-
<.> Optional: Set the `olm.catalogImageTemplate` annotation to your index image name and use one or more of the Kubernetes cluster version variables as shown when constructing the template for the image tag.
77
-
endif::[]
78
-
ifdef::olm-restricted-networks[]
79
-
<.> 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.
86
+
<1> 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.
87
+
<2> Optional: Set the `olm.catalogImageTemplate` annotation to your index image name and use one or more of the Kubernetes cluster version variables as shown when constructing the template for the image tag.
88
+
<3> Specify your index image.
89
+
<4> Specify your name or an organization name publishing the catalog.
90
+
<5> Catalog sources can automatically check for new versions to keep up to date.
80
91
endif::[]
81
-
<.> Specify your index image.
82
-
<.> Specify your name or an organization name publishing the catalog.
83
-
<.> Catalog sources can automatically check for new versions to keep up to date.
84
92
85
93
.. Use the file to create the `CatalogSource` object:
The `opm render` command generates a declarative config blob from the provided catalog images and bundle images.
98
98
+
@@ -111,9 +111,9 @@ schema: olm.channel
111
111
package: <operator_name>
112
112
name: preview
113
113
entries:
114
-
- name: <operator_name>.v0.1.0 <.>
114
+
- name: <operator_name>.v0.1.0 <1>
115
115
----
116
-
<.> Ensure that you include the period (`.`) after `<operator_name>` but before the `v` in the version. Otherwise, the entry will fail to pass the `opm validate` command.
116
+
<1> Ensure that you include the period (`.`) after `<operator_name>` but before the `v` in the version. Otherwise, the entry will fail to pass the `opm validate` command.
0 commit comments