Skip to main content

storage.k8s.io/VolumeAttachment@v1

Properties

PropertyTypeAttributesDescription
metadataIoK8SApimachineryPkgApisMetaV1ObjectMetaRequired, IdentifierObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
specIoK8SApiStorageV1VolumeAttachmentSpecRequiredVolumeAttachmentSpec is the specification of a VolumeAttachment request.
apiVersion'storage.k8s.io/v1'Read-only, Deploy-time constantAPIVersion 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'VolumeAttachment'Read-only, Deploy-time constantKind 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
statusIoK8SApiStorageV1VolumeAttachmentStatusVolumeAttachmentStatus is the status of a VolumeAttachment request.

IoK8SApimachineryPkgApisMetaV1ObjectMeta

PropertyTypeAttributesDescription
namestringRequired, Deploy-time constant, IdentifierName must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
annotationsIoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotationsAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creationTimestampstringRead-onlyTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionGracePeriodSecondsintRead-onlyNumber of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestampstringRead-onlyTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
finalizersstring[]Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
generationintRead-onlyA sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labelsIoK8SApimachineryPkgApisMetaV1ObjectMetaLabelsMap of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
managedFieldsIoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[]Read-onlyManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
namespacestringDeploy-time constant, IdentifierNamespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
ownerReferencesIoK8SApimachineryPkgApisMetaV1OwnerReference[]List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersionstringRead-onlyAn opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLinkstringRead-onlyDeprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uidstringRead-onlyUID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

IoK8SApiStorageV1VolumeAttachmentSpec

PropertyTypeAttributesDescription
attacherstringRequiredattacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
nodeNamestringRequirednodeName represents the node that the volume should be attached to.
sourceIoK8SApiStorageV1VolumeAttachmentSourceRequiredVolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in the future we may allow also inline volumes in pods. Exactly one member can be set.

IoK8SApiStorageV1VolumeAttachmentStatus

PropertyTypeAttributesDescription
attachedboolRequiredattached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachErrorIoK8SApiStorageV1VolumeErrorVolumeError captures an error encountered during a volume operation.
attachmentMetadataIoK8SApiStorageV1VolumeAttachmentStatusAttachmentMetadataattachmentMetadata is populated with any information returned by the attach operation, upon successful attach, that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
detachErrorIoK8SApiStorageV1VolumeErrorVolumeError captures an error encountered during a volume operation.

IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry

PropertyTypeAttributesDescription
apiVersionstringAPIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsTypestringFieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1anyAny object
managerstringManager is an identifier of the workflow managing these fields.
operationstringOperation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresourcestringSubresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
timestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

IoK8SApimachineryPkgApisMetaV1OwnerReference

PropertyTypeAttributesDescription
apiVersionstringRequiredAPI version of the referent.
kindstringRequiredKind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringRequiredName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uidstringRequiredUID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletionboolIf true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controllerboolIf true, this reference points to the managing controller.

IoK8SApiStorageV1VolumeAttachmentSource

PropertyTypeAttributesDescription
inlineVolumeSpecIoK8SApiCoreV1PersistentVolumeSpecPersistentVolumeSpec is the specification of a persistent volume.
persistentVolumeNamestringpersistentVolumeName represents the name of the persistent volume to attach.

IoK8SApiStorageV1VolumeError

PropertyTypeAttributesDescription
errorCodeinterrorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations. This is an optional, alpha field that requires the MutableCSINodeAllocatableCount feature gate being enabled to be set.
messagestringmessage represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
timestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

IoK8SApiStorageV1VolumeAttachmentStatusAttachmentMetadata

Additional properties of type string are allowed.

IoK8SApiCoreV1PersistentVolumeSpec

PropertyTypeAttributesDescription
accessModesstring[]accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
awsElasticBlockStoreIoK8SApiCoreV1AWSElasticBlockStoreVolumeSourceRepresents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
azureDiskIoK8SApiCoreV1AzureDiskVolumeSourceAzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureFileIoK8SApiCoreV1AzureFilePersistentVolumeSourceAzureFile represents an Azure File Service mount on the host and bind mount to the pod.
capacityIoK8SApiCoreV1PersistentVolumeSpecCapacitycapacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
cephfsIoK8SApiCoreV1CephFSPersistentVolumeSourceRepresents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
cinderIoK8SApiCoreV1CinderPersistentVolumeSourceRepresents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
claimRefIoK8SApiCoreV1ObjectReferenceObjectReference contains enough information to let you inspect or modify the referred object.
csiIoK8SApiCoreV1CSIPersistentVolumeSourceRepresents storage that is managed by an external CSI volume driver
fcIoK8SApiCoreV1FCVolumeSourceRepresents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
flexVolumeIoK8SApiCoreV1FlexPersistentVolumeSourceFlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
flockerIoK8SApiCoreV1FlockerVolumeSourceRepresents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
gcePersistentDiskIoK8SApiCoreV1GCEPersistentDiskVolumeSourceRepresents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
glusterfsIoK8SApiCoreV1GlusterfsPersistentVolumeSourceRepresents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
hostPathIoK8SApiCoreV1HostPathVolumeSourceRepresents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
iscsiIoK8SApiCoreV1IscsiPersistentVolumeSourceISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
localIoK8SApiCoreV1LocalVolumeSourceLocal represents directly-attached storage with node affinity
mountOptionsstring[]mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
nfsIoK8SApiCoreV1NFSVolumeSourceRepresents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
nodeAffinityIoK8SApiCoreV1VolumeNodeAffinityVolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
persistentVolumeReclaimPolicystringpersistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
photonPersistentDiskIoK8SApiCoreV1PhotonPersistentDiskVolumeSourceRepresents a Photon Controller persistent disk resource.
portworxVolumeIoK8SApiCoreV1PortworxVolumeSourcePortworxVolumeSource represents a Portworx volume resource.
quobyteIoK8SApiCoreV1QuobyteVolumeSourceRepresents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
rbdIoK8SApiCoreV1RBDPersistentVolumeSourceRepresents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
scaleIOIoK8SApiCoreV1ScaleIOPersistentVolumeSourceScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
storageClassNamestringstorageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
storageosIoK8SApiCoreV1StorageOSPersistentVolumeSourceRepresents a StorageOS persistent volume resource.
volumeAttributesClassNamestringName of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
volumeModestringvolumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
vsphereVolumeIoK8SApiCoreV1VsphereVirtualDiskVolumeSourceRepresents a vSphere volume resource.

IoK8SApiCoreV1AWSElasticBlockStoreVolumeSource

PropertyTypeAttributesDescription
volumeIDstringRequiredvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
fsTypestringfsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
partitionintpartition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
readOnlyboolreadOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

IoK8SApiCoreV1AzureDiskVolumeSource

PropertyTypeAttributesDescription
diskNamestringRequireddiskName is the Name of the data disk in the blob storage
diskURIstringRequireddiskURI is the URI of data disk in the blob storage
cachingModestringcachingMode is the Host Caching mode: None, Read Only, Read Write.
fsTypestringfsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
kindstringkind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnlyboolreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

IoK8SApiCoreV1AzureFilePersistentVolumeSource

PropertyTypeAttributesDescription
secretNamestringRequiredsecretName is the name of secret that contains Azure Storage Account Name and Key
shareNamestringRequiredshareName is the azure Share Name
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretNamespacestringsecretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod

IoK8SApiCoreV1PersistentVolumeSpecCapacity

Additional properties of type string are allowed.

IoK8SApiCoreV1CephFSPersistentVolumeSource

PropertyTypeAttributesDescription
monitorsstring[]Requiredmonitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
pathstringpath is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnlyboolreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretFilestringsecretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
userstringuser is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

IoK8SApiCoreV1CinderPersistentVolumeSource

PropertyTypeAttributesDescription
volumeIDstringRequiredvolumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
fsTypestringfsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
readOnlyboolreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
secretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

IoK8SApiCoreV1ObjectReference

PropertyTypeAttributesDescription
apiVersionstringAPI version of the referent.
fieldPathstringIf referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kindstringKind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespacestringNamespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersionstringSpecific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uidstringUID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

IoK8SApiCoreV1CSIPersistentVolumeSource

PropertyTypeAttributesDescription
driverstringRequireddriver is the name of the driver to use for this volume. Required.
volumeHandlestringRequiredvolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
controllerExpandSecretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
controllerPublishSecretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
fsTypestringfsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
nodeExpandSecretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
nodePublishSecretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
nodeStageSecretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
readOnlyboolreadOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
volumeAttributesIoK8SApiCoreV1CSIPersistentVolumeSourceVolumeAttributesvolumeAttributes of the volume to publish.

IoK8SApiCoreV1FCVolumeSource

PropertyTypeAttributesDescription
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lunintlun is Optional: FC target lun number
readOnlyboolreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNsstring[]targetWWNs is Optional: FC target worldwide names (WWNs)
wwidsstring[]wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

IoK8SApiCoreV1FlexPersistentVolumeSource

PropertyTypeAttributesDescription
driverstringRequireddriver is the name of the driver to use for this volume.
fsTypestringfsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
optionsIoK8SApiCoreV1FlexPersistentVolumeSourceOptionsoptions is Optional: this field holds extra command options if any.
readOnlyboolreadOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

IoK8SApiCoreV1FlockerVolumeSource

PropertyTypeAttributesDescription
datasetNamestringdatasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUIDstringdatasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

IoK8SApiCoreV1GCEPersistentDiskVolumeSource

PropertyTypeAttributesDescription
pdNamestringRequiredpdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
fsTypestringfsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partitionintpartition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnlyboolreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

IoK8SApiCoreV1GlusterfsPersistentVolumeSource

PropertyTypeAttributesDescription
endpointsstringRequiredendpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
pathstringRequiredpath is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpointsNamespacestringendpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnlyboolreadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

IoK8SApiCoreV1HostPathVolumeSource

PropertyTypeAttributesDescription
pathstringRequiredpath of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
typestringtype for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

IoK8SApiCoreV1IscsiPersistentVolumeSource

PropertyTypeAttributesDescription
iqnstringRequirediqn is Target iSCSI Qualified Name.
lunintRequiredlun is iSCSI Target Lun number.
targetPortalstringRequiredtargetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
chapAuthDiscoveryboolchapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthSessionboolchapAuthSession defines whether support iSCSI Session CHAP authentication
fsTypestringfsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorNamestringinitiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iscsiInterfacestringiscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
portalsstring[]portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnlyboolreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

IoK8SApiCoreV1LocalVolumeSource

PropertyTypeAttributesDescription
pathstringRequiredpath of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
fsTypestringfsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.

IoK8SApiCoreV1NFSVolumeSource

PropertyTypeAttributesDescription
pathstringRequiredpath that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
serverstringRequiredserver is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnlyboolreadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

IoK8SApiCoreV1VolumeNodeAffinity

PropertyTypeAttributesDescription
requiredIoK8SApiCoreV1NodeSelectorA node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

IoK8SApiCoreV1PhotonPersistentDiskVolumeSource

PropertyTypeAttributesDescription
pdIDstringRequiredpdID is the ID that identifies Photon Controller persistent disk
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

IoK8SApiCoreV1PortworxVolumeSource

PropertyTypeAttributesDescription
volumeIDstringRequiredvolumeID uniquely identifies a Portworx volume
fsTypestringfSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

IoK8SApiCoreV1QuobyteVolumeSource

PropertyTypeAttributesDescription
registrystringRequiredregistry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
volumestringRequiredvolume is a string that references an already created Quobyte volume by name.
groupstringgroup to map volume access to Default is no group
readOnlyboolreadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
tenantstringtenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
userstringuser to map volume access to Defaults to serivceaccount user

IoK8SApiCoreV1RBDPersistentVolumeSource

PropertyTypeAttributesDescription
imagestringRequiredimage is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitorsstring[]Requiredmonitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
fsTypestringfsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
keyringstringkeyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
poolstringpool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnlyboolreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
secretRefIoK8SApiCoreV1SecretReferenceSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
userstringuser is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

IoK8SApiCoreV1ScaleIOPersistentVolumeSource

PropertyTypeAttributesDescription
gatewaystringRequiredgateway is the host address of the ScaleIO API Gateway.
secretRefIoK8SApiCoreV1SecretReferenceRequiredSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
systemstringRequiredsystem is the name of the storage system as configured in ScaleIO.
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
protectionDomainstringprotectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
sslEnabledboolsslEnabled is the flag to enable/disable SSL communication with Gateway, default false
storageModestringstorageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePoolstringstoragePool is the ScaleIO Storage Pool associated with the protection domain.
volumeNamestringvolumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

IoK8SApiCoreV1StorageOSPersistentVolumeSource

PropertyTypeAttributesDescription
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnlyboolreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefIoK8SApiCoreV1ObjectReferenceObjectReference contains enough information to let you inspect or modify the referred object.
volumeNamestringvolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespacestringvolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

IoK8SApiCoreV1VsphereVirtualDiskVolumeSource

PropertyTypeAttributesDescription
volumePathstringRequiredvolumePath is the path that identifies vSphere volume vmdk
fsTypestringfsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
storagePolicyIDstringstoragePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyNamestringstoragePolicyName is the storage Policy Based Management (SPBM) profile name.

IoK8SApiCoreV1SecretReference

PropertyTypeAttributesDescription
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.

IoK8SApiCoreV1CSIPersistentVolumeSourceVolumeAttributes

Additional properties of type string are allowed.

IoK8SApiCoreV1FlexPersistentVolumeSourceOptions

Additional properties of type string are allowed.

IoK8SApiCoreV1NodeSelector

PropertyTypeAttributesDescription
nodeSelectorTermsIoK8SApiCoreV1NodeSelectorTerm[]RequiredRequired. A list of node selector terms. The terms are ORed.

IoK8SApiCoreV1NodeSelectorTerm

PropertyTypeAttributesDescription
matchExpressionsIoK8SApiCoreV1NodeSelectorRequirement[]A list of node selector requirements by node's labels.
matchFieldsIoK8SApiCoreV1NodeSelectorRequirement[]A list of node selector requirements by node's fields.

IoK8SApiCoreV1NodeSelectorRequirement

PropertyTypeAttributesDescription
keystringRequiredThe label key that the selector applies to.
operatorstringRequiredRepresents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
valuesstring[]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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.