Volume

io.k8s.api.core.v1.Volume source ↗

Volume represents a named volume in a pod that may be accessed by any container in the pod.

awsElasticBlockStoreAWSElasticBlockStoreVolumeSourceawsElasticBlockStore 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
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
partitioninteger (int32)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).
readOnlybooleanreadOnly value true will force the readOnly setting in VolumeMounts.More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeIDstring requiredvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDiskAzureDiskVolumeSourceazureDisk 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.
cachingModestringcachingMode is the Host Caching mode: None, Read Only, Read Write.
diskNamestring requireddiskName is the Name of the data disk in the blob storage
diskURIstring requireddiskURI is the URI of data disk in the blob storage
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
readOnlybooleanreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
azureFileAzureFileVolumeSourceazureFile 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.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretNamestring requiredsecretName is the name of secret that contains Azure Storage Account Name and Key
shareNamestring requiredshareName is the azure share Name
cephfsCephFSVolumeSourcecephFS 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.
monitors[]string requiredmonitors is Required: Monitors is a collection of Ceph monitorsMore 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 /
readOnlybooleanreadOnly 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.secretMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRefLocalObjectReferencesecretRef 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
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
userstringuser is optional: User is the rados user name, default is adminMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
cinderCinderVolumeSourcecinder 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
fsTypestringfsType is the 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
readOnlybooleanreadOnly 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
secretRefLocalObjectReferencesecretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
volumeIDstring requiredvolumeID used to identify the volume in cinder.More info: https://examples.k8s.io/mysql-cinder-pd/README.md
configMapConfigMapVolumeSourceconfigMap represents a configMap that should populate this volume
defaultModeinteger (int32)defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items[]KeyToPathitems if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
keystring requiredkey is the key to project.
modeinteger (int32)mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
pathstring requiredpath is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanoptional specify whether the ConfigMap or its keys must be defined
csiCSIVolumeSourcecsi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
driverstring requireddriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
fsTypestringfsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
nodePublishSecretRefLocalObjectReferencenodePublishSecretRef 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 secret references are passed.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
readOnlybooleanreadOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
volumeAttributesmap[string]stringvolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
downwardAPIDownwardAPIVolumeSourcedownwardAPI represents downward API about the pod that should populate this volume
defaultModeinteger (int32)Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items[]DownwardAPIVolumeFileItems is a list of downward API volume file
fieldRefObjectFieldSelectorRequired: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
apiVersionstringVersion of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPathstring requiredPath of the field to select in the specified API version.
modeinteger (int32)Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
pathstring requiredRequired: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRefResourceFieldSelectorSelects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
containerNamestringContainer name: required for volumes, optional for env vars
divisorQuantitySpecifies the output format of the exposed resources, defaults to "1"
resourcestring requiredRequired: resource to select
emptyDirEmptyDirVolumeSourceemptyDir represents a temporary directory that shares a pod's lifetime.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
mediumstringmedium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimitQuantitysizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined.More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
ephemeralEphemeralVolumeSourceephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.A pod can use both types of ephemeral volumes and persistent volumes at the same time.
volumeClaimTemplatePersistentVolumeClaimTemplateWill be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.Required, must not be nil.
metadataObjectMetaMay contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
annotationsmap[string]stringAnnotations 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
creationTimestampTime read-onlyCreationTimestamp 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
deletionGracePeriodSecondsinteger (int64) read-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.
deletionTimestampTime read-onlyDeletionTimestamp 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
finalizers[]stringMust 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.
generateNamestringGenerateName 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
generationinteger (int64) read-onlyA sequence number representing a specific generation of the desired state.Populated by the system.Read-only.
labelsmap[string]stringMap 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
managedFields[]ManagedFieldsEntryManagedFields 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.
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"
fieldsV1FieldsV1FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
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.
timeTimeTime is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
namestringName 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
namespacestringNamespace 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
ownerReferences[]OwnerReferenceList 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.
apiVersionstring requiredAPI version of the referent.
blockOwnerDeletionbooleanIf 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.
controllerbooleanIf true, this reference points to the managing controller.
kindstring requiredKind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestring requiredName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uidstring requiredUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
resourceVersionstring read-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
selfLinkstring read-onlyDeprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uidstring read-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
specPersistentVolumeClaimSpec requiredThe specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
accessModes[]stringaccessModes contains the desired access modes the volume should have.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSourceTypedLocalObjectReferencedataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
apiGroupstringAPIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kindstring requiredKind is the type of resource being referenced
namestring requiredName is the name of resource being referenced
dataSourceRefTypedObjectReferencedataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
  • While dataSource ignores disallowed values (dropping them), dataSourceRef
preserves all values, and generates an error if a disallowed value is specified.
  • While dataSource only allows local objects, dataSourceRef allows objects
in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
apiGroupstringAPIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kindstring requiredKind is the type of resource being referenced
namestring requiredName is the name of resource being referenced
namespacestringNamespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
resourcesVolumeResourceRequirementsresources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
limitsmap[string]QuantityLimits describes the maximum amount of compute resources allowed.More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requestsmap[string]QuantityRequests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits.More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
selectorLabelSelectorselector is a label query over volumes to consider for binding.
matchExpressions[]LabelSelectorRequirementmatchExpressions is a list of label selector requirements. The requirements are ANDed.
keystring requiredkey is the label key that the selector applies to.
operatorstring requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
storageClassNamestringstorageClassName is the name of the StorageClass required by the claim.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassNamestringvolumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists.More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
volumeModestringvolumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeNamestringvolumeName is the binding reference to the PersistentVolume backing this claim.
fcFCVolumeSourcefc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
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.
luninteger (int32)lun is Optional: FC target lun number
readOnlybooleanreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs[]stringtargetWWNs is Optional: FC target worldwide names (WWNs)
wwids[]stringwwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
flexVolumeFlexVolumeSourceflexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
driverstring requireddriver 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.
optionsmap[string]stringoptions is Optional: this field holds extra command options if any.
readOnlybooleanreadOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefLocalObjectReferencesecretRef 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.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
flockerFlockerVolumeSourceflocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
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
gcePersistentDiskGCEPersistentDiskVolumeSourcegcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. 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
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
partitioninteger (int32)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
pdNamestring requiredpdName 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
readOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
gitRepoGitRepoVolumeSourcegitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
directorystringdirectory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repositorystring requiredrepository is the URL
revisionstringrevision is the commit hash for the specified revision.
glusterfsGlusterfsVolumeSourceglusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
endpointsstring requiredendpoints is the endpoint name that details Glusterfs topology.
pathstring requiredpath is the Glusterfs volume path.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnlybooleanreadOnly 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
hostPathHostPathVolumeSourcehostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this.More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
pathstring requiredpath 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
imageImageVolumeSourceimage represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:
  • Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
pullPolicystringPolicy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
referencestringRequired: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
iscsiISCSIVolumeSourceiscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
chapAuthDiscoverybooleanchapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthSessionbooleanchapAuthSession 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.
iqnstring requirediqn is the target iSCSI Qualified Name.
iscsiInterfacestringiscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
luninteger (int32) requiredlun represents iSCSI Target Lun number.
portals[]stringportals 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).
readOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRefLocalObjectReferencesecretRef is the CHAP Secret for iSCSI target and initiator authentication
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
targetPortalstring requiredtargetPortal 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).
namestring requiredname of the volume. Must be a DNS_LABEL and unique within the pod.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
nfsNFSVolumeSourcenfs represents an NFS mount on the host that shares a pod's lifetimeMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
pathstring requiredpath that is exported by the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnlybooleanreadOnly 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
serverstring requiredserver is the hostname or IP address of the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
persistentVolumeClaimPersistentVolumeClaimVolumeSourcepersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
claimNamestring requiredclaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnlybooleanreadOnly Will force the ReadOnly setting in VolumeMounts. Default false.
photonPersistentDiskPhotonPersistentDiskVolumeSourcephotonPersistentDisk 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.
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.
pdIDstring requiredpdID is the ID that identifies Photon Controller persistent disk
portworxVolumePortworxVolumeSourceportworxVolume 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 when the CSIMigrationPortworx feature-gate is on.
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.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeIDstring requiredvolumeID uniquely identifies a Portworx volume
projectedProjectedVolumeSourceprojected items for all in one resources secrets, configmaps, and downward API
defaultModeinteger (int32)defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
sources[]VolumeProjectionsources is the list of volume projections. Each entry in this list handles one source.
clusterTrustBundleClusterTrustBundleProjectionClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of ClusterTrustBundle objects in an auto-updating file.Alpha, gated by the ClusterTrustBundleProjection feature gate.ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.
labelSelectorLabelSelectorSelect all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".
matchExpressions[]LabelSelectorRequirementmatchExpressions is a list of label selector requirements. The requirements are ANDed.
keystring requiredkey is the label key that the selector applies to.
operatorstring requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
namestringSelect a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
optionalbooleanIf true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.
pathstring requiredRelative path from the volume root to write the bundle.
signerNamestringSelect all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
configMapConfigMapProjectionconfigMap information about the configMap data to project
items[]KeyToPathitems if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
keystring requiredkey is the key to project.
modeinteger (int32)mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
pathstring requiredpath is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanoptional specify whether the ConfigMap or its keys must be defined
downwardAPIDownwardAPIProjectiondownwardAPI information about the downwardAPI data to project
items[]DownwardAPIVolumeFileItems is a list of DownwardAPIVolume file
fieldRefObjectFieldSelectorRequired: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
apiVersionstringVersion of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPathstring requiredPath of the field to select in the specified API version.
modeinteger (int32)Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
pathstring requiredRequired: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
resourceFieldRefResourceFieldSelectorSelects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
containerNamestringContainer name: required for volumes, optional for env vars
divisorQuantitySpecifies the output format of the exposed resources, defaults to "1"
resourcestring requiredRequired: resource to select
podCertificatePodCertificateProjectionProjects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.The named signer controls chooses the format of the certificate it issues; consult the signer implementation's documentation to learn how to use the certificates it issues.
certificateChainPathstringWrite the certificate chain at this path in the projected volume.Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.
credentialBundlePathstringWrite the credential bundle at this path in the projected volume.The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key.The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates).Using credentialBundlePath lets your Pod's application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key.
keyPathstringWrite the key at this path in the projected volume.Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.
keyTypestring requiredThe type of keypair Kubelet will generate for the pod.Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519".
maxExpirationSecondsinteger (int32)maxExpirationSeconds is the maximum lifetime permitted for the certificate.Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection.If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).The signer implementation is then free to issue a certificate with any lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. `kubernetes.io` signers will never issue certificates with a lifetime longer than 24 hours.
signerNamestring requiredKubelet's generated CSRs will be addressed to this signer.
secretSecretProjectionsecret information about the secret data to project
items[]KeyToPathitems if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
keystring requiredkey is the key to project.
modeinteger (int32)mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
pathstring requiredpath is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanoptional field specify whether the Secret or its key must be defined
serviceAccountTokenServiceAccountTokenProjectionserviceAccountToken is information about the serviceAccountToken data to project
audiencestringaudience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSecondsinteger (int64)expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
pathstring requiredpath is the path relative to the mount point of the file to project the token into.
quobyteQuobyteVolumeSourcequobyte 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.
groupstringgroup to map volume access to Default is no group
readOnlybooleanreadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registrystring requiredregistry 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
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
volumestring requiredvolume is a string that references an already created Quobyte volume by name.
rbdRBDVolumeSourcerbd 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.
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
imagestring requiredimage is the rados image name.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
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
monitors[]string requiredmonitors is a collection of Ceph monitors.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
readOnlybooleanreadOnly 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
secretRefLocalObjectReferencesecretRef 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
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
userstringuser is the rados user name. Default is admin.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
scaleIOScaleIOVolumeSourcescaleIO 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.
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".
gatewaystring requiredgateway is the host address of the ScaleIO API Gateway.
protectionDomainstringprotectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
readOnlybooleanreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefLocalObjectReference requiredsecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
sslEnabledbooleansslEnabled Flag 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.
systemstring requiredsystem is the name of the storage system as configured in ScaleIO.
volumeNamestringvolumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
secretSecretVolumeSourcesecret represents a secret that should populate this volume.More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
defaultModeinteger (int32)defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
items[]KeyToPathitems If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
keystring requiredkey is the key to project.
modeinteger (int32)mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
pathstring requiredpath is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
optionalbooleanoptional field specify whether the Secret or its keys must be defined
secretNamestringsecretName is the name of the secret in the pod's namespace to use.More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageosStorageOSVolumeSourcestorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
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.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefLocalObjectReferencesecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
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.
vsphereVolumeVsphereVirtualDiskVolumeSourcevsphereVolume 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.
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.
volumePathstring requiredvolumePath is the path that identifies vSphere volume vmdk