Provisioning a Scalingo for OpenSearch® Addon

Once you have chosen the right plan for your needs, you are ready to provision the addon. This can be done via our dashboard, our CLI tool or via our Terraform Provider.

Using the Dashboard

  1. From your web browser, open your dashboard
  2. Click on the application for which you want to add an OpenSearch® database
  3. Click on the Resources tab
  4. Locate the Addons block and click on the Add an addon button
  5. Select OpenSearch® in the databases block and click the Go to plan selection button
  6. Select the plan you want to provision
  7. Click the Finish button
  8. Give the platform a few seconds to ship your database and enjoy!

Using the Command Line

  1. Make sure you have correctly setup the Scalingo command line tool
  2. From the command line, list the plans available for opensearch:
    scalingo --app my-app addons-plans opensearch
    

    The output should look like this:

    +----------------------------+---------------+
    |             ID             |     NAME      |
    +----------------------------+---------------+
    | opensearch-starter-1024    | Starter 1G    |
    | opensearch-starter-2048    | Starter 2G    |
    ...
    
  3. Locate the ID corresponding to the plan you want to deploy (for example opensearch-starter-2048)
  4. Provision the addon:
    scalingo --app my-app addons-add opensearch <plan_ID>
    

    The output should look like this:

    -----> Addon opensearch has been provisionned
           ID: my_app_wxyz
           Message from addon provider: Database is being provisioned
    
  5. Wait a few seconds for the addon to be provisioned and enjoy!

Using the Terraform Provider

  1. Place the following resource block in your Terraform file to create the addon and attach it to your app:
    resource "scalingo_addon" "my-db" {
      provider_id = "opensearch"
      plan = "opensearch-starter-2048"
      app = "${scalingo_app.my-app.id}"
    }
    

    In this example, we create an OpenSearch Starter 2048 addon named my-db and attach it to an app named my-app (which must exist). We could have done the same with another plan.


Suggest edits

Provisioning a Scalingo for OpenSearch® Addon

©2025 Scalingo