Skip to content

Commit 44657b5

Browse files
obrown1205obrown1205
committed
OSDOCS-12920: oc adm upgrade recommend TP doc
1 parent fcbdf08 commit 44657b5

File tree

3 files changed

+96
-11
lines changed

3 files changed

+96
-11
lines changed

‎modules/update-upgrading-oc-adm-upgrade-recommend.adoc

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating_a_cluster/updating-cluster-cli.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="update-upgrading-oc-adm-upgrade-recommend_{context}"]
7+
= Finding recommended update paths with oc adm upgrade recommend (Technology Preview)
8+
9+
When updating your cluster, the `oc adm upgrade` command returns a list of the next available versions. You can use the `oc adm upgrade recommend` command to narrow down your suggestions and recommend a new target release before you launch your update.
10+
11+
The `oc adm upgrade recommend` command is read-only and cannot alter the state of your cluster.
12+
13+
:FeatureName: The `oc adm upgrade recommend` command
14+
include::snippets/technology-preview.adoc[]
15+
16+
[NOTE]
17+
====
18+
Your cluster does not need to be a Technology Preview-enabled cluster in order for you to use the `oc adm upgrade recommend` command.
19+
====
20+
21+
.Procedure
22+
23+
. Set the `OC_ENABLE_CMD_UPGRADE_RECOMMEND` environment variable to `true` by running the following command:
24+
+
25+
[source,terminal]
26+
----
27+
$ export OC_ENABLE_CMD_UPGRADE_RECOMMEND=true
28+
----
29+
. Run one of the following commands:
30+
31+
** To list the recommended versions for your update, run the `oc adm upgrade recommend` command:
32+
+
33+
[source,terminal]
34+
----
35+
$ oc adm upgrade recommend
36+
----
37+
+
38+
.Example output
39+
40+
[source,terminal]
41+
----
42+
Upstream is unset, so the cluster will use an appropriate default.
43+
Channel: stable-4.13 (available channels: candidate-4.12, candidate-4.13, eus-4.12, eus-4.14, fast-4.12, fast-4.13, stable-4.12, stable-4.13)
44+
45+
Updates to 4.13:
46+
47+
Version: 4.13.50
48+
Image: quay.io/openshift-release-dev/ocp-release@sha256:6afb11e1cac46fd26476ca134072937115256b9c6360f7a1cd1812992c065f02
49+
Reason: AdminAckRequired
50+
Message: Kubernetes 1.26 and therefore OpenShift 4.13 remove several APIs which require admin consideration. Please see the knowledge article https://access.redhat.com/articles/6958394 for details and instructions.
51+
52+
Version: 4.13.49
53+
Image: quay.io/openshift-release-dev/ocp-release@sha256:ab6f574665395d809511db9dc57764358278538eaae248c6d199208b3c30ab7d
54+
Reason: AdminAckRequired
55+
Message: Kubernetes 1.26 and therefore OpenShift 4.13 remove several APIs which require admin consideration. Please see the knowledge article https://access.redhat.com/articles/6958394 for details and instructions.
56+
57+
Updates to 4.12:
58+
VERSION ISSUES
59+
4.12.64 no known issues
60+
4.12.63 no known issues
61+
And 43 older 4.12 updates you can see with '--show-outdated-releases' or '--version VERSION'.
62+
----
63+
64+
** To determine whether a specific version is recommended for your update, run the `oc adm upgrade recommend --version` command:
65+
+
66+
[source,terminal]
67+
----
68+
$ oc adm upgrade recommend --version 4.12.51
69+
----
70+
+
71+
.Example output
72+
73+
[source,terminal]
74+
----
75+
Upstream is unset, so the cluster will use an appropriate default.
76+
Channel: stable-4.13 (available channels: candidate-4.12, candidate-4.13, eus-4.12, eus-4.14, fast-4.12, fast-4.13, stable-4.12, stable-4.13)
77+
78+
Update to 4.12.51 Recommended=False:
79+
Image: quay.io/openshift-release-dev/ocp-release@sha256:158ced797e49f6caf7862acccef58484be63b642fdd2f66e6416295fa7958ab0
80+
Release URL: https://access.redhat.com/errata/RHSA-2024:1052
81+
Reason: MultipleReasons
82+
Message: An unintended reversion to the default kubelet nodeStatusReportFrequency can cause significant load on the control plane. https://issues.redhat.com/browse/MCO-1094
83+
84+
After rebooting into kernel-4.18.0-372.88.1.el8_6 or later, kernel nodes experience high load average and io_wait times. The nodes might fail to start or stop pods and probes may fail. Workload and host processes may become unresponsive and workload may be disrupted. https://issues.redhat.com/browse/COS-2705
85+
----

‎modules/update-upgrading-oc-adm-upgrade-status.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@
66
[id="update-upgrading-oc-adm-upgrade-status_{context}"]
77
= Gathering cluster update status using oc adm upgrade status (Technology Preview)
88

9-
When updating your cluster, it is useful to understand how your update is progressing. While the `oc adm upgrade` command returns limited information about the status of your update, this release introduces the `oc adm upgrade status` command as a Technology Preview feature. This command decouples status information from the `oc adm upgrade` command and provides specific information regarding a cluster update, including the status of the control plane and worker node updates.
9+
When updating your cluster, the `oc adm upgrade` command returns returns limited information about the status of your update. You can use the `oc adm upgrade status` command to decouple status information from the `oc adm upgrade` command and return specific information regarding a cluster update, including the status of the control plane and worker node updates.
1010

11-
The `oc adm upgrade status` command is read-only and will never alter any state in your cluster.
11+
The `oc adm upgrade status` command is read-only and does not alter any state in your cluster.
1212

1313
:FeatureName: The `oc adm upgrade status` command
1414
include::snippets/technology-preview.adoc[]
1515

1616
The `oc adm upgrade status` command can be used for clusters from version 4.12 up to the latest supported release.
1717

18-
[IMPORTANT]
18+
[NOTE]
1919
====
20-
While your cluster does not need to be a Technology Preview-enabled cluster, you must enable the `OC_ENABLE_CMD_UPGRADE_STATUS` Technology Preview environment variable, otherwise the {oc-first} will not recognize the command and you will not be able to use the feature.
20+
Your cluster does not need to be a Technology Preview-enabled cluster in order for you to use the `oc adm upgrade status` command.
2121
====
2222

2323
.Procedure
2424

25-
. Set the `OC_ENABLE_CMD_UPGRADE_STATUS` environmental variable to `true` by running the following command:
25+
. Set the `OC_ENABLE_CMD_UPGRADE_STATUS` environment variable to `true` by running the following command:
2626
+
2727
[source,terminal]
2828
----
@@ -36,8 +36,7 @@ $ oc adm upgrade status
3636
----
3737
+
3838
.Example output for an update progressing successfully
39-
[%collapsible]
40-
====
39+
4140
[source,terminal]
4241
----
4342
= Control Plane =
@@ -80,6 +79,4 @@ ip-10-0-4-159-infra.us-east-2.compute.internal Progressing Draining 4.14.0
8079
= Update Health =
8180
SINCE LEVEL IMPACT MESSAGE
8281
14m4s Info None Update is proceeding well
83-
----
84-
====
85-
With this information, you can make informed decisions on how to proceed with your update.
82+
----

‎updating/updating_a_cluster/updating-cluster-cli.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,10 @@ include::modules/updating-sno.adoc[leveloffset=+1]
5757
// Updating a cluster by using the CLI
5858
include::modules/update-upgrading-cli.adoc[leveloffset=+1]
5959

60-
//Introducing oc adm upgrade status - Tech Preview
60+
//Finding recommended update paths with oc adm upgrade recommend (Technology Preview)
61+
include::modules/update-upgrading-oc-adm-upgrade-recommend.adoc[leveloffset=+1]
62+
63+
//Gathering cluster update status using oc adm upgrade status (Technology Preview)
6164
include::modules/update-upgrading-oc-adm-upgrade-status.adoc[leveloffset=+1]
6265

6366
[role="_additional-resources"]

0 commit comments

Comments
 (0)