NFSStorageClass

Scope: Cluster
Version: v1alpha1

NFSStorageClass is a Kubernetes Custom Resource that defines a configuration for a Kubernetes StorageClass.
  • 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

      Defines a Kubernetes StorageClass configuration.
      • spec.connection.host
        string

        Required value

        NFS server host.

        Minimal length: 1

      • spec.connection.mtls
        boolean

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

        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

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

        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
        NFS retries before fail.

        Allowed values: 1 <= X

      • spec.mountOptions.timeout
        integer
        NFS server timeout.

        Allowed values: 1 <= X

    • spec.reclaimPolicy
      string

      Required value

      The StorageClass’s reclaim policy. Might be:

      • Delete (If the Persistent Volume Claim is deleted, deletes the Persistent Volume and its associated storage as well);
      • Retain (If the Persistent Volume Claim is deleted, remains the Persistent Volume and its associated storage).

      Allowed values: Delete, Retain

    • spec.volumeBindingMode
      string

      Required value

      The StorageClass’s volume binding mode. Might be Immediate or WaitForFirstConsumer.

      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. By default, the NFS CSI driver simply deletes the directory created for the Persistent Volume (PV) on the NFS server without performing any data cleanup. When volumeCleanup is enabled, the driver will erase each file in the PV directory.

      Valid options are:

      • 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.