Merge pull request #55448 from skopacz1/4744_main

OSDOCS-4744: creating a discrete updating page for mirroring content

Author: michaelryanpeter

_topic_maps/_topic_map.yml

@@ -587,15 +587,17 @@ Topics:
 - Name: Updating a cluster that includes RHEL compute machines
   File: updating-cluster-rhel-compute
   Distros: openshift-enterprise
-- Name: Updating a disconnected environment
+- Name: Updating a cluster in a disconnected environment
   Dir: updating-restricted-network-cluster
   Distros: openshift-enterprise
   Topics:
-  - Name: About disconnected environment updates
+  - Name: About cluster updates in a disconnected environment
     File: index
-  - Name: Updating disconnected environments using OSUS
+  - Name: Mirroring the OpenShift Container Platform image repository
+    File: mirroring-image-repository
+  - Name: Updating a cluster in a disconnected environment using OSUS
     File: restricted-network-update-osus
-  - Name: Updating disconnected environments without OSUS
+  - Name: Updating a cluster in a disconnected environment without OSUS
     File: restricted-network-update
 - Name: Updating hardware on nodes running on vSphere
   File: updating-hardware-on-nodes-running-on-vsphere

installing/disconnected_install/installing-mirroring-disconnected.adoc

@@ -140,3 +140,9 @@ include::modules/oc-mirror-image-set-config-examples.adoc[leveloffset=+1]
 
 // Command reference for oc-mirror
 include::modules/oc-mirror-command-reference.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+[id="additional-resources_installing-mirroring-disconnected"]
+== Additional resources
+
+* xref:../../updating/updating-restricted-network-cluster/index.adoc#about-restricted-network-updates[About cluster updates in a disconnected environment]

modules/cli-installing-cli.adoc

@@ -48,14 +48,14 @@
 // * openshift_images/samples-operator-alt-registry.adoc
 // * installing/installing_rhv/installing-rhv-customizations.adoc
 // * installing/installing_rhv/installing-rhv-default.adoc
-// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 // * microshift_cli_ref/microshift-oc-cli-install.adoc
 // * updating/updating-restricted-network-cluster.adoc
 // * installing/installing-nutanix-installer-provisioned.adoc
 // * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
 // AMQ docs link to this; do not change anchor
 
-ifeval::["{context}" == "updating-restricted-network-cluster"]
+ifeval::["{context}" == "mirroring-ocp-image-repository"]
 :restricted:
 endif::[]
 
@@ -200,6 +200,6 @@ After you install the OpenShift CLI, it is available using the `oc` command:
 $ oc <command>
 ----
 
-ifeval::["{context}" == "updating-restricted-network-cluster"]
+ifeval::["{context}" == "mirroring-ocp-image-repository"]
 :!restricted:
 endif::[]

modules/installation-about-mirror-registry.adoc

@@ -3,11 +3,16 @@
 // * installing/disconnected_install/installing-mirroring-installation-images.adoc
 // * openshift_images/samples-operator-alt-registry.adoc
 // * scalability_and_performance/ztp-deploying-disconnected.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
 ifeval::["{context}" == "installing-mirroring-disconnected"]
 :oc-mirror:
 endif::[]
 
+ifeval::["{context}" == "mirroring-ocp-image-repository"]
+:oc-mirror:
+endif::[]
+
 :_content-type: CONCEPT
 [id="installation-about-mirror-registry_{context}"]
 = About the mirror registry
@@ -42,3 +47,7 @@ Red Hat does not test third party registries with {product-title}.
 ifeval::["{context}" == "installing-mirroring-disconnected"]
 :!oc-mirror:
 endif::[]
+
+ifeval::["{context}" == "mirroring-ocp-image-repository"]
+:!oc-mirror:
+endif::[]

modules/installation-adding-registry-pull-secret.adoc

@@ -4,10 +4,11 @@
 // * installing/disconnected_install/installing-mirroring-disconnected.adoc
 // * openshift_images/samples-operator-alt-registry.adoc
 // * scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-clusters-at-scale.adoc
-// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
-ifeval::["{context}" == "updating-restricted-network-cluster"]
+ifeval::["{context}" == "mirroring-ocp-image-repository"]
 :restricted:
+:update-oc-mirror:
 endif::[]
 
 ifeval::["{context}" == "installing-mirroring-installation-images"]
@@ -62,14 +63,7 @@ ifndef::openshift-origin[]
 ----
 $ cat ./pull-secret | jq . > <path>/<pull_secret_file_in_json> <1>
 ----
-ifndef::oc-mirror[]
 <1> Specify the path to the folder to store the pull secret in and a name for the JSON file that you create.
-endif::[]
-ifdef::oc-mirror[]
-<1> Specify the path to the folder to store the pull secret in and a name for the JSON file that you create.
-
-. Save the file either as `~/.docker/config.json` or `$XDG_RUNTIME_DIR/containers/auth.json`.
-endif::[]
 +
 The contents of the file resemble the following example:
 +
@@ -96,6 +90,14 @@ The contents of the file resemble the following example:
   }
 }
 ----
+// An additional step for following this procedure when using oc-mirror as part of the disconnected install process.
+ifdef::oc-mirror[]
+. Save the file either as `~/.docker/config.json` or `$XDG_RUNTIME_DIR/containers/auth.json`.
+endif::[]
+// Similar to the additional step above, except it is framed as optional because it is included in a disconnected update page (where users may or may not use oc-mirror for their process)
+ifdef::update-oc-mirror[]
+. Optional: If using the oc-mirror plugin, save the file either as `~/.docker/config.json` or `$XDG_RUNTIME_DIR/containers/auth.json`.
+endif::[]
 endif::[]
 
 . Generate the base64-encoded user name and password or token for your mirror registry:
@@ -122,6 +124,7 @@ ifndef::openshift-origin[]
     "<mirror_registry>": { <1>
       "auth": "<credentials>", <2>
       "email": "[email protected]"
+    }
   },
 endif::[]
 ifdef::openshift-origin[]
@@ -189,8 +192,9 @@ ifeval::["{context}" == "installing-mirroring-installation-images"]
 :!restricted:
 endif::[]
 
-ifeval::["{context}" == "updating-restricted-network-cluster"]
+ifeval::["{context}" == "mirroring-ocp-image-repository"]
 :!restricted:
+:!update-oc-mirror:
 endif::[]
 
 ifeval::["{context}" == "installing-mirroring-disconnected"]

modules/oc-mirror-about.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * installing/disconnected_install/installing-mirroring-disconnected.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
 :_content-type: CONCEPT
 [id="installation-oc-mirror-about_{context}"]
@@ -17,7 +18,7 @@ You can use the oc-mirror OpenShift CLI (`oc`) plugin to mirror all required {pr
 
 When using the oc-mirror plugin, you specify which content to mirror in an image set configuration file. In this YAML file, you can fine-tune the configuration to only include the {product-title} releases and Operators that your cluster needs. This reduces the amount of data that you need to download and transfer. The oc-mirror plugin can also mirror arbitrary helm charts and additional container images to assist users in seamlessly synchronizing their workloads onto mirror registries.
 
-The first time you run the oc-mirror plugin, it populates your mirror registry with the required content to perform your disconnected cluster installation. In order for your disconnected cluster to continue receiving updates, you must keep your mirror registry updated. To update your mirror registry, you run the oc-mirror plugin using the same configuration as the first time you ran it. The oc-mirror plugin references the metadata from the storage backend and only downloads what has been released since the last time you ran the tool. This provides update paths for {product-title} and Operators and performs dependency resolution as required.
+The first time you run the oc-mirror plugin, it populates your mirror registry with the required content to perform your disconnected cluster installation or update. In order for your disconnected cluster to continue receiving updates, you must keep your mirror registry updated. To update your mirror registry, you run the oc-mirror plugin using the same configuration as the first time you ran it. The oc-mirror plugin references the metadata from the storage backend and only downloads what has been released since the last time you ran the tool. This provides update paths for {product-title} and Operators and performs dependency resolution as required.
 
 [IMPORTANT]
 ====

modules/oc-mirror-command-reference.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * installing/disconnected_install/installing-mirroring-disconnected.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
 :_content-type: REFERENCE
 [id="oc-mirror-command-reference_{context}"]

modules/oc-mirror-creating-image-set-config.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * installing/disconnected_install/installing-mirroring-disconnected.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
 :_content-type: PROCEDURE
 [id="oc-mirror-creating-image-set-config_{context}"]

modules/oc-mirror-differential-updates.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * installing/disconnected_install/installing-mirroring-disconnected.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
 :_content-type: PROCEDURE
 [id="oc-mirror-differential-updates_{context}"]

modules/oc-mirror-disk-to-mirror.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * installing/disconnected_install/installing-mirroring-disconnected.adoc
+// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc
 
 :_content-type: PROCEDURE
 [id="oc-mirror-disk-to-mirror_{context}"]