Skip to content

Commit 9fcd009

Browse files
committed
Add OpenShift APIs 4.16.0-rc6
- https://issues.redhat.com/browse/OSDOCS-9886
1 parent cbfd774 commit 9fcd009

11 files changed

+312
-20
lines changed

modules/network-observability-flowcollector-api-specifications.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
21
:_mod-docs-content-type: REFERENCE
32
[id="network-observability-flowcollector-api-specifications_{context}"]
43
= FlowCollector API specifications

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

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,11 @@ Type::
7878
| `object`
7979
| externalIP defines configuration for controllers that affect Service.ExternalIP. If nil, then ExternalIP is not allowed to be set.
8080

81+
| `networkDiagnostics`
82+
| `object`
83+
| networkDiagnostics defines network diagnostics configuration.
84+
Takes precedence over spec.disableNetworkDiagnostics in network.operator.openshift.io. If networkDiagnostics is not specified or is empty, and the spec.disableNetworkDiagnostics flag in network.operator.openshift.io is set to true, the network diagnostics feature will be disabled.
85+
8186
| `networkType`
8287
| `string`
8388
| NetworkType is the plugin that is to be deployed (e.g. OpenShiftSDN). This should match a value that the cluster-network-operator understands, or else no networking will be installed. Currently supported values are: - OpenShiftSDN This field is immutable after installation.
@@ -181,6 +186,210 @@ Type::
181186
| `array (string)`
182187
| rejectedCIDRs is the list of disallowed CIDRs. These take precedence over allowedCIDRs.
183188

189+
|===
190+
=== .spec.networkDiagnostics
191+
Description::
192+
+
193+
--
194+
networkDiagnostics defines network diagnostics configuration.
195+
Takes precedence over spec.disableNetworkDiagnostics in network.operator.openshift.io. If networkDiagnostics is not specified or is empty, and the spec.disableNetworkDiagnostics flag in network.operator.openshift.io is set to true, the network diagnostics feature will be disabled.
196+
--
197+
198+
Type::
199+
`object`
200+
201+
202+
203+
204+
[cols="1,1,1",options="header"]
205+
|===
206+
| Property | Type | Description
207+
208+
| `mode`
209+
| `string`
210+
| mode controls the network diagnostics mode
211+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is All.
212+
213+
| `sourcePlacement`
214+
| `object`
215+
| sourcePlacement controls the scheduling of network diagnostics source deployment
216+
See NetworkDiagnosticsSourcePlacement for more details about default values.
217+
218+
| `targetPlacement`
219+
| `object`
220+
| targetPlacement controls the scheduling of network diagnostics target daemonset
221+
See NetworkDiagnosticsTargetPlacement for more details about default values.
222+
223+
|===
224+
=== .spec.networkDiagnostics.sourcePlacement
225+
Description::
226+
+
227+
--
228+
sourcePlacement controls the scheduling of network diagnostics source deployment
229+
See NetworkDiagnosticsSourcePlacement for more details about default values.
230+
--
231+
232+
Type::
233+
`object`
234+
235+
236+
237+
238+
[cols="1,1,1",options="header"]
239+
|===
240+
| Property | Type | Description
241+
242+
| `nodeSelector`
243+
| `object (string)`
244+
| nodeSelector is the node selector applied to network diagnostics components
245+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `kubernetes.io/os: linux`.
246+
247+
| `tolerations`
248+
| `array`
249+
| tolerations is a list of tolerations applied to network diagnostics components
250+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is an empty list.
251+
252+
| `tolerations[]`
253+
| `object`
254+
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
255+
256+
|===
257+
=== .spec.networkDiagnostics.sourcePlacement.tolerations
258+
Description::
259+
+
260+
--
261+
tolerations is a list of tolerations applied to network diagnostics components
262+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is an empty list.
263+
--
264+
265+
Type::
266+
`array`
267+
268+
269+
270+
271+
=== .spec.networkDiagnostics.sourcePlacement.tolerations[]
272+
Description::
273+
+
274+
--
275+
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
276+
--
277+
278+
Type::
279+
`object`
280+
281+
282+
283+
284+
[cols="1,1,1",options="header"]
285+
|===
286+
| Property | Type | Description
287+
288+
| `effect`
289+
| `string`
290+
| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
291+
292+
| `key`
293+
| `string`
294+
| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
295+
296+
| `operator`
297+
| `string`
298+
| 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.
299+
300+
| `tolerationSeconds`
301+
| `integer`
302+
| 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.
303+
304+
| `value`
305+
| `string`
306+
| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
307+
308+
|===
309+
=== .spec.networkDiagnostics.targetPlacement
310+
Description::
311+
+
312+
--
313+
targetPlacement controls the scheduling of network diagnostics target daemonset
314+
See NetworkDiagnosticsTargetPlacement for more details about default values.
315+
--
316+
317+
Type::
318+
`object`
319+
320+
321+
322+
323+
[cols="1,1,1",options="header"]
324+
|===
325+
| Property | Type | Description
326+
327+
| `nodeSelector`
328+
| `object (string)`
329+
| nodeSelector is the node selector applied to network diagnostics components
330+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `kubernetes.io/os: linux`.
331+
332+
| `tolerations`
333+
| `array`
334+
| tolerations is a list of tolerations applied to network diagnostics components
335+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `- operator: "Exists"` which means that all taints are tolerated.
336+
337+
| `tolerations[]`
338+
| `object`
339+
| The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
340+
341+
|===
342+
=== .spec.networkDiagnostics.targetPlacement.tolerations
343+
Description::
344+
+
345+
--
346+
tolerations is a list of tolerations applied to network diagnostics components
347+
When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `- operator: "Exists"` which means that all taints are tolerated.
348+
--
349+
350+
Type::
351+
`array`
352+
353+
354+
355+
356+
=== .spec.networkDiagnostics.targetPlacement.tolerations[]
357+
Description::
358+
+
359+
--
360+
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
361+
--
362+
363+
Type::
364+
`object`
365+
366+
367+
368+
369+
[cols="1,1,1",options="header"]
370+
|===
371+
| Property | Type | Description
372+
373+
| `effect`
374+
| `string`
375+
| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
376+
377+
| `key`
378+
| `string`
379+
| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
380+
381+
| `operator`
382+
| `string`
383+
| 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.
384+
385+
| `tolerationSeconds`
386+
| `integer`
387+
| 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.
388+
389+
| `value`
390+
| `string`
391+
| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
392+
184393
|===
185394
=== .status
186395
Description::

rest_api/network_apis/adminnetworkpolicy-policy-networking-k8s-io-v1alpha1.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Support: Core
123123
| `subject`
124124
| `object`
125125
| Subject defines the pods to which this AdminNetworkPolicy applies.
126+
Note that host-networked pods are not included in subject selection.
126127

127128

128129
Support: Core
@@ -1467,6 +1468,7 @@ Description::
14671468
+
14681469
--
14691470
Subject defines the pods to which this AdminNetworkPolicy applies.
1471+
Note that host-networked pods are not included in subject selection.
14701472

14711473

14721474
Support: Core

rest_api/network_apis/baselineadminnetworkpolicy-policy-networking-k8s-io-v1alpha1.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ Subject field.
113113
| `subject`
114114
| `object`
115115
| Subject defines the pods to which this BaselineAdminNetworkPolicy applies.
116+
Note that host-networked pods are not included in subject selection.
116117

117118

118119
Support: Core
@@ -1445,6 +1446,7 @@ Description::
14451446
+
14461447
--
14471448
Subject defines the pods to which this BaselineAdminNetworkPolicy applies.
1449+
Note that host-networked pods are not included in subject selection.
14481450

14491451

14501452
Support: Core

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

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

192192
| `dnsName`
193193
| `string`
194-
| dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector and nodeSelector must be unset.
194+
| dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector and nodeSelector must be unset. For a wildcard DNS name, the '*' will match only one label. Additionally, only a single '*' can be used at the beginning of the wildcard DNS name. For example, '*.example.com' will match 'sub1.example.com' but won't match 'sub2.sub1.example.com'
195195

196196
| `nodeSelector`
197197
| `object`

rest_api/operator_apis/config-imageregistry-operator-openshift-io-v1.adoc

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -660,7 +660,15 @@ Required::
660660

661661
| `labelSelector`
662662
| `object`
663-
| A label query over a set of resources, in this case pods.
663+
| A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
664+
665+
| `matchLabelKeys`
666+
| `array (string)`
667+
| MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
668+
669+
| `mismatchLabelKeys`
670+
| `array (string)`
671+
| MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
664672

665673
| `namespaceSelector`
666674
| `object`
@@ -679,7 +687,7 @@ Required::
679687
Description::
680688
+
681689
--
682-
A label query over a set of resources, in this case pods.
690+
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
683691
--
684692

685693
Type::
@@ -861,7 +869,15 @@ Required::
861869

862870
| `labelSelector`
863871
| `object`
864-
| A label query over a set of resources, in this case pods.
872+
| A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
873+
874+
| `matchLabelKeys`
875+
| `array (string)`
876+
| MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
877+
878+
| `mismatchLabelKeys`
879+
| `array (string)`
880+
| MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
865881

866882
| `namespaceSelector`
867883
| `object`
@@ -880,7 +896,7 @@ Required::
880896
Description::
881897
+
882898
--
883-
A label query over a set of resources, in this case pods.
899+
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
884900
--
885901

886902
Type::
@@ -1125,7 +1141,15 @@ Required::
11251141

11261142
| `labelSelector`
11271143
| `object`
1128-
| A label query over a set of resources, in this case pods.
1144+
| A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
1145+
1146+
| `matchLabelKeys`
1147+
| `array (string)`
1148+
| MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
1149+
1150+
| `mismatchLabelKeys`
1151+
| `array (string)`
1152+
| MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
11291153

11301154
| `namespaceSelector`
11311155
| `object`
@@ -1144,7 +1168,7 @@ Required::
11441168
Description::
11451169
+
11461170
--
1147-
A label query over a set of resources, in this case pods.
1171+
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
11481172
--
11491173

11501174
Type::
@@ -1326,7 +1350,15 @@ Required::
13261350

13271351
| `labelSelector`
13281352
| `object`
1329-
| A label query over a set of resources, in this case pods.
1353+
| A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
1354+
1355+
| `matchLabelKeys`
1356+
| `array (string)`
1357+
| MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
1358+
1359+
| `mismatchLabelKeys`
1360+
| `array (string)`
1361+
| MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
13301362

13311363
| `namespaceSelector`
13321364
| `object`
@@ -1345,7 +1377,7 @@ Required::
13451377
Description::
13461378
+
13471379
--
1348-
A label query over a set of resources, in this case pods.
1380+
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
13491381
--
13501382

13511383
Type::
@@ -2541,6 +2573,8 @@ OperatorCondition is just the standard condition fields.
25412573
Type::
25422574
`object`
25432575

2576+
Required::
2577+
- `type`
25442578

25452579

25462580

0 commit comments

Comments
 (0)