Reference docs for kubernetes 1.23

2021-12-08 09:34:52 +01:00
parent e808edad3a
commit 02445930e5
63 changed files with 10024 additions and 6326 deletions
@@ -296,6 +296,11 @@ POST /api/v1/namespaces/{namespace}/configmaps
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -348,6 +353,11 @@ PUT /api/v1/namespaces/{namespace}/configmaps/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -398,6 +408,11 @@ PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -64,7 +64,7 @@ CSIDriverSpec is the specification of a CSIDriver.

 - **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 beta, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.
+  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 immutable.
  
@@ -93,7 +93,7 @@ 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 field is immutable.
+  This field was immutable in Kubernetes \<= 1.22 and now is mutable.
  
  This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.

@@ -289,6 +289,11 @@ POST /apis/storage.k8s.io/v1/csidrivers
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -336,6 +341,11 @@ PUT /apis/storage.k8s.io/v1/csidrivers/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -381,6 +391,11 @@ PATCH /apis/storage.k8s.io/v1/csidrivers/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -247,6 +247,11 @@ POST /apis/storage.k8s.io/v1/csinodes
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -294,6 +299,11 @@ PUT /apis/storage.k8s.io/v1/csinodes/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -339,6 +349,11 @@ PATCH /apis/storage.k8s.io/v1/csinodes/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -318,6 +318,11 @@ POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -370,6 +375,11 @@ PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{na
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -420,6 +430,11 @@ PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -70,7 +70,7 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and

 - **resources** (ResourceRequirements)

-  Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+  Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

  <a name="ResourceRequirements"></a>
  *ResourceRequirements describes the compute resource requirements.*
@@ -125,6 +125,10 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.

  AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

+- **allocatedResources** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
+
+  The storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
+
 - **capacity** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)

  Represents the actual resources of the underlying volume.
@@ -143,6 +147,12 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.

  - **conditions.type** (string), required

+    
+    
+    
+    Possible enum values:
+     - `"FileSystemResizePending"` - controller resize is finished and a file system resize is pending on node
+     - `"Resizing"` - a user trigger resize of pvc has been started

  - **conditions.lastProbeTime** (Time)

@@ -169,6 +179,15 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
 - **phase** (string)

  Phase represents the current phase of PersistentVolumeClaim.
+  
+  Possible enum values:
+   - `"Bound"` used for PersistentVolumeClaims that are bound
+   - `"Lost"` used for PersistentVolumeClaims that lost their underlying PersistentVolume. The claim was bound to a PersistentVolume and this volume does not exist any longer and all data on it was lost.
+   - `"Pending"` used for PersistentVolumeClaims that are not yet bound
+
+- **resizeStatus** (string)
+
+  ResizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.



@@ -445,6 +464,11 @@ POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -497,6 +521,11 @@ PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -547,6 +576,11 @@ PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -597,6 +631,11 @@ PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -652,6 +691,11 @@ PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -108,6 +108,11 @@ PersistentVolumeSpec is the specification of a persistent volume.
 - **persistentVolumeReclaimPolicy** (string)

  What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
+  
+  Possible enum values:
+   - `"Delete"` means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion.
+   - `"Recycle"` means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim. The volume plugin must support Recycling.
+   - `"Retain"` means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.

 - **storageClassName** (string)

@@ -150,7 +155,7 @@ PersistentVolumeSpec is the specification of a persistent volume.

  - **local.fsType** (string)

-    Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified.
+    Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.

 ### Persistent volumes

@@ -844,6 +849,13 @@ PersistentVolumeStatus is the current status of a persistent volume.
 - **phase** (string)

  Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
+  
+  Possible enum values:
+   - `"Available"` used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims
+   - `"Bound"` used for PersistentVolumes that are bound
+   - `"Failed"` used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim
+   - `"Pending"` used for PersistentVolumes that are not available
+   - `"Released"` used for PersistentVolumes where the bound PersistentVolumeClaim was deleted released volumes must be recycled before becoming available again this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource

 - **reason** (string)

@@ -1036,6 +1048,11 @@ POST /api/v1/persistentvolumes
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -1083,6 +1100,11 @@ PUT /api/v1/persistentvolumes/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -1128,6 +1150,11 @@ PUT /api/v1/persistentvolumes/{name}/status
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -1173,6 +1200,11 @@ PATCH /api/v1/persistentvolumes/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -1223,6 +1255,11 @@ PATCH /api/v1/persistentvolumes/{name}/status
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -56,7 +56,7 @@ Secret holds secret data of a certain type. The total bytes of the values in the

 - **type** (string)

-  Used to facilitate programmatic handling of secret data.
+  Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types



@@ -300,6 +300,11 @@ POST /api/v1/namespaces/{namespace}/secrets
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -352,6 +357,11 @@ PUT /api/v1/namespaces/{namespace}/secrets/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -402,6 +412,11 @@ PATCH /api/v1/namespaces/{namespace}/secrets/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -251,6 +251,11 @@ POST /apis/storage.k8s.io/v1/storageclasses
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -298,6 +303,11 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -343,6 +353,11 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -326,6 +326,11 @@ POST /apis/storage.k8s.io/v1/volumeattachments
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -373,6 +378,11 @@ PUT /apis/storage.k8s.io/v1/volumeattachments/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -418,6 +428,11 @@ PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **pretty** (*in query*): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
@@ -463,6 +478,11 @@ PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -513,6 +533,11 @@ PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status
  <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>


+- **fieldValidation** (*in query*): string
+
+  <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
+
+
 - **force** (*in query*): boolean

  <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
@@ -809,8 +809,6 @@ 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.*