IBM Cloud Docs
Provisioning

Provisioning

Provision a IBM Cloud® Messages for RabbitMQ deployment through the catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or through Terraform.

Provisioning through the IBM Cloud console

Provision from the console by specifying the following parameters.

Service details

  • 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.
  • 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.
  • Location - The deployment's public cloud region or Satellite location.

Hosting model

  • Isolated: Secure single-tenant offering for complex, highly-performant enterprise workloads.
  • Shared: Flexible multi-tenant offering for dynamic, fine-tuned, and decoupled capacity selections.
    For more information, see Hosting models.

Resource allocation

Fine tune your resource allocation. The available options differ based on your selected hosting model.

  • Isolated: Use the table to choose the machine size for each member of your deployment, and specify the disk size.
  • Shared: By default, the smallest possible resource allocation is selected. This is ideal for small applications or testing. For larger allocations, select the Custom tile, which allows flexible resource configuration with 2+ cores.

The Shared Compute hosting model supports more fine-grained resource allocations that are not shown in the UI to maintain clarity. For more information, see Hosting models.

Specify the disk size depending on your requirements. It can be increased after provisioning but cannot be decreased to prevent data loss.

Service configuration

  • 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.
  • 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.
  • Endpoints - Set only at deployment Configure the Service endpoints on your deployment. The default setting is private.

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

Provisioning through the CLI

Create a service instance through the CLI

Before provisioning, follow the instructions provided in the documentation to install the IBM Cloud CLI tool.

  1. Log in to IBM Cloud. If you use a federated user ID, it's important that you switch to a one-time passcode (ibmcloud login --sso), or use an API key (ibmcloud --apikey key or @key_file) to authenticate. For more information about how to log in by using the CLI, see General CLI (ibmcloud) commands under ibmcloud login.

    ibmcloud login

  2. Select the hosting model you want your database to be provisioned on. You can change this later.

  3. Provision your database with the following command:

    ibmcloud resource service-instance-create <INSTANCE_NAME> <SERVICE_NAME> <SERVICE_PLAN_NAME> <LOCATION> <RESOURCE_GROUP> -p '{"members_host_flavor": "<members_host_flavor value>"}' --service-endpoints="<endpoint>"

    For example, to provision a Messages for RabbitMQ Shared Compute hosting model instance, use a command like:

    ibmcloud resource service-instance-create test-database messages-for-rabbitmq standard us-south -p '{"members_host_flavor": "multitenant", "members_memory_allocation_mb": "24576"}' --service-endpoints="private"

    Provision a Messages for RabbitMQ Isolated instance with the same "members_host_flavor" -p parameter, setting it to the desired Isolated size. Available hosting sizes and their members_host_flavor value parameters are listed in Table 2. 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.

    ibmcloud resource service-instance-create test-database messages-for-rabbitmq standard us-south -p '{"members_host_flavor": "b3c.4x16.encrypted"}' --service-endpoints="private"

    The fields in the command are described in the table that follows.

    Basic command format fields
    Field Description Flag
    NAME Required The instance name can be any string and is the name that is used on the web and in the CLI to identify the new deployment.
    SERVICE_NAME Required Name or ID of the service. For Messages for RabbitMQ, use messages-for-rabbitmq.
    SERVICE_PLAN_NAME Required Standard plan (standard)
    LOCATION Required The location where you want to deploy. To retrieve a list of regions, use the ibmcloud regions command.
    RESOURCE_GROUP The Resource group name. The default value is default. -g
    --parameters JSON file or JSON string of parameters to create service instance -p
    members_host_flavor To provision an Isolated or Shared Compute instance, use {"members_host_flavor": "<members_host_flavor value>"}. For Shared Compute, specify multitenant. For Isolated Compute, select desired CPU and RAM configuration. For more information, see the table below or Hosting models.
    --service-endpoints Required Configure the Service endpoints of your deployment, either public, private or public-and-private.

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

The members host flavor parameter

The members_host_flavor parameter defines your Compute sizing. To provision a Shared Compute instance, specify multitenant. To provision an Isolated Compute instance, input the appropriate value for your desired CPU and RAM configuration.

Members host flavor sizing parameter
Members host flavor members_host_flavor value
Shared Compute multitenant
4 CPU x 16 RAM b3c.4x16.encrypted
8 CPU x 32 RAM b3c.8x32.encrypted
8 CPU x 64 RAM m3c.8x64.encrypted
16 CPU x 64 RAM b3c.16x64.encrypted
32 CPU x 128 RAM b3c.32x128.encrypted
30 CPU x 240 RAM m3c.30x240.encrypted

You will see a response like:

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:messages-for-rabbitmq: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

  1. To check provisioning status, use the following command:

    ibmcloud resource service-instance <INSTANCE_NAME>

    When complete, you will see a response like:

    Retrieving service instance INSTANCE_NAME in resource group default under account USER's Account as USER...
OK

Name:                  INSTANCE_NAME
ID:                    crn:v1:bluemix:public:messages-for-rabbitmq:us-east:a/40ddc34a953a8c02f109835656860e:dd13152c-fe15-4bb6-af94-fde0af5303f4::
GUID:                  dd13152c-fe15-4bb6-af94-fde5654765
Location:              <LOCATION>
Service Name:          messages-for-rabbitmq
Service Plan Name:     standard
Resource Group Name:   default
State:                 active
Type:                  service_instance
Sub Type:              Public
Locked:                false
Service Endpoints:     private
Created at:            2023-06-26T19:42:07Z
Created by:            USER
Updated at:            2023-06-26T19:53:25Z
Last Operation:
                       Status    create succeeded
                       Message   Provisioning messages-for-rabbitmq with version 12 (100%)

  2. (Optional) Delete an instance by running a command like this one:

    ibmcloud resource service-instance-delete <INSTANCE_NAME_OR_CRN>

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.

The --parameters parameter

The service-instance-create command supports a -p flag, which allows JSON-formatted parameters to be passed to the provisioning process. Some parameter values are Cloud Resource Names (CRNs), which uniquely identify a resource in the cloud. All parameter names and values are passed as strings.

For example, if a database is being provisioned from a particular backup and the new database deployment needs a total of 12 GB of memory across three members, then the command to provision 4 GBs per member looks like:

ibmcloud resource service-instance-create messages-for-rabbitmq <INSTANCE_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": "8192"}' --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

  4. Select the hosting model you want your database to be provisioned on. You can change this later.

    A host flavor represents fixed sizes of guaranteed resource allocations. To see which host flavors are available in your region, call the host flavors capability endpoint like this:

    curl -X POST  https://api.{region}.databases.cloud.ibm.com/v5/ibm/    capability/flavors  \
  -H 'Authorization: Bearer <>' \
  -H 'ContentType: application/json' \
  -d '{
    "deployment": {
      "type": "messages-for-rabbitmq",
      "location": "us-south"
    },
  }'

    This returns:

    {
  "deployment": {
    "type": "messages-for-rabbitmq",
    "location": "us-south",
    "platform": "classic"
  },
  "capability": {
    "flavors": [
      {
        "id": "b3c.4x16.encrypted",
        "name": "4x16",
        "cpu": {
          "allocation_count": 4
        },
        "memory": {
          "allocation_mb": 16384
        },
        "hosting_size": "xs"
      },
      {
        "id": "b3c.8x32.encrypted",
        "name": "8x32",
        "cpu": {
          "allocation_count": 8
        },
        "memory": {
          "allocation_mb": 32768
        },
        "hosting_size": "s"
      },
      {
        "id": "m3c.8x64.encrypted",
        "name": "8x64",
        "cpu": {
          "allocation_count": 8
        },
        "memory": {
          "allocation_mb": 65536
        },
        "hosting_size": "s+"
      },
      {
        "id": "b3c.16x64.encrypted",
        "name": "16x64",
        "cpu": {
          "allocation_count": 16
        },
        "memory": {
          "allocation_mb": 65536
        },
        "hosting_size": "m"
      },
      {
        "id": "b3c.32x128.encrypted",
        "name": "32x128",
        "cpu": {
          "allocation_count": 32
        },
        "memory": {
          "allocation_mb": 131072
        },
        "hosting_size": "l"
      },
      {
        "id": "m3c.30x240.encrypted",
        "name": "30x240",
        "cpu": {
          "allocation_count": 30
        },
        "memory": {
          "allocation_mb": 245760
        },
        "hosting_size": "xl"
      },
      {
        "id": "multitenant",
        "name": "multitenant",
        "cpu": {
          "allocation_count": 0
        },
        "memory": {
          "allocation_mb": 0
        },
        "hosting_size": ""
      }
    ]
  }
}

    As shown, the Isolated Compute host flavors available to a Messages for RabbitMQ instance in the us-south region are:

    • b3c.4x16.encrypted
    • b3c.8x32.encrypted
    • m3c.8x64.encrypted
    • b3c.16x64.encrypted
    • b3c.32x128.encrypted
    • m3c.30x240.encrypted

    To provision or scale your instance to 4 CPUs and 16384 megabytes or RAM, submit the following command:

    {
      "member_host_flavor": "b3c.4x16.encrypted"
 }

    To scale your instance up to 8 CPUs and 32768 megabytes of RAM, submit the following command:

    {
      "member_host_flavor": "b3c.8x32.encrypted"
}

    1. 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": "<INSTANCE_NAME",
    "target": "<LOCATION>",
    "resource_group": "RESOURCE_GROUP_ID",
    "resource_plan_id": "<SERVICE_PLAN_NAME>"
    "parameters": {
        "members_host_flavor": "<members_host_flavor_value>"
        "service_endpoints":"<endpoint>",
        "version":"<verison>"
    }
  }'

To make a Shared Compute instance, follow this example:

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": "us-south",
    "resource_group": "5g9f447903254bb58972a2f3f5a4c711",
    "resource_plan_id": "messages-for-rabbitmq-standard"
    "parameters": {
     "members_host_flavor": "multitenant", 
     "members_memory_allocation_mb": 12288, 
     "members_cpu_allocation_count": 3
   }
  }'

Provision a Messages for RabbitMQ 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. 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 <>" \
  -H 'Content-Type: application/json' \
    -d '{
    "name": "my-instance",
    "target": "us-south",
    "resource_group": "5g9f447903254bb58972a2f3f5a4c711",
    "resource_plan_id": "messages-for-rabbitmq-standard"
    "parameters": {
    "members_host_flavor": "b3c.4x16.encrypted"
   }
  }'

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

The fields in the command are described in the table that follows.

Basic command format fields
Field Description Flag
NAME Required The instance name can be any string and is the name that is used on the web and in the CLI to identify the new deployment.
SERVICE_NAME Required Name or ID of the service. For Messages for RabbitMQ, use messages-for-rabbitmq.
SERVICE_PLAN_NAME Required standard
TARGET Required The location where you want to deploy. To retrieve a list of regions, use the ibmcloud regions command.
SERVICE_ENDPOINTS_TYPE Configure the Service endpoints of your deployment, either public or private. The default value is public.
RESOURCE_GROUP The Resource group name. The default value is default. -g
--parameters JSON file or JSON string of parameters to create service instance -p
members_host_flavor To provision an Isolated or Shared Compute instance, use {"members_host_flavor": "<members_host_flavor value>"}. For Shared Compute, specify multitenant. For Isolated Compute, select desired CPU and RAM configuration. For more information, see the table below, or Hosting models.

The members host flavor parameter

The members_host_flavor parameter defines your Compute sizing. To provision a Shared Compute instance, specify multitenant. To provision an Isolated Compute instance, input the appropriate value for your desired CPU and RAM configuration.

Members host flavor sizing parameter
Members host flavor members_host_flavor value
Shared Compute multitenant
4 CPU x 16 RAM b3c.4x16.encrypted
8 CPU x 32 RAM b3c.8x32.encrypted
8 CPU x 64 RAM m3c.8x64.encrypted
16 CPU x 64 RAM b3c.16x64.encrypted
32 CPU x 128 RAM b3c.32x128.encrypted
30 CPU x 240 RAM m3c.30x240.encrypted

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 "12288", and there are three database members, then the deployment gets 12 GB of RAM total, giving 4 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'.

Provisioning with Terraform

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.

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

Select the hosting model you want your database to be provisioned on. You can change this later.

Provision a Messages for RabbitMQ Shared hosting model instance with the "host_flavor" parameter set to multitenant. See the following example:

data "ibm_resource_group" "group" {
  name = "<your_group>"
}
resource "ibm_database" "<your_database>" {
  name              = "<your_database_name>"
  plan              = "standard"
  location          = "eu-gb"
  service           = "messages-for-rabbitmq"
  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}"
}

Provision a Messages for RabbitMQ Isolated instance with the same "host_flavor" parameter, setting it to the desired Isolated size. Available hosting sizes and their host_flavor value parameters are listed in Table 1. For example, {"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.

data "ibm_resource_group" "group" {
  name = "<your_group>"
}
resource "ibm_database" "<your_database>" {
  name              = "<your_database_name>"
  plan              = "standard"
  location          = "eu-gb"
  service           = "messages-for-rabbitmq"
  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}"
}

The host flavor parameter

The host_flavor parameter defines your Compute sizing. To provision a Shared Compute instance, specify multitenant. To provision an Isolated Compute instance, input the appropriate value for your desired CPU and RAM configuration.

Host Flavor sizing parameter
Host flavor host_flavor value
Shared Compute multitenant
4 CPU x 16 RAM b3c.4x16.encrypted
8 CPU x 32 RAM b3c.8x32.encrypted
8 CPU x 64 RAM m3c.8x64.encrypted
16 CPU x 64 RAM b3c.16x64.encrypted
32 CPU x 128 RAM b3c.32x128.encrypted
30 CPU x 240 RAM m3c.30x240.encrypted

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.