Databases - IBM Cloud

Help

Let's get your IBM Cloud Databases Terraform up and running

Prerequisite

Terraform CLI installed

If you don't have it installed yet, follow the steps at the Terraform installation tutorial

Optional

Make sure Terraform is installed correctly

Open Terminal and run:

$ terraform -help

Create or retrieve an IBM Cloud API key

The API key is used to authenticate with the IBM Cloud platform and to determine your permissions for IBM Cloud services.

Note

Make sure you save the API key locally, as you will not get to see it again.

Create a new folder with a Terraform file

You can use the terminal, Visual Studio Code or any equivalent tool to:

Create a new directory on your machine called:
Create a new Terraform file in this directory called:

Automate provisioning by setting up your configuration file

Edit Terraform configuration file

Add the following snippet into the

configuration file you just created. Replace theAPI keywith the one previously created.

terraform {
  required_providers {
    ibm = {
      version = ">= 1.12.0"
      source  = "IBM-Cloud/ibm"
    }
  }
}

# Configure the IBM Provider
provider "ibm" {
  region           = "us-south"
  ibmcloud_api_key = "<YOUR API KEY>"
}

# Configure the resource group
data "ibm_resource_group" "db_default" {
  is_default = true
}

# Create database 
resource "ibm_database" "postgresql_db" {
  resource_group_id = data.ibm_resource_group.db_default.id
  name              = "test-postgresql" 
  service           = "databases-for-postgresql"
  plan              = "standard"
  location          = "us-south"
  service_endpoints = "public"
  group {
    group_id = "member"
    host_flavor {
      id = "multitenant"
    }
    cpu {
      allocation_count = 0
    }
    memory {
      allocation_mb = 4096
    }
    disk {
      allocation_mb = 5120
    }
  }
}

See detailed explanation

Optional

Add optional parameters to the configuration file

Add any of the following optional parameters to the ibm_database resource.

Admin password

adminpassword = "password123verysecure"

Admin password needs to be 15 characters long and must include a letter and a number

Add users

users {
  name     = "user123"
  password = "password1234secure"
  type     = "database"
}

User password needs to be 15 characters long and must include a letter and a number

Allowlisting

allowlist {
  address     = "172.168.1.1/32"
  description = "network"
}

Including an allowlist entry might prevent from successful connection

Add the connection strings to the configuration file – outside the ibm_database resource.

Connection strings

# ibm_database_connection data source must be defined to be referenced by the output
data "ibm_database_connection" "postgresql_conn" {
  deployment_id = resource.ibm_database.postgresql_db.id
  user_id       = resource.ibm_database.postgresql_db.adminuser
  user_type     = "database"  
  endpoint_type = "public"
}

# output string references data source
output "postgresql_connection" {
  value  = data.ibm_database_connection.postgresql_conn.postgres.0.composed.0
}

Download the complete configuration file

Get Terraform ready and create your database

Open your local terminal and navigate to the recently created

directory that has thefile in it.

Launch Terraform

$ terraform init

Get a list of actions what is going to be deployed

$ terraform plan

Run this command to provision the database

$ terraform apply

It might take some time to provision your instance, you will see a success message once it is done.

IBM Cloud