AutoScale Configuration (Docker Agent Pool)

This section covers the AutoScale configuration for Pools of type “Docker Agent”.

../../_images/create_autoscale_agent.webp

Create Autoscale Agent

AutoScale Settings for Agent Pool

  • Configure the following settings in your Kasm deployment.

General AutoScaling Settings

Name

Description

Enabled

Whether to enable this config or not.

Name

Name for the AutoScale config .

AutoScale Type

The type of AutoScale confog this is, either a Docker Agent or a Server.

Pool

Which pool this AutoScale config is attached to.

Aggressive Scaling

When enabled, the system may take more expedient measures to provision raw compute resources for on-demand session requests.

See Aggressive Scaling for more details.

Deployment Zone

Which zone this AutoScale config applies to.

Downscale Backoff (Seconds)

This setting prevents prevents the system from downscaling (deleting Agents) for this amount of time (in seconds) when needed. This is useful for preventing the system from thrashing up and down if the available resource hover around an interval that would typically trigger autoscaling.

Standby Cores

The number of standby cores that the system should try to keep “always available” at any given time in addition to any that is needed to satisfy the Staging Config requirements. If the number of available cores falls below this number, more Agents are created. If the number of available cores rises above this number, Agents are deleted as long as it wont result in the number of available cores falling below this number. A value of 0 indicates no additional standby compute is created. The AutoScaler will only provision enough compute according to the Staging Config requirements.

Standby GPUs

The number of standby GPUs that the system should try to keep “always available” at any given time in addition to any that is needed to satisfy the Staging Config requirements. If the number of available GPUs falls below this number, more Agents are created. If the number of available GPUs rises above this number, Agents are deleted as long as it wont result in the number of available GPUs falling below this number. A value of 0 indicates no additional standby compute is created. The AutoScaler will only provision enough compute according to the Staging Config requirements.

Standby Memory (GiB)

The amount of memory (in GiB) that the system should try to keep “always available” at any given time in addition to any that is needed to satisfy the Staging Config requirements. If the amount of available memory falls below this number, more Agents are created. If the amount of available memory rises above this number, Agents are deleted as long as it wont result in available amount falling below this number. A value of 0 indicates no additional standby compute is created. The AutoScaler will only provision enough compute according to the Staging Config requirements.

Agent Cores Override

When an Agent is created, the compute resource (e.g AWS EC2 / Digital Ocean Droplet) will have a set amount of CPU and Ram as defined by the cloud provider’s instance type. This setting should typically be set to match the instance type but can be set to a preferred value.

Agent GPUs Override

When an Agent is created, the compute resource (e.g AWS EC2 / Digital Ocean Droplet) will have a set number of GPUs as defined by the cloud provider’s instance type. This setting should typically be set to match the instance type but can be set to a higher number to allow oversubscribing.

Agent Memory Override (GiB)

When an Agent is created, the compute resource (e.g AWS EC2 / Digital Ocean Droplet) will have a set amount of CPU and Ram as defined by the cloud provider’s instance type. This setting should typically be set to match the instance type but can be set to a preferred value.

NGINX Cert

The PEM encoded SSL certificate to use for the kasm_proxy role on the created Agents. This cert should be a wildcard for the Base Domain Name (e.g *.agents.kasm.example.com)

NGINX Key

The PEM encoded SSL Key to use for the kasm_proxy role on the created Agents.

Register DNS

If enabled, the Agent’s IP will be registered in DNS.

Base Domain Name

Define a base name for the automatic DNS registration for the Agent. The system will create a full name using <ID>.<Base Domain Name>. If the Base Domain Name is “agents.kasm.example.com”, the full DNS name generated will be <ID>.agents.kasm.example.com (e.g 123abcd.agents.kasm.example.com). This Base Domain Name, must already be a registered DNS zone within the cloud provider’s DNS system.

Pre-load Workspace Images on Agents

Pre-loading workspace images on your provisioned agents helps eliminate delays caused by image downloads after the VMs are brought online. Follow the Pre-load Workspace Images on Agents guide to learn how to fetch workspace images using the Kasm API and bake them into your VM templates for faster and more efficient autoscaling.

Provider Specific Settings

Kasm supports AutoScaling on a variety of providers. Each provider has unique configurations that must be set up correctly for optimal performance. Select your provider to learn more: