mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-8990: Adds oc mirror for MicroShift operator deployment with OLM
This commit is contained in:
“Shauna Diaz”
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
8fff4bd8ae
commit
1232e862aa
@@ -403,7 +403,7 @@ Topics:
|
||||
- Name: Using networking settings
|
||||
File: microshift-networking-settings
|
||||
- Name: Network policies
|
||||
Dir: microshift-network-policy
|
||||
Dir: microshift_network_policy
|
||||
Topics:
|
||||
- Name: About network policies
|
||||
File: microshift-network-policy-index
|
||||
@@ -455,14 +455,21 @@ Topics:
|
||||
File: microshift-embedding-apps-tutorial
|
||||
- Name: Creating application or workload health check scripts
|
||||
File: microshift-greenboot-workload-scripts
|
||||
- Name: Pod security authentication and authorization
|
||||
File: microshift-authentication
|
||||
- Name: Using Operators
|
||||
File: microshift-operators
|
||||
- Name: Using Operator Lifecycle Manager
|
||||
File: microshift-operators-olm
|
||||
- Name: Automating application management with GitOps
|
||||
File: microshift-gitops
|
||||
- Name: Pod security authentication and authorization
|
||||
File: microshift-authentication
|
||||
- Name: Operators
|
||||
Dir: microshift_operators
|
||||
Topics:
|
||||
- Name: Using Operators
|
||||
File: microshift-operators
|
||||
- Name: Using Operator Lifecycle Manager
|
||||
File: microshift-operators-olm
|
||||
- Name: Creating custom catalogs with oc-mirror
|
||||
File: microshift-operators-oc-mirror
|
||||
- Name: Adding OLM-based Operators to a disconnected cluster
|
||||
File: microshift-operators-oc-mirror-disconnected
|
||||
---
|
||||
Name: Backup and restore
|
||||
Dir: microshift_backup_and_restore
|
||||
|
||||
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
You can use a custom container registry when you deploy {microshift-short} in an air-gapped network. Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of container images in a private registry.
|
||||
You can use a custom container registry when you deploy {microshift-short} in a disconnected network. Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of container images in a private registry.
|
||||
|
||||
include::modules/microshift-mirror-container-images.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -34,3 +34,5 @@ include::modules/microshift-creating-ostree-iso.adoc[leveloffset=+2]
|
||||
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_a_customized_rhel_system_image/assembly_pushing-a-container-to-a-register-and-embedding-it-into-a-image_composing-a-customized-rhel-system-image#con_the-container-registry-credentials_assembly_pushing-a-container-to-a-register-and-embedding-it-into-a-image[Pushing a container to a registry and embedding it into an image]
|
||||
* link:https://osbuild.org/docs/on-premises/installation/container-auth[Container registry credentials]
|
||||
* xref:../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
|
||||
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
|
||||
* xref:../microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.adoc#microshift-operators-oc-mirror[Creating custom catalogs using the oc-mirror plugin]
|
||||
|
||||
@@ -35,7 +35,7 @@ include::modules/microshift-adding-olm-to-blueprint.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../microshift_running_apps/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
|
||||
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
|
||||
* xref:../microshift_updating/microshift-update-rpms-ostree.adoc[Applying updates on an OSTree system]
|
||||
|
||||
include::modules/microshift-ca-adding-bundle.adoc[leveloffset=+1]
|
||||
|
||||
@@ -44,7 +44,7 @@ include::modules/microshift-install-rpms-olm.adoc[leveloffset=+1]
|
||||
.Additional resources
|
||||
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-system-requirements_microshift-install-rpm[System requirements for installing MicroShift]
|
||||
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm-preparing_microshift-install-rpm[Preparing to install MicroShift from an RPM package]
|
||||
* xref:../microshift_running_apps/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
|
||||
* xref:../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}]
|
||||
|
||||
include::modules/microshift-install-rpms-gitops.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
1
microshift_running_apps/microshift_operators/_attributes
Symbolic link
1
microshift_running_apps/microshift_operators/_attributes
Symbolic link
@@ -0,0 +1 @@
|
||||
../_attributes
|
||||
1
microshift_running_apps/microshift_operators/images
Symbolic link
1
microshift_running_apps/microshift_operators/images
Symbolic link
@@ -0,0 +1 @@
|
||||
../images
|
||||
@@ -0,0 +1,26 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="microshift-operators-oc-mirror-disconnected"]
|
||||
= Adding OLM-based Operators to a disconnected cluster
|
||||
include::_attributes/attributes-microshift.adoc[]
|
||||
:context: microshift-operators-oc-mirror-disconnected
|
||||
|
||||
toc::[]
|
||||
|
||||
You can use OLM-based Operators in disconnected situations by embedding them in a {op-system-ostree-first} image.
|
||||
|
||||
//Using OLM disconnected
|
||||
include::modules/microshift-olm-deploy-op-disconnected-con.adoc[leveloffset=+1]
|
||||
|
||||
//additional resources for embedding operators into rhel for edge disconnected
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/red_hat_build_of_microshift/{ocp-version}/html/installing/microshift-embed-in-rpm-ostree-for-offline-use#microshift-creating-ostree-iso_microshift-embed-rpm-ostree-offline-use[Creating the RHEL for Edge image]
|
||||
* xref:../../microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
|
||||
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]
|
||||
|
||||
//OCP module, edit with conditionals and care
|
||||
include::modules/oc-mirror-dry-run.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/microshift-oc-mirror-embed-ops-disconnected-use.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/microshift-ops-config-embed-ostree.adoc[leveloffset=+2]
|
||||
@@ -0,0 +1,57 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="microshift-operators-oc-mirror"]
|
||||
= Creating custom catalogs using the oc-mirror plugin
|
||||
include::_attributes/attributes-microshift.adoc[]
|
||||
:context: microshift-operators-oc-mirror
|
||||
|
||||
toc::[]
|
||||
|
||||
You can create custom catalogs with widely available Operators and mirror them by using the oc-mirror OpenShift CLI (oc) plugin.
|
||||
|
||||
[id="microshift-olm-red-hat-ops-mirror_{context}"]
|
||||
== Using Red Hat-provided Operator catalogs and mirror registries
|
||||
You can filter and prune catalogs to get specific Operators and mirror them by using the oc-mirror OpenShift CLI (oc) plugin. You can also use Operators in disconnected settings or embedded in {op-system-ostree-first} images. To read more details about how to configure your systems for mirroring, use the links in the following "Additional resources" section. If you are ready to deploy Operators from Red Hat-provided Operator catalogs, mirror them, or to embed them in {op-system-ostree} images, start with the following section, "Inspecting catalog contents by using the oc-mirror plugin."
|
||||
|
||||
//additional resources for deploying operators in disconnected environments
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
|
||||
* xref:../../microshift_install/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access]
|
||||
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
|
||||
* xref:../../microshift_install/microshift-deploy-with-mirror-registry.adoc#microshift-get-mirror-reg-container-image-list_microshift-deploy-with-mirror-registry[Getting the mirror registry container image list]
|
||||
* xref:../../microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
|
||||
|
||||
include::modules/microshift-oc-mirror-about-con.adoc[leveloffset=+1]
|
||||
|
||||
//additional resources for preqeq to using oc mirror
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#prerequisites_installing-mirroring-disconnected[Installing the oc mirror plugin]
|
||||
|
||||
include::modules/microshift-oc-mirror-list-ops-catalogs.adoc[leveloffset=+2]
|
||||
|
||||
//First, make the image sets
|
||||
include::modules/microshift-oc-mirror-creating-imageset-config.adoc[leveloffset=+2]
|
||||
|
||||
//OCP module, reference for valid imageset parameters for microshift; see conditionals
|
||||
include::modules/oc-mirror-imageset-config-params.adoc[leveloffset=+3]
|
||||
|
||||
//additional resources for creating image sets
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#oc-mirror-image-set-examples_installing-mirroring-disconnected[Imageset configuration examples]
|
||||
|
||||
// OCP module, mirroring from mirror to mirror
|
||||
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+2]
|
||||
|
||||
//additional resources for microshift mirror to mirror module
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment]
|
||||
|
||||
//Convert the imageset file and add configuration to CRI-O
|
||||
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+2]
|
||||
|
||||
//Apply changes to cluster so it can use Operators
|
||||
include::modules/microshift-oc-mirror-install-catalog-cluster.adoc[leveloffset=+2]
|
||||
@@ -8,6 +8,9 @@ toc::[]
|
||||
|
||||
The Operator Lifecycle Manager (OLM) package manager is used in {microshift-short} for installing and running optional link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/architecture/control-plane#olm-operators_control-plane[add-on Operators].
|
||||
|
||||
[id="microshift-olm-considerations_{context}"]
|
||||
== Considerations for using OLM with {microshift-short}
|
||||
|
||||
* Cluster Operators as applied in {ocp} are not used in {microshift-short}.
|
||||
* You must create your own catalogs for the add-on Operators you want to use with your applications. Catalogs are not provided by default.
|
||||
** Each catalog must have an accessible `CatalogSource` added to a cluster, so that the OLM catalog Operator can use the catalog for content.
|
||||
@@ -26,26 +29,26 @@ You can install the OLM package manager for use with {microshift-short} 4.15 or
|
||||
|
||||
* You can install the `microshift-olm` RPM at the same time you install the {microshift-short} RPM on {op-system-base-full}.
|
||||
* You can install the `microshift-olm` on an existing {microshift-short} {product-version}. Restart the {microshift-short} service after installing OLM for the changes to apply.
|
||||
See xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpms-olm_microshift-install-rpm[Installing the Operator Lifecycle Manager (OLM) from an RPM package].
|
||||
* You can embed OLM in a {op-system-ostree-first} image. See xref:../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-adding-olm-to-blueprint_microshift-embed-in-rpm-ostree[Adding the Operator Lifecycle Manager (OLM) service to a blueprint].
|
||||
See xref:../../microshift_install/microshift-install-rpm.adoc#microshift-install-rpms-olm_microshift-install-rpm[Installing the Operator Lifecycle Manager (OLM) from an RPM package].
|
||||
* You can embed OLM in a {op-system-ostree-first} image. See xref:../../microshift_install/microshift-embed-in-rpm-ostree.adoc#microshift-adding-olm-to-blueprint_microshift-embed-in-rpm-ostree[Adding the Operator Lifecycle Manager (OLM) service to a blueprint].
|
||||
|
||||
include::modules/microshift-olm-namespaces.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/microshift-olm-build-op-catalogs.adoc[leveloffset=+1]
|
||||
|
||||
//additional resources for builing catalogs module
|
||||
//additional resources for building catalogs module
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli[`opm` CLI reference]
|
||||
* link:https://docs.openshift.com/container-platform/{ocp-version}/operators/understanding/olm-rh-catalogs.html#olm-about-catalogs_olm-rh-catalogs[About Operator catalogs]
|
||||
* For instructions about creating file-based catalogs by using the `opm` CLI, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-managing-custom-catalogs[Managing custom catalogs]
|
||||
* To create file-based catalogs by using the `opm` CLI, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-managing-custom-catalogs[Managing custom catalogs]
|
||||
|
||||
include::modules/microshift-olm-deploy-ops-con.adoc[leveloffset=+1]
|
||||
|
||||
//additional resources for deploying operators concept module
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://docs.openshift.com/container-platform/4.14/operators/understanding/olm/olm-understanding-operatorgroups.html#olm-operatorgroups-membership_olm-understanding-operatorgroups[Operator group membership]
|
||||
* link:https://docs.openshift.com/container-platform/{ocp-version}/operators/understanding/olm/olm-understanding-operatorgroups.html#olm-operatorgroups-membership_olm-understanding-operatorgroups[Operator group membership]
|
||||
|
||||
include::modules/microshift-olm-deploy-ops-global-ns.adoc[leveloffset=+2]
|
||||
|
||||
@@ -55,16 +58,4 @@ include::modules/microshift-olm-deploy-ops-spec-ns.adoc[leveloffset=+2]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-upgrading-operators[Updating installed Operators]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-deleting-operator-from-a-cluster-using-cli_olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster using the CLI]
|
||||
|
||||
include::modules/microshift-olm-deploy-op-disconnected.adoc[leveloffset=+2]
|
||||
|
||||
//additional resources for deploying operators in disconnected and offline environments
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for more information.
|
||||
* link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-disconnected.html#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin]
|
||||
* xref:../microshift_install/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access]
|
||||
* xref:../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
|
||||
* xref:../microshift_install/microshift-deploy-with-mirror-registry.adoc#microshift-get-mirror-reg-container-image-list_microshift-deploy-with-mirror-registry[Getting the mirror registry container image list]
|
||||
* xref:../microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-deleting-operator-from-a-cluster-using-cli_olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster using the CLI]
|
||||
@@ -19,8 +19,12 @@ There are two ways to use Operators for your {microshift-short} clusters:
|
||||
|
||||
[id="microshift-operators-paths-manifests_{context}"]
|
||||
=== Manifests for Operators
|
||||
* Operators can be installed and managed directly by using manifests. You can use the `kustomize` configuration management tool with {microshift-short} to deploy an application. Use the same steps to install Operators with manifests. See xref:../microshift_running_apps/microshift-applications.adoc#microshift-manifests-overview_applications-microshift[Using Kustomize manifests to deploy applications] and xref:../microshift_running_apps/microshift-applications.adoc#microshift-applying-manifests-example_applications-microshift[Using manifests example] for details.
|
||||
Operators can be installed and managed directly by using manifests. You can use the `kustomize` configuration management tool with {microshift-short} to deploy an application. Use the same steps to install Operators with manifests.
|
||||
|
||||
* See xref:../../microshift_running_apps/microshift-applications.adoc#microshift-manifests-overview_applications-microshift[Using Kustomize manifests to deploy applications] and xref:../../microshift_running_apps/microshift-applications.adoc#microshift-applying-manifests-example_applications-microshift[Using manifests example] for details.
|
||||
|
||||
[id="microshift-operators-paths-olm_{context}"]
|
||||
=== Operator Lifecycle Manager for Operators
|
||||
* You can also install add-on Operators to a {microshift-short} cluster using Operator Lifecycle Manager (OLM). OLM can be used to manage both custom Operators and Operators that are widely available. Building catalogs is required to use OLM with {microshift-short}. For details, see xref:../microshift_running_apps/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}].
|
||||
You can also install add-on Operators to a {microshift-short} cluster using Operator Lifecycle Manager (OLM). OLM can be used to manage both custom Operators and Operators that are widely available. Building catalogs is required to use OLM with {microshift-short}.
|
||||
|
||||
* For details, see xref:../../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}].
|
||||
1
microshift_running_apps/microshift_operators/modules
Symbolic link
1
microshift_running_apps/microshift_operators/modules
Symbolic link
@@ -0,0 +1 @@
|
||||
../modules
|
||||
1
microshift_running_apps/microshift_operators/snippets
Symbolic link
1
microshift_running_apps/microshift_operators/snippets
Symbolic link
@@ -0,0 +1 @@
|
||||
../snippets/
|
||||
@@ -12,7 +12,7 @@ To create an air-gapped mirror registry for {microshift-short} containers, you m
|
||||
|
||||
* Get the container image list to be mirrored.
|
||||
* Configure the mirroring prerequisites.
|
||||
* Download images on a host with the internet access.
|
||||
* Download images on a host with internet access.
|
||||
* Copy the downloaded image directory to an air-gapped site.
|
||||
* Upload images to a mirror registry in an air-gapped site.
|
||||
* Configure your {microshift-short} hosts to use the mirror registry.
|
||||
|
||||
37
modules/microshift-oc-mirror-about-con.adoc
Normal file
37
modules/microshift-oc-mirror-about-con.adoc
Normal file
@@ -0,0 +1,37 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="microshift-using-oc-mirror_{context}"]
|
||||
= About the oc-mirror plugin for creating a mirror registry
|
||||
|
||||
You can use the oc-mirror OpenShift CLI (oc) plugin with {microshift-short} to filter and prune Operator catalogs. You can then mirror the filtered catalog contents to a mirror registry or use the container images in disconnected or offline deployments with {op-system-ostree}.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
{microshift-short} uses the generally available version (1) of the oc-mirror plugin. Do not use the following procedures with the Technical Preview version (2) of oc-mirror plugin.
|
||||
====
|
||||
|
||||
You can mirror the container images required by the desired Operators locally or to a container mirror registry that supports link:https://docs.docker.com/registry/[Docker v2-2], such as Red Hat Quay. The procedure to mirror content from Red Hat-hosted registries connected to the internet to a disconnected image registry is the same, independent of the registry you choose. After you mirror the contents of your catalog, configure each cluster to retrieve this content from your mirror registry.
|
||||
|
||||
[id="microshift-populate-mirror-registry-connectivity_{context}"]
|
||||
== Connectivity considerations when populating a mirror registry
|
||||
|
||||
When you populate your registry, you can use one of following connectivity scenarios:
|
||||
|
||||
Connected mirroring::
|
||||
If you have a host that can access both the internet and your mirror registry, but not your cluster node, you can directly mirror the content from that machine.
|
||||
|
||||
Disconnected mirroring::
|
||||
If you do not have a host that can access both the internet and your mirror registry, you must mirror the images to a file system and then bring that host or removable media into your disconnected environment.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
A container registry must be reachable by every machine in the clusters that you provision. Installing, updating, and other operations, such as relocating workloads, might fail if the registry is unreachable.
|
||||
====
|
||||
|
||||
To avoid problems caused by an unreachable registry, use the following standard practices:
|
||||
|
||||
* Run mirror registries in a highly available way.
|
||||
* Ensure that the mirror registry at least matches the production availability of your clusters.
|
||||
90
modules/microshift-oc-mirror-creating-imageset-config.adoc
Normal file
90
modules/microshift-oc-mirror-creating-imageset-config.adoc
Normal file
@@ -0,0 +1,90 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-oc-mirror-creating-imageset-config_{context}"]
|
||||
= Creating an image set configuration file
|
||||
|
||||
You must create an image set configuration file to mirror catalog contents with the oc-mirror plugin. The image set configuration file defines which Operators to mirror along with other configuration settings for the oc-mirror plugin. After generating a default image set file, you must edit the contents so that remaining entries are compatible with both {microshift-short} and the Operator you plan to use.
|
||||
|
||||
You must specify a storage backend in the image set configuration file. This storage backend can be a local directory or a registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2]. The oc-mirror plugin stores metadata in this storage backend during image set creation.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Do not delete or modify the metadata that is generated by the oc-mirror plugin. You must use the same storage backend every time you run the oc-mirror plugin for the same mirror registry.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have created a container image registry credentials file. See link:https://docs.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored].
|
||||
|
||||
.Procedure
|
||||
|
||||
. Use the `oc mirror init` command to create a template for the image set configuration and save it to a file called `imageset-config.yaml`:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror init <--registry <storage_backend> > imageset-config.yaml <1>
|
||||
----
|
||||
<1> Specifies the location of your storage backend, such as `example.com/mirror/oc-mirror-metadata`.
|
||||
+
|
||||
.Example default image set configuration file
|
||||
[source,yaml]
|
||||
----
|
||||
kind: ImageSetConfiguration
|
||||
apiVersion: mirror.openshift.io/v1alpha2
|
||||
storageConfig:
|
||||
registry:
|
||||
imageURL: registry.example.com/oc-mirror
|
||||
skipTLS: false
|
||||
mirror:
|
||||
platform: <1>
|
||||
channels:
|
||||
- name: stable-4.15
|
||||
type: ocp
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15
|
||||
packages:
|
||||
- name: serverless-operator
|
||||
channels:
|
||||
- name: stable
|
||||
additionalImages: <2>
|
||||
- name: registry.redhat.io/ubi8/ubi:latest
|
||||
helm: {} <3>
|
||||
----
|
||||
<1> The `platform` field and related fields are not supported by {microshift-short} and must be deleted.
|
||||
<2> Specify any additional images to include in the image set. If you do not need to specify additional images, delete this field.
|
||||
<3> Helm is not supported by {microshift-short}, and must be deleted.
|
||||
|
||||
. Edit the values of your image set configuration file to meet the requirements of both {microshift-short} and the Operator you want to mirror, like the following example:
|
||||
+
|
||||
.Example edited {microshift-short} image set configuration file
|
||||
[source,yaml,subs="attributes+"]
|
||||
----
|
||||
kind: ImageSetConfiguration
|
||||
apiVersion: mirror.openshift.io/v1alpha2
|
||||
storageConfig: <1>
|
||||
registry:
|
||||
imageURL: <storage_backend> <2>
|
||||
skipTLS: false
|
||||
mirror:
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15 <3>
|
||||
packages:
|
||||
- name: amq-broker-rhel8 <4>
|
||||
channels:
|
||||
- name: 7.11.x <5>
|
||||
----
|
||||
<1> Set the backend location where the image set metadata is saved. This location can be a registry or local directory. It is required to specify `storageConfig` values.
|
||||
<2> Set the registry URL for the storage backend, such as `<example.com/mirror/oc-mirror-metadata`.
|
||||
<3> Set the Operator catalog to retrieve images from.
|
||||
<4> Specify the Operator packages to include in the image set. Remove this field to retrieve all packages in the catalog.
|
||||
<5> Specify only certain channels of the Operator packages to include in the image set. You must always include the default channel for the Operator package even if you do not use the bundles in that channel. You can find the default channel by running the following command: `oc mirror list operators --catalog=<catalog_name> --package=<package_name>`.
|
||||
|
||||
. Save the updated file.
|
||||
|
||||
.Next steps
|
||||
* Use the oc-mirror plugin to mirror an image set directly to a target mirror registry.
|
||||
* Configure CRI-O.
|
||||
* Apply the catalog sources to your clusters.
|
||||
171
modules/microshift-oc-mirror-embed-ops-disconnected-use.adoc
Normal file
171
modules/microshift-oc-mirror-embed-ops-disconnected-use.adoc
Normal file
@@ -0,0 +1,171 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-oc-mirror-prep-ops-cat-images-disconnected-use_{context}"]
|
||||
= Getting catalogs and Operator container image references to use with RHEL for Edge in disconnected environments
|
||||
|
||||
After performing a dry run with the oc-mirror plugin to review the list of images that you want to mirror, you must get all of the container image references, then format the output for adding to an Image Builder blueprint.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For catalogs made for proprietary Operators, you can format image references for the Image Builder blueprint without using the following procedure.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
* You have a catalog index for the Operators you want to use.
|
||||
* You have installed the `jq` CLI tool.
|
||||
* You are familiar with Image Builder blueprint files.
|
||||
* You have an Image Builder blueprint TOML file.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Parse the catalog `index.json` file to get the image references that you need to include in the Image Builder blueprint. You can use either the unfiltered catalog or you can filter out images that cannot be mirrored:
|
||||
|
||||
.. Parse the unfiltered catalog `index.json` file to get the image references by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
jq -r --slurp '.[] | select(.relatedImages != null) | "[[containers]]\nsource = \"" + .relatedImages[].image + "\"\n"' ./oc-mirror-workspace/src/catalogs/registry.redhat.io/redhat/redhat-operator-index/v4.15/index/index.json
|
||||
----
|
||||
|
||||
.. If you want to filter out images that cannot be mirrored, filter and parse the catalog `index.json` file by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ jq -r --slurp '.[] | select(.relatedImages != null) | .relatedImages[] | select(.name | contains("ppc") or contains("s390x") | not) | "[[containers]]\\nsource = \\"" + .image + "\\"\\n"' ./oc-mirror-workspace/src/catalogs/registry.redhat.io/redhat/redhat-operator-index/v4.15/index/index.json
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
This step uses the AMQ Broker Operator as an example. You can add other criteria to the `jq` command for further filtering as required by your use case.
|
||||
====
|
||||
+
|
||||
.Example image-reference output
|
||||
[source,terminal]
|
||||
----
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-init-rhel8@sha256:0b2126cfb6054fdf428c1f43b69e36e93a09a49ce15350e9273c98cc08c6598b"
|
||||
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-init-rhel8@sha256:0dde839c2dce7cb684094bf26523c8e16677de03149a0fff468b8c3f106e1f4f"
|
||||
...
|
||||
...
|
||||
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-rhel8@sha256:e8fa2a00e576ecb95561ffbdbf87b1c82d479c8791ab2c6ce741dd0d0b496d15"
|
||||
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-rhel8@sha256:ff6fefad518a6c997d4c5a6e475ba89640260167f0bc27715daf3cc30116fad1"
|
||||
…
|
||||
EOF
|
||||
----
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
For mirrored and disconnected use cases, ensure that all of the sources filtered from your catalog `index.json` file are digests. If any of the sources use tags instead of digests, the Operator installation fails. Tags require an internet connection.
|
||||
====
|
||||
|
||||
. View the `imageset-config.yaml` to get the catalog image reference for the `CatalogSource` custom resource (CR) by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ cat imageset-config.yaml
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
kind: ImageSetConfiguration
|
||||
apiVersion: mirror.openshift.io/v1alpha2
|
||||
storageConfig:
|
||||
registry:
|
||||
imageURL: registry.example.com/microshift-mirror
|
||||
mirror:
|
||||
operators:
|
||||
- catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15 <1>
|
||||
packages:
|
||||
- name: amq-broker-rhel8
|
||||
channels:
|
||||
- name: 7.11.x
|
||||
----
|
||||
<1> Use the value in the `mirror.catalog` catalog image reference for the follwing `jq` command to get the image digest. In this example, _<registry.redhat.io/redhat/redhat-operator-index:v4.15>_.
|
||||
|
||||
. Get the SHA of the catalog index image by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ skopeo inspect docker://<registry.redhat.io/redhat/redhat-operator-index:v4.15> | jq `.Digest` <1>
|
||||
----
|
||||
<1> Use the value in the `mirror.catalog` catalog image reference for the `jq` command to get the image digest. In this example, _<registry.redhat.io/redhat/redhat-operator-index:v4.15>_.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
"sha256:7a76c0880a839035eb6e896d54ebd63668bb37b82040692141ba39ab4c539bc6"
|
||||
----
|
||||
|
||||
. To get ready to add the image references to your Image Builder blueprint file, format the catalog image reference by using the following example:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/redhat/redhat-operator-index@sha256:7a76c0880a839035eb6e896d54ebd63668bb37b82040692141ba39ab4c539bc6"
|
||||
----
|
||||
|
||||
. Add the image references from all the previous steps to the Image Builder blueprint.
|
||||
+
|
||||
.Generated Image Builder blueprint example snippet
|
||||
[source,text]
|
||||
----
|
||||
name = "microshift_blueprint"
|
||||
description = "MicroShift 4.15.1 on x86_64 platform"
|
||||
version = "0.0.1"
|
||||
modules = []
|
||||
groups = []
|
||||
|
||||
[[packages]] <1>
|
||||
name = "microshift"
|
||||
version = "4.15.1"
|
||||
...
|
||||
...
|
||||
|
||||
[customizations.services] <2>
|
||||
enabled = ["microshift"]
|
||||
|
||||
[customizations.firewall]
|
||||
ports = ["22:tcp", "80:tcp", "443:tcp", "5353:udp", "6443:tcp", "30000-32767:tcp", "30000-32767:udp"]
|
||||
...
|
||||
...
|
||||
|
||||
[[containers]] <3>
|
||||
source = "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:f41e79c17e8b41f1b0a5a32c3e2dd7cd15b8274554d3f1ba12b2598a347475f4"
|
||||
|
||||
[[containers]]
|
||||
source = "quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:dbc65f1fba7d92b36cf7514cd130fe83a9bd211005ddb23a8dc479e0eea645fd"
|
||||
...
|
||||
...
|
||||
|
||||
[[containers]] <4>
|
||||
source = "registry.redhat.io/redhat/redhat-operator-index@sha256:7a76c0880a839035eb6e896d54ebd63668bb37b82040692141ba39ab4c539bc6"
|
||||
...
|
||||
...
|
||||
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-init-rhel8@sha256:0dde839c2dce7cb684094bf26523c8e16677de03149a0fff468b8c3f106e1f4f"
|
||||
...
|
||||
...
|
||||
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-rhel8@sha256:e8fa2a00e576ecb95561ffbdbf87b1c82d479c8791ab2c6ce741dd0d0b496d15"
|
||||
|
||||
[[containers]]
|
||||
source = "registry.redhat.io/amq7/amq-broker-rhel8@sha256:ff6fefad518a6c997d4c5a6e475ba89640260167f0bc27715daf3cc30116fad1"
|
||||
…
|
||||
EOF
|
||||
----
|
||||
<1> References for all non-optional {microshift-short} RPM packages using the same version compatible with the `microshift-release-info` RPM.
|
||||
<2> References for automatically enabling {microshift-short} on system startup and applying default networking settings.
|
||||
<3> References for all non-optional {microshift-short} container images necessary for a disconnected deployment.
|
||||
<4> References for the catalog index.
|
||||
99
modules/microshift-oc-mirror-install-catalog-cluster.adoc
Normal file
99
modules/microshift-oc-mirror-install-catalog-cluster.adoc
Normal file
@@ -0,0 +1,99 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-oc-mirror-install-catalog-in-cluster_{context}"]
|
||||
= Installing a custom catalog created with the oc-mirror plugin
|
||||
|
||||
After you mirror your image set to the mirror registry, you must apply the generated `CatalogSource` custom resource (CR) into the cluster. The `CatalogSource` CR is used by Operator Lifecycle Manager (OLM) to retrieve information about the available Operators in the mirror registry. You must then create and apply a subscription CR to subscribe to your custom catalog.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You mirrored the image set to your registry mirror.
|
||||
* You added image reference information to the CRI-O container runtime configuration.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Apply the catalog source configuration file from the results directory to create the catalog source object by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f ./oc-mirror-workspace/results-1708508014/catalogSource-cs-redhat-operator-index.yaml
|
||||
----
|
||||
+
|
||||
.Example catalog source configuration file
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operators.coreos.com/v1alpha1
|
||||
kind: CatalogSource
|
||||
metadata:
|
||||
name: redhat-catalog
|
||||
namespace: openshift-marketplace <1>
|
||||
spec:
|
||||
sourceType: grpc
|
||||
image: registry.example.com/redhat/redhat-operator-index:v4.15
|
||||
updateStrategy:
|
||||
registryPoll:
|
||||
interval: 60m
|
||||
----
|
||||
<1> Specifies the global namespace. Setting the `metadata.namespace` to `openshift-marketplace` enables the catalog to reference catalogs in all namespaces. Subscriptions in any namespace can reference catalogs created in the `openshift-marketplace` namespace.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
catalogsource.operators.coreos.com/cs-redhat-operator-index created
|
||||
----
|
||||
|
||||
. Verify that the `CatalogSource` resources were successfully installed by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get catalogsource --all-namespaces
|
||||
----
|
||||
//add example output
|
||||
|
||||
. Verify that the catalog source is running by using the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get pods -n openshift-marketplace
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
cs-redhat-operator-index-4227b 2/2 Running 0 2m5s
|
||||
----
|
||||
|
||||
. Create a `Subscription` CR, similar to the following example:
|
||||
+
|
||||
.Example `Subscription` CR
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operators.coreos.com/v1alpha1
|
||||
kind: Subscription
|
||||
metadata:
|
||||
name: amq-broker
|
||||
namespace: openshift-operators
|
||||
spec:
|
||||
channel: 7.11.x
|
||||
name: amq-broker-rhel8
|
||||
source: cs-redhat-operator-index
|
||||
sourceNamespace: openshift-marketplace
|
||||
----
|
||||
|
||||
. Apply the Subscription CR configuration by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f ./<my-subscription-cr.yaml> <1>
|
||||
----
|
||||
<1> Specify the name of your subscription, such as `my-subscription-cr.yaml`.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
subscription.operators.coreos.com/amq-broker created
|
||||
----
|
||||
56
modules/microshift-oc-mirror-list-ops-catalogs.adoc
Normal file
56
modules/microshift-oc-mirror-list-ops-catalogs.adoc
Normal file
@@ -0,0 +1,56 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-oc-mirror-list-operators-catalogs_{context}"]
|
||||
= Inspecting catalog contents by using the oc-mirror plugin
|
||||
|
||||
Use the following example procedure to select a catalog and list Operators from available {OCP} content to add to your oc-mirror plugin image set configuration file.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you use your own catalogs and Operators, you can push the images directly to your internal registry.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
* The {oc-first} is installed.
|
||||
* Operator Lifecycle Manager (OLM) is installed.
|
||||
* The oc-mirror OpenShift CLI (oc) plugin is installed.
|
||||
|
||||
.Procedure
|
||||
. Get a list of available Red{nbsp}Hat-provided Operator catalogs to filter by running the following command:
|
||||
+
|
||||
[source,terminal,subs="attributes+"]
|
||||
----
|
||||
$ oc mirror list operators --version {product-version} --catalogs
|
||||
----
|
||||
|
||||
. Get a list of Operators in the Red{nbsp}Hat Operators catalog by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror list operators <--catalog=<catalog_source>> <1>
|
||||
----
|
||||
<1> Specifies your catalog source, such as `registry.redhat.io/redhat/redhat-operator-index:v{product-version}` or `quay.io/operatorhubio/catalog:latest`.
|
||||
|
||||
. Select an Operator. For this example, `amq-broker-rhel8` is selected.
|
||||
|
||||
. Optional: To inspect the channels and versions of the Operator you want to filter, enter the following commands:
|
||||
|
||||
.. Get a list of channels by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v4.15 --package=amq-broker-rhel8
|
||||
----
|
||||
.. Get a list of versions within a channel by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v4.15 --package=amq-broker-rhel8 --channel=7.11.x
|
||||
----
|
||||
|
||||
.Next steps
|
||||
* Create and edit an image set configuration file using the information gathered in this procedure.
|
||||
* Mirror the images from the transformed image set configuration file to a mirror registry or disk.
|
||||
93
modules/microshift-oc-mirror-transform-imageset-to-crio.adoc
Normal file
93
modules/microshift-oc-mirror-transform-imageset-to-crio.adoc
Normal file
@@ -0,0 +1,93 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-oc-mirror-transform-imageset-to-crio_{context}"]
|
||||
= Configuring CRI-O for using a registry mirror for Operators
|
||||
|
||||
You must transform the `imageContentSourcePolicy.yaml` file created with the oc-mirror plugin into a format that is compatible with the CRI-O container runtime configuration used by {microshift-short}.
|
||||
|
||||
.Prerequisites
|
||||
* The {oc-first} is installed.
|
||||
* Operator Lifecycle Manager (OLM) is installed.
|
||||
* The oc-mirror OpenShift CLI (oc) plugin is installed.
|
||||
* The `yq` binary is installed.
|
||||
* `ImageContentSourcePolicy` and `CatalogSource` YAML files are available in the `oc-mirror-workspace/results-*` directory.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Confirm the contents of the `imageContentSourcePolicy.yaml` file by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ cat oc-mirror-workspace/<results-directory>/imageContentSourcePolicy.yaml <1>
|
||||
----
|
||||
<1> Specify the `results` directory name, such as `<results-1707148826>`.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1alpha1
|
||||
kind: ImageContentSourcePolicy
|
||||
metadata:
|
||||
labels:
|
||||
operators.openshift.org/catalog: "true"
|
||||
name: operator-0
|
||||
spec:
|
||||
repositoryDigestMirrors:
|
||||
- mirrors:
|
||||
- registry.<example.com>/amq7
|
||||
source: registry.redhat.io/amq7
|
||||
----
|
||||
|
||||
. Transform the `imageContentSourcePolicy.yaml` into a format ready for CRI-O configuration by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
yq '.spec.repositoryDigestMirrors[] as $item ireduce([]; . + [{"mirror": $item.mirrors[], "source": ($item | .source)}]) | .[] |
|
||||
"[[registry]]
|
||||
prefix = \"" + .source + "\"
|
||||
location = \"" + .mirror + "\"
|
||||
mirror-by-digest-only = true
|
||||
insecure = true
|
||||
"' ./icsp.yaml
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
[[registry]]
|
||||
prefix = "registry.redhat.io/amq7"
|
||||
location = "registry.example.com/amq7"
|
||||
mirror-by-digest-only = true
|
||||
insecure = true
|
||||
----
|
||||
|
||||
. Add the output to the CRI-O configuration file in the `/etc/containers/registries.conf.d/` directory:
|
||||
+
|
||||
.Example `crio-config.yaml` mirror configuration file
|
||||
[source,yaml]
|
||||
----
|
||||
[[registry]]
|
||||
prefix = "registry.redhat.io/amq7"
|
||||
location = "registry.example.com/amq7"
|
||||
mirror-by-digest-only = true
|
||||
insecure = true
|
||||
|
||||
[[registry]]
|
||||
prefix = ""
|
||||
location = "quay.io"
|
||||
mirror-by-digest-only = true
|
||||
[[registry.mirror]]
|
||||
location = "<registry_host>:<port>" <1>
|
||||
insecure = false
|
||||
----
|
||||
<1> Specify the host name and port of your mirror registry server, for example `microshift-quay:8443`.
|
||||
|
||||
. Apply the CRI-O configuration changes by restarting {microshift-short} with the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo systemctl restart crio
|
||||
----
|
||||
@@ -1,6 +1,6 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift-operators-olm.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="microshift-options-building-operator-catalogs_{context}"]
|
||||
|
||||
19
modules/microshift-olm-deploy-op-disconnected-con.adoc
Normal file
19
modules/microshift-olm-deploy-op-disconnected-con.adoc
Normal file
@@ -0,0 +1,19 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="microshift-adding-OLM-Operators-to-disconnected-cluster_{context}"]
|
||||
= About adding OLM-based Operators to a disconnected cluster
|
||||
|
||||
For Operators that are installed on disconnected clusters, Operator Lifecycle Manager (OLM) by default cannot access sources hosted on remote registries because those remote sources require full internet connectivity. Therefore, you must mirror the remote registries to a highly available container registry.
|
||||
|
||||
The following steps are required to use OLM-based Operators in disconnected situations:
|
||||
|
||||
* Include OLM in the container image list for your mirror registry.
|
||||
* Configure the system to use your mirror registry by updating your CRI-O configuration directly. `ImageContentSourcePolicy` is not supported in {microshift-short}.
|
||||
* Add a `CatalogSource` object to the cluster so that the OLM catalog Operator can use the local catalog on the mirror registry.
|
||||
* Ensure that {microshift-short} is installed to run in a disconnected capacity.
|
||||
* Ensure that the network settings are configured to run in disconnected mode.
|
||||
|
||||
After enabling OLM in a disconnected cluster, you can continue to use your internet-connected workstation to keep your local catalog sources updated as newer versions of Operators are released.
|
||||
@@ -1,19 +0,0 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="microshift-adding-OLM-Operators-to-offline-cluster_{context}"]
|
||||
= About adding OLM-based Operators to an offline cluster
|
||||
|
||||
For {microshift-short} clusters that are installed on disconnected or offline clusters, Operator Lifecycle Manager (OLM) by default cannot access sources hosted on remote registries because those remote sources require full internet connectivity.
|
||||
|
||||
The following steps are required to use OLM-based Operators in offline situations:
|
||||
|
||||
* Include OLM in your container image list for your mirror registry.
|
||||
* Configure the system to use the mirror by updating your CRI-O configuration directly. `ImageContentSourcePolicy` is not supported in {microshift-short}.
|
||||
* Add a `CatalogSource` object to the cluster so that the OLM catalog Operator can use the local catalog on the mirror registry.
|
||||
* Ensure that {microshift-short} is installed to run in an offline capacity.
|
||||
* Ensure that the network settings are configured to run in a disconnected mode.
|
||||
|
||||
After enabling OLM in an offline cluster, you can continue to use your unrestricted workstation to keep your local catalog sources updated as newer versions of Operators are released.
|
||||
@@ -1,10 +1,10 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift-operators-olm.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="microshift-deploy-operators_{context}"]
|
||||
= How to deploy Operators
|
||||
[id="microshift-olm-deploy-operators_{context}"]
|
||||
= How to deploy Operators using OLM
|
||||
|
||||
After you create and deploy your custom catalog, you must create a Subscription custom resource (CR) that can access the catalog and install the Operators you choose. Where Operators run depends on the namespace in which you create the Subscription CR.
|
||||
|
||||
@@ -13,8 +13,8 @@ After you create and deploy your custom catalog, you must create a Subscription
|
||||
Operators in OLM have a watch scope. For example, some Operators only support watching their own namespace, while others support watching every namespace in the cluster. All Operators installed in a given namespace must have the same watch scope.
|
||||
====
|
||||
|
||||
[id="microshift-operators-connection-details_{context}"]
|
||||
== Connectivity and Operator deployment
|
||||
[id="microshift-olm-operators-connection-details_{context}"]
|
||||
== Connectivity and OLM Operator deployment
|
||||
Operators can be deployed anywhere a catalog is running.
|
||||
|
||||
* For clusters that are connected to the internet, mirroring images is not required. Images can be pulled over the network.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift-operators-olm.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-OLM-deploy-Operators_{context}"]
|
||||
@@ -75,16 +75,16 @@ spec:
|
||||
interval: 60m
|
||||
----
|
||||
<1> The global namespace. Setting the `metadata.namespace` to `openshift-marketplace` enables the catalog to run in all namespaces. Subscriptions in any namespace can reference catalogs created in the `openshift-marketplace` namespace.
|
||||
<2> Community Operators are not installed by default with OLM for {miroshift-short}. Listed here for example only.
|
||||
<2> Community Operators are not installed by default with OLM for {microshift-short}. Listed here for example only.
|
||||
<3> The value of `securityContextConfig` must be set to `restricted` for {microshift-short}.
|
||||
|
||||
. Apply the `CatalogSource` configuration by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f _<my-catalog-source.yaml>_ <1>
|
||||
$ oc apply -f <my-catalog-source.yaml> <1>
|
||||
----
|
||||
<1> Replace _<my-catalog-source.yaml>_ with your catalog source configuration file name. In this example, `catalogsource.yaml` is used.
|
||||
<1> Replace `<my-catalog-source.yaml>` with your catalog source configuration file name. In this example, `catalogsource.yaml` is used.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
@@ -174,9 +174,9 @@ spec:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f _<my-subscription-cr.yaml>_ <1>
|
||||
$ oc apply -f <my-subscription-cr.yaml> <1>
|
||||
----
|
||||
<1> Replace _<my-subscription-cr.yaml>_ with your Subscription CR filename. In this example, `sub.yaml` is used.
|
||||
<1> Replace `<my-subscription-cr.yaml>` with your Subscription CR filename. In this example, `sub.yaml` is used.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift-operators-olm.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-OLM-deploy-Operators-specific-namespace_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift-operators-olm.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="microshift-olm-namespaces_{context}"]
|
||||
|
||||
134
modules/microshift-ops-config-embed-ostree.adoc
Normal file
134
modules/microshift-ops-config-embed-ostree.adoc
Normal file
@@ -0,0 +1,134 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="microshift-apply-ops-ostree-disconnected-use_{context}"]
|
||||
= Applying catalogs and Operators in a disconnected-deployment RHEL for Edge image
|
||||
|
||||
After you have created a {op-system-ostree} image for a disconnected environment and configured {microshift-short} networking settings for disconnected use, you can configure the namespace and create catalog and Operator custom resources (CR) for running your Operators.
|
||||
|
||||
.Prerequisites
|
||||
* You have a {op-system-ostree} image.
|
||||
* Networking is configured for disconnected use.
|
||||
* You completed the oc-mirror plugin dry run procedure.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Create a `CatalogSource` custom resource (CR), similar to the following example:
|
||||
+
|
||||
.Example `my-catalog-source-cr.yaml` file
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operators.coreos.com/v1alpha1
|
||||
kind: CatalogSource
|
||||
metadata:
|
||||
name: cs-redhat-operator-index
|
||||
namespace: openshift-marketplace <1>
|
||||
spec:
|
||||
image: registry.example.com/redhat/redhat-operator-index:v4.15
|
||||
sourceType: grpc
|
||||
displayName:
|
||||
publisher:
|
||||
updateStrategy:
|
||||
registryPoll:
|
||||
interval: 60m
|
||||
----
|
||||
<1> The global namespace. Setting the `metadata.namespace` to `openshift-marketplace` enables the catalog to run in all namespaces. Subscriptions in any namespace can reference catalogs created in the `openshift-marketplace` namespace.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The default pod security admission definition for `openshift-marketplace` is `baseline`, therefore a catalog source custom resource (CR) created in that namespace does not require a `spec.grpcPodConfig.securityContextConfig` value to be set. You can set a `legacy` or `restricted` value if required for the namespace and Operators you want to use.
|
||||
====
|
||||
|
||||
. Add the SHA of the catalog index commit to the Catalog Source (CR), similar to the following example:
|
||||
+
|
||||
.Example namespace `spec.image` configuration
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operators.coreos.com/v1alpha1
|
||||
kind: CatalogSource
|
||||
metadata:
|
||||
name: cs-redhat-operator-index
|
||||
namespace: openshift-marketplace
|
||||
spec:
|
||||
image: registry.example.com/redhat/redhat-operator-index@sha256:7a76c0880a839035eb6e896d54ebd63668bb37b82040692141ba39ab4c539bc6 <1>
|
||||
sourceType: grpc
|
||||
displayName:
|
||||
publisher:
|
||||
updateStrategy:
|
||||
registryPoll:
|
||||
interval: 60m
|
||||
----
|
||||
<1> The SHA of the image commit. Use the same SHA you added to the Image Builder blueprint.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must use the SHA instead of a tag in your catalog CR or the pod fails to start.
|
||||
====
|
||||
|
||||
. Apply the YAML file from the oc-mirror plugin dry run results directory to the cluster by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f ./oc-mirror-workspace/results-1708508014/catalogSource-cs-redhat-operator-index.yaml
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
catalogsource.operators.coreos.com/cs-redhat-operator-index created
|
||||
----
|
||||
|
||||
. Verify that the `CatalogSource` resources were successfully installed by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get catalogsource --all-namespaces
|
||||
----
|
||||
//Example output
|
||||
|
||||
. Verify that the catalog source is running by using the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get pods -n openshift-marketplace
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
cs-redhat-operator-index-4227b 2/2 Running 0 2m5s
|
||||
----
|
||||
|
||||
. Create a `Subscription` CR, similar to the following example:
|
||||
+
|
||||
.Example `my-subscription-cr.yaml` file
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operators.coreos.com/v1alpha1
|
||||
kind: Subscription
|
||||
metadata:
|
||||
name: amq-broker
|
||||
namespace: openshift-operators
|
||||
spec:
|
||||
channel: 7.11.x
|
||||
name: amq-broker-rhel8
|
||||
source: cs-redhat-operator-index
|
||||
sourceNamespace: openshift-marketplace
|
||||
----
|
||||
|
||||
. Apply the `Subscription` CR by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc apply -f ./<my-subscription-cr.yaml> <1>
|
||||
----
|
||||
<1> Specify the name of your `Subscription` CR, such as `my-subscription-cr.yaml`.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
subscription.operators.coreos.com/amq-broker created
|
||||
----
|
||||
@@ -2,12 +2,13 @@
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-olm.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="oc-mirror-dry-run_{context}"]
|
||||
= Performing a dry run
|
||||
|
||||
You can use oc-mirror to perform a dry run, without actually mirroring any images. This allows you to review the list of images that would be mirrored, as well as any images that would be pruned from the mirror registry. It also allows you to catch any errors with your image set configuration early or use the generated list of images with other tools to carry out the mirroring operation.
|
||||
You can use oc-mirror to perform a dry run, without actually mirroring any images. This allows you to review the list of images that would be mirrored, as well as any images that would be pruned from the mirror registry. A dry run also allows you to catch any errors with your image set configuration early or use the generated list of images with other tools to carry out the mirroring operation.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
|
||||
// * microshift_running_apps/microshift_operators//microshift-operators-olm.com
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="oc-mirror-imageset-config-params_{context}"]
|
||||
@@ -22,10 +23,14 @@ The oc-mirror plugin requires an image set configuration file that defines what
|
||||
|The API version for the `ImageSetConfiguration` content.
|
||||
|String. For example: `mirror.openshift.io/v1alpha2`.
|
||||
|
||||
ifndef::microshift[]
|
||||
|
||||
|`archiveSize`
|
||||
|The maximum size, in GiB, of each archive file within the image set.
|
||||
|Integer. For example: `4`
|
||||
|
||||
endif::microshift[]
|
||||
|
||||
|`mirror`
|
||||
|The configuration of the image set.
|
||||
|Object
|
||||
@@ -48,6 +53,8 @@ additionalImages:
|
||||
|The full tag, digest, or pattern of images to block from mirroring.
|
||||
|Array of strings. For example: `docker.io/library/alpine`
|
||||
|
||||
ifndef::microshift[]
|
||||
|
||||
|`mirror.helm`
|
||||
|The helm configuration of the image set. Note that the oc-mirror plugin supports only helm charts that do not require user input when rendered.
|
||||
|Object
|
||||
@@ -105,6 +112,8 @@ repositories:
|
||||
|The version of the named helm chart to mirror.
|
||||
|String. For example: `5.0.0`.
|
||||
|
||||
endif::microshift[]
|
||||
|
||||
|`mirror.operators`
|
||||
|The Operators configuration of the image set.
|
||||
|Array of objects. For example:
|
||||
@@ -190,6 +199,8 @@ The `targetName` parameter is deprecated. Use the `targetCatalog` parameter inst
|
||||
|An alternative tag to append to the `targetName` or `targetCatalog`.
|
||||
|String. For example: `v1`
|
||||
|
||||
ifndef::microshift[]
|
||||
|
||||
|`mirror.platform`
|
||||
|The platform configuration of the image set.
|
||||
|Object
|
||||
@@ -249,6 +260,8 @@ channels:
|
||||
|Indicates whether the OSUS graph is added to the image set and subsequently published to the mirror.
|
||||
|Boolean. The default value is `false`.
|
||||
|
||||
endif::microshift[]
|
||||
|
||||
|`storageConfig`
|
||||
|The back-end configuration of the image set.
|
||||
|Object
|
||||
@@ -277,9 +290,9 @@ channels:
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Using the `minVersion` and `maxVersion` properties to filter for a specific Operator version range can result in a multiple channel heads error. The error message will state that there are `multiple channel heads`. This is because when the filter is applied, the update graph of the operator is truncated.
|
||||
Using the `minVersion` and `maxVersion` properties to filter for a specific Operator version range can result in a multiple channel heads error. The error message states that there are `multiple channel heads`. This is because when the filter is applied, the update graph of the Operator is truncated.
|
||||
|
||||
The Operator Lifecycle Manager requires that every operator channel contains versions that form an update graph with exactly one end point, that is, the latest version of the operator. When applying the filter range that graph can turn into two or more separate graphs or a graph that has more than one end point.
|
||||
Operator Lifecycle Manager requires that every Operator channel contains versions that form an update graph with exactly one end point, that is, the latest version of the Operator. When the filter range is applied, that graph can turn into two or more separate graphs or a graph that has more than one end point.
|
||||
|
||||
To avoid this error, do not filter out the latest version of an operator. If you still run into the error, depending on the operator, either the `maxVersion` property needs to be increased or the `minVersion` property needs to be decreased. Because every operator graph can be different, you might need to adjust these values, according to the procedure, until the error is gone.
|
||||
To avoid this error, do not filter out the latest version of an Operator. If you still run into the error, depending on the Operator, either the `maxVersion` property must be increased or the `minVersion` property must be decreased. Because every Operator graph can be different, you might need to adjust these values until the error resolves.
|
||||
====
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
//
|
||||
// * installing/disconnected_install/installing-mirroring-disconnected.adoc
|
||||
// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
|
||||
// * microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="oc-mirror-mirror-to-mirror_{context}"]
|
||||
@@ -18,7 +19,7 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have access to the internet to obtain the necessary container images.
|
||||
* You have access to the internet to get the necessary container images.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
* You have installed the `oc-mirror` CLI plugin.
|
||||
* You have created the image set configuration file.
|
||||
@@ -29,27 +30,46 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc mirror --config=./imageset-config.yaml \// <1>
|
||||
$ oc mirror --config=./<imageset-config.yaml> \// <1>
|
||||
docker://registry.example:5000 <2>
|
||||
----
|
||||
<1> Pass in the image set configuration file that was created. This procedure assumes that it is named `imageset-config.yaml`.
|
||||
<1> Specify the image set configuration file that you created. For example, `imageset-config.yaml`.
|
||||
<2> Specify the registry to mirror the image set file to. The registry must start with `docker://`. If you specify a top-level namespace for the mirror registry, you must also use this same namespace on subsequent executions.
|
||||
|
||||
ifdef::microshift[]
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
Rendering catalog image "registry.example.com/redhat/redhat-operator-index:v{ocp-version}" with file-based catalog
|
||||
----
|
||||
endif::microshift[]
|
||||
|
||||
.Verification
|
||||
|
||||
. Navigate into the `oc-mirror-workspace/` directory that was generated.
|
||||
. Navigate into the results directory, for example, `results-1639608409/`.
|
||||
. Verify that YAML files are present for the `ImageContentSourcePolicy` and `CatalogSource` resources.
|
||||
|
||||
ifndef::microshift[]
|
||||
[NOTE]
|
||||
====
|
||||
The `repositoryDigestMirrors` section of the `ImageContentSourcePolicy` YAML file is used for the `install-config.yaml` file during installation.
|
||||
====
|
||||
+
|
||||
endif::microshift[]
|
||||
// TODO: Test and get some better wording/example output.
|
||||
|
||||
.Next steps
|
||||
ifdef::microshift[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
The `ImageContentSourcePolicy` YAML file is used as reference content for manual configuration of CRI-O in {microshift-short}. You cannot apply the resource directly into a {microshift-short} cluster.
|
||||
====
|
||||
endif::microshift[]
|
||||
|
||||
.Next steps
|
||||
ifdef::microshift[]
|
||||
* Convert the `ImageContentSourcePolicy` YAML content for use in manually configuring CRI-O.
|
||||
* If required, mirror the images from mirror to disk for disconnected or offline use.
|
||||
endif::microshift[]
|
||||
* Configure your cluster to use the resources generated by oc-mirror.
|
||||
|
||||
.Troubleshooting
|
||||
|
||||
Reference in New Issue
Block a user