mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Add OpenShift 4.18 RC0 APIs
This commit is contained in:
Jason Boxman
@@ -65,15 +65,36 @@ Type::
|
||||
|
||||
| `balanceSimilarNodeGroups`
|
||||
| `boolean`
|
||||
| BalanceSimilarNodeGroups enables/disables the `--balance-similar-node-groups` cluster-autoscaler feature. This feature will automatically identify node groups with the same instance type and the same set of labels and try to keep the respective sizes of those node groups balanced.
|
||||
| BalanceSimilarNodeGroups enables/disables the
|
||||
`--balance-similar-node-groups` cluster-autoscaler feature.
|
||||
This feature will automatically identify node groups with
|
||||
the same instance type and the same set of labels and try
|
||||
to keep the respective sizes of those node groups balanced.
|
||||
|
||||
| `balancingIgnoredLabels`
|
||||
| `array (string)`
|
||||
| BalancingIgnoredLabels sets "--balancing-ignore-label <label name>" flag on cluster-autoscaler for each listed label. This option specifies labels that cluster autoscaler should ignore when considering node group similarity. For example, if you have nodes with "topology.ebs.csi.aws.com/zone" label, you can add name of this label here to prevent cluster autoscaler from spliting nodes into different node groups based on its value.
|
||||
| BalancingIgnoredLabels sets "--balancing-ignore-label <label name>" flag on cluster-autoscaler for each listed label.
|
||||
This option specifies labels that cluster autoscaler should ignore when considering node group similarity.
|
||||
For example, if you have nodes with "topology.ebs.csi.aws.com/zone" label, you can add name of this label here
|
||||
to prevent cluster autoscaler from spliting nodes into different node groups based on its value.
|
||||
|
||||
| `expanders`
|
||||
| `array (string)`
|
||||
| Sets the type and order of expanders to be used during scale out operations. This option specifies an ordered list, highest priority first, of expanders that will be used by the cluster autoscaler to select node groups for expansion when scaling out. Expanders instruct the autoscaler on how to choose node groups when scaling out the cluster. They can be specified in order so that the result from the first expander is used as the input to the second, and so forth. For example, if set to `[LeastWaste, Random]` the autoscaler will first evaluate node groups to determine which will have the least resource waste, if multiple groups are selected the autoscaler will then randomly choose between those groups to determine the group for scaling. The following expanders are available: * LeastWaste - selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. * Priority - selects the node group that has the highest priority assigned by the user. For details, please see https://github.com/openshift/kubernetes-autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md * Random - selects the node group randomly. If not specified, the default value is `Random`, available options are: `LeastWaste`, `Priority`, `Random`.
|
||||
| Sets the type and order of expanders to be used during scale out operations.
|
||||
This option specifies an ordered list, highest priority first, of expanders that
|
||||
will be used by the cluster autoscaler to select node groups for expansion
|
||||
when scaling out.
|
||||
Expanders instruct the autoscaler on how to choose node groups when scaling out
|
||||
the cluster. They can be specified in order so that the result from the first expander
|
||||
is used as the input to the second, and so forth. For example, if set to `[LeastWaste, Random]`
|
||||
the autoscaler will first evaluate node groups to determine which will have the least
|
||||
resource waste, if multiple groups are selected the autoscaler will then randomly choose
|
||||
between those groups to determine the group for scaling.
|
||||
The following expanders are available:
|
||||
* LeastWaste - selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up.
|
||||
* Priority - selects the node group that has the highest priority assigned by the user. For details, please see https://github.com/openshift/kubernetes-autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md
|
||||
* Random - selects the node group randomly.
|
||||
If not specified, the default value is `Random`, available options are: `LeastWaste`, `Priority`, `Random`.
|
||||
|
||||
| `ignoreDaemonsetsUtilization`
|
||||
| `boolean`
|
||||
@@ -81,8 +102,10 @@ Type::
|
||||
|
||||
| `logVerbosity`
|
||||
| `integer`
|
||||
| Sets the autoscaler log level. Default value is 1, level 4 is recommended for DEBUGGING and level 6 will enable almost everything.
|
||||
This option has priority over log level set by the `CLUSTER_AUTOSCALER_VERBOSITY` environment variable.
|
||||
| Sets the autoscaler log level.
|
||||
Default value is 1, level 4 is recommended for DEBUGGING and level 6 will enable almost everything.
|
||||
|
||||
This option has priority over log level set by the `CLUSTER_AUTOSCALER_VERBOSITY` environment variable.
|
||||
|
||||
| `maxNodeProvisionTime`
|
||||
| `string`
|
||||
@@ -94,7 +117,9 @@ Type::
|
||||
|
||||
| `podPriorityThreshold`
|
||||
| `integer`
|
||||
| To allow users to schedule "best-effort" pods, which shouldn't trigger Cluster Autoscaler actions, but only run when there are spare resources available, More info: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption
|
||||
| To allow users to schedule "best-effort" pods, which shouldn't trigger
|
||||
Cluster Autoscaler actions, but only run when there are spare resources available,
|
||||
More info: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption
|
||||
|
||||
| `resourceLimits`
|
||||
| `object`
|
||||
@@ -128,11 +153,13 @@ Type::
|
||||
|
||||
| `cores`
|
||||
| `object`
|
||||
| Minimum and maximum number of cores in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
| Minimum and maximum number of cores in cluster, in the format <min>:<max>.
|
||||
Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
|
||||
| `gpus`
|
||||
| `array`
|
||||
| Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.
|
||||
| Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>.
|
||||
Cluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.
|
||||
|
||||
| `gpus[]`
|
||||
| `object`
|
||||
@@ -140,18 +167,21 @@ Type::
|
||||
|
||||
| `maxNodesTotal`
|
||||
| `integer`
|
||||
| Maximum number of nodes in all node groups. Cluster autoscaler will not grow the cluster beyond this number.
|
||||
| Maximum number of nodes in all node groups.
|
||||
Cluster autoscaler will not grow the cluster beyond this number.
|
||||
|
||||
| `memory`
|
||||
| `object`
|
||||
| Minimum and maximum number of GiB of memory in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
| Minimum and maximum number of GiB of memory in cluster, in the format <min>:<max>.
|
||||
Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
|
||||
|===
|
||||
=== .spec.resourceLimits.cores
|
||||
Description::
|
||||
+
|
||||
--
|
||||
Minimum and maximum number of cores in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
Minimum and maximum number of cores in cluster, in the format <min>:<max>.
|
||||
Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
--
|
||||
|
||||
Type::
|
||||
@@ -180,7 +210,8 @@ Required::
|
||||
Description::
|
||||
+
|
||||
--
|
||||
Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.
|
||||
Minimum and maximum number of different GPUs in cluster, in the format <gpu_type>:<min>:<max>.
|
||||
Cluster autoscaler will not scale the cluster beyond these numbers. Can be passed multiple times.
|
||||
--
|
||||
|
||||
Type::
|
||||
@@ -220,14 +251,19 @@ Required::
|
||||
|
||||
| `type`
|
||||
| `string`
|
||||
| The type of GPU to associate with the minimum and maximum limits. This value is used by the Cluster Autoscaler to identify Nodes that will have GPU capacity by searching for it as a label value on the Node objects. For example, Nodes that carry the label key `cluster-api/accelerator` with the label value being the same as the Type field will be counted towards the resource limits by the Cluster Autoscaler.
|
||||
| The type of GPU to associate with the minimum and maximum limits.
|
||||
This value is used by the Cluster Autoscaler to identify Nodes that will have GPU capacity by searching
|
||||
for it as a label value on the Node objects. For example, Nodes that carry the label key
|
||||
`cluster-api/accelerator` with the label value being the same as the Type field will be counted towards
|
||||
the resource limits by the Cluster Autoscaler.
|
||||
|
||||
|===
|
||||
=== .spec.resourceLimits.memory
|
||||
Description::
|
||||
+
|
||||
--
|
||||
Minimum and maximum number of GiB of memory in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
Minimum and maximum number of GiB of memory in cluster, in the format <min>:<max>.
|
||||
Cluster autoscaler will not scale the cluster beyond these numbers.
|
||||
--
|
||||
|
||||
Type::
|
||||
|
||||
@@ -102,15 +102,22 @@ Required::
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
| APIVersion defines the versioned schema of this representation of an
|
||||
object. Servers should convert recognized schemas to the latest internal
|
||||
value, and may reject unrecognized values. More info:
|
||||
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
| Kind is a string value representing the REST resource this object
|
||||
represents. Servers may infer this from the endpoint the client submits
|
||||
requests to. Cannot be updated. In CamelCase. More info:
|
||||
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace.
|
||||
| Name specifies a name of an object, e.g. worker-us-east-1a.
|
||||
Scalable resources are expected to exist under a single namespace.
|
||||
|
||||
|===
|
||||
=== .status
|
||||
@@ -157,15 +164,22 @@ Required::
|
||||
|
||||
| `apiVersion`
|
||||
| `string`
|
||||
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
| APIVersion defines the versioned schema of this representation of an
|
||||
object. Servers should convert recognized schemas to the latest internal
|
||||
value, and may reject unrecognized values. More info:
|
||||
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
||||
|
||||
| `kind`
|
||||
| `string`
|
||||
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
| Kind is a string value representing the REST resource this object
|
||||
represents. Servers may infer this from the endpoint the client submits
|
||||
requests to. Cannot be updated. In CamelCase. More info:
|
||||
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
||||
|
||||
| `name`
|
||||
| `string`
|
||||
| Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace.
|
||||
| Name specifies a name of an object, e.g. worker-us-east-1a.
|
||||
Scalable resources are expected to exist under a single namespace.
|
||||
|
||||
|===
|
||||
|
||||
|
||||
Reference in New Issue
Block a user