openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

Add 4.20.0 rc0 APIs

Browse Source
This commit is contained in:
Jason Boxman
2025-09-15 08:54:49 -04:00
parent a9a882280a
commit a423d1029b
12 changed files with 1663 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc
View File

@@ -129,6 +129,10 @@ More info: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscal
| `object`
| Configuration of scale down operation
| `scaleUp`
| `object`
| Configuration of scale up operation
| `skipNodesWithLocalStorage`
| `boolean`
| Enables/Disables `--skip-nodes-with-local-storage` CA feature flag. If true cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath. true by default at autoscaler
@@ -331,6 +335,28 @@ Required::
| `string`
| Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
|===
=== .spec.scaleUp
Description::
+
--
Configuration of scale up operation
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `newPodScaleUpDelay`
| `string`
| Scale up delay for new pods, if omitted defaults to 0 seconds
|===
=== .status
Description::

7
rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc
View File

@@ -98,7 +98,12 @@ Type::
| `defaultRuntime`
| `string`
| defaultRuntime is the name of the OCI runtime to be used as the default.
| defaultRuntime is the name of the OCI runtime to be used as the default for containers.
Allowed values are `runc` and `crun`.
When set to `runc`, OpenShift will use runc to execute the container
When set to `crun`, OpenShift will use crun to execute the container
When omitted, this means no opinion and the platform is left to choose a reasonable default,
which is subject to change over time. Currently, the default is `crun`.
| `logLevel`
| `string`

15
rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc
View File

@@ -233,6 +233,15 @@ Use case is e.g. spanning an Alertmanager cluster across Kubernetes clusters wit
| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the
pod's hosts file.
| `hostUsers`
| `boolean`
| HostUsers supports the user space in Kubernetes.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/
The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.
Starting Kubernetes 1.33, the feature is enabled by default.
| `image`
| `string`
| Image if specified has precedence over baseImage, tag and sha
@@ -294,8 +303,8 @@ UI, not the gossip communication.
| `integer`
| Minimum number of seconds for which a newly created pod should be ready
without any of its container crashing for it to be considered available.
Defaults to 0 (pod will be considered available as soon as it is ready)
This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate.
If unset, pods will be considered available as soon as they are ready.
| `nodeSelector`
| `object (string)`
@@ -304,7 +313,7 @@ This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling t
| `paused`
| `boolean`
| If set to true all actions on the underlying managed objects are not
goint to be performed, except for delete actions.
going to be performed, except for delete actions.
| `persistentVolumeClaimRetentionPolicy`
| `object`

1487
rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1beta1.adoc
View File

File diff suppressed because it is too large Load Diff

2
rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc
View File

@@ -178,6 +178,8 @@ that will be accepted.
| Whether to scrape a classic histogram that is also exposed as a native histogram.
It requires Prometheus >= v2.45.0.
Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
| `scrapeProtocols`
| `array (string)`
| `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the

55
rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc
View File

@@ -157,6 +157,16 @@ It requires Prometheus >= v2.50.0.
| `object`
| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
| `params`
| `array`
| The list of HTTP query parameters for the scrape.
Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined.
The module name must be added using Module under ProbeSpec.
| `params[]`
| `object`
| ProbeParam defines specification of extra parameters for a Probe.
| `prober`
| `object`
| Specification for the prober to use for probing targets.
@@ -175,6 +185,8 @@ The prober.URL parameter is required. Targets cannot be probed if left empty.
| Whether to scrape a classic histogram that is also exposed as a native histogram.
It requires Prometheus >= v2.45.0.
Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
| `scrapeProtocols`
| `array (string)`
| `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the
@@ -1055,6 +1067,49 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam
| `boolean`
| Specify whether the Secret or its key must be defined
|===
=== .spec.params
Description::
+
--
The list of HTTP query parameters for the scrape.
Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined.
The module name must be added using Module under ProbeSpec.
--
Type::
`array`
=== .spec.params[]
Description::
+
--
ProbeParam defines specification of extra parameters for a Probe.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| The parameter name
| `values`
| `array (string)`
| The parameter values
|===
=== .spec.prober
Description::

31
rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc
View File

@@ -472,6 +472,15 @@ When hostNetwork is enabled, this will set the DNS policy to
`ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set
to a different value).
| `hostUsers`
| `boolean`
| HostUsers supports the user space in Kubernetes.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/
The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.
Starting Kubernetes 1.33, the feature is enabled by default.
| `ignoreNamespaceSelectors`
| `boolean`
| When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor
@@ -585,10 +594,8 @@ If set, the value should be greater than 60 (seconds). Otherwise it will be equa
| `integer`
| Minimum number of seconds for which a newly created Pod should be ready
without any of its container crashing for it to be considered available.
Defaults to 0 (pod will be considered available as soon as it is ready)
This is an alpha field from kubernetes 1.22 until 1.24 which requires
enabling the StatefulSetMinReadySeconds feature gate.
If unset, pods will be considered available as soon as they are ready.
| `nameEscapingScheme`
| `string`
@@ -863,6 +870,9 @@ in a breaking way.
| `scrapeClassicHistograms`
| `boolean`
| Whether to scrape a classic histogram that is also exposed as a native histogram.
Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
It requires Prometheus >= v3.5.0.
| `scrapeConfigNamespaceSelector`
@@ -9854,6 +9864,13 @@ Type::
| Configures optional translation of OTLP explicit bucket histograms into native histograms with custom buckets.
It requires Prometheus >= v3.4.0.
| `ignoreResourceAttributes`
| `array (string)`
| List of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.
It requires `promoteAllResourceAttributes` to be true.
It requires Prometheus >= v3.5.0.
| `keepIdentifyingResourceAttributes`
| `boolean`
| Enables adding `service.name`, `service.namespace` and `service.instance.id`
@@ -9861,9 +9878,17 @@ resource attributes to the `target_info` metric, on top of converting them into
It requires Prometheus >= v3.1.0.
| `promoteAllResourceAttributes`
| `boolean`
| Promote all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.
Cannot be true when `promoteResourceAttributes` is defined.
It requires Prometheus >= v3.5.0.
| `promoteResourceAttributes`
| `array (string)`
| List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none.
Cannot be defined when `promoteAllResourceAttributes` is true.
| `translationStrategy`
| `string`

2
rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc
View File

@@ -192,6 +192,8 @@ that will be accepted.
| Whether to scrape a classic histogram that is also exposed as a native histogram.
It requires Prometheus >= v2.45.0.
Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.
| `scrapeProtocols`
| `array (string)`
| `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the

35
rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc
View File

@@ -171,6 +171,18 @@ so, you accept that this behaviour may break at any time without notice.
| `string`
| Defines the DNS policy for the pods.
| `enableFeatures`
| `array (string)`
| Enable access to Thanos Ruler feature flags. By default, no features are enabled.
Enabling features which are disabled by default 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.
For more information see https://thanos.io/tip/components/rule.md/
It requires Thanos >= 0.39.0.
| `enableServiceLinks`
| `boolean`
| Indicates whether information about services should be injected into pod's environment variables
@@ -217,6 +229,15 @@ Maps to the '--grpc-server-tls-*' CLI args.
| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the
pod's hosts file.
| `hostUsers`
| `boolean`
| HostUsers supports the user space in Kubernetes.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/
The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.
Starting Kubernetes 1.33, the feature is enabled by default.
| `image`
| `string`
| Thanos container image URL.
@@ -275,8 +296,8 @@ does not bind against the Pod IP.
| `integer`
| Minimum number of seconds for which a newly created pod should be ready
without any of its container crashing for it to be considered available.
Defaults to 0 (pod will be considered available as soon as it is ready)
This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate.
If unset, pods will be considered available as soon as they are ready.
| `nodeSelector`
| `object (string)`
@@ -377,6 +398,10 @@ to a remote endpoint.
| `integer`
| Number of thanos ruler instances to deploy.
| `resendDelay`
| `string`
| Minimum amount of time to wait before resending an alert to Alertmanager.
| `resources`
| `object`
| Resources defines the resource requirements for single Pods.
@@ -400,6 +425,12 @@ operates in stateless mode.
| How many rules can be evaluated concurrently.
It requires Thanos >= v0.37.0.
| `ruleGracePeriod`
| `string`
| Minimum duration between alert and restored "for" state.
This is maintained only for alerts with configured "for" time greater than grace period.
It requires Thanos >= v0.30.0.
| `ruleNamespaceSelector`
| `object`
| Namespaces to be selected for Rules discovery. If unspecified, only

4
rest_api/network_apis/ipamclaim-k8s-cni-cncf-io-v1alpha1.adoc
View File

@@ -43,7 +43,7 @@ Type::
| `status`
| `object`
|
| IPAMClaimStatus contains the observed status of the IPAMClaim.
|===
=== .spec
@@ -79,7 +79,7 @@ Required::
Description::
+
--
IPAMClaimStatus contains the observed status of the IPAMClaim.
--
Type::

267
rest_api/objects/index.adoc
View File

File diff suppressed because it is too large Load Diff

26
rest_api/operator_apis/network-operator-openshift-io-v1.adoc
View File

@@ -701,8 +701,7 @@ current default is "Disabled".
| v4InternalSubnet is a v4 subnet used internally by ovn-kubernetes in case the
default one is being already used by something else. It must not overlap with
any other subnet being used by OpenShift or by the node network. The size of the
subnet must be larger than the number of nodes. The value cannot be changed
after installation.
subnet must be larger than the number of nodes.
Default is 100.64.0.0/16
| `v6InternalSubnet`
@@ -710,8 +709,7 @@ Default is 100.64.0.0/16
| v6InternalSubnet is a v6 subnet used internally by ovn-kubernetes in case the
default one is being already used by something else. It must not overlap with
any other subnet being used by OpenShift or by the node network. The size of the
subnet must be larger than the number of nodes. The value cannot be changed
after installation.
subnet must be larger than the number of nodes.
Default is fd98::/64
|===
@@ -813,7 +811,7 @@ installation. The subnet chosen should not overlap with other networks specified
OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must
be large enough to accommodate 6 IPs (maximum prefix length /29).
When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time.
The current default subnet is 169.254.169.0/29
The current default subnet is 169.254.0.0/17
The value must be in proper IPV4 CIDR format
|===
@@ -844,7 +842,7 @@ installation. The subnet chosen should not overlap with other networks specified
OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must
be large enough to accommodate 6 IPs (maximum prefix length /125).
When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time.
The current default subnet is fd69::/125
The current default subnet is fd69::/112
Note that IPV6 dual addresses are not permitted
|===
@@ -1016,10 +1014,9 @@ Type::
| internalJoinSubnet is a v4 subnet used internally by ovn-kubernetes in case the
default one is being already used by something else. It must not overlap with
any other subnet being used by OpenShift or by the node network. The size of the
subnet must be larger than the number of nodes. The value cannot be changed
after installation.
subnet must be larger than the number of nodes.
The current default value is 100.64.0.0/16
The subnet must be large enough to accomadate one IP per node in your cluster
The subnet must be large enough to accommodate one IP per node in your cluster
The value must be in proper IPV4 CIDR format
| `internalTransitSwitchSubnet`
@@ -1029,11 +1026,10 @@ by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect
architecture that connects the cluster routers on each node together to enable
east west traffic. The subnet chosen should not overlap with other networks
specified for OVN-Kubernetes as well as other networks used on the host.
The value cannot be changed after installation.
When ommitted, this means no opinion and the platform is left to choose a reasonable
default which is subject to change over time.
The current default subnet is 100.88.0.0/16
The subnet must be large enough to accomadate one IP per node in your cluster
The subnet must be large enough to accommodate one IP per node in your cluster
The value must be in proper IPV4 CIDR format
|===
@@ -1061,9 +1057,8 @@ Type::
| internalJoinSubnet is a v6 subnet used internally by ovn-kubernetes in case the
default one is being already used by something else. It must not overlap with
any other subnet being used by OpenShift or by the node network. The size of the
subnet must be larger than the number of nodes. The value cannot be changed
after installation.
The subnet must be large enough to accomadate one IP per node in your cluster
subnet must be larger than the number of nodes.
The subnet must be large enough to accommodate one IP per node in your cluster
The current default value is fd98::/64
The value must be in proper IPV6 CIDR format
Note that IPV6 dual addresses are not permitted
@@ -1075,10 +1070,9 @@ by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect
architecture that connects the cluster routers on each node together to enable
east west traffic. The subnet chosen should not overlap with other networks
specified for OVN-Kubernetes as well as other networks used on the host.
The value cannot be changed after installation.
When ommitted, this means no opinion and the platform is left to choose a reasonable
default which is subject to change over time.
The subnet must be large enough to accomadate one IP per node in your cluster
The subnet must be large enough to accommodate one IP per node in your cluster
The current default subnet is fd97::/64
The value must be in proper IPV6 CIDR format
Note that IPV6 dual addresses are not permitted