Workload autoscaling

Workload autoscaling lets Instabase autoscale data services based on demand. Autoscaling optimizes service resources to maximize efficiency and performance for any workload at a given time. Workload autoscaling also removes the need to manually size services and presents cost saving opportunities.

Autoscaling is performed with Kubernetes HorizontalPodAutoscalers (HPAs) based on CPU usage for conversion-service, ocr-msft-lite, ocr-msft-v3, and ocr-service.

Enable workload autoscaling

You can enable workload autoscaling during or after an upgrade or installation.

Enable autoscaling during an upgrade

To enable autoscaling during an upgrade:

1. Before upgrading, edit the control-plane.yml file in the release you’re upgrading to and enable the ENABLE_AUTOSCALING and IS_CUSTOMER_HOSTED_AUTOSCALING environment variables:

   1. Unzip the installation.zip file for the release you’re upgrading to.

   2. On the command line, navigate to and open the control-plane.yml file (installation/control-plane/control-plane.yml).

   3. Change the value of the ENABLE_AUTOSCALING environment variable to True.

   4. Change the value of the IS_CUSTOMER_HOSTED_AUTOSCALING environment variable to True.

   5. Save your changes. You apply this updated control-plane.yml file when updating Deployment Manager at the start of the upgrade or installation process.

2. Add the base configurations that enable autoscaling to the release’s base_configs.zip file:

   1. Unzip the base_configs.zip file contained within the release’s installation folder.

   2. Locate the autoscaling folder in the installation folder (installation > additional_configs > autoscaling).

   3. Move the config files in the autoscaling folder to the unzipped base_configs folder.

   4. Select all files in the base_configs folder and compress them, creating a new .zip file of base configs.

   5. Rename the file base_configs.zip. This updated .zip file is what you upload during the upgrade.

3. (Optional) If your deployment uses custom resourcing sizing or if you didn’t select a resource sizing option during the upgrade, create patches that define the minReplicas and maxReplicas values for each autoscaled service’s corresponding HPA service. For example, a patch targeting autoscaler-conversion-service sets the autoscaling range for conversion-service. The required steps are:

   1. Calculate the minReplicas values for all autoscaled services’ corresponding HPA services.

   2. In the release’s installation file, locate the custom-hpa-patches folder (installation > optional_patches > custom-hpa-patches). This folder contains patches to configure minReplicas and maxReplicas values for each HPA service. Or, reference the sample patch in this article.

   3. Edit each HPA service patch to define the minReplicas and maxReplicas values. Use your calculated minReplicas values and define the maxReplicas values based on your preferred resourcing sizing.

4. Update the default_patches.zip file to include the following patches:

   • All patches contained in the enable-autoscaling folder (installation > optional_patches > enable-autoscaling).

   • (Optional) If using custom or undefined resource sizing, any patches used to manually define an HPA service’s minReplicas and maxReplicas values.

   To update the default_patches.zip file

   1. Unzip the default_patches.zip file contained within the release’s installation folder.

   2. Add the enable-autoscaling patches (and optional edited HPA service patches) to the now unzipped default_patches folder.

   3. Select all files in the default_patches folder and compress them, creating a new .zip file of patches.

   4. Rename the file default_patches.zip. This updated .zip file is what you upload during the upgrade.

5. During the upgrade, upload the updated base_configs.zip file and the default_patches.zip file. The default_patches.zip and base_configs.zip files contain all patches and configurations required to configure autoscaling in your deployment.

   Info

   You must upload the default_patches.zip file during the upgrade even if you didn’t add custom patches to it.

Enable autoscaling during an installation

Follow the same steps as enabling autoscaling during an upgrade. However, if your deployment uses custom resourcing sizing, you don’t need to create patches that define the minReplicas and maxReplicas values for each autoscaled service’s corresponding HPA service.

Enable autoscaling outside of an upgrade or installation

If your deployment is already on release 23.07 or later, you can enable autoscaling at any time:

1. Enable the ENABLE_AUTOSCALING environment variable:

   1. On the command line, run the following command: kubectl edit deployment/deployment-control-plane -n $IB_NS, where $IB_NS is your Instabase namespace.

   2. Locate the ENABLE_AUTOSCALING environment variable.

   3. Set the value to True.

   4. Save your changes.

2. Enable the IS_CUSTOMER_HOSTED_AUTOSCALING environment variable:

   1. On the command line, run the following command: kubectl edit deployment/deployment-control-plane -n $IB_NS, where $IB_NS is your Instabase namespace.

   2. Locate the IS_CUSTOMER_HOSTED_AUTOSCALING environment variable.

   3. Set the value to True.

   4. Save your changes.

3. From the Deployment Manager Base Configs tab, update your deployment’s base configs to include the base configs required for workload autoscaling. (If you already included the workload autoscaling base configs when upgrading or installing, you can skip this step.)

   1. Unzip the base_configs.zip file contained within the release’s installation folder.

   2. Locate the autoscaling folder in the installation folder (installation > additional_configs > autoscaling).

   3. Move the config files in the autoscaling folder to the now unzipped base_configs folder.

   4. Select all files in the base_configs folder and compress them, creating a new .zip file of base configs.

   5. Rename the file base_configs.zip.

   6. From the Deployment Manager Base Configs tab, update your base configs.

4. From the Deployment Manager Configs tab, apply the patches required to enable workload autoscaling. All required patches are in the release’s enable_autoscaling patches folder (installation > optional_patches > enable-autoscaling).

# This patch will associate the HPA with the deployment allowing the HPA to autoscale the deployment's replica count

 # target: <name of HPA service>

 apiVersion: autoscaling/v2beta2
 kind: HorizontalPodAutoscaler
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Deployment
     name: <name of deployment service>

You can verify that all HPAs are working and have the desired minReplicas and maxReplicas values from the HPAs tab of the Infra Dashboard. If needed, you can adjust the minimum and maximum replica count.

Configure workload autoscaling

For deployments using Instabase standard resourcing sizing, Deployment Manager automatically determines and applies appropriate minReplicas and maxReplicas values for all autoscaled services. For deployments using custom resourcing sizing, however, you must set the minReplicas and maxReplicas values for the HPA services corresponding to the following autoscaled deployment services:

While the maxReplicas value can be set based on your preferred resourcing sizing, the minReplicas value must be calculated based on the number of celery-app-tasks pods in the deployment.

To adjust a service’s minReplicas and maxReplicas values, apply the following patch to each HPA service.

# target: <name of HPA service>
apiVersion: autoscaling/v2beta2
kind: HorizontalPodAutoscaler
spec:
  maxReplicas: <max replicas>
  minReplicas: <min replicas>

Calculate HPA minReplicas for autoscaled services

To calculate minReplicas for an HPA service, use the following formulas, where n is the number of celery-app-tasks pods in your deployment:

Disable autoscaling

You can disable autoscaling at any time. The process differs slightly based on whether your deployment uses custom resourcing sizing or standard Instabase resourcing sizing.

Deployments with standard resourcing sizing

To disable autoscaling in deployments using standard Instabase resourcing sizing:

1. Disable the ENABLE_AUTOSCALING environment variable:

   1. On the command line, run the following command: kubectl edit deployment/deployment-control-plane -n $IB_NS, where $IB_NS is your Instabase namespace.

   2. Locate the ENABLE_AUTOSCALING environment variable.

   3. Set the value to False.

   4. Save your changes.

2. Call the Push latest materialized configs to cluster API to redeploy the deployment with autoscaling disabled.

3. Call the Update cluster size API to reset your resourcing sizing.

4. From the Deployment Manager Configs tab, apply the patches required to disable workload autoscaling. All required patches are in the release’s disable_autoscaling patches folder (installation > optional_patches > disable-autoscaling). These patches dissociate each previously autoscaled service from its corresponding HPA.

 # This patch will disassociate the HPA with the deployment stopping the HPA from autoscaling the deployment's replica count

 # target: <name of HPA service>

 apiVersion: autoscaling/v2beta2
 kind: HorizontalPodAutoscaler
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Deployment
     name: disassociated

Deployments with custom resourcing sizing

To disable autoscaling in deployments using custom resourcing sizing:

1. Disable the ENABLE_AUTOSCALING environment variable:

   1. On the command line, run the following command: kubectl edit deployment/deployment-control-plane -n $IB_NS

   2. Locate the ENABLE_AUTOSCALING environment variable.

   3. Set the value to False.

   4. Save your changes.

2. Call the Push latest materialized configs to cluster API to redeploy the deployment with autoscaling disabled.

3. From the Deployment Manager Configs tab, apply the patches required to disable workload autoscaling. All required patches are in the release’s disable_autoscaling patches folder (installation > optional_patches > disable-autoscaling). These patches dissociate each previously autoscaled service from its corresponding HPA.

 # This patch will disassociate the HPA with the deployment stopping the HPA from autoscaling the deployment's replica count

 # target: <name of HPA service>

 apiVersion: autoscaling/v2beta2
 kind: HorizontalPodAutoscaler
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Deployment
     name: disassociated

Verifying autoscaling configuration changes

You can verify that patches targeting HPAs have applied successfully using the HPAs tab of the Deployment Manager infra dashboard.

To confirm that an HPA’s replica count has updated successfully:

1. Open the Deployment Manager HPAs tab (All apps > Deployment Manager > Infra Dashboard > HPAs).

2. On the Horizontal Pod Autoscalers, select the updated HPA.

3. Confirm that the General Info section lists the correct Min Replicas and Max Replicas values.

To confirm that an HPA is active:

1. Open the Deployment Manager HPAs tab (All apps > Deployment Manager > Infra Dashboard > HPAs).

2. On the Horizontal Pod Autoscalers dashboard, select the updated HPA.

3. Verify that the Conditions table includes an AbleToScale condition. This condition means that CPU metrics are available and the HPA is active.