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
Files
a9a97db5c6252918bc95f2bb92ef889585e69d68
openshift-docs/rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc

716 lines
22 KiB
Plaintext
Raw Blame History

// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="clusterautoscaler-autoscaling-openshift-io-v1"]
= ClusterAutoscaler [autoscaling.openshift.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
ClusterAutoscaler is the Schema for the clusterautoscalers API
--
Type::
`object`
== Specification
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `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
| `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
| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `spec`
| `object`
| Desired state of ClusterAutoscaler resource
| `status`
| `object`
| Most recently observed status of ClusterAutoscaler resource
|===
=== .spec
Description::
+
--
Desired state of ClusterAutoscaler resource
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `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.
| `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.
| `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`.
| `ignoreDaemonsetsUtilization`
| `boolean`
| Enables/Disables `--ignore-daemonsets-utilization` CA feature flag. Should CA ignore DaemonSet pods when calculating resource utilization for scaling down. false by default
| `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.
| `maxNodeProvisionTime`
| `string`
| Maximum time CA waits for node to be provisioned
| `maxPodGracePeriod`
| `integer`
| Gives pods graceful termination time before scaling down
| `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
| `resourceLimits`
| `object`
| Constraints of autoscaling resources
| `scaleDown`
| `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
|===
=== .spec.resourceLimits
Description::
+
--
Constraints of autoscaling resources
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `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.
| `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.
| `gpus[]`
| `object`
|
| `maxNodesTotal`
| `integer`
| 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.
|===
=== .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.
--
Type::
`object`
Required::
- `max`
- `min`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `max`
| `integer`
|
| `min`
| `integer`
|
|===
=== .spec.resourceLimits.gpus
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.
--
Type::
`array`
=== .spec.resourceLimits.gpus[]
Description::
+
--
--
Type::
`object`
Required::
- `max`
- `min`
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `max`
| `integer`
|
| `min`
| `integer`
|
| `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.
|===
=== .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.
--
Type::
`object`
Required::
- `max`
- `min`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `max`
| `integer`
|
| `min`
| `integer`
|
|===
=== .spec.scaleDown
Description::
+
--
Configuration of scale down operation
--
Type::
`object`
Required::
- `enabled`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `cordonNodeBeforeTerminating`
| `string`
| CordonNodeBeforeTerminating enables/disables cordoning nodes before terminating during scale down.
| `delayAfterAdd`
| `string`
| How long after scale up that scale down evaluation resumes
| `delayAfterDelete`
| `string`
| How long after node deletion that scale down evaluation resumes, defaults to scan-interval
| `delayAfterFailure`
| `string`
| How long after scale down failure that scale down evaluation resumes
| `enabled`
| `boolean`
| Should CA scale down the cluster
| `unneededTime`
| `string`
| How long a node should be unneeded before it is eligible for scale down
| `utilizationThreshold`
| `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::
+
--
Most recently observed status of ClusterAutoscaler resource
--
Type::
`object`
== API endpoints
The following API endpoints are available:
* `/apis/autoscaling.openshift.io/v1/clusterautoscalers`
- `DELETE`: delete collection of ClusterAutoscaler
- `GET`: list objects of kind ClusterAutoscaler
- `POST`: create a ClusterAutoscaler
* `/apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}`
- `DELETE`: delete a ClusterAutoscaler
- `GET`: read the specified ClusterAutoscaler
- `PATCH`: partially update the specified ClusterAutoscaler
- `PUT`: replace the specified ClusterAutoscaler
* `/apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}/status`
- `GET`: read status of the specified ClusterAutoscaler
- `PATCH`: partially update status of the specified ClusterAutoscaler
- `PUT`: replace status of the specified ClusterAutoscaler
=== /apis/autoscaling.openshift.io/v1/clusterautoscalers
HTTP method::
`DELETE`
Description::
delete collection of ClusterAutoscaler
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
list objects of kind ClusterAutoscaler
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-autoscaling-v1-ClusterAutoscalerList[`ClusterAutoscalerList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create a ClusterAutoscaler
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 201 - Created
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 202 - Accepted
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterAutoscaler
|===
HTTP method::
`DELETE`
Description::
delete a ClusterAutoscaler
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`GET`
Description::
read the specified ClusterAutoscaler
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified ClusterAutoscaler
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified ClusterAutoscaler
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 201 - Created
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterAutoscaler
|===
HTTP method::
`GET`
Description::
read status of the specified ClusterAutoscaler
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified ClusterAutoscaler
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified ClusterAutoscaler
.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===
.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 201 - Created
| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema
| 401 - Unauthorized
| Empty
|===
View Git Blame Copy Permalink