mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-11850: migrating disconnected OLM content
This commit is contained in:
Sebastian Kopacz
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
e79849ea17
commit
543ba0a32a
@@ -34,7 +34,7 @@ include::modules/disabling-catalogsource-objects.adoc[leveloffset=+1]
|
||||
* xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-operatorhub-arch-operatorhub_crd_olm-understanding-operatorhub[OperatorHub custom resource]
|
||||
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
* xref:../../operators/admin/olm-restricted-networks.html#olm-restricted-networks-operatorhub_olm-restricted-networks[Disabling the default OperatorHub catalog sources]
|
||||
* xref:../../disconnected/using-olm.adoc#olm-restricted-networks-operatorhub_olm-restricted-networks[Disabling the default OperatorHub catalog sources]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
|
||||
include::modules/olm-node-selector.adoc[leveloffset=+1]
|
||||
@@ -53,7 +53,7 @@ include::modules/olm-priority-class-name.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/olm-tolerations.adoc[leveloffset=+1]
|
||||
|
||||
// The following xref points to a topic that is not included in the OSD or
|
||||
// The following xref points to a topic that is not included in the OSD or
|
||||
// ROSA docs.
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
[role="_additional-resources"]
|
||||
|
||||
@@ -64,7 +64,7 @@ ifndef::openshift-dedicated,openshift-rosa[]
|
||||
|
||||
* 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:../../operators/admin/olm-restricted-networks.adoc#olm-creating-catalog-from-index_olm-restricted-networks[Adding a catalog source to a cluster]
|
||||
* 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[]
|
||||
|
||||
[id="olm-managing-custom-catalogs-sqlite"]
|
||||
|
||||
@@ -1,82 +1,23 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="olm-restricted-networks"]
|
||||
= Using Operator Lifecycle Manager on restricted networks
|
||||
= Using Operator Lifecycle Manager in disconnected environments
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: olm-restricted-networks
|
||||
|
||||
toc::[]
|
||||
|
||||
For {product-title} clusters that are installed on restricted networks, also known as _disconnected clusters_, Operator Lifecycle Manager (OLM) by default cannot access the Red{nbsp}Hat-provided OperatorHub sources hosted on remote registries because those remote sources require full internet connectivity.
|
||||
For {product-title} clusters in disconnected environments, Operator Lifecycle Manager (OLM) by default cannot access the Red{nbsp}Hat-provided OperatorHub sources hosted on remote registries because those remote sources require full internet connectivity.
|
||||
|
||||
However, as a cluster administrator you can still enable your cluster to use OLM in a restricted network if you have a workstation that has full internet access. The workstation, which requires full internet access to pull the remote OperatorHub content, is used to prepare local mirrors of the remote sources, and push the content to a mirror registry.
|
||||
However, as a cluster administrator you can still enable your cluster to use OLM in a disconnected environment if you have a workstation that has full internet access. The workstation, which requires full internet access to pull the remote OperatorHub content, is used to prepare local mirrors of the remote sources, and push the content to a mirror registry.
|
||||
|
||||
The mirror registry can be located on a bastion host, which requires connectivity to both your workstation and the disconnected cluster, or a completely disconnected, or _airgapped_, host, which requires removable media to physically move the mirrored content to the disconnected environment.
|
||||
|
||||
This guide describes the following process that is required to enable OLM in restricted networks:
|
||||
This guide describes the following process that is required to enable OLM in disconnected environments:
|
||||
|
||||
* Disable the default remote OperatorHub sources for OLM.
|
||||
* Use a workstation with full internet access to create and push local mirrors of the OperatorHub content to a mirror registry.
|
||||
* Configure OLM to install and manage Operators from local sources on the mirror registry instead of the default remote sources.
|
||||
|
||||
After enabling OLM in a restricted network, you can continue to use your unrestricted workstation to keep your local OperatorHub sources updated as newer versions of Operators are released.
|
||||
After enabling OLM in a disconnected environment, you can continue to use your unrestricted workstation to keep your local OperatorHub sources updated as newer versions of Operators are released.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
While OLM can manage Operators from local sources, the ability for a given Operator to run successfully in a restricted network still depends on the Operator itself meeting the following criteria:
|
||||
|
||||
* List any related images, or other container images that the Operator might require to perform their functions, in the `relatedImages` parameter of its `ClusterServiceVersion` (CSV) object.
|
||||
* Reference all specified images by a digest (SHA) and not by a tag.
|
||||
|
||||
You can search software on the link:https://catalog.redhat.com/software/search?p=1&deployed_as=Operator&type=Containerized%20application&badges_and_features=Disconnected[Red{nbsp}Hat Ecosystem Catalog] for a list of Red{nbsp}Hat Operators that support running in disconnected mode by filtering with the following selections:
|
||||
|
||||
[horizontal]
|
||||
Type:: Containerized application
|
||||
Deployment method:: Operator
|
||||
Infrastructure features:: Disconnected
|
||||
====
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red{nbsp}Hat-provided Operator catalogs]
|
||||
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-restricted-network_osdk-generating-csvs[Enabling your Operator for restricted network environments]
|
||||
|
||||
[id="olm-restricted-network-prereqs"]
|
||||
== Prerequisites
|
||||
|
||||
* Log in to your {product-title} cluster as a user with `cluster-admin` privileges.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you are using OLM in a restricted network on {ibm-z-name}, you must have at least 12 GB allocated to the directory where you place your registry.
|
||||
====
|
||||
|
||||
include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1]
|
||||
|
||||
[id="olm-mirror-catalog_olm-restricted-networks"]
|
||||
== Mirroring an Operator catalog
|
||||
|
||||
For instructions about mirroring Operator catalogs for use with disconnected clusters, see xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#olm-mirroring-catalog_installing-mirroring-installation-images[Installing -> Mirroring images for a disconnected installation].
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
As of {product-title} 4.11, the default Red{nbsp}Hat-provided Operator catalog releases in the file-based catalog format. The default Red{nbsp}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 xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format], xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs], and xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin].
|
||||
====
|
||||
|
||||
include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-accessing-images-private-registries_olm-managing-custom-catalogs[Accessing images for Operators from private registries]
|
||||
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource-image-template_olm-understanding-olm[Image template for custom catalog sources]
|
||||
* xref:../../openshift_images/managing_images/image-pull-policy.adoc#image-pull-policy[Image pull policy]
|
||||
|
||||
[id="next-steps_olm-restricted-networks"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]
|
||||
For more information, see xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments] in the Disconnected environments section.
|
||||
@@ -29,5 +29,5 @@ ifndef::openshift-dedicated,openshift-rosa[]
|
||||
[id="additional-resources_olm-upgrading-operators"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
* xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
@@ -64,7 +64,9 @@ endif::openshift-dedicated,openshift-rosa[]
|
||||
** xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Delete installed Operators].
|
||||
** xref:../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[Configure proxy support].
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
** xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Use Operator Lifecycle Manager on restricted networks].
|
||||
** xref:../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments].
|
||||
|
||||
// Not sure if the xref above should be changed in #82841 since this is the index page of the Operators section
|
||||
|
||||
To know all about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference].
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
|
||||
@@ -33,7 +33,7 @@ include::modules/olm-about-catalogs.adoc[leveloffset=+1]
|
||||
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs]
|
||||
* xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Packaging format]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
* xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
|
||||
include::modules/olm-rh-catalogs.adoc[leveloffset=+1]
|
||||
|
||||
Reference in New Issue
Block a user