Provisioning

Provisioning through the catalog

Deploy from the catalog by specifying the following parameters:

• Service name - The name can be any string and is the name that is used on the web and in the CLI to identify the new deployment.
• Location - The deployment's public cloud region or Satellite location.
• Database Version Set only at deployment - The deployment version of your database. To ensure optimal performance, run the preferred version. The latest minor version is used automatically. For more information, see Database Versioning Policy.
• Resource allocation - Specify initial RAM, disk, and cores for your databases. The minimum sizes of memory and disk are selected by default. With dedicated cores, your resource group is given a single-tenant host with a minimum reserve of CPU shares. Your deployments are then allocated the number of cores you specify. Once provisioned, disk cannot be scaled down.
• Endpoints Set only at deployment - Configure the Service Endpoints on your deployment.
• The resource group - If you are organizing your services into resource groups, specify the resource group in this field. Otherwise, you can leave it at default. For more information, see Managing resource groups.
• Encryption - If you use Key Protect, an instance and key can be selected to encrypt the deployment's disk. If you do not use your own key, the deployment automatically creates and manages its own disk encryption key.

After you select the appropriate settings, click Create to start the provisioning process.

Provisioning through the CLI

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

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": "messages-for-rabbitmq-standard"
     }'
   

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

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.

• 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.

• 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.

• 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.