Skip to content

openstack-cinder-csi and csi-snapshot-controller doc fixes #813

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

Open
theboringstuff wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −1
Open

openstack-cinder-csi and csi-snapshot-controller doc fixes #813

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f902a90
doc fixes
theboringstuff May 26, 2026
2efe338
VolumeSnapshotClass immutability note
theboringstuff May 26, 2026
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
23 changes: 22 additions & 1 deletion documentation/Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4555,7 +4555,15 @@ plugins:

**Note:**
* Above configuration assumes that nodes have OpenStack credentials stored on all nodes under `/etc/config/cloud.conf` file. You need to put this file on nodes during nodes provisioning.
* By default, this plugin uses `openstack-cinder-csi` namespace and helm release name.
* By default, this plugin uses `openstack-cinder-csi` namespace and helm release name. You can change namespace and release name using following configuraion options:
```
plugins:
openstack-cinder-csi:
namespace: "my-namespace"
releaseName: "my-release"
```
* You can override chart values using `plugins.openstack-cinder-csi.values` field. Supported parameters could be found in the chart [`values.yaml`](/kubemarine/plugins/charts/openstack-cinder-csi-2.35.0/values.yaml).
* `StorageClass` fields are mostly immutable, so if you want to change them, you need to first manually delete existing StorageClass on the cluster (with the same name). Alternatively you can add a new StorageClass and make it the default.

If you are using an old OpenStack, above configuration may not work, because it installs new version of Cinder CSI plugin, which expects new OpenStack APIs. You may see issues like following:
```
Expand Down Expand Up @@ -4638,6 +4646,15 @@ plugins:
* Above configuration also creates default `VolumeSnapshotClass` for openstack cinder driver.
* `csi-snapshot-controller` only works with recent versions of `openstack-cinder-csi` plugin, because old version contains a bug:
* https://github.com/kubernetes/cloud-provider-openstack/issues/1812
* By default, this plugin uses `csi-snapshot-controller` namespace and helm release name. You can change namespace and release name using following configuraion options:
```
plugins:
csi-snapshot-controller:
namespace: "my-namespace"
releaseName: "my-release"
```
* You can override chart values using `plugins.csi-snapshot-controller.values` field. Supported parameters could be found in the chart [`values.yaml`](/kubemarine/plugins/charts/csi-snapshot-controller-8.5.0/values.yaml).
* `VolumeSnapshotClass` fields are mostly immutable, so if you want to change them, you need to first manually delete existing VolumeSnapshotClass on the cluster (with the same name). Alternatively you can add a new VolumeSnapshotClass and make it the default.

#### Plugins Features

Expand Down Expand Up @@ -6310,6 +6327,7 @@ The tables below shows the correspondence of versions that are supported and is
| | registry.k8s.io/sig-storage/livenessprobe | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/csi-node-driver-registrar | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/provider-os/cinder-csi-plugin | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/snapshot-controller | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | Required only if csi-snapshot-controller plugin is set to be installed. |

## Default Dependent Components Versions for Kubernetes Versions v1.34.2
| Type | Name | Versions | | | | | | | | Note |
Expand Down Expand Up @@ -6352,6 +6370,7 @@ The tables below shows the correspondence of versions that are supported and is
| | registry.k8s.io/sig-storage/livenessprobe | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/csi-node-driver-registrar | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/provider-os/cinder-csi-plugin | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/snapshot-controller | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | Required only if csi-snapshot-controller plugin is set to be installed. |

## Default Dependent Components Versions for Kubernetes Versions v1.35.0

Expand Down Expand Up @@ -6397,6 +6416,7 @@ The tables below shows the correspondence of versions that are supported and is
| | registry.k8s.io/sig-storage/livenessprobe | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/csi-node-driver-registrar | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/provider-os/cinder-csi-plugin | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/snapshot-controller | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | Required only if csi-snapshot-controller plugin is set to be installed. |

## Default Dependent Components Versions for Kubernetes Versions v1.36.0

Expand Down Expand Up @@ -6442,3 +6462,4 @@ The tables below shows the correspondence of versions that are supported and is
| | registry.k8s.io/sig-storage/livenessprobe | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | v2.17.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/csi-node-driver-registrar | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | v2.15.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/provider-os/cinder-csi-plugin | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | v1.35.0 | Required only if openstack-cinder-csi plugin is set to be installed. |
| | registry.k8s.io/sig-storage/snapshot-controller | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | v8.5.0 | Required only if csi-snapshot-controller plugin is set to be installed. |
Loading