The ceph-csi module: Custom Resources

CephCSIDriver

Scope: Cluster
Version: v1alpha1

Ceph cluster connection parameters and StorageClasses configuration.

• spec

  object

  Required value

  • spec.cephfs

    object
    • spec.cephfs.storageClasses

      array of objects

      CephFS StorageClasses.

      • spec.cephfs.storageClasses.allowVolumeExpansion

        boolean

        Allows the users to resize the volume by editing the corresponding PVC object.

        Default: true

      • spec.cephfs.storageClasses.fsName

        string

        Required value

        CephFS filesystem name.

      • spec.cephfs.storageClasses.mountOptions

        array of strings

        List of mount options.

      • spec.cephfs.storageClasses.namePostfix

        string

        Required value

        Part of the StorageClass name after -.

        The name from the CustomResource CephCSIDriver is used as the first part.

      • spec.cephfs.storageClasses.pool

        string

        Ceph pool name into which volume data shall be stored.

      • spec.cephfs.storageClasses.reclaimPolicy

        string

        The reclaim policy for a Persistent Volume.

        Default: "Retain"

        Allowed values: Delete, Retain

    • spec.cephfs.subvolumeGroup

      string

      CephFS subvolume group name.

  • spec.clusterID

    string

    Required value

    Ceph cluster FSID/UUID.

    Use ceph fsid to get Ceph cluster FSID/UUID.

  • spec.monitors

    array of strings

    Required value

    List of ceph-mon IP addresses in the format 10.0.0.10:6789.

  • spec.rbd

    object
    • spec.rbd.storageClasses

      array of objects

      Description of StorageClasses for Rados Block Device (RBD).

      • spec.rbd.storageClasses.allowVolumeExpansion

        boolean

        Allows the users to resize the volume by editing the corresponding PVC object.

        More info…

        Default: true

      • spec.rbd.storageClasses.defaultFSType

        string

        Default fstype.

        Default: "ext4"

        Allowed values: ext4, xfs

      • spec.rbd.storageClasses.mountOptions

        array of strings

        List of mount options.

      • spec.rbd.storageClasses.namePostfix

        string

        Required value

        Part of the StorageClass name after -.

        The name from the CustomResource CephCSIDriver is used as the first part.

      • spec.rbd.storageClasses.pool

        string

        Ceph pool into which the RBD image shall be created.

      • spec.rbd.storageClasses.reclaimPolicy

        string

        The reclaim policy for a Persistent Volume.

        More info…

        Default: "Retain"

        Allowed values: Delete, Retain

  • spec.userID

    string

    Required value

    Username without client..

  • spec.userKey

    string

    Required value

    Ceph auth key corresponding to the userID.