×

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

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

utilizationThreshold

string

Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered 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.

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