Skip to content

Commit 3c29528

Browse files
authored
Merge pull request #62151 from skopacz1/OSDOCS-5789
OSDOCS-5789: Understanding updates section
2 parents 8e33390 + 89f8637 commit 3c29528

17 files changed

+49
-75
lines changed

_topic_maps/_topic_map.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -551,19 +551,20 @@ Distros: openshift-origin,openshift-enterprise
551551
Topics:
552552
- Name: Updating clusters overview
553553
File: index
554+
Distros: openshift-origin
554555
- Name: Understanding OpenShift updates
555556
Dir: understanding_updates
556-
Distros: openshift-enterprise
557557
Topics:
558558
- Name: Introduction to OpenShift updates
559559
File: intro-to-updates
560560
- Name: How cluster updates work
561561
File: how-updates-work
562-
- Name: Understanding update channels and releases
563-
File: understanding-upgrade-channels-release
564-
Distros: openshift-enterprise
565-
- Name: Understanding OpenShift update duration
566-
File: understanding-openshift-update-duration
562+
Distros: openshift-enterprise
563+
- Name: Understanding update channels and releases
564+
File: understanding-update-channels-release
565+
Distros: openshift-enterprise
566+
- Name: Understanding OpenShift update duration
567+
File: understanding-openshift-update-duration
567568
- Name: Preparing to update to OpenShift Container Platform 4.13
568569
File: updating-cluster-prepare
569570
Distros: openshift-enterprise

architecture/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ include::modules/openshift-architecture-common-terms.adoc[leveloffset=+1]
2020
* For more information on authentication, see xref:../authentication/index.adoc#index[{product-title} authentication].
2121
* For more information on Operator Lifecycle Manager (OLM), see xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[OLM].
2222
* For more information on logging, see xref:../logging/viewing-resource-logs.adoc#viewing-resource-logs[{product-title} Logging].
23-
* For more information on over-the-air (OTA) updates, see xref:../updating/index.adoc#index[Updating {product-title} clusters].
23+
* For more information on over-the-air (OTA) updates, see xref:../updating/understanding_updates/intro-to-updates.adoc#understanding-openshift-updates[Introduction to OpenShift updates].
2424
2525
[id="about-installation-and-updates"]
2626
== About installation and updates

installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ include::modules/ipi-preparing-reinstall-cluster-bare-metal.adoc[leveloffset=+1]
114114
[id="additional-resources_creating_manifest_ignition"]
115115
== Additional resources
116116
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-user-infra-generate-k8s-manifest-ignition_installing-bare-metal[{product-title} Creating the Kubernetes manifest and Ignition config files]
117-
* xref:../../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels-releases[Understanding update channels and releases]
117+
* xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases]

installing/validating-an-installation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ include::modules/getting-cluster-version-status-and-update-details.adoc[leveloff
2626
2727
* See xref:../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console] for more information on updating your cluster.
2828
29-
* See xref:../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels-releases[Understanding update channels and releases] for an overview about update release channels.
29+
* See xref:../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases] for an overview about update release channels.
3030
3131
//Querying the status of the cluster nodes by using the CLI
3232
include::modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc[leveloffset=+1]

modules/understanding-upgrade-channels.adoc renamed to modules/understanding-update-channels.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * updating/understanding-upgrade-channels-release.adoc
44

55

6-
[id="understanding-upgrade-channels_{context}"]
6+
[id="understanding-update-channels_{context}"]
77

88
= Update channels
99

modules/update-common-terms.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Channels:: _Channels_ declare an update strategy tied to minor versions of {prod
1818

1919
Recommended update edge:: A _recommended update edge_ is a recommended update between {product-title} releases. Whether a given update is recommended can depend on the cluster's configured channel, current version, known bugs, and other information. OSUS communicates the recommended edges to the CVO, which runs in every cluster.
2020

21+
ifndef::openshift-origin[]
22+
2123
Extended Update Support:: All post-4.7 even-numbered minor releases are labeled as _Extended Update Support_ (EUS) releases. These releases introduce a verified update path between EUS releases, permitting customers to streamline updates of worker worker nodes and formulate update strategies of EUS-to-EUS {product-title} releases that will cause fewer reboots of worker nodes.
2224
+
2325
For more information, see link:https://access.redhat.com/support/policy/updates/openshift-eus[Red Hat OpenShift Extended Update Support (EUS) Overview].
26+
27+
endif::openshift-origin[]

networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-load-balancer-allowed-source-ranges.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ include::modules/nw-configuring-lb-allowed-source-ranges-migration.adoc[leveloff
1313

1414
[role="_additional-resources"]
1515
== Additional resources
16-
* xref:../../updating/index.adoc#index[Updating your cluster]
16+
* xref:../../updating/understanding_updates/intro-to-updates.adoc#understanding-openshift-updates[Introduction to OpenShift updates]

scalability_and_performance/ztp_far_edge/ztp-talm-updating-managed-policies.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::modules/cnf-topology-aware-lifecycle-manager-preparing-for-updates.adoc
2828
2929
* For more information about how to prepare the disconnected environment and mirroring the desired image repository, see xref:../../scalability_and_performance/ztp_far_edge/ztp-preparing-the-hub-cluster.adoc#ztp-preparing-the-hub-cluster[Preparing the disconnected environment].
3030
31-
* For more information about update channels and releases, see xref:../../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels-releases[Understanding update channels and releases].
31+
* For more information about update channels and releases, see xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases].
3232
3333
include::modules/cnf-topology-aware-lifecycle-manager-platform-update.adoc[leveloffset=+2]
3434

updating/index.adoc

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,13 @@ toc::[]
88

99
You can update an {product-title} 4 cluster with a single operation by using the web console or the OpenShift CLI (`oc`).
1010

11-
ifndef::openshift-origin[]
12-
[id="updating-clusters-overview-understanding-container-platform-updates"]
13-
== Understanding OpenShift Container Platform updates
14-
xref:../updating/understanding_updates/intro-to-updates.adoc#update-service-about_understanding-openshift-updates[About the OpenShift Update Service]: For clusters with internet access, Red Hat provides over-the-air updates by using an {product-title} update service as a hosted service located behind public APIs.
15-
endif::openshift-origin[]
16-
17-
[id="updating-clusters-overview-upgrade-channels-and-releases"]
11+
[id="updating-clusters-overview-update-channels-and-releases"]
1812
== Understanding update channels and releases
19-
ifndef::openshift-origin[]
20-
xref:../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels-releases[Update channels and releases]: With update channels, you can choose an update strategy. Update channels are specific to a minor version of {product-title}. Update channels only control release selection and do not impact the version of the cluster that you install. The `openshift-install` binary file for a specific version of the {product-title} always installs that minor version. For more information, see the following:
21-
22-
* xref:../updating/understanding-upgrade-channels-release.adoc#upgrade-version-paths_understanding-upgrade-channels-releases[Upgrading version paths]
23-
* xref:../updating/understanding-upgrade-channels-release.adoc#fast-stable-channel-strategies_understanding-upgrade-channels-releases[Understanding fast and stable channel use and strategies]
24-
* xref:../updating/understanding-upgrade-channels-release.adoc#restricted-network-clusters_understanding-upgrade-channels-releases[Understanding restricted network clusters]
25-
* xref:../updating/understanding-upgrade-channels-release.adoc#switching-between-channels_understanding-upgrade-channels-releases[Switching between channels]
26-
* xref:../updating/understanding-upgrade-channels-release.adoc#conditional-updates-overview_understanding-upgrade-channels-releases[Understanding conditional updates]
27-
endif::openshift-origin[]
28-
ifdef::openshift-origin[]
2913
With update channels, you can choose an update strategy. Update channels are specific to a minor version of {product-title}. Update channels only control release selection and do not impact the version of the cluster that you install. The `openshift-install` binary file for a specific version of the {product-title} always installs that minor version.
3014

3115
{product-title} {product-version} offers the following update channel:
3216

3317
* `stable-4`
34-
endif::openshift-origin[]
35-
36-
37-
include::modules/determining-upgrade-viability-conditiontype.adoc[leveloffset=+1]
38-
39-
include::modules/determining-upgrade-viability-cv-conditiontype.adoc[leveloffset=+1]
40-
41-
ifndef::openshift-origin[]
42-
[id="updating-clusters-overview-prepare-eus-to-eus-update"]
43-
== Performing an EUS-to-EUS update
44-
xref:../updating/updating_a_cluster/eus-eus-update.adoc#eus-eus-update[Performing an EUS-to-EUS update]: Due to fundamental Kubernetes design, all {product-title} updates between minor versions must be serialized. You must update from {product-title} 4.10 to 4.11, and then to 4.12. You cannot update from {product-title} 4.10 to 4.12 directly. However, if you want to update between two Extended Update Support (EUS) versions, you can do so by incurring only a single reboot of non-control plane hosts. For more information, see the following:
45-
46-
* xref:../updating/updating_a_cluster/eus-eus-update.adoc#updating-eus-to-eus-upgrade_eus-to-eus-update[EUS-to-EUS update]
47-
endif::openshift-origin[]
4818

4919
[id="updating-clusters-overview-update-cluster-using-web-console"]
5020
== Updating a cluster using the web console
@@ -75,16 +45,6 @@ xref:../updating/updating_a_cluster/update-using-custom-machine-config-pools.ado
7545
* xref:../updating/updating_a_cluster/update-using-custom-machine-config-pools.adoc#update-using-custom-machine-config-pools-unpause_update-using-custom-machine-config-pools[Unpausing the machine configuration pools]
7646
* xref:../updating/updating_a_cluster/update-using-custom-machine-config-pools.adoc#update-using-custom-machine-config-pools-mcp-remove_update-using-custom-machine-config-pools[Moving a node to the original machine configuration pool]
7747

78-
ifndef::openshift-origin[]
79-
[id="updating-clusters-overview-update-cluster-with-rhel-compute-machines"]
80-
== Updating a cluster that includes {op-system-base} compute machines
81-
xref:../updating/updating_a_cluster/updating-cluster-rhel-compute.adoc#updating-cluster-rhel-compute[Updating a cluster that includes {op-system-base} compute machines]: If your cluster contains {op-system-base-full} machines, you must perform additional steps to update those machines. You can perform the following procedures:
82-
83-
* xref:../updating/updating_a_cluster/updating-cluster-rhel-compute.adoc#update-upgrading-web_updating-cluster-rhel-compute[Updating a cluster by using the web console]
84-
* xref:../updating/updating_a_cluster/updating-cluster-rhel-compute.adoc#updating-cluster-rhel-compute-hooks[Optional: Adding hooks to perform Ansible tasks on {op-system-base} machines]
85-
* xref:../updating/updating_a_cluster/updating-cluster-rhel-compute.adoc#rhel-compute-updating-minor_updating-cluster-rhel-compute[Updating {op-system-base} compute machines in your cluster]
86-
endif::openshift-origin[]
87-
8848
[id="updating-clusters-overview-update-restricted-network-cluster"]
8949
== Updating a cluster in a disconnected environment
9050
xref:../updating/updating_a_cluster/updating_disconnected_cluster/index.adoc#about-restricted-network-updates[About cluster updates in a disconnected environment]: If your mirror host cannot access both the internet and the cluster, you can mirror the images to a file system that is disconnected from that environment. You can then bring that host or removable media across that gap. If the local container registry and the cluster are connected to the mirror host of a registry, you can directly push the release images to the local registry.

updating/understanding_updates/how-updates-work.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include::modules/update-evaluate-availability.adoc[leveloffset=+1]
1313
[role="_additional-resources"]
1414
.Additional resources
1515

16-
* xref:../../updating/understanding-upgrade-channels-release.adoc#conditional-updates-overview_understanding-upgrade-channels-releases[Update recommendation removals and Conditional Updates]
16+
* xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#conditional-updates-overview_understanding-update-channels-releases[Update recommendation removals and Conditional Updates]
1717
1818
include::modules/update-release-images.adoc[leveloffset=+1]
1919

@@ -24,7 +24,7 @@ include::modules/update-manifest-application.adoc[leveloffset=+1]
2424
[role="_additional-resources"]
2525
.Additional resources
2626

27-
* xref:../../updating/understanding-openshift-update-duration.adoc#understanding-openshift-update-duration[Understanding {product-title} update duration]
27+
* xref:../../updating/understanding_updates/understanding-openshift-update-duration.adoc#understanding-openshift-update-duration[Understanding {product-title} update duration]
2828
2929
include::modules/update-mco-process.adoc[leveloffset=+1]
3030

0 commit comments

Comments
 (0)