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.

CephClusterAuthentication

Scope: Cluster
Version: v1alpha1

Ceph cluster authentication parameters.
  • spec
    object
    • spec.userID
      string

      Required value

      Username without client..
    • spec.userKey
      string

      Required value

      Ceph auth key corresponding to the userID.
  • status
    object
    Displays current information about the resources managed by the CephClusterAuthentication custom resource.
    • status.conditions
      array of objects

      The latest observations of the resource state. Condition type: Deprecated.

      No Ready condition is published: the controller does not reconcile this resource towards a desired state, it only marks it as superseded by CephClusterConnection.

      • status.conditions.lastTransitionTime
        string
        Timestamp of the last status transition for this condition.
      • status.conditions.message
        string
        Human-readable explanation of the current status.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        The value of metadata.generation this condition was set against.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        Machine-readable reason for the current status, suitable for log filtering and alerting.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        Current status of the condition.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Condition type. Deprecated is True for every CephClusterAuthentication: the kind is superseded by CephClusterConnection, which carries the authentication fields itself.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.observedGeneration
      integer
      The value of metadata.generation the controller has last acted on.
    • status.phase
      string
      Not published for this resource kind. This resource is deprecated and the controller does not reconcile it towards a desired state, so there is no phase to report — see the Deprecated condition instead. The field is retained for compatibility.

      Allowed values: Failed, Created

    • status.reason
      string
      Additional information about the resources managed by the CephClusterAuthentication custom resource.

CephClusterConnection

Scope: Cluster
Version: v1alpha1

Ceph cluster connection parameters.
  • spec
    object
    • spec.cephFS
      object
      CephFS specific parameters (Cluster wide).
      • spec.cephFS.subvolumeGroup
        string
        CephFS subvolume group name.

        Minimal length: 1

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

      Required value

      Ceph user name.
    • spec.userKey
      string

      Required value

      Ceph user key.

      Minimal length: 1

  • status
    object
    Displays current information about the resources managed by the CephClusterConnection custom resource.
    • status.conditions
      array of objects
      The latest observations of the resource state. Condition type: Ready.
      • status.conditions.lastTransitionTime
        string
        Timestamp of the last status transition for this condition. It is not bumped when only the reason or the message changes.
      • status.conditions.message
        string
        Human-readable explanation of the current status.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        The value of metadata.generation this condition was set against.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        Machine-readable reason for the current status, suitable for log filtering and alerting.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        Current status of the condition.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Condition type. Ready is True once the secret and the CSI ConfigMap entry are in place and False when a reconcile pass failed. The condition is absent until the controller has processed the resource for the first time.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.observedGeneration
      integer
      The value of metadata.generation the controller has last acted on. When it trails metadata.generation, the controller has not yet processed the latest spec, and the conditions below still describe the previous one.
    • status.phase
      string

      The current state of resources managed by the CephClusterConnection custom resource. Might be:

      • Failed (if the controller received incorrect resource configuration or some errors occurred during the operation)
      • Created (if everything went fine)

      Allowed values: Failed, Created

    • status.reason
      string
      Additional information about the resources managed by the CephClusterConnection custom resource.

CephMetadataBackup

Short names: cephmdb

Scope: Cluster
Version: v1alpha1

CephMetadataBackup is a Kubernetes custom resource that stores backup of Kubernetes resources.
  • spec
    object
    • spec.data
      string
      Data is a base64 encoded Kubernetes resource.

CephStorageClass

Scope: Cluster
Version: v1alpha1

CephStorageClass is a Kubernetes Custom Resource that defines a configuration for a Kubernetes Storage class.
  • spec
    object
    • spec.cephFS
      object
      CephFS specific parameters.
      • spec.cephFS.fsName
        string
        Name of the CephFS file system.
    • spec.clusterAuthenticationName
      string
      Name of the CephClusterAuthentication custom resource.

      Minimal length: 1

    • spec.clusterConnectionName
      string

      Required value

      Name of the CephClusterConnection custom resource.

      Minimal length: 1

    • spec.rbd
      object
      Rados Block Device specific parameters.
      • spec.rbd.defaultFSType
        string
        Default file system type for the Rados Block Device.

        Default: ext4

      • spec.rbd.pool
        string
        Name of the RBD pool.
    • spec.reclaimPolicy
      string

      Required value

      The storage class’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.type
      string

      Required value

      The type of the storage class. Might be:

      • CephFS
      • RBD (Rados Block Device)

      Allowed values: CephFS, RBD

  • status
    object
    Displays current information about the Storage Class.
    • status.conditions
      array of objects
      The latest observations of the resource state. Condition type: Ready.
      • status.conditions.lastTransitionTime
        string
        Timestamp of the last status transition for this condition. It is not bumped when only the reason or the message changes.
      • status.conditions.message
        string
        Human-readable explanation of the current status.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        The value of metadata.generation this condition was set against.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        Machine-readable reason for the current status, suitable for log filtering and alerting.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        Current status of the condition.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Condition type. Ready is True once the StorageClass and the VolumeSnapshotClass are in place and False when a reconcile pass failed. The condition is absent until the controller has processed the resource for the first time.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.observedGeneration
      integer
      The value of metadata.generation the controller has last acted on. When it trails metadata.generation, the controller has not yet processed the latest spec, and the conditions below still describe the previous one.
    • status.phase
      string

      The Storage class current state. Might be:

      • Failed (if the controller received incorrect resource configuration or some errors occurred during the operation)
      • Created (if everything went fine)

      Allowed values: Failed, Created

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