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

HPENodeInfo

Scope: Cluster
Version: v1

apiVersion

string
APIVersion defines the versioned schema of this representation of an object.
kind

string
Kind is a string value representing the REST resource this object represents
spec

object
spec defines the desired characteristics of a HPE nodeinfo requested by a user.
- spec.iqns
  
  array of strings
  List of IQNs configured on the node.
- spec.networks
  
  array of strings
  Required value
  
  List of networks configured on the node.
- spec.uuid
  
  string
  Required value
  
  The UUID of the node.
- spec.wwpns
  
  array of strings
  List of WWPNs configured on the node.

HPEReplicationDeviceInfo

Scope: Cluster

v2 v1

hpeReplicationDeviceInfos

object of objects
List of HPE Replicated Device Information
- hpeReplicationDeviceInfos.targets
  
  object of objects
  List of Target Array Details
  - hpeReplicationDeviceInfos.targets.targetCpg
    
    string
    Target CPG of the array
  - hpeReplicationDeviceInfos.targets.targetMode
    
    string
    Replication Mode
  - hpeReplicationDeviceInfos.targets.targetName
    
    string
    Target Name of the array
  - hpeReplicationDeviceInfos.targets.targetSecret
    
    string
    Secret of the replicated array
  - hpeReplicationDeviceInfos.targets.targetSecretNamespace
    
    string
    Namespace of secret
  - hpeReplicationDeviceInfos.targets.targetSnapCpg
    
    string
    Target Snap CPG of the array

hpeReplicationDeviceInfos

object of objects
List of HPE Replicated Device Information
- hpeReplicationDeviceInfos.targets
  
  object of objects
  List of Target Array Details
  - hpeReplicationDeviceInfos.targets.targetCpg
    
    string
    Target CPG of the array
  - hpeReplicationDeviceInfos.targets.targetMode
    
    string
    Replication Mode
  - hpeReplicationDeviceInfos.targets.targetName
    
    string
    Target Name of the array
  - hpeReplicationDeviceInfos.targets.targetSecret
    
    string
    Secret of the replicated array
  - hpeReplicationDeviceInfos.targets.targetSecretNamespace
    
    string
    Namespace of secret
  - hpeReplicationDeviceInfos.targets.targetSnapCpg
    
    string
    Target Snap CPG of the array

HPEStorageClass

Scope: Cluster
Version: v1alpha1

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

spec

object
- spec.accessProtocol
  
  string
  Required value
  
  SAN access protocol.
  
  Allowed values: iscsi, fc
- spec.cpg
  
  string
  Name of the cpg.
  
  Minimal length: 1
- 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 HPEStorageConnection custom resource.
  
  Minimal length: 1

HPEStorageConnection

Scope: Cluster
Version: v1alpha1

HPE storage connection parameters.

spec

object
- spec.controlPlane
  
  object
  Required value
  
  Properties of control plane connection for HPE storage.
  - spec.controlPlane.backendAddress
    
    string
    HPE storage address
  - spec.controlPlane.password
    
    string
    HPE storage password, base64 encoded
  - spec.controlPlane.serviceName
    
    string
    HPE service name
  - spec.controlPlane.servicePort
    
    string
    HPE service port
  - spec.controlPlane.username
    
    string
    HPE storage username

HPEVolumeGroupInfo

Scope: Cluster

v2 v1

hpeVolumeGroupInfos

object of objects
List of HPE volume groups configured for 3PAR/Primera arrays.
- hpeVolumeGroupInfos.record
  
  object
  Metadata for the volume group
- hpeVolumeGroupInfos.snapshotGroups
  
  object of objects
  Snapshot groups that are linked to this volume group
  - hpeVolumeGroupInfos.snapshotGroups.id
    
    string
    ID of the snapshot group
  - hpeVolumeGroupInfos.snapshotGroups.name
    
    string
    Name of the snapshot group
- hpeVolumeGroupInfos.uuid
  
  string
  The UUID of the node.
- hpeVolumeGroupInfos.volumes
  
  object of objects
  Volumes that are members in this volume group
  - hpeVolumeGroupInfos.volumes.volumeId
    
    string
    ID of the member volume
  - hpeVolumeGroupInfos.volumes.volumeName
    
    string
    Name of the member volume

hpeVolumeGroupInfos

object of objects
List of HPE volume groups configured for 3PAR/Primera arrays.
- hpeVolumeGroupInfos.record
  
  object
  Metadata for the volume group
- hpeVolumeGroupInfos.snapshotGroups
  
  object of objects
  Snapshot groups that are linked to this volume group
  - hpeVolumeGroupInfos.snapshotGroups.id
    
    string
    ID of the snapshot group
  - hpeVolumeGroupInfos.snapshotGroups.name
    
    string
    Name of the snapshot group
- hpeVolumeGroupInfos.uuid
  
  string
  The UUID of the node.
- hpeVolumeGroupInfos.volumes
  
  object of objects
  Volumes that are members in this volume group
  - hpeVolumeGroupInfos.volumes.volumeId
    
    string
    ID of the member volume
  - hpeVolumeGroupInfos.volumes.volumeName
    
    string
    Name of the member volume

HPEVolumeInfo

Scope: Cluster

v2 v1

hpeVolumes

object of objects
List of HPE volumes configured for 3PAR/Primera arrays.
- hpeVolumes.record
  
  object
  Metadata for the volume
- hpeVolumes.uuid
  
  string
  The UUID of the node.

hpeVolumes

object of objects
List of HPE volumes configured for 3PAR/Primera arrays.
- hpeVolumes.record
  
  object
  Metadata for the volume
- hpeVolumes.uuid
  
  string
  The UUID of the node.

HPESnapshotGroupInfo

Scope: Cluster

v2 v1

hpeSnapshotGroupInfos

object of objects
List of HPE snapshot groups created for 3PAR/Primera arrays.
- hpeSnapshotGroupInfos.record
  
  object
  Metadata for the volume group
- hpeSnapshotGroupInfos.snapshotVolumes
  
  object of objects
  Snapshot volumes that are part of this snapshot group
  - hpeSnapshotGroupInfos.snapshotVolumes.snapshotId
    
    string
    Snapshot volume Id
  - hpeSnapshotGroupInfos.snapshotVolumes.snapshotName
    
    string
    Snapshot volume name
  - hpeSnapshotGroupInfos.snapshotVolumes.srcVolumeId
    
    string
    ID of the volume that is the source of this snapshot volume
  - hpeSnapshotGroupInfos.snapshotVolumes.srcVolumeName
    
    string
    Name of the volume that is the source of this snapshot volume
- hpeSnapshotGroupInfos.uuid
  
  string
  The UUID of the node.

hpeSnapshotGroupInfos

object of objects
List of HPE snapshot groups created for 3PAR/Primera arrays.
- hpeSnapshotGroupInfos.record
  
  object
  Metadata for the volume group
- hpeSnapshotGroupInfos.snapshotVolumes
  
  object of objects
  Snapshot volumes that are part of this snapshot group
  - hpeSnapshotGroupInfos.snapshotVolumes.snapshotId
    
    string
    Snapshot volume Id
  - hpeSnapshotGroupInfos.snapshotVolumes.snapshotName
    
    string
    Snapshot volume name
  - hpeSnapshotGroupInfos.snapshotVolumes.srcVolumeId
    
    string
    ID of the volume that is the source of this snapshot volume
  - hpeSnapshotGroupInfos.snapshotVolumes.srcVolumeName
    
    string
    Name of the volume that is the source of this snapshot volume
- hpeSnapshotGroupInfos.uuid
  
  string
  The UUID of the node.

SnapshotGroupClass

Scope: Cluster
Version: v1

SnapshotGroupClass specifies parameters that a underlying storage system uses when creating a volumegroup snapshot. A specific SnapshotGroupClass is used by specifying its name in a VolumeGroupSnapshot object. SnapshotGroupClasses are non-namespaced

apiVersion

string
APIVersion defines the versioned schema of this representation of an object.
deletionPolicy

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

Allowed values: Delete, Retain
kind

string
Kind is a string value representing the REST resource this object represents.
parameters

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

string
snapshotter is the name of the storage driver that handles this SnapshotGroupClass. Required.

SnapshotGroupContent

Scope: Cluster
Version: v1

SnapshotGroupContent represents the actual “on-disk” snapshotGroup object in the underlying storage system

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/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/api-conventions.md#types-kinds
spec

object
spec defines properties of a SnapshotGroupContent created by the underlying storage system. Required.
- spec.deletionPolicy
  
  string
  Required value
  
  deletionPolicy determines whether this SnapshotGroupContent and its physical snapshotgroup on the underlying storage system should be deleted when its bound SnapshotGroup is deleted. Supported values are “Retain” and “Delete”. “Retain” means that the SnapshotGroupContent and its physical snapshotGroup on underlying storage system are kept. “Delete” means that the SnapshotGroupContent and its physical snapshotGroup on underlying storage system are deleted. Required.
  
  Allowed values: Delete, Retain
- spec.snapshotGroupClassName
  
  string
  Required value
  
  name of the SnapshotGroupClass to which this snapshotGroup belongs.
- spec.snapshotGroupRef
  
  object
  snapshotGroupRef specifies the SnapshotGroup object to which this SnapshotGroupContent object is bound. SnapshotGroup.Spec.SnapshotGroupContentName field must reference to this SnapshotGroupContent’s name for the bidirectional binding to be valid. Required.
  - spec.snapshotGroupRef.apiVersion
    
    string
    API version of the referent.
  - spec.snapshotGroupRef.kind
    
    string
    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  - spec.snapshotGroupRef.name
    
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  - spec.snapshotGroupRef.namespace
    
    string
    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
  - spec.snapshotGroupRef.resourceVersion
    
    string
    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
  - spec.snapshotGroupRef.uid
    
    string
    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- spec.source
  
  object
  Required value
  
  source specifies from where a snapshotGroup will be created.Required.
  - spec.source.snapshotGroupHandle
    
    string
    snapshotGroupHandle specifies the snapshotGroup Id of a pre-existing snapshotGroup on the underlying storage system. This field is immutable.
- spec.volumeSnapshotContentNames
  
  array of strings
  list of volumeSnapshotContentNames associated with this snapshotGroups

SnapshotGroup

Scope: Namespaced
Version: v1

SnapshotGroup is a user’s request for creating a snapshotgroup

apiVersion

string
APIVersion defines the versioned schema of this representation of an object.
kind

string
Kind is a string value representing the REST resource this object represents
spec

object
spec defines the desired characteristics of a snapshotGroup requested by a user. Required.
- spec.snapshotGroupClassName
  
  string
  Required value
  
  snapshotGroupClassName is the name of the SnapshotGroupClass requested by the SnapshotGroup.
- spec.snapshotGroupContentName
  
  string
  snapshotGroupContentName is the name of the snapshotGroupContent the snapshotGroup is bound.
- spec.source
  
  object
  Required value
  
  source specifies where a snapshotGroup will be created. This field is immutable after creation. Required.
  - spec.source.apiGroup
    
    string
    apiGroup of the source. Current supported is storage.hpe.com
  - spec.source.kind
    
    string
    kind of the source (VolumeGroup) is the only supported one.
  - spec.source.name
    
    string
    name specifies the volumeGroupName of the VolumeGroup object in the same namespace as the SnapshotGroup object where the snapshotGroup should be dynamically taken from. This field is immutable.
- spec.volumeSnapshotClassName
  
  string
  Required value
  
  name of the volumeSnapshotClass to create pre-provisioned snapshots

VolumeGroupClass

Scope: Cluster
Version: v1

VolumeGroupClass specifies parameters that a underlying storage system uses when creating a volumegroup. A specific VolumeGroupClass is used by specifying its name in a VolumeGroup object. VolumeGroupClasses are non-namespaced

apiVersion

string
APIVersion defines the versioned schema of this representation of an object.
deletionPolicy

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

Allowed values: Delete, Retain
kind

string
Kind is a string value representing the REST resource this object represents.
parameters

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

string
provisioner is the name of the storage driver that handles this VolumeGroupClass. Required.

VolumeGroupContent

Scope: Cluster
Version: v1

VolumeGroupContent represents the actual “on-disk” volumeGroup object in the underlying storage system

apiVersion

string
APIVersion defines the versioned schema of this representation of an object.
kind

string
Kind is a string value representing the REST resource this object represents.
spec

object
spec defines properties of a VolumeGroupContent created by the underlying storage system. Required.
- spec.deletionPolicy
  
  string
  Required value
  
  deletionPolicy determines whether this VolumeGroupContent and its physical volumegroup on the underlying storage system should be deleted when its bound VolumeGroup is deleted. Supported values are “Retain” and “Delete”. “Retain” means that the VolumeGroupContent and its physical volumeGroup on underlying storage system are kept. “Delete” means that the VolumeGroupContent and its physical volumeGroup on underlying storage system are deleted. Required.
  
  Allowed values: Delete, Retain
- spec.source
  
  object
  Required value
  
  source specifies from where a volumeGroup will be created.Required.
  - spec.source.volumeGroupHandle
    
    string
    volumeGroupHandle specifies the volumeGroup Id of a pre-existing volumeGroup on the underlying storage system. This field is immutable.
- spec.volumeGroupClassName
  
  string
  Required value
  
  name of the VolumeGroupClass to which this volumeGroup belongs.
- spec.volumeGroupRef
  
  object
  volumeGroupRef specifies the VolumeGroup object to which this VolumeGroupContent object is bound. VolumeGroup.Spec.VolumeGroupContentName field must reference to this VolumeGroupContent’s name for the bidirectional binding to be valid. Required.
  - spec.volumeGroupRef.apiVersion
    
    string
    API version of the referent.
  - spec.volumeGroupRef.kind
    
    string
    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  - spec.volumeGroupRef.name
    
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  - spec.volumeGroupRef.namespace
    
    string
    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
  - spec.volumeGroupRef.resourceVersion
    
    string
    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
  - spec.volumeGroupRef.uid
    
    string
    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

VolumeGroup

Scope: Namespaced
Version: v1

VolumeGroup is a user’s request for creating a volumegroup

apiVersion

string
APIVersion defines the versioned schema of this representation of an object.
kind

string
Kind is a string value representing the REST resource this object represents
spec

object
spec defines the desired characteristics of a volumeGroup requested by a user. Required.
- spec.persistentVolumeClaimNames
  
  array of strings
  persistentVolumeClaimNames are the name of the PVC associated with this volumeGroup.
- spec.volumeGroupClassName
  
  string
  Required value
  
  name of the volumeGroupClassName to create volumeGroups
- spec.volumeGroupContentName
  
  string
  volumeGroupContentName is the name of the volumeGroupContent to which the volumeGroup is bound.