autoscaler/cluster-autoscaler
Krzysztof Jastrzebski 6944f3fc56 Delete zero values from deletionsInProgress map in NodeDeletionTracker. 2019-05-28 14:34:56 +02:00
..
Godeps Revert vendoring extra gophercloud packages 2019-04-23 17:19:53 +02:00
_override/github.com/Azure Godeps update of google.golang.org/api 2019-03-22 18:32:53 +01:00
cloudprovider docs: more improvements to CA on Azure README 2019-05-22 10:26:45 -06:00
clusterstate Revert "Use cloudProvider.GetInstanceID() to get unregistered nodes" 2019-03-08 10:47:26 +08:00
config Implement functionality which delays node deletion when node has 2019-05-17 16:06:17 +02:00
context Define ProcessorCallbacks interface 2019-04-15 16:59:13 +02:00
core Delete zero values from deletionsInProgress map in NodeDeletionTracker. 2019-05-28 14:34:56 +02:00
estimator Move schedulercache to package nodeinfo 2019-02-21 12:41:08 +08:00
expander Implement functionality which delays node deletion when node has 2019-05-17 16:06:17 +02:00
metrics Tainting unneeded nodes as PreferNoSchedule 2019-01-21 13:06:50 +01:00
processors Add methods for passing arbitrary object via autoscaling context 2019-05-17 16:38:12 +02:00
proposals Move schedulercache to package nodeinfo 2019-02-21 12:41:08 +08:00
simulator Move static scheduler initialization out of module init() 2019-05-23 00:17:57 +02:00
utils Merge pull request #2046 from krzysztof-jastrzebski/master 2019-05-28 01:55:53 -07:00
vendor Revert vendoring extra gophercloud packages 2019-04-23 17:19:53 +02:00
version Move CA version to own package 2019-05-06 11:30:08 +02:00
.gitignore priority expander 2019-03-22 10:43:20 +01:00
Dockerfile Use debian-base-amd64:v1.0.0 2019-03-26 10:19:27 +01:00
FAQ.md CA FAQs - Clarify error situations support 2019-04-22 17:07:15 +01:00
Makefile Enable race detection in CA test-in-docker make target 2019-04-12 11:38:40 +02:00
OWNERS Add krzysztof-jastrzebski to cluster-autoscaler OWNERS 2019-05-16 16:37:39 +02:00
README.md Fix markdown format error 2019-05-10 18:59:08 +08:00
cloudbuild.yaml Add GCB config for cluster-autoscaler 2018-02-15 16:03:35 -08:00
fix_gopath.sh Bug with with globbing 2019-04-08 10:18:41 +10:00
kubernetes.sync Update godeps based on k8s.io/kubernetes:release-1.14 2019-03-07 21:37:57 +01:00
main.go Implement functionality which delays node deletion when node has 2019-05-17 16:06:17 +02:00
main_test.go Fix error format strings according to best practices from CodeReviewComments 2019-01-11 09:10:31 +13:00
push_image.sh Pushes go to staging-k8s.gcr.io 2018-01-17 14:16:38 -08:00
run.sh Cluster-Autoscaler: added wrapper script to pass signals 2017-02-28 17:39:29 +01:00
update_toc.py Fix update_toc.py script to stop appending empty lines 2017-06-30 14:18:18 +02: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 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.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.

Notable changes

For CA 1.1.2 and later, please check release notes.

CA version 1.1.1:

  • Fixes around metrics in the multi-master 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 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: