Skip to content

Commit 24e17cb

Browse files
committed
Update resource API 1.34 with enum values
1 parent 93fcff4 commit 24e17cb

34 files changed

+851
-7
lines changed

content/en/docs/reference/kubernetes-api/authentication-resources/token-request-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ TokenRequestSpec contains client provided parameters of a token request.
6464

6565
*Atomic: will be replaced during a merge*
6666

67-
Audiences are the intended audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.
67+
Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.
6868

6969
- **boundObjectRef** (BoundObjectReference)
7070

content/en/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,10 @@ NamespaceStatus is information about the current status of a Namespace.
113113
- **phase** (string)
114114

115115
Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
116+
117+
Possible enum values:
118+
- `"Active"` means the namespace is available for use in the system
119+
- `"Terminating"` means the namespace is undergoing graceful termination
116120

117121

118122

content/en/docs/reference/kubernetes-api/cluster-resources/node-v1.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,11 @@ NodeSpec describes the attributes that a node is created with.
124124
- **taints.effect** (string), required
125125

126126
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
127+
128+
Possible enum values:
129+
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
130+
- `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
131+
- `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
127132

128133
- **taints.key** (string), required
129134

@@ -444,6 +449,11 @@ NodeStatus is information about the current status of a node.
444449
- **phase** (string)
445450

446451
NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
452+
453+
Possible enum values:
454+
- `"Pending"` means the node has been created/added by the system, but not configured.
455+
- `"Running"` means the node has been configured and has Kubernetes components running.
456+
- `"Terminated"` means the node has been removed from the cluster.
447457

448458
- **runtimeHandlers** ([]NodeRuntimeHandler)
449459

content/en/docs/reference/kubernetes-api/cluster-resources/runtime-class-v1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
8585
- **scheduling.tolerations.operator** (string)
8686

8787
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
88+
89+
Possible enum values:
90+
- `"Equal"`
91+
- `"Exists"`
8892

8993
- **scheduling.tolerations.value** (string)
9094

@@ -93,6 +97,11 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
9397
- **scheduling.tolerations.effect** (string)
9498

9599
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
100+
101+
Possible enum values:
102+
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
103+
- `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler.
104+
- `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
96105

97106
- **scheduling.tolerations.tolerationSeconds** (int64)
98107

content/en/docs/reference/kubernetes-api/common-definitions/node-selector-requirement.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ A node selector requirement is a selector that contains values, a key, and an op
3737
- **operator** (string), required
3838

3939
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
40+
41+
Possible enum values:
42+
- `"DoesNotExist"`
43+
- `"Exists"`
44+
- `"Gt"`
45+
- `"In"`
46+
- `"Lt"`
47+
- `"NotIn"`
4048

4149
- **values** ([]string)
4250

content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
9696
- **volumeMode** (string)
9797

9898
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
99+
100+
Possible enum values:
101+
- `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device.
102+
- `"Filesystem"` means the volume will be or is formatted with a filesystem.
99103

100104

101105

@@ -269,6 +273,11 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
269273
Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
270274
resolve the error, a valid VolumeAttributesClass needs to be specified.
271275
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
276+
277+
Possible enum values:
278+
- `"InProgress"` InProgress indicates that the volume is being modified
279+
- `"Infeasible"` Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified
280+
- `"Pending"` Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing
272281

273282
- **modifyVolumeStatus.targetVolumeAttributesClassName** (string)
274283

@@ -277,6 +286,11 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
277286
- **phase** (string)
278287

279288
phase represents the current phase of PersistentVolumeClaim.
289+
290+
Possible enum values:
291+
- `"Bound"` used for PersistentVolumeClaims that are bound
292+
- `"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.
293+
- `"Pending"` used for PersistentVolumeClaims that are not yet bound
280294

281295

282296

content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-v1.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,11 @@ PersistentVolumeSpec is the specification of a persistent volume.
118118
- **persistentVolumeReclaimPolicy** (string)
119119

120120
persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
121+
122+
Possible enum values:
123+
- `"Delete"` means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion.
124+
- `"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.
125+
- `"Retain"` means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.
121126

122127
- **storageClassName** (string)
123128

@@ -130,6 +135,10 @@ PersistentVolumeSpec is the specification of a persistent volume.
130135
- **volumeMode** (string)
131136

132137
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
138+
139+
Possible enum values:
140+
- `"Block"` means the volume will not be formatted with a filesystem and will remain a raw block device.
141+
- `"Filesystem"` means the volume will be or is formatted with a filesystem.
133142

134143

135144

@@ -150,6 +159,16 @@ PersistentVolumeSpec is the specification of a persistent volume.
150159
- **hostPath.type** (string)
151160

152161
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
162+
163+
Possible enum values:
164+
- `""` For backwards compatible, leave it empty if unset
165+
- `"BlockDevice"` A block device must exist at the given path
166+
- `"CharDevice"` A character device must exist at the given path
167+
- `"Directory"` A directory must exist at the given path
168+
- `"DirectoryOrCreate"` If nothing exists at the given path, an empty directory will be created there as needed with file mode 0755, having the same group and ownership with Kubelet.
169+
- `"File"` A file must exist at the given path
170+
- `"FileOrCreate"` If nothing exists at the given path, an empty file will be created there as needed with file mode 0644, having the same group and ownership with Kubelet.
171+
- `"Socket"` A UNIX socket must exist at the given path
153172

154173
- **local** (LocalVolumeSource)
155174

@@ -212,6 +231,11 @@ PersistentVolumeSpec is the specification of a persistent volume.
212231
- **azureDisk.cachingMode** (string)
213232

214233
cachingMode is the Host Caching mode: None, Read Only, Read Write.
234+
235+
Possible enum values:
236+
- `"None"`
237+
- `"ReadOnly"`
238+
- `"ReadWrite"`
215239

216240
- **azureDisk.fsType** (string)
217241

@@ -220,6 +244,11 @@ PersistentVolumeSpec is the specification of a persistent volume.
220244
- **azureDisk.kind** (string)
221245

222246
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
247+
248+
Possible enum values:
249+
- `"Dedicated"`
250+
- `"Managed"`
251+
- `"Shared"`
223252

224253
- **azureDisk.readOnly** (boolean)
225254

@@ -890,6 +919,13 @@ PersistentVolumeStatus is the current status of a persistent volume.
890919
- **phase** (string)
891920

892921
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
922+
923+
Possible enum values:
924+
- `"Available"` used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims
925+
- `"Bound"` used for PersistentVolumes that are bound
926+
- `"Failed"` used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim
927+
- `"Pending"` used for PersistentVolumes that are not available
928+
- `"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
893929

894930
- **reason** (string)
895931

content/en/docs/reference/kubernetes-api/config-and-storage-resources/storage-class-v1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,19 @@ StorageClasses are non-namespaced; the name of the storage class according to et
9393
- **reclaimPolicy** (string)
9494

9595
reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
96+
97+
Possible enum values:
98+
- `"Delete"` means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion.
99+
- `"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.
100+
- `"Retain"` means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.
96101

97102
- **volumeBindingMode** (string)
98103

99104
volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
105+
106+
Possible enum values:
107+
- `"Immediate"` indicates that PersistentVolumeClaims should be immediately provisioned and bound. This is the default mode.
108+
- `"WaitForFirstConsumer"` indicates that PersistentVolumeClaims should not be provisioned and bound until the first Pod is created that references the PeristentVolumeClaim. The volume provisioning and binding will occur during Pod scheduing.
100109

101110

102111

content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,16 @@ Volume represents a named volume in a pod that may be accessed by any container
354354
- **hostPath.type** (string)
355355

356356
type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
357+
358+
Possible enum values:
359+
- `""` For backwards compatible, leave it empty if unset
360+
- `"BlockDevice"` A block device must exist at the given path
361+
- `"CharDevice"` A character device must exist at the given path
362+
- `"Directory"` A directory must exist at the given path
363+
- `"DirectoryOrCreate"` If nothing exists at the given path, an empty directory will be created there as needed with file mode 0755, having the same group and ownership with Kubelet.
364+
- `"File"` A file must exist at the given path
365+
- `"FileOrCreate"` If nothing exists at the given path, an empty file will be created there as needed with file mode 0644, having the same group and ownership with Kubelet.
366+
- `"Socket"` A UNIX socket must exist at the given path
357367

358368
### Persistent volumes
359369

@@ -401,6 +411,11 @@ Volume represents a named volume in a pod that may be accessed by any container
401411
- **azureDisk.cachingMode** (string)
402412

403413
cachingMode is the Host Caching mode: None, Read Only, Read Write.
414+
415+
Possible enum values:
416+
- `"None"`
417+
- `"ReadOnly"`
418+
- `"ReadWrite"`
404419

405420
- **azureDisk.fsType** (string)
406421

@@ -409,6 +424,11 @@ Volume represents a named volume in a pod that may be accessed by any container
409424
- **azureDisk.kind** (string)
410425

411426
kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
427+
428+
Possible enum values:
429+
- `"Dedicated"`
430+
- `"Managed"`
431+
- `"Shared"`
412432

413433
- **azureDisk.readOnly** (boolean)
414434

@@ -741,6 +761,11 @@ Volume represents a named volume in a pod that may be accessed by any container
741761
- **image.pullPolicy** (string)
742762

743763
Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
764+
765+
Possible enum values:
766+
- `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
767+
- `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
768+
- `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
744769

745770
- **image.reference** (string)
746771

content/en/docs/reference/kubernetes-api/extend-resources/custom-resource-definition-v1.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
187187

188188
- **versions.selectableFields.jsonPath** (string), required
189189

190-
jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metadata fields. Required.
190+
jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.
191191

192192
- **versions.subresources** (CustomResourceSubresources)
193193

@@ -602,6 +602,12 @@ JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-sc
602602
- **x-kubernetes-validations.reason** (string)
603603

604604
reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
605+
606+
Possible enum values:
607+
- `"FieldValueDuplicate"` is used to report collisions of values that must be unique (e.g. unique IDs).
608+
- `"FieldValueForbidden"` is used to report valid (as per formatting rules) values which would be accepted under some conditions, but which are not permitted by the current conditions (such as security policy).
609+
- `"FieldValueInvalid"` is used to report malformed values (e.g. failed regex match, too long, out of bounds).
610+
- `"FieldValueRequired"` is used to report required values that are not provided (e.g. empty strings, null values, or empty arrays).
605611

606612

607613

0 commit comments

Comments
 (0)