Merge pull request #54298 from skopacz1/OSDOCS-4665_main

stevsmit · web-flow · commit 7921dd567a16 · 2023-01-23T12:52:37.000-05:00
OSDOCS-4665: breaking up restricted network update content
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -581,9 +581,16 @@ Topics:
 - Name: Updating a cluster that includes RHEL compute machines
   File: updating-cluster-rhel-compute
   Distros: openshift-enterprise
-- Name: Updating a restricted network cluster
-  File: updating-restricted-network-cluster
+- Name: Updating a disconnected environment
+  Dir: updating-restricted-network-cluster
   Distros: openshift-enterprise
+  Topics:
+  - Name: About disconnected environment updates
+    File: index
+  - Name: Updating disconnected environments using OSUS
+    File: restricted-network-update-OSUS
+  - Name: Updating disconnected environments without OSUS
+    File: restricted-network-update
 - Name: Updating hardware on nodes running on vSphere
   File: updating-hardware-on-nodes-running-on-vsphere
 # - Name: Troubleshooting an update
diff --git a/getting_started/openshift-overview.adoc b/getting_started/openshift-overview.adoc
@@ -104,7 +104,7 @@ be reviewed by cluster administrators and xref:../operators/admin/olm-adding-ope
 
 * **xref:../scalability_and_performance/scaling-cluster-monitoring-operator.adoc#scaling-cluster-monitoring-operator[Scale] and xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[tune] clusters**: Set cluster limits, tune nodes, scale cluster monitoring, and optimize networking, storage, and routes for your environment.
 
-* **xref:../updating/updating-restricted-network-cluster.adoc#update-service-overview_updating-restricted-network-cluster[Understanding the OpenShift Update Service]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in restricted network environments.
+* **xref:../updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc#update-service-overview_updating-restricted-network-cluster-OSUS[Understanding the OpenShift Update Service]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in disconnected environments.
 
 * **xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**:
 Learn to  xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
diff --git a/installing/disconnected_install/installing-mirroring-disconnected.adoc b/installing/disconnected_install/installing-mirroring-disconnected.adoc
@@ -69,7 +69,7 @@ include::modules/oc-mirror-creating-image-set-config.adoc[leveloffset=+1]
 
 * xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-imageset-config-params_installing-mirroring-disconnected[Image set configuration parameters]
 * xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#oc-mirror-image-set-examples_installing-mirroring-disconnected[Image set configuration examples]
-* xref:../../updating/updating-restricted-network-cluster.adoc#update-service-overview_updating-restricted-network-cluster[About the OpenShift Update Service]
+* xref:../../updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc#update-service-overview_updating-restricted-network-cluster-OSUS[About the OpenShift Update Service]
 
 [id="mirroring-image-set"]
 == Mirroring an image set to a mirror registry
diff --git a/modules/cli-installing-cli.adoc b/modules/cli-installing-cli.adoc
@@ -46,7 +46,7 @@
 // * 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.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 //
 // AMQ docs link to this; do not change anchor
 
@@ -67,7 +67,7 @@ If you installed an earlier version of `oc`, you cannot use it to complete all
 of the commands in {product-title} {product-version}. Download and
 install the new version of `oc`.
 ifdef::restricted[]
-If you are upgrading a cluster in a restricted network, install the `oc` version that you plan to upgrade to.
+If you are upgrading a cluster in a disconnected environment, install the `oc` version that you plan to upgrade to.
 endif::restricted[]
 ====
 
diff --git a/modules/generating-icsp-object-scoped-to-a-registry.adoc b/modules/generating-icsp-object-scoped-to-a-registry.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * updating/updating-restricted-network-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 
 :_content-type: PROCEDURE
 [id="generating-icsp-object-scoped-to-a-registry_{context}"]
diff --git a/modules/images-configuration-registry-mirror.adoc b/modules/images-configuration-registry-mirror.adoc
@@ -2,6 +2,7 @@
 //
 // * openshift_images/image-configuration.adoc
 // * post_installation_configuration/preparing-for-users.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 
 :_content-type: PROCEDURE
 [id="images-configuration-registry-mirror_{context}"]
@@ -15,7 +16,7 @@ Setting up container registry repository mirroring enables you to do the followi
 The attributes of repository mirroring in {product-title} include:
 
 * Image pulls are resilient to registry downtimes.
-* Clusters in restricted networks can pull images from critical locations, such as quay.io, and have registries behind a company firewall provide the requested images.
+* Clusters in disconnected environments can pull images from critical locations, such as quay.io, and have registries behind a company firewall provide the requested images.
 * A particular order of registries is tried when an image pull request is made, with the permanent registry typically being the last one tried.
 * The mirror information you enter is added to the `/etc/containers/registries.conf` file on every node in the {product-title} cluster.
 * When a node makes a request for an image from the source repository, it tries each mirrored repository in turn until it finds the requested content. If all mirrors fail, the cluster tries the source repository. If successful, the image is pulled to the node.
@@ -24,7 +25,7 @@ Setting up repository mirroring can be done in the following ways:
 
 * At {product-title} installation:
 +
-By pulling container images needed by {product-title} and then bringing those images behind your company's firewall, you can install {product-title} into a datacenter that is in a restricted network.
+By pulling container images needed by {product-title} and then bringing those images behind your company's firewall, you can install {product-title} into a datacenter that is in a disconnected environment.
 
 * After {product-title} installation:
 +
diff --git a/modules/images-update-global-pull-secret.adoc b/modules/images-update-global-pull-secret.adoc
@@ -2,7 +2,8 @@
 // * openshift_images/managing_images/using-image-pull-secrets.adoc
 // * post_installation_configuration/cluster-tasks.adoc
 // * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc
-// * updating/updating-restricted-network-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 //
 // Not included, but linked to from:
 // * operators/admin/olm-managing-custom-catalogs.adoc
diff --git a/modules/installation-adding-registry-pull-secret.adoc b/modules/installation-adding-registry-pull-secret.adoc
@@ -4,7 +4,7 @@
 // * 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.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 
 ifeval::["{context}" == "updating-restricted-network-cluster"]
 :restricted:
@@ -43,7 +43,7 @@ endif::restricted[]
 
 .Prerequisites
 
-* You configured a mirror registry to use in your restricted network.
+* You configured a mirror registry to use in your disconnected environment.
 ifdef::restricted[]
 * You identified an image repository location on your mirror registry to mirror images into.
 * You provisioned a mirror registry account that allows images to be uploaded to that image repository.
diff --git a/modules/machine-health-checks-pausing.adoc b/modules/machine-health-checks-pausing.adoc
@@ -2,7 +2,7 @@
 
 // * updating/updating-cluster-cli.adoc
 // * updating/updating-cluster-within-minor.adoc
-// * updating/updating-restricted-network-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 
 :_content-type: PROCEDURE
 [id="machine-health-checks-pausing_{context}"]
diff --git a/modules/update-mirror-repository-oc-mirror.adoc b/modules/update-mirror-repository-oc-mirror.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
-//
-// * updating/updating-restricted-network-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
 
 :_content-type: PROCEDURE
 [id="update-mirror-repository-oc-mirror_{context}"]
diff --git a/modules/update-mirror-repository.adoc b/modules/update-mirror-repository.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * updating/updating-restricted-network-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 
 :_content-type: PROCEDURE
 [id="update-mirror-repository-adm-release-mirror_{context}"]
@@ -103,7 +103,7 @@ $ oc adm release mirror -a ${LOCAL_SECRET_JSON} --to-dir=${REMOVABLE_MEDIA_PATH}
 ----
 $ oc adm release mirror -a ${LOCAL_SECRET_JSON} --to-dir=${REMOVABLE_MEDIA_PATH}/mirror quay.io/${PRODUCT_REPO}/${RELEASE_NAME}:${OCP_RELEASE}-${ARCHITECTURE}
 ----
-... Take the media to the restricted network environment and upload the images to the local container registry.
+... Take the media to the disconnected environment and upload the images to the local container registry.
 +
 [source,terminal]
 ----
diff --git a/modules/update-restricted.adoc b/modules/update-restricted.adoc
@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * updating/updating-restricted-network-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
 
 :_content-type: PROCEDURE
 [id="update-restricted_{context}"]
-= Upgrading the restricted network cluster
+= Upgrading the disconnected cluster
 
-Update the restricted network cluster to the {product-title} version that you downloaded the release images for.
+Update the disconnected cluster to the {product-title} version that you downloaded the release images for.
 
 //TODO: Add xrefs in the following note when functionality is enabled.
 
diff --git a/modules/update-service-configure-cvo.adoc b/modules/update-service-configure-cvo.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-configure-cvo"]
 = Configuring the Cluster Version Operator (CVO)
diff --git a/modules/update-service-create-service-cli.adoc b/modules/update-service-create-service-cli.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-create-service-cli_{context}"]
 = Creating an OpenShift Update Service application by using the CLI
diff --git a/modules/update-service-create-service-web-console.adoc b/modules/update-service-create-service-web-console.adoc
@@ -1,3 +1,6 @@
+//Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-create-service-web-console_{context}"]
 = Creating an OpenShift Update Service application by using the web console
diff --git a/modules/update-service-delete-service-cli.adoc b/modules/update-service-delete-service-cli.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-delete-service-cli_{context}"]
 = Deleting an OpenShift Update Service application by using the CLI
diff --git a/modules/update-service-delete-service-web-console.adoc b/modules/update-service-delete-service-web-console.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-delete-service-web-console_{context}"]
 = Deleting an OpenShift Update Service application by using the web console
diff --git a/modules/update-service-graph-data.adoc b/modules/update-service-graph-data.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-graph-data_{context}"]
 = Creating the OpenShift Update Service graph data container image
@@ -33,5 +36,5 @@ $ podman push registry.example.com/openshift/graph-data:latest
 +
 [NOTE]
 ====
-To push a graph data image to a local registry in a restricted network, copy the graph-data container image created in the previous step to a repository that is accessible to the OpenShift Update Service. Run `oc image mirror --help` for available options.
+To push a graph data image to a local registry in a disconnected environment, copy the graph-data container image created in the previous step to a repository that is accessible to the OpenShift Update Service. Run `oc image mirror --help` for available options.
 ====
diff --git a/modules/update-service-install-cli.adoc b/modules/update-service-install-cli.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-install-cli_{context}"]
 = Installing the OpenShift Update Service Operator by using the CLI
@@ -82,7 +85,7 @@ spec:
   sourceNamespace: "openshift-marketplace"
   name: "cincinnati-operator"
 ----
-<1> Specify the name of the catalog source that provides the Operator. For clusters that do not use a custom Operator Lifecycle Manager (OLM), specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the `CatalogSource` object created when you configured Operator Lifecycle Manager (OLM).
+<1> Specify the name of the catalog source that provides the Operator. For clusters that do not use a custom Operator Lifecycle Manager (OLM), specify `redhat-operators`. If your {product-title} cluster is installed in a disconnected environment, specify the name of the `CatalogSource` object created when you configured Operator Lifecycle Manager (OLM).
 
 .. Create the `Subscription` object:
 +
diff --git a/modules/update-service-install-web-console.adoc b/modules/update-service-install-web-console.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-install-web-console_{context}"]
 = Installing the OpenShift Update Service Operator by using the web console
diff --git a/modules/update-service-mirror-release.adoc b/modules/update-service-mirror-release.adoc
@@ -1,9 +1,10 @@
+// Module included in the following assemblies:
+// *updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-mirror-release-adm-release-mirror_{context}"]
 = Mirroring images using the oc adm release mirror command
 
-The OpenShift Update Service requires a locally accessible registry containing update release payloads.
-
 [IMPORTANT]
 ====
 To avoid excessive memory usage by the OpenShift Update Service application, it is recommended that you mirror release images to a separate repository, as described in the following procedure.
@@ -13,7 +14,7 @@ To avoid excessive memory usage by the OpenShift Update Service application, it
 
 * You reviewed and completed the steps from "Mirroring images for a disconnected installation" up to but not including the section entitled *Mirroring the {product-title} image repository*.
 //TODO: Add xref to preceding step when allowed.
-* You configured a mirror registry to use in your restricted network and can access the certificate and credentials that you configured.
+* You configured a mirror registry to use in your disconnected environment and can access the certificate and credentials that you configured.
 ifndef::openshift-origin[]
 * You downloaded the {cluster-manager-url-pull} and modified it to include authentication to your mirror repository.
 endif::[]
@@ -132,7 +133,7 @@ $ oc adm release mirror -a ${LOCAL_SECRET_JSON}  \
 ----
 $ oc adm release mirror -a ${LOCAL_SECRET_JSON} --to-dir=${REMOVABLE_MEDIA_PATH}/mirror quay.io/${PRODUCT_REPO}/${RELEASE_NAME}:${OCP_RELEASE}-${ARCHITECTURE}
 ----
-... Take the media to the restricted network environment and upload the images to the local container registry:
+... Take the media to the disconnected environment and upload the images to the local container registry:
 +
 [source,terminal]
 ----
diff --git a/modules/update-service-overview.adoc b/modules/update-service-overview.adoc
@@ -4,13 +4,13 @@
 // * updating/updating-cluster-within-minor.adoc
 // * updating/updating-cluster-cli.adoc
 // * updating/updating-cluster-rhel-compute.adoc
-// * updating/updating-disconnected-cluster.adoc
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
 
 :_content-type: CONCEPT
 [id="update-service-overview_{context}"]
 = About the OpenShift Update Service
 
-The OpenShift Update Service (OSUS) provides over-the-air updates to {product-title}, including {op-system-first}. It provides a graph, or diagram, that contains the _vertices_ of component Operators and the _edges_ that connect them. The edges in the graph show which versions you can safely update to. The vertices are update payloads that specify the intended state of the managed cluster components.
+The OpenShift Update Service (OSUS) provides updates to {product-title}, including {op-system-first}. It provides a graph, or diagram, that contains the _vertices_ of component Operators and the _edges_ that connect them. The edges in the graph show which versions you can safely update to. The vertices are update payloads that specify the intended state of the managed cluster components.
 
 The Cluster Version Operator (CVO) in your cluster checks with the OpenShift Update Service to see the valid updates and update paths based on current component versions and information in the graph. When you request an update, the CVO uses the release image for that update to upgrade your cluster. The release artifacts are hosted in Quay as container images.
 ////
diff --git a/modules/update-service-uninstall-cli.adoc b/modules/update-service-uninstall-cli.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-uninstall-cli_{context}"]
 = Uninstalling the OpenShift Update Service Operator by using the CLI
diff --git a/modules/update-service-uninstall-web-console.adoc b/modules/update-service-uninstall-web-console.adoc
@@ -1,3 +1,6 @@
+// Module included in the following assemblies:
+// * updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
+
 :_content-type: PROCEDURE
 [id="update-service-uninstall-web-console_{context}"]
 = Uninstalling the OpenShift Update Service Operator by using the web console
diff --git a/security/container_security/security-hosts-vms.adoc b/security/container_security/security-hosts-vms.adoc
@@ -31,7 +31,7 @@ ifndef::openshift-origin[]
 endif::[]
 * xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-encrypt-disk_installing-customizing[Disk encryption]
 * xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Chrony time service]
-* xref:../../updating/updating-restricted-network-cluster.adoc#update-service-overview_updating-restricted-network-cluster[{product-title} cluster updates]
+* xref:../../updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc#update-service-overview_updating-restricted-network-cluster-OSUS[{product-title} cluster updates]
 
 // Virtualization versus containers
 include::modules/security-hosts-vms-vs-containers.adoc[leveloffset=+1]
diff --git a/updating/index.adoc b/updating/index.adoc
diff --git a/updating/understanding-openshift-updates.adoc b/updating/understanding-openshift-updates.adoc
diff --git a/updating/updating-restricted-network-cluster.adoc b/updating/updating-restricted-network-cluster.adoc
diff --git a/updating/updating-restricted-network-cluster/_attributes b/updating/updating-restricted-network-cluster/_attributes
diff --git a/updating/updating-restricted-network-cluster/images b/updating/updating-restricted-network-cluster/images
diff --git a/updating/updating-restricted-network-cluster/index.adoc b/updating/updating-restricted-network-cluster/index.adoc
diff --git a/updating/updating-restricted-network-cluster/modules b/updating/updating-restricted-network-cluster/modules
diff --git a/updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc b/updating/updating-restricted-network-cluster/restricted-network-update-OSUS.adoc
diff --git a/updating/updating-restricted-network-cluster/restricted-network-update.adoc b/updating/updating-restricted-network-cluster/restricted-network-update.adoc
diff --git a/updating/updating-restricted-network-cluster/snippets b/updating/updating-restricted-network-cluster/snippets
diff --git a/welcome/index.adoc b/welcome/index.adoc
