Chapter 5. Configure autoscaling

Procedure

1. Create an HPA resource for a deployment, specifying the target metrics and desired replica count.

   apiVersion: autoscaling/v2
   kind: HorizontalPodAutoscaler
   metadata:
     name: scaler
     namespace: openshift-devspaces
   spec:
     scaleTargetRef:
       apiVersion: apps/v1
       kind: Deployment
       name: <deployment_name>
     ...

   where:

   <deployment_name>

   One of the following deployments:

   • devspaces
   • che-gateway
   • devspaces-dashboard
   • plugin-registry

   • devfile-registry

     For example:

     apiVersion: autoscaling/v2
     kind: HorizontalPodAutoscaler
     metadata:
       name: devspaces-scaler
       namespace: openshift-devspaces
     spec:
       scaleTargetRef:
         apiVersion: apps/v1
         kind: Deployment
         name: devspaces
       minReplicas: 2
       maxReplicas: 5
       metrics:
         - type: Resource
           resource:
             name: cpu
             target:
               type: Utilization
               averageUtilization: 75

     In this example, the HPA targets the devspaces deployment with a minimum of 2 replicas, a maximum of 5 replicas, and scales based on CPU utilization.

Procedure

1. Set the startup timeout and event handling in the CheCluster Custom Resource to handle autoscaler node additions:

   spec:
     devEnvironments:
       startTimeoutSeconds: 600
       ignoredUnrecoverableEvents:
         - FailedScheduling

   where:

   startTimeoutSeconds

   Set to at least 600 seconds to allow time for a new node to be provisioned during workspace startup.

   ignoredUnrecoverableEvents

   Ignore the FailedScheduling event to allow workspace startup to continue when a new node is provisioned. This setting is enabled by default.

2. Add the safe-to-evict annotation to the CheCluster Custom Resource to prevent workspace pod eviction when the autoscaler removes a node:

   spec:
     devEnvironments:
       workspacesPodAnnotations:
         cluster-autoscaler.kubernetes.io/safe-to-evict: "false"