Skip to content

Commit cfcb820

Browse files
committed
Update API resource reference enum values
1 parent ada14be commit cfcb820

34 files changed

Lines changed: 2383 additions & 1377 deletions

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

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The file is auto-generated from the Go source code of the component using a gene
1515
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
1616
to generate the reference documentation, please read
1717
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
18-
To update the reference content, please follow the
18+
To update the reference content, please follow the
1919
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
2020
guide. You can file document formatting bugs against the
2121
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
@@ -63,7 +63,7 @@ NamespaceSpec describes the attributes on a Namespace.
6363
- **finalizers** ([]string)
6464

6565
*Atomic: will be replaced during a merge*
66-
66+
6767
Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
6868

6969

@@ -79,9 +79,9 @@ NamespaceStatus is information about the current status of a Namespace.
7979
- **conditions** ([]NamespaceCondition)
8080

8181
*Patch strategy: merge on key `type`*
82-
82+
8383
*Map: unique values on key type will be kept during a merge*
84-
84+
8585
Represents the latest available observations of a namespace's current state.
8686

8787
<a name="NamespaceCondition"></a>
@@ -114,6 +114,10 @@ NamespaceStatus is information about the current status of a Namespace.
114114

115115
Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
116116

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
120+
117121

118122

119123

@@ -298,7 +302,7 @@ POST /api/v1/namespaces
298302

299303
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
300304

301-
305+
302306

303307

304308
- **dryRun** (*in query*): string
@@ -350,7 +354,7 @@ PUT /api/v1/namespaces/{name}
350354

351355
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
352356

353-
357+
354358

355359

356360
- **dryRun** (*in query*): string
@@ -400,7 +404,7 @@ PUT /api/v1/namespaces/{name}/finalize
400404

401405
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
402406

403-
407+
404408

405409

406410
- **dryRun** (*in query*): string
@@ -450,7 +454,7 @@ PUT /api/v1/namespaces/{name}/status
450454

451455
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
452456

453-
457+
454458

455459

456460
- **dryRun** (*in query*): string
@@ -500,7 +504,7 @@ PATCH /api/v1/namespaces/{name}
500504

501505
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
502506

503-
507+
504508

505509

506510
- **dryRun** (*in query*): string
@@ -555,7 +559,7 @@ PATCH /api/v1/namespaces/{name}/status
555559

556560
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
557561

558-
562+
559563

560564

561565
- **dryRun** (*in query*): string
@@ -610,7 +614,7 @@ DELETE /api/v1/namespaces/{name}
610614

611615
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
612616

613-
617+
614618

615619

616620
- **dryRun** (*in query*): string

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

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The file is auto-generated from the Go source code of the component using a gene
1515
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
1616
to generate the reference documentation, please read
1717
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
18-
To update the reference content, please follow the
18+
To update the reference content, please follow the
1919
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
2020
guide. You can file document formatting bugs against the
2121
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
@@ -105,7 +105,7 @@ NodeSpec describes the attributes that a node is created with.
105105
- **podCIDRs** ([]string)
106106

107107
*Set: unique values will be kept during a merge*
108-
108+
109109
podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
110110

111111
- **providerID** (string)
@@ -115,7 +115,7 @@ NodeSpec describes the attributes that a node is created with.
115115
- **taints** ([]Taint)
116116

117117
*Atomic: will be replaced during a merge*
118-
118+
119119
If specified, the node's taints.
120120

121121
<a name="Taint"></a>
@@ -125,6 +125,11 @@ NodeSpec describes the attributes that a node is created with.
125125

126126
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
127127

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.
132+
128133
- **taints.key** (string), required
129134

130135
Required. The taint key to be applied to a node.
@@ -157,9 +162,9 @@ NodeStatus is information about the current status of a node.
157162
- **addresses** ([]NodeAddress)
158163

159164
*Patch strategy: merge on key `type`*
160-
165+
161166
*Map: unique values on key type will be kept during a merge*
162-
167+
163168
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
164169

165170
<a name="NodeAddress"></a>
@@ -184,9 +189,9 @@ NodeStatus is information about the current status of a node.
184189
- **conditions** ([]NodeCondition)
185190

186191
*Patch strategy: merge on key `type`*
187-
192+
188193
*Map: unique values on key type will be kept during a merge*
189-
194+
190195
Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
191196

192197
<a name="NodeCondition"></a>
@@ -356,7 +361,7 @@ NodeStatus is information about the current status of a node.
356361
- **declaredFeatures** ([]string)
357362

358363
*Atomic: will be replaced during a merge*
359-
364+
360365
DeclaredFeatures represents the features related to feature gates that are declared by the node.
361366

362367
- **features** (NodeFeatures)
@@ -373,7 +378,7 @@ NodeStatus is information about the current status of a node.
373378
- **images** ([]ContainerImage)
374379

375380
*Atomic: will be replaced during a merge*
376-
381+
377382
List of container images on this node
378383

379384
<a name="ContainerImage"></a>
@@ -382,7 +387,7 @@ NodeStatus is information about the current status of a node.
382387
- **images.names** ([]string)
383388

384389
*Atomic: will be replaced during a merge*
385-
390+
386391
Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
387392

388393
- **images.sizeBytes** (int64)
@@ -451,10 +456,15 @@ NodeStatus is information about the current status of a node.
451456

452457
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.
453458

459+
Possible enum values:
460+
- `"Pending"` means the node has been created/added by the system, but not configured.
461+
- `"Running"` means the node has been configured and has Kubernetes components running.
462+
- `"Terminated"` means the node has been removed from the cluster.
463+
454464
- **runtimeHandlers** ([]NodeRuntimeHandler)
455465

456466
*Atomic: will be replaced during a merge*
457-
467+
458468
The available runtime handlers.
459469

460470
<a name="NodeRuntimeHandler"></a>
@@ -482,7 +492,7 @@ NodeStatus is information about the current status of a node.
482492
- **volumesAttached** ([]AttachedVolume)
483493

484494
*Atomic: will be replaced during a merge*
485-
495+
486496
List of volumes that are attached to the node.
487497

488498
<a name="AttachedVolume"></a>
@@ -499,7 +509,7 @@ NodeStatus is information about the current status of a node.
499509
- **volumesInUse** ([]string)
500510

501511
*Atomic: will be replaced during a merge*
502-
512+
503513
List of attachable volumes in use (mounted) by the node.
504514

505515

@@ -686,7 +696,7 @@ POST /api/v1/nodes
686696

687697
- **body**: <a href="{{< ref "../cluster-resources/node-v1#Node" >}}">Node</a>, required
688698

689-
699+
690700

691701

692702
- **dryRun** (*in query*): string
@@ -738,7 +748,7 @@ PUT /api/v1/nodes/{name}
738748

739749
- **body**: <a href="{{< ref "../cluster-resources/node-v1#Node" >}}">Node</a>, required
740750

741-
751+
742752

743753

744754
- **dryRun** (*in query*): string
@@ -788,7 +798,7 @@ PUT /api/v1/nodes/{name}/status
788798

789799
- **body**: <a href="{{< ref "../cluster-resources/node-v1#Node" >}}">Node</a>, required
790800

791-
801+
792802

793803

794804
- **dryRun** (*in query*): string
@@ -838,7 +848,7 @@ PATCH /api/v1/nodes/{name}
838848

839849
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
840850

841-
851+
842852

843853

844854
- **dryRun** (*in query*): string
@@ -893,7 +903,7 @@ PATCH /api/v1/nodes/{name}/status
893903

894904
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
895905

896-
906+
897907

898908

899909
- **dryRun** (*in query*): string
@@ -948,7 +958,7 @@ DELETE /api/v1/nodes/{name}
948958

949959
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
950960

951-
961+
952962

953963

954964
- **dryRun** (*in query*): string
@@ -998,7 +1008,7 @@ DELETE /api/v1/nodes
9981008

9991009
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
10001010

1001-
1011+
10021012

10031013

10041014
- **continue** (*in query*): string

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

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The file is auto-generated from the Go source code of the component using a gene
1515
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
1616
to generate the reference documentation, please read
1717
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
18-
To update the reference content, please follow the
18+
To update the reference content, please follow the
1919
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
2020
guide. You can file document formatting bugs against the
2121
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
@@ -72,7 +72,7 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
7272
- **scheduling.tolerations** ([]Toleration)
7373

7474
*Atomic: will be replaced during a merge*
75-
75+
7676
tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.
7777

7878
<a name="Toleration"></a>
@@ -86,6 +86,12 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
8686

8787
Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
8888

89+
Possible enum values:
90+
- `"Equal"`
91+
- `"Exists"`
92+
- `"Gt"`
93+
- `"Lt"`
94+
8995
- **scheduling.tolerations.value** (string)
9096

9197
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
@@ -94,6 +100,11 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
94100

95101
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
96102

103+
Possible enum values:
104+
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
105+
- `"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.
106+
- `"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.
107+
97108
- **scheduling.tolerations.tolerationSeconds** (int64)
98109

99110
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
@@ -254,7 +265,7 @@ POST /apis/node.k8s.io/v1/runtimeclasses
254265

255266
- **body**: <a href="{{< ref "../cluster-resources/runtime-class-v1#RuntimeClass" >}}">RuntimeClass</a>, required
256267

257-
268+
258269

259270

260271
- **dryRun** (*in query*): string
@@ -306,7 +317,7 @@ PUT /apis/node.k8s.io/v1/runtimeclasses/{name}
306317

307318
- **body**: <a href="{{< ref "../cluster-resources/runtime-class-v1#RuntimeClass" >}}">RuntimeClass</a>, required
308319

309-
320+
310321

311322

312323
- **dryRun** (*in query*): string
@@ -356,7 +367,7 @@ PATCH /apis/node.k8s.io/v1/runtimeclasses/{name}
356367

357368
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
358369

359-
370+
360371

361372

362373
- **dryRun** (*in query*): string
@@ -411,7 +422,7 @@ DELETE /apis/node.k8s.io/v1/runtimeclasses/{name}
411422

412423
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
413424

414-
425+
415426

416427

417428
- **dryRun** (*in query*): string
@@ -461,7 +472,7 @@ DELETE /apis/node.k8s.io/v1/runtimeclasses
461472

462473
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
463474

464-
475+
465476

466477

467478
- **continue** (*in query*): string

0 commit comments

Comments
 (0)