Updating a cluster using the CLI

You can update, or upgrade, an OKD cluster within a minor version by using the OpenShift CLI (oc). You can also update a cluster between minor versions by following the same instructions.

Prerequisites

  • Have access to the cluster as a user with admin privileges. See Using RBAC to define and apply permissions.

  • Have a recent etcd backup in case your update fails and you must restore your cluster to a previous state.

  • Have a recent Container Storage Interface (CSI) volume snapshot in case you need to restore persistent volumes due to a pod failure.

  • Support for Fedora7 workers is removed in OKD 4. You must replace Fedora7 workers with Fedora8 or FCOS workers before updating to OKD 4. Red Hat does not support in-place Fedora7 to Fedora8 updates for Fedora workers; those hosts must be replaced with a clean operating system install.

  • Ensure all Operators previously installed through Operator Lifecycle Manager (OLM) are updated to their latest version in their latest channel. Updating the Operators ensures they have a valid update path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster update. See Updating installed Operators for more information.

  • Ensure that all machine config pools (MCPs) are running and not paused. Nodes associated with a paused MCP are skipped during the update process. You can pause the MCPs if you are performing a canary rollout update strategy.

  • If your cluster uses manually maintained credentials, update the cloud provider resources for the new release. For more information, including how to determine if this is a requirement for your cluster, see Preparing to update a cluster with manually maintained credentials.

  • Ensure that you address all Upgradeable=False conditions so the cluster allows an update to the next minor version. An alert displays at the top of the Cluster Settings page when you have one or more cluster Operators that cannot be updated. You can still update to the next available patch update for the minor release you are currently on.

  • If you run an Operator or you have configured any application with the pod disruption budget, you might experience an interruption during the update process. If minAvailable is set to 1 in PodDisruptionBudget, the nodes are drained to apply pending machine configs which might block the eviction process. If several nodes are rebooted, all the pods might run on only one node, and the PodDisruptionBudget field can prevent the node drain.

  • When an update is failing to complete, the Cluster Version Operator (CVO) reports the status of any blocking components while attempting to reconcile the update. Rolling your cluster back to a previous version is not supported. If your update is failing to complete, contact Red Hat support.

  • Using the unsupportedConfigOverrides section to modify the configuration of an Operator is unsupported and might block cluster updates. You must remove this setting before you can update your cluster.

Additional resources

Pausing a MachineHealthCheck resource

During the update process, nodes in the cluster might become temporarily unavailable. In the case of worker nodes, the machine health check might identify such nodes as unhealthy and reboot them. To avoid rebooting such nodes, pause all the MachineHealthCheck resources before updating the cluster.

Prerequisites

  • Install the OpenShift CLI (oc).

Procedure

  1. To list all the available MachineHealthCheck resources that you want to pause, run the following command:

    1. $ oc get machinehealthcheck -n openshift-machine-api

  2. To pause the machine health checks, add the cluster.x-k8s.io/paused="" annotation to the MachineHealthCheck resource. Run the following command:

    1. $ oc -n openshift-machine-api annotate mhc <mhc-name> cluster.x-k8s.io/paused=""

    The annotated MachineHealthCheck resource resembles the following YAML file:

    1. apiVersion: machine.openshift.io/v1beta1
    2. kind: MachineHealthCheck
    3. metadata:
    4.   name: example
    5.   namespace: openshift-machine-api
    6.   annotations:
    7.     cluster.x-k8s.io/paused: ""
    8. spec:
    9.   selector:
    10.     matchLabels:
    11.       role: worker
    12.   unhealthyConditions:
    13.   - type:    "Ready"
    14.     status:  "Unknown"
    15.     timeout: "300s"
    16.   - type:    "Ready"
    17.     status:  "False"
    18.     timeout: "300s"
    19.   maxUnhealthy: "40%"
    20. status:
    21.   currentHealthy: 5
    22.   expectedMachines: 5

    Resume the machine health checks after updating the cluster. To resume the check, remove the pause annotation from the MachineHealthCheck resource by running the following command:

    1. $ oc -n openshift-machine-api annotate mhc <mhc-name> cluster.x-k8s.io/paused-

About updating single node OKD

You can update, or upgrade, a single-node OKD cluster by using either the console or CLI.

However, note the following limitations:

  • The prerequisite to pause the MachineHealthCheck resources is not required because there is no other node to perform the health check.

  • Restoring a single-node OKD cluster using an etcd backup is not officially supported. However, it is good practice to perform the etcd backup in case your update fails. If your control plane is healthy, you might be able to restore your cluster to a previous state by using the backup.

  • Updating a single-node OKD cluster requires downtime and can include an automatic reboot. The amount of downtime depends on the update payload, as described in the following scenarios:

    • If the update payload contains an operating system update, which requires a reboot, the downtime is significant and impacts cluster management and user workloads.

    • If the update contains machine configuration changes that do not require a reboot, the downtime is less, and the impact on the cluster management and user workloads is lessened. In this case, the node draining step is skipped with single-node OKD because there is no other node in the cluster to reschedule the workloads to.

    • If the update payload does not contain an operating system update or machine configuration changes, a short API outage occurs and resolves quickly.

There are conditions, such as bugs in an updated package, that can cause the single node to not restart after a reboot. In this case, the update does not rollback automatically.

Additional resources

Updating a cluster by using the CLI

You can use the OpenShift CLI (oc) to review and request cluster updates.

You can find information about available OKD 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-admin privileges.

  • Pause all MachineHealthCheck resources.

Procedure

  1. View the available updates and note the version number of the update that you want to apply:

    1. $ oc adm upgrade

    Example output

    1. Cluster version is 4.13.0-0.okd-2023-10-28-065448
    3. Upstream: https://amd64.origin.releases.ci.openshift.org/graph
    4. Channel: stable-4
    6. Recommended updates:
    8.   VERSION                        IMAGE
    9.   4.14.0-0.okd-2024-01-06-084517 registry.ci.openshift.org/origin/release@sha256:c4a6b6850701202f629c0e451de784b02f0de079650a1b9ccbf610448ebc9227
    10.   4.14.0-0.okd-2023-11-14-101924 registry.ci.openshift.org/origin/release@sha256:72d40c51e7c4d1b9c31e9b0d276d045f1b2b93def5ecee49186df856d40bcb5c
    11.   4.14.0-0.okd-2023-11-12-042703 registry.ci.openshift.org/origin/release@sha256:2242d1df4e4cbcc0cd27191ab9ad5f55ac4f0c60c3cda2a186181a2435e3bd00
    12.   4.14.0-0.okd-2023-10-28-073550 registry.ci.openshift.org/origin/release@sha256:7a6200e347a1b857e47f2ab0735eb1303af7d796a847d79ef9706f217cd12f5c

    • If there are no available updates, updates that are supported but not recommended might still be available. See Updating along a conditional update path for more information.

  2. Apply an update:

    • To update to the latest version:

      1. $ oc adm upgrade --to-latest=true (1)

    • To update to a specific version:

      1. $ oc adm upgrade --to=<version> (1)
      1<version> is the update version that you obtained from the output of the oc adm upgrade 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.

  3. Review the status of the Cluster Version Operator:

    1. $ oc adm upgrade

    Example output

    1. info: An upgrade is in progress. Working towards 4.14.0-0.okd-2024-01-06-084517: 117 of 864 done (13% complete), waiting on etcd, kube-apiserver
    3. Upstream: https://amd64.origin.releases.ci.openshift.org/graph
    4. Channel: stable-4
    5. No updates available. You may still upgrade to a specific release image with --to-image or wait for new updates to be available.

  4. After the update completes, you can confirm that the cluster version has updated to the new version:

    1. $ oc adm upgrade

    Example output

    1. Cluster version is 4.14.0-0.okd-2024-01-06-084517
    3. Upstream: https://amd64.origin.releases.ci.openshift.org/graph
    4. Channel: stable-4
    5. No updates available. You may still upgrade to a specific release image with --to-image or wait for new updates to be available.

  5. If you are updating your cluster to the next minor version, such as version X.y to X.(y+1), it is recommended to confirm that your nodes are updated before deploying workloads that rely on a new feature:

    1. $ oc get nodes

    Example output

    1. NAME                           STATUS   ROLES    AGE   VERSION
    2. ip-10-0-168-251.ec2.internal   Ready    master   82m   v1.28.5
    3. ip-10-0-170-223.ec2.internal   Ready    master   82m   v1.28.5
    4. ip-10-0-179-95.ec2.internal    Ready    worker   70m   v1.28.5
    5. ip-10-0-182-134.ec2.internal   Ready    worker   70m   v1.28.5
    6. ip-10-0-211-16.ec2.internal    Ready    master   82m   v1.28.5
    7. ip-10-0-250-100.ec2.internal   Ready    worker   69m   v1.28.5

Additional resources

Updating along a conditional update path

You can update along a recommended conditional update path using the web console or the OpenShift CLI (oc). When a conditional update is not recommended for your cluster, you can update along a conditional update path using the OpenShift CLI (oc) 4.10 or later.

Procedure

  1. To view the description of the update when it is not recommended because a risk might apply, run the following command:

    1. $ oc adm upgrade --include-not-recommended

  2. 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 the update by running the following command:

    1. $ oc adm upgrade --allow-not-recommended --to <version> (1)
    1<version> is the supported but not recommended update version that you obtained from the output of the previous command.

Changing the update server by using the CLI

Changing the update server is optional. If you have an OpenShift Update Service (OSUS) installed and configured locally, you must set the URL for the server as the upstream to use the local server during updates. The default value for upstream is https://api.openshift.com/api/upgrades_info/v1/graph.

Procedure

  • Change the upstream parameter value in the cluster version:

    1. $ oc patch clusterversion/version --patch '{"spec":{"upstream":"<update-server-url>"}}' --type=merge

    The <update-server-url> variable specifies the URL for the update server.

    Example output

    1. clusterversion.config.openshift.io/version patched