Skip to content

Commit 9a6e648

Browse files
authored
Merge pull request #97053 from jab-rh/apis-4-20-0ec5
Add apis-4-20-0ec5 for OCP 4.20
2 parents 6837b66 + 8cea264 commit 9a6e648

File tree

64 files changed

+10163
-1157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+10163
-1157
lines changed

_topic_maps/_topic_map.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4076,10 +4076,14 @@ Topics:
40764076
File: machine-machine-openshift-io-v1beta1
40774077
- Name: 'MachineSet [machine.openshift.io/v1beta1]'
40784078
File: machineset-machine-openshift-io-v1beta1
4079+
- Name: 'MachineConfigNode [machineconfiguration.openshift.io/v1]'
4080+
File: machineconfignode-machineconfiguration-openshift-io-v1
40794081
- Name: 'MachineOSBuild [machineconfiguration.openshift.io/v1]'
40804082
File: machineosbuild-machineconfiguration-openshift-io-v1
40814083
- Name: 'MachineOSConfig [machineconfiguration.openshift.io/v1]'
40824084
File: machineosconfig-machineconfiguration-openshift-io-v1
4085+
- Name: 'PinnedImageSet [machineconfiguration.openshift.io/v1]'
4086+
File: pinnedimageset-machineconfiguration-openshift-io-v1
40834087
- Name: Metadata APIs
40844088
Dir: metadata_apis
40854089
Topics:
@@ -4173,6 +4177,8 @@ Topics:
41734177
File: ingress-networking-k8s-io-v1
41744178
- Name: 'IngressClass [networking.k8s.io/v1]'
41754179
File: ingressclass-networking-k8s-io-v1
4180+
- Name: 'IPAddress [networking.k8s.io/v1]'
4181+
File: ipaddress-networking-k8s-io-v1
41764182
- Name: 'IPAMClaim [k8s.cni.cncf.io/v1alpha1]'
41774183
File: ipamclaim-k8s-cni-cncf-io-v1alpha1
41784184
- Name: 'IPPool [whereabouts.cni.cncf.io/v1alpha1]'
@@ -4195,6 +4201,10 @@ Topics:
41954201
File: route-route-openshift-io-v1
41964202
- Name: 'Service [undefined/v1]'
41974203
File: service-v1
4204+
- Name: 'ServiceCIDR [networking.k8s.io/v1]'
4205+
File: servicecidr-networking-k8s-io-v1
4206+
- Name: 'IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]'
4207+
File: ipaddressclaim-ipam-cluster-x-k8s-io-v1beta1
41984208
- Name: 'UserDefinedNetwork [k8s.ovn.org/v1]'
41994209
File: userdefinednetwork-k8s-ovn-org-v1
42004210
- Name: Node APIs

api-config.yaml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -304,18 +304,18 @@ apiMap:
304304
- kind: MachineSet
305305
group: machine.openshift.io
306306
version: v1beta1
307-
# - kind: MachineConfigNode
308-
# group: machineconfiguration.openshift.io
309-
# version: v1alpha1
307+
- kind: MachineConfigNode
308+
group: machineconfiguration.openshift.io
309+
version: v1
310310
- kind: MachineOSBuild
311311
group: machineconfiguration.openshift.io
312312
version: v1
313313
- kind: MachineOSConfig
314314
group: machineconfiguration.openshift.io
315315
version: v1
316-
# - kind: PinnedImageSet
317-
# group: machineconfiguration.openshift.io
318-
# version: v1alpha1
316+
- kind: PinnedImageSet
317+
group: machineconfiguration.openshift.io
318+
version: v1
319319
- name: Metadata APIs
320320
resources:
321321
- kind: APIRequestCount
@@ -442,6 +442,9 @@ apiMap:
442442
- kind: IngressClass
443443
group: networking.k8s.io
444444
version: v1
445+
- kind: IPAddress
446+
group: networking.k8s.io
447+
version: v1
445448
- kind: IPAMClaim
446449
group: k8s.cni.cncf.io
447450
version: v1alpha1
@@ -474,6 +477,12 @@ apiMap:
474477
version: v1
475478
- kind: Service
476479
version: v1
480+
- kind: ServiceCIDR
481+
group: networking.k8s.io
482+
version: v1
483+
- kind: IPAddressClaim
484+
group: ipam.cluster.x-k8s.io
485+
version: v1beta1
477486
- kind: UserDefinedNetwork
478487
group: k8s.ovn.org
479488
version: v1

rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v2.adoc

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,30 @@ Type::
110110

111111
| `scaleDown`
112112
| `object`
113-
| HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
113+
| HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.
114+
115+
Scaling Policy Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
116+
117+
The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires enabling the alpha HPAConfigurableTolerance feature gate.)
114118

115119
| `scaleUp`
116120
| `object`
117-
| HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
121+
| HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.
122+
123+
Scaling Policy Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
124+
125+
The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires enabling the alpha HPAConfigurableTolerance feature gate.)
118126

119127
|===
120128
=== .spec.behavior.scaleDown
121129
Description::
122130
+
123131
--
124-
HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
132+
HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.
133+
134+
Scaling Policy Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
135+
136+
The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires enabling the alpha HPAConfigurableTolerance feature gate.)
125137
--
126138

127139
Type::
@@ -136,7 +148,7 @@ Type::
136148

137149
| `policies`
138150
| `array`
139-
| policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
151+
| policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
140152

141153
| `policies[]`
142154
| `object`
@@ -150,12 +162,20 @@ Type::
150162
| `integer`
151163
| stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
152164

165+
| `tolerance`
166+
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`Quantity`]
167+
| tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%).
168+
169+
For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi.
170+
171+
This is an alpha field and requires enabling the HPAConfigurableTolerance feature gate.
172+
153173
|===
154174
=== .spec.behavior.scaleDown.policies
155175
Description::
156176
+
157177
--
158-
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
178+
policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
159179
--
160180

161181
Type::
@@ -202,7 +222,11 @@ Required::
202222
Description::
203223
+
204224
--
205-
HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
225+
HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance.
226+
227+
Scaling Policy Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.
228+
229+
The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires enabling the alpha HPAConfigurableTolerance feature gate.)
206230
--
207231

208232
Type::
@@ -217,7 +241,7 @@ Type::
217241

218242
| `policies`
219243
| `array`
220-
| policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
244+
| policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
221245

222246
| `policies[]`
223247
| `object`
@@ -231,12 +255,20 @@ Type::
231255
| `integer`
232256
| stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
233257

258+
| `tolerance`
259+
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`Quantity`]
260+
| tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or equal to zero. If not set, the default cluster-wide tolerance is applied (by default 10%).
261+
262+
For example, if autoscaling is configured with a memory consumption target of 100Mi, and scale-down and scale-up tolerances of 5% and 1% respectively, scaling will be triggered when the actual consumption falls below 95Mi or exceeds 101Mi.
263+
264+
This is an alpha field and requires enabling the HPAConfigurableTolerance feature gate.
265+
234266
|===
235267
=== .spec.behavior.scaleUp.policies
236268
Description::
237269
+
238270
--
239-
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
271+
policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4 pods in a 15s window. - For scale down: allow all pods to be removed in a 15s window.
240272
--
241273

242274
Type::

rest_api/cluster_apis/ipaddress-ipam-cluster-x-k8s-io-v1beta1.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ Type::
3939

4040
| `spec`
4141
| `object`
42-
| IPAddressSpec is the desired state of an IPAddress.
42+
| spec is the desired state of IPAddress.
4343

4444
|===
4545
=== .spec
4646
Description::
4747
+
4848
--
49-
IPAddressSpec is the desired state of an IPAddress.
49+
spec is the desired state of IPAddress.
5050
--
5151

5252
Type::

0 commit comments

Comments
 (0)