Updating a cluster that includes RHEL compute machines | Updating clusters

About the OpenShift Container Platform update service
Updating a cluster by using the web console
(Optional) Adding hooks to perform Ansible tasks on RHEL machines
Updating RHEL compute machines in your cluster

You can update, or upgrade, an OpenShift Container Platform cluster. If your cluster contains Red Hat Enterprise Linux (RHEL) machines, you must perform more steps to update those machines.

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 upgrade fails and you must restore your cluster to a previous state.

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.

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.

Reverting your cluster to a previous version, or a rollback, is not supported. Only upgrading to a newer version is supported.

Updating a cluster by using the web console

If updates are available, you can update your cluster from the web console.

You can find information about available OpenShift Container Platform advisories and updates in the errata section of the Customer Portal.

Prerequisites

Have access to the web console as a user with admin privileges.

Procedure

From the web console, click Administration > Cluster Settings and review the contents of the Overview tab.
1. For production clusters, ensure that the CHANNEL is set to stable-4.1.
  
  For production clusters, you must subscribe to the stable-4.1 channel.
2. If the UPDATE STATUS is not Updates Available, you cannot upgrade your cluster.
3. The DESIRED VERSION indicates the cluster version that your cluster is running or is updating to.
Click Updates Available, select a version to update to, and click Update. The UPDATE STATUS changes to Updating, and you can review the progress of the Operator upgrades on the Cluster Operators tab.

(Optional) Adding hooks to perform Ansible tasks on RHEL machines

You can use hooks to run Ansible tasks on the RHEL compute machines during the OpenShift Container Platform update.

About Ansible hooks for upgrades

When you update OpenShift Container Platform, you can run custom tasks on your Red Hat Enterprise Linux (RHEL) nodes during specific operations by using hooks. Hooks allow you to provide files that define tasks to run before or after specific update tasks. You can use hooks to validate or modify custom infrastructure when you update the RHEL compute nodes in you OpenShift Container Platform cluster.

Because when a hook fails, the operation fails, you must design hooks that are idempotent, or can run multiple times and provide the same results.

Hooks have the following important limitations: - Hooks do not have a defined or versioned interface. They can use internal openshift-ansible variables, but it is possible that the variables will be modified or removed in future OpenShift Container Platform releases. - Hooks do not have error handling, so an error in a hook halts the update process. If you get an error, you must address the problem and then start the upgrade again.

Configuring the Ansible inventory file to use hooks

You define the hooks to use when you update the Red Hat Enterprise Linux (RHEL) compute machines, which are also known as worker machines, in the hosts inventory file under the all:vars section.

Prerequisites

You have access to the machine that you used to add the RHEL compute machines cluster. You must have access to the hosts Ansible inventory file that defines your RHEL machines.

Procedure

After you design the hook, create a YAML file that defines the Ansible tasks for it. This file must be a set of tasks and cannot be a playbook, as shown in the following example:

---
# Trivial example forcing an operator to acknowledge the start of an upgrade
# file=/home/user/openshift-ansible/hooks/pre_compute.yml

- name: note the start of a compute machine update
  debug:
      msg: "Compute machine upgrade of {{ inventory_hostname }} is about to start"

- name: require the user agree to start an upgrade
  pause:
      prompt: "Press Enter to start the compute machine update"

Modify the hosts Ansible inventory file to specify the hook files. The hook files are specified as parameter values in the [all:vars] section, as shown:
Example hook definitions in an inventory file
```
[all:vars]
openshift_node_pre_upgrade_hook=/home/user/openshift-ansible/hooks/pre_node.yml
openshift_node_post_upgrade_hook=/home/user/openshift-ansible/hooks/post_node.yml
```
To avoid ambiguity in the paths to the hook, use absolute paths instead of a relative paths in their definitions.

Available hooks for RHEL compute machines

You can use the following hooks when you update the Red Hat Enterprise Linux (RHEL) compute machines in your OpenShift Container Platform cluster.

Hook name Description

Hook name	Description
`openshift_node_pre_cordon_hook`	Runs before each node is cordoned. This hook runs against each node in serial. If a task must run against a different host, the task must use `delegate_to` or `local_action`.
`openshift_node_pre_upgrade_hook`	Runs after each node is cordoned but before it is updated. This hook runs against each node in serial. If a task must run against a different host, the task must use `delegate_to` or `local_action`.
`openshift_node_pre_uncordon_hook`	Runs after each node is updated but before it is uncordoned. This hook runs against each node in serial. If a task must run against a different host, they task must use `delegate_to` or `local_action`.
`openshift_node_post_upgrade_hook`	Runs after each node uncordoned. It is the last node update action. This hook runs against each node in serial. If a task must run against a different host, the task must use `delegate_to` or `local_action`.

openshift_node_pre_cordon_hook

Runs before each node is cordoned.
This hook runs against each node in serial.
If a task must run against a different host, the task must use delegate_to or local_action.

openshift_node_pre_upgrade_hook

Runs after each node is cordoned but before it is updated.
This hook runs against each node in serial.
If a task must run against a different host, the task must use delegate_to or local_action.

openshift_node_pre_uncordon_hook

Runs after each node is updated but before it is uncordoned.
This hook runs against each node in serial.
If a task must run against a different host, they task must use delegate_to or local_action.

openshift_node_post_upgrade_hook

Runs after each node uncordoned. It is the last node update action.
This hook runs against each node in serial.
If a task must run against a different host, the task must use delegate_to or local_action.

Updating RHEL compute machines in your cluster

After you update your cluster, you must update the Red Hat Enterprise Linux (RHEL) compute machines in your cluster.

Prerequisites

You updated your cluster.

Because the RHEL machines require assets that are generated by the cluster to complete the update process, you must update the cluster before you update the RHEL compute machines in it.
You have access to the machine that you used to add the RHEL compute machines cluster. You must have access to the hosts Ansible inventory file that defines your RHEL machines and the upgrade playbook.

Procedure

Stop and disable firewalld on the host:
```
# systemctl disable --now firewalld.service
```
You must not enable firewalld later. If you do, you cannot access OpenShift Container Platform logs on the worker.
Review your Ansible inventory file at /<path>/inventory/hosts and ensure that all of your compute, or worker, machines are listed in the [workers] section, as shown in the following example:
```
[all:vars]
ansible_user=root
#ansible_become=True

openshift_kubeconfig_path="~/.kube/config"
openshift_pull_secret_path="~/pull-secret.txt"

[workers]
mycluster-worker-0.example.com
mycluster-worker-1.example.com
mycluster-worker-2.example.com
mycluster-worker-3.example.com
```
If all of your RHEL compute machines are not listed in the [workers] section, you must move them to that section.
Change to the openshift-ansible directory and run the upgrade playbook:
```
$ cd /usr/share/ansible/openshift-ansible
$ ansible-playbook -i /<path>/inventory/hosts playbooks/upgrade.yml (1)
```
1 For <path>, specify the path to the Ansible inventory file that you created.