VolumeAttachment
storage.k8s.io/v1
Cluster
VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. VolumeAttachment objects are non-namespaced.
RBAC Verbs
create
delete
deletecollection
get
list
patch
update
watch
Properties
| Field | Type | Required? | Description |
|---|---|---|---|
| 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| metadata | object | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
| metadata.annotations | object | Annotations 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 | |
| metadata.creationTimestamp | string | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
| metadata.deletionGracePeriodSeconds | integer | Number 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. | |
| metadata.deletionTimestamp | string | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
| metadata.finalizers | array | 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. | |
| metadata.generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency | |
| metadata.generation | integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| metadata.labels | object | Map 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 | |
| metadata.managedFields | array | ManagedFields 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. | |
| metadata.name | string | Name 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 | |
| metadata.namespace | string | Namespace 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 | |
| metadata.ownerReferences | array | 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. | |
| metadata.resourceVersion | string | An 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 | |
| metadata.selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| metadata.uid | string | UID 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec | object | Required | spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
| spec.attacher | string | Required | attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
| spec.nodeName | string | Required | nodeName represents the node that the volume should be attached to. |
| spec.source | object | Required | source represents the volume that should be attached. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec | object | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. | |
| spec.source.persistentVolumeName | string | persistentVolumeName represents the name of the persistent volume to attach. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.accessModes | array | accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes | |
| spec.source.inlineVolumeSpec.awsElasticBlockStore | object | awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | |
| spec.source.inlineVolumeSpec.azureDisk | object | azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver. | |
| spec.source.inlineVolumeSpec.azureFile | object | azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver. | |
| spec.source.inlineVolumeSpec.capacity | object | capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
| spec.source.inlineVolumeSpec.cephfs | object | cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported. | |
| spec.source.inlineVolumeSpec.cinder | object | cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md | |
| spec.source.inlineVolumeSpec.claimRef | object | claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding | |
| spec.source.inlineVolumeSpec.csi | object | csi represents storage that is handled by an external CSI driver. | |
| spec.source.inlineVolumeSpec.fc | object | fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | |
| spec.source.inlineVolumeSpec.flexVolume | object | flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead. | |
| spec.source.inlineVolumeSpec.flocker | object | flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported. | |
| spec.source.inlineVolumeSpec.gcePersistentDisk | object | gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | |
| spec.source.inlineVolumeSpec.glusterfs | object | glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md | |
| spec.source.inlineVolumeSpec.hostPath | object | hostPath 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 | |
| spec.source.inlineVolumeSpec.iscsi | object | iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. | |
| spec.source.inlineVolumeSpec.local | object | local represents directly-attached storage with node affinity | |
| spec.source.inlineVolumeSpec.mountOptions | array | 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 | |
| spec.source.inlineVolumeSpec.nfs | object | nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs | |
| spec.source.inlineVolumeSpec.nodeAffinity | object | nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. This field is mutable if MutablePVNodeAffinity feature gate is enabled. | |
| spec.source.inlineVolumeSpec.persistentVolumeReclaimPolicy | string | persistentVolumeReclaimPolicy 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 | |
| spec.source.inlineVolumeSpec.photonPersistentDisk | object | photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported. | |
| spec.source.inlineVolumeSpec.portworxVolume | object | portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver. | |
| spec.source.inlineVolumeSpec.quobyte | object | quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported. | |
| spec.source.inlineVolumeSpec.rbd | object | rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md | |
| spec.source.inlineVolumeSpec.scaleIO | object | scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported. | |
| spec.source.inlineVolumeSpec.storageClassName | string | storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. | |
| spec.source.inlineVolumeSpec.storageos | object | storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: https://examples.k8s.io/volumes/storageos/README.md | |
| spec.source.inlineVolumeSpec.volumeAttributesClassName | string | Name 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. | |
| spec.source.inlineVolumeSpec.volumeMode | string | volumeMode 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. | |
| spec.source.inlineVolumeSpec.vsphereVolume | object | vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.awsElasticBlockStore.fsType | string | fsType 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 | |
| spec.source.inlineVolumeSpec.awsElasticBlockStore.partition | integer | partition 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). | |
| spec.source.inlineVolumeSpec.awsElasticBlockStore.readOnly | boolean | readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | |
| spec.source.inlineVolumeSpec.awsElasticBlockStore.volumeID | string | Required | volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.azureDisk.cachingMode | string | cachingMode is the Host Caching mode: None, Read Only, Read Write. | |
| spec.source.inlineVolumeSpec.azureDisk.diskName | string | Required | diskName is the Name of the data disk in the blob storage |
| spec.source.inlineVolumeSpec.azureDisk.diskURI | string | Required | diskURI is the URI of data disk in the blob storage |
| spec.source.inlineVolumeSpec.azureDisk.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.azureDisk.kind | string | kind 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 | |
| spec.source.inlineVolumeSpec.azureDisk.readOnly | boolean | readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.azureFile.readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
| spec.source.inlineVolumeSpec.azureFile.secretName | string | Required | secretName is the name of secret that contains Azure Storage Account Name and Key |
| spec.source.inlineVolumeSpec.azureFile.secretNamespace | string | secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod | |
| spec.source.inlineVolumeSpec.azureFile.shareName | string | Required | shareName is the azure Share Name |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.cephfs.monitors | array | Required | monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
| spec.source.inlineVolumeSpec.cephfs.path | string | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / | |
| spec.source.inlineVolumeSpec.cephfs.readOnly | boolean | readOnly 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 | |
| spec.source.inlineVolumeSpec.cephfs.secretFile | string | secretFile 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 | |
| spec.source.inlineVolumeSpec.cephfs.secretRef | object | secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | |
| spec.source.inlineVolumeSpec.cephfs.user | string | user 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.cinder.fsType | string | fsType 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 | |
| spec.source.inlineVolumeSpec.cinder.readOnly | boolean | readOnly 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 | |
| spec.source.inlineVolumeSpec.cinder.secretRef | object | secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack. | |
| spec.source.inlineVolumeSpec.cinder.volumeID | string | Required | volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.claimRef.apiVersion | string | API version of the referent. | |
| spec.source.inlineVolumeSpec.claimRef.fieldPath | string | If 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. | |
| spec.source.inlineVolumeSpec.claimRef.kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
| spec.source.inlineVolumeSpec.claimRef.name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
| spec.source.inlineVolumeSpec.claimRef.namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
| spec.source.inlineVolumeSpec.claimRef.resourceVersion | string | Specific 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 | |
| spec.source.inlineVolumeSpec.claimRef.uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.csi.controllerExpandSecretRef | object | controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. | |
| spec.source.inlineVolumeSpec.csi.controllerPublishSecretRef | object | controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. | |
| spec.source.inlineVolumeSpec.csi.driver | string | Required | driver is the name of the driver to use for this volume. Required. |
| spec.source.inlineVolumeSpec.csi.fsType | string | fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". | |
| spec.source.inlineVolumeSpec.csi.nodeExpandSecretRef | object | nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed. | |
| spec.source.inlineVolumeSpec.csi.nodePublishSecretRef | object | nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. | |
| spec.source.inlineVolumeSpec.csi.nodeStageSecretRef | object | nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. | |
| spec.source.inlineVolumeSpec.csi.readOnly | boolean | readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). | |
| spec.source.inlineVolumeSpec.csi.volumeAttributes | object | volumeAttributes of the volume to publish. | |
| spec.source.inlineVolumeSpec.csi.volumeHandle | string | Required | volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.fc.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.fc.lun | integer | lun is Optional: FC target lun number | |
| spec.source.inlineVolumeSpec.fc.readOnly | boolean | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
| spec.source.inlineVolumeSpec.fc.targetWWNs | array | targetWWNs is Optional: FC target worldwide names (WWNs) | |
| spec.source.inlineVolumeSpec.fc.wwids | array | wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.flexVolume.driver | string | Required | driver is the name of the driver to use for this volume. |
| spec.source.inlineVolumeSpec.flexVolume.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.flexVolume.options | object | options is Optional: this field holds extra command options if any. | |
| spec.source.inlineVolumeSpec.flexVolume.readOnly | boolean | readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
| spec.source.inlineVolumeSpec.flexVolume.secretRef | object | secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.flocker.datasetName | string | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated | |
| spec.source.inlineVolumeSpec.flocker.datasetUUID | string | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.gcePersistentDisk.fsType | string | fsType 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 | |
| spec.source.inlineVolumeSpec.gcePersistentDisk.partition | integer | partition 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 | |
| spec.source.inlineVolumeSpec.gcePersistentDisk.pdName | string | Required | pdName 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 |
| spec.source.inlineVolumeSpec.gcePersistentDisk.readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.glusterfs.endpoints | string | Required | endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
| spec.source.inlineVolumeSpec.glusterfs.endpointsNamespace | string | endpointsNamespace 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 | |
| spec.source.inlineVolumeSpec.glusterfs.path | string | Required | path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
| spec.source.inlineVolumeSpec.glusterfs.readOnly | boolean | readOnly 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.hostPath.path | string | Required | path 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 |
| spec.source.inlineVolumeSpec.hostPath.type | string | type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.iscsi.chapAuthDiscovery | boolean | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication | |
| spec.source.inlineVolumeSpec.iscsi.chapAuthSession | boolean | chapAuthSession defines whether support iSCSI Session CHAP authentication | |
| spec.source.inlineVolumeSpec.iscsi.fsType | string | fsType 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 | |
| spec.source.inlineVolumeSpec.iscsi.initiatorName | string | initiatorName 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. | |
| spec.source.inlineVolumeSpec.iscsi.iqn | string | Required | iqn is Target iSCSI Qualified Name. |
| spec.source.inlineVolumeSpec.iscsi.iscsiInterface | string | iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). | |
| spec.source.inlineVolumeSpec.iscsi.lun | integer | Required | lun is iSCSI Target Lun number. |
| spec.source.inlineVolumeSpec.iscsi.portals | array | 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). | |
| spec.source.inlineVolumeSpec.iscsi.readOnly | boolean | readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. | |
| spec.source.inlineVolumeSpec.iscsi.secretRef | object | secretRef is the CHAP Secret for iSCSI target and initiator authentication | |
| spec.source.inlineVolumeSpec.iscsi.targetPortal | string | Required | targetPortal 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). |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.local.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.local.path | string | Required | path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.nfs.path | string | Required | path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
| spec.source.inlineVolumeSpec.nfs.readOnly | boolean | readOnly 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 | |
| spec.source.inlineVolumeSpec.nfs.server | string | Required | server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.nodeAffinity.required | object | required specifies hard node constraints that must be met. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.photonPersistentDisk.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.photonPersistentDisk.pdID | string | Required | pdID is the ID that identifies Photon Controller persistent disk |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.portworxVolume.fsType | string | fSType 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. | |
| spec.source.inlineVolumeSpec.portworxVolume.readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
| spec.source.inlineVolumeSpec.portworxVolume.volumeID | string | Required | volumeID uniquely identifies a Portworx volume |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.quobyte.group | string | group to map volume access to Default is no group | |
| spec.source.inlineVolumeSpec.quobyte.readOnly | boolean | readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. | |
| spec.source.inlineVolumeSpec.quobyte.registry | string | Required | registry 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 |
| spec.source.inlineVolumeSpec.quobyte.tenant | string | tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin | |
| spec.source.inlineVolumeSpec.quobyte.user | string | user to map volume access to Defaults to serivceaccount user | |
| spec.source.inlineVolumeSpec.quobyte.volume | string | Required | volume is a string that references an already created Quobyte volume by name. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.rbd.fsType | string | fsType 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 | |
| spec.source.inlineVolumeSpec.rbd.image | string | Required | image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
| spec.source.inlineVolumeSpec.rbd.keyring | string | keyring 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 | |
| spec.source.inlineVolumeSpec.rbd.monitors | array | Required | monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
| spec.source.inlineVolumeSpec.rbd.pool | string | pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | |
| spec.source.inlineVolumeSpec.rbd.readOnly | boolean | readOnly 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 | |
| spec.source.inlineVolumeSpec.rbd.secretRef | object | secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | |
| spec.source.inlineVolumeSpec.rbd.user | string | user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.scaleIO.fsType | string | fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" | |
| spec.source.inlineVolumeSpec.scaleIO.gateway | string | Required | gateway is the host address of the ScaleIO API Gateway. |
| spec.source.inlineVolumeSpec.scaleIO.protectionDomain | string | protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. | |
| spec.source.inlineVolumeSpec.scaleIO.readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
| spec.source.inlineVolumeSpec.scaleIO.secretRef | object | Required | secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
| spec.source.inlineVolumeSpec.scaleIO.sslEnabled | boolean | sslEnabled is the flag to enable/disable SSL communication with Gateway, default false | |
| spec.source.inlineVolumeSpec.scaleIO.storageMode | string | storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. | |
| spec.source.inlineVolumeSpec.scaleIO.storagePool | string | storagePool is the ScaleIO Storage Pool associated with the protection domain. | |
| spec.source.inlineVolumeSpec.scaleIO.system | string | Required | system is the name of the storage system as configured in ScaleIO. |
| spec.source.inlineVolumeSpec.scaleIO.volumeName | string | volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.storageos.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.storageos.readOnly | boolean | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
| spec.source.inlineVolumeSpec.storageos.secretRef | object | secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. | |
| spec.source.inlineVolumeSpec.storageos.volumeName | string | volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. | |
| spec.source.inlineVolumeSpec.storageos.volumeNamespace | string | volumeNamespace 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. |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec.source.inlineVolumeSpec.vsphereVolume.fsType | string | fsType 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. | |
| spec.source.inlineVolumeSpec.vsphereVolume.storagePolicyID | string | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. | |
| spec.source.inlineVolumeSpec.vsphereVolume.storagePolicyName | string | storagePolicyName is the storage Policy Based Management (SPBM) profile name. | |
| spec.source.inlineVolumeSpec.vsphereVolume.volumePath | string | Required | volumePath is the path that identifies vSphere volume vmdk |
| Field | Type | Required? | Description |
|---|---|---|---|
| status | object | status represents status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. | |
| status.attachError | object | attachError represents the last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. | |
| status.attachError.errorCode | integer | errorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations. This field requires the MutableCSINodeAllocatableCount feature gate being enabled to be set. | |
| status.attachError.message | string | message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. | |
| status.attachError.time | string | time represents the time the error was encountered. | |
| status.attached | boolean | Required | attached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
| status.attachmentMetadata | object | attachmentMetadata 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. | |
| status.detachError | object | detachError represents the last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher. | |
| status.detachError.errorCode | integer | errorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations. This field requires the MutableCSINodeAllocatableCount feature gate being enabled to be set. | |
| status.detachError.message | string | message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. | |
| status.detachError.time | string | time represents the time the error was encountered. |
Sample Manifest
Minimal example generated from required fields — not hand-verified.
apiVersion: storage.k8s.io/v1
kind: VolumeAttachment
metadata:
name: my-volumeattachment
spec:
attacher: ""
nodeName: ""
source: {}
Need this managed for you, not just automated?
We're also a hands-on DevOps consultancy — Kubernetes, CI/CD, and cloud infrastructure.