Merge pull request #11730 from rook/mergify/bp/release-1.11/pr-11728

docs: update docs to prepare for v1.11 release (backport #11728)
This commit is contained in:
Travis Nielsen authored and GitHub committed 2023-02-21 10:37:01 -07:00
commit fc5d6dad7a
2 files changed
+25 -33

No files matched your search

+2 -2
View File
@@ -49,11 +49,11 @@ In Ceph Quincy (v17), the `device_health_metrics` pool was renamed to `.mgr`. Ce
migration automatically. If you do not use CephBlockPool to customize the configuration of the
`device_health_metrics` pool, the pool rename will be automatic.
If you do use CephBlockPool to customize the configuration of the `device_health_metrics` pool, you
If you use CephBlockPool to customize the configuration of the `device_health_metrics` pool, you
will need two extra steps after the Ceph upgrade is complete. Once upgrade is complete:
1. Create a new CephBlockPool to configure the `.mgr` built-in pool. You can reference the example
[builtin mgr pool](https://github.com/rook/rook/blob/master/deploy/examples/pool-builtin-mgr.yaml).
[builtin mgr pool](https://github.com/rook/rook/blob/master/deploy/examples/pool-builtin-mgr.yaml).
2. Delete the old CephBlockPool that represents the `device_health_metrics` pool.
### CephNFS User Consideration
+23 -31
View File
@@ -14,7 +14,7 @@ We welcome feedback and opening issues!
## Supported Versions
This guide is for upgrading from **Rook v1.9.x to Rook v1.10.x**.
This guide is for upgrading from **Rook v1.10.x to Rook v1.11.x**.
Please refer to the upgrade guides from previous releases for supported upgrade paths.
Rook upgrades are only supported between official releases.
@@ -22,6 +22,7 @@ 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.
* [Upgrade 1.9 to 1.10](https://rook.io/docs/rook/v1.10/Upgrade/rook-upgrade/)
* [Upgrade 1.8 to 1.9](https://rook.io/docs/rook/v1.9/Upgrade/rook-upgrade/)
* [Upgrade 1.7 to 1.8](https://rook.io/docs/rook/v1.8/ceph-upgrade.html)
* [Upgrade 1.6 to 1.7](https://rook.io/docs/rook/v1.7/ceph-upgrade.html)
@@ -44,18 +45,9 @@ those releases.
official releases. Builds from the master branch can have functionality changed or removed at any
time without compatibility support and without prior notice.
## Breaking changes in v1.10
## Breaking changes in v1.11
* Support for Ceph Octopus (15.2.x) was removed. If you are running v15 you must upgrade to Ceph
Pacific (v16) or Quincy (v17) before upgrading to Rook v1.10
* The minimum supported version of Ceph-CSI is v3.6.0. You must update to at least this version of
Ceph-CSI before or at the same time you update the Rook operator image to v1.10
* Before upgrading to K8s 1.25, ensure that you are running at least Rook v1.9.10, or v1.10.x.
If you upgrade to K8s 1.25 before upgrading to v1.9.10 or newer, the Helm chart may be
blocked from upgrading to newer versions of Rook. See [#10826](https://github.com/rook/rook/issues/10826)
for a possible workaround.
* The minimum supported version of Kubernetes is now v1.21.0
## Considerations
@@ -71,7 +63,7 @@ With this upgrade guide, there are a few notes to consider:
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.10.1 is released, the process of updating from v1.10.0 is as simple as running
example, when Rook v1.11.1 is released, the process of updating from v1.11.0 is as simple as running
the following:
```console
@@ -83,11 +75,11 @@ If you have deployed the Rook Operator or the Ceph cluster into a different name
`rook-ceph`, see the [Update common resources and CRDs](#1-update-common-resources-and-crds)
section for instructions on how to change the default namespaces in `common.yaml`.
Then apply the latest changes from v1.10 and update the Rook Operator image.
Then apply the latest changes from v1.11 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.10.1
kubectl -n rook-ceph set image deploy/rook-ceph-operator rook-ceph-operator=rook/ceph:v1.11.1
```
As exemplified above, it is a good practice to update Rook common resources from the example
@@ -118,9 +110,9 @@ In order to successfully upgrade a Rook cluster, the following prerequisites mus
## Rook Operator Upgrade
In the examples given in this guide, we will be upgrading a live Rook cluster running `v1.9.10` to
the version `v1.10.0`. This upgrade should work from any official patch release of Rook v1.9 to any
official patch release of v1.10.
In the examples given in this guide, we will be upgrading a live Rook cluster running `v1.10.11` to
the version `v1.11.0`. This upgrade should work from any official patch release of Rook v1.10 to any
official patch release of v1.11.
Let's get started!
@@ -182,7 +174,7 @@ kubectl apply -f deploy/examples/monitoring/rbac.yaml
!!! hint
If you are upgrading via the Helm chart, the operator is automatically updated.
The largest portion of the upgrade is triggered when the operator's image is updated to `v1.10.x`.
The largest portion of the upgrade is triggered when the operator's image is updated to `v1.11.x`.
When the operator is updated, it will proceed to update all of the Ceph daemons.
```console
@@ -216,18 +208,18 @@ watch --exec kubectl -n $ROOK_CLUSTER_NAMESPACE get deployments -l rook_cluster=
```
As an example, this cluster is midway through updating the OSDs. When all deployments report `1/1/1`
availability and `rook-version=v1.10.0`, the Ceph cluster's core components are fully updated.
availability and `rook-version=v1.11.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.10.0
rook-ceph-mon-a req/upd/avl: 1/1/1 rook-version=v1.10.0
rook-ceph-mon-b req/upd/avl: 1/1/1 rook-version=v1.10.0
rook-ceph-mon-c req/upd/avl: 1/1/1 rook-version=v1.10.0
rook-ceph-osd-0 req/upd/avl: 1// rook-version=v1.10.0
rook-ceph-osd-1 req/upd/avl: 1/1/1 rook-version=v1.9.10
rook-ceph-osd-2 req/upd/avl: 1/1/1 rook-version=v1.9.10
rook-ceph-mgr-a req/upd/avl: 1/1/1 rook-version=v1.11.0
rook-ceph-mon-a req/upd/avl: 1/1/1 rook-version=v1.11.0
rook-ceph-mon-b req/upd/avl: 1/1/1 rook-version=v1.11.0
rook-ceph-mon-c req/upd/avl: 1/1/1 rook-version=v1.11.0
rook-ceph-osd-0 req/upd/avl: 1// rook-version=v1.11.0
rook-ceph-osd-1 req/upd/avl: 1/1/1 rook-version=v1.10.11
rook-ceph-osd-2 req/upd/avl: 1/1/1 rook-version=v1.10.11
```
An easy check to see if the upgrade is totally finished is to check that there is only one
@@ -236,14 +228,14 @@ An easy check to see if the upgrade is totally finished is to check that there i
```console
# kubectl -n $ROOK_CLUSTER_NAMESPACE get deployment -l rook_cluster=$ROOK_CLUSTER_NAMESPACE -o jsonpath='{range .items[*]}{"rook-version="}{.metadata.labels.rook-version}{"\n"}{end}' | sort | uniq
This cluster is not yet finished:
rook-version=v1.9.10
rook-version=v1.10.0
rook-version=v1.10.11
rook-version=v1.11.0
This cluster is finished:
rook-version=v1.10.0
rook-version=v1.11.0
```
### **5. Verify the updated cluster**
At this point, your Rook operator should be running version `rook/ceph:v1.10.0`.
At this point, your Rook operator should be running version `rook/ceph:v1.11.0`.
Verify the Ceph cluster's health using the [health verification doc](health-verification.md).