Skip to content

Commit fece6cc

Browse files
authored
Merge pull request #74472 from obrown1205/OSDOCS-10218
OSDOCS-10218: Docs for renaming supported but not recommended to know…
2 parents 697fcae + e7527df commit fece6cc

8 files changed

+38
-28
lines changed

modules/understanding-update-channels.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Red Hat monitors newly released versions and update paths associated with those
7575

7676
If Red Hat removes update recommendations from any supported release, a superseding update recommendation will be provided to a future version that corrects the regression. There may however be a delay while the defect is corrected, tested, and promoted to your selected channel.
7777

78-
Beginning in {product-title} 4.10, when update risks are confirmed, they are declared as Conditional Update risks for the relevant updates. Each known risk may apply to all clusters or only clusters matching certain conditions. Some examples include having the `Platform` set to `None` or the CNI provider set to `OpenShiftSDN`. The Cluster Version Operator (CVO) continually evaluates known risks against the current cluster state. If no risks match, the update is recommended. If the risk matches, those updates are supported but not recommended, and a reference link is provided. The reference link helps the cluster admin decide if they would like to accept the risk and update anyway.
78+
Beginning in {product-title} 4.10, when update risks are confirmed, they are declared as Conditional Update risks for the relevant updates. Each known risk may apply to all clusters or only clusters matching certain conditions. Some examples include having the `Platform` set to `None` or the CNI provider set to `OpenShiftSDN`. The Cluster Version Operator (CVO) continually evaluates known risks against the current cluster state. If no risks match, the update is recommended. If the risk matches, those update paths are labeled as _updates with known issues_, and a reference link to the known issues is provided. The reference link helps the cluster admin decide if they want to accept the risk and continue to update their cluster.
7979

8080
When Red Hat chooses to declare Conditional Update risks, that action is taken in all relevant channels simultaneously. Declaration of a Conditional Update risk may happen either before or after the update has been promoted to supported channels.
8181

modules/update-availability-faq.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,16 @@ The primary purpose of the `eus` channel is to serve as a convenience for cluste
3535
* A release that is available on the `fast` channel always becomes available on the `stable` channel after this delay.
3636
3737
[id="supported-updates_{context}"]
38-
*What does it mean if an update is supported but not recommended?*
38+
*What does it mean if an update has known issues?*
3939

40-
* Red Hat continuously evaluates data from multiple sources to determine whether updates from one version to another lead to issues.
41-
If an issue is identified, an update path may no longer be recommended to users.
42-
However, even if the update path is not recommended, customers are still supported if they perform the update.
40+
* Red{nbsp}Hat continuously evaluates data from multiple sources to determine whether updates from one version to another have any declared issues. Identified issues are typically documented in the version's release notes.
41+
Even if the update path has known issues, customers are still supported if they perform the update.
4342
4443
* Red Hat does not block users from updating to a certain version.
4544
Red Hat may declare conditional update risks, which may or may not apply to a particular cluster.
4645
4746
** Declared risks provide cluster administrators more context about a supported update.
4847
Cluster administrators can still accept the risk and update to that particular target version.
49-
This update is always supported despite not being recommended in the context of the conditional risk.
5048

5149
[id="removed-recommendation_{context}"]
5250
*What if I see that an update to a particular release is no longer recommended?*

modules/update-cluster-version-object.adoc

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,32 +37,45 @@ $ oc adm upgrade --include-not-recommended
3737
+
3838
[NOTE]
3939
====
40-
The additional `--include-not-recommended` parameter includes updates that are available but not recommended due to a known risk that applies to the cluster.
40+
The additional `--include-not-recommended` parameter includes updates that are available with known issues that apply to the cluster.
4141
====
4242
+
4343
.Example output
4444
[source,terminal]
4545
----
46-
Cluster version is 4.10.22
46+
Cluster version is 4.13.40
4747
4848
Upstream is unset, so the cluster will use an appropriate default.
49-
Channel: fast-4.11 (available channels: candidate-4.10, candidate-4.11, eus-4.10, fast-4.10, fast-4.11, stable-4.10)
49+
Channel: stable-4.14 (available channels: candidate-4.13, candidate-4.14, eus-4.14, fast-4.13, fast-4.14, stable-4.13, stable-4.14)
5050
5151
Recommended updates:
5252
5353
VERSION IMAGE
54-
4.10.26 quay.io/openshift-release-dev/ocp-release@sha256:e1fa1f513068082d97d78be643c369398b0e6820afab708d26acda2262940954
55-
4.10.25 quay.io/openshift-release-dev/ocp-release@sha256:ed84fb3fbe026b3bbb4a2637ddd874452ac49c6ead1e15675f257e28664879cc
56-
4.10.24 quay.io/openshift-release-dev/ocp-release@sha256:aab51636460b5a9757b736a29bc92ada6e6e6282e46b06e6fd483063d590d62a
57-
4.10.23 quay.io/openshift-release-dev/ocp-release@sha256:e40e49d722cb36a95fa1c03002942b967ccbd7d68de10e003f0baa69abad457b
58-
59-
Supported but not recommended updates:
60-
61-
Version: 4.11.0
62-
Image: quay.io/openshift-release-dev/ocp-release@sha256:300bce8246cf880e792e106607925de0a404484637627edf5f517375517d54a4
63-
Recommended: False
64-
Reason: RPMOSTreeTimeout
65-
Message: Nodes with substantial numbers of containers and CPU contention may not reconcile machine configuration https://bugzilla.redhat.com/show_bug.cgi?id=2111817#c22
54+
4.14.27 quay.io/openshift-release-dev/ocp-release@sha256:4d30b359aa6600a89ed49ce6a9a5fdab54092bcb821a25480fdfbc47e66af9ec
55+
4.14.26 quay.io/openshift-release-dev/ocp-release@sha256:4fe7d4ccf4d967a309f83118f1a380a656a733d7fcee1dbaf4d51752a6372890
56+
4.14.25 quay.io/openshift-release-dev/ocp-release@sha256:a0ef946ef8ae75aef726af1d9bbaad278559ad8cab2c1ed1088928a0087990b6
57+
4.14.24 quay.io/openshift-release-dev/ocp-release@sha256:0a34eac4b834e67f1bca94493c237e307be2c0eae7b8956d4d8ef1c0c462c7b0
58+
4.14.23 quay.io/openshift-release-dev/ocp-release@sha256:f8465817382128ec7c0bc676174bad0fb43204c353e49c146ddd83a5b3d58d92
59+
4.13.42 quay.io/openshift-release-dev/ocp-release@sha256:dcf5c3ad7384f8bee3c275da8f886b0bc9aea7611d166d695d0cf0fff40a0b55
60+
4.13.41 quay.io/openshift-release-dev/ocp-release@sha256:dbb8aa0cf53dc5ac663514e259ad2768d8c82fd1fe7181a4cfb484e3ffdbd3ba
61+
62+
Updates with known issues:
63+
64+
Version: 4.14.22
65+
Image: quay.io/openshift-release-dev/ocp-release@sha256:7093fa606debe63820671cc92a1384e14d0b70058d4b4719d666571e1fc62190
66+
Reason: MultipleReasons
67+
Message: Exposure to AzureRegistryImageMigrationUserProvisioned is unknown due to an evaluation failure: client-side throttling: only 18.061µs has elapsed since the last match call completed for this cluster condition backend; this cached cluster condition request has been queued for later execution
68+
In Azure clusters with the user-provisioned registry storage, the in-cluster image registry component may struggle to complete the cluster update. https://issues.redhat.com/browse/IR-468
69+
70+
Incoming HTTP requests to services exposed by Routes may fail while routers reload their configuration, especially when made with Apache HTTPClient versions before 5.0. The problem is more likely to occur in clusters with higher number of Routes and corresponding endpoints. https://issues.redhat.com/browse/NE-1689
71+
72+
Version: 4.14.21
73+
Image: quay.io/openshift-release-dev/ocp-release@sha256:6e3fba19a1453e61f8846c6b0ad3abf41436a3550092cbfd364ad4ce194582b7
74+
Reason: MultipleReasons
75+
Message: Exposure to AzureRegistryImageMigrationUserProvisioned is unknown due to an evaluation failure: client-side throttling: only 33.991µs has elapsed since the last match call completed for this cluster condition backend; this cached cluster condition request has been queued for later execution
76+
In Azure clusters with the user-provisioned registry storage, the in-cluster image registry component may struggle to complete the cluster update. https://issues.redhat.com/browse/IR-468
77+
78+
Incoming HTTP requests to services exposed by Routes may fail while routers reload their configuration, especially when made with Apache HTTPClient versions before 5.0. The problem is more likely to occur in clusters with higher number of Routes and corresponding endpoints. https://issues.redhat.com/browse/NE-1689
6679
----
6780
+
6881
The `oc adm upgrade` command queries the `ClusterVersion` resource for information about available updates and presents it in a human-readable format.

modules/update-conditional-updates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ $ oc adm upgrade --include-not-recommended
2424
----
2525
$ oc adm upgrade --allow-not-recommended --to <version> <.>
2626
----
27-
<.> `<version>` is the supported but not recommended update version that you obtained from the output of the previous command.
27+
<.> `<version>` is the update version that you obtained from the output of the previous command, which is supported but also has known issues or risks.

modules/update-conditional-web-console.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,11 @@ You can view and assess the risks associated with particular updates with condit
2222
.Procedure
2323

2424
. From the web console, click *Administration* -> *Cluster settings* page and review the contents of the *Details* tab.
25-
26-
. You can enable `Include supported but not recommended versions` in the `Select new version` dropdown of the *Update cluster* modal to populate the dropdown list with conditional updates.
25+
. You can enable the `Include versions with known issues` feature in the *Select new version* dropdown of the *Update cluster* modal to populate the dropdown list with conditional updates.
2726
+
2827
[NOTE]
2928
====
30-
If a `Supported but not recommended` version is selected, more information is provided with potential issues with the version.
29+
If a version with known issues is selected, more information is provided with potential risks that are associated with the version.
3130
====
3231

3332
. Review the notification detailing the potential risks to updating.

modules/update-evaluate-availability.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ The CVO continuously evaluates its cluster characteristics against the condition
1818
If the CVO finds that the cluster does not match the risks of an update, or that there are no risks associated with the update, it stores the target version in the `availableUpdates` field of its `ClusterVersion` resource.
1919

2020
The user interface, either the web console or the OpenShift CLI (`oc`), presents this information in sectioned headings to the administrator.
21-
Each *supported but not recommended* update recommendation contains a link to further resources about the risk so that the administrator can make an informed decision about the update.
21+
Each known issue associated with the update path contains a link to further resources about the risk so that the administrator can make an informed decision about the update.

modules/update-service-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To allow the OpenShift Update Service to provide only compatible updates, a rele
1919

2020
[IMPORTANT]
2121
====
22-
The OpenShift Update Service displays all recommended updates for your current cluster. If an update path is not recommended by the OpenShift Update Service, it might be because of a known issue with the update or the target release.
22+
The OpenShift Update Service displays all recommended updates for your current cluster. If an update path is not recommended by the OpenShift Update Service, it might be because of a known issue related to the update path, such as incompatibility or availability.
2323
====
2424

2525
////

modules/update-upgrading-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ endif::openshift-origin[]
6666
+
6767
[NOTE]
6868
====
69-
* If there are no available updates, updates that are supported but not recommended might still be available.
69+
* If there are no recommended updates, updates that have known issues might still be available.
7070
See _Updating along a conditional update path_ for more information.
7171
ifndef::openshift-origin[]
7272
* For details and information on how to perform an `EUS-to-EUS` channel update, please refer to the _Preparing to perform an EUS-to-EUS upgrade_ page, listed in the Additional resources section.

0 commit comments

Comments
 (0)