Skip to content

Commit fa6ee64

Browse files
authored
Merge pull request #60049 from jboxman-rh/try-413
Refresh OpenShift 4.13 REST API resources
2 parents 6c735b7 + 44e0e0a commit fa6ee64

13 files changed

+289
-72
lines changed

rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -315,37 +315,10 @@ Type::
315315
|===
316316
| Property | Type | Description
317317

318-
| `cloudControllerManager`
319-
| `object`
320-
| CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
321-
322318
| `platformName`
323319
| `string`
324320
| PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. This field is solely for informational and reporting purposes and is not expected to be used for decision-making.
325321

326-
|===
327-
=== .spec.platformSpec.external.cloudControllerManager
328-
Description::
329-
+
330-
--
331-
CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
332-
--
333-
334-
Type::
335-
`object`
336-
337-
338-
339-
340-
[cols="1,1,1",options="header"]
341-
|===
342-
| Property | Type | Description
343-
344-
| `state`
345-
| `string`
346-
| state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager
347-
When set to "External", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to "None", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.
348-
349322
|===
350323
=== .spec.platformSpec.gcp
351324
Description::
@@ -1616,6 +1589,10 @@ Type::
16161589
| `string`
16171590
| region holds the default Power VS region for new Power VS resources created by the cluster.
16181591

1592+
| `resourceGroup`
1593+
| `string`
1594+
| resourceGroup is the resource group name for new IBMCloud resources created for a cluster. The resource group specified here will be used by cluster-image-registry-operator to set up a COS Instance in IBMCloud for the cluster registry. More about resource groups can be found here: https://cloud.ibm.com/docs/account?topic=account-rgs. When omitted, the image registry operator won't be able to configure storage, which results in the image registry cluster operator not being in an available state.
1595+
16191596
| `serviceEndpoints`
16201597
| `array`
16211598
| serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.

rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Type::
161161

162162
| `initContainers`
163163
| `array`
164-
| InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ Using initContainers for any use case other then secret fetching is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.
164+
| InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: `init-config-reloader`. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.
165165

166166
| `initContainers[]`
167167
| `object`
@@ -197,7 +197,7 @@ Type::
197197

198198
| `portName`
199199
| `string`
200-
| Port name used for the pods and governing service. This defaults to web
200+
| Port name used for the pods and governing service. Defaults to `web`.
201201

202202
| `priorityClassName`
203203
| `string`
@@ -4546,7 +4546,7 @@ Type::
45464546
Description::
45474547
+
45484548
--
4549-
InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ Using initContainers for any use case other then secret fetching is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.
4549+
InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator generated init containers if they share the same name and modifications are done via a strategic merge patch. The current init container name is: `init-config-reloader`. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.
45504550
--
45514551

45524552
Type::

rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ Type::
282282

283283
| `portName`
284284
| `string`
285-
| Port name used for the pods and governing service. This defaults to web
285+
| Port name used for the pods and governing service. Defaults to `web`.
286286

287287
| `priorityClassName`
288288
| `string`
@@ -417,8 +417,7 @@ Type::
417417
| `thanos`
418418
| `object`
419419
| Thanos configuration allows configuring various aspects of a Prometheus server in a Thanos environment.
420-
This section is experimental, it may change significantly without deprecation notice in any release.
421-
This is experimental and may change significantly without backward compatibility in any release.
420+
This section is experimental, it may change significantly without deprecation notice in any release.
422421

423422
| `tolerations`
424423
| `array`
@@ -10321,8 +10320,7 @@ Description::
1032110320
+
1032210321
--
1032310322
Thanos configuration allows configuring various aspects of a Prometheus server in a Thanos environment.
10324-
This section is experimental, it may change significantly without deprecation notice in any release.
10325-
This is experimental and may change significantly without backward compatibility in any release.
10323+
This section is experimental, it may change significantly without deprecation notice in any release.
1032610324
--
1032710325

1032810326
Type::
@@ -10347,6 +10345,10 @@ Type::
1034710345
| `string`
1034810346
| Thanos base image if other than default. Deprecated: use 'image' instead
1034910347

10348+
| `blockSize`
10349+
| `string`
10350+
| BlockDuration controls the size of TSDB blocks produced by Prometheus. Default is 2h to match the upstream Prometheus defaults. WARNING: Changing the block duration can impact the performance and efficiency of the entire Prometheus/Thanos stack due to how it interacts with memory and Thanos compactors. It is recommended to keep this value set to a multiple of 120 times your longest scrape or rule interval. For example, 30s * 120 = 1h.
10351+
1035010352
| `grpcListenLocal`
1035110353
| `boolean`
1035210354
| If true, the Thanos sidecar listens on the loopback interface for the gRPC endpoints. It has no effect if `listenLocal` is true.

rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Type::
207207

208208
| `portName`
209209
| `string`
210-
| Port name used for the pods and governing service. This defaults to web
210+
| Port name used for the pods and governing service. Defaults to `web`.
211211

212212
| `priorityClassName`
213213
| `string`

rest_api/network_apis/egressfirewall-k8s-ovn-org-v1.adoc

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,11 +187,91 @@ Type::
187187

188188
| `cidrSelector`
189189
| `string`
190-
| cidrSelector is the CIDR range to allow/deny traffic to. If this is set, dnsName must be unset.
190+
| cidrSelector is the CIDR range to allow/deny traffic to. If this is set, dnsName and nodeSelector must be unset.
191191

192192
| `dnsName`
193193
| `string`
194-
| dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset.
194+
| dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector and nodeSelector must be unset.
195+
196+
| `nodeSelector`
197+
| `object`
198+
| nodeSelector will allow/deny traffic to the Kubernetes node IP of selected nodes. If this is set, cidrSelector and DNSName must be unset.
199+
200+
|===
201+
=== .spec.egress[].to.nodeSelector
202+
Description::
203+
+
204+
--
205+
nodeSelector will allow/deny traffic to the Kubernetes node IP of selected nodes. If this is set, cidrSelector and DNSName must be unset.
206+
--
207+
208+
Type::
209+
`object`
210+
211+
212+
213+
214+
[cols="1,1,1",options="header"]
215+
|===
216+
| Property | Type | Description
217+
218+
| `matchExpressions`
219+
| `array`
220+
| matchExpressions is a list of label selector requirements. The requirements are ANDed.
221+
222+
| `matchExpressions[]`
223+
| `object`
224+
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
225+
226+
| `matchLabels`
227+
| `object (string)`
228+
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
229+
230+
|===
231+
=== .spec.egress[].to.nodeSelector.matchExpressions
232+
Description::
233+
+
234+
--
235+
matchExpressions is a list of label selector requirements. The requirements are ANDed.
236+
--
237+
238+
Type::
239+
`array`
240+
241+
242+
243+
244+
=== .spec.egress[].to.nodeSelector.matchExpressions[]
245+
Description::
246+
+
247+
--
248+
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
249+
--
250+
251+
Type::
252+
`object`
253+
254+
Required::
255+
- `key`
256+
- `operator`
257+
258+
259+
260+
[cols="1,1,1",options="header"]
261+
|===
262+
| Property | Type | Description
263+
264+
| `key`
265+
| `string`
266+
| key is the label key that the selector applies to.
267+
268+
| `operator`
269+
| `string`
270+
| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
271+
272+
| `values`
273+
| `array (string)`
274+
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
195275

196276
|===
197277
=== .status

rest_api/objects/index.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3310,7 +3310,7 @@ Type::
33103310

33113311
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
33123312

3313-
This field is immutable.
3313+
This field is immutable. It can only be set for containers.
33143314

33153315
| `claims[]`
33163316
| `object`
@@ -3333,7 +3333,7 @@ Claims lists the names of resources, defined in spec.resourceClaims, that are us
33333333

33343334
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
33353335

3336-
This field is immutable.
3336+
This field is immutable. It can only be set for containers.
33373337
--
33383338

33393339
Type::
@@ -3981,6 +3981,14 @@ Type::
39813981
|===
39823982
| Property | Type | Description
39833983

3984+
| `claims`
3985+
| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceClaim[`array (ResourceClaim)`]
3986+
| Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
3987+
3988+
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
3989+
3990+
This field is immutable.
3991+
39843992
| `limits`
39853993
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`]
39863994
| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Type::
6868

6969
| `credentialsMode`
7070
| `string`
71-
| CredentialsMode allows informing CCO that it should not attempt to dynamically determine the root cloud credentials capabilities, and it should just run in the specified mode. It also allows putting the operator into "manual" mode if desired. Leaving the field in default mode runs CCO so that the cluster's cloud credentials will be dynamically probed for capabilities (on supported clouds/platforms). Supported modes: AWS/Azure/GCP: "" (Default), "Mint", "Passthrough", "Manual" Others: Do not set value as other platforms only support running in "Passthrough"
71+
| CredentialsMode allows informing CCO that it should not attempt to dynamically determine the root cloud credentials capabilities, and it should just run in the specified mode. It also allows putting the operator into "manual" mode if desired. Leaving the field in default mode runs CCO so that the cluster's cloud credentials will be dynamically probed for capabilities (on supported clouds/platforms). Supported modes: AWS/Azure/GCP: "" (Default), "Mint", "Passthrough", "Manual" Others: Do not set value as other platforms only support running in "Passthrough"
7272

7373
| `logLevel`
7474
| `string`

0 commit comments

Comments
 (0)