Skip to content

Commit 61095d4

Browse files
authored
Merge pull request #32833 from feloy/api-reference-multi-pages
API reference multi pages for v1.24
2 parents 57b5856 + 43c0e26 commit 61095d4

31 files changed

+3036
-3996
lines changed

api-ref-assets/api/swagger.json

Lines changed: 2341 additions & 3333 deletions
Large diffs are not rendered by default.

api-ref-assets/config/fields.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,7 @@
405405
- fields:
406406
- jobTemplate
407407
- schedule
408+
- timeZone
408409
- concurrencyPolicy
409410
- startingDeadlineSeconds
410411
- suspend

api-ref-assets/config/toc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ parts:
124124
version: v1
125125
- name: CSIStorageCapacity
126126
group: storage.k8s.io
127-
version: v1beta1
127+
version: v1
128128
- name: Authentication Resources
129129
chapters:
130130
- name: ServiceAccount

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,6 @@ CertificateSigningRequestSpec contains the certificate request.
109109
3. Signer whose configured minimum is longer than the requested duration
110110

111111
The minimum valid value for expirationSeconds is 600, i.e. 10 minutes.
112-
113-
As of v1.22, this field is beta and is controlled via the CSRDuration feature gate.
114112

115113
- **extra** (map[string][]string)
116114

@@ -212,11 +210,6 @@ CertificateSigningRequestStatus contains conditions used to indicate approved/de
212210
Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added.
213211

214212
Only one condition of a given type is allowed.
215-
216-
Possible enum values:
217-
- `"Approved"` Approved indicates the request was approved and should be issued by the signer.
218-
- `"Denied"` Denied indicates the request was denied and should not be issued by the signer.
219-
- `"Failed"` Failed indicates the signer failed to issue the certificate.
220213

221214
- **conditions.lastTransitionTime** (Time)
222215

content/en/docs/reference/kubernetes-api/authentication-resources/service-account-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ ServiceAccount binds together: * a name, understood by users, and perhaps by per
5454

5555
*Patch strategy: merge on key `name`*
5656

57-
Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret
57+
Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret
5858

5959

6060

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

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,6 @@ NamespaceStatus is information about the current status of a Namespace.
9090
- **conditions.type** (string), required
9191

9292
Type of namespace controller condition.
93-
94-
Possible enum values:
95-
- `"NamespaceContentRemaining"` contains information about resources remaining in a namespace.
96-
- `"NamespaceDeletionContentFailure"` contains information about namespace deleter errors during deletion of resources.
97-
- `"NamespaceDeletionDiscoveryFailure"` contains information about namespace deleter errors during resource discovery.
98-
- `"NamespaceDeletionGroupVersionParsingFailure"` contains information about namespace deleter errors parsing GV for legacy types.
99-
- `"NamespaceFinalizersRemaining"` contains information about which finalizers are on resources remaining in a namespace.
10093

10194
- **conditions.lastTransitionTime** (Time)
10295

@@ -114,9 +107,7 @@ NamespaceStatus is information about the current status of a Namespace.
114107

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

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
110+
120111

121112

122113

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

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ NodeSpec describes the attributes that a node is created with.
6262

6363
- **configSource** (NodeConfigSource)
6464

65-
Deprecated. If specified, the source of the node's configuration. The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field. This field is deprecated as of 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
65+
Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed from Kubelets as of 1.24 and will be fully removed in 1.26.
6666

6767
<a name="NodeConfigSource"></a>
6868
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22*
@@ -121,10 +121,7 @@ NodeSpec describes the attributes that a node is created with.
121121

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

124-
Possible enum values:
125-
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
126-
- `"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.
127-
- `"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.
124+
128125

129126
- **taints.key** (string), required
130127

@@ -171,13 +168,6 @@ NodeStatus is information about the current status of a node.
171168
- **addresses.type** (string), required
172169

173170
Node address type, one of Hostname, ExternalIP or InternalIP.
174-
175-
Possible enum values:
176-
- `"ExternalDNS"` identifies a DNS name which resolves to an IP address which has the characteristics of a NodeExternalIP. The IP it resolves to may or may not be a listed NodeExternalIP address.
177-
- `"ExternalIP"` identifies an IP address which is, in some way, intended to be more usable from outside the cluster then an internal IP, though no specific semantics are defined. It may be a globally routable IP, though it is not required to be. External IPs may be assigned directly to an interface on the node, like a NodeInternalIP, or alternatively, packets sent to the external IP may be NAT'ed to an internal node IP rather than being delivered directly (making the IP less efficient for node-to-node traffic than a NodeInternalIP).
178-
- `"Hostname"` identifies a name of the node. Although every node can be assumed to have a NodeAddress of this type, its exact syntax and semantics are not defined, and are not consistent between different clusters.
179-
- `"InternalDNS"` identifies a DNS name which resolves to an IP address which has the characteristics of a NodeInternalIP. The IP it resolves to may or may not be a listed NodeInternalIP address.
180-
- `"InternalIP"` identifies an IP address which is assigned to one of the node's network interfaces. Every node should have at least one address of this type. An internal IP is normally expected to be reachable from every other node, but may not be visible to hosts outside the cluster. By default it is assumed that kube-apiserver can reach node internal IPs, though it is possible to configure clusters where this is not the case. NodeInternalIP is the default type of node IP, and does not necessarily imply that the IP is ONLY reachable internally. If a node has multiple internal IPs, no specific semantics are assigned to the additional IPs.
181171

182172
- **allocatable** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
183173

@@ -203,13 +193,6 @@ NodeStatus is information about the current status of a node.
203193
- **conditions.type** (string), required
204194

205195
Type of node condition.
206-
207-
Possible enum values:
208-
- `"DiskPressure"` means the kubelet is under pressure due to insufficient available disk.
209-
- `"MemoryPressure"` means the kubelet is under pressure due to insufficient available memory.
210-
- `"NetworkUnavailable"` means that network for the node is not correctly configured.
211-
- `"PIDPressure"` means the kubelet is under pressure due to insufficient available PID.
212-
- `"Ready"` means kubelet is healthy and ready to accept pods.
213196

214197
- **conditions.lastHeartbeatTime** (Time)
215198

@@ -396,7 +379,7 @@ NodeStatus is information about the current status of a node.
396379

397380
- **nodeInfo.containerRuntimeVersion** (string), required
398381

399-
ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
382+
ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
400383

401384
- **nodeInfo.kernelVersion** (string), required
402385

@@ -430,10 +413,7 @@ NodeStatus is information about the current status of a node.
430413

431414
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.
432415

433-
Possible enum values:
434-
- `"Pending"` means the node has been created/added by the system, but not configured.
435-
- `"Running"` means the node has been configured and has Kubernetes components running.
436-
- `"Terminated"` means the node has been removed from the cluster.
416+
437417

438418
- **volumesAttached** ([]AttachedVolume)
439419

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
5050

5151
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see
5252
https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/
53-
This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature.
5453

5554
<a name="Overhead"></a>
5655
*Overhead structure represents the resource overhead associated with running a pod.*
@@ -87,9 +86,7 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
8786

8887
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.
8988

90-
Possible enum values:
91-
- `"Equal"`
92-
- `"Exists"`
89+
9390

9491
- **scheduling.tolerations.value** (string)
9592

@@ -99,10 +96,7 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
9996

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

102-
Possible enum values:
103-
- `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController.
104-
- `"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.
105-
- `"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.
99+
106100

107101
- **scheduling.tolerations.tolerationSeconds** (int64)
108102

content/en/docs/reference/kubernetes-api/common-definitions/list-meta.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,7 @@ ListMeta describes metadata that synthetic resources must have, including lists
4444

4545
- **selfLink** (string)
4646

47-
selfLink is a URL representing this object. Populated by the system. Read-only.
48-
49-
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
47+
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
5048

5149

5250

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,7 @@ A node selector requirement is a selector that contains values, a key, and an op
3838

3939
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
4040

41-
Possible enum values:
42-
- `"DoesNotExist"`
43-
- `"Exists"`
44-
- `"Gt"`
45-
- `"In"`
46-
- `"Lt"`
47-
- `"NotIn"`
41+
4842

4943
- **values** ([]string)
5044

0 commit comments

Comments
 (0)