Instance Size Selections with the SkySQL DBaaS API

Enterprise Server Single Node

For Foundation tier:

For Power tier:

Enterprise Server With Replica(s)

For Foundation tier:

For Power tier:

Xpand Distributed SQL

For Foundation tier:

For Power tier:

ColumnStore Data Warehouse

For Foundation tier:

For Power tier:

MaxScale

With Power tier, the following instance sizes can be selected for MaxScale nodes:

Query Database Node Options with REST Client

A REST client can query the SkySQL DBaaS API for the database node instance size selections for a specific cloud provider, architecture, and topology.

To see the available database node instance sizes for a topology, use curl to call the /provisioning/v1/sizes API endpoint with type=server set:

$ curl -sS --location \
   --header "Authorization: Bearer ${SKYSQL_API_KEY}" \
   'https://api.mariadb.com/provisioning/v1/sizes?architecture=amd64&service_type=transactional&provider=gcp&topology=es-replica&type=server' \
   | jq .

[
  {
    "id": "37629543-65d2-11ed-8da6-2228d0ae81af",
    "name": "sky-2x8",
    "display_name": "Sky-2x8",
    "service_type": "transactional",
    "provider": "gcp",
    "tier": "foundation",
    "architecture": "amd64",
    "cpu": "2 vCPU",
    "ram": "8 GB",
    "type": "server",
    "default_maxscale_size_name": "sky-2x8",
    "updated_on": "2022-11-16T17:15:06Z",
    "created_on": "2022-11-16T17:15:06Z",
    "is_active": true,
    "topology": "es-replica"
  },
  {
    "id": "37629489-65d2-11ed-8da6-2228d0ae81af",
    "name": "sky-4x16",
    "display_name": "Sky-4x16",
    "service_type": "transactional",
    "provider": "gcp",
    "tier": "foundation",
    "architecture": "amd64",
    "cpu": "4 vCPU",
    "ram": "16 GB",
    "type": "server",
    "default_maxscale_size_name": "sky-2x8",
    "updated_on": "2022-11-16T17:15:06Z",
    "created_on": "2022-11-16T17:15:06Z",
    "is_active": true,
    "topology": "es-replica"
  },
  {
    "id": "376292a9-65d2-11ed-8da6-2228d0ae81af",
    "name": "sky-4x32",
    "display_name": "Sky-4x32",
    "service_type": "transactional",
    "provider": "gcp",
    "tier": "foundation",
    "architecture": "amd64",
    "cpu": "4 vCPU",
    "ram": "32 GB",
    "type": "server",
    "default_maxscale_size_name": "sky-4x32",
    "updated_on": "2022-11-16T17:15:06Z",
    "created_on": "2022-11-16T17:15:06Z",
    "is_active": true,
    "topology": "es-replica"
  },
  {
    "id": "376292d0-65d2-11ed-8da6-2228d0ae81af",
    "name": "sky-8x32",
    "display_name": "Sky-8x32",
    "service_type": "transactional",
    "provider": "gcp",
    "tier": "foundation",
    "architecture": "amd64",
    "cpu": "8 vCPU",
    "ram": "32 GB",
    "type": "server",
    "default_maxscale_size_name": "sky-4x16",
    "updated_on": "2022-11-16T17:15:06Z",
    "created_on": "2022-11-16T17:15:06Z",
    "is_active": true,
    "topology": "es-replica"
  },
  {
    "id": "3762935b-65d2-11ed-8da6-2228d0ae81af",
    "name": "sky-8x64",
    "display_name": "Sky-8x64",
    "service_type": "transactional",
    "provider": "gcp",
    "tier": "foundation",
    "architecture": "amd64",
    "cpu": "8 vCPU",
    "ram": "64 GB",
    "type": "server",
    "default_maxscale_size_name": "sky-4x32",
    "updated_on": "2022-11-16T17:15:06Z",
    "created_on": "2022-11-16T17:15:06Z",
    "is_active": true,
    "topology": "es-replica"
  }
]

The output can show different instance sizes, depending on whether your SkySQL account is Foundation tier or Power tier.

For the database node instance size that you would like to select, extract the name attribute from the output and provide that value to the /provisioning/v1/services API endpoint as the size attribute.

Select Database Node Option with REST Client

A database node instance size is selected during service launch. When using a REST client, select an instance size for database nodes by calling the /provisioning/v1/services API endpoint with the size attribute set.

For example, prepare a request body containing the desired service options in a file called request-service.json:

$ cat > request-service.json <<EOF
{
  "service_type": "transactional",
  "topology": "es-single",
  "provider": "gcp",
  "region": "us-central1",
  "architecture": "amd64",
  "size": "sky-2x8",
  "storage": 100,
  "nodes": 1,
  "version": "10.6.11-6-1",
  "name": "skysql-nr-quickstart",
  "ssl_enabled": true
}
EOF

Then use curl to call the /provisioning/v1/services API endpoint to create (launch) a new database service and save the response to the response-service.json file:

$ curl -sS --location --request POST \
   --header "Authorization: Bearer ${SKYSQL_API_KEY}" \
   --header "Accept: application/json" \
   --header "Content-type: application/json" \
   --data '@request-service.json' \
   https://api.mariadb.com/provisioning/v1/services \
   | tee response-service.json | jq .

Upon success, the command will return JSON with details about the new service.

Query MaxScale Node Options with REST Client

A REST client can query the SkySQL DBaaS API for the MaxScale node instance size selections for a specific cloud provider, architecture, and topology.

To see the default MaxScale instance size for a topology, cloud, and architecture, use curl to call the /provisioning/v1/sizes API endpoint:

$ curl -sS --location \
   --header "Authorization: Bearer ${SKYSQL_API_KEY}" \
   'https://api.mariadb.com/provisioning/v1/sizes?provider=gcp&architecture=amd64&topology=es-replica' \
   | jq .

[
   {
     "id": "c0666ab8-4a3b-11ed-8853-b278760e6ab5",
     "name": "sky-2x8",
     "display_name": "Sky-2x8",
     "service_type": "transactional",
     "provider": "gcp",
     "tier": "foundation",
     "architecture": "amd64",
     "cpu": "2 vCPU",
     "ram": "8 GB",
     "type": "server",
     "default_maxscale_size_name": "sky-2x8",
     "updated_on": "2022-10-12T14:40:00Z",
     "created_on": "2022-10-12T14:40:00Z",
     "is_active": true,
     "topology": "es-replica"
   }
]

The default_maxscale_size_name attribute shows the default MaxScale instance size.

To see the available MaxScale node instance sizes for a topology, use curl to call the /provisioning/v1/sizes API endpoint with type=proxy set:

$ curl -sS --location \
   --header "Authorization: Bearer ${SKYSQL_API_KEY}" \
   'https://api.mariadb.com/provisioning/v1/sizes?architecture=amd64&service_type=transactional&provider=gcp&topology=es-replica&type=proxy' \
   | jq .

The output can show different instance sizes, depending on whether your SkySQL account is Foundation tier or Power tier.

For the MaxScale node instance size that you would like to select, extract the name attribute from the output and provide that value to the /provisioning/v1/services API endpoint as the maxscale_size attribute.

Select MaxScale Node Option with REST Client

A MaxScale node instance size is selected during service launch. When using a REST client and your SkySQL account has Power tier, select an instance size for MaxScale nodes by calling the /provisioning/v1/services API endpoint with the maxscale_size attribute set.

For example, prepare a request body containing the desired service options in a file called request-service.json:

$ cat > request-service.json <<EOF
{
  "service_type": "transactional",
  "topology": "es-replica",
  "provider": "gcp",
  "region": "us-central1",
  "architecture": "amd64",
  "size": "sky-2x8",
  "storage": 100,
  "nodes": 3,
  "maxscale_size": "sky-2x8",
  "maxscale_nodes": 2,
  "version": "10.6.11-6-1",
  "name": "skysql-nr-quickstart",
  "ssl_enabled": true
}
EOF

Then use curl to call the /provisioning/v1/services API endpoint to create (launch) a new database service and save the response to the response-service.json file:

$ curl -sS --location --request POST \
   --header "Authorization: Bearer ${SKYSQL_API_KEY}" \
   --header "Accept: application/json" \
   --header "Content-type: application/json" \
   --data '@request-service.json' \
   https://api.mariadb.com/provisioning/v1/services \
   | tee response-service.json | jq .

Upon success, the command will return JSON with details about the new service.

Select Database Node Option with Terraform

When using Terraform, select an instance size for database nodes using the size attribute for the skysql_service resource:

# Create a service
resource "skysql_service" "default" {
  service_type        = "transactional"
  topology            = "es-single"
  cloud_provider      = "gcp"
  region              = "us-central1"
  architecture        = "amd64"
  size                = "sky-2x8"
  storage             = 100
  nodes               = 1
  version             = "10.6.11-6-1"
  name                = "skysql-nr-quickstart"
  ssl_enabled         = true
  deletion_protection = true
  wait_for_creation   = true
  wait_for_deletion   = true
  wait_for_update     = true
  is_active           = true
}

Select MaxScale Node Option with Terraform

When using Terraform and your SkySQL account has Power tier, select an instance size for MaxScale nodes using the maxscale_size attribute for the skysql_service resource:

# Create a service
resource "skysql_service" "default" {
  service_type        = "transactional"
  topology            = "es-replica"
  cloud_provider      = "gcp"
  region              = "us-central1"
  architecture        = "amd64"
  size                = "sky-2x8"
  storage             = 100
  nodes               = 3
  version             = "10.6.11-6-1"
  maxscale_size       = "sky-2x8"
  maxscale_nodes      = 2
  name                = "skysql-nr-quickstart"
  ssl_enabled         = true
  deletion_protection = true
  wait_for_creation   = true
  wait_for_deletion   = true
  wait_for_update     = true
  is_active           = true
}