Merge pull request #89383 from xenolinux/image-set-config

OCPBUGS#51001: Update disconnected mirroring steps for HCP

Author: xenolinux

hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc

@@ -17,6 +17,12 @@ include::modules/hcp-dc-registry.adoc[leveloffset=+1]
 include::modules/hcp-dc-mgmt-cluster.adoc[leveloffset=+1]
 include::modules/hcp-dc-web-server.adoc[leveloffset=+1]
 include::modules/hcp-dc-image-mirror.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-workflows-partially-disconnected-v2_about-installing-oc-mirror-v2[Mirroring an image set in a partially disconnected environment]
+* xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-workflows-fully-disconnected-v2_about-installing-oc-mirror-v2[Mirroring an image set in a fully disconnected environment]
+
 include::modules/hcp-dc-apply-objects.adoc[leveloffset=+1]
 
 [role="_additional-resources"]

hosted_control_planes/hcp-disconnected/hcp-deploy-dc-virt.adoc

@@ -15,6 +15,12 @@ When you deploy {hcp} in a disconnected environment, some of the steps differ de
 * You have an internal registry to mirror images on. For more information, see xref:../../disconnected/mirroring/index.adoc#installing-mirroring-disconnected-about[About disconnected installation mirroring].
 
 include::modules/hcp-dc-image-mirror.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-workflows-partially-disconnected-v2_about-installing-oc-mirror-v2[Mirroring an image set in a partially disconnected environment]
+* xref:../../disconnected/mirroring/about-installing-oc-mirror-v2.adoc#oc-mirror-workflows-fully-disconnected-v2_about-installing-oc-mirror-v2[Mirroring an image set in a fully disconnected environment]
+
 include::modules/hcp-dc-apply-objects.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
@@ -61,4 +67,4 @@ include::modules/hcp-virt-wildcard-dns.adoc[leveloffset=+3]
 You can monitor the deployment of a hosted cluster from two perspectives: the control plane and the data plane.
 
 include::modules/hcp-monitor-cp.adoc[leveloffset=+2]
-include::modules/hcp-monitor-dp.adoc[leveloffset=+2]
+include::modules/hcp-monitor-dp.adoc[leveloffset=+2]

modules/hcp-dc-image-mirror.adoc

@@ -17,7 +17,7 @@ In the following procedures, the `oc-mirror` tool is used, which is a binary tha
 
 .Prerequisites
 
-Ensure that the registry server is running before you start the mirroring process.
+* Ensure that the registry server is running before you start the mirroring process.
 
 .Procedure
 
@@ -29,21 +29,18 @@ To configure image mirroring, complete the following steps:
 +
 [source,yaml,subs="attributes+"]
 ----
-apiVersion: mirror.openshift.io/v1alpha2
+apiVersion: mirror.openshift.io/v2alpha1
 kind: ImageSetConfiguration
-storageConfig:
-  registry:
-    imageURL: registry.<dns.base.domain.name>:5000/openshift/release/metadata:latest <1>
 mirror:
   platform:
     channels:
     - name: candidate-{product-version}
-      minVersion: <4.x.y-build>  <2>
-      maxVersion: <4.x.y-build> <2>
+      minVersion: <4.x.y-build>  <1>
+      maxVersion: <4.x.y-build> <1>
       type: ocp
-    kubeVirtContainer: true <3>
+    kubeVirtContainer: true <2>
     graph: true
-  additionalImages:
+  additionalImages: <3>
   - name: quay.io/karmab/origin-keepalived-ipfailover:latest
   - name: quay.io/karmab/kubectl:latest
   - name: quay.io/karmab/haproxy:latest
@@ -67,19 +64,19 @@ mirror:
     - name: kubevirt-hyperconverged <4>
 ----
 +
-<1> Replace `<dns.base.domain.name>` with the DNS base domain name.
-<2> Replace `<4.x.y-build>` with the supported {product-title} version you want to use.
-<3> Set this optional flag to `true` if you want to also mirror the container disk image for the {op-system-first} boot image for the KubeVirt provider. This flag is available with oc-mirror v2 only.
+<1> Replace `<4.x.y-build>` with the supported {product-title} version you want to use.
+<2> Set this optional flag to `true` if you want to also mirror the container disk image for the {op-system-first} boot image for the KubeVirt provider. This flag is available with oc-mirror v2 only.
+<3> Images specified in the `additionalImages` field are examples only and are not strictly needed.
 <4> For deployments that use the KubeVirt provider, include this line.
 
 . Start the mirroring process by entering the following command:
 +
 [source,terminal]
 ----
-$ oc-mirror --v2 --config imagesetconfig.yaml docker://${REGISTRY}
+$ oc-mirror --v2 --config imagesetconfig.yaml  --workspace file://mirror-file docker://<registry>
 ----
 +
-After the mirroring process is finished, you have a new folder named `oc-mirror-workspace/results-XXXXXX/`, which contains the IDMS and the catalog sources to apply on the hosted cluster.
+After the mirroring process is finished, you have a new folder named `mirror-file`, which contains the `ImageDigestMirrorSet` (IDMS), `ImageTagMirrorSet` (ITMS), and the catalog sources to apply on the hosted cluster.
 
 . Mirror the nightly or CI versions of {product-title} by configuring the `imagesetconfig.yaml` file as follows:
 +
@@ -98,11 +95,31 @@ mirror:
 <1> Replace `<4.x.y-build>` with the supported {product-title} version you want to use.
 <2> Set this optional flag to `true` if you want to also mirror the container disk image for the {op-system-first} boot image for the KubeVirt provider. This flag is available with oc-mirror v2 only.
 
-. Apply the changes to the file by entering the following command:
+. If you have a partially disconnected environment, mirror the images from the image set configuration to a registry by entering the following command:
++
+[source,terminal]
+----
+$ oc mirror -c imagesetconfig.yaml --workspace file://<file_path> docker://<mirror_registry_url> --v2
+----
++
+For more information, see "Mirroring an image set in a partially disconnected environment".
+
+. If you have a fully disconnected environment, perform the following steps:
+
+.. Mirror the images from the specified image set configuration to the disk by entering the following command:
++
+[source,terminal]
+----
+$ oc mirror -c imagesetconfig.yaml file://<file_path> --v2
+----
++
+For more information, see "Mirroring an image set in a fully disconnected environment".
+
+.. Process the image set file on the disk and mirror the contents to a target mirror registry by entering the following command:
 +
 [source,terminal]
 ----
-$ oc-mirror --v2 --config imagesetconfig.yaml docker://${REGISTRY}
+$ oc mirror -c imagesetconfig.yaml --from file://<file_path> docker://<mirror_registry_url> --v2
 ----
 
 . Mirror the latest {mce-short} images by following the steps in link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#install-on-disconnected-networks[Install on disconnected networks].