Skip to main content
Version: 3.2

GroupVolumeSnapshot CRD reference

GroupVolumeSnapshot represents a group snapshot.

GroupVolumeSnapshot

FieldDescriptionType
apiVersionAPIVersion 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
string
kindKind 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
string
specGroupVolumeSnapshotSpec represents the spec for a group snapshotobject
statusGroupVolumeSnapshotStatus is status for the group snapshotobject

spec fields

FieldDescriptionType
spec.maxRetriesMaxRetries is the number of times to retry the groupvolumesnapshot on failure. default: 0integer
spec.optionsOptions are pass-through parameters that are passed to the driver handling the group snapshotobject
spec.postExecRulePreExecRule is the name of rule applied after taking the snapshot. The rule needs to be
in the same namespace as the group volumesnapshot
string
spec.preExecRulePreExecRule is the name of rule applied before taking the snapshot. The rule needs to be
in the same namespace as the group volumesnapshot
string
spec.pvcSelectorPVCSelector selects the PVCs that are part of the group snapshotobject
spec.pvcSelector.matchExpressionsmatchExpressions is a list of label selector requirements. The requirements are ANDed.array
spec.pvcSelector.matchExpressions.keykey is the label key that the selector applies to.string
spec.pvcSelector.matchExpressions.operatoroperator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
string
spec.pvcSelector.matchExpressions.valuesvalues is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
array
spec.pvcSelector.matchLabelsmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
object
spec.restoreNamespacesRestoreNamespaces is a list of namespaces to which the snapshots can be restored toarray

status fields

FieldDescriptionType
status.stageGroupVolumeSnapshotStageType is the stage of the group snapshotstring
status.statusGroupVolumeSnapshotStatusType is types of statuses of a group snapshot operationstring
status.volumeSnapshots.conditions.lastTransitionTimeThe last time the condition transitioned from one status to another.string
status.volumeSnapshots.conditions.messageA human readable message indicating details about the transition.string
status.volumeSnapshots.conditions.reasonThe reason for the condition's last transition.string
status.volumeSnapshots.conditions.statusStatus of the condition, one of True, False, Unknown.string
status.volumeSnapshots.conditions.typeType of replication controller condition.string
status.volumeSnapshots.dataSourceVolumeSnapshotDataSource represents the actual location and type of the snapshot. Only one of its members may be specified.object
status.volumeSnapshots.dataSource.awsElasticBlockStoreAWSElasticBlockStoreVolumeSnapshotSource is AWS EBS volume snapshot sourceobject
status.volumeSnapshots.dataSource.awsElasticBlockStore.fsTypeOriginal volume file system type. The volume created from the snapshot would be pre-formatted
using the same file system, so it has to be saved along with the AWS snapshot ID
string
status.volumeSnapshots.dataSource.awsElasticBlockStore.snapshotIdUnique id of the persistent disk snapshot resource. Used to identify the disk snapshot in AWSstring
status.volumeSnapshots.dataSource.cinderVolumeCinderVolumeSnapshotSource represents Cinder snapshot resourceobject
status.volumeSnapshots.dataSource.cinderVolume.snapshotIdUnique id of the cinder volume snapshot resource. Used to identify the snapshot in OpenStackstring
status.volumeSnapshots.dataSource.gcePersistentDiskGCEPersistentDiskSnapshotSource represents an GCE PD snapshot resourceobject
status.volumeSnapshots.dataSource.gcePersistentDisk.snapshotIdUnique id of the persistent disk snapshot resource. Used to identify the disk snapshot in GCEstring
status.volumeSnapshots.dataSource.glusterSnapshotVolumeAWSElasticBlockStore represents an AWS Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
GlusterSnapshotSource represents a gluster snapshot resource
object
status.volumeSnapshots.dataSource.glusterSnapshotVolume.snapshotIdUniqueID represents a snapshot resource.string
status.volumeSnapshots.dataSource.hostPathHostPath represents a directory on the host.
Provisioned by a developer or tester.
This is useful for single-node development and testing only!
On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster.
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
object
status.volumeSnapshots.dataSource.hostPath.snapshotPath represents a tar file that stores the HostPath volume sourcestring
status.volumeSnapshots.dataSource.portworxVolumePortworxVolumeSnapshotSource represents Portworx snapshot resourceobject
status.volumeSnapshots.dataSource.portworxVolume.snapshotCloudCredIDSnapshotCloudCredID is an optional credentials ID for the snapshot. This is used for cloud snaps.string
status.volumeSnapshots.dataSource.portworxVolume.snapshotDataSnapshotData stores the name of VolumeSnapshotData for this snapshot. This is populated only for group snapshots.string
status.volumeSnapshots.dataSource.portworxVolume.snapshotIdUnique id of the Portworx snapshot.string
status.volumeSnapshots.dataSource.portworxVolume.snapshotTaskIDSnapshotTaskID stores the task ID used for the snapshotstring
status.volumeSnapshots.dataSource.portworxVolume.snapshotTypeSnapshotType is the type of the snapshotstring
status.volumeSnapshots.dataSource.portworxVolume.volumeProvisionerVolumeProvisioner is either the intree or CSI driver namestring