mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
97bae04edb
resolving error in HCP topic map indentation removed the < and replaced with brackets for tech preview in HCP topic map removed the < and replaced with brackets for Operators tech preview in HCP topic map removed the file with tech preview for Operators in HCP topic map applied conditions to 20 xrefs because the networking, cli, authentication and observability books are not in HCP repo yet added blank line after and endif and an include module
141 lines
8.6 KiB
Plaintext
141 lines
8.6 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="olm-managing-custom-catalogs"]
|
|
= Managing custom catalogs
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: olm-managing-custom-catalogs
|
|
|
|
toc::[]
|
|
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
Cluster administrators
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
Administrators with the `dedicated-admin` role
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
and Operator catalog maintainers can create and manage custom catalogs packaged using the xref:../../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[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 xref:../../operators/operator_sdk/osdk-working-bundle-images#osdk-control-compat_osdk-working-bundle-images[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.
|
|
====
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs]
|
|
|
|
[id="olm-managing-custom-catalogs-bundle-format-prereqs"]
|
|
== Prerequisites
|
|
|
|
// TODO-HCP remove conditions for HCP after cli_tools book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
* You have installed the xref:../../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[`opm` CLI].
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
[id="olm-managing-custom-catalogs-fb"]
|
|
== 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.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format] and xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin].
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format].
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
====
|
|
|
|
include::modules/olm-creating-fb-catalog-image.adoc[leveloffset=+2]
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
// TODO-HCP remove conditions for HCP after cli_tools book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
* xref:../../cli_reference/opm/cli-opm-ref.adoc#cli-opm-ref[`opm` CLI reference]
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
include::modules/olm-filtering-fbc.adoc[leveloffset=+2]
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm-packaging-format.adoc#olm-deprecations-schema_olm-packaging-format[Packaging format -> Schemas -> olm.deprecations schema]
|
|
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#updating-mirror-registry-content[Mirroring images for a disconnected installation using the oc-mirror plugin -> Keeping your mirror registry content updated]
|
|
* xref:../../disconnected/using-olm.adoc#olm-creating-catalog-from-index_olm-restricted-networks[Adding a catalog source to a cluster]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
[id="olm-managing-custom-catalogs-sqlite"]
|
|
== SQLite-based catalogs
|
|
|
|
:FeatureName: The SQLite database format for Operator catalogs
|
|
include::modules/deprecated-feature.adoc[leveloffset=+1]
|
|
|
|
include::modules/olm-creating-index-image.adoc[leveloffset=+2]
|
|
include::modules/olm-updating-index-image.adoc[leveloffset=+2]
|
|
include::modules/olm-pruning-index-image.adoc[leveloffset=+2]
|
|
|
|
include::modules/olm-catalog-source-and-psa.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
// TODO-HCP remove conditions for HCP after cli_tools book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
* xref:../../authentication/understanding-and-managing-pod-security-admission.adoc#understanding-and-managing-pod-security-admission[Understanding and managing pod security admission]
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
include::modules/olm-migrating-sqlite-catalog-to-fbc.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-creating-catalog-from-index_olm-managing-custom-catalogs[Adding a catalog source to a cluster]
|
|
|
|
include::modules/olm-updating-sqlite-catalog-to-a-new-opm-version.adoc[leveloffset=+2]
|
|
include::modules/olm-sqlite-catalog-configuring-elevated-permissions.adoc[leveloffset=+2]
|
|
|
|
include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Operator Lifecycle Manager concepts and resources -> Catalog source]
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-accessing-images-private-registries_olm-managing-custom-catalogs[Accessing images for Operators from private registries]
|
|
// This xref may be relevant to OSD/ROSA, but the topic is not currently included in the OSD and ROSA docs.
|
|
* xref:../../openshift_images/managing_images/image-pull-policy.adoc#image-pull-policy[Image pull policy]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// Exclude from OSD/ROSA - dedicated-admins can't create the necessary secrets to do this procedure.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/olm-accessing-images-private-registries.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* See xref:../../cicd/builds/creating-build-inputs.adoc#builds-secrets-overview_creating-build-inputs[What is a secret?] for more information on the types of secrets, including those used for registry credentials.
|
|
* See xref:../../openshift_images/managing_images/using-image-pull-secrets.adoc#images-update-global-pull-secret_using-image-pull-secrets[Updating the global cluster pull secret] for more details on the impact of changing this secret.
|
|
* See xref:../../openshift_images/managing_images/using-image-pull-secrets.adoc#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries] for more details on linking pull secrets to service accounts per namespace.
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// Exclude from OSD/ROSA - dedicated-admins can't do this procedure.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// Removing custom catalogs can be done as a dedicated-admin, but the steps are different.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/olm-removing-catalogs.adoc[leveloffset=+1]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/sd-olm-removing-catalogs.adoc[leveloffset=+1]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] |