Skip to content
This repository has been archived by the owner on Jan 11, 2023. It is now read-only.

Clarified that autoscaler addon only supports first agentPool #2990

Merged
merged 1 commit into from
May 16, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions examples/addons/cluster-autoscaler/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Cluster Autoscaler (VMSS) Add-on

Cluster Autoscaler is a tool that automatically adjusts the size of the Kubernetes cluster when:
[Cluster Autoscaler](https://github.com/kubernetes/autoscaler) is a tool that automatically adjusts the size of the Kubernetes cluster when:

* there are pods that failed to run in the cluster due to insufficient resources.
* some nodes in the cluster are so underutilized, for an extended period of time, that they can be deleted and their pods will be easily placed on some other, existing nodes.

This is the Kubernetes Cluster Autoscaler add-on for Virtual Machine Scale Sets. Add this add-on to your json file as shown below to automatically enable cluster autoscaler in your new Kubernetes cluster.

To use this add-on, make sure your cluster's Kubernetes version is 1.10 or above, and agent pool `availabilityProfile` is set to `VirtualMachineScaleSets`. This will automatically enable first agent pool to autoscale from 1 to 5 nodes by default. You can override these settings in `config` section of the `cluster-autoscaler` add-on.
To use this add-on, make sure your cluster's Kubernetes version is 1.10 or above and your agent pool `availabilityProfile` is set to `VirtualMachineScaleSets`. By default, the first agent pool will autoscale the node count between 1 and 5. You can override these settings in `config` section of the `cluster-autoscaler` add-on.

```
> At this time, only the primaryScaleSet (the first agent pool) is monitored by the autoscaler. To configure autoscale to monitor (and scale) other node pools, you must manually edit the autoscaler YAML at `/etc/kubernetes/addons` on each master node. See the [cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/azure/README.md) docs for guidance.

The following is an example:

```json
{
"apiVersion": "vlabs",
"properties": {
Expand Down Expand Up @@ -69,8 +73,8 @@ Follow the README at https://github.com/kubernetes/autoscaler/tree/master/cluste

| Name | Required | Description | Default Value |
| -------------- | -------- | --------------------------------- | ---------------------------------------------------------- |
| minNodes | no | minimum node count | |
| maxNodes | no | maximum node count | |
| minNodes | no | minimum node count | 1 |
| maxNodes | no | maximum node count | 5 |
| name | no | container name | "cluster-autoscaler" |
| image | no | image | "gcrio.azureedge.net/google-containers/cluster-autoscaler" |
| cpuRequests | no | cpu requests for the container | "100m" |
Expand All @@ -80,4 +84,4 @@ Follow the README at https://github.com/kubernetes/autoscaler/tree/master/cluste

## Supported Orchestrators

Kubernetes
* Kubernetes