Skip to content

Commit 8e7a9ff

Browse files
committed
OSDOCS-5545: guidance for updating to a new minor version
1 parent 859621e commit 8e7a9ff

File tree

4 files changed

+39
-12
lines changed

4 files changed

+39
-12
lines changed

modules/understanding-upgrade-channels.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
// Module included in the following assemblies:
22
//
3-
// * updating/updating-cluster-within-minor.adoc
4-
// * updating/updating-cluster-cli.adoc
5-
// * updating/updating-cluster-rhel-compute.adoc
6-
// * updating/updating-disconnected-cluster.adoc
3+
// * updating/understanding-upgrade-channels-release.adoc
4+
75

86
[id="understanding-upgrade-channels_{context}"]
97

@@ -92,7 +90,7 @@ First, select the minor version you want for your cluster upgrade. Selecting a c
9290
Due to the complexity involved in planning upgrades between versions many minors apart, channels that assist in planning upgrades beyond a single EUS-to-EUS update are not offered.
9391
====
9492

95-
Second, you should choose your desired rollout strategy. You may choose to update as soon as Red Hat declares a release GA by selecting from fast channels or you may want to wait for Red Hat to promote releases to the stable channel. Update recommendations offered in the `fast-{product-version}` and `stable-{product-version}` are both fully supported and benefit equally from ongoing data analysis. The promotion delay before promoting release to the stable channel represents the only difference between the two channels. Updates to the latest z-streams are generally promoted to the stable channel within a week or two, however the delay when initially rolling out updates to the latest minor is much longer, generally 45-90 days. Please consider the promotion delay when choosing your desired channel as waiting for promotion to the stable channel may affect your scheduling plans.
93+
Second, you should choose your desired rollout strategy. You may choose to update as soon as Red Hat declares a release GA by selecting from fast channels or you may want to wait for Red Hat to promote releases to the stable channel. Update recommendations offered in the `fast-{product-version}` and `stable-{product-version}` are both fully supported and benefit equally from ongoing data analysis. The promotion delay before promoting a release to the stable channel represents the only difference between the two channels. Updates to the latest z-streams are generally promoted to the stable channel within a week or two, however the delay when initially rolling out updates to the latest minor is much longer, generally 45-90 days. Please consider the promotion delay when choosing your desired channel, as waiting for promotion to the stable channel may affect your scheduling plans.
9694

9795
Additionally, there are several factors which may lead an organization to move clusters to the fast channel either permanently or temporarily including:
9896

modules/update-upgrading-cli.adoc

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ VERSION IMAGE
5555
+
5656
[NOTE]
5757
====
58-
For details and information on how to perform an `EUS-to-EUS` channel upgrade, please refer to the
58+
For details and information on how to perform an `EUS-to-EUS` channel upgrade, please refer to the
5959
_Preparing to perform an EUS-to-EUS upgrade_ page, listed in the Additional resources section.
6060
====
6161

@@ -77,6 +77,16 @@ $ oc adm upgrade channel stable-{product-version}
7777
====
7878
For production clusters, you must subscribe to a `stable-\*`, `eus-*`, or `fast-*` channel.
7979
====
80+
+
81+
[NOTE]
82+
====
83+
When you are ready to move to the next minor version, choose the channel that corresponds to that minor version.
84+
The sooner the update channel is declared, the more effectively the cluster can recommend update paths to your target version.
85+
The cluster might take some time to evaluate all the possible updates that are available and offer the best update recommendations to choose from.
86+
Update recommendations can change over time, as they are based on what update options are available at the time.
87+
88+
If you cannot see an update path to your target minor version, keep updating your cluster to the latest patch release for your current version until the next minor version is available in the path.
89+
====
8090

8191
. Apply an update:
8292
** To update to the latest version:
@@ -114,10 +124,10 @@ $ oc get clusterversion
114124
[source,terminal]
115125
----
116126
117-
Cluster version is <version>
127+
Cluster version is <version>
118128
119129
Upstream is unset, so the cluster will use an appropriate default.
120-
Channel: stable-4.10 (available channels: candidate-4.10, candidate-4.11, eus-4.10, fast-4.10, fast-4.11, stable-4.10)
130+
Channel: stable-4.10 (available channels: candidate-4.10, candidate-4.11, eus-4.10, fast-4.10, fast-4.11, stable-4.10)
121131
122132
No updates available. You may force an upgrade to a specific release image, but doing so might not be supported and might result in downtime or data loss.
123133
----

modules/update-upgrading-web.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,16 @@ link:https://access.redhat.com/downloads/content/290[in the errata section] of t
3030
====
3131
For production clusters, you must subscribe to a `stable-\*`, `eus-*` or `fast-*` channel.
3232
====
33-
ifdef::openshift-origin[]
34-
such as `stable-4`.
35-
endif::openshift-origin[]
33+
+
34+
[NOTE]
35+
====
36+
When you are ready to move to the next minor version, choose the channel that corresponds to that minor version.
37+
The sooner the update channel is declared, the more effectively the cluster can recommend update paths to your target version.
38+
The cluster might take some time to evaluate all the possible updates that are available and offer the best update recommendations to choose from.
39+
Update recommendations can change over time, as they are based on what update options are available at the time.
40+
41+
If you cannot see an update path to your target minor version, keep updating your cluster to the latest patch release for your current version until the next minor version is available in the path.
42+
====
3643
** If the *Update status* is not *Updates available*, you cannot update your cluster.
3744
** *Select channel* indicates the cluster version that your cluster is running or is updating to.
3845

updating/understanding-upgrade-channels-release.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,19 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Update channels are tied to a minor version of {product-title}. For instance, {product-title} 4.10 update channels recommend updates to 4.10 and updates within 4.10. They also recommend updates within 4.9 and from 4.9 to 4.10 allowing all 4.9 to eventually update to 4.10, even if they do not immediately meet the minimum z-stream version requirements. They do not recommend updates to 4.11 or later releases. This strategy ensures that administrators explicitly decide to update to the next minor version of {product-title}.
9+
Update channels are the mechanism by which users declare the {product-title} minor version they intend to update their clusters to. They also allow users to choose the timing and level of support their updates will have through the `fast`, `stable`, `candidate`, and `eus` channel options. The Cluster Version Operator uses an update graph based on the channel declaration, along with other conditional information, to provide a list of recommended and conditional updates available to the cluster.
10+
11+
Update channels correspond to a minor version of {product-title}. The version number in the channel represents the target minor version that the cluster will eventually be updated to, even if it is higher than the cluster's current minor version.
12+
13+
For instance, {product-title} 4.10 update channels provide the following recommendations:
14+
15+
* Updates within 4.10.
16+
* Updates within 4.9.
17+
* Updates from 4.9 to 4.10, allowing all 4.9 clusters to eventually update to 4.10, even if they do not immediately meet the minimum z-stream version requirements.
18+
* `eus-4.10` only: updates within 4.8.
19+
* `eus-4.10` only: updates from 4.8 to 4.9 to 4.10, allowing all 4.8 clusters to eventually update to 4.10.
20+
21+
4.10 update channels do not recommend updates to 4.11 or later releases. This strategy ensures that administrators must explicitly decide to update to the next minor version of {product-title}.
1022

1123
Update channels control only release selection and do not impact the version of the cluster that you install. The `openshift-install` binary file for a specific version of {product-title} always installs that version.
1224

0 commit comments

Comments
 (0)