Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Doc update for v3.13 release (backport #4994) #5010

Merged
merged 3 commits into from
Dec 11, 2024
Merged

doc: Doc update for v3.13 release (backport #4994) #5010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
975964a
doc: update the document for 3.13 release
Madhu-1 Dec 3, 2024
e62e82a
ci: update mergify rules
Madhu-1 Dec 3, 2024
e6a9a0b
ci: update github action commenter
Madhu-1 Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 2 additions & 22 deletions .github/workflows/pull-request-commentor.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,8 @@ jobs:

strategy:
matrix:
branch: [release-v3.11, release-v3.12, devel]
k8s: ["1.26", "1.27", "1.28", "1.29", "1.30", "1.31"]
exclude:
# Run only last 3 support releases on devel and 3.12
- k8s: "1.26"
branch: "release-v3.12"
- k8s: "1.26"
branch: "devel"
- k8s: "1.27"
branch: "release-v3.12"
- k8s: "1.27"
branch: "devel"
- k8s: "1.28"
branch: "release-v3.12"
- k8s: "1.28"
branch: "devel"
# Ceph-CSI <= 3.11 was released before Kubernetes 1.30
- k8s: "1.30"
branch: "release-v3.11"
# Ceph-CSI <= 3.11 was released before Kubernetes 1.31
- k8s: "1.31"
branch: "release-v3.11"
branch: [release-v3.12, release-v3.13, devel]
k8s: ["1.29", "1.30", "1.31"]

# watch out, matrix.branch can not be used in this if-statement :-/
if: >
Expand Down
63 changes: 27 additions & 36 deletions .mergify.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,22 @@ queue_rules:
- "status-success=ci/centos/upgrade-tests-cephfs"
- "status-success=ci/centos/upgrade-tests-rbd"
- and:
- base=release-v3.11
- base=release-v3.12
- "status-success=codespell"
- "status-success=multi-arch-build"
- "status-success=go-test"
- "status-success=golangci-lint"
- "status-success=mod-check"
- "status-success=lint-extras"
- "status-success=ci/centos/k8s-e2e-external-storage/1.26"
- "status-success=ci/centos/k8s-e2e-external-storage/1.27"
- "status-success=ci/centos/k8s-e2e-external-storage/1.28"
- "status-success=ci/centos/k8s-e2e-external-storage/1.29"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.26"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.27"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.28"
- "status-success=ci/centos/k8s-e2e-external-storage/1.30"
- "status-success=ci/centos/k8s-e2e-external-storage/1.31"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.29"
- "status-success=ci/centos/mini-e2e/k8s-1.26"
- "status-success=ci/centos/mini-e2e/k8s-1.27"
- "status-success=ci/centos/mini-e2e/k8s-1.28"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.30"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.31"
- "status-success=ci/centos/mini-e2e/k8s-1.29"
- "status-success=ci/centos/mini-e2e/k8s-1.30"
- "status-success=ci/centos/mini-e2e/k8s-1.31"
- "status-success=ci/centos/upgrade-tests-cephfs"
- "status-success=ci/centos/upgrade-tests-rbd"
- and:
Expand Down Expand Up @@ -178,7 +175,7 @@ pull_request_rules:
- "status-success=ci/centos/upgrade-tests-rbd"
- and:
- label!=DNM
- base=release-v3.11
- base=release-v3.12
- "#approved-reviews-by>=2"
- "#changes-requested-reviews-by=0"
- "approved-reviews-by=@ceph/ceph-csi-contributors"
Expand All @@ -190,18 +187,15 @@ pull_request_rules:
- "status-success=commitlint"
- "status-success=mod-check"
- "status-success=lint-extras"
- "status-success=ci/centos/k8s-e2e-external-storage/1.26"
- "status-success=ci/centos/k8s-e2e-external-storage/1.27"
- "status-success=ci/centos/k8s-e2e-external-storage/1.28"
- "status-success=ci/centos/k8s-e2e-external-storage/1.29"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.26"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.27"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.28"
- "status-success=ci/centos/k8s-e2e-external-storage/1.30"
- "status-success=ci/centos/k8s-e2e-external-storage/1.31"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.29"
- "status-success=ci/centos/mini-e2e/k8s-1.26"
- "status-success=ci/centos/mini-e2e/k8s-1.27"
- "status-success=ci/centos/mini-e2e/k8s-1.28"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.30"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.31"
- "status-success=ci/centos/mini-e2e/k8s-1.29"
- "status-success=ci/centos/mini-e2e/k8s-1.30"
- "status-success=ci/centos/mini-e2e/k8s-1.31"
- "status-success=ci/centos/upgrade-tests-cephfs"
- "status-success=ci/centos/upgrade-tests-rbd"
- "status-success=DCO"
Expand Down Expand Up @@ -266,7 +260,7 @@ pull_request_rules:
- "status-success=ci/centos/upgrade-tests-rbd"
- "status-success=DCO"
- and:
- base=release-v3.11
- base=release-v3.12
- label!=DNM
- label=ready-to-merge
- "approved-reviews-by=@ceph/ceph-csi-maintainers"
Expand All @@ -278,18 +272,15 @@ pull_request_rules:
- "status-success=mod-check"
- "status-success=lint-extras"
- "#changes-requested-reviews-by=0"
- "status-success=ci/centos/k8s-e2e-external-storage/1.26"
- "status-success=ci/centos/k8s-e2e-external-storage/1.27"
- "status-success=ci/centos/k8s-e2e-external-storage/1.28"
- "status-success=ci/centos/k8s-e2e-external-storage/1.29"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.26"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.27"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.28"
- "status-success=ci/centos/k8s-e2e-external-storage/1.30"
- "status-success=ci/centos/k8s-e2e-external-storage/1.31"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.29"
- "status-success=ci/centos/mini-e2e/k8s-1.26"
- "status-success=ci/centos/mini-e2e/k8s-1.27"
- "status-success=ci/centos/mini-e2e/k8s-1.28"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.30"
- "status-success=ci/centos/mini-e2e-helm/k8s-1.31"
- "status-success=ci/centos/mini-e2e/k8s-1.29"
- "status-success=ci/centos/mini-e2e/k8s-1.30"
- "status-success=ci/centos/mini-e2e/k8s-1.31"
- "status-success=ci/centos/upgrade-tests-cephfs"
- "status-success=ci/centos/upgrade-tests-rbd"
- "status-success=DCO"
Expand All @@ -298,23 +289,23 @@ pull_request_rules:
name: default
delete_head_branch: {}

- name: backport patches to release-v3.11 branch
- name: backport patches to release-v3.12 branch
conditions:
- base=devel
- label=backport-to-release-v3.11
- label=backport-to-release-v3.12
actions:
backport:
branches:
- release-v3.11
- release-v3.12

- name: backport patches to release-v3.12 branch
- name: backport patches to release-v3.13 branch
conditions:
- base=devel
- label=backport-to-release-v3.12
- label=backport-to-release-v3.13
actions:
backport:
branches:
- release-v3.12
- release-v3.13

- name: remove outdated approvals on ci/centos
conditions:
Expand Down
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ environments.

| Ceph CSI Version | Container Orchestrator Name | Version Tested |
| -----------------| --------------------------- | -------------------|
| v3.12.0 | Kubernetes | v1.29, v1.30, v1.31|
| v3.11.0 | Kubernetes | v1.26, v1.27, v1.28, v1.29|
| v3.13.0 | Kubernetes | v1.29, v1.30, v1.31|
| v3.12.3 | Kubernetes | v1.29, v1.30, v1.31|

There is work in progress to make this CO-independent and thus
support other orchestration environments (Nomad, Mesos..etc).
Expand Down Expand Up @@ -129,11 +129,12 @@ in the Kubernetes documentation.
| Ceph CSI Release/Branch | Container image name | Image Tag |
| ----------------------- | ---------------------------- | --------- |
| devel (Branch) | quay.io/cephcsi/cephcsi | canary |
| v3.12.0 (Release) | quay.io/cephcsi/cephcsi | v3.12.0 |
| v3.11.0 (Release) | quay.io/cephcsi/cephcsi | v3.11.0 |
| v3.13.0 (Release) | quay.io/cephcsi/cephcsi | v3.13.0 |
| v3.12.3 (Release) | quay.io/cephcsi/cephcsi | v3.12.3 |

| Deprecated Ceph CSI Release/Branch | Container image name | Image Tag |
| ----------------------- | --------------------------------| --------- |
| v3.11.0 (Release) | quay.io/cephcsi/cephcsi | v3.11.0 |
| v3.10.2 (Release) | quay.io/cephcsi/cephcsi | v3.10.2 |
| v3.10.1 (Release) | quay.io/cephcsi/cephcsi | v3.10.1 |
| v3.10.0 (Release) | quay.io/cephcsi/cephcsi | v3.10.0 |
Expand Down
23 changes: 12 additions & 11 deletions docs/ceph-csi-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Pre-upgrade considerations](#pre-upgrade-considerations)
- [Snapshot-controller and snapshot crd](#snapshot-controller-and-snapshot-crd)
- [Upgrading from previous releases](#upgrading-from-previous-releases)
- [Upgrading from v3.11 to v3.12](#upgrading-from-v311-to-v312)
- [Upgrading from v3.12 to v3.13](#upgrading-from-v312-to-v313)
- [Upgrading CephFS](#upgrading-cephfs)
- [1. Upgrade CephFS Provisioner resources](#1-upgrade-cephfs-provisioner-resources)
- [1.1 Update the CephFS Provisioner RBAC](#11-update-the-cephfs-provisioner-rbac)
Expand Down Expand Up @@ -49,7 +49,7 @@ To avoid this issue in future upgrades, we recommend that you do not use the
fuse client as of now.

This guide will walk you through the steps to upgrade the software in a cluster
from v3.11 to v3.12
from v3.12 to v3.13

### Snapshot-controller and snapshot crd

Expand Down Expand Up @@ -79,9 +79,10 @@ To upgrade from previous releases, refer to the following:
to upgrade from cephcsi v3.8 to v3.9
- [upgrade-from-v3.9-v3.10](https://github.com/ceph/ceph-csi/blob/v3.10.0/docs/ceph-csi-upgrade.md)
- [upgrade-from-v3.10-v3.11](https://github.com/ceph/ceph-csi/blob/v3.11.0/docs/ceph-csi-upgrade.md)
to upgrade from cephcsi v3.10 to v3.11
- [upgrade-from-v3.11-v3.12](https://github.com/ceph/ceph-csi/blob/v3.12.3/docs/ceph-csi-upgrade.md)
to upgrade from cephcsi v3.11 to v3.12

## Upgrading from v3.11 to v3.12
## Upgrading from v3.12 to v3.13

**Ceph-csi releases from devel are expressly unsupported.** It is strongly
recommended that you use [official
Expand All @@ -91,19 +92,19 @@ that will not be supported in the official releases. Builds from the devel
branch can have functionality changed and even removed at any time without
compatibility support and without prior notice.

**Also, we do not recommend any direct upgrades to 3.12 except from 3.11 to 3.12.**
For example, upgrading from 3.10 to 3.12 is not recommended.
**Also, we do not recommend any direct upgrades to 3.13 except from 3.12 to 3.13.**
For example, upgrading from 3.10 to 3.13 is not recommended.

**Refer to the Breaking Changes Section in the
[release notes](https://github.com/ceph/ceph-csi/releases/tag/v3.12.0) before
proceeding further.**

git checkout v3.12.0 tag
git checkout v3.13.0 tag

```bash
git clone https://github.com/ceph/ceph-csi.git
cd ./ceph-csi
git checkout v3.12.0
git checkout v3.13.0
```

```console
Expand Down Expand Up @@ -225,7 +226,7 @@ For each node:
- The pod deletion causes the pods to be restarted and updated automatically
on the node.

we have successfully upgraded cephfs csi from v3.11 to v3.12
we have successfully upgraded cephfs csi from v3.12 to v3.13

### Upgrading RBD

Expand Down Expand Up @@ -289,7 +290,7 @@ daemonset.apps/csi-rbdplugin configured
service/csi-metrics-rbdplugin configured
```

we have successfully upgraded RBD csi from v3.11 to v3.12
we have successfully upgraded RBD csi from v3.12 to v3.13

### Upgrading NFS

Expand Down Expand Up @@ -351,7 +352,7 @@ daemonset.apps/csi-nfsplugin configured
service/csi-metrics-nfsplugin configured
```

we have successfully upgraded nfs csi from v3.11 to v3.12
we have successfully upgraded nfs csi from v3.12 to v3.13

### CSI Sidecar containers consideration

Expand Down
Loading