Skip to content

Ceph-CSI Driver Helm Chart

To configure the Ceph-CSI drivers, Rook requires the installation of the Ceph-CSI Driver chart. This chart configures the CSI drivers to provision and mount volumes to make available the Ceph storage to your applications.

Prerequisites

  • The rook-ceph chart must be installed before the Ceph-CSI drivers chart, to install the required Ceph-CSI operator and CRDs.

Installing

The Ceph-CSI drivers Helm chart installs the resources needed for ceph-csi to run under the ceph-csi-operator.

The helm install command deploys the drivers in the default configuration from the chart. For more configuration options, see the Ceph-CSI Drivers Configuration.

Ceph-CSI publishes the drivers chart from the ceph-csi-operator Helm repository.

IMPORTANT

  1. Install this chart with the recommended values.yaml. The drivers will fail if only configured with the chart defaults.
  2. If installing in another namespace, replace all instances of rook-ceph in the values.yaml with the required namespace.
1
2
3
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 \
  -f https://raw.githubusercontent.com/rook/rook/master/deploy/charts/ceph-csi-drivers/values.yaml

Custom settings

Below are some examples of common settings that may need to be customized in the CSI drivers chart. Create a values file with the desired settings and install with -f values.yaml.

CSI-Addons sidecar

1
2
3
operatorConfig:
  driverSpecDefaults:
    deployCsiAddons: true

See: CSI-Addons sidecar

Controller plugin replicas

1
2
3
4
operatorConfig:
  driverSpecDefaults:
    controllerPlugin:
      replicas: 2

See: Controller replicas and strategy

CephFS client type

1
2
3
drivers:
  cephfs:
    cephFsClientType: fuse

See: CephFS client type (kernel vs FUSE)

RBD driver name prefix

1
2
3
drivers:
  rbd:
    name: rook-ceph.rbd.csi.ceph.com

Note The prefix rook-ceph should always be the rook operator namespace.

See: Driver name / provisioner prefix

NFS CSI driver

1
2
3
4
drivers:
  nfs:
    enabled: true
    name: rook-ceph.nfs.csi.ceph.com

See: Enable NFS CSI driver

kubelet path

1
2
3
4
5
operatorConfig:
  driverSpecDefaults:
    nodePlugin:
      kubeletDirPath: /var/lib/kubelet
      enableSeLinuxHostMount: true

See: Node plugin kubelet path and SELinux host mount

Custom CSI images

Custom CSI images are configured from the rook-ceph chart. See the default images in the rook-ceph chart values