Merge pull request #86791 from adellape/v1_disconn

adellape · web-flow · commit d064598775dd · 2025-02-17T14:17:24.000-07:00
OSDOCS#12433: Add disconnected support for OLM v1
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2095,6 +2095,8 @@ Topics:
     File: managing-catalogs
   - Name: Creating catalogs
     File: creating-catalogs
+  - Name: Disconnected environment support in OLM v1
+    File: disconnected-catalogs
 - Name: Cluster extensions
   Dir: ce
   Topics:
diff --git a/disconnected/mirroring/about-installing-oc-mirror-v2.adoc b/disconnected/mirroring/about-installing-oc-mirror-v2.adoc
@@ -8,7 +8,7 @@ toc::[]
 
 You can run your cluster in a disconnected environment if you install the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running whenever your cluster is running.
 
-Just as you can use the `oc-mirror` OpenShift CLI (`oc`) plugin, you can also use oc-mirror plugin v2 to mirror images to a mirror registry in your fully or partially disconnected environments. To download the required images from the official Red{nbsp}Hat registries, you must run oc-mirror plugin v2 from a system with internet connectivity.
+Just as you can use the oc-mirror OpenShift CLI (`oc`) plugin, you can also use oc-mirror plugin v2 to mirror images to a mirror registry in your fully or partially disconnected environments. To download the required images from the official Red{nbsp}Hat registries, you must run oc-mirror plugin v2 from a system with internet connectivity.
 
 :FeatureName: oc-mirror plugin v2
 include::snippets/technology-preview.adoc[]
@@ -63,7 +63,7 @@ include::modules/oc-mirror-workflows-fully-disconnected-v2.adoc[leveloffset=+2]
 include::modules/oc-mirror-mirror-to-disk-v2.adoc[leveloffset=+2]
 include::modules/oc-mirror-disk-to-mirror-v2.adoc[leveloffset=+2]
 
-// About custom resources generated by v2
+// About custom resources generated by oc-mirror plugin v2
 include::modules/oc-mirror-IDMS-ITMS-about.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
@@ -73,10 +73,17 @@ include::modules/oc-mirror-IDMS-ITMS-about.adoc[leveloffset=+1]
 
 * xref:../../rest_api/config_apis/imagetagmirrorset-config-openshift-io-v1.adoc#imagetagmirrorset-config-openshift-io-v1[ImageTagMirrorSet]
 
+* xref:../../extensions/catalogs/managing-catalogs.adoc#olmv1-about-catalogs_managing-catalogs[About catalogs in {olmv1}]
+
 // Configuring your cluster to use the resources generated by oc-mirror
 include::modules/oc-mirror-updating-cluster-manifests-v2.adoc[leveloffset=+2]
 
-Once your cluster is configured to use the resources generated by oc-mirror plugin v2, see xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#next-steps_about-installing-oc-mirror-v2[Next Steps] for information about tasks that you can perform using your mirrored images.
+After your cluster is configured to use the resources generated by oc-mirror plugin v2, see xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#next-steps_about-installing-oc-mirror-v2[Next Steps] for information about tasks that you can perform using your mirrored images.
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../extensions/catalogs/disconnected-catalogs.adoc#disconnected-catalogs[Disconnected environment support in {olmv1}]
 
 //Delete Feature
 // workflows of delete feature
diff --git a/disconnected/mirroring/installing-mirroring-disconnected.adoc b/disconnected/mirroring/installing-mirroring-disconnected.adoc
@@ -96,6 +96,11 @@ include::modules/oc-mirror-disk-to-mirror.adoc[leveloffset=+3]
 // Configuring your cluster to use the resources generated by oc-mirror
 include::modules/oc-mirror-updating-cluster-manifests.adoc[leveloffset=+1]
 
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../extensions/catalogs/managing-catalogs.adoc#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs[Adding a catalog to a cluster] in "Extensions"
+
 // About updating your mirror registry content
 include::modules/oc-mirror-updating-registry-about.adoc[leveloffset=+1]
 
diff --git a/extensions/catalogs/disconnected-catalogs.adoc b/extensions/catalogs/disconnected-catalogs.adoc
@@ -0,0 +1,16 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="disconnected-catalogs"]
+= Disconnected environment support in {olmv1}
+include::_attributes/common-attributes.adoc[]
+:context: disconnected-catalogs
+
+toc::[]
+
+To support cluster administrators that prioritize high security by running their clusters in internet-disconnected environments, especially for mission-critical production workloads, {olmv1-first} includes cluster extension lifecycle management functionality that works within these disconnected environments, starting in {product-title} 4.18.
+
+include::modules/olmv1-about-disconnected.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin v1]
+* xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation using the oc-mirror plugin v2]
diff --git a/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc b/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc
@@ -60,6 +60,12 @@ Complete the following steps to complete the configuration of your cluster.
 
 include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2]
 include::modules/oc-mirror-updating-restricted-cluster-manifests.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../extensions/catalogs/managing-catalogs.adoc#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs[Adding a catalog to a cluster] in "Extensions"
+
 include::modules/registry-configuring-storage-nutanix.adoc[leveloffset=+2]
 
 include::modules/cluster-telemetry.adoc[leveloffset=+1]
diff --git a/modules/oc-mirror-IDMS-ITMS-about.adoc b/modules/oc-mirror-IDMS-ITMS-about.adoc
@@ -4,13 +4,18 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="oc-mirror-custom-resources-v2_{context}"]
-= About custom resources generated by v2
+= About custom resources generated by oc-mirror plugin v2
 
 // Should sentence below say "to which a digest or tag refers"?
 
-With oc-mirror plugin v2, `ImageDigestMirrorSet` (IDMS) resources are generated by default if at least one image of the image set is mirrored by digest.
-`ImageTagMirrorSet` (ITMS) resources are generated if at least one image from the image set is mirrored by tag.
+The oc-mirror plugin v2 automatically generates the following custom resources:
 
-Operator Lifecycle Manager (OLM) uses the `CatalogSource` resource to retrieve information about the available Operators in the mirror registry.
+`ImageDigestMirrorSet` (IDMS):: Handles registry mirror rules when using image digest pull specifications. Generated if at least one image of the image set is mirrored by digest.
 
-The OpenShift Update Service uses the `UpdateService` resource to provide update graph data to the disconnected environment.
+`ImageTagMirrorSet` (ITMS):: Handles registry mirror rules when using image tag pull specifications. Generated if at least one image from the image set is mirrored by tag.
+
+`CatalogSource`:: Retrieves information about the available Operators in the mirror registry. Used by {olmv0-first}.
+
+`ClusterCatalog`:: Retrieves information about the available cluster extensions (which includes Operators) in the mirror registry. Used by {olmv1}.
+
+`UpdateService`:: Provides update graph data to the disconnected environment. Used by the OpenShift Update Service.
diff --git a/modules/oc-mirror-disk-to-mirror.adoc b/modules/oc-mirror-disk-to-mirror.adoc
@@ -12,7 +12,7 @@ You can use the oc-mirror plugin to mirror the contents of a generated image set
 .Prerequisites
 
 * You have installed the OpenShift CLI (`oc`) in the disconnected environment.
-* You have installed the `oc-mirror` CLI plugin in the disconnected environment.
+* You have installed the oc-mirror CLI plugin in the disconnected environment.
 * You have generated the image set file by using the `oc mirror` command.
 * You have transferred the image set file to the disconnected environment.
 // TODO: Confirm prereq about not needing a cluster, but need pull secret misc
diff --git a/modules/oc-mirror-dry-run.adoc b/modules/oc-mirror-dry-run.adoc
@@ -14,7 +14,7 @@ You can use oc-mirror to perform a dry run, without actually mirroring any image
 
 * You have access to the internet to obtain the necessary container images.
 * You have installed the OpenShift CLI (`oc`).
-* You have installed the `oc-mirror` CLI plugin.
+* You have installed the oc-mirror CLI plugin.
 * You have created the image set configuration file.
 
 .Procedure
diff --git a/modules/oc-mirror-imageset-config-parameters-v2.adoc b/modules/oc-mirror-imageset-config-parameters-v2.adoc
@@ -78,7 +78,7 @@ Example: `registry.redhat.io/ubi8/ubi:latest`
 Example: `docker.io/library/alpine`
 
 |`mirror.helm`
-|The helm configuration of the image set. The `oc-mirror` plugin does not support helm charts with manually modified `values.yaml` files.
+|The helm configuration of the image set. The oc-mirror plugin does not support helm charts with manually modified `values.yaml` files.
 |Object
 
 |`mirror.helm.local`
diff --git a/modules/oc-mirror-mirror-to-disk.adoc b/modules/oc-mirror-mirror-to-disk.adoc
@@ -27,7 +27,7 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin.
 
 * You have access to the internet to obtain the necessary container images.
 * You have installed the OpenShift CLI (`oc`).
-* You have installed the `oc-mirror` CLI plugin.
+* You have installed the oc-mirror CLI plugin.
 * You have created the image set configuration file.
 // TODO: Don't need a running cluster, but need some pull secrets. Sync w/ team on this
 
diff --git a/modules/oc-mirror-mirror-to-mirror.adoc b/modules/oc-mirror-mirror-to-mirror.adoc
@@ -21,7 +21,7 @@ Do not delete or modify the metadata that is generated by the oc-mirror plugin.
 
 * 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 installed the oc-mirror CLI plugin.
 * You have created the image set configuration file.
 
 .Procedure
diff --git a/modules/oc-mirror-oci-format.adoc b/modules/oc-mirror-oci-format.adoc
@@ -29,7 +29,7 @@ If you used the Technology Preview OCI local catalogs feature for the oc-mirror
 
 * You have access to the internet to obtain the necessary container images.
 * You have installed the OpenShift CLI (`oc`).
-* You have installed the `oc-mirror` CLI plugin.
+* You have installed the oc-mirror CLI plugin.
 
 .Procedure
 
diff --git a/modules/oc-mirror-updating-cluster-manifests-v2.adoc b/modules/oc-mirror-updating-cluster-manifests-v2.adoc
@@ -51,3 +51,10 @@ $ oc get imagetagmirrorset
 ----
 $ oc get catalogsource -n openshift-marketplace
 ----
+
+. Verify that the `ClusterCatalog` resources are successfully installed by running the following command:
++
+[source,terminal]
+----
+$ oc get clustercatalog
+----
diff --git a/modules/oc-mirror-updating-cluster-manifests.adoc b/modules/oc-mirror-updating-cluster-manifests.adoc
@@ -1,15 +1,21 @@
 // Module included in the following assemblies:
 //
-// * installing/disconnected_install/installing-mirroring-disconnected.adoc
-// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
+// * disconnected/mirroring/installing-mirroring-disconnected.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="oc-mirror-updating-cluster-manifests_{context}"]
 = Configuring your cluster to use the resources generated by oc-mirror
 
 After you have mirrored your image set to the mirror registry, you must apply the generated `ImageContentSourcePolicy`, `CatalogSource`, and release image signature resources into the cluster.
 
-The `ImageContentSourcePolicy` resource associates the mirror registry with the source registry and redirects image pull requests from the online registries to the mirror registry. The `CatalogSource` resource is used by Operator Lifecycle Manager (OLM) to retrieve information about the available Operators in the mirror registry. The release image signatures are used to verify the mirrored release images.
+The `ImageContentSourcePolicy` resource associates the mirror registry with the source registry and redirects image pull requests from the online registries to the mirror registry. The `CatalogSource` resource is used by {olmv0-first} to retrieve information about the available Operators in the mirror registry. The release image signatures are used to verify the mirrored release images.
+
+[NOTE]
+====
+{olmv1} uses the `ClusterCatalog` resource to retrieve information about the available cluster extensions in the mirror registry.
+
+The oc-mirror plugin v1 does not generate `ClusterCatalog` resources automatically; you must manually create them. For more information on creating and applying `ClusterCatalog` resources, see "Adding a catalog to a cluster" in "Extensions".
+====
 
 .Prerequisites
 
@@ -18,7 +24,7 @@ The `ImageContentSourcePolicy` resource associates the mirror registry with the
 
 .Procedure
 
-. Log in to the OpenShift CLI as a user with the `cluster-admin` role.
+. Log in to {oc-first} as a user with the `cluster-admin` role.
 
 . Apply the YAML files from the results directory to the cluster by running the following command:
 +
diff --git a/modules/oc-mirror-updating-restricted-cluster-manifests.adoc b/modules/oc-mirror-updating-restricted-cluster-manifests.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
+// * installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="oc-mirror-updating-cluster-manifests_{context}"]
@@ -9,7 +9,16 @@
 Mirroring the {product-title} content using the oc-mirror OpenShift CLI (oc) plugin creates resources, which include `catalogSource-certified-operator-index.yaml` and `imageContentSourcePolicy.yaml`.
 
 * The `ImageContentSourcePolicy` resource associates the mirror registry with the source registry and redirects image pull requests from the online registries to the mirror registry.
-* The `CatalogSource` resource is used by Operator Lifecycle Manager (OLM) to retrieve information about the available Operators in the mirror registry, which lets users discover and install Operators.
+* The `CatalogSource` resource is used by {olmv0-first} to retrieve information about the available Operators in the mirror registry, which lets users discover and install Operators.
++
+[NOTE]
+====
+{olmv1} uses the `ClusterCatalog` resource to retrieve information about the available cluster extensions in the mirror registry.
+
+The oc-mirror plugin v1 does not generate `ClusterCatalog` resources automatically; you must manually create them. The oc-mirror plugin v2 does, however, generate `ClusterCatalog` resources automatically.
+
+For more information on creating and applying `ClusterCatalog` resources, see "Adding a catalog to a cluster" in "Extensions".
+====
 
 After you install the cluster, you must install these resources into the cluster.
 
diff --git a/modules/olmv1-about-disconnected.adoc b/modules/olmv1-about-disconnected.adoc
@@ -0,0 +1,20 @@
+// Module included in the following assemblies:
+//
+// * extensions/catalogs/disconnected-catalogs.adoc
+
+:_mod-docs-content-type: CONCEPT
+
+[id="olmv1-about-disconnected_{context}"]
+= About disconnected support and the oc-mirror plugin in {olmv1}
+
+{olmv1-first} supports disconnected environments starting in {product-title} 4.18. After using the oc-mirror plugin for the {oc-first} to mirror the images required for your cluster to a mirror registry in your fully or partially disconnected environments, {olmv1} can function properly in these environments by utilizing either of the following sets of resources, depending on which oc-mirror plugin version you are using:
+
+* `ImageContentSourcePolicy` resources, which are automatically generated by oc-mirror plugin v1, and `ClusterCatalog` resources, which must be manually created after using oc-mirror plugin v1
+* `ImageDigestMirrorSet`, `ImageTagMirrorSet`, and `ClusterCatalog` resources, which are all automatically generated by oc-mirror plugin v2
+
+[NOTE]
+====
+Starting in {product-title} 4.18, oc-mirror plugin v2 is the recommended version for mirroring.
+====
+
+For more information and procedures, see the _Disconnected environments_ guide for the oc-mirror plugin version you plan to use.
diff --git a/modules/olmv1-adding-a-catalog.adoc b/modules/olmv1-adding-a-catalog.adoc
@@ -1,13 +1,13 @@
 // Module included in the following assemblies:
 //
-// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc
+// * extensions/catalogs/managing-catalogs.adoc
 
 :_mod-docs-content-type: PROCEDURE
 
 [id="olmv1-adding-a-catalog-to-a-cluster_{context}"]
 = Adding a catalog to a cluster
 
-To add a catalog to a cluster, create a catalog custom resource (CR) and apply it to the cluster.
+To add a catalog to a cluster for {olmv1-first} usage, create a `ClusterCatalog` custom resource (CR) and apply it to the cluster.
 
 .Procedure
 
@@ -113,4 +113,4 @@ Events:                   <none>
 <1> Describes the status of the catalog.
 <2> Displays the reason the catalog is in the current state.
 <3> Displays the phase of the installation process.
-<4> Displays the image reference of the catalog.
+<4> Displays the image reference of the catalog.
