LocalStorageClass

Scope: Cluster
Version: v1alpha1

LocalStorageClass is a Kubernetes Custom Resource that defines a configuration for a Kubernetes Storage class.

  • spec
    object

    Required value

    Defines a Kubernetes Storage class configuration.

    • spec.fsType
      string

      The storage class’s file system type.

      Default: "ext4"

      Allowed values: ext4, xfs

    • spec.lvm
      object

      Required value

      The field provides a LVM configuration.

      • spec.lvm.lvmVolumeGroups
        array of objects

        Required value

        LVMVolumeGroup resources where Persistent Volume will be create on.

        • spec.lvm.lvmVolumeGroups.name
          string

          Required value

          The LVMVolumeGroup resource’s name.

        • spec.lvm.lvmVolumeGroups.thin
          object

          Thin pool in a LVMVolumeGroup resource.

          • spec.lvm.lvmVolumeGroups.thin.poolName
            string

            Required value

            The name of the thin pool.

            Pattern: ^.*$

      • spec.lvm.thick
        object

        Settings for Logical Volumes in a LVMVolumeGroup resource.

        • spec.lvm.thick.contiguous
          boolean

          If true, the Logical Volume will be created with the contiguous flag. Note: This flag should be used with caution because it may lead to poor scheduling of pods using the Persistent Volume. Our scheduler checks the free space in VG and selects nodes with the most free space for pods. However, it cannot determine the maximum amount of sequential free space available. Consequently, there may be situations where a pod is scheduled to a node, but the volume cannot be created due to insufficient contiguous free space. If such a situation arises, manual intervention will be required.

      • spec.lvm.type
        string

        Required value

        The provisioning type of the LVM Logical Volumes (LV) created for Persistent Volumes (PV).

        Allowed values: Thick, Thin

    • spec.reclaimPolicy
      string

      Required value

      The storage class’s reclaim policy:

      • 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 Storage class’s binding mode:

      • Immediate — creates a PV as a PVC requested;
      • WaitForFirstConsumer — creates a PV after a Pod consumes PVC.

      Allowed values: Immediate, WaitForFirstConsumer