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

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

NFSStorageClass

Scope: Cluster
Version: v1alpha1

Interface for managing StorageClass for the nfs.csi.k8s.io CSI driver.

Manual creation of StorageClass for this driver is prohibited.

  • spec
    object
    Defines a Kubernetes StorageClass configuration.
    • spec.chmodPermissions
      string
      chmod rights for PVs subdirectory.

      Pattern: ^[0-7]{3,4}$

    • spec.connection
      object

      Required value

      NFS server connection settings.
      • spec.connection.host
        string

        Required value

        NFS server host.

        Minimal length: 1

      • spec.connection.mtls
        boolean

        Available in SE, SE+, EE, and FE editions.

        Whether to use mTLS — requires TLS to be enabled.

        Default: false

      • spec.connection.nfsVersion
        string

        Required value

        NFS version.

        Allowed values: 3, 4.1, 4.2

      • spec.connection.share
        string

        Required value

        NFS server share path.

        Minimal length: 1

      • spec.connection.tls
        boolean

        Available in SE, SE+, EE, and FE editions.

        Whether to use TLS for connection.

        Default: false

    • spec.mountOptions
      object
      StorageClass mount options.
      • spec.mountOptions.mountMode
        string
        NFS share mount mode.

        Allowed values: hard, soft

      • spec.mountOptions.readOnly
        boolean
        Share read-only flag.
      • spec.mountOptions.retransmissions
        integer
        The number of repeated attempts by the NFS client to execute the request before it takes further steps to restore the connection.

        Allowed values: 1 <= X

      • spec.mountOptions.timeout
        integer

        The time during which the NFS client waits for a response before repeating the NFS request, in tenths of a second.

        For example, 600 is 60 seconds.

        Allowed values: 1 <= X

    • spec.reclaimPolicy
      string

      Required value

      Defines the behavior when a PersistentVolumeClaim (PVC) is deleted.

      Allowed values:

      • Delete — when the PVC is deleted, the associated PersistentVolume (PV) and corresponding data on the NFS server are also deleted;
      • Retain — when the PVC is deleted, the associated PersistentVolume and data on the NFS server are not deleted and require manual removal by the user. See more in the Kubernetes documentation.

      Allowed values: Delete, Retain

    • spec.volumeBindingMode
      string

      Required value

      Defines the volume binding mode.

      Allowed values:

      • Immediate — the volume is provisioned immediately after the PersistentVolumeClaim (PVC) is created;
      • WaitForFirstConsumer — the volume is provisioned only when the PVC is first used by a pod. See more in the Kubernetes documentation.

      Allowed values: Immediate, WaitForFirstConsumer

    • spec.volumeCleanup
      string

      This feature is available in Enterprise Edition.

      Specifies the cleanup method to be applied to the PV’s subdirectory content before deletion.

      If the parameter is omitted, the NFS CSI driver deletes the directory created for the Persistent Volume (PV) on the NFS server without performing any data cleanup. If the parameter is set, the driver erases each file in the PV directory.

      Allowed values:

      • Discard — uses the filesystem’s discard (trim) functionality to free data blocks (this option is available only when supported, for example with NFSv4.2);
      • RandomFillSinglePass — overwrites the content of each file once with random data before deletion. This is implemented by invoking the utility shred;
      • RandomFillThreePass — overwrites the content of each file three times with random data before deletion. This is implemented by invoking the utility shred.

      Allowed values: Discard, RandomFillSinglePass, RandomFillThreePass

    • spec.workloadNodes
      object
      • spec.workloadNodes.nodeSelector
        object

        Node selector to specify rules for selecting nodes where Persistent Volumes (PVs) created by this StorageClass are allowed to connect.

        Combines simple label matches and advanced matching expressions.

        If this parameter is omitted, NFS shares can be mounted on any node in the cluster running the Linux OS.

        • spec.workloadNodes.nodeSelector.matchExpressions
          array of objects

          A list of advanced node selector requirements.

          Each requirement specifies a key, an operator, and optional values for filtering nodes based on their labels or other fields.

          • spec.workloadNodes.nodeSelector.matchExpressions.key
            string
          • spec.workloadNodes.nodeSelector.matchExpressions.operator
            string

            Allowed values: In, NotIn, Exists, DoesNotExist

          • spec.workloadNodes.nodeSelector.matchExpressions.values
            array of strings
        • spec.workloadNodes.nodeSelector.matchLabels
          object

          A map of labels that must match exactly with the labels of a node.

          Nodes that do not match any of the specified labels will be excluded.

  • status
    object
    Displays current information about the StorageClass.
    • status.phase
      string

      The StorageClass current state.

      Possible values:

      • Failed — the controller received incorrect resource configuration or some errors occurred during the operation;
      • Created — the StorageClass was created successfully.

      Allowed values: Failed, Created

    • status.reason
      string
      Additional information about the current state of the StorageClass.