core/PersistentVolume@v1
Properties
| Property | Type | Attributes | Description |
|---|---|---|---|
metadata | IoK8SApimachineryPkgApisMetaV1ObjectMeta | Required, Identifier | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. |
apiVersion | 'v1' | Read-only, Deploy-time constant | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind | 'PersistentVolume' | Read-only, Deploy-time constant | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
spec | IoK8SApiCoreV1PersistentVolumeSpec | PersistentVolumeSpec is the specification of a persistent volume. | |
status | IoK8SApiCoreV1PersistentVolumeStatus | PersistentVolumeStatus is the current status of a persistent volume. |
IoK8SApimachineryPkgApisMetaV1ObjectMeta
| Property | Type | Attributes | Description |
|---|---|---|---|
name | string | Required, Deploy-time constant, Identifier | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
annotations | IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations | |
creationTimestamp | string | Read-only | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. |
deletionGracePeriodSeconds | int | Read-only | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
deletionTimestamp | string | Read-only | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. |
finalizers | string[] | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. | |
generation | int | Read-only | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
labels | IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels | |
managedFields | IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[] | Read-only | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. |
namespace | string | Deploy-time constant, Identifier | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces |
ownerReferences | IoK8SApimachineryPkgApisMetaV1OwnerReference[] | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. | |
resourceVersion | string | Read-only | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
selfLink | string | Read-only | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
uid | string | Read-only | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
IoK8SApiCoreV1PersistentVolumeSpec
| Property | Type | Attributes | Description |
|---|---|---|---|
accessModes | string[] | accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes | |
awsElasticBlockStore | IoK8SApiCoreV1AWSElasticBlockStoreVolumeSource | 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. | |
azureDisk | IoK8SApiCoreV1AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | |
azureFile | IoK8SApiCoreV1AzureFilePersistentVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. | |
capacity | IoK8SApiCoreV1PersistentVolumeSpecCapacity | capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
cephfs | IoK8SApiCoreV1CephFSPersistentVolumeSource | Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. | |
cinder | IoK8SApiCoreV1CinderPersistentVolumeSource | 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. | |
claimRef | IoK8SApiCoreV1ObjectReference | ObjectReference contains enough information to let you inspect or modify the referred object. | |
csi | IoK8SApiCoreV1CSIPersistentVolumeSource | Represents storage that is managed by an external CSI volume driver | |
fc | IoK8SApiCoreV1FCVolumeSource | 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. | |
flexVolume | IoK8SApiCoreV1FlexPersistentVolumeSource | FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. | |
flocker | IoK8SApiCoreV1FlockerVolumeSource | 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. | |
gcePersistentDisk | IoK8SApiCoreV1GCEPersistentDiskVolumeSource | 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. | |
glusterfs | IoK8SApiCoreV1GlusterfsPersistentVolumeSource | Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. | |
hostPath | IoK8SApiCoreV1HostPathVolumeSource | Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. | |
iscsi | IoK8SApiCoreV1IscsiPersistentVolumeSource | ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. | |
local | IoK8SApiCoreV1LocalVolumeSource | Local represents directly-attached storage with node affinity | |
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 | IoK8SApiCoreV1NFSVolumeSource | Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. | |
nodeAffinity | IoK8SApiCoreV1VolumeNodeAffinity | VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. | |
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 | IoK8SApiCoreV1PhotonPersistentDiskVolumeSource | Represents a Photon Controller persistent disk resource. | |
portworxVolume | IoK8SApiCoreV1PortworxVolumeSource | PortworxVolumeSource represents a Portworx volume resource. | |
quobyte | IoK8SApiCoreV1QuobyteVolumeSource | Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. | |
rbd | IoK8SApiCoreV1RBDPersistentVolumeSource | Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. | |
scaleIO | IoK8SApiCoreV1ScaleIOPersistentVolumeSource | ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume | |
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 | IoK8SApiCoreV1StorageOSPersistentVolumeSource | Represents a StorageOS persistent volume resource. | |
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. This is a beta field and requires enabling VolumeAttributesClass feature (off by default). | |
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 | IoK8SApiCoreV1VsphereVirtualDiskVolumeSource | Represents a vSphere volume resource. |
IoK8SApiCoreV1PersistentVolumeStatus
| Property | Type | Attributes | Description |
|---|---|---|---|
lastPhaseTransitionTime | string | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | |
message | string | message is a human-readable message indicating details about why the volume is in this state. | |
phase | string | phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase | |
reason | string | reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. |
IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations
Additional properties of type string are allowed.
IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels
Additional properties of type string are allowed.
IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry
| Property | Type | Attributes | Description |
|---|---|---|---|
apiVersion | string | APIVersion 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. | |
fieldsType | string | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | |
fieldsV1 | any | Any object | |
manager | string | Manager is an identifier of the workflow managing these fields. | |
operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. | |
subresource | string | Subresource 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. | |
time | string | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. |
IoK8SApimachineryPkgApisMetaV1OwnerReference
| Property | Type | Attributes | Description |
|---|---|---|---|
apiVersion | string | Required | API version of the referent. |
kind | string | Required | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name | string | Required | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
uid | string | Required | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
blockOwnerDeletion | bool | If 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. | |
controller | bool | If true, this reference points to the managing controller. |
IoK8SApiCoreV1AWSElasticBlockStoreVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
volumeID | string | Required | volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
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 | |
partition | int | 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). | |
readOnly | bool | readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
IoK8SApiCoreV1AzureDiskVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
diskName | string | Required | diskName is the Name of the data disk in the blob storage |
diskURI | string | Required | diskURI is the URI of data disk in the blob storage |
cachingMode | string | cachingMode is the Host Caching mode: None, Read Only, Read Write. | |
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. | |
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 | |
readOnly | bool | readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
IoK8SApiCoreV1AzureFilePersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
secretName | string | Required | secretName is the name of secret that contains Azure Storage Account Name and Key |
shareName | string | Required | shareName is the azure Share Name |
readOnly | bool | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
secretNamespace | string | secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod |
IoK8SApiCoreV1PersistentVolumeSpecCapacity
Additional properties of type string are allowed.
IoK8SApiCoreV1CephFSPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
monitors | string[] | Required | monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
path | string | path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / | |
readOnly | bool | 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 | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
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 |
IoK8SApiCoreV1CinderPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
volumeID | string | Required | 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 | bool | 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 | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace |
IoK8SApiCoreV1ObjectReference
| Property | Type | Attributes | Description |
|---|---|---|---|
apiVersion | string | API version of the referent. | |
fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | |
kind | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | |
namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
resourceVersion | string | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | |
uid | string | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
IoK8SApiCoreV1CSIPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
driver | string | Required | driver is the name of the driver to use for this volume. Required. |
volumeHandle | string | Required | volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. |
controllerExpandSecretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
controllerPublishSecretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
fsType | string | fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". | |
nodeExpandSecretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
nodePublishSecretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
nodeStageSecretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
readOnly | bool | readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). | |
volumeAttributes | IoK8SApiCoreV1CSIPersistentVolumeSourceVolumeAttributes | volumeAttributes of the volume to publish. |
IoK8SApiCoreV1FCVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
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. | |
lun | int | lun is Optional: FC target lun number | |
readOnly | bool | readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
targetWWNs | string[] | targetWWNs is Optional: FC target worldwide names (WWNs) | |
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. |
IoK8SApiCoreV1FlexPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
driver | string | Required | 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 | IoK8SApiCoreV1FlexPersistentVolumeSourceOptions | options is Optional: this field holds extra command options if any. | |
readOnly | bool | readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
secretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace |
IoK8SApiCoreV1FlockerVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
datasetName | string | datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated | |
datasetUUID | string | datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset |
IoK8SApiCoreV1GCEPersistentDiskVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
pdName | string | Required | pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
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 | |
partition | int | 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 | |
readOnly | bool | readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
IoK8SApiCoreV1GlusterfsPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
endpoints | string | Required | endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
path | string | Required | path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
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 | |
readOnly | bool | 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 |
IoK8SApiCoreV1HostPathVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
path | string | Required | path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
type | string | type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
IoK8SApiCoreV1IscsiPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
iqn | string | Required | iqn is Target iSCSI Qualified Name. |
lun | int | Required | lun is iSCSI Target Lun number. |
targetPortal | string | Required | targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
chapAuthDiscovery | bool | chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication | |
chapAuthSession | bool | 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 <target portal>:<volume name> 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 | bool | readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. | |
secretRef | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace |
IoK8SApiCoreV1LocalVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
path | string | Required | path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). |
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. |
IoK8SApiCoreV1NFSVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
path | string | Required | path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
server | string | Required | server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
readOnly | bool | 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 |
IoK8SApiCoreV1VolumeNodeAffinity
| Property | Type | Attributes | Description |
|---|---|---|---|
required | IoK8SApiCoreV1NodeSelector | A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. |
IoK8SApiCoreV1PhotonPersistentDiskVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
pdID | string | Required | pdID is the ID that identifies Photon Controller persistent disk |
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. |
IoK8SApiCoreV1PortworxVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
volumeID | string | Required | volumeID uniquely identifies a Portworx volume |
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. | |
readOnly | bool | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
IoK8SApiCoreV1QuobyteVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
registry | string | Required | registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
volume | string | Required | volume is a string that references an already created Quobyte volume by name. |
group | string | group to map volume access to Default is no group | |
readOnly | bool | readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. | |
tenant | string | tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin | |
user | string | user to map volume access to Defaults to serivceaccount user |
IoK8SApiCoreV1RBDPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
image | string | Required | image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
monitors | string[] | Required | 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 | bool | 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 | IoK8SApiCoreV1SecretReference | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace | |
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 |
IoK8SApiCoreV1ScaleIOPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
gateway | string | Required | gateway is the host address of the ScaleIO API Gateway. |
secretRef | IoK8SApiCoreV1SecretReference | Required | SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace |
system | string | Required | 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 | bool | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
sslEnabled | bool | 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. |
IoK8SApiCoreV1StorageOSPersistentVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
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 | bool | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | |
secretRef | IoK8SApiCoreV1ObjectReference | ObjectReference contains enough information to let you inspect or modify the referred object. | |
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. |
IoK8SApiCoreV1VsphereVirtualDiskVolumeSource
| Property | Type | Attributes | Description |
|---|---|---|---|
volumePath | string | Required | volumePath is the path that identifies vSphere volume vmdk |
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. | |
storagePolicyID | string | storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. | |
storagePolicyName | string | storagePolicyName is the storage Policy Based Management (SPBM) profile name. |
IoK8SApiCoreV1SecretReference
| Property | Type | Attributes | Description |
|---|---|---|---|
name | string | name is unique within a namespace to reference a secret resource. | |
namespace | string | namespace defines the space within which the secret name must be unique. |
IoK8SApiCoreV1CSIPersistentVolumeSourceVolumeAttributes
Additional properties of type string are allowed.
IoK8SApiCoreV1FlexPersistentVolumeSourceOptions
Additional properties of type string are allowed.
IoK8SApiCoreV1NodeSelector
| Property | Type | Attributes | Description |
|---|---|---|---|
nodeSelectorTerms | IoK8SApiCoreV1NodeSelectorTerm[] | Required | Required. A list of node selector terms. The terms are ORed. |
IoK8SApiCoreV1NodeSelectorTerm
| Property | Type | Attributes | Description |
|---|---|---|---|
matchExpressions | IoK8SApiCoreV1NodeSelectorRequirement[] | A list of node selector requirements by node's labels. | |
matchFields | IoK8SApiCoreV1NodeSelectorRequirement[] | A list of node selector requirements by node's fields. |
IoK8SApiCoreV1NodeSelectorRequirement
| Property | Type | Attributes | Description |
|---|---|---|---|
key | string | Required | The label key that the selector applies to. |
operator | string | Required | Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
values | string[] | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |