Provisioning

Provisioning through the IBM Cloud console

Provision from the console by specifying the following parameters:

Provisioning through the CLI

Creating service instance INSTANCE_NAME in resource group default of account    USER...
OK
Service instance INSTANCE_NAME was created.

Name:                INSTANCE_NAME
ID:                  crn:v1:bluemix:public:databases-for-etcd:us-east:a/   40ddc34a846383BGB5b60e:dd13152c-fe15-4bb6-af94-fde0af5303f4::
GUID:                dd13152c-fe15-4bb6-af94-fde0af56897
Location:            LOCATION
State:               provisioning
Type:                service_instance
Sub Type:            Public
Service Endpoints:   private
Allow Cleanup:       false
Locked:              false
Created at:          2023-06-26T19:42:07Z
Updated at:          2023-06-26T19:42:07Z
Last Operation:
                     Status    create in progress
                     Message   Started create instance operation

ibmcloud resource service-instance-create databases-for-etcd <INSTANCE_NAME> standard us-south \
-p \ '{
  "backup_id": "crn:v1:blue:public:databases-for-etcd:us-south:a/54e8ffe85dcedf470db5b5ee6ac4a8d8:1b8f53db-fc2d-4e24-8470-f82b15c71717:backup:06392e97-df90-46d8-98e8-cb67e9e0a8e6",
  "members_memory_allocation_mb": "3072"
}' --service-endpoints="private"

Provisioning through the Resource Controller API

Follow these steps to provision using the Resource Controller API.

1. Obtain an IAM token from your API token.

2. You need to know the ID of the resource group that you would like to deploy to. This information is available through the IBM Cloud CLI.

   Use a command like:

   ibmcloud resource groups
   

3. You need to know the region you would like to deploy to.

   To list all of the regions that deployments can be provisioned into from the current region, use the Cloud Databases CLI plug-in.

   The command looks like:

   ibmcloud cdb regions --json
   

   Once you have all the information, provision a new resource instance with the IBM Cloud Resource Controller.

   curl -X POST \
     https://resource-controller.cloud.ibm.com/v2/resource_instances \
     -H 'Authorization: Bearer <>' \
     -H 'Content-Type: application/json' \
       -d '{
       "name": "my-instance",
       "target": "blue-us-south",
       "resource_group": "5g9f447903254bb58972a2f3f5a4c711",
       "resource_plan_id": "databases-for-etcd-standard",
       "parameters": { 
                "members_host_flavor":"b3c.4x16.encrypted",
                "service_endpoints":"private",
                "version": "<version>"
              }
     }'
   

   To make a Shared Compute instance, follow this example:

   curl -X POST \
     https://resource-controller.cloud.ibm.com/v2/resource_instances \
     -H "Authorization: Bearer <TOKEN>" \
     -H 'Content-Type: application/json' \
       -d '{ \
       "name": "my-instance", \
       "target": "us-south", \
       "resource_group": "<RESOURCE_GROUP_ID>", \
       "resource_plan_id": "<SERVICE_PLAN_NAME>", \
       "parameters": { 
         "members_host_flavor": "multitenant", 
         "service_endpoints": "private",
         "members_memory_allocation_mb": 16384, 
         "members_cpu_allocation_count": 4 
       } \
     }' \
   

    Provision a Databases for etcd Isolated instance with the same `"members_host_flavor"` parameter, setting it to the desired Isolated size. Available hosting sizes and their `members_host_flavor value` parameters are listed in [Table 2](#members_host-flavor-parameter-api). For example, `{"members_host_flavor": "b3c.4x16.encrypted"}`. Note that since the host flavor selection includes CPU and RAM sizes (`b3c.4x16.encrypted` is 4 CPU and 16 RAM), this request does not accept both, an Isolated size selection and separate CPU and RAM allocation selections.
   

   curl -X POST \
     https://resource-controller.cloud.ibm.com/v2/resource_instances \
     -H "Authorization: Bearer <TOKEN>" \
     -H 'Content-Type: application/json' \
       -d '{ \
       "name": "my-instance", \
       "target": "us-south", \
       "resource_group": "5g9f447903254bb58972a2f3f5a4c711", \
       "resource_plan_id": "<SERVICE_PLAN_NAME>", \
       "parameters": { 
       "members_host_flavor": "b3c.4x16.encrypted",
       "service_endpoints": "private"
       } \
     }' \
   

   The parameters name, target, resource_group, resource_plan_id, and service_endpoints are all required.

The host_flavor parameter defines your Compute sizing. Input the appropriate value for your desired size. To provision a Shared Compute instance, specify multitenant.

CPU and RAM autoscaling is not supported on Cloud Databases Isolated Compute. Disk autoscaling is available. If you have provisioned an Isolated instance or switched over from a deployment with autoscaling, keep an eye on your resources using IBM Cloud® Monitoring integration, which provides metrics for memory, disk space, and disk I/O utilization. To add resources to your instance, manually scale your deployment.

List of additional parameters

• backup_id- A CRN of a backup resource to restore from. The backup must be created by a database deployment with the same service ID. The backup is loaded after provisioning and the new deployment starts up that uses that data. A backup CRN is in the format crn:v1:<...>:backup:<uuid>. If omitted, the database is provisioned empty.

• version - The version of the database to be provisioned. If omitted, the database is created with the most recent major and minor version.

• disk_encryption_key_crn - The CRN of a KMS key (for example, Hyper Protect Crypto Services or Key Protect), which is then used for disk encryption. A KMS key CRN is in the format crn:v1:<...>:key:<id>.

• backup_encryption_key_crn - The CRN of a KMS key (for example, Hyper Protect Crypto Services or Key Protect), which is then used for backup encryption. A KMS key CRN is in the format crn:v1:<...>:key:<id>.

  To use a key for your backups, you must first enable the service-to-service delegation.

• members_memory_allocation_mb - Total amount of memory to be shared between the database members within the database. For example, if the value is "6144", and there are three database members, then the deployment gets 6 GB of RAM total, giving 2 GB of RAM per member. If omitted, the default value is used for the database type is used. This parameter only applies to `multitenant'.

• members_disk_allocation_mb - Total amount of disk to be shared between the database members within the database. For example, if the value is "30720", and there are three members, then the deployment gets 30 GB of disk total, giving 10 GB of disk per member. If omitted, the default value for the database type is used. This parameter only applies to `multitenant'.

• members_cpu_allocation_count - Enables and allocates the number of specified dedicated cores to your deployment. For example, to use two dedicated cores per member, use "members_cpu_allocation_count":"2". If omitted, the default value "Shared CPU" uses compute resources on shared hosts. This parameter only applies to `multitenant'.

• service_endpoints - The Service endpoints supported on your deployment, public or private.

  In the CLI, service-endpoints is a flag, not a parameter.

Provisioning with Terraform

Use Terraform to manage your infrastructure through the ibm_database Resource for Terraform supports provisioning Cloud Databases deployments.

Before executing a Terraform script on an existing instance, use the terraform plan command to compare the current infrastructure state with the desired state defined in your Terraform files. Any alteration to the resource_group_id, service plan, version, key_protect_instance, key_protect_key, backup_encryption_key_crn attributes recreates your instance. For a list of current argument references with the Forces new resource specification, see the ibm_database Terraform Registry.

To provision an instance through Isolated Compute:

data "ibm_resource_group" "group" {
  name = "<your_group>"
}
resource "ibm_database" "<your_database>" {
  name              = "<your_database_name>"
  plan              = "standard"
  location          = "eu-gb"
  service           = "databases-for-mongodb"
  resource_group_id = data.ibm_resource_group.group.id
  service_endpoints = "private"
  tags              = ["tag1", "tag2"]
  adminpassword                = "password12"
  group {
    group_id = "member"
    host_flavor {
      id = "b3c.8x32.encrypted"
    }
    disk {
      allocation_mb = 256000
    }
  }
  users {
    name     = "user123"
    password = "password12"
  }
  allowlist {
    address     = "172.168.1.1/32"
    description = "desc"
  }
}
output "ICD Etcd database connection string" {
  value = "http://${ibm_database.test_acc.ibm_database_connection.icd_conn}"
}

To provision an instance through Shared Compute:

data "ibm_resource_group" "group" {
  name = "<your_group>"
}
resource "ibm_database" "<your_database>" {
  name              = "<your_database_name>"
  plan              = "standard"
  location          = "eu-gb"
  service           = "databases-for-mongodb"
  resource_group_id = data.ibm_resource_group.group.id
  service_endpoints = "private"
  tags              = ["tag1", "tag2"]
  adminpassword                = "password12"
  group {
    group_id = "member"
    host_flavor {
      id = "multitenant"
    },
    cpu {
      allocation_count = 3
    }
    memory {
      allocation_mb = 12288
    }
    disk {
      allocation_mb = 256000
    }
  }
  users {
    name     = "user123"
    password = "password12"
  }
  allowlist {
    address     = "172.168.1.1/32"
    description = "desc"
  }
}
output "ICD Etcd database connection string" {
  value = "http://${ibm_database.test_acc.ibm_database_connection.icd_conn}"
}

The host_flavor parameter defines your Isolated Compute sizing. Input the appropriate value for your desired size. To provision a Shared Compute instance, specify multitenant.

CPU and RAM autoscaling is not supported on Cloud Databases Isolated Compute. Disk autoscaling is available. If you have provisioned an Isolated instance or switched over from a deployment with autoscaling, keep an eye on your resources using IBM Cloud® Monitoring integration, which provides metrics for memory, disk space, and disk I/O utilization. To add resources to your instance, manually scale your deployment.