autoscaler/cluster-autoscaler
Artur Żyliński 2b1f29d0c0 Cleanup: Remove deprecated github.com/golang/protobuf usage
- Regenerate cloudprovider/externalgrpc proto
- go mod tidy
2023-11-09 09:28:25 +01:00
..
cloudprovider Cleanup: Remove deprecated github.com/golang/protobuf usage 2023-11-09 09:28:25 +01:00
clusterstate Fix klog formating directives in cluster-autoscaler package. 2023-11-07 16:13:57 +01:00
config Rename variables & methods to StartupTaint... instead of IgnoreTaint 2023-09-26 13:54:52 +00:00
context Use informer factory to reuse listers 2023-09-15 13:57:15 +00:00
core Fix klog formating directives in cluster-autoscaler package. 2023-11-07 16:13:57 +01:00
debuggingsnapshot Fix klog formating directives in cluster-autoscaler package. 2023-11-07 16:13:57 +01:00
estimator Fix klog formating directives in cluster-autoscaler package. 2023-11-07 16:13:57 +01:00
expander Fix klog formating directives in cluster-autoscaler package. 2023-11-07 16:13:57 +01:00
hack Address comments from #6104 2023-09-20 05:11:38 -07:00
metrics Reports node taints. 2023-10-20 13:47:51 +00:00
processors Extend BinpackingLimiter interface 2023-10-06 13:53:33 +00:00
proposals Add information about provisioning-class-name annotation. 2023-10-17 01:43:54 -07:00
provisioningrequest Address comments from #6104 2023-09-20 05:11:38 -07:00
simulator Change scheduler framework function names after recent refactor in 2023-11-07 16:26:58 +01:00
utils Reports node taints. 2023-10-20 13:47:51 +00:00
vendor Update kubernetes dependencies to 1.29.0-alpha.3. 2023-11-07 16:25:05 +01:00
version CA - Update k/k vendoring to 1.28.0 2023-08-28 13:51:06 +01:00
.gitignore CA - Git ignore s390x arch binaries 2023-08-24 13:50:13 +01:00
Dockerfile.amd64 feat: use non-root user for base-image 2022-03-11 23:24:18 +01:00
Dockerfile.arm64 feat: use non-root user for base-image 2022-03-11 23:24:18 +01:00
Dockerfile.s390x s390x image support 2023-08-09 11:24:05 +05:30
FAQ.md Merge pull request #6218 from piotrwrotniak/adddocs 2023-10-24 11:55:20 +02:00
Makefile Add scripts go generate client for ProvReq and manifest. 2023-09-13 02:24:42 -07:00
OWNERS Add BigDarkClown to Cluster Autoscaler approvers 2023-06-30 09:49:53 +00:00
README.md CA - Add 1.28 to version compatibility matrix 2023-08-31 18:08:08 +01:00
cloudbuild.yaml Switched from N1 to E2 machine 2023-03-31 11:16:14 +05:30
go.mod Cleanup: Remove deprecated github.com/golang/protobuf usage 2023-11-09 09:28:25 +01:00
go.sum Update kubernetes dependencies to 1.29.0-alpha.3. 2023-11-07 16:25:05 +01:00
main.go Initialize default drainability rules 2023-10-19 15:55:34 +00:00
main_test.go
push_image.sh CA - Push Image script - Support newer docker versions 2022-06-14 17:03:50 +01:00
update_toc.py Migrate CA off python2 to python3 2022-03-14 12:52:32 +00:00

README.md

Cluster Autoscaler

Introduction

Cluster Autoscaler is a tool that automatically adjusts the size of the Kubernetes cluster when one of the following conditions is true:

  • there are pods that failed to run in the cluster due to insufficient resources.
  • there are nodes in the cluster that have been underutilized for an extended period of time and their pods can be placed on other existing nodes.

FAQ/Documentation

An FAQ is available HERE.

You should also take a look at the notes and "gotchas" for your specific cloud provider:

Releases

We recommend using Cluster Autoscaler with the Kubernetes control plane (previously referred to as master) version for which it was meant. The below combinations have been tested on GCP. We don't do cross version testing or compatibility testing in other environments. Some user reports indicate successful use of a newer version of Cluster Autoscaler with older clusters, however, there is always a chance that it won't work as expected.

Starting from Kubernetes 1.12, versioning scheme was changed to match Kubernetes minor releases exactly.

Kubernetes Version CA Version
1.28.X 1.28.X
1.27.X 1.27.X
1.26.X 1.26.X
1.25.X 1.25.X
1.24.X 1.24.X
1.23.X 1.23.X
1.22.X 1.22.X
1.21.X 1.21.X
1.20.X 1.20.X
1.19.X 1.19.X
1.18.X 1.18.X
1.17.X 1.17.X
1.16.X 1.16.X
1.15.X 1.15.X
1.14.X 1.14.X
1.13.X 1.13.X
1.12.X 1.12.X
1.11.X 1.3.X
1.10.X 1.2.X
1.9.X 1.1.X
1.8.X 1.0.X
1.7.X 0.6.X
1.6.X 0.5.X, 0.6.X*
1.5.X 0.4.X
1.4.X 0.3.X

*Cluster Autoscaler 0.5.X is the official version shipped with k8s 1.6. We've done some basic tests using k8s 1.6 / CA 0.6 and we're not aware of any problems with this setup. However, Cluster Autoscaler internally simulates Kubernetes' scheduler and using different versions of scheduler code can lead to subtle issues.

Patch releases

Cluster Autoscaler releases patches for versions corresponding to currently supported Kubernetes versions on a roughly 2 month cadence. Currently planned schedule is below. Please note that target dates listed below are approximate and we expect up to a week difference between target ETA and the actual releases.

Date Maintainer Preparing Release Backup Maintainer
2023-03-15 MaciekPytel gjtempleton
2023-05-17 gjtempleton BigDarkClown
2023-07-19 BigDarkClown towca
2023-09-13 towca x13n
2023-11-15 x13n MaciekPytel
2024-01-17 MaciekPytel gjtempleton

Additional patch releases may happen outside of the schedule in case of critical bugs or vulnerabilities.

Notable changes

For CA 1.1.2 and later, please check release notes.

CA version 1.1.1:

  • Fixes around metrics in the multiple kube apiserver configuration.
  • Fixes for unready nodes issues when quota is overrun.

CA version 1.1.0:

CA version 1.0.3:

  • Adds support for safe-to-evict annotation on pod. Pods with this annotation can be evicted even if they don't meet other requirements for it.
  • Fixes an issue when too many nodes with GPUs could be added during scale-up (https://github.com/kubernetes/kubernetes/issues/54959).

CA Version 1.0.2:

CA Version 1.0.1:

CA Version 1.0:

With this release we graduated Cluster Autoscaler to GA.

  • Support for 1000 nodes running 30 pods each. See: Scalability testing report
  • Support for 10 min graceful termination.
  • Improved eventing and monitoring.
  • Node allocatable support.
  • Removed Azure support. See: PR removing support with reasoning behind this decision
  • cluster-autoscaler.kubernetes.io/scale-down-disabled annotation for marking nodes that should not be scaled down.
  • scale-down-delay-after-delete and scale-down-delay-after-failure flags replaced scale-down-trial-interval

CA Version 0.6:

CA Version 0.5.4:

  • Fixes problems with node drain when pods are ignoring SIGTERM.

CA Version 0.5.3:

CA Version 0.5.2:

CA Version 0.5.1:

CA Version 0.5:

  • CA continues to operate even if some nodes are unready and is able to scale-down them.
  • CA exports its status to kube-system/cluster-autoscaler-status config map.
  • CA respects PodDisruptionBudgets.
  • Azure support.
  • Alpha support for dynamic config changes.
  • Multiple expanders to decide which node group to scale up.

CA Version 0.4:

  • Bulk empty node deletions.
  • Better scale-up estimator based on binpacking.
  • Improved logging.

CA Version 0.3:

  • AWS support.
  • Performance improvements around scale down.

Deployment

Cluster Autoscaler is designed to run on Kubernetes control plane (previously referred to as master) node. This is the default deployment strategy on GCP. It is possible to run a customized deployment of Cluster Autoscaler on worker nodes, but extra care needs to be taken to ensure that Cluster Autoscaler remains up and running. Users can put it into kube-system namespace (Cluster Autoscaler doesn't scale down node with non-mirrored kube-system pods running on them) and set a priorityClassName: system-cluster-critical property on your pod spec (to prevent your pod from being evicted).

Supported cloud providers: