VolumeAttachment storage.k8s.io/v1
VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.
VolumeAttachment objects are non-namespaced.
Fields
- apiVersion:
storage.k8s.io/v1 - kind:
VolumeAttachment - metadata (ObjectMeta)
-
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec (VolumeAttachmentSpec)
-
spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
- status (VolumeAttachmentStatus)
-
status represents status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
VolumeAttachmentSpec
VolumeAttachmentSpec is the specification of a VolumeAttachment request.
- attacher (string)
-
attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
- nodeName (string)
-
nodeName represents the node that the volume should be attached to.
- source (VolumeAttachmentSource)
-
source represents the volume that should be attached.
VolumeAttachmentSource
VolumeAttachmentSource 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.
- inlineVolumeSpec (PersistentVolumeSpec)
-
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.
- persistentVolumeName (string)
-
persistentVolumeName represents the name of the persistent volume to attach.
PersistentVolumeSpec
PersistentVolumeSpec is the specification of a persistent volume.
- accessModes ([]string)
-
accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
- awsElasticBlockStore (AWSElasticBlockStoreVolumeSource)
-
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
Represents 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.
- awsElasticBlockStore.volumeID (string)
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 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
- 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).
- awsElasticBlockStore.readOnly (boolean)
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- azureDisk (AzureDiskVolumeSource)
-
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.
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- azureDisk.diskName (string)
diskName is the Name of the data disk in the blob storage
- azureDisk.diskURI (string)
diskURI is the URI of data disk in the blob storage
- azureDisk.cachingMode (string)
cachingMode is the Host Caching mode: None, Read Only, Read Write.
- 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.
- 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
- azureDisk.readOnly (boolean)
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- azureFile (AzureFilePersistentVolumeSource)
-
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.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
- azureFile.secretName (string)
secretName is the name of secret that contains Azure Storage Account Name and Key
- azureFile.shareName (string)
shareName is the azure Share Name
- azureFile.readOnly (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- 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
- capacity (map[string]Quantity)
-
capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
- cephfs (CephFSPersistentVolumeSource)
-
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.
- cinder (CinderPersistentVolumeSource)
-
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
- claimRef (ObjectReference)
-
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
- csi (CSIPersistentVolumeSource)
-
csi represents storage that is handled by an external CSI driver.
- fc (FCVolumeSource)
-
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
- 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.
- fc.lun (integer)
lun is Optional: FC target lun number
- fc.readOnly (boolean)
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- fc.targetWWNs ([]string)
targetWWNs is Optional: FC target worldwide names (WWNs)
- fc.wwids ([]string)
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- flexVolume (FlexPersistentVolumeSource)
-
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
- flocker (FlockerVolumeSource)
-
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.
Represents 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.
- flocker.datasetName (string)
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
- flocker.datasetUUID (string)
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- gcePersistentDisk (GCEPersistentDiskVolumeSource)
-
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
Represents 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.
- gcePersistentDisk.pdName (string)
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
- 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
- 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
- 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
- glusterfs (GlusterfsPersistentVolumeSource)
-
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
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
- glusterfs.endpoints (string)
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- glusterfs.path (string)
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 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
- 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
- hostPath (HostPathVolumeSource)
-
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
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
- hostPath.path (string)
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
- hostPath.type (string)
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- iscsi (ISCSIPersistentVolumeSource)
-
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.
- local (LocalVolumeSource)
-
local represents directly-attached storage with node affinity
Local represents directly-attached storage with node affinity
- local.path (string)
path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
- 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.
- mountOptions ([]string)
-
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
- nfs (NFSVolumeSource)
-
nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
- nfs.path (string)
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- nfs.server (string)
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 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
- nodeAffinity (VolumeNodeAffinity)
-
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.
- 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
- photonPersistentDisk (PhotonPersistentDiskVolumeSource)
-
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.
Represents a Photon Controller persistent disk resource.
- photonPersistentDisk.pdID (string)
pdID is the ID that identifies Photon Controller persistent disk
- 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.
- portworxVolume (PortworxVolumeSource)
-
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.
PortworxVolumeSource represents a Portworx volume resource.
- portworxVolume.volumeID (string)
volumeID uniquely identifies a Portworx volume
- 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.
- portworxVolume.readOnly (boolean)
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- quobyte (QuobyteVolumeSource)
-
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.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
- quobyte.registry (string)
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
- quobyte.volume (string)
volume is a string that references an already created Quobyte volume by name.
- quobyte.group (string)
group to map volume access to Default is no group
- quobyte.readOnly (boolean)
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
- quobyte.tenant (string)
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- quobyte.user (string)
user to map volume access to Defaults to serivceaccount user
- rbd (RBDPersistentVolumeSource)
-
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
- scaleIO (ScaleIOPersistentVolumeSource)
-
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.
- 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.
- storageos (StorageOSPersistentVolumeSource)
-
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
- 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.
- 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.
- vsphereVolume (VsphereVirtualDiskVolumeSource)
-
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.
Represents a vSphere volume resource.
- vsphereVolume.volumePath (string)
volumePath is the path that identifies vSphere volume vmdk
- 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.
- vsphereVolume.storagePolicyID (string)
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- vsphereVolume.storagePolicyName (string)
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
CephFSPersistentVolumeSource
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
- monitors ([]string)
-
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- path (string)
-
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- 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
- 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
- secretRef (SecretReference)
-
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
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- secretRef.name (string)
name is unique within a namespace to reference a secret resource.
- secretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- 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
CinderPersistentVolumeSource
Represents 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.
- volumeID (string)
-
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 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
- 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
- secretRef (SecretReference)
-
secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- secretRef.name (string)
name is unique within a namespace to reference a secret resource.
- secretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
CSIPersistentVolumeSource
Represents storage that is managed by an external CSI volume driver
- driver (string)
-
driver is the name of the driver to use for this volume. Required.
- volumeHandle (string)
-
volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
- controllerExpandSecretRef (SecretReference)
-
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.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- controllerExpandSecretRef.name (string)
name is unique within a namespace to reference a secret resource.
- controllerExpandSecretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- controllerPublishSecretRef (SecretReference)
-
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.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- controllerPublishSecretRef.name (string)
name is unique within a namespace to reference a secret resource.
- controllerPublishSecretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- fsType (string)
-
fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
- nodeExpandSecretRef (SecretReference)
-
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.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- nodeExpandSecretRef.name (string)
name is unique within a namespace to reference a secret resource.
- nodeExpandSecretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- nodePublishSecretRef (SecretReference)
-
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.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- nodePublishSecretRef.name (string)
name is unique within a namespace to reference a secret resource.
- nodePublishSecretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- nodeStageSecretRef (SecretReference)
-
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.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- nodeStageSecretRef.name (string)
name is unique within a namespace to reference a secret resource.
- nodeStageSecretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- readOnly (boolean)
-
readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
- volumeAttributes (map[string]string)
-
volumeAttributes of the volume to publish.
FlexPersistentVolumeSource
FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
- driver (string)
-
driver is the name of the driver to use for this volume.
- 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.
- options (map[string]string)
-
options is Optional: this field holds extra command options if any.
- readOnly (boolean)
-
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- secretRef (SecretReference)
-
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.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- secretRef.name (string)
name is unique within a namespace to reference a secret resource.
- secretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
ISCSIPersistentVolumeSource
ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
- iqn (string)
-
iqn is Target iSCSI Qualified Name.
- lun (integer)
-
lun is iSCSI Target Lun number.
- targetPortal (string)
-
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).
- chapAuthDiscovery (boolean)
-
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- chapAuthSession (boolean)
-
chapAuthSession defines whether support iSCSI Session CHAP authentication
- 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
- initiatorName (string)
-
initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
: will be created for the connection. - iscsiInterface (string)
-
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
- portals ([]string)
-
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).
- readOnly (boolean)
-
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
- secretRef (SecretReference)
-
secretRef is the CHAP Secret for iSCSI target and initiator authentication
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- secretRef.name (string)
name is unique within a namespace to reference a secret resource.
- secretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
VolumeNodeAffinity
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
- required (NodeSelector)
-
required specifies hard node constraints that must be met.
RBDPersistentVolumeSource
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
- image (string)
-
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- monitors ([]string)
-
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 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
- 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
- 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
- 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
- secretRef (SecretReference)
-
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
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- secretRef.name (string)
name is unique within a namespace to reference a secret resource.
- secretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- 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
ScaleIOPersistentVolumeSource
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
- gateway (string)
-
gateway is the host address of the ScaleIO API Gateway.
- secretRef (SecretReference)
-
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- secretRef.name (string)
name is unique within a namespace to reference a secret resource.
- secretRef.namespace (string)
namespace defines the space within which the secret name must be unique.
- system (string)
-
system is the name of the storage system as configured in 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"
- protectionDomain (string)
-
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- readOnly (boolean)
-
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- sslEnabled (boolean)
-
sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
- storageMode (string)
-
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
- storagePool (string)
-
storagePool is the ScaleIO Storage Pool associated with the protection domain.
- volumeName (string)
-
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
StorageOSPersistentVolumeSource
Represents a StorageOS persistent volume resource.
- 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.
- readOnly (boolean)
-
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
- secretRef (ObjectReference)
-
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- volumeName (string)
-
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
- 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.
VolumeAttachmentStatus
VolumeAttachmentStatus is the status of a VolumeAttachment request.
- attached (boolean)
-
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.
- attachError (VolumeError)
-
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.
- attachmentMetadata (map[string]string)
-
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.
- detachError (VolumeError)
-
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.
VolumeError
VolumeError captures an error encountered during a volume operation.
- 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.
- message (string)
-
message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- time (Time)
-
time represents the time the error was encountered.
VolumeAttachmentList
VolumeAttachmentList is a collection of VolumeAttachment objects.
- apiVersion:
storage.k8s.io/v1 - kind:
VolumeAttachmentList - metadata (ListMeta)
-
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- items ([]VolumeAttachment)
-
items is the list of VolumeAttachments