diff --git a/Documentation/Helm-Charts/csi-drivers-chart.md b/Documentation/Helm-Charts/csi-drivers-chart.md index 0aec01421..7a09c0761 100644 --- a/Documentation/Helm-Charts/csi-drivers-chart.md +++ b/Documentation/Helm-Charts/csi-drivers-chart.md @@ -16,9 +16,13 @@ The `helm install` command deploys the drivers in the default configuration from Ceph-CSI publishes the drivers chart from the `ceph-csi-operator` Helm repository. +!!! important + Install this chart with the recommended values.yaml. The drivers will fail if only configured with the chart defaults. + ```console helm repo add ceph-csi-operator https://ceph.github.io/ceph-csi-operator -helm install ceph-csi-drivers --namespace rook-ceph ceph-csi-operator/ceph-csi-drivers +helm install ceph-csi-drivers --namespace rook-ceph ceph-csi-operator/ceph-csi-drivers \ + -f https://raw.githubusercontent.com/rook/rook/master/deploy/charts/rook-ceph/ceph-csi-drivers/values.yaml ``` ## Custom settings diff --git a/Documentation/Upgrade/rook-upgrade.md b/Documentation/Upgrade/rook-upgrade.md index 003826114..0c6991164 100644 --- a/Documentation/Upgrade/rook-upgrade.md +++ b/Documentation/Upgrade/rook-upgrade.md @@ -119,10 +119,14 @@ See the default settings applied by Rook in [values.yaml](https://github.com/roo Install or upgrade the [`ceph-csi-drivers`](../Helm-Charts/csi-drivers-chart.md) chart, to configure the CSI driver. -!!! important - In previous releases, CSI settings were customized in the `rook-ceph` chart. Now, settings - must be customized in the [CSI Drivers Chart config](https://github.com/ceph/ceph-csi-operator/blob/main/docs/helm-charts/drivers-chart.md#configuration). +**Important points** to ensure CSI mounts continue working after upgrades: +1. This `ceph-csi-drivers` chart must be installed, otherwise the CSI driver will be in a + failed state due to missing service accounts. +2. A recommended `values.yaml` is provided for Rook-compatible defaults in the drivers chart doc linked above. + This is critical for setting the proper driver names with the rook operator namespace as a prefix. +3. In previous releases, CSI settings were customized in the `rook-ceph` chart. + Now see the [CSI Drivers Chart config](https://github.com/ceph/ceph-csi-operator/blob/main/docs/helm-charts/drivers-chart.md#configuration) for customization. ### `rook-ceph-cluster` Chart diff --git a/deploy/charts/ceph-csi-drivers/values.yaml b/deploy/charts/ceph-csi-drivers/values.yaml new file mode 100644 index 000000000..1fd5ae6af --- /dev/null +++ b/deploy/charts/ceph-csi-drivers/values.yaml @@ -0,0 +1,32 @@ +# Rook-compatible default values for the ceph-csi-drivers Helm chart. +# +# Use these values when installing or upgrading the ceph-csi-drivers chart +# alongside the rook-ceph operator chart. The driver names must match the +# provisioner names used by Rook (e.g. in StorageClasses and VolumeSnapshotClasses). +# +# If the Rook operator is installed in a namespace other than rook-ceph, replace +# "rook-ceph" in the driver names below with your operator namespace. + +operatorConfig: + namespace: rook-ceph # namespace:operator + driverSpecDefaults: + imageSet: + name: rook-csi-operator-image-set-configmap + nodePlugin: + priorityClassName: system-node-critical + controllerPlugin: + priorityClassName: system-cluster-critical + +drivers: + rbd: + enabled: true + name: rook-ceph.rbd.csi.ceph.com + cephfs: + enabled: true + name: rook-ceph.cephfs.csi.ceph.com + nfs: + enabled: false + name: rook-ceph.nfs.csi.ceph.com + nvmeof: + enabled: false + name: rook-ceph.nvmeof.csi.ceph.com diff --git a/deploy/examples/csi/nvmeof/storageclass.yaml b/deploy/examples/csi/nvmeof/storageclass.yaml index ffe19a569..7aec3ad01 100644 --- a/deploy/examples/csi/nvmeof/storageclass.yaml +++ b/deploy/examples/csi/nvmeof/storageclass.yaml @@ -2,6 +2,7 @@ apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: name: ceph-nvmeof +provisioner: rook-ceph.nvmeof.csi.ceph.com # csi-provisioner-name parameters: clusterID: rook-ceph pool: nvmeof @@ -27,7 +28,6 @@ parameters: csi.storage.k8s.io/node-expand-secret-namespace: rook-ceph imageFormat: "2" imageFeatures: layering,deep-flatten,exclusive-lock,object-map,fast-diff -provisioner: rook-ceph.nvmeof.csi.ceph.com reclaimPolicy: Delete volumeBindingMode: Immediate allowVolumeExpansion: true