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-nfs 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-nfs

  • Using ModuleConfig csi-nfs.

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

    Example of a manifest to enable module csi-nfs:

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

    d8 k edit mc csi-nfs

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

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: csi-nfs
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.logLevel
      string
      Module log level.

      Default: DEBUG

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

    • settings.storageClassLabelIgnoredPrefixes
      array of strings

      List of label-key prefixes that MUST NOT be propagated from an NFSStorageClass to the managed Kubernetes StorageClass.

      The controller treats this list as a complement to a built-in (system) list and drops any NFSStorageClass label whose key starts with any prefix from either list.

      The defaults cover labels typically added by GitOps tooling (Argo CD, Flux, Rancher Fleet) so that their reconcilers do not fight the storage controller over labels on the managed StorageClass.

      Default: [ "argocd.argoproj.io/", "kustomize.toolkit.fluxcd.io/", "helm.toolkit.fluxcd.io/", "fleet.cattle.op/" ]

    • settings.tlsParameters
      object

      This feature is available in SE, SE+, EE, and FE.

      RPC-with-TLS (RFC 9289) configuration.

      Default: {}

      • settings.tlsParameters.ca
        string
        Root certificate in PEM format, encoded in Base64, which can be used to verify the NFS server certificate.

        Pattern: ^[A-Za-z0-9+/]*={0,2}$

      • settings.tlsParameters.mtls
        object
        Configuration of the client certificate verification mode by the NFS server.

        Default: {}

        • settings.tlsParameters.mtls.clientCert
          string
          Client certificate in PEM format, encoded in Base64.

          Pattern: ^[A-Za-z0-9+/]*={0,2}$

        • settings.tlsParameters.mtls.clientKey
          string
          Client key in PEM format, encoded in Base64.

          Pattern: ^[A-Za-z0-9+/]*={0,2}$

    • settings.v3support
      boolean
      NFS version v3 support. After enabling this setting, rpcbind package will be installed on nodes. When this setting is disabled, it will NOT be removed from the nodes.

      Default: false