Prepare for v1.21 + indentation + local common definitions
This commit is contained in:
Philippe Martin
+1
-1
@@ -40,7 +40,7 @@ ConfigMap holds configuration data for pods to consume.
|
||||
|
||||
- **immutable** (boolean)
|
||||
|
||||
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.
|
||||
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
|
||||
|
||||
|
||||
|
||||
|
||||
+14
-4
@@ -47,17 +47,23 @@ CSIDriverSpec is the specification of a CSIDriver.
|
||||
- **attachRequired** (boolean)
|
||||
|
||||
attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.
|
||||
|
||||
This field is immutable.
|
||||
|
||||
- **fsGroupPolicy** (string)
|
||||
|
||||
Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.
|
||||
|
||||
This field is immutable.
|
||||
|
||||
- **podInfoOnMount** (boolean)
|
||||
|
||||
If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume
|
||||
If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
|
||||
defined by a CSIVolumeSource, otherwise "false"
|
||||
|
||||
"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver.
|
||||
|
||||
This field is immutable.
|
||||
|
||||
- **requiresRepublish** (boolean)
|
||||
|
||||
@@ -65,7 +71,7 @@ CSIDriverSpec is the specification of a CSIDriver.
|
||||
|
||||
Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.
|
||||
|
||||
This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled.
|
||||
This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
|
||||
|
||||
- **storageCapacity** (boolean)
|
||||
|
||||
@@ -75,7 +81,9 @@ CSIDriverSpec is the specification of a CSIDriver.
|
||||
|
||||
Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.
|
||||
|
||||
This is an alpha field and only available when the CSIStorageCapacity feature is enabled. The default is false.
|
||||
This field is immutable.
|
||||
|
||||
This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
|
||||
|
||||
- **tokenRequests** ([]TokenRequest)
|
||||
|
||||
@@ -91,7 +99,7 @@ CSIDriverSpec is the specification of a CSIDriver.
|
||||
|
||||
Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.
|
||||
|
||||
This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled.
|
||||
This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
|
||||
|
||||
<a name="TokenRequest"></a>
|
||||
*TokenRequest contains parameters of a service account token.*
|
||||
@@ -109,6 +117,8 @@ CSIDriverSpec is the specification of a CSIDriver.
|
||||
*Set: unique values will be kept during a merge*
|
||||
|
||||
volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta.
|
||||
|
||||
This field is immutable.
|
||||
|
||||
|
||||
|
||||
|
||||
+2
-2
@@ -68,9 +68,9 @@ CSINodeSpec holds information about the specification of all CSI drivers install
|
||||
<a name="VolumeNodeResources"></a>
|
||||
*VolumeNodeResources is a set of resource limits for scheduling of volumes.*
|
||||
|
||||
- **drivers.allocatable.count** (int32)
|
||||
- **drivers.allocatable.count** (int32)
|
||||
|
||||
Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.
|
||||
Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.
|
||||
|
||||
- **drivers.topologyKeys** ([]string)
|
||||
|
||||
|
||||
+566
@@ -0,0 +1,566 @@
|
||||
---
|
||||
api_metadata:
|
||||
apiVersion: "storage.k8s.io/v1beta1"
|
||||
import: "k8s.io/api/storage/v1beta1"
|
||||
kind: "CSIStorageCapacity"
|
||||
content_type: "api_reference"
|
||||
description: "CSIStorageCapacity stores the result of one CSI GetCapacity call."
|
||||
title: "CSIStorageCapacity v1beta1"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
`apiVersion: storage.k8s.io/v1beta1`
|
||||
|
||||
`import "k8s.io/api/storage/v1beta1"`
|
||||
|
||||
|
||||
## CSIStorageCapacity {#CSIStorageCapacity}
|
||||
|
||||
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.
|
||||
|
||||
For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"
|
||||
|
||||
The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero
|
||||
|
||||
The producer of these objects can decide which approach is more suitable.
|
||||
|
||||
They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.
|
||||
|
||||
<hr>
|
||||
|
||||
- **apiVersion**: storage.k8s.io/v1beta1
|
||||
|
||||
|
||||
- **kind**: CSIStorageCapacity
|
||||
|
||||
|
||||
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
|
||||
|
||||
Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-\<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.
|
||||
|
||||
Objects are namespaced.
|
||||
|
||||
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
- **storageClassName** (string), required
|
||||
|
||||
The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
|
||||
|
||||
- **capacity** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
|
||||
|
||||
The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
|
||||
|
||||
- **maximumVolumeSize** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
|
||||
|
||||
This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
|
||||
|
||||
- **nodeTopology** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
|
||||
|
||||
NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## CSIStorageCapacityList {#CSIStorageCapacityList}
|
||||
|
||||
CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
|
||||
|
||||
<hr>
|
||||
|
||||
- **apiVersion**: storage.k8s.io/v1beta1
|
||||
|
||||
|
||||
- **kind**: CSIStorageCapacityList
|
||||
|
||||
|
||||
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
|
||||
|
||||
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
- **items** ([]<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>), required
|
||||
|
||||
*Map: unique values on key name will be kept during a merge*
|
||||
|
||||
Items is the list of CSIStorageCapacity objects.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Operations {#Operations}
|
||||
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### `get` read the specified CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the CSIStorageCapacity
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `list` list or watch objects of kind CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **allowWatchBookmarks** (*in query*): boolean
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
|
||||
|
||||
|
||||
- **continue** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
|
||||
|
||||
|
||||
- **fieldSelector** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
|
||||
|
||||
|
||||
- **labelSelector** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
|
||||
|
||||
|
||||
- **limit** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
- **resourceVersion** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
|
||||
|
||||
|
||||
- **resourceVersionMatch** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
|
||||
|
||||
|
||||
- **timeoutSeconds** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
|
||||
|
||||
|
||||
- **watch** (*in query*): boolean
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `list` list or watch objects of kind CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
GET /apis/storage.k8s.io/v1beta1/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **allowWatchBookmarks** (*in query*): boolean
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
|
||||
|
||||
|
||||
- **continue** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
|
||||
|
||||
|
||||
- **fieldSelector** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
|
||||
|
||||
|
||||
- **labelSelector** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
|
||||
|
||||
|
||||
- **limit** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
- **resourceVersion** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
|
||||
|
||||
|
||||
- **resourceVersionMatch** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
|
||||
|
||||
|
||||
- **timeoutSeconds** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
|
||||
|
||||
|
||||
- **watch** (*in query*): boolean
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `create` create a CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
|
||||
|
||||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **fieldManager** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
|
||||
202 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Accepted
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `update` replace the specified CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the CSIStorageCapacity
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
|
||||
|
||||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **fieldManager** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `patch` partially update the specified CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the CSIStorageCapacity
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
|
||||
|
||||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **fieldManager** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
||||
|
||||
|
||||
- **force** (*in query*): boolean
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `delete` delete a CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **name** (*in path*): string, required
|
||||
|
||||
name of the CSIStorageCapacity
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
|
||||
|
||||
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **gracePeriodSeconds** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
- **propagationPolicy** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
|
||||
|
||||
202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): Accepted
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
### `deletecollection` delete collection of CSIStorageCapacity
|
||||
|
||||
#### HTTP Request
|
||||
|
||||
DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
|
||||
|
||||
#### Parameters
|
||||
|
||||
|
||||
- **namespace** (*in path*): string, required
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
|
||||
|
||||
|
||||
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
|
||||
|
||||
|
||||
|
||||
|
||||
- **continue** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
|
||||
|
||||
|
||||
- **dryRun** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
||||
|
||||
|
||||
- **fieldSelector** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
|
||||
|
||||
|
||||
- **gracePeriodSeconds** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
|
||||
|
||||
|
||||
- **labelSelector** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
|
||||
|
||||
|
||||
- **limit** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
|
||||
|
||||
|
||||
- **pretty** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
||||
|
||||
|
||||
- **propagationPolicy** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
|
||||
|
||||
|
||||
- **resourceVersion** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
|
||||
|
||||
|
||||
- **resourceVersionMatch** (*in query*): string
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
|
||||
|
||||
|
||||
- **timeoutSeconds** (*in query*): integer
|
||||
|
||||
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
|
||||
|
||||
|
||||
|
||||
#### Response
|
||||
|
||||
|
||||
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
+2
-2
@@ -65,11 +65,11 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
|
||||
|
||||
- **resources.limits** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|
||||
|
||||
- **resources.requests** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
|
||||
|
||||
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
|
||||
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
|
||||
|
||||
- **volumeName** (string)
|
||||
|
||||
|
||||
+119
-122
@@ -78,20 +78,20 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="NodeSelector"></a>
|
||||
*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.*
|
||||
|
||||
- **nodeAffinity.required.nodeSelectorTerms** ([]NodeSelectorTerm), required
|
||||
- **nodeAffinity.required.nodeSelectorTerms** ([]NodeSelectorTerm), required
|
||||
|
||||
Required. A list of node selector terms. The terms are ORed.
|
||||
Required. A list of node selector terms. The terms are ORed.
|
||||
|
||||
<a name="NodeSelectorTerm"></a>
|
||||
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
|
||||
<a name="NodeSelectorTerm"></a>
|
||||
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
|
||||
|
||||
- **nodeAffinity.required.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
- **nodeAffinity.required.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
|
||||
A list of node selector requirements by node's labels.
|
||||
A list of node selector requirements by node's labels.
|
||||
|
||||
- **nodeAffinity.required.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
- **nodeAffinity.required.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
|
||||
|
||||
A list of node selector requirements by node's fields.
|
||||
A list of node selector requirements by node's fields.
|
||||
|
||||
- **persistentVolumeReclaimPolicy** (string)
|
||||
|
||||
@@ -252,13 +252,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **cephfs.secretRef.name** (string)
|
||||
- **cephfs.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **cephfs.secretRef.namespace** (string)
|
||||
- **cephfs.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **cephfs.user** (string)
|
||||
|
||||
@@ -290,13 +290,100 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **cinder.secretRef.name** (string)
|
||||
- **cinder.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **cinder.secretRef.namespace** (string)
|
||||
- **cinder.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi** (CSIPersistentVolumeSource)
|
||||
|
||||
CSI represents storage that is handled by an external CSI driver (Beta feature).
|
||||
|
||||
<a name="CSIPersistentVolumeSource"></a>
|
||||
*Represents storage that is managed by an external CSI volume driver (Beta feature)*
|
||||
|
||||
- **csi.driver** (string), required
|
||||
|
||||
Driver is the name of the driver to use for this volume. Required.
|
||||
|
||||
- **csi.volumeHandle** (string), required
|
||||
|
||||
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
|
||||
|
||||
- **csi.controllerExpandSecretRef** (SecretReference)
|
||||
|
||||
ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.controllerExpandSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.controllerExpandSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.controllerPublishSecretRef** (SecretReference)
|
||||
|
||||
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.controllerPublishSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.controllerPublishSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.fsType** (string)
|
||||
|
||||
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
|
||||
|
||||
- **csi.nodePublishSecretRef** (SecretReference)
|
||||
|
||||
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.nodePublishSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.nodePublishSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.nodeStageSecretRef** (SecretReference)
|
||||
|
||||
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.nodeStageSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.nodeStageSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
|
||||
|
||||
- **csi.volumeAttributes** (map[string]string)
|
||||
|
||||
Attributes of the volume to publish.
|
||||
|
||||
- **fc** (FCVolumeSource)
|
||||
|
||||
@@ -355,13 +442,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **flexVolume.secretRef.name** (string)
|
||||
- **flexVolume.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **flexVolume.secretRef.namespace** (string)
|
||||
- **flexVolume.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **flocker** (FlockerVolumeSource)
|
||||
|
||||
@@ -480,13 +567,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **iscsi.secretRef.name** (string)
|
||||
- **iscsi.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **iscsi.secretRef.namespace** (string)
|
||||
- **iscsi.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **nfs** (NFSVolumeSource)
|
||||
|
||||
@@ -610,13 +697,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **rbd.secretRef.name** (string)
|
||||
- **rbd.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **rbd.secretRef.namespace** (string)
|
||||
- **rbd.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **rbd.user** (string)
|
||||
|
||||
@@ -640,13 +727,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **scaleIO.secretRef.name** (string)
|
||||
- **scaleIO.secretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **scaleIO.secretRef.namespace** (string)
|
||||
- **scaleIO.secretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **scaleIO.system** (string), required
|
||||
|
||||
@@ -730,96 +817,6 @@ PersistentVolumeSpec is the specification of a persistent volume.
|
||||
|
||||
Storage Policy Based Management (SPBM) profile name.
|
||||
|
||||
### Beta level
|
||||
|
||||
|
||||
- **csi** (CSIPersistentVolumeSource)
|
||||
|
||||
CSI represents storage that is handled by an external CSI driver (Beta feature).
|
||||
|
||||
<a name="CSIPersistentVolumeSource"></a>
|
||||
*Represents storage that is managed by an external CSI volume driver (Beta feature)*
|
||||
|
||||
- **csi.driver** (string), required
|
||||
|
||||
Driver is the name of the driver to use for this volume. Required.
|
||||
|
||||
- **csi.volumeHandle** (string), required
|
||||
|
||||
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
|
||||
|
||||
- **csi.controllerExpandSecretRef** (SecretReference)
|
||||
|
||||
ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.controllerExpandSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.controllerExpandSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.controllerPublishSecretRef** (SecretReference)
|
||||
|
||||
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.controllerPublishSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.controllerPublishSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.fsType** (string)
|
||||
|
||||
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
|
||||
|
||||
- **csi.nodePublishSecretRef** (SecretReference)
|
||||
|
||||
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.nodePublishSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.nodePublishSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.nodeStageSecretRef** (SecretReference)
|
||||
|
||||
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
|
||||
|
||||
<a name="SecretReference"></a>
|
||||
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
|
||||
|
||||
- **csi.nodeStageSecretRef.name** (string)
|
||||
|
||||
Name is unique within a namespace to reference a secret resource.
|
||||
|
||||
- **csi.nodeStageSecretRef.namespace** (string)
|
||||
|
||||
Namespace defines the space within which the secret name must be unique.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
|
||||
|
||||
- **csi.volumeAttributes** (map[string]string)
|
||||
|
||||
Attributes of the volume to publish.
|
||||
|
||||
|
||||
|
||||
## PersistentVolumeStatus {#PersistentVolumeStatus}
|
||||
|
||||
@@ -36,11 +36,11 @@ Secret holds secret data of a certain type. The total bytes of the values in the
|
||||
|
||||
- **immutable** (boolean)
|
||||
|
||||
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.
|
||||
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
|
||||
|
||||
- **stringData** (map[string]string)
|
||||
|
||||
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
|
||||
stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
|
||||
|
||||
- **type** (string)
|
||||
|
||||
|
||||
+4
-4
@@ -54,13 +54,13 @@ StorageClasses are non-namespaced; the name of the storage class according to et
|
||||
<a name="TopologySelectorLabelRequirement"></a>
|
||||
*A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.*
|
||||
|
||||
- **allowedTopologies.matchLabelExpressions.key** (string), required
|
||||
- **allowedTopologies.matchLabelExpressions.key** (string), required
|
||||
|
||||
The label key that the selector applies to.
|
||||
The label key that the selector applies to.
|
||||
|
||||
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
|
||||
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
|
||||
|
||||
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
|
||||
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
|
||||
|
||||
- **mountOptions** ([]string)
|
||||
|
||||
|
||||
+1
-1
@@ -67,7 +67,7 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request.
|
||||
|
||||
- **source.inlineVolumeSpec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-v1#PersistentVolumeSpec" >}}">PersistentVolumeSpec</a>)
|
||||
|
||||
inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
|
||||
inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
|
||||
|
||||
- **source.persistentVolumeName** (string)
|
||||
|
||||
|
||||
@@ -14,6 +14,8 @@ weight: 3
|
||||
`import "k8s.io/api/core/v1"`
|
||||
|
||||
|
||||
## Volume {#Volume}
|
||||
|
||||
Volume represents a named volume in a pod that may be accessed by any container in the pod.
|
||||
|
||||
<hr>
|
||||
@@ -24,7 +26,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
|
||||
|
||||
### Exposed Persistent volumes {#Exposed-Persistent-volumes}
|
||||
### Exposed Persistent volumes
|
||||
|
||||
|
||||
- **persistentVolumeClaim** (PersistentVolumeClaimVolumeSource)
|
||||
@@ -42,7 +44,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
Will force the ReadOnly setting in VolumeMounts. Default false.
|
||||
|
||||
### Projections {#Projections}
|
||||
### Projections
|
||||
|
||||
|
||||
- **configMap** (ConfigMapVolumeSource)
|
||||
@@ -66,7 +68,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
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 "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
|
||||
- **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 '..'.
|
||||
|
||||
@@ -91,7 +93,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
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 "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
|
||||
- **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 '..'.
|
||||
|
||||
@@ -106,7 +108,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
|
||||
|
||||
- **downwardAPI.items** ([]<a href="{{< ref "../common-definitions/downward-api-volume-file#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
|
||||
- **downwardAPI.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
|
||||
|
||||
Items is a list of downward API volume file
|
||||
|
||||
@@ -128,79 +130,79 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
<a name="VolumeProjection"></a>
|
||||
*Projection that may be projected along with other supported volume types*
|
||||
|
||||
- **projected.sources.configMap** (ConfigMapProjection)
|
||||
- **projected.sources.configMap** (ConfigMapProjection)
|
||||
|
||||
information about the configMap data to project
|
||||
information about the configMap data to project
|
||||
|
||||
<a name="ConfigMapProjection"></a>
|
||||
*Adapts a ConfigMap into a projected volume.
|
||||
|
||||
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.*
|
||||
<a name="ConfigMapProjection"></a>
|
||||
*Adapts a ConfigMap into a projected volume.
|
||||
|
||||
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.*
|
||||
|
||||
- **projected.sources.configMap.name** (string)
|
||||
- **projected.sources.configMap.name** (string)
|
||||
|
||||
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
|
||||
- **projected.sources.configMap.optional** (boolean)
|
||||
- **projected.sources.configMap.optional** (boolean)
|
||||
|
||||
Specify whether the ConfigMap or its keys must be defined
|
||||
Specify whether the ConfigMap or its keys must be defined
|
||||
|
||||
- **projected.sources.configMap.items** ([]<a href="{{< ref "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
|
||||
- **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 '..'.
|
||||
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)
|
||||
- **projected.sources.downwardAPI** (DownwardAPIProjection)
|
||||
|
||||
information about the downwardAPI data to project
|
||||
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.*
|
||||
<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.*
|
||||
|
||||
- **projected.sources.downwardAPI.items** ([]<a href="{{< ref "../common-definitions/downward-api-volume-file#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
|
||||
- **projected.sources.downwardAPI.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
|
||||
|
||||
Items is a list of DownwardAPIVolume file
|
||||
Items is a list of DownwardAPIVolume file
|
||||
|
||||
- **projected.sources.secret** (SecretProjection)
|
||||
- **projected.sources.secret** (SecretProjection)
|
||||
|
||||
information about the secret data to project
|
||||
information about the secret data to project
|
||||
|
||||
<a name="SecretProjection"></a>
|
||||
*Adapts a secret into a projected volume.
|
||||
|
||||
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.*
|
||||
<a name="SecretProjection"></a>
|
||||
*Adapts a secret into a projected volume.
|
||||
|
||||
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.*
|
||||
|
||||
- **projected.sources.secret.name** (string)
|
||||
- **projected.sources.secret.name** (string)
|
||||
|
||||
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||||
|
||||
- **projected.sources.secret.optional** (boolean)
|
||||
- **projected.sources.secret.optional** (boolean)
|
||||
|
||||
Specify whether the Secret or its key must be defined
|
||||
Specify whether the Secret or its key must be defined
|
||||
|
||||
- **projected.sources.secret.items** ([]<a href="{{< ref "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
|
||||
- **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 '..'.
|
||||
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)
|
||||
- **projected.sources.serviceAccountToken** (ServiceAccountTokenProjection)
|
||||
|
||||
information about the serviceAccountToken data to project
|
||||
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).*
|
||||
<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
|
||||
- **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)
|
||||
- **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)
|
||||
- **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 {#Local-Temporary-Directory}
|
||||
### Local / Temporary Directory
|
||||
|
||||
|
||||
- **emptyDir** (EmptyDirVolumeSource)
|
||||
@@ -233,7 +235,7 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
|
||||
|
||||
### Persistent volumes {#Persistent-volumes}
|
||||
### Persistent volumes
|
||||
|
||||
|
||||
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
|
||||
@@ -365,6 +367,33 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
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).
|
||||
|
||||
<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.
|
||||
|
||||
- **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.
|
||||
|
||||
- **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.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
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.
|
||||
|
||||
- **fc** (FCVolumeSource)
|
||||
|
||||
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
|
||||
@@ -749,42 +778,12 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
Storage Policy Based Management (SPBM) profile name.
|
||||
|
||||
### Beta level {#Beta-level}
|
||||
|
||||
|
||||
- **csi** (CSIVolumeSource)
|
||||
|
||||
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.
|
||||
|
||||
- **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.
|
||||
|
||||
- **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.
|
||||
|
||||
- **csi.readOnly** (boolean)
|
||||
|
||||
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.
|
||||
|
||||
### Alpha level {#Alpha-level}
|
||||
### Alpha level
|
||||
|
||||
|
||||
- **ephemeral** (EphemeralVolumeSource)
|
||||
|
||||
Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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,
|
||||
@@ -798,14 +797,12 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.
|
||||
|
||||
A pod can use both types of ephemeral volumes and persistent volumes at the same time.
|
||||
|
||||
This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
|
||||
|
||||
<a name="EphemeralVolumeSource"></a>
|
||||
*Represents an ephemeral volume that is handled by a normal storage driver.*
|
||||
|
||||
- **ephemeral.readOnly** (boolean)
|
||||
|
||||
Specifies a read-only configuration for the volume. Defaults to false (read/write).
|
||||
|
||||
- **ephemeral.volumeClaimTemplate** (PersistentVolumeClaimTemplate)
|
||||
|
||||
Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `\<pod name>-\<volume name>` where `\<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).
|
||||
@@ -819,15 +816,15 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
<a name="PersistentVolumeClaimTemplate"></a>
|
||||
*PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.*
|
||||
|
||||
- **ephemeral.volumeClaimTemplate.spec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaimSpec" >}}">PersistentVolumeClaimSpec</a>), required
|
||||
- **ephemeral.volumeClaimTemplate.spec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaimSpec" >}}">PersistentVolumeClaimSpec</a>), required
|
||||
|
||||
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
|
||||
The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
|
||||
|
||||
- **ephemeral.volumeClaimTemplate.metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
|
||||
- **ephemeral.volumeClaimTemplate.metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
|
||||
|
||||
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
|
||||
May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
|
||||
|
||||
### Deprecated {#Deprecated}
|
||||
### Deprecated
|
||||
|
||||
|
||||
- **gitRepo** (GitRepoVolumeSource)
|
||||
@@ -853,3 +850,51 @@ Volume represents a named volume in a pod that may be accessed by any container
|
||||
|
||||
|
||||
|
||||
## DownwardAPIVolumeFile {#DownwardAPIVolumeFile}
|
||||
|
||||
DownwardAPIVolumeFile represents information to create the file containing the pod field
|
||||
|
||||
<hr>
|
||||
|
||||
- **path** (string), required
|
||||
|
||||
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
|
||||
|
||||
- **fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
|
||||
|
||||
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
|
||||
|
||||
- **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.
|
||||
|
||||
- **resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
|
||||
|
||||
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## KeyToPath {#KeyToPath}
|
||||
|
||||
Maps a string key to a path within a volume.
|
||||
|
||||
<hr>
|
||||
|
||||
- **key** (string), required
|
||||
|
||||
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 '..'.
|
||||
|
||||
- **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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user