Skip to content

Commit 5eff886

Browse files
committed
restructure Required Kubernetes Snapshot Components readme section
1 parent c96f152 commit 5eff886

4 files changed

Lines changed: 19 additions & 20 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
## unreleased
22

33
## v4.0.0-beta1 - 2026.02.27
4-
⚠️ **Breaking change for snapshot users**
5-
This release **requires** Kubernetes VolumeSnapshot CRDs and the external snapshot controller to be installed **before** installing or upgrading this driver. Clusters without these components must install them first; otherwise snapshot-related operations (and the Helm chart’s snapshot resources) will fail to work.
4+
⚠️ See the [update instructions](https://github.com/cloudscale-ch/csi-cloudscale#from-csi-cloudscale-v3x-to-v4x).
65

7-
* Add CSI snapshot support, including create/delete, list, and creating volumes from snapshots, with improved error handling and idempotency (for example around size mismatches and existing snapshots).
8-
* Add `VolumeSnapshotClass` and other snapshot-related resources to the Helm chart and examples; when using Helm, snapshot classes are now created from the `csi.snapshotClasses` configuration.
9-
* Document the new snapshot-related preconditions and upgrade notes in the README, focusing on users upgrading from v3.x to v4.x.
10-
* Update `github.com/cloudscale-ch/cloudscale-go-sdk/v7` to `v7.0.0`.
6+
**Breaking change:** This release **requires** Kubernetes VolumeSnapshot CRDs and the external snapshot controller to be installed **before** installing or upgrading this driver. Clusters without these components must install them first. Otherwise, snapshot-related operations and the snapshot resource in the Helm chart will fail to work.
7+
8+
* Add CSI snapshot support, including create, delete, list, and creating volumes from snapshots.
9+
* Add `VolumeSnapshotClass` and other snapshot-related resources to the Helm chart and examples. When using Helm, snapshot classes are now created from the `csi.snapshotClasses` configuration.
10+
* Cleaned up RBAC rules in Helm chart.
11+
* Update `github.com/cloudscale-ch/cloudscale-go-sdk` fron `v6.0.1` to `v7.0.0`.
1112
* Bump `google.golang.org/grpc` from `v1.77.0` to `v1.79.1`.
1213
* Bump `github.com/sirupsen/logrus` from `v1.9.3` to `v1.9.4`.
1314
* Bump `golang.org/x/sys` from `v0.39.0` to `v0.41.0`.
14-
* Refine the Helm chart, RBAC and example manifests (including LUKS examples), and simplify snapshot installation instructions using kustomize.
1515

1616
## v3.6.0 - 2026.01.15
1717

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,11 @@ on `quay.io` and `k8s.gcr.io` container registries. Use `registry.k8s.io` instea
116116
* If you want to use LUKS encrypted volumes, the kernel on your nodes must have support for
117117
`device mapper` infrastructure with the `crypt target` and the appropriate cryptographic APIs
118118

119-
### Required Kubernetes Snapshot Components
120-
121-
Clusters running this driver version must have the
122-
VolumeSnapshot CRDs and snapshot controller installed.
123-
Some Kubernetes distributions already include these CRDs and controllers. You only need to apply them manually if your cluster does not provide them.
119+
#### 1. Required Kubernetes Snapshot Components
124120

121+
Clusters running this driver version must have the VolumeSnapshot CRDs and snapshot controller installed.
122+
Some Kubernetes distributions already include these CRDs and controllers.
123+
You only need to apply them manually if your cluster does not provide them.
125124

126125
Install the snapshot resources using kustomize (recommended):
127126
```
@@ -132,7 +131,7 @@ kubectl apply -k https://github.com/kubernetes-csi/external-snapshotter/deploy/k
132131
When installing using the Helm chart, the `VolumeSnapshotClass` resources are created by the chart based on the `csi.snapshotClasses`
133132
configuration in `values.yaml`.
134133

135-
#### 1. Create a secret with your cloudscale.ch API Access Token:
134+
#### 2. Create a secret with your cloudscale.ch API Access Token:
136135

137136
Replace the placeholder string starting with `a05...` with your own secret and
138137
save it as `secret.yml`:
@@ -163,14 +162,14 @@ default-token-jskxx kubernetes.io/service-account-token 3 18h
163162
cloudscale Opaque 1 18h
164163
```
165164

166-
#### 2. Deploy the CSI plugin and sidecars:
165+
#### 3. Deploy the CSI plugin and sidecars:
167166

168167
You can install the CSI plugin and sidecars using one of the following methods:
169168
* Helm (requires a Helm installation)
170169
* YAML Manifests (only kubectl required)
171170

172171

173-
#### 2a. Using Helm:
172+
#### 3a. Using Helm:
174173

175174
Before you can install the csi-cloudscale chart, you need to add the helm repository:
176175

@@ -211,7 +210,7 @@ Note: if you want to test a debug/dev release, you can use the following command
211210
$ helm install -g -n kube-system --set controller.image.tag=dev --set node.image.tag=dev --set controller.image.pullPolicy=Always --set node.image.pullPolicy=Always ./charts/csi-cloudscale
212211
```
213212

214-
#### 2b. Using YAML Manifests:
213+
#### 3b. Using YAML Manifests:
215214

216215
Before you continue, be sure to checkout to a [tagged
217216
release](https://github.com/cloudscale-ch/csi-cloudscale/releases).
@@ -227,7 +226,7 @@ storage class `cloudscale-volume-ssd` is set to **"default"** for dynamic provis
227226
using multiple storage classes you might want to remove the annotation and re-deploy it. This is
228227
based on the [recommended mechanism](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md#recommended-mechanism-for-deploying-csi-drivers-on-kubernetes) of deploying CSI drivers on Kubernetes
229228

230-
#### 3. Test and verify:
229+
#### 4. Test and verify:
231230

232231
Create a PersistentVolumeClaim. This makes sure a volume is created and provisioned on your behalf:
233232

@@ -329,7 +328,7 @@ When updating from csi-cloudscale v2.x to v3.x please note the following:
329328

330329
Before upgrading, ensure that the Kubernetes VolumeSnapshot
331330
CRDs and snapshot controller are installed in the cluster.
332-
See [Required Kubernetes Snapshot Components](#required-kubernetes-snapshot-components).
331+
See [Required Kubernetes Snapshot Components](#1-required-kubernetes-snapshot-components).
333332

334333
## Advanced Configuration
335334

examples/kubernetes/luks-encrypted-volumes/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Demonstrates creating and restoring LUKS-encrypted volumes from snapshots.
44

55
## Prerequisites
66

7-
- Snapshot CRDs and snapshot controller installed (see [main README](../../../README.md#prerequisites))
7+
- Snapshot CRDs and snapshot controller installed (see [main README](../../../README.md#1-required-kubernetes-snapshot-components))
88
- A suitable `VolumeSnapshotClass` available. When installing the driver via the Helm chart,
99
this is created automatically based on the `csi.snapshotClasses` configuration. For other
1010
installation methods, you must create a `VolumeSnapshotClass` manually.

examples/kubernetes/volume-snapshots/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Demonstrates creating and restoring volumes from snapshots.
44

55
## Prerequisites
66

7-
- Snapshot CRDs and snapshot controller installed (see [main README](../../../README.md#prerequisites))
7+
- Snapshot CRDs and snapshot controller installed (see [main README](../../../README.md#1-required-kubernetes-snapshot-components))
88
- A suitable `VolumeSnapshotClass` available. When installing the driver via the Helm chart,
99
this is created automatically based on the `csi.snapshotClasses` configuration. For other
1010
installation methods, you must create a `VolumeSnapshotClass` manually.

0 commit comments

Comments
 (0)