Update API Reference multi-pages for v1.24
This commit is contained in:
Philippe Martin
@@ -34,7 +34,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **name** (string), required
|
||||
|
||||
Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
name 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
|
||||
|
||||
|
||||
|
||||
@@ -43,25 +43,25 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **persistentVolumeClaim** (PersistentVolumeClaimVolumeSource)
|
||||
|
||||
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
|
||||
|
||||
<a name="PersistentVolumeClaimVolumeSource"></a>
|
||||
*PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).*
|
||||
|
||||
- **persistentVolumeClaim.claimName** (string), required
|
||||
|
||||
ClaimName 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
|
||||
claimName 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
|
||||
|
||||
- **persistentVolumeClaim.readOnly** (boolean)
|
||||
|
||||
Will force the ReadOnly setting in VolumeMounts. Default false.
|
||||
readOnly Will force the ReadOnly setting in VolumeMounts. Default false.
|
||||
|
||||
### Projections
|
||||
|
||||
|
||||
- **configMap** (ConfigMapVolumeSource)
|
||||
|
||||
ConfigMap represents a configMap that should populate this volume
|
||||
configMap represents a configMap that should populate this volume
|
||||
|
||||
<a name="ConfigMapVolumeSource"></a>
|
||||
*Adapts a ConfigMap into a volume.
|
||||
@@ -74,19 +74,19 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **configMap.optional** (boolean)
|
||||
|
||||
Specify whether the ConfigMap or its keys must be defined
|
||||
optional specify whether the ConfigMap or its keys must be defined
|
||||
|
||||
- **configMap.defaultMode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **configMap.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
items 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 '..'.
|
||||
|
||||
- **secret** (SecretVolumeSource)
|
||||
|
||||
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
|
||||
<a name="SecretVolumeSource"></a>
|
||||
*Adapts a Secret into a volume.
|
||||
@@ -95,23 +95,23 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **secret.secretName** (string)
|
||||
|
||||
Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
|
||||
|
||||
- **secret.optional** (boolean)
|
||||
|
||||
Specify whether the Secret or its keys must be defined
|
||||
optional field specify whether the Secret or its keys must be defined
|
||||
|
||||
- **secret.defaultMode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **secret.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
items 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 '..'.
|
||||
|
||||
- **downwardAPI** (DownwardAPIVolumeSource)
|
||||
|
||||
DownwardAPI represents downward API about the pod that should populate this volume
|
||||
downwardAPI represents downward API about the pod that should populate this volume
|
||||
|
||||
<a name="DownwardAPIVolumeSource"></a>
|
||||
*DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.*
|
||||
@@ -126,25 +126,25 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **projected** (ProjectedVolumeSource)
|
||||
|
||||
Items for all in one resources secrets, configmaps, and downward API
|
||||
projected items for all in one resources secrets, configmaps, and downward API
|
||||
|
||||
<a name="ProjectedVolumeSource"></a>
|
||||
*Represents a projected volume source*
|
||||
|
||||
- **projected.defaultMode** (int32)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **projected.sources** ([]VolumeProjection)
|
||||
|
||||
list of volume projections
|
||||
sources is the list of volume projections
|
||||
|
||||
<a name="VolumeProjection"></a>
|
||||
*Projection that may be projected along with other supported volume types*
|
||||
|
||||
- **projected.sources.configMap** (ConfigMapProjection)
|
||||
|
||||
information about the configMap data to project
|
||||
configMap information about the configMap data to project
|
||||
|
||||
<a name="ConfigMapProjection"></a>
|
||||
*Adapts a ConfigMap into a projected volume.
|
||||
@@ -157,15 +157,15 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **projected.sources.configMap.optional** (boolean)
|
||||
|
||||
Specify whether the ConfigMap or its keys must be defined
|
||||
optional specify whether the ConfigMap or its keys must be defined
|
||||
|
||||
- **projected.sources.configMap.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
items 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 '..'.
|
||||
|
||||
- **projected.sources.downwardAPI** (DownwardAPIProjection)
|
||||
|
||||
information about the downwardAPI data to project
|
||||
downwardAPI information about the downwardAPI data to project
|
||||
|
||||
<a name="DownwardAPIProjection"></a>
|
||||
*Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.*
|
||||
@@ -176,7 +176,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **projected.sources.secret** (SecretProjection)
|
||||
|
||||
information about the secret data to project
|
||||
secret information about the secret data to project
|
||||
|
||||
<a name="SecretProjection"></a>
|
||||
*Adapts a secret into a projected volume.
|
||||
@@ -189,70 +189,70 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **projected.sources.secret.optional** (boolean)
|
||||
|
||||
Specify whether the Secret or its key must be defined
|
||||
optional field specify whether the Secret or its key must be defined
|
||||
|
||||
- **projected.sources.secret.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
|
||||
|
||||
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 '..'.
|
||||
items 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 '..'.
|
||||
|
||||
- **projected.sources.serviceAccountToken** (ServiceAccountTokenProjection)
|
||||
|
||||
information about the serviceAccountToken data to project
|
||||
serviceAccountToken is information about the serviceAccountToken data to project
|
||||
|
||||
<a name="ServiceAccountTokenProjection"></a>
|
||||
*ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).*
|
||||
|
||||
- **projected.sources.serviceAccountToken.path** (string), required
|
||||
|
||||
Path is the path relative to the mount point of the file to project the token into.
|
||||
path is the path relative to the mount point of the file to project the token into.
|
||||
|
||||
- **projected.sources.serviceAccountToken.audience** (string)
|
||||
|
||||
Audience 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.
|
||||
audience 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.
|
||||
|
||||
- **projected.sources.serviceAccountToken.expirationSeconds** (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.
|
||||
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.
|
||||
|
||||
### Local / Temporary Directory
|
||||
|
||||
|
||||
- **emptyDir** (EmptyDirVolumeSource)
|
||||
|
||||
EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
|
||||
emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
|
||||
|
||||
<a name="EmptyDirVolumeSource"></a>
|
||||
*Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **emptyDir.medium** (string)
|
||||
|
||||
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
|
||||
medium 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
|
||||
|
||||
- **emptyDir.sizeLimit** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
sizeLimit 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: http://kubernetes.io/docs/user-guide/volumes#emptydir
|
||||
|
||||
- **hostPath** (HostPathVolumeSource)
|
||||
|
||||
HostPath 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
|
||||
hostPath 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
|
||||
|
||||
<a name="HostPathVolumeSource"></a>
|
||||
*Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **hostPath.path** (string), required
|
||||
|
||||
Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
- **hostPath.type** (string)
|
||||
|
||||
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
### Persistent volumes
|
||||
|
||||
|
||||
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
|
||||
|
||||
AWSElasticBlockStore represents an AWS 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#awselasticblockstore
|
||||
awsElasticBlockStore represents an AWS 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#awselasticblockstore
|
||||
|
||||
<a name="AWSElasticBlockStoreVolumeSource"></a>
|
||||
*Represents a Persistent Disk resource in AWS.
|
||||
@@ -261,223 +261,223 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **awsElasticBlockStore.volumeID** (string), required
|
||||
|
||||
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **awsElasticBlockStore.fsType** (string)
|
||||
|
||||
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
|
||||
fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **awsElasticBlockStore.partition** (int32)
|
||||
|
||||
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).
|
||||
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
|
||||
|
||||
- **awsElasticBlockStore.readOnly** (boolean)
|
||||
|
||||
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
|
||||
|
||||
- **azureDisk** (AzureDiskVolumeSource)
|
||||
|
||||
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
|
||||
<a name="AzureDiskVolumeSource"></a>
|
||||
*AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.*
|
||||
|
||||
- **azureDisk.diskName** (string), required
|
||||
|
||||
The Name of the data disk in the blob storage
|
||||
diskName is the Name of the data disk in the blob storage
|
||||
|
||||
- **azureDisk.diskURI** (string), required
|
||||
|
||||
The URI the data disk in the blob storage
|
||||
diskURI is the URI of data disk in the blob storage
|
||||
|
||||
- **azureDisk.cachingMode** (string)
|
||||
|
||||
Host Caching mode: None, Read Only, Read Write.
|
||||
cachingMode is the Host Caching mode: None, Read Only, Read Write.
|
||||
|
||||
- **azureDisk.fsType** (string)
|
||||
|
||||
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.
|
||||
fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
|
||||
- **azureDisk.kind** (string)
|
||||
|
||||
Expected values 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
|
||||
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
|
||||
|
||||
- **azureDisk.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **azureFile** (AzureFileVolumeSource)
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
|
||||
<a name="AzureFileVolumeSource"></a>
|
||||
*AzureFile represents an Azure File Service mount on the host and bind mount to the pod.*
|
||||
|
||||
- **azureFile.secretName** (string), required
|
||||
|
||||
the name of secret that contains Azure Storage Account Name and Key
|
||||
secretName is the name of secret that contains Azure Storage Account Name and Key
|
||||
|
||||
- **azureFile.shareName** (string), required
|
||||
|
||||
Share Name
|
||||
shareName is the azure share Name
|
||||
|
||||
- **azureFile.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **cephfs** (CephFSVolumeSource)
|
||||
|
||||
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
|
||||
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
|
||||
|
||||
<a name="CephFSVolumeSource"></a>
|
||||
*Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **cephfs.monitors** ([]string), required
|
||||
|
||||
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
- **cephfs.path** (string)
|
||||
|
||||
Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
|
||||
|
||||
- **cephfs.readOnly** (boolean)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cephfs.secretFile** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **cephfs.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
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
|
||||
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
|
||||
- **cephfs.user** (string)
|
||||
|
||||
Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **cinder** (CinderVolumeSource)
|
||||
|
||||
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
|
||||
<a name="CinderVolumeSource"></a>
|
||||
*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.*
|
||||
|
||||
- **cinder.volumeID** (string), required
|
||||
|
||||
volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
|
||||
|
||||
- **cinder.fsType** (string)
|
||||
|
||||
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
|
||||
fsType 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
|
||||
|
||||
- **cinder.readOnly** (boolean)
|
||||
|
||||
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
|
||||
readOnly 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
|
||||
|
||||
- **cinder.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
Optional: points to a secret object containing parameters used to connect to OpenStack.
|
||||
secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
|
||||
|
||||
- **csi** (CSIVolumeSource)
|
||||
|
||||
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
|
||||
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
|
||||
|
||||
<a name="CSIVolumeSource"></a>
|
||||
*Represents a source location of a volume to mount, managed by an external CSI driver*
|
||||
|
||||
- **csi.driver** (string), required
|
||||
|
||||
Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
|
||||
driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
|
||||
|
||||
- **csi.fsType** (string)
|
||||
|
||||
Filesystem type 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.
|
||||
fsType 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.
|
||||
|
||||
- **csi.nodePublishSecretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
|
||||
nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
Specifies a read-only configuration for the volume. Defaults to false (read/write).
|
||||
readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).
|
||||
|
||||
- **csi.volumeAttributes** (map[string]string)
|
||||
|
||||
VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
|
||||
volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
|
||||
|
||||
- **fc** (FCVolumeSource)
|
||||
|
||||
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
|
||||
<a name="FCVolumeSource"></a>
|
||||
*Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **fc.fsType** (string)
|
||||
|
||||
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.
|
||||
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
|
||||
- **fc.lun** (int32)
|
||||
|
||||
Optional: FC target lun number
|
||||
lun is Optional: FC target lun number
|
||||
|
||||
- **fc.readOnly** (boolean)
|
||||
|
||||
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **fc.targetWWNs** ([]string)
|
||||
|
||||
Optional: FC target worldwide names (WWNs)
|
||||
targetWWNs is Optional: FC target worldwide names (WWNs)
|
||||
|
||||
- **fc.wwids** ([]string)
|
||||
|
||||
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
|
||||
wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
|
||||
|
||||
- **flexVolume** (FlexVolumeSource)
|
||||
|
||||
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
|
||||
flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
|
||||
|
||||
<a name="FlexVolumeSource"></a>
|
||||
*FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.*
|
||||
|
||||
- **flexVolume.driver** (string), required
|
||||
|
||||
Driver is the name of the driver to use for this volume.
|
||||
driver is the name of the driver to use for this volume.
|
||||
|
||||
- **flexVolume.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **flexVolume.options** (map[string]string)
|
||||
|
||||
Optional: Extra command options if any.
|
||||
options is Optional: this field holds extra command options if any.
|
||||
|
||||
- **flexVolume.readOnly** (boolean)
|
||||
|
||||
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **flexVolume.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
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.
|
||||
secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
|
||||
|
||||
- **flocker** (FlockerVolumeSource)
|
||||
|
||||
Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
|
||||
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
|
||||
|
||||
<a name="FlockerVolumeSource"></a>
|
||||
*Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **flocker.datasetName** (string)
|
||||
|
||||
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
|
||||
|
||||
- **flocker.datasetUUID** (string)
|
||||
|
||||
UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
|
||||
|
||||
- **gcePersistentDisk** (GCEPersistentDiskVolumeSource)
|
||||
|
||||
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
gcePersistentDisk represents a GCE 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#gcepersistentdisk
|
||||
|
||||
<a name="GCEPersistentDiskVolumeSource"></a>
|
||||
*Represents a Persistent Disk resource in Google Compute Engine.
|
||||
@@ -486,316 +486,316 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **gcePersistentDisk.pdName** (string), required
|
||||
|
||||
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
|
||||
pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
- **gcePersistentDisk.fsType** (string)
|
||||
|
||||
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
|
||||
fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
- **gcePersistentDisk.partition** (int32)
|
||||
|
||||
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
|
||||
partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
- **gcePersistentDisk.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
|
||||
|
||||
- **glusterfs** (GlusterfsVolumeSource)
|
||||
|
||||
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
|
||||
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
|
||||
|
||||
<a name="GlusterfsVolumeSource"></a>
|
||||
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **glusterfs.endpoints** (string), required
|
||||
|
||||
EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.path** (string), required
|
||||
|
||||
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
|
||||
- **glusterfs.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
|
||||
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
|
||||
|
||||
- **iscsi** (ISCSIVolumeSource)
|
||||
|
||||
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
|
||||
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
|
||||
|
||||
<a name="ISCSIVolumeSource"></a>
|
||||
*Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **iscsi.iqn** (string), required
|
||||
|
||||
Target iSCSI Qualified Name.
|
||||
iqn is the target iSCSI Qualified Name.
|
||||
|
||||
- **iscsi.lun** (int32), required
|
||||
|
||||
iSCSI Target Lun number.
|
||||
lun represents iSCSI Target Lun number.
|
||||
|
||||
- **iscsi.targetPortal** (string), required
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **iscsi.chapAuthDiscovery** (boolean)
|
||||
|
||||
whether support iSCSI Discovery CHAP authentication
|
||||
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
|
||||
|
||||
- **iscsi.chapAuthSession** (boolean)
|
||||
|
||||
whether support iSCSI Session CHAP authentication
|
||||
chapAuthSession defines whether support iSCSI Session CHAP authentication
|
||||
|
||||
- **iscsi.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **iscsi.initiatorName** (string)
|
||||
|
||||
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \<target portal>:\<volume name> will be created for the connection.
|
||||
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.
|
||||
|
||||
- **iscsi.iscsiInterface** (string)
|
||||
|
||||
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
|
||||
iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
|
||||
|
||||
- **iscsi.portals** ([]string)
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
- **iscsi.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
|
||||
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
|
||||
|
||||
- **iscsi.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
CHAP Secret for iSCSI target and initiator authentication
|
||||
secretRef is the CHAP Secret for iSCSI target and initiator authentication
|
||||
|
||||
- **nfs** (NFSVolumeSource)
|
||||
|
||||
NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
<a name="NFSVolumeSource"></a>
|
||||
*Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **nfs.path** (string), required
|
||||
|
||||
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
- **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
|
||||
server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
|
||||
- **nfs.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
|
||||
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
|
||||
|
||||
- **photonPersistentDisk** (PhotonPersistentDiskVolumeSource)
|
||||
|
||||
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
|
||||
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
|
||||
|
||||
<a name="PhotonPersistentDiskVolumeSource"></a>
|
||||
*Represents a Photon Controller persistent disk resource.*
|
||||
|
||||
- **photonPersistentDisk.pdID** (string), required
|
||||
|
||||
ID that identifies Photon Controller persistent disk
|
||||
pdID is the ID that identifies Photon Controller persistent disk
|
||||
|
||||
- **photonPersistentDisk.fsType** (string)
|
||||
|
||||
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.
|
||||
fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
|
||||
- **portworxVolume** (PortworxVolumeSource)
|
||||
|
||||
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
|
||||
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
|
||||
|
||||
<a name="PortworxVolumeSource"></a>
|
||||
*PortworxVolumeSource represents a Portworx volume resource.*
|
||||
|
||||
- **portworxVolume.volumeID** (string), required
|
||||
|
||||
VolumeID uniquely identifies a Portworx volume
|
||||
volumeID uniquely identifies a Portworx volume
|
||||
|
||||
- **portworxVolume.fsType** (string)
|
||||
|
||||
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
|
||||
- **portworxVolume.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **quobyte** (QuobyteVolumeSource)
|
||||
|
||||
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
|
||||
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
|
||||
|
||||
<a name="QuobyteVolumeSource"></a>
|
||||
*Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.*
|
||||
|
||||
- **quobyte.registry** (string), required
|
||||
|
||||
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
|
||||
registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
|
||||
|
||||
- **quobyte.volume** (string), required
|
||||
|
||||
Volume is a string that references an already created Quobyte volume by name.
|
||||
volume is a string that references an already created Quobyte volume by name.
|
||||
|
||||
- **quobyte.group** (string)
|
||||
|
||||
Group to map volume access to Default is no group
|
||||
group to map volume access to Default is no group
|
||||
|
||||
- **quobyte.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
|
||||
readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
|
||||
|
||||
- **quobyte.tenant** (string)
|
||||
|
||||
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
|
||||
tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
|
||||
|
||||
- **quobyte.user** (string)
|
||||
|
||||
User to map volume access to Defaults to serivceaccount user
|
||||
user to map volume access to Defaults to serivceaccount user
|
||||
|
||||
- **rbd** (RBDVolumeSource)
|
||||
|
||||
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
|
||||
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
|
||||
|
||||
<a name="RBDVolumeSource"></a>
|
||||
*Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.*
|
||||
|
||||
- **rbd.image** (string), required
|
||||
|
||||
The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.monitors** ([]string), required
|
||||
|
||||
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.fsType** (string)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
- **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
|
||||
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
|
||||
|
||||
- **rbd.pool** (string)
|
||||
|
||||
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.readOnly** (boolean)
|
||||
|
||||
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
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
|
||||
|
||||
- **rbd.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **rbd.user** (string)
|
||||
|
||||
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
|
||||
|
||||
- **scaleIO** (ScaleIOVolumeSource)
|
||||
|
||||
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
|
||||
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
|
||||
|
||||
<a name="ScaleIOVolumeSource"></a>
|
||||
*ScaleIOVolumeSource represents a persistent ScaleIO volume*
|
||||
|
||||
- **scaleIO.gateway** (string), required
|
||||
|
||||
The host address of the ScaleIO API Gateway.
|
||||
gateway is the host address of the ScaleIO API Gateway.
|
||||
|
||||
- **scaleIO.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>), required
|
||||
|
||||
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
|
||||
secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
|
||||
|
||||
- **scaleIO.system** (string), required
|
||||
|
||||
The name of the storage system as configured in ScaleIO.
|
||||
system is the name of the storage system as configured in ScaleIO.
|
||||
|
||||
- **scaleIO.fsType** (string)
|
||||
|
||||
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
|
||||
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".
|
||||
|
||||
- **scaleIO.protectionDomain** (string)
|
||||
|
||||
The name of the ScaleIO Protection Domain for the configured storage.
|
||||
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
|
||||
|
||||
- **scaleIO.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **scaleIO.sslEnabled** (boolean)
|
||||
|
||||
Flag to enable/disable SSL communication with Gateway, default false
|
||||
sslEnabled Flag enable/disable SSL communication with Gateway, default false
|
||||
|
||||
- **scaleIO.storageMode** (string)
|
||||
|
||||
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
|
||||
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
|
||||
|
||||
- **scaleIO.storagePool** (string)
|
||||
|
||||
The ScaleIO Storage Pool associated with the protection domain.
|
||||
storagePool is the ScaleIO Storage Pool associated with the protection domain.
|
||||
|
||||
- **scaleIO.volumeName** (string)
|
||||
|
||||
The name of a volume already created in the ScaleIO system that is associated with this volume source.
|
||||
volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
|
||||
|
||||
- **storageos** (StorageOSVolumeSource)
|
||||
|
||||
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
|
||||
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
|
||||
|
||||
<a name="StorageOSVolumeSource"></a>
|
||||
*Represents a StorageOS persistent volume resource.*
|
||||
|
||||
- **storageos.fsType** (string)
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
- **storageos.readOnly** (boolean)
|
||||
|
||||
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
|
||||
|
||||
- **storageos.secretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
|
||||
|
||||
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
|
||||
secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
|
||||
|
||||
- **storageos.volumeName** (string)
|
||||
|
||||
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
|
||||
volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
|
||||
|
||||
- **storageos.volumeNamespace** (string)
|
||||
|
||||
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
|
||||
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.
|
||||
|
||||
- **vsphereVolume** (VsphereVirtualDiskVolumeSource)
|
||||
|
||||
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|
||||
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
|
||||
|
||||
<a name="VsphereVirtualDiskVolumeSource"></a>
|
||||
*Represents a vSphere volume resource.*
|
||||
|
||||
- **vsphereVolume.volumePath** (string), required
|
||||
|
||||
Path that identifies vSphere volume vmdk
|
||||
volumePath is the path that identifies vSphere volume vmdk
|
||||
|
||||
- **vsphereVolume.fsType** (string)
|
||||
|
||||
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.
|
||||
fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
|
||||
|
||||
- **vsphereVolume.storagePolicyID** (string)
|
||||
|
||||
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
|
||||
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
|
||||
|
||||
- **vsphereVolume.storagePolicyName** (string)
|
||||
|
||||
Storage Policy Based Management (SPBM) profile name.
|
||||
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
|
||||
|
||||
### Alpha level
|
||||
|
||||
|
||||
- **ephemeral** (EphemeralVolumeSource)
|
||||
|
||||
Ephemeral 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.
|
||||
ephemeral 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,
|
||||
@@ -839,7 +839,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **gitRepo** (GitRepoVolumeSource)
|
||||
|
||||
GitRepo 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.
|
||||
gitRepo 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.
|
||||
|
||||
<a name="GitRepoVolumeSource"></a>
|
||||
*Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
|
||||
@@ -848,15 +848,15 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
- **gitRepo.repository** (string), required
|
||||
|
||||
Repository URL
|
||||
repository is the URL
|
||||
|
||||
- **gitRepo.directory** (string)
|
||||
|
||||
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.
|
||||
directory 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.
|
||||
|
||||
- **gitRepo.revision** (string)
|
||||
|
||||
Commit hash for the specified revision.
|
||||
revision is the commit hash for the specified revision.
|
||||
|
||||
|
||||
|
||||
@@ -894,15 +894,15 @@ Maps a string key to a path within a volume.
|
||||
|
||||
- **key** (string), required
|
||||
|
||||
The key to project.
|
||||
key is the key to project.
|
||||
|
||||
- **path** (string), required
|
||||
|
||||
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 '..'.
|
||||
path 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 '..'.
|
||||
|
||||
- **mode** (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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user