Available in:  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-s3 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-s3

  • Using ModuleConfig csi-s3.

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

    Example of a manifest to enable module csi-s3:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: csi-s3
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-s3 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-s3 on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module csi-s3) 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-s3 (for more details on configuring Deckhouse, see the documentation) by executing the following command:

    d8 k edit mc csi-s3

    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-s3 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-s3:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: csi-s3
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.

Parameters

Schema version: 1

  • settings
    object
    • settings.customCACertificates
      array of strings

      Additional Certification Authority (CA) certificates trusted by the module when connecting to HTTPS endpoints of an S3-compatible storage.

      Each list item must contain an X.509 certificate in PEM format. Invalid values are rejected by the validating webhook before the parameter is applied by the module.

      Use this parameter if the TLS certificate of the object storage is signed by a private or corporate Certification Authority that is not included in the module’s default trusted certificate bundle.

      Default: []

    • settings.dataNodes
      object
      Settings for CSI S3 on nodes where volumes can be mounted

      Default: {}

      • settings.dataNodes.nodeSelector
        object

        The same as in the Pods spec.nodeSelector parameter in Kubernetes.

        By default (kubernetes.io/os: linux), the csi-node DaemonSet runs on every Linux node. Override this to restrict CSI S3 to a subset of nodes. An empty object is rejected by the validating webhook to avoid accidentally matching every node in the cluster.

        Caution! Changing this parameter does not migrate existing mounts. If a node no longer matches the nodeSelector, volumes on that node will become inaccessible.

        Default: { "kubernetes.io/os": "linux" }

    • settings.logLevel
      string

      Sets log verbosity for the CSI S3 controller process.

      The verbosity of logging decreases from TRACE to ERROR: TRACE and DEBUG are intended for in-depth troubleshooting, INFO reflects normal operation, WARN highlights unusual but non-fatal situations, and ERROR records failures only.

      Default: DEBUG

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