SupportConsoleDevelopersStart a trialContact

Chapter 3. Updating a cluster within a minor version by using the CLI

You can update, or upgrade, an OpenShift Container Platform cluster within a minor version by using the OpenShift CLI (oc).

3.1. Prerequisites

Important

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

3.2. About the OpenShift Container Platform update service

The OpenShift Container Platform update service is the hosted service that provides over-the-air updates to both OpenShift Container Platform and Red Hat Enterprise Linux CoreOS (RHCOS). It provides a graph, or diagram that contain vertices and the edges that connect them, of component Operators. The edges in the graph show which versions you can safely update to, and the vertices are update payloads that specify the intended state of the managed cluster components.

The Cluster Version Operator (CVO) in your cluster checks with the OpenShift Container Platform update service to see the valid updates and update paths based on current component versions and information in the graph. When you request an update, the OpenShift Container Platform CVO uses the release image for that update to upgrade your cluster. The release artifacts are hosted in Quay as container images.

To allow the OpenShift Container Platform update service to provide only compatible updates, a release verification pipeline exists to drive automation. Each release artifact is verified for compatibility with supported cloud platforms and system architectures as well as other component packages. After the pipeline confirms the suitability of a release, the OpenShift Container Platform update service notifies you that it is available.

Important

Because the update service displays all valid updates, you must not force an update to a version that the update service does not display.

During continuous update mode, two controllers run. One continuously updates the payload manifests, applies them to the cluster, and outputs the status of the controlled rollout of the Operators, whether they are available, upgrading, or failed. The second controller polls the OpenShift Container Platform update service to determine if updates are available.

Important

Reverting your cluster to a previous version, or a rollback, is not supported. Only upgrading to a newer version is supported. If your upgrade fails, contact Red Hat support.

During the upgrade process, the Machine Config Operator (MCO) applies the new configuration to your cluster machines. It cordons the number of nodes that is specified by the maxUnavailable field on the machine configuration pool and marks them as unavailable. By default, this value is set to 1. It then applies the new configuration and reboots the machine. If you use Red Hat Enterprise Linux (RHEL) machines as workers, the MCO does not update the kubelet on these machines because you must update the OpenShift API on them first. Because the specification for the new version is applied to the old kubelet, the RHEL machine cannot return to the Ready state. You cannot complete the update until the machines are available. However, the maximum number of nodes that are unavailable is set to ensure that normal cluster operations are likely to continue with that number of machines out of service.

Additional resources

3.3. OpenShift Container Platform upgrade channels and releases

In OpenShift Container Platform 4.1, Red Hat introduced the concept of channels for recommending the appropriate release versions for cluster upgrades. By controlling the pace of upgrades, these upgrade channels allow you to choose an upgrade strategy. Upgrade channels are tied to a minor version of OpenShift Container Platform. For instance, OpenShift Container Platform 4.5 upgrade channels recommend upgrades to 4.5 and upgrades within 4.5. They also recommend upgrades within 4.4 and from 4.4 to 4.5, to allow clusters on 4.4 to eventually upgrade to 4.5. They do not recommend upgrades to 4.6 or later releases. This strategy ensures that administrators explicitly decide to upgrade to the next minor version of OpenShift Container Platform.

Upgrade channels control only release selection and do not impact the version of the cluster that you install; the openshift-install binary file for a specific version of OpenShift Container Platform always installs that version.

OpenShift Container Platform 4.5 offers the following upgrade channels:

  • candidate-4.5
  • fast-4.5
  • stable-4.5
  • eus-4.6 (only available when running 4.6)

candidate-4.5 channel

The candidate-4.5 channel contains candidate builds for a z-stream (4.5.z) and previous minor version releases. Release candidates contain all the features of the product but are not supported. Use release candidate versions to test feature acceptance and assist in qualifying the next version of OpenShift Container Platform. A release candidate is any build that is available in the candidate channel, including ones that do not contain a pre-release version such as -rc in their names. After a version is available in the candidate channel, it goes through more quality checks. If it meets the quality standard, it is promoted to the fast-4.5 or stable-4.5 channels. Because of this strategy, if a specific release is available in both the candidate-4.5 channel and in the fast-4.5 or stable-4.5 channels, it is a Red Hat-supported version. The candidate-4.5 channel can include release versions from which there are no recommended updates in any channel.

You can use the candidate-4.5 channel to upgrade from a previous minor version of OpenShift Container Platform.

Note

Release candidates differ from the nightly builds. Nightly builds are available for early access to features, but updating to or from nightly builds is neither recommended nor supported. Nightly builds are not available in any upgrade channel. You can reference the OpenShift Container Platform release statuses for more build information.

fast-4.5 channel

The fast-4.5 channel is updated with new and previous minor versions of 4.5 as soon as Red Hat declares the given version as a general availability release. As such, these releases are fully supported, are production quality, and have performed well while available as a release candidate in the candidate-4.5 channel from where they were promoted. Some time after a release appears in the fast-4.5 channel, it is added to the stable-4.5 channel. Releases never appear in the stable-4.5 channel before they appear in the fast-4.5 channel.

You can use the fast-4.5 channel to upgrade from a previous minor version of OpenShift Container Platform.

stable-4.5 channel

While the fast-4.5 channel contains releases as soon as their errata are published, releases are added to the stable-4.5 channel after a delay. During this delay, data is collected from Red Hat SRE teams, Red Hat support services, and pre-production and production environments that participate in connected customer program about the stability of the release.

You can use the stable-4.5 channel to upgrade from a previous minor version of OpenShift Container Platform.

eus-4.6 channel

In addition to the stable channel, certain minor versions of OpenShift Container Platform offer an Extended Update Support (EUS). These EUS versions extend the maintenance phase for customers with Premium Subscriptions to 14 months. OpenShift Container Platform 4.6 is currently the only minor version with EUS.

Although there is no difference between stable-4.6 and eus-4.6 channels until OpenShift Container Platform 4.6 transitions to the EUS phase, you can switch to the EUS channel as soon as it becomes available. When OpenShift Container Platform 4.6 transitions to the EUS phase of its lifecycle, the stable-4.6 channel will no longer receive subsequent z-stream updates. After you upgrade to a version that is exclusive to the EUS channel, that cluster will no longer be eligible for minor version upgrades until upgrades to the next EUS version become available. The next planned EUS version is to be 4.10 and the upgrade to that version will require a serial set of version upgrades, such as from 4.6 to 4.7 to 4.8 to 4.9 to 4.10.

Additionally, you may only switch to the EUS channel when your cluster is running a supported version of OpenShift Container Platform 4.6.

Finally, if you install a 4.6 version that is exclusive to EUS, you will similarly not be able to upgrade to a later minor version until upgrades are provided to 4.10.

Upgrade version paths

OpenShift Container Platform maintains an upgrade recommendation service that understands the version of OpenShift Container Platform you have installed as well as the path to take within the channel you choose to get you to the next release.

You can imagine seeing the following in the fast-4.5 channel:

  • 4.5.0
  • 4.5.1
  • 4.5.3
  • 4.5.4

The service recommends only upgrades that have been tested and have no serious issues. It will not suggest updating to a version of OpenShift Container Platform that contains known vulnerabilities. For example, if your cluster is on 4.5.1 and OpenShift Container Platform suggests 4.5.4, then it is safe for you to update from 4.5.1 to 4.5.4. Do not rely on consecutive patch numbers. In this example, 4.5.2 is not and never was available in the channel.

Update stability depends on your channel. The presence of an update recommendation in the candidate-4.5 channel does not imply that the update is supported. It means that no serious issues have been found with the update yet, but there might not be significant traffic through the update to suggest stability. The presence of an update recommendation in the fast-4.5 or stable-4.5 channels at any point is a declaration that the update is supported. While releases will never be removed from a channel, update recommendations that exhibit serious issues will be removed from all channels. Updates initiated after the update recommendation has been removed are still supported.

Red Hat will eventually provide supported update paths from any supported release in the fast-4.5 or stable-4.5 channels to the latest release in 4.5.z, although there can be delays while safe paths away from troubled releases are constructed and verified.

Fast and stable channel use and strategies

The fast-4.5 and stable-4.5 channels present a choice between receiving general availability releases as soon as they are available or allowing Red Hat to control the rollout of those updates. If issues are detected during rollout or at a later time, upgrades to that version might be blocked in both the fast-4.5 and stable-4.5 channels, and a new version might be introduced that becomes the new preferred upgrade target.

Customers can improve this process by configuring pre-production systems on the fast-4.5 channel, configuring production systems on the stable-4.5 channel, and participating in the Red Hat connected customer program. Red Hat uses this program to observe the impact of updates on your specific hardware and software configurations. Future releases might improve or alter the pace at which updates move from the fast-4.5 to the stable-4.5 channel.

Restricted network clusters

If you manage the container images for your OpenShift Container Platform clusters yourself, you must consult the Red Hat errata that is associated with product releases and note any comments that impact upgrades. During upgrade, the user interface might warn you about switching between these versions, so you must ensure that you selected an appropriate version before you bypass those warnings.

Switching between channels

Your cluster is still supported if you change from the stable-4.5 channel to the fast-4.5 channel. Although you can switch to the candidate-4.5 channel at any time, some releases in that channel might be unsupported release candidates. You can switch from the candidate-4.5 channel to the fast-4.5 channel if your current release is a general availability release. You can always switch from the fast-4.5 channel to the stable-4.5 channel, although if the current release was recently promoted to fast-4.5 there can be a delay of up to a day for the release to be promoted to stable-4.5. If you change to a channel that does not include your current release, an alert displays and no updates can be recommended, but you can safely change back to your original channel at any point.

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-admin privileges.
  • Install the jq package.

Procedure

  1. Ensure that your cluster is available: 

    $ oc get clusterversion

    Example output

    NAME      VERSION   AVAILABLE   PROGRESSING   SINCE   STATUS
version   4.5.4     True        False         158m    Cluster version is 4.5.4

  2. Review 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"
}

    Important

    For production clusters, you must subscribe to a stable-* or fast-* channel.

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

    $ oc adm upgrade

    Example output

    Cluster version is 4.1.0

Updates:

VERSION IMAGE
4.1.2   quay.io/openshift-release-dev/ocp-release@sha256:9c5f0df8b192a0d7b46cd5f6a4da2289c155fd5302dec7954f8f06c878160b8b

  4. Apply an update:

    • To update to the latest version: 

      $ oc adm upgrade --to-latest=true 1

    • To update to a specific version: 

      $ oc adm upgrade --to=<version> 1
      1 1
      <version> is the update version that you obtained from the output of the previous command.

  5. 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 version number in the desiredUpdate stanza matches the value that you specified, the update is in progress.

  6. 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 Completed if the rollout completed and Partial if the update failed or did not complete.

    Important

    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.

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

    $ oc get clusterversion

    Example output

    NAME      VERSION     AVAILABLE   PROGRESSING   SINCE     STATUS
version   4.5.4       True        False         2m        Cluster version is 4.5.4

  8. If 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 nodes

    Example 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

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.