Available in:  CE, SE, SE+, EE

The module lifecycle stage: General Availability
The module has requirements for installation

How to explicitly enable the module…

You may explicitly enable or disable the module in one of the following ways:

  • Via Deckhouse web UI. In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the csi-ceph module and enable (or disable) the “Module enabled” toggle. Save changes.

    Example:

    Module enable/disable interface

  • Via Deckhouse CLI (d8).

    Use the d8 system module enable command for enabling, or d8 system module disable command for disabling the module (you need Deckhouse CLI (d8), configured to work with the cluster).

    Example of enabling the module:

    d8 system module enable csi-ceph

  • Using ModuleConfig csi-ceph.

    Set spec.enabled to true or false in ModuleConfig csi-ceph (create it if necessary);

    Example of a manifest to enable module csi-ceph:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: csi-ceph
spec:
  enabled: true

How to configure the module…

You can configure the module in one of the following ways:

  • Via Deckhouse web UI.

    In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the csi-ceph module and enable the “Advanced Settings” switch. Fill in the required fields in the “Configuration” tab or specify the module settings in YAML format on the “YAML” tab, excluding the settings section. Save the changes.

    Example:

    Module Setup Interface

    You can also edit the ModuleConfig object csi-ceph on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module csi-ceph) by specifying the schema version in the spec.version parameter and the necessary module parameters in the spec.settings section.

  • Via Deckhouse CLI (d8) (requires Deckhouse CLI (d8) configured to work with the cluster).

    Edit the existing ModuleConfig csi-ceph (for more details on configuring Deckhouse, see the documentation) by executing the following command:

    d8 k edit mc csi-ceph

    Make the necessary changes in the spec.settings section. If necessary, specify the schema version in the spec.version parameter. Save the changes.

    You can also create a file with manifest for ModuleConfig csi-ceph using the example below. Fill in the spec.settings section with the required module parameters. If necessary, specify the schema version in the spec.version parameter.

    Apply the manifest using the following command (indicate the manifest file name):

    d8 k apply -f <FILENAME>

    Example of a manifest for ModuleConfig csi-ceph:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: csi-ceph
spec:
  version: 1
  enabled: true
  settings: # Module parameters from the "Parameters" section below.

How to change the module release channel…

To change the module release channel, follow the instruction.

Requirements

To the Deckhouse version: 1.72 and above.

To the versions of other modules:

  • snapshot-controller: any version.

Parameters

Schema version: 1

  • settings
    object
    • settings.cephfsEnabled
      boolean
      Enable or disable the CephFS CSI driver. When set to false, the CephFS driver controller and CSIDriver resources will not be deployed.

      Default: true

    • settings.cephfsProvisionerWorkers
      integer
      Settings for CephFS provisioner workers (default 10). Please do not set this value if you are not sure what you are doing.

      Default: 10

    • settings.logLevel
      string
      Module log level

      Default: DEBUG

      Allowed values: ERROR, WARN, INFO, DEBUG, TRACE

    • settings.msCrcData
      boolean

      Enable or disable CRC32C checksum verification on Ceph messenger data frames.

      WARNING: Do not disable this option unless you fully understand the consequences. When set to false, the ms_crc_data option in ceph.conf is disabled. This reduces Ceph’s ability to detect corrupted messenger data frames and may result in silent data corruption, data inconsistency, or data loss.

      The recommended and safe value is true.

      NOTE: Changing this value only affects new Ceph client operations performed by the CSI driver: new volume provisioning, as well as new attach/mount operations. Already mounted volumes keep using the previous ms_crc_data value until they are physically unmounted from the node and mounted again.

      Default: true

    • settings.rbdEnabled
      boolean
      Enable or disable the RBD CSI driver. When set to false, the RBD driver controller and CSIDriver resources will not be deployed.

      Default: true

    • settings.rbdProvisionerWorkers
      integer
      Settings for RBD provisioner workers (default 10). Please do not set this value if you are not sure what you are doing.

      Default: 10