|
| 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-status_{context}"] |
| 7 | += Retrieving information about a cluster update using oc adm upgrade status (Technology Preview) |
| 8 | + |
| 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. |
| 10 | + |
| 11 | +The `oc adm upgrade status` command is read-only and will never alter any state in your cluster. |
| 12 | + |
| 13 | +:FeatureName: The `oc adm upgrade status` command |
| 14 | +include::snippets/technology-preview.adoc[] |
| 15 | + |
| 16 | +The `oc adm upgrade status` command can be used for clusters from version 4.12 up to the latest supported release. |
| 17 | + |
| 18 | +[IMPORTANT] |
| 19 | +==== |
| 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. |
| 21 | +==== |
| 22 | + |
| 23 | +.Procedure |
| 24 | + |
| 25 | +. Set the `OC_ENABLE_CMD_UPGRADE_STATUS` environmental variable to `true` by running the following command: |
| 26 | ++ |
| 27 | +[source,terminal] |
| 28 | +---- |
| 29 | +$ export OC_ENABLE_CMD_UPGRADE_STATUS=true |
| 30 | +---- |
| 31 | +. Run the `oc adm upgrade status` command: |
| 32 | ++ |
| 33 | +[source,terminal] |
| 34 | +---- |
| 35 | +$ oc adm upgrade status |
| 36 | +---- |
| 37 | ++ |
| 38 | +.Example output for an update progressing successfully |
| 39 | +[%collapsible] |
| 40 | +==== |
| 41 | +[source,terminal] |
| 42 | +---- |
| 43 | += Control Plane = |
| 44 | +Assessment: Progressing |
| 45 | +Target Version: 4.14.1 (from 4.14.0) |
| 46 | +Completion: 97% |
| 47 | +Duration: 54m |
| 48 | +Operator Status: 32 Healthy, 1 Unavailable |
| 49 | +
|
| 50 | +Control Plane Nodes |
| 51 | +NAME ASSESSMENT PHASE VERSION EST MESSAGE |
| 52 | +ip-10-0-53-40.us-east-2.compute.internal Progressing Draining 4.14.0 +10m |
| 53 | +ip-10-0-30-217.us-east-2.compute.internal Outdated Pending 4.14.0 ? |
| 54 | +ip-10-0-92-180.us-east-2.compute.internal Outdated Pending 4.14.0 ? |
| 55 | +
|
| 56 | += Worker Upgrade = |
| 57 | +
|
| 58 | += Worker Pool = |
| 59 | +Worker Pool: worker |
| 60 | +Assessment: Progressing |
| 61 | +Completion: 0% |
| 62 | +Worker Status: 3 Total, 2 Available, 1 Progressing, 3 Outdated, 1 Draining, 0 Excluded, 0 Degraded |
| 63 | +
|
| 64 | +Worker Pool Nodes |
| 65 | +NAME ASSESSMENT PHASE VERSION EST MESSAGE |
| 66 | +ip-10-0-4-159.us-east-2.compute.internal Progressing Draining 4.14.0 +10m |
| 67 | +ip-10-0-20-162.us-east-2.compute.internal Outdated Pending 4.14.0 ? |
| 68 | +ip-10-0-99-40.us-east-2.compute.internal Outdated Pending 4.14.0 ? |
| 69 | +
|
| 70 | += Worker Pool = |
| 71 | +Worker Pool: infra |
| 72 | +Assessment: Progressing |
| 73 | +Completion: 0% |
| 74 | +Worker Status: 1 Total, 0 Available, 1 Progressing, 1 Outdated, 1 Draining, 0 Excluded, 0 Degraded |
| 75 | +
|
| 76 | +Worker Pool Node |
| 77 | +NAME ASSESSMENT PHASE VERSION EST MESSAGE |
| 78 | +ip-10-0-4-159-infra.us-east-2.compute.internal Progressing Draining 4.14.0 +10m |
| 79 | +
|
| 80 | += Update Health = |
| 81 | +SINCE LEVEL IMPACT MESSAGE |
| 82 | +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. |
0 commit comments