expose DOKS custom cluster-autoscaler expanders (#1705)

Author: d-honeybadger

args.go

@@ -128,6 +128,8 @@ const (
 	ArgClusterAutoscalerScaleDownUtilizationThreshold = "scale-down-utilization-threshold"
 	// ArgClusterAutoscalerScaleDownUnneededTime is the cluster autoscaler scale down unneeded time
 	ArgClusterAutoscalerScaleDownUnneededTime = "scale-down-unneeded-time"
+	// ArgClusterAutoscalerExpanders customizes the expanders used by the cluster autoscaler to scale up the cluster.
+	ArgClusterAutoscalerExpanders = "expanders"
 	// ArgEnableRoutingAgent enables the routing-agent cluster plugin.
 	ArgEnableRoutingAgent = "enable-routing-agent"
 	// ArgSurgeUpgrade is a cluster's surge-upgrade argument.

commands/displayers/kubernetes.go

@@ -50,6 +50,7 @@ func (clusters *KubernetesClusters) Cols() []string {
 		"NodePools",
 		"Autoscaler.UtilizationThreshold",
 		"Autoscaler.UnneededTime",
+		"Autoscaler.Expanders",
 		"RoutingAgent",
 	}
 }
@@ -84,6 +85,7 @@ func (clusters *KubernetesClusters) ColMap() map[string]string {
 		"NodePools":                       "Node Pools",
 		"Autoscaler.UtilizationThreshold": "Autoscaler Scale Down Utilization",
 		"Autoscaler.UnneededTime":         "Autoscaler Scale Down Unneeded Time",
+		"Autoscaler.Expanders":            "Autoscaler Custom Expanders",
 		"RoutingAgent":                    "Routing Agent",
 	}
 }
@@ -119,6 +121,7 @@ func (clusters *KubernetesClusters) KV() []map[string]any {
 			"NodePools":                       strings.Join(nodePools, " "),
 			"Autoscaler.UtilizationThreshold": "",
 			"Autoscaler.UnneededTime":         "",
+			"Autoscaler.Expanders":            "",
 			"RoutingAgent":                    cluster.RoutingAgent != nil && *cluster.RoutingAgent.Enabled,
 		}
 
@@ -129,6 +132,9 @@ func (clusters *KubernetesClusters) KV() []map[string]any {
 			if cluster.ClusterAutoscalerConfiguration.ScaleDownUnneededTime != nil {
 				o["Autoscaler.UnneededTime"] = *cfg.ScaleDownUnneededTime
 			}
+			if cluster.ClusterAutoscalerConfiguration.Expanders != nil {
+				o["Autoscaler.Expanders"] = strings.Join(cfg.Expanders, ", ")
+			}
 		}
 
 		out = append(out, o)

commands/kubernetes.go

@@ -295,6 +295,8 @@ After creating a cluster, a configuration context is added to kubectl and made a
 		"The threshold value for the cluster autoscaler's scale-down-utilization-threshold. It is the maximum value between the sum of CPU requests and sum of memory requests of all pods running on the node divided by node's corresponding allocatable resource, below which a node can be considered for scale down. To set the scale-down-utilization-threshold to 50%, pass the floating point value 0.5.")
 	AddStringFlag(cmdKubeClusterCreate, doctl.ArgClusterAutoscalerScaleDownUnneededTime, "", "",
 		"The unneed time for the cluster autoscaler's scale-down-unneeded-time. It defines how long a node should be unneeded before it is eligible for scale down. To set the scale-down-unneeded-time to a minute and 30 seconds for example, pass the string '1m30s'.")
+	AddStringSliceFlag(cmdKubeClusterCreate, doctl.ArgClusterAutoscalerExpanders, "", nil,
+		"Customizes expanders used by cluster-autoscaler. The autoscaler will apply each expander from the provided comma-separated list to narrow down the selection of node types created to scale up, until either a single node type is left, or the list of expanders is exhausted. Available expanders: random, least-waste, priority. If this flag is empty, autoscaler will use its default expanders.")
 	AddBoolFlag(cmdKubeClusterCreate, doctl.ArgEnableRoutingAgent, "", false,
 		"Creates the cluster with routing-agent enabled. Defaults to false. To enable routing-agent, supply --enable-routing-agent=true.")
 	AddStringSliceFlag(cmdKubeClusterCreate, doctl.ArgTag, "", nil,
@@ -351,6 +353,8 @@ Updates the configuration values for a Kubernetes cluster. The cluster must be r
 		"The threshold value for the cluster autoscaler's scale-down-utilization-threshold. It is the maximum value between the sum of CPU requests and sum of memory requests of all pods running on the node divided by node's corresponding allocatable resource, below which a node can be considered for scale down. To set the scale-down-utilization-threshold to 50%, pass the floating point value 0.5.")
 	AddStringFlag(cmdKubeClusterUpdate, doctl.ArgClusterAutoscalerScaleDownUnneededTime, "", "",
 		"The unneed time for the cluster autoscaler's scale-down-unneeded-time. It defines how long a node should be unneeded before it is eligible for scale down. To set the scale-down-unneeded-time to a minute and 30 seconds for example, pass the string '1m30s'.")
+	AddStringSliceFlag(cmdKubeClusterUpdate, doctl.ArgClusterAutoscalerExpanders, "", nil,
+		"Customizes expanders used by cluster-autoscaler. The autoscaler will apply each expander from the provided comma-separated list to narrow down the selection of node types created to scale up, until either a single node type is left, or the list of expanders is exhausted. Available expanders: random, least-waste, priority. If this value is empty, autoscaler will use its default expanders. To unset expander customization, pass an empty string.")
 	AddStringSliceFlag(cmdKubeClusterUpdate, doctl.ArgControlPlaneFirewallAllowedAddresses, "", nil,
 		"A comma-separated list of allowed addresses that can access the control plane.")
 	AddBoolFlag(cmdKubeClusterUpdate, doctl.ArgClusterUpdateKubeconfig, "",
@@ -1733,7 +1737,15 @@ func buildClusterCreateRequestFromArgs(c *CmdConfig, r *godo.KubernetesClusterCr
 		clusterAutoscalerConfiguration.ScaleDownUnneededTime = &unneededTime
 	}
 
-	if thresholdStr != "" || unneededTime != "" {
+	expanders, expandersAreSet, err := c.Doit.GetStringSliceIsFlagSet(c.NS, doctl.ArgClusterAutoscalerExpanders)
+	if err != nil {
+		return err
+	}
+	if expandersAreSet {
+		clusterAutoscalerConfiguration.Expanders = expanders
+	}
+
+	if thresholdStr != "" || unneededTime != "" || expandersAreSet {
 		r.ClusterAutoscalerConfiguration = clusterAutoscalerConfiguration
 	}
 
@@ -1882,7 +1894,15 @@ func buildClusterUpdateRequestFromArgs(c *CmdConfig, r *godo.KubernetesClusterUp
 		clusterAutoscalerConfiguration.ScaleDownUnneededTime = &unneededTime
 	}
 
-	if thresholdStr != "" || unneededTime != "" {
+	expanders, expandersAreSet, err := c.Doit.GetStringSliceIsFlagSet(c.NS, doctl.ArgClusterAutoscalerExpanders)
+	if err != nil {
+		return err
+	}
+	if expandersAreSet {
+		clusterAutoscalerConfiguration.Expanders = expanders
+	}
+
+	if thresholdStr != "" || unneededTime != "" || expandersAreSet {
 		r.ClusterAutoscalerConfiguration = clusterAutoscalerConfiguration
 	}
 

integration/kubernetes_clusters_get_test.go

@@ -106,7 +106,8 @@ var (
 		},
 		"cluster_autoscaler_configuration": {
     		"scale_down_utilization_threshold": 0.5,
-    		"scale_down_unneeded_time": "1m30s"
+    		"scale_down_unneeded_time": "1m30s",
+			"expanders": ["priority", "random"]
     	},
 		"created_at": "2018-11-15T16:00:11Z",
 		"updated_at": "2018-11-15T16:00:11Z"
@@ -115,7 +116,8 @@ var (
 }
 `
 
-	k8sGetOutput = `ID                 Name               Region    Version              Auto Upgrade    HA Control Plane    Status     Endpoint    IPv4    Cluster Subnet    Service Subnet    Tags          Created At                       Updated At                       Node Pools       Autoscaler Scale Down Utilization    Autoscaler Scale Down Unneeded Time    Routing Agent
-some-cluster-id    some-cluster-id    nyc3      some-kube-version    true            false               running                                                            production    2018-11-15 16:00:11 +0000 UTC    2018-11-15 16:00:11 +0000 UTC    frontend-pool    50%                                  1m30s                                  false
+	k8sGetOutput = `
+ID                 Name               Region    Version              Auto Upgrade    HA Control Plane    Status     Endpoint    IPv4    Cluster Subnet    Service Subnet    Tags          Created At                       Updated At                       Node Pools       Autoscaler Scale Down Utilization    Autoscaler Scale Down Unneeded Time    Autoscaler Custom Expanders    Routing Agent
+some-cluster-id    some-cluster-id    nyc3      some-kube-version    true            false               running                                                            production    2018-11-15 16:00:11 +0000 UTC    2018-11-15 16:00:11 +0000 UTC    frontend-pool    50%                                  1m30s                                  priority, random               false
 `
 )

integration/projects_resources_get_test.go

@@ -343,8 +343,8 @@ ID                                      Name       Size      Region    Filesyste
 }
 `
 	projectsResourcesGetKubernetesOutput = `
-ID    Name    Region    Version    Auto Upgrade    HA Control Plane    Status          Endpoint    IPv4    Cluster Subnet    Service Subnet    Tags    Created At                       Updated At                       Node Pools    Autoscaler Scale Down Utilization    Autoscaler Scale Down Unneeded Time    Routing Agent
-      1111                         false           false               provisioning                                                            k8s     2021-01-29 16:02:02 +0000 UTC    0001-01-01 00:00:00 +0000 UTC    pool-test                                                                                 false
+ID    Name    Region    Version    Auto Upgrade    HA Control Plane    Status          Endpoint    IPv4    Cluster Subnet    Service Subnet    Tags    Created At                       Updated At                       Node Pools    Autoscaler Scale Down Utilization    Autoscaler Scale Down Unneeded Time    Autoscaler Custom Expanders    Routing Agent
+      1111                         false           false               provisioning                                                            k8s     2021-01-29 16:02:02 +0000 UTC    0001-01-01 00:00:00 +0000 UTC    pool-test                                                                                                                false
 `
 
 	projectsResourcesListKubernetesOutput = `