Skip to content

Commit 7af3d84

Browse files
authored
Merge pull request #40412 from sagidlow/OSDOCS-2911-prod
OSDOCS-2911: Adding documentation about conditional updates
2 parents 5f567ca + f57b95b commit 7af3d84

6 files changed

+54
-2
lines changed

modules/understanding-upgrade-channels.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ endif::openshift-origin[]
8888
The service recommends only upgrades that have been tested and have no serious issues. It will not suggest updating to a version of {product-title} that contains known vulnerabilities. For example, if your cluster is on {product-version}.1 and {product-title} suggests {product-version}.4, then it is safe for you to update from {product-version}.1 to {product-version}.4. Do not rely on consecutive patch numbers. In this example, {product-version}.2 is not and never was available in the channel.
8989

9090
ifndef::openshift-origin[]
91-
Update stability depends on your channel. The presence of an update recommendation in the `candidate-{product-version}` channel does not imply that the update is supported. It means that no serious issues have been found with the update yet, but there might not be significant traffic through the update to suggest stability. The presence of an update recommendation in the `fast-{product-version}` or `stable-{product-version}` channels at any point is a declaration that the update is supported. While releases will never be removed from a channel, update recommendations that exhibit serious issues will be removed from all channels. Updates initiated after the update recommendation has been removed are still supported.
91+
Update stability depends on your channel. The presence of an update recommendation in the `candidate-{product-version}` channel does not imply that the update is supported. It means that no serious issues have been found with the update yet, but there might not be significant traffic through the update to suggest stability. The presence of an update recommendation in the `fast-{product-version}` or `stable-{product-version}` channels at any point is a declaration that the update is supported. While releases will never be removed from a channel, update recommendations that exhibit serious issues will be removed or made conditional from all channels. When an update recommendation is supported, it remains supported for the life of {product-version}, even if the update recommendation is later dropped or made conditional.
9292

9393
Red Hat will eventually provide supported update paths from any supported release in the `fast-{product-version}` or `stable-{product-version}` channels to the latest release in {product-version}.z, although there can be delays while safe paths away from troubled releases are constructed and verified.
9494
endif::openshift-origin[]
9595

9696
ifdef::openshift-origin[]
97-
The presence of an update recommendation in the `stable-4` channel at any point is a declaration that the update is supported. While releases will never be removed from the channel, update recommendations that exhibit serious issues will be removed from the channel. Updates initiated after the update recommendation has been removed are still supported.
97+
The presence of an update recommendation in the `stable-4` channel at any point is a declaration that the update is supported. While releases will never be removed from the channel, update recommendations that exhibit serious issues will be removed or made conditional from all channels. When an update recommendation is supported, it remains supported for the life of {product-version}, even if the update recommendation is later dropped or made conditional.
9898
endif::openshift-origin[]
9999

100100
ifndef::openshift-origin[]
@@ -136,3 +136,11 @@ Changing your channel might impact the supportability of your cluster. The follo
136136

137137
* You can always switch from the `fast-{product-version}` channel to the `stable-{product-version}` channel. There is a possible delay of up to a day for the release to be promoted to `stable-{product-version}` if the current release was recently promoted.
138138
endif::openshift-origin[]
139+
140+
[id="conditional-updates-overview_{context}"]
141+
== Conditional updates
142+
143+
The OpenShift Update Service might declare conditionally recommended updates associated with known risks.
144+
The Cluster Version Operator (CVO) continually evaluates known risks associated with updates from the current {product-title} release to later releases.
145+
When no risks apply, the update is recommended. You can update from the Administrator perspective on the web console, as well as the OpenShift CLI (`oc`).
146+
When an update is not recommended because a risk might apply, you can view the update from the OpenShift CLI (`oc`). If the cluster administrator evaluates the potential known risks and decides it is acceptable for the current cluster, the administrator can waive the safety guards and proceed to an update.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating-cluster-cli.adoc
4+
// * updating/understanding-upgrade-channels-releases.adoc
5+
6+
[id="update-conditional-upgrade-path{context}"]
7+
= Updating along a conditional upgrade path
8+
9+
You can update along a recommended conditional upgrade path using the web console or the OpenShift CLI (`oc`).
10+
When a conditional update is not recommended for your cluster, you can update along a conditional upgrade path using the OpenShift CLI (`oc`) 4.10 or later.
11+
12+
.Procedure
13+
14+
. To view the description of the update when it is not recommended because a risk might apply, run the following command:
15+
+
16+
[source,terminal]
17+
----
18+
$ oc adm upgrade --include-not-recommended
19+
----
20+
21+
. If the cluster administrator evaluates the potential known risks and decides it is acceptable for the current cluster, then the administrator can waive the safety guards and proceed the update by running the following command:
22+
+
23+
[source,terminal]
24+
----
25+
$ oc adm upgrade --allow-not-recommended --to <version> <.>
26+
----
27+
<.> `<version>` is the supported but not recommended update version that you obtained from the output of the previous command.

updating/understanding-the-update-service.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,9 @@ If you are on a restricted network where disconnected clusters cannot access the
1414

1515
include::modules/update-service-overview.adoc[leveloffset=+1]
1616

17+
.Additional resources
18+
19+
* xref:../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels_understanding-upgrade-channels-releases[Understanding upgrade channels and releases]
20+
21+
1722
include::modules/unmanaged-operators.adoc[leveloffset=+1]

updating/understanding-upgrade-channels-release.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,6 @@ ifdef::openshift-origin[]
3333
endif::openshift-origin[]
3434

3535
include::modules/understanding-upgrade-channels.adoc[leveloffset=+1]
36+
37+
.Additional resources
38+
* For more information, see xref:../updating/updating-cluster-cli.adoc#update-conditional-upgrade-pathupdating-cluster-cli[Updating along a conditional upgrade path]

updating/updating-cluster-cli.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,10 @@ include::modules/updating-sno.adoc[leveloffset=+1]
4242
For information on which machine configuration changes require a reboot, see the note in xref:../architecture/control-plane.adoc#understanding-machine-config-operator_control-plane[Understanding the Machine Config Operator].
4343

4444
include::modules/update-upgrading-cli.adoc[leveloffset=+1]
45+
include::modules/update-conditional-updates.adoc[leveloffset=+1]
46+
47+
.Additional resources
48+
49+
* xref:../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels_understanding-upgrade-channels-releases[Upgrade channels and release paths]
4550

4651
include::modules/update-changing-update-server-cli.adoc[leveloffset=+1]

updating/updating-cluster-within-minor.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,7 @@ include::modules/updating-sno.adoc[leveloffset=+1]
5959
include::modules/update-upgrading-web.adoc[leveloffset=+1]
6060

6161
include::modules/update-changing-update-server-web.adoc[leveloffset=+1]
62+
63+
.Additional resources
64+
65+
* xref:../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels_understanding-upgrade-channels-releases[Understanding upgrade channels and releases]

0 commit comments

Comments
 (0)