diff --git a/disconnected/updating/index.adoc b/disconnected/updating/index.adoc index b5334c8474a6..ded55c8c4dff 100644 --- a/disconnected/updating/index.adoc +++ b/disconnected/updating/index.adoc @@ -6,29 +6,28 @@ include::_attributes/common-attributes.adoc[] toc::[] -A disconnected environment is one in which your cluster nodes cannot access the internet or where you want to manage update recommendations and release images locally for policy or performance purposes. -This section covers mirroring {product-title} images, managing an OpenShift Update Service, and performing cluster updates in a disconnected environment. +[role="_abstract"] +You can update a {product-title} cluster in a disconnected environment where the cluster nodes cannot access the internet or where you want to manage update recommendations and release images locally for policy or performance purposes. -[id="about-disconnected-updates-mirroring_{context}"] -== Mirroring {product-title} images -To update your cluster in a disconnected environment, your cluster environment must have access to a mirror registry that has the necessary images and resources for your targeted update. -A single container image registry is sufficient to host mirrored images for several clusters in the disconnected network. -The following page has instructions for mirroring images onto a repository in your disconnected cluster: +// Mirroring ocp images +include::modules/mirror-ocp-images.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources * xref:../../disconnected/updating/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images] -[id="about-disconnected-updates-update_{context}"] -== Performing a cluster update in a disconnected environment - -You can use one of the following procedures to update a disconnected {product-title} cluster: +// Performing a cluster update in a disconnected environment +include::modules/perform-cluster-update-disconnected-evn.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources * xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-osus[Updating a cluster in a disconnected environment using the OpenShift Update Service] * xref:../../disconnected/updating/disconnected-update.adoc#updating-disconnected-cluster[Updating a cluster in a disconnected environment without the OpenShift Update Service] -[id="about-disconnected-updates-uninstalling-osus_{context}"] -== Uninstalling the OpenShift Update Service from a cluster - -You can use the following procedure to uninstall a local copy of the OpenShift Update Service (OSUS) from your cluster: +// Uninstalling the OpenShift Update Service from a cluster +include::modules/uninstalling-osus.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources * xref:../../disconnected/updating/uninstalling-osus.adoc#uninstalling-osus[Uninstalling the OpenShift Update Service from a cluster] diff --git a/disconnected/updating/uninstalling-osus.adoc b/disconnected/updating/uninstalling-osus.adoc index b7d733ab200a..314181c78c42 100644 --- a/disconnected/updating/uninstalling-osus.adoc +++ b/disconnected/updating/uninstalling-osus.adoc @@ -6,12 +6,11 @@ include::_attributes/common-attributes.adoc[] toc::[] -To remove a local copy of the OpenShift Update Service (OSUS) from your cluster, you must first delete the OSUS application and then uninstall the OSUS Operator. +[role="_abstract"] +You can remove a local copy of the OpenShift Update Service (OSUS) from your cluster. To do this, you must first delete the OSUS application and then uninstall the OSUS Operator. -[id="update-service-delete-service_{context}"] -== Deleting an OpenShift Update Service application - -You can delete an OpenShift Update Service application by using the {product-title} web console or CLI. +// Deleting an OpenShift Update Service application +include::modules/delete-update-service-application.adoc[leveloffset=+1] // Deleting an OpenShift Update Service application by using the web console include::modules/update-service-delete-service-web-console.adoc[leveloffset=+2] @@ -19,10 +18,8 @@ include::modules/update-service-delete-service-web-console.adoc[leveloffset=+2] // Deleting an OpenShift Update Service application by using the CLI include::modules/update-service-delete-service-cli.adoc[leveloffset=+2] -[id="update-service-uninstall_{context}"] -== Uninstalling the OpenShift Update Service Operator - -You can uninstall the OpenShift Update Service Operator by using the {product-title} web console or CLI. +// Uninstalling the OpenShift Update Service Operator +include::modules/uninstall-update-service-operator.adoc[leveloffset=+1] // Uninstalling the OpenShift Update Service Operator by using the web console include::modules/update-service-uninstall-web-console.adoc[leveloffset=+2] diff --git a/modules/delete-update-service-application.adoc b/modules/delete-update-service-application.adoc new file mode 100644 index 000000000000..8ac429c149ba --- /dev/null +++ b/modules/delete-update-service-application.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// * updating/updating_a_cluster/updating_disconnected_cluster/uninstalling-osus.adoc + +:_mod-docs-content-type: CONCEPT +[id="update-service-delete-service_{context}"] += Deleting an OpenShift Update Service application + +[role="_abstract"] +You can delete an OpenShift Update Service application by using the {product-title} web console or CLI. \ No newline at end of file diff --git a/modules/mirror-ocp-images.adoc b/modules/mirror-ocp-images.adoc new file mode 100644 index 000000000000..d0de5fe6fa53 --- /dev/null +++ b/modules/mirror-ocp-images.adoc @@ -0,0 +1,12 @@ +// Module included in the following assemblies: +// * disconnected/updating/index.adoc + +:_mod-docs-content-type: CONCEPT +[id="about-disconnected-updates-mirroring_{context}"] += Mirroring {product-title} images + +[role="_abstract"] +You can mirror {product-title} images to a local container image registry to provide your disconnected cluster with the resources necessary for targeted updates. +A single container image registry is sufficient to host mirrored images for several clusters in the disconnected network. + +For more information about mirroring images onto a repository in your disconnected cluster, see the "Mirroring {product-title} images" section. \ No newline at end of file diff --git a/modules/perform-cluster-update-disconnected-evn.adoc b/modules/perform-cluster-update-disconnected-evn.adoc new file mode 100644 index 000000000000..0755a20f3f21 --- /dev/null +++ b/modules/perform-cluster-update-disconnected-evn.adoc @@ -0,0 +1,13 @@ +// Module included in the following assemblies: +// * disconnected/updating/index.adoc + +:_mod-docs-content-type: CONCEPT +[id="about-disconnected-updates-update_{context}"] += Performing a cluster update in a disconnected environment + +[role="_abstract"] +You can keep your disconnected {product-title} environment up to date by performing a cluster update. This process can be managed locally either with or without the OpenShift Update Service (OSUS). + +For more information about performing a cluster update in a disconnected environment with OSUS, see the "Updating a cluster in a disconnected environment using the OpenShift Update Service" section. + +For more information about performing a cluster update in a disconnected environment without OSUS, see the "Updating a cluster in a disconnected environment without the OpenShift Update Service" section. \ No newline at end of file diff --git a/modules/uninstall-update-service-operator.adoc b/modules/uninstall-update-service-operator.adoc new file mode 100644 index 000000000000..0f2f7cfa611f --- /dev/null +++ b/modules/uninstall-update-service-operator.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// * updating/updating_a_cluster/updating_disconnected_cluster/uninstalling-osus.adoc + +:_mod-docs-content-type: CONCEPT +[id="update-service-uninstall_{context}"] += Uninstalling the OpenShift Update Service Operator + +[role="_abstract"] +You can uninstall the OpenShift Update Service Operator by using the {product-title} web console or CLI. \ No newline at end of file diff --git a/modules/uninstalling-osus.adoc b/modules/uninstalling-osus.adoc new file mode 100644 index 000000000000..ba098d693ec1 --- /dev/null +++ b/modules/uninstalling-osus.adoc @@ -0,0 +1,11 @@ +// Module included in the following assemblies: +// * disconnected/updating/index.adoc + +:_mod-docs-content-type: CONCEPT +[id="about-disconnected-updates-uninstalling-osus_{context}"] += Uninstalling the OpenShift Update Service from a cluster + +[role="_abstract"] +You can uninstall a local copy of the OpenShift Update Service (OSUS) from your {product-title} cluster when you no longer need to manage updates locally: + +For more information about uninstalling the OpenShift Update Service from a cluster, see the "Uninstalling the OpenShift Update Service from a cluster" section. \ No newline at end of file diff --git a/modules/update-service-delete-service-cli.adoc b/modules/update-service-delete-service-cli.adoc index 60119104186d..cff2b5fcf26d 100644 --- a/modules/update-service-delete-service-cli.adoc +++ b/modules/update-service-delete-service-cli.adoc @@ -5,6 +5,7 @@ [id="update-service-delete-service-cli_{context}"] = Deleting an OpenShift Update Service application by using the CLI +[role="_abstract"] You can use the OpenShift CLI (`oc`) to delete an OpenShift Update Service application. .Procedure diff --git a/modules/update-service-delete-service-web-console.adoc b/modules/update-service-delete-service-web-console.adoc index 486998cdbe82..7cf30c2634ba 100644 --- a/modules/update-service-delete-service-web-console.adoc +++ b/modules/update-service-delete-service-web-console.adoc @@ -5,6 +5,7 @@ [id="update-service-delete-service-web-console_{context}"] = Deleting an OpenShift Update Service application by using the web console +[role="_abstract"] You can use the {product-title} web console to delete an OpenShift Update Service application by using the OpenShift Update Service Operator. .Prerequisites diff --git a/modules/update-service-uninstall-cli.adoc b/modules/update-service-uninstall-cli.adoc index 1e76eaf5f485..5da148e114f9 100644 --- a/modules/update-service-uninstall-cli.adoc +++ b/modules/update-service-uninstall-cli.adoc @@ -5,6 +5,7 @@ [id="update-service-uninstall-cli_{context}"] = Uninstalling the OpenShift Update Service Operator by using the CLI +[role="_abstract"] You can use the OpenShift CLI (`oc`) to uninstall the OpenShift Update Service Operator. .Prerequisites diff --git a/modules/update-service-uninstall-web-console.adoc b/modules/update-service-uninstall-web-console.adoc index 4ced5ab84c90..bcd888ad016c 100644 --- a/modules/update-service-uninstall-web-console.adoc +++ b/modules/update-service-uninstall-web-console.adoc @@ -5,6 +5,7 @@ [id="update-service-uninstall-web-console_{context}"] = Uninstalling the OpenShift Update Service Operator by using the web console +[role="_abstract"] You can use the {product-title} web console to uninstall the OpenShift Update Service Operator. .Prerequisites