olm-managing-custom-catalogs.adoc

Managing custom catalogs

Cluster administrators and Operator catalog maintainers can create and manage custom catalogs packaged using the bundle format on Operator Lifecycle Manager (OLM) in {product-title}.

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. If your cluster is using custom catalogs, see Controlling Operator compatibility with {product-title} versions for more details about how Operator authors can update their projects to help avoid workload issues and prevent incompatible upgrades.

Additional resources

• Red Hat-provided Operator catalogs

Prerequisites

• You have installed the opm CLI.

File-based catalogs

File-based catalogs are the latest iteration of the catalog format in Operator Lifecycle Manager (OLM). It is a plain text-based (JSON or YAML) and declarative config evolution of the earlier SQLite database format, and it is fully backwards compatible.

Important

As of {product-title} 4.11, the default Red Hat-provided Operator catalog releases in the file-based catalog format. The default Red Hat-provided Operator catalogs for {product-title} 4.6 through 4.10 released in the deprecated SQLite database format. The opm subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format. Many of the opm subcommands and flags for working with the SQLite database format, such as opm index prune, do not work with the file-based catalog format. For more information about working with file-based catalogs, see Operator Framework packaging format and Mirroring images for a disconnected installation using the oc-mirror plugin.

modules/olm-creating-fb-catalog-image.adoc

Additional resources

• opm CLI reference

modules/olm-filtering-fbc.adoc

Additional resources

• Packaging format → Schemas → olm.deprecations schema

• Mirroring images for a disconnected installation using the oc-mirror plugin → Keeping your mirror registry content updated

• Adding a catalog source to a cluster

SQLite-based catalogs

modules/deprecated-feature.adoc

modules/olm-creating-index-image.adoc modules/olm-updating-index-image.adoc modules/olm-pruning-index-image.adoc

modules/olm-catalog-source-and-psa.adoc

Additional resources

• Understanding and managing pod security admission

modules/olm-migrating-sqlite-catalog-to-fbc.adoc

Additional resources

• Adding a catalog source to a cluster

modules/olm-updating-sqlite-catalog-to-a-new-opm-version.adoc modules/olm-sqlite-catalog-configuring-elevated-permissions.adoc

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

Additional resources

• Operator Lifecycle Manager concepts and resources → Catalog source

• Accessing images for Operators from private registries

• Image pull policy

modules/olm-accessing-images-private-registries.adoc

Additional resources

• See What is a secret? for more information on the types of secrets, including those used for registry credentials.

• See Updating the global cluster pull secret for more details on the impact of changing this secret.

• See Allowing pods to reference images from other secured registries for more details on linking pull secrets to service accounts per namespace.

modules/olm-restricted-networks-configuring-operatorhub.adoc

modules/olm-removing-catalogs.adoc