3.4. Updating a cluster by using the CLI
If updates are available, you can update your cluster by using the OpenShift CLI (oc).
You can find information about available OpenShift Container Platform advisories and updates in the errata section of the Customer Portal.
Prerequisites
-
Install the OpenShift CLI (
oc) that matches the version for your updated version. -
Log in to the cluster as user with
cluster-adminprivileges. -
Install the
jqpackage.
Procedure
Ensure that your cluster is available:
$ oc get clusterversionExample output
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS version 4.5.4 True False 158m Cluster version is 4.5.4Review the current update channel information and confirm that your channel is set to
stable-4.5:$ oc get clusterversion -o json|jq ".items[0].spec"Example output
{ "channel": "stable-4.5", "clusterID": "990f7ab8-109b-4c95-8480-2bd1deec55ff", "upstream": "https://api.openshift.com/api/upgrades_info/v1/graph" }重要For production clusters, you must subscribe to a
stable-*orfast-*channel.View the available updates and note the version number of the update that you want to apply:
$ oc adm upgradeExample output
Cluster version is 4.1.0 Updates: VERSION IMAGE 4.1.2 quay.io/openshift-release-dev/ocp-release@sha256:9c5f0df8b192a0d7b46cd5f6a4da2289c155fd5302dec7954f8f06c878160b8bApply an update:
Review the status of the Cluster Version Operator:
$ oc get clusterversion -o json|jq ".items[0].spec"Example output
{ "channel": "stable-4.5", "clusterID": "990f7ab8-109b-4c95-8480-2bd1deec55ff", "desiredUpdate": { "force": false, "image": "quay.io/openshift-release-dev/ocp-release@sha256:9c5f0df8b192a0d7b46cd5f6a4da2289c155fd5302dec7954f8f06c878160b8b", "version": "4.5.4"1 }, "upstream": "https://api.openshift.com/api/upgrades_info/v1/graph" }- 1
- If the
versionnumber in thedesiredUpdatestanza matches the value that you specified, the update is in progress.
Review the cluster version status history to monitor the status of the update. It might take some time for all the objects to finish updating.
$ oc get clusterversion -o json|jq ".items[0].status.history"Example output
[ { "completionTime": null, "image": "quay.io/openshift-release-dev/ocp-release@sha256:9c5f0df8b192a0d7b46cd5f6a4da2289c155fd5302dec7954f8f06c878160b8b", "startedTime": "2019-06-19T20:30:50Z", "state": "Partial", "verified": true, "version": "4.1.2" }, { "completionTime": "2019-06-19T20:30:50Z", "image": "quay.io/openshift-release-dev/ocp-release@sha256:b8307ac0f3ec4ac86c3f3b52846425205022da52c16f56ec31cbe428501001d6", "startedTime": "2019-06-19T17:38:10Z", "state": "Completed", "verified": false, "version": "4.1.0" } ]The history contains a list of the most recent versions applied to the cluster. This value is updated when the CVO applies an update. The list is ordered by date, where the newest update is first in the list. Updates in the history have state
Completedif the rollout completed andPartialif the update failed or did not complete.重要If an upgrade fails, the Operator stops and reports the status of the failing component. Rolling your cluster back to a previous version is not supported. If your upgrade fails, contact Red Hat support.
After the update completes, you can confirm that the cluster version has updated to the new version:
$ oc get clusterversionExample output
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS version 4.5.4 True False 2m Cluster version is 4.5.4If you are upgrading your cluster to the next minor version, like version 4.y to 4.(y+1), it is recommended to confirm your nodes are upgraded before deploying workloads that rely on a new feature:
$ oc get nodesExample output
NAME STATUS ROLES AGE VERSION ip-10-0-168-251.ec2.internal Ready master 82m v1.18.0 ip-10-0-170-223.ec2.internal Ready master 82m v1.18.0 ip-10-0-179-95.ec2.internal Ready worker 70m v1.18.0 ip-10-0-182-134.ec2.internal Ready worker 70m v1.18.0 ip-10-0-211-16.ec2.internal Ready master 82m v1.18.0 ip-10-0-250-100.ec2.internal Ready worker 69m v1.18.0