Merge pull request #76917 from subhtk/ocm-v2-assembly-1

OSDOCS-8197: Added oc-mirror v2 section in disconnected installing assembly

Author: ShaunaDiaz

_topic_maps/_topic_map.yml

@@ -1,3 +1,4 @@
+# trunk-ignore-all(prettier)
 # This configuration file dictates the organization of the topic groups and
 # topics on the main page of the doc site for this branch. Each record
 # consists of the following:
@@ -131,6 +132,8 @@ Topics:
     File: installing-mirroring-installation-images
   - Name: Mirroring images for a disconnected installation using the oc-mirror plugin
     File: installing-mirroring-disconnected
+  - Name: Mirroring images for a disconnected installation using oc-mirror V2
+    File: about-installing-oc-mirror-v2
 - Name: Installing on Alibaba
   Dir: installing_alibaba
   Distros: openshift-origin,openshift-enterprise

installing/disconnected_install/about-installing-oc-mirror-v2.adoc

@@ -0,0 +1,53 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="about-installing-oc-mirror-v2"]
+= Mirroring images for a disconnected installation using the version 2
+include::_attributes/common-attributes.adoc[]
+:context: installing-mirroring-disconnected
+
+toc::[]
+
+:FeatureName: oc-mirror version 2
+include::snippets/technology-preview.adoc[]
+
+Running your cluster in a restricted network without direct internet connectivity is possible by installing the cluster from a mirrored set of {product-title} container images in a private registry. This registry must be running at all times provided that the cluster is running. See "Prerequisites" section for more information.
+
+You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror images to a mirror registry in your fully or partially disconnected environments. You must run oc-mirror from a system with internet connectivity in order to download the required images from the official Red Hat registries.
+
+.High level workflow
+
+The following steps outline the high-level workflow on how to use the oc-mirror plugin to mirror images to a mirror registry:
+
+. Create an image set configuration file.
+
+. Mirror the image set to the target mirror registry by using one of the following workflows:
+
+** Mirror an image set directly to the target mirror registry (Mirror-to-Mirror).
+
+** Mirror an image set to disk (Mirror-to-Disk), transfer the tar file to the target environment, then mirror the image set to the target mirror registry (Disk-to-Mirror).
+
+. Configure your cluster to use the resources generated by the oc-mirror.
+
+. Repeat these steps to update your target mirror registry as necessary.
+
+// AboutVv2
+include::modules/oc-mirror-v2-about.adoc[leveloffset=+1]
+
+// oc-mirror compatibility and support
+include::modules/oc-mirror-v2-support.adoc[leveloffset=+1]
+
+
+[id="prerequisites_oc-mirror-v2_{context}"]
+== Prerequisites
+
+* You must have a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker V2-2] in the location that will host the {product-title} cluster, such as Red Hat Quay.
++
+[NOTE]
+====
+If you use Red Hat Quay, you must use version 3.6 or later with the oc-mirror plugin. If you have an entitlement to Red Hat Quay, see the documentation on deploying Red Hat Quay link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploy_red_hat_quay_for_proof-of-concept_non-production_purposes/[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index[by using the Red Hat Quay Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support.
+====
+
+If you do not have an existing solution for a container image registry, {product-title} subscribers receive a mirror registry for Red Hat OpenShift. This mirror registry is included with your subscription and serves as a small-scale container registry that can be used to mirror the necessary container images of {product-title} for disconnected installations.
+
+* Every machine in the provisioned clusters must have access to the mirror registry. If the registry is unreachable, tasks like installation, updating, or routine operations such as workload relocation may fail. Therefore, mirror registries must be operated in a highly available manner, ensuring their availability aligns with the production availability of your {product-title} clusters.
+
+* You have set the umask parameter to `0022` on the operating system that uses oc-mirror.

modules/oc-mirror-support.adoc

@@ -14,10 +14,4 @@ The oc-mirror plugin supports mirroring {product-title} payload images and Opera
 On `aarch64`, `ppc64le`, and `s390x` architectures the oc-mirror plugin is only supported for {product-title} versions 4.14 and later.
 ====
 
-Use the latest available version of the oc-mirror plugin regardless of which versions of {product-title} you need to mirror.
-
-// TODO: Remove this in 4.14
-[IMPORTANT]
-====
-If you used the Technology Preview OCI local catalogs feature for the oc-mirror plugin for {product-title} 4.12, you can no longer use the OCI local catalogs feature of the oc-mirror plugin to copy a catalog locally and convert it to OCI format as a first step to mirroring to a fully disconnected cluster.
-====
+Use the latest available version of the oc-mirror plugin regardless of which versions of {product-title} you need to mirror.

modules/oc-mirror-v2-about.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// * installing/disconnected_install/about-installing-oc-mirror-v2.adoc
+// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="installation-oc-mirror-v2-about_{context}"]
+= About oc-mirror plugin version 2
+You can use the oc-mirror OpenShift CLI (`oc`) plugin as a single tool to mirror all required {product-title} content and other images to your mirror registry.
+
+To use oc-mirror, add the `--v2` flag to the oc-mirror command line. The new tool is is available as a Tech Preview feature. 
+
+oc-mirror version 2 (V2) provides the following features:
+
+* Verifies that the complete image set specified in the image set config is mirrored to the mirrored registry, regardless of whether the images were previously mirrored or not.
+
+* Uses a cache system instead of metadata.
+
+* Maintains minimal archive sizes by incorporating only new images into the archive.
+
+* Generate mirroring archives with content selected by mirroring date.
+
+* Can generate IDMS and ITMS (instead of ICSP) for the full image set, rather than just the incremental changes.
+
+* Filter Operator versions by bundle name.
+
+* Does not perform automatic pruning; instead, it introduces a `Delete` feature, granting users more control over the image deletion.
+
+* Introduces support for `registries.conf`, facilitating mirroring to multiple enclaves using the same cache.

modules/oc-mirror-v2-support.adoc

@@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * installing/disconnected_install/installing-mirroring-disconnected.adoc
+// * installing/disconnected_install/about-installing-oc-mirror-v2.adoc
+// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="oc-mirror-v2-support_{context}"]
+= oc-mirror V2 compatibility and support
+
+The oc-mirror plugin V2 supports mirroring {product-title} payload images and Operator catalogs for {product-title} versions 4.12 and later.
+
+[NOTE]
+====
+On `aarch64`, `ppc64le`, and `s390x` architectures the oc-mirror plugin is only supported for {product-title} versions 4.14 and later.
+====
+
+Use the latest available version of the oc-mirror plugin regardless of which versions of {product-title} you need to mirror.