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 OpenShift 4.18 RC0 APIs

Browse Source
This commit is contained in:
Jason Boxman
2025-01-02 09:24:22 -05:00
parent a66418f4a2
commit 041c14d5f1
141 changed files with 20978 additions and 5298 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
rest_api/node_apis/node-apis-index.adoc
View File

@@ -56,7 +56,13 @@ Type::
Description::
+
--
Tuned is a collection of rules that allows cluster-wide deployment of node-level sysctls and more flexibility to add custom tuning specified by user needs. These rules are translated and passed to all containerized Tuned daemons running in the cluster in the format that the daemons understand. The responsibility for applying the node-level tuning then lies with the containerized Tuned daemons. More info: https://github.com/openshift/cluster-node-tuning-operator
Tuned is a collection of rules that allows cluster-wide deployment
of node-level sysctls and more flexibility to add custom tuning
specified by user needs. These rules are translated and passed to all
containerized Tuned daemons running in the cluster in the format that
the daemons understand. The responsibility for applying the node-level
tuning then lies with the containerized Tuned daemons. More info:
https://github.com/openshift/cluster-node-tuning-operator
--
Type::

38
rest_api/node_apis/node-v1.adoc
View File

@@ -246,7 +246,7 @@ Type::
| `capacity`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-api-resource-Quantity[`object (Quantity)`]
| Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
| Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacity
| `conditions`
| `array`
@@ -264,6 +264,10 @@ Type::
| `object`
| NodeDaemonEndpoints lists ports opened by daemons running on the Node.
| `features`
| `object`
| NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.
| `images`
| `array`
| List of container images on this node
@@ -677,6 +681,28 @@ Required::
| `integer`
| Port number of the given endpoint.
|===
=== .status.features
Description::
+
--
NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `supplementalGroupsPolicy`
| `boolean`
| SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.
|===
=== .status.images
Description::
@@ -763,7 +789,7 @@ Required::
| `kubeProxyVersion`
| `string`
| KubeProxy Version reported by the node.
| Deprecated: KubeProxy Version reported by the node.
| `kubeletVersion`
| `string`
@@ -818,7 +844,7 @@ Type::
| `features`
| `object`
| NodeRuntimeHandlerFeatures is a set of runtime features.
| NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
| `name`
| `string`
@@ -829,7 +855,7 @@ Type::
Description::
+
--
NodeRuntimeHandlerFeatures is a set of runtime features.
NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
--
Type::
@@ -846,6 +872,10 @@ Type::
| `boolean`
| RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
| `userNamespaces`
| `boolean`
| UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.
|===
=== .status.volumesAttached
Description::

92
rest_api/node_apis/performanceprofile-performance-openshift-io-v2.adoc
View File

@@ -76,7 +76,11 @@ Required::
| `globallyDisableIrqLoadBalancing`
| `boolean`
| GloballyDisableIrqLoadBalancing toggles whether IRQ load balancing will be disabled for the Isolated CPU set. When the option is set to "true" it disables IRQs load balancing for the Isolated CPU set. Setting the option to "false" allows the IRQs to be balanced across all CPUs, however the IRQs load balancing can be disabled per pod CPUs when using irq-load-balancing.crio.io/cpu-quota.crio.io annotations. Defaults to "false"
| GloballyDisableIrqLoadBalancing toggles whether IRQ load balancing will be disabled for the Isolated CPU set.
When the option is set to "true" it disables IRQs load balancing for the Isolated CPU set.
Setting the option to "false" allows the IRQs to be balanced across all CPUs, however the IRQs load balancing
can be disabled per pod CPUs when using irq-load-balancing.crio.io/cpu-quota.crio.io annotations.
Defaults to "false"
| `hardwareTuning`
| `object`
@@ -84,15 +88,23 @@ Required::
| `hugepages`
| `object`
| HugePages defines a set of huge pages related parameters. It is possible to set huge pages with multiple size values at the same time. For example, hugepages can be set with 1G and 2M, both values will be set on the node by the Performance Profile Controller. It is important to notice that setting hugepages default size to 1G will remove all 2M related folders from the node and it will be impossible to configure 2M hugepages under the node.
| HugePages defines a set of huge pages related parameters.
It is possible to set huge pages with multiple size values at the same time.
For example, hugepages can be set with 1G and 2M, both values will be set on the node by the Performance Profile Controller.
It is important to notice that setting hugepages default size to 1G will remove all 2M related
folders from the node and it will be impossible to configure 2M hugepages under the node.
| `machineConfigLabel`
| `object (string)`
| MachineConfigLabel defines the label to add to the MachineConfigs the operator creates. It has to be used in the MachineConfigSelector of the MachineConfigPool which targets this performance profile. Defaults to "machineconfiguration.openshift.io/role=<same role as in NodeSelector label key>"
| MachineConfigLabel defines the label to add to the MachineConfigs the operator creates. It has to be
used in the MachineConfigSelector of the MachineConfigPool which targets this performance profile.
Defaults to "machineconfiguration.openshift.io/role=<same role as in NodeSelector label key>"
| `machineConfigPoolSelector`
| `object (string)`
| MachineConfigPoolSelector defines the MachineConfigPool label to use in the MachineConfigPoolSelector of resources like KubeletConfigs created by the operator. Defaults to "machineconfiguration.openshift.io/role=<same role as in NodeSelector label key>"
| MachineConfigPoolSelector defines the MachineConfigPool label to use in the MachineConfigPoolSelector
of resources like KubeletConfigs created by the operator.
Defaults to "machineconfiguration.openshift.io/role=<same role as in NodeSelector label key>"
| `net`
| `object`
@@ -100,7 +112,11 @@ Required::
| `nodeSelector`
| `object (string)`
| NodeSelector defines the Node label to use in the NodeSelectors of resources like Tuned created by the operator. It most likely should, but does not have to match the node label in the NodeSelector of the MachineConfigPool which targets this performance profile. In the case when machineConfigLabels or machineConfigPoolSelector are not set, we are expecting a certain NodeSelector format <domain>/<role>: "" in order to be able to calculate the default values for the former mentioned fields.
| NodeSelector defines the Node label to use in the NodeSelectors of resources like Tuned created by the operator.
It most likely should, but does not have to match the node label in the NodeSelector of the MachineConfigPool
which targets this performance profile.
In the case when machineConfigLabels or machineConfigPoolSelector are not set, we are expecting a certain NodeSelector format
<domain>/<role>: "" in order to be able to calculate the default values for the former mentioned fields.
| `numa`
| `object`
@@ -112,7 +128,8 @@ Required::
| `workloadHints`
| `object`
| WorkloadHints defines hints for different types of workloads. It will allow defining exact set of tuned and kernel arguments that should be applied on top of the node.
| WorkloadHints defines hints for different types of workloads. It will allow defining exact set of tuned and
kernel arguments that should be applied on top of the node.
|===
=== .spec.cpu
@@ -137,11 +154,22 @@ Required::
| `balanceIsolated`
| `boolean`
| BalanceIsolated toggles whether or not the Isolated CPU set is eligible for load balancing work loads. When this option is set to "false", the Isolated CPU set will be static, meaning workloads have to explicitly assign each thread to a specific cpu in order to work across multiple CPUs. Setting this to "true" allows workloads to be balanced across CPUs. Setting this to "false" offers the most predictable performance for guaranteed workloads, but it offloads the complexity of cpu load balancing to the application. Defaults to "true"
| BalanceIsolated toggles whether or not the Isolated CPU set is eligible for load balancing work loads.
When this option is set to "false", the Isolated CPU set will be static, meaning workloads have to
explicitly assign each thread to a specific cpu in order to work across multiple CPUs.
Setting this to "true" allows workloads to be balanced across CPUs.
Setting this to "false" offers the most predictable performance for guaranteed workloads, but it
offloads the complexity of cpu load balancing to the application.
Defaults to "true"
| `isolated`
| `string`
| Isolated defines a set of CPUs that will be used to give to application threads the most execution time possible, which means removing as many extraneous tasks off a CPU as possible. It is important to notice the CPU manager can choose any CPU to run the workload except the reserved CPUs. In order to guarantee that your workload will run on the isolated CPU: 1. The union of reserved CPUs and isolated CPUs should include all online CPUs 2. The isolated CPUs field should be the complementary to reserved CPUs field
| Isolated defines a set of CPUs that will be used to give to application threads the most execution time possible,
which means removing as many extraneous tasks off a CPU as possible.
It is important to notice the CPU manager can choose any CPU to run the workload
except the reserved CPUs. In order to guarantee that your workload will run on the isolated CPU:
1. The union of reserved CPUs and isolated CPUs should include all online CPUs
2. The isolated CPUs field should be the complementary to reserved CPUs field
| `offlined`
| `string`
@@ -153,7 +181,9 @@ Required::
| `shared`
| `string`
| Shared defines a set of CPUs that will be shared among guaranteed workloads that needs additional cpus which are not exclusive, alongside the isolated, exclusive resources that are being used already by those workloads.
| Shared defines a set of CPUs that will be shared among guaranteed workloads
that needs additional cpus which are not exclusive,
alongside the isolated, exclusive resources that are being used already by those workloads.
|===
=== .spec.hardwareTuning
@@ -186,7 +216,11 @@ Type::
Description::
+
--
HugePages defines a set of huge pages related parameters. It is possible to set huge pages with multiple size values at the same time. For example, hugepages can be set with 1G and 2M, both values will be set on the node by the Performance Profile Controller. It is important to notice that setting hugepages default size to 1G will remove all 2M related folders from the node and it will be impossible to configure 2M hugepages under the node.
HugePages defines a set of huge pages related parameters.
It is possible to set huge pages with multiple size values at the same time.
For example, hugepages can be set with 1G and 2M, both values will be set on the node by the Performance Profile Controller.
It is important to notice that setting hugepages default size to 1G will remove all 2M related
folders from the node and it will be impossible to configure 2M hugepages under the node.
--
Type::
@@ -248,7 +282,8 @@ Type::
| `node`
| `integer`
| Node defines the NUMA node where hugepages will be allocated, if not specified, pages will be allocated equally between NUMA nodes
| Node defines the NUMA node where hugepages will be allocated,
if not specified, pages will be allocated equally between NUMA nodes
| `size`
| `string`
@@ -274,11 +309,14 @@ Type::
| `devices`
| `array`
| Devices contains a list of network device representations that will be set with a netqueue count equal to CPU.Reserved . If no devices are specified then the default is all devices.
| Devices contains a list of network device representations that will be
set with a netqueue count equal to CPU.Reserved .
If no devices are specified then the default is all devices.
| `devices[]`
| `object`
| Device defines a way to represent a network device in several options: device name, vendor ID, model ID, PCI path and MAC address
| Device defines a way to represent a network device in several options:
device name, vendor ID, model ID, PCI path and MAC address
| `userLevelNetworking`
| `boolean`
@@ -289,7 +327,9 @@ Type::
Description::
+
--
Devices contains a list of network device representations that will be set with a netqueue count equal to CPU.Reserved . If no devices are specified then the default is all devices.
Devices contains a list of network device representations that will be
set with a netqueue count equal to CPU.Reserved .
If no devices are specified then the default is all devices.
--
Type::
@@ -302,7 +342,8 @@ Type::
Description::
+
--
Device defines a way to represent a network device in several options: device name, vendor ID, model ID, PCI path and MAC address
Device defines a way to represent a network device in several options:
device name, vendor ID, model ID, PCI path and MAC address
--
Type::
@@ -347,7 +388,8 @@ Type::
| `topologyPolicy`
| `string`
| Name of the policy applied when TopologyManager is enabled Operator defaults to "best-effort"
| Name of the policy applied when TopologyManager is enabled
Operator defaults to "best-effort"
|===
=== .spec.realTimeKernel
@@ -376,7 +418,8 @@ Type::
Description::
+
--
WorkloadHints defines hints for different types of workloads. It will allow defining exact set of tuned and kernel arguments that should be applied on top of the node.
WorkloadHints defines hints for different types of workloads. It will allow defining exact set of tuned and
kernel arguments that should be applied on top of the node.
--
Type::
@@ -391,15 +434,18 @@ Type::
| `highPowerConsumption`
| `boolean`
| HighPowerConsumption defines if the node should be configured in high power consumption mode. The flag will affect the power consumption but will improve the CPUs latency. Defaults to false.
| HighPowerConsumption defines if the node should be configured in high power consumption mode.
The flag will affect the power consumption but will improve the CPUs latency. Defaults to false.
| `mixedCpus`
| `boolean`
| MixedCpus enables the mixed-cpu-node-plugin on the node. Defaults to false.
| MixedCpus enables the mixed-cpu-node-plugin on the node.
Defaults to false.
| `perPodPowerManagement`
| `boolean`
| PerPodPowerManagement defines if the node should be configured in per pod power management. PerPodPowerManagement and HighPowerConsumption hints can not be enabled together. Defaults to false.
| PerPodPowerManagement defines if the node should be configured in per pod power management.
PerPodPowerManagement and HighPowerConsumption hints can not be enabled together. Defaults to false.
| `realTime`
| `boolean`
@@ -429,7 +475,8 @@ Type::
| `conditions[]`
| `object`
| Condition represents the state of the operator's reconciliation functionality.
| Condition represents the state of the operator's
reconciliation functionality.
| `runtimeClass`
| `string`
@@ -457,7 +504,8 @@ Type::
Description::
+
--
Condition represents the state of the operator's reconciliation functionality.
Condition represents the state of the operator's
reconciliation functionality.
--
Type::

13
rest_api/node_apis/profile-tuned-openshift-io-v1.adoc
View File

@@ -43,7 +43,8 @@ Type::
| `status`
| `object`
| ProfileStatus is the status for a Profile resource; the status is for internal use only and its fields may be changed/removed in the future.
| ProfileStatus is the status for a Profile resource; the status is for internal use only
and its fields may be changed/removed in the future.
|===
=== .spec
@@ -113,6 +114,10 @@ Required::
| `string`
| TuneD profile to apply
| `verbosity`
| `integer`
| klog logging verbosity
|===
=== .spec.config.tunedConfig
Description::
@@ -182,7 +187,8 @@ Required::
Description::
+
--
ProfileStatus is the status for a Profile resource; the status is for internal use only and its fields may be changed/removed in the future.
ProfileStatus is the status for a Profile resource; the status is for internal use only
and its fields may be changed/removed in the future.
--
Type::
@@ -250,7 +256,8 @@ Required::
| `message`
| `string`
| message provides additional information about the current condition. This is only to be consumed by humans.
| message provides additional information about the current condition.
This is only to be consumed by humans.
| `reason`
| `string`

28
rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc
View File

@@ -11,7 +11,13 @@ toc::[]
Description::
+
--
Tuned is a collection of rules that allows cluster-wide deployment of node-level sysctls and more flexibility to add custom tuning specified by user needs. These rules are translated and passed to all containerized Tuned daemons running in the cluster in the format that the daemons understand. The responsibility for applying the node-level tuning then lies with the containerized Tuned daemons. More info: https://github.com/openshift/cluster-node-tuning-operator
Tuned is a collection of rules that allows cluster-wide deployment
of node-level sysctls and more flexibility to add custom tuning
specified by user needs. These rules are translated and passed to all
containerized Tuned daemons running in the cluster in the format that
the daemons understand. The responsibility for applying the node-level
tuning then lies with the containerized Tuned daemons. More info:
https://github.com/openshift/cluster-node-tuning-operator
--
Type::
@@ -39,7 +45,8 @@ Type::
| `spec`
| `object`
| spec is the specification of the desired behavior of Tuned. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
| spec is the specification of the desired behavior of Tuned. More info:
https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
| `status`
| `object`
@@ -50,7 +57,8 @@ Type::
Description::
+
--
spec is the specification of the desired behavior of Tuned. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
spec is the specification of the desired behavior of Tuned. More info:
https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
--
Type::
@@ -65,7 +73,9 @@ Type::
| `managementState`
| `string`
| managementState indicates whether the registry instance represented by this config instance is under operator management or not. Valid values are Force, Managed, Unmanaged, and Removed.
| managementState indicates whether the registry instance represented
by this config instance is under operator management or not. Valid
values are Force, Managed, Unmanaged, and Removed.
| `profile`
| `array`
@@ -161,7 +171,11 @@ Required::
| `machineConfigLabels`
| `object (string)`
| MachineConfigLabels specifies the labels for a MachineConfig. The MachineConfig is created automatically to apply additional host settings (e.g. kernel boot parameters) profile 'Profile' needs and can only be applied by creating a MachineConfig. This involves finding all MachineConfigPools with machineConfigSelector matching the MachineConfigLabels and setting the profile 'Profile' on all nodes that match the MachineConfigPools' nodeSelectors.
| MachineConfigLabels specifies the labels for a MachineConfig. The MachineConfig is created
automatically to apply additional host settings (e.g. kernel boot parameters) profile 'Profile'
needs and can only be applied by creating a MachineConfig. This involves finding all
MachineConfigPools with machineConfigSelector matching the MachineConfigLabels and setting the
profile 'Profile' on all nodes that match the MachineConfigPools' nodeSelectors.
| `match`
| `array`
@@ -258,6 +272,10 @@ Type::
| `object`
| Global configuration for the TuneD daemon as defined in tuned-main.conf
| `verbosity`
| `integer`
| klog logging verbosity
|===
=== .spec.recommend[].operand.tunedConfig
Description::