This is a cache of https://docs.okd.io/4.8/rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.html. It is a snapshot of the page at 2024-11-25T01:00:16.157+0000.
ClusterAutoscaler [autoscaling.openshift.io/v1] - Autoscale <strong>api</strong>s | <strong>api</strong> reference | OKD 4.8
  1. Documentation
×

ClusterAutoscaler [autoscaling.openshift.io/v1]

Specification

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

ObjectMeta_v2 meta/v1

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

Property Type Description

balanceSimilarNodeGroups

boolean

BalanceSimilarNodeGroups enables/disables the --balance-similar-node-groups cluster-autocaler 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.

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

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

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

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 gigabytes 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

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

Property Type Description

max

integer

min

integer

type

string
.spec.resourceLimits.memory
Description

Minimum and maximum number of gigabytes of memory in cluster, in the format <min>:<max>. Cluster autoscaler will not scale the cluster beyond these numbers.

Type

object

Required

  • max

  • min

Property Type Description

max

integer

min

integer
.spec.scaleDown
Description

Configuration of scale down operation

Type

object

Required

  • enabled

Property Type Description

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
.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

Table 1. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete collection of ClusterAutoscaler

Table 2. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 3. HTTP responses
HTTP code Reponse body

200 - OK

Status_v2 meta/v1
HTTP method

GET

Description

list objects of kind ClusterAutoscaler

Table 4. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscalerList autoscaling.openshift.io/v1
HTTP method

POST

Description

create a ClusterAutoscaler

Table 6. Query parameters
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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 7. Body parameters
Parameter Type Description

body

ClusterAutoscaler autoscaling.openshift.io/v1
Table 8. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1

/apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}

Table 9. Global path parameters
Parameter Type Description

name

string

name of the ClusterAutoscaler
Table 10. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete a ClusterAutoscaler

Table 11. Query parameters
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

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
Table 12. Body parameters
Parameter Type Description

body

DeleteOptions_v2 meta/v1
Table 13. HTTP responses
HTTP code Reponse body

200 - OK

Status_v2 meta/v1
HTTP method

GET

Description

read the specified ClusterAutoscaler

Table 14. Query parameters
Parameter Type Description

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1
HTTP method

PATCH

Description

partially update the specified ClusterAutoscaler

Table 16. Query parameters
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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 17. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1
HTTP method

PUT

Description

replace the specified ClusterAutoscaler

Table 19. Query parameters
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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 20. Body parameters
Parameter Type Description

body

ClusterAutoscaler autoscaling.openshift.io/v1
Table 21. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1

/apis/autoscaling.openshift.io/v1/clusterautoscalers/{name}/status

Table 22. Global path parameters
Parameter Type Description

name

string

name of the ClusterAutoscaler
Table 23. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

GET

Description

read status of the specified ClusterAutoscaler

Table 24. Query parameters
Parameter Type Description

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
Table 25. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1
HTTP method

PATCH

Description

partially update status of the specified ClusterAutoscaler

Table 26. Query parameters
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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 27. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 28. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1
HTTP method

PUT

Description

replace status of the specified ClusterAutoscaler

Table 29. Query parameters
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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 30. Body parameters
Parameter Type Description

body

ClusterAutoscaler autoscaling.openshift.io/v1
Table 31. HTTP responses
HTTP code Reponse body

200 - OK

ClusterAutoscaler autoscaling.openshift.io/v1