Project: Rook (Runtime / Cloud Native Storage)
File: rook-upgrade.md

title: Rook Upgrades This guide will walk through the steps to upgrade the software in a Rook cluster from one version to the next. This guide focuses on updating the Rook version for the management layer, while the guide focuses on updating the data layer. Upgrades for both the operator and for Ceph are entirely automated except where Rook's permissions need to be explicitly updated by an admin or when incompatibilities need to be addressed manually due to customizations. We welcome feedback and opening issues! This guide is for upgrading from Rook v1.13.x to Rook v1.14.x. Please refer to the upgrade guides from previous releases for supported upgrade paths. Rook upgrades are only supported between official releases. For a guide to upgrade previous versions of Rook, please refer to the version of documentation for those releases. !!! important Rook releases from master are expressly unsupported. It is strongly recommended to use of Rook. Unreleased versions from the master branch are subject to changes and incompatibilities that will not be supported in the official releases. Builds from the master branch can have functionality changed or removed at any time without compatibility support and without prior notice. The minimum supported version of Kubernetes is v1.25. Upgrade to Kubernetes v1.25 or higher before upgrading Rook. The Rook operator config `CSIENABLEREAD_AFFINITY` was removed. v1.13 clusters that have modified this value to be `"true"` must set the option as desired in each CephCluster as documented before upgrading to v1.14. Rook is beginning the process of deprecating CSI network "holder" pods. If there are pods named `csi-plugin-holder-` in the Rook operator namespace, see the to disable them. This is optional for v1.14, but will be required in a future release. In the operator helm chart, the images for the CSI driver are now specified with separate `repository` and `tag` values. If the CSI images have been customized, convert them from the `image` value to the separated `repository` and `tag` values. With this upgrade guide, there are a few notes to consider: WARNING*: Upgrading a Rook cluster is not without risk. There may be unexpected issues or obstacles that damage the integrity and health the storage cluster, including data loss. The Rook cluster's storage may be unavailable for short periods during the upgrade process for both Rook operator updates and for Ceph version updates. Read this document in full before undertaking a Rook cluster

Unless otherwise noted due to extenuating requirements, upgrades from one patch release of Rook to another are as simple as updating the common resources and the image of the Rook operator. For example, when Rook v1.14.1 is released, the process of updating from v1.14.0 is as simple as running the following: ```console git clone --single-branch --depth=1 --branch v1.14.1 https://github.com/rook/rook.git cd rook/deploy/examples ``` If the Rook Operator or CephCluster are deployed into a different namespace than `rook-ceph`, see the section for instructions on how to change the default namespaces in `common.yaml`. Then, apply the latest changes from v1.14, and update the Rook Operator image. ```console kubectl apply -f common.yaml -f crds.yaml kubectl -n rook-ceph set image deploy/rook-ceph-operator rook-ceph-operator=rook/ceph:v1.14.1 ``` As exemplified above, it is a good practice to update Rook common resources from the example manifests before any update. The common resources and CRDs might not be updated with every release, but Kubernetes will only apply updates to the ones that changed. Also update optional resources like Prometheus monitoring noted more fully in the . If Rook is installed via the Helm chart, Helm will handle some details of the upgrade itself. The upgrade steps in this guide will clarify what Helm handles automatically. !!! important If there are pods named `csi-plugin-holder-` in the Rook operator namespace, set the new config `csi.disableHolderPods: false` in the values.yaml before upgrading to v1.14. The `rook-ceph` helm chart upgrade performs the Rook upgrade. The `rook-ceph-cluster` helm chart upgrade performs a if the Ceph image is updated. The `rook-ceph` chart should be upgraded before `rook-ceph-cluster`, so the latest operator has the opportunity to update custom resources as necessary. !!! note Be sure to update to a In order to successfully upgrade a Rook cluster, the following prerequisites must be met: The cluster should be in a healthy state with full functionality. Review the in order to verify a CephCluster is in a good starting state. All pods consuming Rook storage should be created, running, and in a steady state. The examples given in this guide upgrade a live Rook cluster running `v1.13.7` to the version `v1.14.0`. This upgrade should work from any official patch release of Rook v1.13 to any official patch release of v1.14. Let's get started! These instructions will work for as long the environment is parameterized correctly. Set the following environment variables, which will be used throughout this document. ```console export ROOKOPERATORNAMESPACE=rook-ceph export ROOKCLUSTERNAMESPACE=rook-ceph ``` !!! hint Common resources and CRDs are automatically updated when using Helm charts. First, apply updates to Rook common resources. This includes modified privileges (RBAC) needed by the Operator. Also update the Custom Resource Definitions (CRDs). Get the latest common resources manifests that contain the latest

```console git clone --single-branch --depth=1 --branch master https://github.com/rook/rook.git cd rook/deploy/examples ``` If the Rook Operator or CephCluster are deployed into a different namespace than `rook-ceph`, update the common resource manifests to use your `ROOKOPERATORNAMESPACE` and `ROOKCLUSTERNAMESPACE` using `sed`. ```console sed -i.bak \ -e "s/\(.\):.# namespace:operator/\1: $ROOKOPERATORNAMESPACE # namespace:operator/g" \ -e "s/\(.\):.# namespace:cluster/\1: $ROOKCLUSTERNAMESPACE # namespace:cluster/g" \ common.yaml ``` Apply the resources. ```console kubectl apply -f common.yaml -f crds.yaml ``` If is enabled, follow this step to upgrade the Prometheus RBAC resources as well. ```console kubectl apply -f deploy/examples/monitoring/rbac.yaml ``` !!! hint The operator is automatically updated when using Helm charts. The largest portion of the upgrade is triggered when the operator's image is updated to `v1.14.x`. When the operator is updated, it will proceed to update all of the Ceph daemons. ```console kubectl -n $ROOKOPERATORNAMESPACE set image deploy/rook-ceph-operator rook-ceph-operator=rook/ceph:master ``` !!! hint This is automatically updated if custom CSI image versions are not set. !!! important The minimum supported version of Ceph-CSI is v3.8.0. Update to the latest Ceph-CSI drivers if custom CSI images are specified. See the documentation. !!! note If using snapshots, refer to the . Watch now in amazement as the Ceph mons, mgrs, OSDs, rbd-mirrors, MDSes and RGWs are terminated and replaced with updated versions in sequence. The cluster may be unresponsive very briefly as mons update, and the Ceph Filesystem may fall offline a few times while the MDSes are upgrading. This is normal. The versions of the components can be viewed as they are updated: ```console watch --exec kubectl -n $ROOKCLUSTERNAMESPACE get deployments -l rookcluster=$ROOKCLUSTER_NAMESPACE -o jsonpath='{range .items[*]}{.metadata.name}{" \treq/upd/avl: "}{.spec.replicas}{"/"}{.status.updatedReplicas}{"/"}{.status.readyReplicas}{" \trook-version="}{.metadata.labels.rook-version}{"\n"}{end}' ``` As an example, this cluster is midway through updating the OSDs. When all deployments report `1/1/1` availability and `rook-version=v1.14.0`, the Ceph cluster's core components are fully updated. ```console Every 2.0s: kubectl -n rook-ceph get deployment -o j... rook-ceph-mgr-a req/upd/avl: 1/1/1 rook-version=v1.14.0 rook-ceph-mon-a req/upd/avl: 1/1/1 rook-version=v1.14.0 rook-ceph-mon-b req/upd/avl: 1/1/1 rook-version=v1.14.0 rook-ceph-mon-c req/upd/avl: 1/1/1 rook-version=v1.14.0 rook-ceph-osd-0 req/upd/avl: 1// rook-version=v1.14.0 rook-ceph-osd-1 req/upd/avl: 1/1/1 rook-version=v1.13.7 rook-ceph-osd-2 req/upd/avl: 1/1/1 rook-version=v1.13.7 ``` An easy check to see if the upgrade is totally finished is to check that there is only one `rook-version` reported across the cluster. ```console This cluster is not yet finished: rook-version=v1.13.7 rook-version=v1.14.0 This cluster is finished: rook-version=v1.14.0 ``` At this point, the Rook operator should be running version `rook/ceph:v1.14.0`. Verify the CephCluster health using the . Rook is beginning the process of deprecating CSI network "holder" pods. If there are pods named `csi-plugin-holder-` in the Rook operator namespace, see the to disable them. This is optional for v1.14, but will be required in a future release.