The managed database you describe here will spin up automatically through the build process. The way you setup your deployment to make use of a managed database is to go to your template and setup two values. The first value is
"DATABASE_INSTALLATION_TYPE"
which must be set to
"DBaaS".
The second value is
DATABASE_DBaaS_INSTALLATION_TYPE
which is described below for each DBaaS provider that is supported. With the DATABASE_DBaaS_INSTALLATION_TYPE parameter, you add the configuration qualities of the database you want to be provisioned such as size, region, engine type and so on. If these are all set correctly as part of your build process a managed database according to how you have specified will be provisioned. If a managed database which satisfies the same provisioning is already running and available then a brand new cluster will not be provisioned but rather the existing cluster will be used. You can keep your managed database running across multiple deployments of your application, but, you will have to set "BYPASS_DB_LAYER" to "1" in your template. Please refer to the specification for more information on "BYPASS_DB_LAYER"
DIGITAL OCEAN
If you are using digital ocean managed databases you can set the following in your template or override
DATABASE_DBaaS_INSTALLATION_TYPE="<db-type>:DBAAS:<db-engine>:<region>:<size>:<db-version>:<cluster-name>:<db-name>:<adt_vpc>:<database_name>"** DATABASE_INSTALLATION_TYPE="DBaaS"**
So an example of this would be in your template or override:
1. DATABASE_DBaaS_INSTALLATION_TYPE="MySQL:DBAAS:mysql:lon1:1:db-s-1vcpu-1gb:8:testdbcluster1:testdb1:e265abcb-1295-1d8b-af36-0129f89456c2:testdb1"
2. DATABASE_DBaaS_INSTALLATION_TYPE="Postgres:DBAAS:pg:lon1:1:db-s-1vcpu-1gb:17:testdbcluster1:testdb1:e265abcb-1295-1d8b-af36-0129f89456c2:testdb1"
So, for the first example:
db-type="MySQL"
db-engine="mysql"
region="lon1"
size="db-s-1vcpu-1gb"
db-version="8" (mysql 8)
cluster-name="testdbcluster1"
db-name="testdb1"
adt_vpc="e265abcb-1295-1d8b-af36-0129f89456c2"
So,
db-type can be: "MySQL", "Postgres"
db-engine can be "mysql", "pg"
region can be "nyc1, sfo1, nyc2, ams2, sgp1, lon1, nyc3, ams3, fra1, tor1, sfo2, blr1, sfo3"
size can be "db-s-1vcpu-1gb", "db-s-1vcpu-2gb", "db-s-1vcpu-3gb", "db-s-2vcpu-4gb", "db-s-4vcpu-8gb", "db-s-8vcpu-16gb", "db-s-8vcpu-32gb"
db-version can be for mysql = "8" for postgres="14,15,16,17"
cluster-name can be unique string for your cluster, for example, "testcluster"
db-name can be a unique string for your database, for example, "testdatabase"
adt_vpc the unique vpc id of your machines, for example, "e265abcb-1295-1d8b-af36-0129f89456c2"
Once the managed database is provisioned set its "trusted ip" addresses to "10.0.0.0/16" through the GUI system so that it can only be connected to through private ip addresses.
EXOSCALE
If you are using exoscale managed databases you can set the following in your template or override
DATABASE_DBaaS_INSTALLATION_TYPE="<db-type>:DBAAS:<db-engine>:<region>:<size>:<db-name>" DATABASE_INSTALLATION_TYPE="DBaaS"
So an example of this would be in your template or override:
1. DATABASE_DBaaS_INSTALLATION_TYPE="MySQL:DBAAS:mysql:ch-gva-2:hobbyist-2:testdb1"
2. DATABASE_DBaaS_INSTALLATION_TYPE="Postgres:DBAAS:pg:ch-gva-2:hobbyist-2:testdb1"
So, for the first example:
db-type="MySQL"
db-engine="mysql"
region="ch-gva-2"
size="hobbyist-2"
db-name="testdb1"
So,
db-type can be: "MySQL", "Postgres"
db-engine can be "mysql", "pg"
region can be "ch-gva-2", "de-fra-1", "de-muc-1", "at-vie-1", "ch-dk-2", "bg-sof-1"
size can be "hobbyist-2", "startup-[4|8|16|32|64|128|255]", "business-[4|8|16|32|64|128|255]", "premium-[4|8|16|32|64|128|255]"
db-name can be a unique string for your database, for example, "testdatabase"
LINODE
If you are using Linode Managed Databases you can set the following in your template override:
DATABASE_DBaaS_INSTALLATION_TYPE="<db-type>:DBAAS:<engine>:<region>:<machine_type>:<cluster_size>:<cluster_label>:<database_name> DATABASE_INSTALLATION_TYPE="DBaaS"
So two example configurations might be:
1. DATABASE_DBaaS_INSTALLATION_TYPE="MySQL:DBAAS:mysql/8:gb-lon:g6-nanode-1:1:test-cluster:testdb1"
db-type="MySQL" db-engine="mysql/8" region="gb-lon" machine-size="g6-nanode-1" cluster-size="1"
db-type can be "MySQL"
db-engine can be "mysql/8" - at the time of writing you can check what engines are available for you by issuing "linode-cli databases engines" command.
region can currently be listed using "linode-cli databases engines"
machine-size="g6-nanode-1,g6-standard-1,g6-standard-2,g6-standard-4,g6-standard-6,g6-standard-8,g6-standard-16,g6-standard-20,g6-standard-24,g6-standard-32,g7-highmem-1,g7-highmem-2,g7-highmem-4,g7-highmem-8,g7-highmem-16,g6-dedicated-2,g6-dedicated-4,g6-dedicated-8,g6-dedicated-16,g6-dedicated-32,g6-dedicated-48,g6-dedicated-50,g6-dedicated-56,g6-dedicated-64"
cluster-size, as far as I know, can be 1 or 3
2. DATABASE_DBaaS_INSTALLATION_TYPE="Postgres:DBAAS:postgresql/17:gb-lon:g6-nanode-1:1:test-cluster:testdb1"
db-type="Postgres" db-engine="postgresql/17" region="gb-lon" machine-size="g6-nanode-1" cluster-size="1"
db-type can be "Postgres"
db-engine can be "postgresql/13" or "postgresql/14" or "postgresql/15" or "postgresql/16" or "postgresql/17" - at the time of writing you can check what engines are available for you by issuing "linode-cli databases engines" command.
region can be "linode-cli databases regions"
machine-size="g6-nanode-1,g6-standard-1,g6-standard-2,g6-standard-4,g6-standard-6,g6-standard-8,g6-standard-16,g6-standard-20,g6-standard-24,g6-standard-32,g7-highmem-1,g7-highmem-2,g7-highmem-4,g7-highmem-8,g7-highmem-16,g6-dedicated-2,g6-dedicated-4,g6-dedicated-8,g6-dedicated-16,g6-dedicated-32,g6-dedicated-48,g6-dedicated-50,g6-dedicated-56,g6-dedicated-64"
cluster-size, as far as I know, can be 1 or 3
When using linode you will be prompted for other variables such as database name, hostname of the database and so on, which you have to get from the GUI system because as far as I know, they are not accessible through the CLI.
VULTR
If you are using Vultr Managed Databases you can set the following in your template override:
DATABASE_DBaaS_INSTALLATION_TYPE="<db-type>:DBAAS:<db-engine>:<db-engine-version>:<region>:<machine-size>:<db-name>:<cluster-name>:<vpc-id>" DATABASE_INSTALLATION_TYPE="DBaaS"
So, two example configurations might be:
1. DATABASE_DBaaS_INSTALLATION_TYPE="MySQL:DBAAS:mysql:8:lhr:vultr-dbaas-hobbyist-cc-1-25-1:testdb:TestDatabase:2fb13fd1-3145-3127-7132-13f28f1912c1"
db-type = MySQL
db-engine = mysql
db-engine-version = 8
region = lhr
machine-size = vultr-dbaas-hobbyist-cc-1-25-1
db-name = testdb
cluster-name = TestDatabase
vpc-id = 2fb13fd1-3145-3127-7132-13f28f1912c1
2. DATABASE_DBaaS_INSTALLATION_TYPE="Postgres:DBAAS:pg:14:lhr:vultr-dbaas-hobbyist-cc-1-25-1:testdb:TestDatabase:2fb13fd1-3145-3127-7132-13f28f1912c1"
db-type = Postgres
db-engine = pg
db-engine-version = 14
region = lhr
machine-size = vultr-dbaas-hobbyist-cc-1-25-1
db-name = testdb
cluster-name = TestDatabase
vpc-id = 2fb13fd1-3145-3127-7132-13f28f1912c1
db-type can be "MySQL" or "Postgres"
db-engine = mysql db-engine-version=8 or db-engine=pg db-engine-version=11 or 12 or 13 or 14 or 15
region = ams atl blr bom cdg del dfw ewr fra hnl icn itm jnb lax lhr mad mel mex mia nrt ord sao scl sea sgp sjc sto syd waw yto
machine-size = vultr-dbaas-hobbyist-cc-1-25-1 vultr-dbaas-startup-cc-1-55-2 vultr-dbaas-business-cc-1-55-2 vultr-dbaas-premium-cc-1-55-2 vultr-dbaas-startup-cc-2-80-4 vultr-dbaas-business-cc-2-80-4 vultr-dbaas-premium-cc-2-80-4 vultr-dbaas-startup-cc-4-160-8 vultr-dbaas-business-cc-4-160-8 vultr-dbaas-premium-cc-4-160-8
Once the managed database is provisioned set its "trusted sources" addresses to "192.168.0.0/16" through the GUI system so that it can only be connected to through private ip addresses.