Scale your Aiven service disks automatically preview

Discover the service disk autoscaler and its capabilities. Find out how it works and how to use it with your Aiven services.

Pricing

Costs of using disk autoscaler depend on your service type and plan. You’re only charged for additional storage space actually provisioned for your service. Costs of using disk autoscaler correspond to costs of using dynamic disk sizing (DDS), which you can check in Aiven Plans and Pricing.

Why use disk autoscaling

Service disk autoscaler increases disk storage capacity automatically when the disk is running out of space.

Note

Currently, service disk autoscaler doesn’t support scaling down.

• Disk autoscaling allows you to improve the cost-efficiency of operating your Aiven services: You can start with a regular-sized disk and only have it scaled up when needed with no risk of running out of disk space at any point.

• Disk autoscaling helps improve service resiliency eliminating the risk of a service becoming non-functional as a consequence of running out of disk space. Use disk autoscaling to make sure your service remains operational in case of unexpected high demand for disk space.

How it works

There are a few steps illustrating how disk autoscaler works:

1. You create a disk autoscaler integration endpoint in your Aiven project setting the maximum additional storage at the same time.

2. You enable a disk autoscaler integration for your service using the new disk autoscaler integration endpoint.

3. From that point onward, the evaluation of disk space availability for your service is done every 30 seconds.

4. When disk storage consumption reaches the threshold for a specific service, disk autoscaler increases available storage space by 10% every time taking the currently-used disk space as a baseline.

AUTOSCALE THRESHOLDS PER SERVICE TYPE

The threshold at which disk autoscaling is triggered is a percentage of the available disk storage capacity and depends on a service type:

• Aiven for Apache Cassandra®: 35% of the available disk storage capacity

• Aiven for OpenSearch®: 75% of the available disk storage capacity

• All the other Aiven service types: 85% of the available disk storage capacity

Prerequisites

• Aiven organization, project, and service up and running

• Dynamic disk sizing (DDS) supported for the service plan and the cloud hosting the service

• Role of the operator for your Aiven organization, project, and service

• Depending on what interface you’d like to use for interacting with disk autoscaler:

  • Access to Aiven Console

  • Aiven API

  • Aiven CLI client

Enable disk autoscaler

To enable disk autoscaling on your Aiven service, you need to create an autoscaler integration endpoint and enable autoscaler integration with your service using the new endpoint. You can set up disk autoscaling in Aiven Console, using Aiven API, or Aiven CLI client.

Enable in Aiven Console

Create an autoscaler endpoint

1. Log in to Aiven Console and navigate to a desired organization and project.

2. On the Services page of your project, select Integration endpoints from the sidebar.

3. On the Integration endpoints page, select Disk autoscaler > Add new endpoint.

4. In the Create new autoscaler endpoint window, enter an endpoint name, specify a maximum additional disk storage that you want to allow for disk autoscaling purposes, and select Create.

Enable on a service

1. Log in to Aiven Console and navigate to a desired organization, project, and service.

2. On the Overview page of your service, select Integrations from the sidebar.

3. On the Integrations page, navigate to External integrations and select Disk autoscaler.

4. In the Autoscaler integration window, select the newly-created autoscaler integration endpoint from the dropdown menu and select Enable.

Enable with Aiven API

To enable disk autoscaler on your service via Aiven API, call the ServiceIntegrationEndpointCreate endpoint on your project and, next, the ServiceIntegrationCreate endpoint to create an autoscaler integration on your service.

1. Call the ServiceIntegrationEndpointCreate endpoint on your project passing the following in the request body:

   • Endpoint name (path and request body parameters)

   • endpoint_type (request body): disk_storage

   • max_additional_storage (request body > user_config object)

   curl --request POST \
     --url https://api.aiven.io/v1/project/{project_name}/integration_endpoint \
     --header 'Authorization: Bearer REPLACE_WITH_YOUR_BEARER_TOKEN' \
     --header 'content-type: application/json' \
     --data
        '{
           "endpoint_name": "REPLACE_WITH_ENDPOINT_NAME",
           "endpoint_type": "disk_storage",
           "user_config": {
             "autoscaler": {
               "max_additional_storage": "REPLACE_WITH_DESIRED_VALUE_IN_GB"
             }
           }
         }'
   

2. Call the ServiceIntegrationCreate endpoint on your service passing the following in the request body:

   • dest_endpoint_id: ID of your new autoscaler integration endpoint

   • integration_type: autoscaler

   • source_project: the name of a project your autoscaler endpoint is created for

   • source_service: the name of a service for which you want to enable autoscaler

   curl --request POST \
     --url https://api.aiven.io/v1/project/{project_name}/integration \
     --header 'Authorization: Bearer REPLACE_WITH_YOUR_BEARER_TOKEN' \
     --header 'content-type: application/json' \
     --data
        '{
           "dest_endpoint_id": "REPLACE_WITH_YOUR_NEW_AUTOSCALER_ENDPOINT_ID",
           "integration_type": "autoscaler",
           "source_project": "REPLACE_WITH_PROJECT_NAME",
           "source_service": "REPLACE_WITH_SERVICE_NAME"
        }'
   

Enable with Aiven CLI

You can enable disk autoscaler for your service with the Aiven CLI client by run the commands to create the following: * Autoscaler integration endpoint on your project (avn service integration-endpoint-create) * Autoscaler integration on your service using the new autoscaler integration endpoint (avn service integration-create)

1. Run the following command to create an autoscaler integration endpoint on your project:

   avn service integration-endpoint-create                                                   \
      --project YOUR_PROJECT_NAME                                                            \
      --endpoint-name DESIRED_ENDPOINT_NAME                                                  \
      --endpoint-type disk_storage                                                           \
      --user-config-json '{"max_additional_storage":"REPLACE_WITH_DESIRED_VALUE_IN_GB"}'
   

2. Run the avn service integration-endpoint-list command to retrieve the identifier of the new endpoint:

   avn service integration-endpoint-list --project YOUR_PROJECT_NAME
   

3. Run the following command to create an autoscaler integration on your service using the new autoscaler integration endpoint:

   avn service integration-create
      --dest-service YOUR_SERVICE_NAME                             \
      --integration-type autoscaler                                \
      --source-endpoint-id ID_OF_AUTOSCALER_INTEGRATION_ENDPOINT
   

Configure disk autoscaler

After enabling disk autoscaler, any time later you can update the maximum additional disk storage allowed for autoscaling purposes. You can use Aiven Console, Aiven API, or Aiven CLI to do that.

Configure in Aiven Console

1. Log in to Aiven Console and navigate to a desired organization and project.

2. On the Services page of your project, select Integration endpoints from the sidebar.

3. On the Integration endpoints page, select Disk autoscaler, find your endpoint on the list of the existing autoscaler endpoints, select the Edit endpoint icon.

4. In the Edit endpoint window, specify a new value for the maximum additional disk storage to be allowed for autoscaling, and select Update.

Configure with Aiven API

You can use Aiven API to configure the maximum additional disk storage allowed for autoscaling purposes on your service.

Call the ServiceIntegrationEndpointUpdate endpoint passing the following parameters in your request:

• project_name (path parameter)

• integration_endpoint_id (path parameter)

• max_additional_storage (request body > user_config object)

curl --request PUT \
  --url https://api.aiven.io/v1/project/{project_name}/integration_endpoint/{integration_endpoint_id} \
  --header 'Authorization: Bearer REPLACE_WITH_YOUR_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data
     '{
        "user_config": {
          "autoscaler": {
            "max_additional_storage": "REPLACE_WITH_DESIRED_VALUE_IN_GB"
          }
        }
      }'

Configure with Aiven CLI

You can use the Aiven CLI client to configure the maximum additional disk storage allowed for autoscaling purposes on your service.

Run the avn service integration-endpoint-update command passing a desired maximum additional disk storage as PARAMETER_VALUE_IN_GB:

avn service integration-endpoint-update AUTOSCALER_ENDPOINT_ID
   --user-config-json '{"max_additional_storage":"PARAMETER_VALUE_IN_GB"}'

Disable disk autoscaler

To disable disk autoscaling on your Aiven service, you need to disconnect the service from the autoscaler integration endpoint. You can also delete the integration endpoint itself if you don’t need it for future purposes. You can disable disk autoscaling in Aiven Console, using Aiven API, or Aiven CLI client.

Disable in Aiven Console

Disable on a service

1. Log in to Aiven Console and navigate to a desired organization, project, and service.

2. On the Overview page of your service, select Integrations from the sidebar.

3. On the Integrations page, find your autoscaler service integration at the top, select the Actions (…) menu > Disconnect.

4. In the Disconnect service integration window, select Disconnect.

Delete an autoscaler endpoint

1. Log in to Aiven Console and navigate to a desired organization and project.

2. On the Services page of your project, select Integration endpoints from the sidebar.

3. On the Integration endpoints page, select Disk autoscaler, find your endpoint on the list of the existing autoscaler endpoints, select the Delete endpoint icon and Delete in the Confirmation window.

Disable with Aiven API

To disable disk autoscaler on your service via Aiven API, call the ServiceIntegrationDelete endpoint to delete an autoscaler integration on your service and, next, the ServiceIntegrationEndpointDelete endpoint on your project to delete the autoscaler integration endpoint if you don’t need it for any future purposes.

ServiceUpdate endpoint passing {"service disk autoscaler": {"enabled": true}} in the user_config object.

1. Call the ServiceIntegrationDelete endpoint on your service passing the following in the request body:

   • project_name (path parameter): the name of a project in which your autoscaler service integration is enabled

   • integration_id (path parameter): ID of an autoscaler service integration you want to disable

   curl --request DELETE \
     --url https://api.aiven.io/v1/project/{project_name}/integration/{integration_id} \
     --header 'Authorization: Bearer REPLACE_WITH_YOUR_BEARER_TOKEN'
   

2. Call the ServiceIntegrationEndpointDelete endpoint on your project passing the following in the request body:

   • project_name (path parameter): the name of a project in which your autoscaler integration endpoint is created

   • integration_endpoint_id (path parameter): ID of an autoscaler integration endpoint you want to delete

   curl --request DELETE \
     --url https://api.aiven.io/v1/project/{project_name}/integration_endpoint/{integration_endpoint_id} \
     --header 'Authorization: Bearer REPLACE_WITH_YOUR_BEARER_TOKEN'
   

Disable with Aiven CLI

You can disable disk autoscaler on your service with the Aiven CLI client by run the commands to delete the following:

• Autoscaler integration on your service

• Autoscaler integration endpoint on your project (if you don’t need the autoscaler integration endpoint on your project for any future purposes).

1. Retrieve the ID of an integration you want to disable by running the following command:

   avn service integration-list SERVICE_NAME
   

2. Run the following command to delete an autoscaler integration on your service:

   avn service integration-delete INTEGRATION_ID
   

3. Retrieve the ID of an autoscaler integration endpoint you want to delete by running the following command:

   avn service integration-endpoint-list PROJECT_NAME
   

3. Run the following command to delete an autoscaler integration endpoint on your project:

   avn service integration-endpoint-delete ENDPOINT_ID
   

Related pages

Dynamic disk sizing (DDS)