> [!WARNING]
>
> **Preview**
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

This page shows you how to autoscale your clusters. To learn about how the
cluster autoscaler works, refer to
[Cluster autoscaler](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/cluster-autoscaler).

Cluster autoscaling resizes the number of nodes in a given node pool based on
the demands of your workloads. You specify `minReplicas` and `maxReplicas`
values for each node pool in your cluster.

For an individual node pool, `minReplicas` must be ≥ 1. However, the sum
of the untainted user cluster nodes at any given time must be at least 3. This
means the sum of the `minReplicas` values for all autoscaled node pools, plus
the sum of the `replicas` values for all non-autoscaled node pools, must be at
least 3.

## Create a user cluster with autoscaling

To create a user cluster with autoscaling, add the `autoscaling` field to the `nodePools` section in the [user cluster configuration file](https://docs.cloud.google.com/anthos/clusters/docs/on-prem/1.8/how-to/user-cluster-configuration-file).

```
nodePools:
- name: pool‐1
  …
  replicas: 3
  ...
  autoscaling:
    minReplicas: 1
    maxReplicas: 5
```

This configuration creates a node pool with 3 replicas, and applies autoscaling with the minimum node pool size as 1 and the maximum node pool size as 5.

The `minReplicas` value must be ≥ 1.

## Add a node pool with autoscaling

To add a node pool with autoscaling to an existing cluster:

1. Edit the user cluster configuration file to add a new node pool, and include the `autoscaling` field. Adapt the values of `minReplicas` and `maxReplicas` as needed.

```
nodePools:
- name: my-new-node-pool
  …
  replicas: 3
  ...
  autoscaling:
    minReplicas: 1
    maxReplicas: 5
```

1. Run the `gkectl update cluster --config <var class="edit">USER_CLUSTER_CONFIG</var> --kubeconfig <var class="edit">ADMIN_CLUSTER_KUBECONFIG</var>` command.

## Enable an existing node pool for autoscaling

To enable autoscaling for a node pool in an existing cluster:

1. Edit a specific `nodePool` in the user cluster configuration file, and include the `autoscaling` field. Adapt the values of `minReplicas` and `maxReplicas` as needed.

   <br />

   ```
   nodePools:


   - name: my-existing-node-pool
     ...
     replicas: 3
     ...
     autoscaling:
     minReplicas: 1
     maxReplicas: 5

   ```
2. Run the `gkectl update cluster --config <var class="edit">USER_CLUSTER_CONFIG</var> --kubeconfig <var class="edit">ADMIN_CLUSTER_KUBECONFIG</var>` command.

> [!NOTE]
> **Note:** You cannot modify replicas for an existing node pool while adding autoscaling.

## Disable autoscaling for an existing node pool

To disable autoscaling for a specific node pool:

1. Edit the user cluster configuration file and remove the `autoscaling` field for that node pool.

2. Run the `gkectl update cluster` command.

## Check cluster autoscaler behavior

You can determine what the cluster autoscaler is doing in several ways.

### Check cluster autoscaler logs

First, find the name of the cluster autoscaler Pod. Run this command, replacing USER_CLUSTER_NAME with the user cluster name:

```
kubectl --kubeconfig ADMIN_CLUSTER_KUBECONFIG get pods -n USER_CLUSTER_NAMEvar> | grep cluster-autoscaler
```

To check logs on the cluster autoscaler Pod, replacing POD_NAME with the Pod name:

```
kubectl --kubeconfig ADMIN_KUBECONFIG logs cluster-autoscaler-POD_NAME --container cluster-autoscaler ADMIN_KUBECONFIG
```

### Check the configuration map

The cluster autoscaler publishes the kube-system/cluster-autoscaler-status configuration map. To see this map, run this command:

```
run kubectl --kubeconfig USER_KUBECONFIG get configmap cluster-autoscaler-status -n kube-system -o yaml
```

### Check cluster autoscale events.

You can check [cluster autoscale events](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-events-are-emitted-by-ca):

- On pods (particularly those that cannot be scheduled, or on underutilized nodes)
- On nodes
- On the kube-system/cluster-autoscaler-status config map.

## Troubleshooting

See the following troubleshooting information for cluster autoscaler:

- You might be experiencing one of the [limitations for cluster autoscaler](https://docs.cloud.google.com/kubernetes-engine/docs/concepts/cluster-autoscaler#limitations).
- If you are having problems with downscaling your cluster, see [Pod scheduling and disruption](https://docs.cloud.google.com/kubernetes-engine/docs/concepts/cluster-autoscaler#scheduling-and-disruption). You might have to add a `PodDisruptionBudget` for the `kube-system` Pods. For more information about manually adding a `PodDisruptionBudget` for the `kube-system` Pods, see the [Kubernetes cluster autoscaler FAQ](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-to-set-pdbs-to-enable-ca-to-move-kube-system-pods).
- When scaling down, cluster autoscaler respects scheduling and eviction rules set on Pods. These restrictions can prevent a node from being deleted by the autoscaler. A node's deletion could be prevented if it contains a Pod with any of these conditions:
  - The Pod's affinity or anti-affinity rules prevent rescheduling.
  - The Pod has local storage.
  - The Pod is not managed by a Controller such as a Deployment, StatefulSet, Job or ReplicaSet.

For more information about cluster autoscaler and preventing disruptions, see
the following questions in the [Kubernetes cluster autoscaler FAQ](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md):

- [How does scale-down work?](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-scale-down-work)
- [Does Cluster autoscaler work with PodDisruptionBudget in scale-down?](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#does-ca-work-with-poddisruptionbudget-in-scale-down)
- [What types of Pods can prevent Cluster autoscaler from removing a node?](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-types-of-pods-can-prevent-ca-from-removing-a-node)