constellation/docs/versioned_docs/version-2.2/workflows/scale.md
Fabian Kammel 2b64f31104
release docs for v2.2 (#482)
Signed-off-by: Fabian Kammel <fk@edgeless.systems>
2022-11-08 18:25:56 +01:00

3.7 KiB

Scale your cluster

Constellation provides all features of a Kubernetes cluster including scaling and autoscaling.

Worker node scaling

Autoscaling

Constellation comes with autoscaling disabled by default. To enable autoscaling, find the scaling group of worker nodes:

worker_group=$(kubectl get scalinggroups -o json | jq -r '.items[].metadata.name | select(contains("worker"))')
echo "The name of your worker scaling group is '$worker_group'"

Then, patch the autoscaling field of the scaling group resource to true:

kubectl patch scalinggroups $worker_group --patch '{"spec":{"autoscaling": true}}' --type='merge'
kubectl get scalinggroup $worker_group -o jsonpath='{.spec}' | jq

The cluster autoscaler now automatically provisions additional worker nodes so that all pods have a place to run. You can configure the minimum and maximum number of worker nodes in the scaling group by patching the min or max fields of the scaling group resource:

kubectl patch scalinggroups $worker_group --patch '{"spec":{"max": 5}}' --type='merge'
kubectl get scalinggroup $worker_group -o jsonpath='{.spec}' | jq

The cluster autoscaler will now never provision more than 5 worker nodes.

If you want to see the autoscaling in action, try to add a deployment with a lot of replicas, like the following Nginx deployment. The number of replicas needed to trigger the autoscaling depends on the size of and count of your worker nodes. Wait for the rollout of the deployment to finish and compare the number of worker nodes before and after the deployment:

kubectl create deployment nginx --image=nginx --replicas 150
kubectl -n kube-system get nodes
kubectl rollout status deployment nginx
kubectl -n kube-system get nodes

Manual scaling

Alternatively, you can manually scale your cluster up or down:

  1. Find your Constellation resource group.
  2. Select the scale-set-workers.
  3. Go to settings and scaling.
  4. Set the new instance count and save.
  1. In Compute Engine go to Instance Groups.
  2. Edit the worker instance group.
  3. Set the new number of instances and save.

:::caution

Scaling isn't yet implemented for AWS. If you require this feature, let us know!

:::

Control-plane node scaling

Control-plane nodes can only be scaled manually and only scaled up!

To increase the number of control-plane nodes, follow these steps:

  1. Find your Constellation resource group.
  2. Select the scale-set-controlplanes.
  3. Go to settings and scaling.
  4. Set the new (increased) instance count and save.
  1. In Compute Engine go to Instance Groups.
  2. Edit the control-plane instance group.
  3. Set the new (increased) number of instances and save.

:::caution

Scaling isn't yet implemented for AWS. If you require this feature, let us know!

:::

If you scale down the number of control-planes nodes, the removed nodes won't be able to exit the etcd cluster correctly. This will endanger the quorum that's required to run a stable Kubernetes control plane.