The csi-scsi-generic module: Custom Resources

The module is available only in Deckhouse Enterprise Edition.

The functionality of the module might significantly change. Compatibility with future versions is not guaranteed.

SCSIDevice

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

SCSIStorageClass

Scope: Cluster
Version: v1alpha1

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

spec

object
Defines a Kubernetes Storage class 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.
  - 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

SCSITarget

Scope: Cluster
Version: v1alpha1

SCSITarget defines the configuration for a single iSCSI or Fibre Channel target resource.

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