Changing Plan
At Scalingo, all databases addons plans are identified by a name made of two or three parts, each separated by a dash (-). This name is made of:
- a database type :
opensearch
- a class : either
starter
orbusiness
(learn more about classes). - a size : specifying the amount of RAM available with the plan, in MB (only for starter and business classes).
You can change your Scalingo for OpenSearch® addon plan whenever you want. The operation is launched instantly, no manual input is required.
The impact on your application and the downtime vary depending on several factors such as the current plan being used and the one you wish to change for (see below for further information).
Understanding the Plan Change Process
From Starter to Starter
When changing the size of a Starter plan, the platform reboots the existing instance with the new size. This leads to a service interruption during which the database is not available. This shouldn’t exceed a few minutes though.
From (class) | To (class) | To (size) | Downtime | Duration |
---|---|---|---|---|
Starter | Starter | Any | Yes | 2-4 minutes |
From Starter to Business
When changing for a Business plan, the platform first starts two new instances with the targeted size. If necessary, it then reboots the existing instance with the targeted size. OpenSearch® then does the necessary to distribute the data, in accordance with the indexes setup. There should be no downtime at all, thanks to the failover mechanism included with the Business plan.
From (class) | To (class) | To (size) | Downtime | Duration |
---|---|---|---|---|
Starter | Business | Any | No | Zero |
From Business to Starter
When changing for a lower class, the platform uses OpenSearch®’s API to exclude the non cluster-manager nodes from the cluster. OpenSearch® does the necessary to bring the data back to the cluster-manager node. It then powers off the excluded nodes. The remaining node is then rebooted, which leads to a small service interruption during which the database is not available. This shouldn’t exceed a few minutes though.
From (class) | To (class) | To (size) | Downtime | Duration |
---|---|---|---|---|
Business | Starter | Same | Yes | 2-4 minutes |
Business | Starter | Larger | Yes | 2-4 minutes |
Business | Starter | Smaller | Yes | 2-4 minutes |
From Business to Business
When changing the size of a Business plan, the platform first reboots the cluster-manager node with the targeted new size. It then reboots the other nodes with the targeted new size. There’s no downtime during this operation, thanks to the failover mechanism included in the Business plan.
From (class) | To (class) | To (size) | Downtime | Duration |
---|---|---|---|---|
Business | Business | Any | No | Zero |
Using the Dashboard
- From your web browser, open your dashboard
- Click on the application for which you want to scale the Scalingo for OpenSearch® addon
- Click on the Resources tab
- Locate the Addons block and click on the … button
- From the dropdown menu, select Change plan
- Select the new plan
- Click the Finish button
- Validate by clicking the Confirm plan change button
Using the Database Dashboard
- From your web browser, open your database dashboard
- Click the Settings tab
- In General, locate the Database Plan block
- In this block, click the Change plan button
- Select the new plan
- Click the Finish button
- Validate by clicking the Confirm plan change button
Using the Command Line
- Make sure you have correctly setup the Scalingo command line tool
- From the command line, list the plans available for
opensearch
:scalingo addons-plans opensearch
The output should look like this:
+----------------------------+---------------+ | ID | NAME | +----------------------------+---------------+ | opensearch-starter-1024 | Starter 1G | | opensearch-starter-2048 | Starter 2G | ...
- Locate the
ID
corresponding to the plan you want to scale to (for exampleopensearch-business-2048
) - Change plan using the
addons-upgrade
sub-command:scalingo --app my-app addons-upgrade opensearch <plan_ID>
The output should look like this:
-----> Addon ad-d0aa540a-5ed2-41f8-8bbe-91e3aff6623b has been upgraded Message from addon provider: Database plan is being changed
Using the Terraform Provider
- Update the
plan
property of the corresponding Resource block in your Terraform file to scale the addon:resource "scalingo_addon" "my-db" { provider_id = "opensearch" plan = "opensearch-business-2048" app = "${scalingo_app.my-app.id}" }
In this example, we switch the
my-db
resource attached to themy-app
application to a OpenSearch® Business 2048 addon.