-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,150 +1,128 @@ | ||
Scale your Aiven service disks automatically | ||
============================================ | ||
|
||
Discover the service disk autoscaler and its capabilities. Find out it works and how to use it with your Aiven for service. | ||
Discover the service disk autoscaler and its capabilities. Find out how it works and how to use it with your Aiven for service. | ||
Check failure on line 4 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L4
Raw output
|
||
|
||
About disk autoscaling | ||
---------------------- | ||
|
||
.. seealso:: | ||
.. topic:: Pricing | ||
|
||
For more information on service disk autoscaler, check. | ||
Costs of using disk autoscaler depend on your service type and plan. You don't pay a fixed amount monthly but you're charged based on your actual usage. For information on the costs of using disk autoscaler, check the same for dynamic disk sizing (DDS) in `Aiven Plans and Pricing <https://aiven.io/pricing?product=kafka>`_ or contact us at [email protected]. | ||
Check failure on line 8 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L8
Raw output
Check failure on line 8 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L8
Raw output
|
||
|
||
Why use it | ||
---------- | ||
Why use disk autoscaling | ||
Check failure on line 10 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L10
Raw output
|
||
------------------------ | ||
|
||
Service disk autoscaler increases disk storage capacity automatically when the disk is running out of space. Disk autoscaling allows you to improve the cost-efficiency of operating your Aiven services: you can start with a relatively small-sized disk and only have it scaled up when needed with no risk of running out of disk space at any point. | ||
Check failure on line 13 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L13
Raw output
Check failure on line 13 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L13
Raw output
|
||
|
||
How it works | ||
------------ | ||
|
||
.. topic:: Flow of actions | ||
There are a few steps illustratig how disk autoscaler works: | ||
Check failure on line 18 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L18
Raw output
Check failure on line 18 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L18
Raw output
|
||
|
||
1. You create an disk autoscaler integration endpoint in your Aiven project setting the maximum additional storage at the same time. | ||
Check failure on line 20 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L20
Raw output
|
||
2. You enable a disk autoscaler integration for your service using the new disk autoscaler integration endpoint. | ||
Check failure on line 21 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L21
Raw output
Check failure on line 21 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L21
Raw output
|
||
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 treshold for a specific service, disk autoscaler increases available storage space by 10% every time taking the currently-used service plan as a baseline. | ||
Check failure on line 23 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L23
Raw output
Check failure on line 23 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L23
Raw output
|
||
|
||
.. seealso:: | ||
.. topic:: AUTOSCALE THRESHOLDS PER SERVICE TYPE | ||
|
||
For more information on how service disk autoscaler works, check | ||
The treshold at which disk autoscaling is triggered is a percentage of the available disk storage capacity and depends on a service type: | ||
Check failure on line 27 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L27
Raw output
Check failure on line 27 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L27
Raw output
|
||
|
||
* 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 (Aiven for PostgreSQL) | ||
* Depending on what interface you'd like to use for interacting with service disk autoscaler, you might need the following: | ||
* Aiven organization, project, and service up and running | ||
* :doc:`Dynamic disk sizing (DDS) </docs/platform/concepts/dynamic-disk-sizing>` 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: | ||
Check failure on line 39 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L39
Raw output
|
||
* Access to `Aiven Console <https://console.aiven.io/>`_ | ||
* SQL | ||
* `Aiven API <https://api.aiven.io/doc/>`_ | ||
* :doc:`Aiven CLI client </docs/tools/cli>` | ||
|
||
Enable service disk autoscaler | ||
------------------- | ||
Enable disk autoscaler | ||
Check failure on line 44 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L44
Raw output
|
||
---------------------- | ||
|
||
You can enable the extension in `Aiven Console <https://console.aiven.io/>`_, using Aiven API, or Aiven CLI client. | ||
You can enable disk autoscaling in `Aiven Console <https://console.aiven.io/>`_, using Aiven API, or Aiven CLI client. | ||
Check failure on line 47 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L47
Raw output
|
||
|
||
Enable in Aiven Console | ||
~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. important:: | ||
|
||
In `Aiven Console <https://console.aiven.io/>`_, you can enable service disk autoscaler at the service level only. To enable the extension on a database or for a user, you need to use SQL. | ||
|
||
1. Log in to `Aiven Console <https://console.aiven.io/>`_ and navigate to a desired organization, project, and service. | ||
2. On the **Overview** page of your service, navigate to **Advanced configuration** > **Configure** > **Add configuration options**. | ||
3. Find the **service disk autoscaler.enabled** parameter, set it to **true**, and select **Save configuration**. | ||
|
||
Enable with Aiven API | ||
~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can use `Aiven API <https://api.aiven.io/doc/>`_ to enable service disk autoscaler on your service. Call the | ||
To enable disk autoscaler on your service via `Aiven API <https://api.aiven.io/doc/>`_, call the | ||
Check failure on line 59 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L59
Raw output
|
||
`ServiceUpdate <https://api.aiven.io/doc/#tag/Service/operation/ServiceUpdate>`_ endpoint passing ``{"service disk autoscaler": {"enabled": true}}`` in the ``user_config`` object. | ||
|
||
Enable with Aiven CLI | ||
Check failure on line 62 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L62
Raw output
|
||
~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can use the :doc:`Aiven CLI client </docs/tools/cli>` to enable service disk autoscaler for your service by running the following command: | ||
You can use the :doc:`Aiven CLI client </docs/tools/cli>` to enable disk autoscaler for your service by running the following command: | ||
Check failure on line 65 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L65
Raw output
|
||
|
||
.. code-block:: bash | ||
avn service update -c service disk autoscaler.enabled=true SERVICE_NAME | ||
Configure service disk autoscaler | ||
---------------------- | ||
|
||
service disk autoscaler is pre-configured with default settings but you can modify its configuration parameters in `Aiven Console <https://console.aiven.io/>`_, using Aiven API, or Aiven CLI. | ||
|
||
You might want to configure the following parameters: | ||
Configure disk autoscaler | ||
Check failure on line 71 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L71
Raw output
|
||
------------------------- | ||
|
||
* ``service disk autoscaler.enabled`` (to enable or disable the service disk autoscaler extension) | ||
* ``service disk autoscaler.track_pg_catalog`` (to enable or disable service disk autoscaler on pg_catalog) | ||
* ``service disk autoscaler.sample_rate`` (to set the granularity of service disk autoscaler analysis and statistics returned) | ||
* Allowed values: ``0`` - ``1``, where ``1`` means analysis and statistics on every single query, and ``0`` means there are no queries analysed. | ||
* Default value: ``1/max_connections`` | ||
* ``service disk autoscaler.track_constants`` (to enable or disable service disk autoscaler on constants) | ||
|
||
.. topic:: Sample service disk autoscaler configuration | ||
|
||
.. code-block:: bash | ||
service disk autoscaler.enabled = on | ||
service disk autoscaler.sample_rate = 0.1 | ||
.. seealso:: | ||
|
||
For more confuguration options, check `powa-team's service disk autoscaler configuration <https://github.com/powa-team/service disk autoscaler>`_. | ||
After enabling disk autoscaler, any time later you can update the maximum additional disk storage that can be added to your original service storage. For that purpose, you can use `Aiven Console <https://console.aiven.io/>`_, Aiven API, or Aiven CLI. | ||
Check failure on line 74 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L74
Raw output
|
||
|
||
Configure in Aiven Console | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. important:: | ||
|
||
In `Aiven Console <https://console.aiven.io/>`_, you can configure service disk autoscaler at the service level only. To configure the extension on a database or for a user, you need to use SQL. | ||
|
||
1. Log in to `Aiven Console <https://console.aiven.io/>`_ and navigate to a desired organization, project, and service. | ||
2. On the **Overview** page of your service, navigate to **Advanced configuration** > **Configure** > **Add configuration options**. | ||
3. Find a desired service disk autoscaler parameter (all prefixed with ``service disk autoscaler``), set its value as needed, and select **Save configuration**. | ||
Check failure on line 81 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L81
Raw output
|
||
|
||
Configure with Aiven API | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can use `Aiven API <https://api.aiven.io/doc/>`_ to configure service disk autoscaler on your service. Call the | ||
You can use `Aiven API <https://api.aiven.io/doc/>`_ to configure disk autoscaler on your service. Call the | ||
`ServiceUpdate <https://api.aiven.io/doc/#tag/Service/operation/ServiceUpdate>`_ endpoint passing desired service disk autoscaler parameters in the ``user_config`` object. | ||
Check failure on line 87 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L87
Raw output
|
||
|
||
Configure with Aiven CLI | ||
Check failure on line 89 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L89
Raw output
|
||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can use the :doc:`Aiven CLI client </docs/tools/cli>` to configure service disk autoscaler on your service by running the following command: | ||
You can use the :doc:`Aiven CLI client </docs/tools/cli>` to configure disk autoscaler on your service by running the following command: | ||
Check failure on line 92 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L92
Raw output
|
||
|
||
.. code-block:: bash | ||
avn service update -c service disk autoscaler.PARAMETER_NAME=PARAMETER_VALUE SERVICE_NAME | ||
Disable service disk autoscaler | ||
-------------------- | ||
Disable disk autoscaler | ||
Check failure on line 98 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L98
Raw output
|
||
----------------------- | ||
|
||
You can disable the extension in `Aiven Console <https://console.aiven.io/>`_, using Aiven API, or Aiven CLI. | ||
You can disable disk autoscaling in `Aiven Console <https://console.aiven.io/>`_, using Aiven API, or Aiven CLI client. | ||
Check failure on line 101 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L101
Raw output
|
||
|
||
Disable in Aiven Console | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. important:: | ||
|
||
In `Aiven Console <https://console.aiven.io/>`_, you can disable service disk autoscaler at the service level only, which deactivates the extension globally for the whole service: all the databases and user roles in this service. To disable the extension on a particular database or for a specific user only, you need to use SQL. | ||
|
||
1. Log in to `Aiven Console <https://console.aiven.io/>`_ and navigate to a desired organization, project, and service. | ||
2. On the **Overview** page of your service, navigate to **Advanced configuration** > **Configure** > **Add configuration options**. | ||
3. Find the **service disk autoscaler.enabled** parameter, set it to **false**, and select **Save configuration**. | ||
|
||
Disable with Aiven API | ||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can use `Aiven API <https://api.aiven.io/doc/>`_ to disable service disk autoscaler on your service. Call the | ||
You can use `Aiven API <https://api.aiven.io/doc/>`_ to disable disk autoscaler on your service. Call the | ||
`ServiceUpdate <https://api.aiven.io/doc/#tag/Service/operation/ServiceUpdate>`_ endpoint passing ``{"service disk autoscaler": {"enabled": false}}`` in the ``user_config`` object. | ||
Check failure on line 114 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L114
Raw output
|
||
|
||
Disable with Aiven CLI | ||
Check failure on line 116 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L116
Raw output
|
||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can use the :doc:`Aiven CLI client </docs/tools/cli>` to disable service disk autoscaler on your service by running the following command: | ||
You can use the :doc:`Aiven CLI client </docs/tools/cli>` to disable disk autoscaler on your service by running the following command: | ||
Check failure on line 119 in docs/platform/howto/disk-autoscaler.rst GitHub Actions / vale[vale] docs/platform/howto/disk-autoscaler.rst#L119
Raw output
|
||
|
||
.. code-block:: bash | ||
avn service update -c service disk autoscaler.enabled=false SERVICE_NAME | ||
Related reading | ||
--------------- | ||
|
||
:doc:`Dynamic disk sizing (DDS) </docs/platform/concepts/dynamic-disk-sizing>` |