Updating OpenShift Data Foundation

Example workflow of EUS upgrade:

1. Pause the worker machine pools.
2. Update OpenShift <4.y> → OpenShift <4.y+1>.
3. Update OpenShift Data Foundation <4.y> → OpenShift Data Foundation <4.y+1>.
4. Update OpenShift <4.y+1> → OpenShift <4.y+2>.
5. Update to OpenShift Data Foundation <4.y+2>.
6. Unpause the worker machine pools.

1. Update OpenShift Container Platform according to the Updating clusters documentation for OpenShift Container Platform.

2. Update Red Hat OpenShift Data Foundation.

   1. To prepare a disconnected environment for updates, see Operators guide to using Operator Lifecycle Manager on restricted networks to be able to update OpenShift Data Foundation as well as Local Storage Operator when in use.
   2. For updating between minor releases, see Updating Red Hat OpenShift Data Foundation 4.14 to 4.15.
   3. For updating between z-stream releases, see Updating Red Hat OpenShift Data Foundation 4.15.x to 4.15.y.
   4. For updating external mode deployments, you must also perform the steps from section Updating the Red Hat OpenShift Data Foundation external secret.
   5. If you use local storage, then update the Local Storage operator. See Checking for Local Storage Operator deployments if you are unsure.

Procedure

1. On the OpenShift Web Console, navigate to Operators → Installed Operators.
2. Select openshift-storage project.
3. Click the OpenShift Data Foundation operator name.
4. Click the Subscription tab and click the link under Update Channel.
5. Select the stable-4.17 update channel and Save it.

6. If the Upgrade status shows requires approval, click on requires approval.

   1. On the Install Plan Details page, click Preview Install Plan.

   2. Review the install plan and click Approve.

      Wait for the Status to change from Unknown to Created.

7. Navigate to Operators → Installed Operators.

8. Select the openshift-storage project.

   Wait for the OpenShift Data Foundation Operator Status to change to Up to date.

9. After the operator is successfully upgraded, a pop-up with a message, Web console update is available appears on the user interface. Click Refresh web console from this pop-up for the console changes to reflect.

Procedure

1. On the OpenShift Web Console, navigate to Operators → Installed Operators.

2. Select openshift-storage project.

   Note

   If the Show default projects option is disabled, use the toggle button to list all the default projects.

3. Click the OpenShift Data Foundation operator name.
4. Click the Subscription tab.
5. If the Upgrade Status shows require approval, click on requires approval link.
6. On the InstallPlan Details page, click Preview Install Plan.
7. Review the install plan and click Approve.
8. Wait for the Status to change from Unknown to Created.
9. After the operator is successfully upgraded, a pop-up with a message, Web console update is available appears on the user interface. Click Refresh web console from this pop-up for the console changes to reflect.

Procedure

1. Navigate to Operators → Installed Operators.

2. Select openshift-storage from the Project drop-down list.

   Note

   If the Show default projects option is disabled, use the toggle button to list all the default projects.

3. Click on OpenShift Data Foundation operator name
4. Go to the Subscription tab.
5. Click on the pencil icon for changing the Update approval.
6. Select the update approval strategy and click Save.

Procedure

1. Download the ceph-external-cluster-details-exporter.py python script that matches your OpenShift Data Foundation version.

   # oc get csv $(oc get csv -n openshift-storage | grep rook-ceph-operator | awk '{print $1}') -n openshift-storage -o jsonpath='{.metadata.annotations.externalClusterScript}'| base64 --decode > ceph-external-cluster-details-exporter.py

2. Update permission caps on the external Red Hat Ceph Storage cluster by running ceph-external-cluster-details-exporter.py on any client node in the external Red Hat Ceph Storage cluster. You may need to ask your Red Hat Ceph Storage administrator to do this.

   # python3 ceph-external-cluster-details-exporter.py --upgrade

   The updated permissions for the user are set as:

   client.csi-cephfs-node
   key: AQCYz0piYgu/IRAAipji4C8+Lfymu9vOrox3zQ==
   caps: [mds] allow rw
   caps: [mgr] allow rw
   caps: [mon] allow r, allow command 'osd blocklist'
   caps: [osd] allow rw tag cephfs =
   client.csi-cephfs-provisioner
   key: AQCYz0piDUMSIxAARuGUyhLXFO9u4zQeRG65pQ==
   caps: [mgr] allow rw
   caps: [mon] allow r, allow command 'osd blocklist'
   caps: [osd] allow rw tag cephfs metadata=*
   client.csi-rbd-node
   key: AQCYz0pi88IKHhAAvzRN4fD90nkb082ldrTaHA==
   caps: [mon] profile rbd, allow command 'osd blocklist'
   caps: [osd] profile rbd
   client.csi-rbd-provisioner
   key: AQCYz0pi6W8IIBAAgRJfrAW7kZfucNdqJqS9dQ==
   caps: [mgr] allow rw
   caps: [mon] profile rbd, allow command 'osd blocklist'
   caps: [osd] profile rbd

3. Run the previously downloaded python script and save the JSON output that gets generated from the external Red Hat Ceph Storage cluster.

   1. Run the previously downloaded python script:

      Note
      • Make sure to use all the flags that you used in the original deployment including any optional argument that you have used.
      • Ensure that all the parameters, including the optional arguments, except for monitoring-endpoint and monitoring-endpoint-port, are the same as that you used during the original deployment of OpenShift Data Foundation in external mode.

      # python3 ceph-external-cluster-details-exporter.py --rbd-data-pool-name <rbd block pool name> --monitoring-endpoint <ceph mgr prometheus exporter endpoint> --monitoring-endpoint-port <ceph mgr prometheus exporter port> --rgw-endpoint <rgw endpoint> --run-as-user <ocs_client_name>  [optional arguments]

      --rbd-data-pool-name

      Is a mandatory parameter used for providing block storage in OpenShift Data Foundation.

      --rgw-endpoint

      Is optional. Provide this parameter if object storage is to be provisioned through Ceph RADOS Gateway for OpenShift Data Foundation. Provide the endpoint in the following format: <ip_address>:<port>.

      --monitoring-endpoint

      Is optional. It accepts comma separated list of IP addresses of active and standby mgrs reachable from the OpenShift Container Platform cluster. If not provided, the value is automatically populated.

      --monitoring-endpoint-port

      Is optional. It is the port associated with the ceph-mgr Prometheus exporter specified by --monitoring-endpoint. If not provided, the value is automatically populated.

      --run-as-user

      The client name used during OpenShift Data Foundation cluster deployment. Use the default client name client.healthchecker if a different client name was not set.

      Additional flags:

      rgw-pool-prefix	(Optional) The prefix of the RGW pools. If not specified, the default prefix is default.
      rgw-tls-cert-path	(Optional) The file path of the RADOS Gateway endpoint TLS certificate.
      rgw-skip-tls	(Optional) This parameter ignores the TLS certification validation when a self-signed certificate is provided (NOT RECOMMENDED).
      ceph-conf	(Optional) The name of the Ceph configuration file.
      cluster-name	(Optional) The Ceph cluster name.
      output	(Optional) The file where the output is required to be stored.
      cephfs-metadata-pool-name	(Optional) The name of the CephFS metadata pool.
      cephfs-data-pool-name	(Optional) The name of the CephFS data pool.
      cephfs-filesystem-name	(Optional) The name of the CephFS filesystem.
      rbd-metadata-ec-pool-name	(Optional) The name of the erasure coded RBD metadata pool.
      dry-run	(Optional) This parameter helps to print the executed commands without running them.

   2. Save the JSON output generated after running the script in the previous step.

      Example output:

      [{"name": "rook-ceph-mon-endpoints", "kind": "ConfigMap", "data": {"data": "xxx.xxx.xxx.xxx:xxxx", "maxMonId": "0", "mapping": "{}"}}, {"name": "rook-ceph-mon", "kind": "Secret", "data": {"admin-secret": "admin-secret", "fsid": "<fs-id>", "mon-secret": "mon-secret"}}, {"name": "rook-ceph-operator-creds", "kind": "Secret", "data": {"userID": "<user-id>", "userKey": "<user-key>"}}, {"name": "rook-csi-rbd-node", "kind": "Secret", "data": {"userID": "csi-rbd-node", "userKey": "<user-key>"}}, {"name": "ceph-rbd", "kind": "StorageClass", "data": {"pool": "<pool>"}}, {"name": "monitoring-endpoint", "kind": "CephCluster", "data": {"MonitoringEndpoint": "xxx.xxx.xxx.xxxx", "MonitoringPort": "xxxx"}}, {"name": "rook-ceph-dashboard-link", "kind": "Secret", "data": {"userID": "ceph-dashboard-link", "userKey": "<user-key>"}}, {"name": "rook-csi-rbd-provisioner", "kind": "Secret", "data": {"userID": "csi-rbd-provisioner", "userKey": "<user-key>"}}, {"name": "rook-csi-cephfs-provisioner", "kind": "Secret", "data": {"adminID": "csi-cephfs-provisioner", "adminKey": "<admin-key>"}}, {"name": "rook-csi-cephfs-node", "kind": "Secret", "data": {"adminID": "csi-cephfs-node", "adminKey": "<admin-key>"}}, {"name": "cephfs", "kind": "StorageClass", "data": {"fsName": "cephfs", "pool": "cephfs_data"}}, {"name": "ceph-rgw", "kind": "StorageClass", "data": {"endpoint": "xxx.xxx.xxx.xxxx", "poolPrefix": "default"}}, {"name": "rgw-admin-ops-user", "kind": "Secret", "data": {"accessKey": "<access-key>", "secretKey": "<secret-key>"}}]

4. Upload the generated JSON file.

   1. Log in to the OpenShift Web Console.
   2. Click Workloads → Secrets.
   3. Set project to openshift-storage.
   4. Click rook-ceph-external-cluster-details.
   5. Click Actions (⋮) → Edit Secret.
   6. Click Browse and upload the JSON file.
   7. Click Save.