Skip to content

Commit 939b45b

Browse files
committed
API Reference multi-pages for v1.25
1 parent ca02c59 commit 939b45b

File tree

25 files changed

+5592
-15849
lines changed

25 files changed

+5592
-15849
lines changed

api-ref-assets/api/swagger.json

Lines changed: 5401 additions & 14947 deletions
Large diffs are not rendered by default.

api-ref-assets/config/fields.yaml

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
fields:
55
- containers
66
- initContainers
7+
- ephemeralContainers
78
- imagePullSecrets
89
- enableServiceLinks
910
- os
@@ -20,7 +21,9 @@
2021
- runtimeClassName
2122
- priorityClassName
2223
- priority
24+
- preemptionPolicy
2325
- topologySpreadConstraints
26+
- overhead
2427
- name: Lifecycle
2528
fields:
2629
- restartPolicy
@@ -48,11 +51,6 @@
4851
- name: Security context
4952
fields:
5053
- securityContext
51-
- name: Beta level
52-
fields:
53-
- ephemeralContainers
54-
- preemptionPolicy
55-
- overhead
5654
- name: Deprecated
5755
fields:
5856
- serviceAccount
@@ -396,7 +394,7 @@
396394
- completedIndexes
397395
- conditions
398396
- uncountedTerminatedPods
399-
- name: Alpha level
397+
- name: Beta level
400398
fields:
401399
- ready
402400

@@ -525,6 +523,7 @@
525523
- cephfs
526524
- cinder
527525
- csi
526+
- ephemeral
528527
- fc
529528
- flexVolume
530529
- flocker
@@ -539,9 +538,6 @@
539538
- scaleIO
540539
- storageos
541540
- vsphereVolume
542-
- name: Alpha level
543-
fields:
544-
- ephemeral
545541
- name: Deprecated
546542
fields:
547543
- gitRepo
@@ -591,7 +587,7 @@
591587
- volumeName
592588
- storageClassName
593589
- volumeMode
594-
- name: Alpha level
590+
- name: Beta level
595591
fields:
596592
- dataSource
597593
- dataSourceRef
@@ -714,6 +710,3 @@
714710
- resourceVersion
715711
- selfLink
716712
- uid
717-
- name: Ignored
718-
fields:
719-
- clusterName

api-ref-assets/config/toc.yaml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,6 @@ parts:
179179
- name: PodDisruptionBudget
180180
group: policy
181181
version: v1
182-
- name: PodSecurityPolicy
183-
group: policy
184-
version: v1beta1
185182
- name: Extend Resources
186183
chapters:
187184
- name: CustomResourceDefinition

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
@@ -62,7 +62,7 @@ TokenRequestSpec contains client provided parameters of a token request.
6262

6363
- **audiences** ([]string), required
6464

65-
Audiences are the intendend audiences of the token. A recipient of a token must identitfy 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.
65+
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.
6666

6767
- **boundObjectRef** (BoundObjectReference)
6868

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ ClusterRole is a cluster level, logical grouping of PolicyRules that can be refe
6262

6363
- **rules.apiGroups** ([]string)
6464

65-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
65+
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
6666

6767
- **rules.resources** ([]string)
6868

content/en/docs/reference/kubernetes-api/authorization-resources/role-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Role is a namespaced, logical grouping of PolicyRules that can be referenced as
5151

5252
- **rules.apiGroups** ([]string)
5353

54-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
54+
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
5555

5656
- **rules.resources** ([]string)
5757

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ NodeStatus is information about the current status of a node.
356356

357357
- **images.names** ([]string)
358358

359-
Names by which this image is known. e.g. ["registry.k8s.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
359+
Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
360360

361361
- **images.sizeBytes** (int64)
362362

content/en/docs/reference/kubernetes-api/cluster-resources/priority-level-configuration-v1beta2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ PriorityLevelConfigurationSpec specifies the configuration of a priority level.
7070

7171
<a name="LimitedPriorityLevelConfiguration"></a>
7272
*LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues:
73-
* How are requests for this priority level limited?
74-
* What should be done with requests that exceed the limit?*
73+
- How are requests for this priority level limited?
74+
- What should be done with requests that exceed the limit?*
7575

7676
- **limited.assuredConcurrencyShares** (int32)
7777

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,5 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
188188

189189
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
190190

191-
### Ignored {#Ignored}
192-
193-
194-
- **clusterName** (string)
195-
196-
Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25.
197-
198-
The name in the go struct is changed to help clients detect accidental use.
199-
200191

201192

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

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,33 @@ Quantity is a fixed-point representation of a number. It provides convenient mar
3030

3131
The serialization format is:
3232

33-
\<quantity> ::= \<signedNumber>\<suffix>
34-
(Note that \<suffix> may be empty, from the "" case in \<decimalSI>.)
33+
``` \<quantity> ::= \<signedNumber>\<suffix>
34+
35+
(Note that \<suffix> may be empty, from the "" case in \<decimalSI>.)
36+
3537
\<digit> ::= 0 | 1 | ... | 9 \<digits> ::= \<digit> | \<digit>\<digits> \<number> ::= \<digits> | \<digits>.\<digits> | \<digits>. | .\<digits> \<sign> ::= "+" | "-" \<signedNumber> ::= \<number> | \<sign>\<number> \<suffix> ::= \<binarySI> | \<decimalExponent> | \<decimalSI> \<binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei
36-
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
38+
39+
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
40+
3741
\<decimalSI> ::= m | "" | k | M | G | T | P | E
38-
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
39-
\<decimalExponent> ::= "e" \<signedNumber> | "E" \<signedNumber>
42+
43+
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
44+
45+
\<decimalExponent> ::= "e" \<signedNumber> | "E" \<signedNumber> ```
4046
4147
No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
4248
4349
When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.
4450
4551
Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:
46-
a. No precision is lost
47-
b. No fractional digits will be emitted
48-
c. The exponent (or suffix) is as large as possible.
52+
53+
- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.
54+
4955
The sign will be omitted unless the number is negative.
5056
5157
Examples:
52-
1.5 will be serialized as "1500m"
53-
1.5Gi will be serialized as "1536Mi"
58+
59+
- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"
5460
5561
Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.
5662

0 commit comments

Comments
 (0)