mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
36 lines
2.5 KiB
Plaintext
36 lines
2.5 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * operators/understanding/olm-rh-catalogs.adoc
|
|
|
|
:_mod-docs-content-type: CONCEPT
|
|
[id="olm-about-catalogs_{context}"]
|
|
= About Operator catalogs
|
|
|
|
An Operator catalog is a repository of metadata that Operator Lifecycle Manager (OLM) can query to discover and install Operators and their dependencies on a cluster. OLM always installs Operators from the latest version of a catalog.
|
|
|
|
An index image, based on the Operator bundle format, is a containerized snapshot of a catalog. It is an immutable artifact that contains the database of pointers to a set of Operator manifest content. A catalog can reference an index image to source its content for OLM on the cluster.
|
|
|
|
As catalogs are updated, the latest versions of Operators change, and older versions may be removed or altered. In addition, when OLM runs on
|
|
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
an {product-title}
|
|
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
a {product-title}
|
|
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
cluster in a restricted network environment, it is unable to access the catalogs directly from the internet to pull the latest content.
|
|
|
|
As a cluster administrator, you can create your own custom index image, either based on a Red Hat-provided catalog or from scratch, which can be used to source the catalog content on the cluster. Creating and updating your own index image provides a method for customizing the set of Operators available on the cluster, while also avoiding the aforementioned restricted network environment issues.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Kubernetes periodically deprecates certain APIs that are removed in subsequent releases. As a result, Operators are unable to use removed APIs starting with the version of {product-title} that uses the Kubernetes version that removed the API.
|
|
====
|
|
|
|
[NOTE]
|
|
====
|
|
Support for the legacy _package manifest format_ for Operators, including custom catalogs that were using the legacy format, is removed in {product-title} 4.8 and later.
|
|
|
|
When creating custom catalog images, previous versions of {product-title} 4 required using the `oc adm catalog build` command, which was deprecated for several releases and is now removed. With the availability of Red Hat-provided index images starting in {product-title} 4.6, catalog builders must use the `opm index` command to manage index images.
|
|
====
|
|
//Check on pulling this note during the 4.10 to 4.11 version scrub.
|