The module lifecycle stage: Preview
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.

PendingResizeRequest

Short names: prr

Scope: Namespaced
Version: v1alpha1

PendingResizeRequest is the Schema for the pendingresizerequests API
  • apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    object
  • spec
    object
    PendingResizeRequestSpec defines the desired state of PendingResizeRequest
    • spec.pvcName
      string

      Required value

      PVCName is the name of the PVC for which the resize is requested.
    • spec.requestedSize
      string

      Required value

      RequestedSize is the new requested size for the PVC. Represented as a string compatible with resource.Quantity.
    • spec.scsiTargets
      array of objects
      SCSITargets represents multiple SCSI targets associated with the device.
      • spec.scsiTargets.fibreChannel
        object
        FibreChannel contains Fibre Channel-specific configuration if applicable.
        • spec.scsiTargets.fibreChannel.WWNs
          array of strings

          Required value

          WWNs is a list of World Wide Names for the Fibre Channel target.
      • spec.scsiTargets.iscsi
        object
        ISCSI contains iSCSI-specific configuration if applicable.
        • spec.scsiTargets.iscsi.auth
          object
          Auth specifies authentication details for accessing the iSCSI target.
          • spec.scsiTargets.iscsi.auth.login
            string

            Required value

            Login is the username used for authentication with the iSCSI target.
          • spec.scsiTargets.iscsi.auth.password
            string

            Required value

            Password is the password used for authentication with the iSCSI target.
        • spec.scsiTargets.iscsi.iqn
          string

          Required value

          IQN is the iSCSI Qualified Name of the target.
        • spec.scsiTargets.iscsi.portals
          array of strings

          Required value

          Portals is a list of portal addresses (IP:port) for accessing the iSCSI target.
      • spec.scsiTargets.lun
        integer
        LUN is the Logical Unit Number for the target.
      • spec.scsiTargets.name
        string
        Name is a human-readable name for the target.
      • spec.scsiTargets.size
        integer or string
        Size is the size of the target as a Quantity (e.g., “1Gi”).

        Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

      • spec.scsiTargets.status
        string
        Status is the current state of the target (e.g., Bound, Available, Failed).
    • spec.wwid
      string

      Required value

      WWID is the World Wide Identifier of the SCSI device. This uniquely identifies the device.

SCSIDevice

Short names: scdev

Scope: Cluster
Version: v1alpha1

SCSIDevice defines the configuration for a single SCSI device. This object is used to manage SCSI devices and their associated storage on Kubernetes nodes.
  • apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    object
  • status
    object
    Status represents the current observed state of the SCSI device.
    • status.conditions
      array of objects
      Conditions represents the latest observed state of the device. The list is keyed by condition type: the controller owns Ready, the CSI controller service owns Reserved and CleanupInProgress, and the node plugin owns Attached, Mounted and Error.
      • status.conditions.lastTransitionTime
        string
        lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
      • status.conditions.message
        string
        message is a human readable message indicating details about the transition. This may be an empty string.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

        Length: 1..1024

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

      • status.conditions.status
        string
        status of the condition, one of True, False, Unknown.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        type of condition in CamelCase or in foo.example.com/CamelCase.

        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.nodeName
      string
      NodeName is the name of the Kubernetes node where the SCSI device is located.
    • status.observedGeneration
      integer

      ObservedGeneration is the most recent metadata.generation the SCSIDevice controller has 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.

      Only the SCSIDevice controller sets it. The CSI controller service and the node plugin write conditions of their own onto this status, but they react to volume operations rather than to the spec, so they have no generation to report.

    • status.path
      string
      Path is the device’s filesystem path.
    • status.phase
      string

      Required value

      Phase indicates the current lifecycle phase of the device.
    • status.pvName
      string
      PersistentVolumeName is the name of the PersistentVolume associated with the SCSI device.
    • status.scsiTargets
      array of objects
      SCSITargets represents multiple SCSI targets associated with the device.
      • status.scsiTargets.lun
        integer
        LUN is the Logical Unit Number for the target.
      • status.scsiTargets.name
        string
        Name is the name of the SCSI target.
      • status.scsiTargets.size
        integer or string
        Size is the size of the target in a human-readable format (e.g., “1Gi”).

        Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

      • status.scsiTargets.status
        string
        Status is the current state of the target (e.g., Bound, Available, Failed).
    • status.size
      integer or string

      Required value

      Size is the size of the SCSI device. The size should be represented as a Quantity (e.g., “10Gi” for 10 GiB).

      Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

    • status.wwid
      string

      Required value

      WWID is the World Wide Identifier of the SCSI device. This uniquely identifies the device.

SCSIStorageClass

Short names: scsc

Scope: Cluster
Version: v1alpha1

SCSIStorageClass is a Kubernetes Custom Resource that defines a configuration for a Kubernetes StorageClass.
  • spec
    object
    Defines a Kubernetes StorageClass configuration.
    • spec.reclaimPolicy
      string

      Required value

      Reclaim policy defines the policy for reclaiming the SCSI device when the PersistentVolume is deleted.

      Allowed values: Delete, Retain

    • spec.scsiDeviceSelector
      object

      Required value

      Selector for choosing SCSIDevice resources to be used for PV provisioning by the CSI driver. Only SCSIDevice objects that satisfy the criteria defined below will be eligible for selection by the CSI driver for this StorageClass.
      • spec.scsiDeviceSelector.matchExpressions
        array of objects
        An array of label selector requirements. Each requirement specifies a key, an operator, and an optional list of values. An SCSIDevice must meet these conditions to be selected.
        • spec.scsiDeviceSelector.matchExpressions.key
          string
          The label key that the selector applies to.
        • spec.scsiDeviceSelector.matchExpressions.operator
          string
          The operator to apply for the key.

          Allowed values: In, NotIn, Exists, DoesNotExist

        • spec.scsiDeviceSelector.matchExpressions.values
          array of strings
          A list of string values. Required for operators such as In or NotIn, and ignored for Exists or DoesNotExist.
      • spec.scsiDeviceSelector.matchLabels
        object
        A map of key-value pairs that must exactly match the labels on a SCSIDevice. Devices that do not have all of the specified labels with the exact values will be excluded.
    • spec.volumeCleanup
      string

      VolumeCleanup defines the policy for cleaning up the SCSI device when the PersistentVolume is deleted. If ommited, no cleanup will be performed.

      Possible values:

      • Discard: Sends a SCSI TRIM or discard command to the device, marking the blocks as free without necessarily overwriting the data. This option is typically faster but may not securely erase data.

      • RandomFillSinglePass: Overwrites the entire device with random data in a single pass. This option is not recommended for solid-state drives, as it reduces the lifespan of the drive.

      • RandomFillThreePass: Overwrites the device with random data in three separate passes. This option is not recommended for solid-state drives, as it reduces the lifespan of the drive.

      Allowed values: Discard, RandomFillSinglePass, RandomFillThreePass

  • status
    object
    Displays current information about the StorageClass.
    • 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 is in place, False when a reconcile pass failed, and Unknown before the controller has observed the resource.

        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 StorageClass current state.

      Possible values:

      • Failed: If the controller received incorrect resource configuration or some errors occurred during the operation).
      • Create: If everything went fine.

      Allowed values: Failed, Created

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

SCSITarget

Short names: sctgt

Scope: Cluster
Version: v1alpha1

SCSITarget is a Kubernetes Custom Resource that defines a configuration for a SCSI target.
  • spec
    object
    Spec defines the desired state of the target.
    • spec.deviceTemplate
      object
      DeviceTemplate defines the metadata for dynamically created devices.
      • spec.deviceTemplate.metadata
        object
        Metadata specifies the metadata to be applied to devices.
        • spec.deviceTemplate.metadata.labels
          object
          Labels are key-value pairs that may be used to select devices.
    • spec.fibreChannel
      object
      FibreChannel defines the configuration for a Fibre Channel target.
      • spec.fibreChannel.WWNs
        array of strings

        Required value

        WWNs is a list of World Wide Names for the Fibre Channel target.
    • spec.iSCSI
      object
      iSCSI defines the configuration for an iSCSI target.
      • spec.iSCSI.auth
        object
        Auth specifies authentication details for accessing the iSCSI target.
        • spec.iSCSI.auth.login
          string

          Required value

          Login is the username used for authentication with the iSCSI target.
        • spec.iSCSI.auth.password
          string

          Required value

          Password is the password used for authentication with the iSCSI target.
      • spec.iSCSI.iqn
        string

        Required value

        IQN is the iSCSI Qualified Name of the target.
      • spec.iSCSI.portals
        array of strings

        Required value

        Portals is a list of portal addresses (IP:port) for accessing the iSCSI target.
  • status
    object
    Status represents the observed state of the target.
    • 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 target has been discovered and its devices reconciled, False when discovery failed, and Unknown before the controller has observed the resource.

        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.