You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
= Cluster update status using oc adm upgrade status
8
+
9
+
When updating your cluster, the `oc adm upgrade` command returns limited information about the status of your update. The cluster administrator 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. Worker is also known as compute.
10
+
11
+
The `oc adm upgrade status` command is read-only and does not alter any state in your cluster.
12
+
13
+
The `oc adm upgrade status` command can be used for clusters from version 4.12 up to the latest supported release.
14
+
15
+
The `oc adm upgrade status` command will output three sections, control plane update, worker nodes update, and health insights.
16
+
17
+
* *Control Plane Update*: Displays details about the updating cluster control plane, contains a high-level assessment, completion status, duration estimate, or cluster operator health. The section also shows a table with control plane node update information.
18
+
+
19
+
The control plane update section can also show an additional table that lists cluster operators being updated if the `--details=operators` or `--details-all` flags are used. Please note that due the asynchronous distributed nature of {product-title}, an operator may appear in this section more than once during the update, or not at all. The section is only shown when a Cluster Operator is observed to be updating. It is normal during an update to observe no updating Cluster Operator at certain periods; not every performed action can be assigned to an observable updating Cluster Operator.
20
+
+
21
+
* *Worker Notes Update*: Displays the worker node update information. The worker nodes section starts with a table that displays a summary of information about each worker pool configured in the cluster. Each non-empty worker pool output will show a dedicated table listing update information about nodes that belong to that pool. If a cluster does not have any worker nodes the output will not contain the worker node section. You can make the node tables show all lines by using `--details=nodes` or `--details=all`.
22
+
+
23
+
* *Health Insights*: displays insights about states and events present in the cluster that may be relevant for the ongoing update. You can use `--details=health` to expand the items in this section into a more verbose form with more content such as documentation links, longer form descriptions, or cluster resources involved in the insight.
24
+
25
+
[NOTE]
26
+
====
27
+
The `oc adm upgrade status` command is currently not supported on {hcp} clusters.
28
+
====
29
+
30
+
The following is an example of the output you will see for an update progressing successfully:
Copy file name to clipboardExpand all lines: modules/update-upgrading-cli.adoc
+42-27Lines changed: 42 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,8 @@ of the Customer Portal.
17
17
18
18
* Install the OpenShift CLI (`oc`) that matches the version for your updated version.
19
19
* Log in to the cluster as user with `cluster-admin` privileges.
20
-
21
20
* Pause all `MachineHealthCheck` resources.
21
+
// Example output Failing=true taken from https://github.com/openshift/oc/blob/main/pkg/cli/admin/upgrade/recommend/examples/4.16.27-degraded-monitoring.output
22
22
23
23
.Procedure
24
24
@@ -27,47 +27,50 @@ you want to apply:
27
27
+
28
28
[source,terminal]
29
29
----
30
-
$ oc adm upgrade
30
+
$ oc adm upgrade recommend
31
31
----
32
32
+
33
33
ifndef::openshift-origin[]
34
34
.Example output
35
35
[source,terminal]
36
36
----
37
-
Cluster version is 4.13.10
38
-
Upstream is unset, so the cluster will use an appropriate default.
4.19.0-okd-scos.17 no known issues relevant to this cluster
64
68
----
65
69
endif::openshift-origin[]
66
70
+
67
71
[NOTE]
68
72
====
69
-
* If there are no recommended updates, updates that have known issues might still be available.
70
-
See _Updating along a conditional update path_ for more information.
73
+
* You can use the `--version` flag to determine whether a specific version is recommended for your update. If there are no recommended updates, updates that have known issues might still be available.
71
74
ifndef::openshift-origin[]
72
75
* For details and information on how to perform a `Control Plane Only` update, please refer to the _Preparing to perform a Control Plane Only update_ page, listed in the Additional resources section.
<1> `<version>` is the update version that you obtained from the output of the
123
-
`oc adm upgrade` command.
126
+
`oc adm upgrade recommend` command.
127
+
+
128
+
.. 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 with the update by running the following command:
When using `oc adm upgrade --help`, there is a listed option for `--force`. This is *heavily discouraged*, as using the `--force` option bypasses cluster-side guards, including release verification and precondition checks. Using `--force` does not guarantee a successful update. Bypassing guards put the cluster at risk.
128
138
====
129
139
130
-
. Review the status of the Cluster Version Operator:
140
+
. Optional: Review the status of the Cluster Version Operator by running the following command:
131
141
+
132
142
[source,terminal]
133
143
----
134
-
$ oc adm upgrade
144
+
$ oc adm upgrade status
135
145
----
146
+
+
147
+
[NOTE]
148
+
====
149
+
To monitor the update in real time, run `oc adm upgrade status` in a `watch` utility.
0 commit comments