Create a Cluster

This page covers how to create a new cluster for a database. By default, each database includes a main cluster, and you can add additional clusters for higher concurrency.

This action modifies or creates new resources in your cloud account. Make sure the action does not exceed any resource limits set by your organization.

Prerequisites

The database access node must be up and running.

Procedure

This procedure can be carried out using the Administration API.

The examples in this procedure are written using Bash on a Linux terminal. You can also use other interfaces and languages to execute the curl commands.

Placeholder values are styled as Bash variables, starting with the dollar sign ($) and using UPPERCASE characters. Replace the placeholders with your own values before executing the curl command.

  1. Get information about the database by sending a GET request to the /api/v1/databases endpoint. For example:

    curl -k -X "GET" \
    "https://$EXASOL_IP/api/v1/databases" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

    The response will include the following:

    • Database ID
    • Database name
    • Database version
    • Provider type
    • Number of clusters in the database
    • Number of clusters running
    • Volumes

    Additional database parameters and hardware details may be included in the response depending on the configuration and platform.

  2. To add a cluster, send a POST request to the /api/v1/databases/DATABASE_ID/clusters endpoint and include the new cluster's name and instance type in the payload. The instance-type depends on the cloud environment. In AWS an instance type could be 'c5d.2xlarge'. For example:

    curl -k -X "POST" \
    "https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/clusters" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "worker_cluster1",
      "instanceType": "c5d.2xlarge"
    }'

If the cluster is created while the database is stopped, the cluster is not started automatically after creation. To start the cluster, see Start a Cluster.

Verification

To verify, send a GET request to the /api/v1/databases/DATABASE_ID/clusters endpoint. For example:

curl -k -X "GET" \
"https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/clusters" \
-H "accept: application/json" \
-H "Authorization: Basic $AUTH_TOKEN"

New clusters are listed and running.