Skip to main content
Version: 3.2

DataExport

DataExport defines a spec for importing of application data from a non Portworx PVC (source) to a PVC backed by Portworx..

DataExportList

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
specDataExportSpec defines configuration parameters for DataExport.object
statusExportStatus indicates a current state of the data transfer.object

spec fields

FieldDescriptionType
spec.destinationDataExportDestination defines a backend for data transfer.object
spec.destination.persistentVolumeClaimPersistentVolumeClaim defines a PVC backend for data transfer. If provided PVC doesn't exist
a new one will be created using the spec configuration.
object
spec.destination.persistentVolumeClaim.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
spec.destination.persistentVolumeClaim.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
spec.destination.persistentVolumeClaim.metadataStandard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
object
spec.destination.persistentVolumeClaim.specspec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
spec.destination.persistentVolumeClaim.spec.accessModesaccessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
array
spec.destination.persistentVolumeClaim.spec.dataSourcedataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
If the AnyVolumeDataSource feature gate is enabled, this field will always have
the same contents as the DataSourceRef field.
object
spec.destination.persistentVolumeClaim.spec.dataSource.apiGroupAPIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
string
spec.destination.persistentVolumeClaim.spec.dataSource.kindKind is the type of resource being referencedstring
spec.destination.persistentVolumeClaim.spec.dataSource.nameName is the name of resource being referencedstring
spec.destination.persistentVolumeClaim.spec.dataSourceRefdataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any local object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the DataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, both fields (DataSource and DataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
There are two important differences between DataSource and DataSourceRef:
* While DataSource only allows two specific types of objects, DataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While DataSource ignores disallowed values (dropping them), DataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
object
spec.destination.persistentVolumeClaim.spec.dataSourceRef.apiGroupAPIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
string
spec.destination.persistentVolumeClaim.spec.dataSourceRef.kindKind is the type of resource being referencedstring
spec.destination.persistentVolumeClaim.spec.dataSourceRef.nameName is the name of resource being referencedstring
spec.destination.persistentVolumeClaim.spec.resourcesresources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
object
spec.destination.persistentVolumeClaim.spec.resources.limitsLimits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
spec.destination.persistentVolumeClaim.spec.resources.requestsRequests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
spec.destination.persistentVolumeClaim.spec.selectorselector is a label query over volumes to consider for binding.object
spec.destination.persistentVolumeClaim.spec.selector.matchExpressionsmatchExpressions is a list of label selector requirements. The requirements are ANDed.array
spec.destination.persistentVolumeClaim.spec.selector.matchExpressions.keykey is the label key that the selector applies to.string
spec.destination.persistentVolumeClaim.spec.selector.matchExpressions.operatoroperator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
string
spec.destination.persistentVolumeClaim.spec.selector.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.destination.persistentVolumeClaim.spec.selector.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.destination.persistentVolumeClaim.spec.storageClassNamestorageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
string
spec.destination.persistentVolumeClaim.spec.volumeModevolumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
string
spec.destination.persistentVolumeClaim.spec.volumeNamevolumeName is the binding reference to the PersistentVolume backing this claim.string
spec.destination.persistentVolumeClaim.statusstatus represents the current information/status of a persistent volume claim.
Read-only.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
spec.destination.persistentVolumeClaim.status.accessModesaccessModes contains the actual access modes the volume backing the PVC has.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
array
spec.destination.persistentVolumeClaim.status.allocatedResourcesallocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may
be larger than the actual capacity when a volume expansion operation is requested.
For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
If a volume expansion capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress and if the actual volume capacity
is equal or lower than the requested capacity.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
object
spec.destination.persistentVolumeClaim.status.capacitycapacity represents the actual resources of the underlying volume.object
spec.destination.persistentVolumeClaim.status.conditionsconditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'ResizeStarted'.
array
spec.destination.persistentVolumeClaim.status.conditions.lastProbeTimelastProbeTime is the time we probed the condition.string
spec.destination.persistentVolumeClaim.status.conditions.lastTransitionTimelastTransitionTime is the time the condition transitioned from one status to another.string
spec.destination.persistentVolumeClaim.status.conditions.messagemessage is the human-readable message indicating details about last transition.string
spec.destination.persistentVolumeClaim.status.conditions.reasonreason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "ResizeStarted" that means the underlying
persistent volume is being resized.
string
spec.destination.persistentVolumeClaim.status.conditions.typePersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Typestring
spec.destination.persistentVolumeClaim.status.phasephase represents the current phase of PersistentVolumeClaim.string
spec.destination.persistentVolumeClaim.status.resizeStatusresizeStatus stores status of resize operation.
ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty
string by resize controller or kubelet.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
string
spec.sourceDataExportSource defines a PVC name and namespace that should be processed.object
spec.source.persistentVolumeClaimPersistentVolumeClaim is a user's request for and claim to a persistent volumeobject
spec.source.persistentVolumeClaim.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
spec.source.persistentVolumeClaim.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
spec.source.persistentVolumeClaim.metadataStandard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
object
spec.source.persistentVolumeClaim.specspec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
spec.source.persistentVolumeClaim.spec.accessModesaccessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
array
spec.source.persistentVolumeClaim.spec.dataSourcedataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
If the AnyVolumeDataSource feature gate is enabled, this field will always have
the same contents as the DataSourceRef field.
object
spec.source.persistentVolumeClaim.spec.dataSource.apiGroupAPIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
string
spec.source.persistentVolumeClaim.spec.dataSource.kindKind is the type of resource being referencedstring
spec.source.persistentVolumeClaim.spec.dataSource.nameName is the name of resource being referencedstring
spec.source.persistentVolumeClaim.spec.dataSourceRefdataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any local object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the DataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, both fields (DataSource and DataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
There are two important differences between DataSource and DataSourceRef:
* While DataSource only allows two specific types of objects, DataSourceRef
allows any non-core object, as well as PersistentVolumeClaim objects.
* While DataSource ignores disallowed values (dropping them), DataSourceRef
preserves all values, and generates an error if a disallowed value is
specified.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
object
spec.source.persistentVolumeClaim.spec.dataSourceRef.apiGroupAPIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
string
spec.source.persistentVolumeClaim.spec.dataSourceRef.kindKind is the type of resource being referencedstring
spec.source.persistentVolumeClaim.spec.dataSourceRef.nameName is the name of resource being referencedstring
spec.source.persistentVolumeClaim.spec.resourcesresources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
object
spec.source.persistentVolumeClaim.spec.resources.limitsLimits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
spec.source.persistentVolumeClaim.spec.resources.requestsRequests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
object
spec.source.persistentVolumeClaim.spec.selectorselector is a label query over volumes to consider for binding.object
spec.source.persistentVolumeClaim.spec.selector.matchExpressionsmatchExpressions is a list of label selector requirements. The requirements are ANDed.array
spec.source.persistentVolumeClaim.spec.selector.matchExpressions.keykey is the label key that the selector applies to.string
spec.source.persistentVolumeClaim.spec.selector.matchExpressions.operatoroperator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
string
spec.source.persistentVolumeClaim.spec.selector.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.source.persistentVolumeClaim.spec.selector.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.source.persistentVolumeClaim.spec.storageClassNamestorageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
string
spec.source.persistentVolumeClaim.spec.volumeModevolumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
string
spec.source.persistentVolumeClaim.spec.volumeNamevolumeName is the binding reference to the PersistentVolume backing this claim.string
spec.source.persistentVolumeClaim.statusstatus represents the current information/status of a persistent volume claim.
Read-only.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
object
spec.source.persistentVolumeClaim.status.accessModesaccessModes contains the actual access modes the volume backing the PVC has.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
array
spec.source.persistentVolumeClaim.status.allocatedResourcesallocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may
be larger than the actual capacity when a volume expansion operation is requested.
For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
If a volume expansion capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress and if the actual volume capacity
is equal or lower than the requested capacity.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
object
spec.source.persistentVolumeClaim.status.capacitycapacity represents the actual resources of the underlying volume.object
spec.source.persistentVolumeClaim.status.conditionsconditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'ResizeStarted'.
array
spec.source.persistentVolumeClaim.status.conditions.lastProbeTimelastProbeTime is the time we probed the condition.string
spec.source.persistentVolumeClaim.status.conditions.lastTransitionTimelastTransitionTime is the time the condition transitioned from one status to another.string
spec.source.persistentVolumeClaim.status.conditions.messagemessage is the human-readable message indicating details about last transition.string
spec.source.persistentVolumeClaim.status.conditions.reasonreason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "ResizeStarted" that means the underlying
persistent volume is being resized.
string
spec.source.persistentVolumeClaim.status.conditions.typePersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Typestring
spec.source.persistentVolumeClaim.status.phasephase represents the current phase of PersistentVolumeClaim.string
spec.source.persistentVolumeClaim.status.resizeStatusresizeStatus stores status of resize operation.
ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty
string by resize controller or kubelet.
This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
string
spec.typeDataExportType defines a method of achieving data transfer.string

status fields

FieldDescriptionType
status.stageDataExportStage defines different stages for DataExport when its Status changes
from Initial to Failed/Successful.
string
status.statusDataExportStatus defines a status of DataExport.string