The csi-huawei 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.

VolumeSnapshotClass

Scope: Cluster

v1 v1beta1

VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced

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
deletionPolicy

string
deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are “Retain” and “Delete”. “Retain” means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. “Delete” means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required.

Allowed values: Delete, Retain
driver

string
driver is the name of the storage driver that handles this VolumeSnapshotClass. Required.
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
parameters

object
parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes.

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
deletionPolicy

string
deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are “Retain” and “Delete”. “Retain” means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. “Delete” means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required.

Allowed values: Delete, Retain
driver

string
driver is the name of the storage driver that handles this VolumeSnapshotClass. Required.
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
parameters

object
parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes.

HuaweiStorageClass

Scope: Cluster
Version: v1alpha1

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

spec

object
- spec.fsType
  
  string
  Required value
  The filesystem type of the storage class. Might be:
  - xfs
  - ext4
  Allowed values: xfs, ext4
- spec.pool
  
  string
  Required value
  
  Name of the pool.
  
  Minimal length: 1
- 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.storageConnectionName
  
  string
  Required value
  
  Name of the HuaweiStorageConnection custom resource.
  
  Minimal length: 1
- spec.volumeBindingMode
  
  string
  Required value
  
  Volume binding mode.
  
  Allowed values: WaitForFirstConsumer, Immediate

HuaweiStorageConnection

Scope: Cluster
Version: v1alpha1

Huawei storage connection parameters.

spec

object
- spec.login
  
  string
  Required value
- spec.maxClientThreads
  
  integer
  Required value
- spec.password
  
  string
  Required value
- spec.pools
  
  array of strings
  Required value
- spec.portals
  
  array of strings
- spec.protocol
  
  string
  Required value
  
  Allowed values: ISCSI, FC, ROCE, FC-NVME, NFS, DPC, SCSI
- spec.storageType
  
  string
  Required value
  
  Allowed values: OceanStorSAN, OceanStorNAS, OceanStorDtree, FusionStorageSAN, FusionStorageNAS
- spec.urls
  
  array of strings
  Required value

ResourceTopology

Scope: Cluster
Version: v1

ResourceTopology is the Schema for the ResourceTopologys 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
- spec.provisioner
  
  string
  Required value
  
  Provisioner is the volume provisioner name
- spec.tags
  
  array of objects
  Required value
  
  Tags defines pv and other relationships and ownership
  - spec.tags.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
  - spec.tags.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
  - spec.tags.name
    
    string
    Name is the name of the resource
  - spec.tags.namespace
    
    string
    NameSpace is the namespace of the resource
  - spec.tags.owner
    
    object
    Owner defines who does the resource belongs to
    - spec.tags.owner.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
    - spec.tags.owner.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
    - spec.tags.owner.name
      
      string
      Name is the name of the resource
    - spec.tags.owner.namespace
      
      string
      NameSpace is the namespace of the resource
- spec.volumeHandle
  
  string
  Required value
  
  VolumeHandle is the backend name and identity of the volume, format as .

StorageBackendClaim

Scope: Namespaced
Version: v1

StorageBackendClaim is the Schema for the storageBackends 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
- metadata.name
  
  string
  
  Maximum length: 63
spec

object
StorageBackendClaimSpec defines the desired state of StorageBackend
- spec.certSecret
  
  string
  CertSecret is the name of the secret that holds the certificate
- spec.configmapMeta
  
  string
  ConfigMapMeta used to config the storage management info, the format is /.
- spec.maxClientThreads
  
  string
  maxClientThreads is used to limit the number of storage client request connections
- spec.parameters
  
  object
  User defined parameter for extension
- spec.provider
  
  string
  Required value
  
  Provider is required in storageBackend, used to filter the provider to add backend
- spec.secretMeta
  
  string
  SecretMeta used to config the storage sensitive info, the format is /.
- spec.useCert
  
  boolean
  UseCert is used to decide whether to use the certificate
  
  Default: false

StorageBackendContent

Scope: Cluster
Version: v1

StorageBackendContent is the Schema for the StorageBackendContents 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
StorageBackendContentSpec defines the desired state of StorageBackendContent
- spec.backendClaim
  
  string
  BackendClaim is the bound StorageBackendClaim namespace and name, format is /.
- spec.certSecret
  
  string
  CertSecret is the name of the secret that holds the certificate
- spec.configmapMeta
  
  string
  ConfigmapMeta is current storage configmap namespace and name, format is /. such as xuanwu/backup-instance-configmap
- spec.maxClientThreads
  
  string
  maxClientThreads is used to limit the number of storage client request connections
- spec.parameters
  
  object
  User defined parameter for extension
- spec.provider
  
  string
  Required value
  
  Provider is required in StorageBackendContent, used to filter the provider to add backend
- spec.secretMeta
  
  string
  SecretMeta is current storage secret namespace and name, format is /. such as xuanwu/backup-instance-secret
- spec.useCert
  
  boolean
  UseCert is used to decide whether to use the certificate
  
  Default: false