Skip to content

Commit daedd13

Browse files
authored
Merge pull request #81395 from skopacz1/OSDOCS-11851
OSDOCS#11851: migrating disconnected update content
2 parents de87b73 + 08793aa commit daedd13

30 files changed

+140
-152
lines changed

_topic_maps/_topic_map.yml

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,30 @@ Topics:
107107
File: admission-plug-ins
108108
Distros: openshift-enterprise,openshift-aro,openshift-origin
109109
---
110+
Name: Disconnected environments
111+
Dir: disconnected
112+
Distros: openshift-enterprise,openshift-origin
113+
Topics:
114+
- Name: Updating a cluster in a disconnected environment
115+
Dir: updating
116+
Topics:
117+
- Name: About cluster updates in a disconnected environment
118+
File: index
119+
- Name: Mirroring OpenShift Container Platform images
120+
File: mirroring-image-repository
121+
- Name: Updating a cluster in a disconnected environment using OSUS
122+
File: disconnected-update-osus
123+
Distros: openshift-enterprise
124+
- Name: Updating a cluster in a disconnected environment without OSUS
125+
File: disconnected-update
126+
Distros: openshift-enterprise
127+
- Name: Updating a cluster in a disconnected environment by using the CLI
128+
File: disconnected-update
129+
Distros: openshift-origin
130+
- Name: Uninstalling OSUS from a cluster
131+
File: uninstalling-osus
132+
Distros: openshift-enterprise
133+
---
110134
Name: Installing
111135
Dir: installing
112136
Distros: openshift-origin,openshift-enterprise,openshift-webscale
@@ -713,24 +737,7 @@ Topics:
713737
File: updating-cluster-rhel-compute
714738
Distros: openshift-enterprise
715739
- Name: Updating a cluster in a disconnected environment
716-
Dir: updating_disconnected_cluster
717-
Topics:
718-
- Name: About cluster updates in a disconnected environment
719-
File: index
720-
- Name: Mirroring OpenShift Container Platform images
721-
File: mirroring-image-repository
722-
- Name: Updating a cluster in a disconnected environment using OSUS
723-
File: disconnected-update-osus
724-
Distros: openshift-enterprise
725-
- Name: Updating a cluster in a disconnected environment without OSUS
726-
File: disconnected-update
727-
Distros: openshift-enterprise
728-
- Name: Updating a cluster in a disconnected environment by using the CLI
729-
File: disconnected-update
730-
Distros: openshift-origin
731-
- Name: Uninstalling OSUS from a cluster
732-
File: uninstalling-osus
733-
Distros: openshift-enterprise
740+
File: disconnected-update
734741
- Name: Updating hardware on nodes running on vSphere
735742
File: updating-hardware-on-nodes-running-on-vsphere
736743
- Name: Migrating to a cluster with multi-architecture compute machines

disconnected/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

disconnected/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

disconnected/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

disconnected/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

disconnected/updating/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/
Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="updating-restricted-network-cluster-OSUS"]
2+
[id="updating-disconnected-cluster-OSUS"]
33
= Updating a cluster in a disconnected environment using the OpenShift Update Service
44
include::_attributes/common-attributes.adoc[]
5-
:context: updating-restricted-network-cluster-osus
5+
:context: updating-disconnected-cluster-osus
66

77
toc::[]
88

9-
////
10-
WARNING: This assembly has been moved into a subdirectory for 4.14+. Changes to this assembly for earlier versions should be done in separate PRs based off of their respective version branches. Otherwise, your cherry picks may fail.
11-
12-
To do: Remove this comment once 4.13 docs are EOL.
13-
////
14-
159
To get an update experience similar to connected clusters, you can use the following procedures to install and configure the OpenShift Update Service (OSUS) in a disconnected environment.
1610

1711
The following steps outline the high-level workflow on how to update a cluster in a disconnected environment using OSUS:
@@ -33,19 +27,19 @@ include::modules/disconnected-osus-overview.adoc[leveloffset=+1]
3327

3428
.Additional resources
3529

36-
* xref:../../../updating/understanding_updates/intro-to-updates.adoc#update-service-about_understanding-openshift-updates[About the OpenShift Update Service]
37-
* xref:../../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases]
30+
* xref:../../updating/understanding_updates/intro-to-updates.adoc#update-service-about_understanding-openshift-updates[About the OpenShift Update Service]
31+
* xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases]
3832
39-
[id="update-service-prereqs"]
33+
[id="update-service-prereqs_{context}"]
4034
== Prerequisites
4135

4236
* You must have the `oc` command-line interface (CLI) tool installed.
43-
* You must provision a container image registry in your environment with the container images for your update, as described in xref:../../../updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
37+
* You must provision a container image registry in your environment with the container images for your update, as described in xref:../../disconnected/updating/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
4438

45-
[id="registry-configuration-for-update-service"]
39+
[id="registry-configuration-for-update-service_{context}"]
4640
== Configuring access to a secured registry for the OpenShift Update Service
4741

48-
If the release images are contained in a registry whose HTTPS X.509 certificate is signed by a custom certificate authority, complete the steps in xref:../../../registry/configuring-registry-operator.adoc#images-configuration-cas_configuring-registry-operator[Configuring additional trust stores for image registry access] along with following changes for the update service.
42+
If the release images are contained in a registry whose HTTPS X.509 certificate is signed by a custom certificate authority, complete the steps in xref:../../registry/configuring-registry-operator.adoc#images-configuration-cas_configuring-registry-operator[Configuring additional trust stores for image registry access] along with following changes for the update service.
4943

5044
The OpenShift Update Service Operator needs the config map key name `updateservice-registry` in the registry CA cert.
5145

@@ -72,14 +66,14 @@ data:
7266
// Updating the global cluster pull secret
7367
include::modules/images-update-global-pull-secret.adoc[leveloffset=+1]
7468

75-
[id="update-service-install"]
69+
[id="update-service-install_{context}"]
7670
== Installing the OpenShift Update Service Operator
7771

7872
To install the OpenShift Update Service, you must first install the OpenShift Update Service Operator by using the {product-title} web console or CLI.
7973

8074
[NOTE]
8175
====
82-
For clusters that are installed in disconnected environments, also known as disconnected clusters, Operator Lifecycle Manager by default cannot access the Red Hat-provided OperatorHub sources hosted on remote registries because those remote sources require full internet connectivity. For more information, see xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
76+
For clusters that are installed in disconnected environments, also known as disconnected clusters, Operator Lifecycle Manager by default cannot access the Red Hat-provided OperatorHub sources hosted on remote registries because those remote sources require full internet connectivity. For more information, see xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
8377
====
8478

8579
// Installing the OpenShift Update Service Operator by using the web console
@@ -91,12 +85,12 @@ include::modules/update-service-install-cli.adoc[leveloffset=+2]
9185
[role="_additional-resources"]
9286
.Additional resources
9387

94-
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Installing Operators in your namespace].
88+
* xref:../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Installing Operators in your namespace].
9589

9690
// Creating the OpenShift Update Service graph data container image
9791
include::modules/update-service-graph-data.adoc[leveloffset=+1]
9892

99-
[id="update-service-create-service"]
93+
[id="update-service-create-service_{context}"]
10094
== Creating an OpenShift Update Service application
10195

10296
You can create an OpenShift Update Service application by using the {product-title} web console or CLI.
@@ -118,10 +112,10 @@ include::modules/update-service-configure-cvo.adoc[leveloffset=+1]
118112

119113
[NOTE]
120114
====
121-
See xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy] to configure the CA to trust the update server.
115+
See xref:../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy] to configure the CA to trust the update server.
122116
====
123117

124-
[id="next-steps_updating-restricted-network-cluster-osus"]
118+
[id="next-steps_updating-disconnected-cluster-osus_{context}"]
125119
== Next steps
126120

127121
Before updating your cluster, confirm that the following conditions are met:
@@ -140,13 +134,13 @@ The Cluster Version Operator (CVO) uses release image signatures to ensure that
140134
[NOTE]
141135
====
142136
If you have not recently installed or updated the OpenShift Update Service Operator, there might be a more recent version available.
143-
See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for more information about how to update your OLM catalog in a disconnected environment.
137+
See xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for more information about how to update your OLM catalog in a disconnected environment.
144138
====
145139

146140
After you configure your cluster to use the installed OpenShift Update Service and local mirror registry, you can use any of the following update methods:
147141

148-
** xref:../../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console]
149-
** xref:../../../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI]
150-
** xref:../../../updating/updating_a_cluster/eus-eus-update.adoc#eus-eus-update[Performing an EUS-to-EUS update]
151-
** xref:../../../updating/updating_a_cluster/update-using-custom-machine-config-pools.adoc#update-using-custom-machine-config-pools[Performing a canary rollout update]
152-
** xref:../../../updating/updating_a_cluster/updating-cluster-rhel-compute.adoc#updating-cluster-rhel-compute[Updating a cluster that includes RHEL compute machines]
142+
** xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console]
143+
** xref:../../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI]
144+
** xref:../../updating/updating_a_cluster/eus-eus-update.adoc#eus-eus-update[Performing an EUS-to-EUS update]
145+
** xref:../../updating/updating_a_cluster/update-using-custom-machine-config-pools.adoc#update-using-custom-machine-config-pools[Performing a canary rollout update]
146+
** xref:../../updating/updating_a_cluster/updating-cluster-rhel-compute.adoc#updating-cluster-rhel-compute[Updating a cluster that includes RHEL compute machines]
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
11
:_mod-docs-content-type: ASSEMBLY
22
ifndef::openshift-origin[]
3-
[id="updating-restricted-network-cluster"]
3+
[id="updating-disconnected-cluster"]
44
= Updating a cluster in a disconnected environment without the OpenShift Update Service
55
endif::openshift-origin[]
66
ifdef::openshift-origin[]
7-
[id="updating-restricted-network-cluster"]
7+
[id="updating-disconnected-cluster"]
88
= Updating a cluster in a disconnected environment by using the CLI
99
endif::openshift-origin[]
1010
include::_attributes/common-attributes.adoc[]
11-
:context: updating-restricted-network-cluster
11+
:context: updating-disconnected-cluster
1212

1313
toc::[]
1414

15-
////
16-
WARNING: This assembly has been moved into a subdirectory for 4.14+. Changes to this assembly for earlier versions should be done in separate PRs based off of their respective version branches. Otherwise, your cherry picks may fail.
17-
18-
To do: Remove this comment once 4.13 docs are EOL.
19-
////
20-
2115
Use the following procedures to update a cluster in a disconnected environment without access to the OpenShift Update Service.
2216

2317
== Prerequisites
2418

2519
* You must have the `oc` command-line interface (CLI) tool installed.
26-
* You must provision a local container image registry with the container images for your update, as described in xref:../../../updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
20+
* You must provision a local container image registry with the container images for your update, as described in xref:../../disconnected/updating/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
2721
* You must have access to the cluster as a user with `admin` privileges.
28-
See xref:../../../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions].
29-
* You must have a recent xref:../../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your update fails and you must xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state].
30-
* You have updated all Operators previously installed through Operator Lifecycle Manager (OLM) to a version that is compatible with your target release. Updating the Operators ensures they have a valid update path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster update. See xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators] for more information on how to check compatibility and, if necessary, update the installed Operators.
22+
See xref:../../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions].
23+
* You must have a recent xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your update fails and you must xref:../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state].
24+
* You have updated all Operators previously installed through Operator Lifecycle Manager (OLM) to a version that is compatible with your target release. Updating the Operators ensures they have a valid update path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster update. See xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators] for more information on how to check compatibility and, if necessary, update the installed Operators.
3125
* You must ensure that all machine config pools (MCPs) are running and not paused. Nodes associated with a paused MCP are skipped during the update process. You can pause the MCPs if you are performing a canary rollout update strategy.
32-
* If your cluster uses manually maintained credentials, update the cloud provider resources for the new release. For more information, including how to determine if this is a requirement for your cluster, see xref:../../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials].
26+
* If your cluster uses manually maintained credentials, update the cloud provider resources for the new release. For more information, including how to determine if this is a requirement for your cluster, see xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials].
3327
* If you run an Operator or you have configured any application with the pod disruption budget, you might experience an interruption during the update process. If `minAvailable` is set to 1 in `PodDisruptionBudget`, the nodes are drained to apply pending machine configs which might block the eviction process. If several nodes are rebooted, all the pods might run on only one node, and the `PodDisruptionBudget` field can prevent the node drain.
3428

3529
[NOTE]
@@ -49,7 +43,7 @@ include::modules/update-restricted.adoc[leveloffset=+1]
4943
[role="_additional-resources"]
5044
.Additional resources
5145

52-
* xref:../../../updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images]
46+
* xref:../../disconnected/updating/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images]
5347

5448
// Understanding image registry repository mirroring
5549
include::modules/images-configuration-registry-mirror.adoc[leveloffset=+1]
@@ -63,10 +57,10 @@ include::modules/images-configuration-registry-mirror-convert.adoc[leveloffset=+
6357
// Widening the scope of the mirror image catalog to reduce the frequency of cluster node reboots
6458
include::modules/generating-icsp-object-scoped-to-a-registry.adoc[leveloffset=+1]
6559

66-
[id="additional-resources_security-container-signature"]
60+
[id="additional-resources_{context}"]
6761
[role="_additional-resources"]
6862
== Additional resources
6963

70-
* xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
64+
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
7165

72-
* xref:../../../machine_configuration/index.adoc#machine-config-overview[Machine Config Overview]
66+
* xref:../../machine_configuration/index.adoc#machine-config-overview[Machine Config Overview]

disconnected/updating/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images/

0 commit comments

Comments
 (0)