Provisioning

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 cloud region. On Gen 2, Databases for MongoDB is currently available only in the Montreal (ca-mon) and Chennai - Airtel (in-che) regions.

Select the platform for your deployment.

• Gen 1: IBM Cloud®’s original platform, available across all IBM Cloud data centers.
• Gen 2: IBM Cloud®'s latest platform, based on a highly secure software-defined networking architecture. Gen 2 is optimized for cloud-native applications and currently available only in Montreal and Chennai.

For more details, see Overview of Gen 1 (Classic) and Gen 2 (VPC).

Hosting model

On Gen 2, the only available hosting model is Isolated, which is a secure single-tenant offering for complex, highly-performant enterprise workloads. For more information, see Isolated Compute.

Resource allocation

Choose the initial host size and disk configuration for your deployment. Host size and disk allocation apply per instance member.

• Host size: Select from available configurations of vCPU and RAM to match your workload needs.
• Disk: Configure the initial disk size for your deployment. Use the slider to set disk capacity. Disk size determines the IOPS allocation. Each GB of disk provides 5 IOPS.

Disk size can be increased after provisioning but cannot be decreased to prevent data loss.

Service configuration

• Database version: Set only at deployment This is the version of your MongoDB deployment. The console highlights the preferred version to ensure optimal performance. For more information, see Versioning policy.
• Database edition: Set only at deployment On Gen 2, only the Standard edition is available.
• Encryption: Set only at deployment 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[Set only at deployment - For Gen 2, only private endpoints are supported.

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

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. You can provision IBM Cloud® Databases for MongoDB instances on the Isolated Compute hosting model on the Gen 2 platform.

3. Provision your database with the following command:

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

   For example, to provision a Databases for MongoDB instance, use a command like:

   ibmcloud resource service-instance-create test-database databases-for-mongodb standard-gen2 us-south -p '{"host_flavor": "bx3d.4x20.encrypted", "storage_gb": 10 }'
   

   Provision a Databases for MongoDB Isolated instance with the same host_flavor -p parameter, setting it to the desired Isolated size. Available hosting sizes and their host_flavor value parameters are listed in Table 2.

Since the members host flavor selection includes CPU and RAM sizes (bx3d.4x20.encrypted is 4 CPU and 20 RAM), this request does not accept both, an Isolated size selection and separate CPU and RAM allocation selections.

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

You will see a response like:

```text {: codeblock}
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-mongodb:us-south: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
```    

• 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:databases-for-mongodb:us-south:a/40ddc34a953a8c02f109835656860e:dd13152c-fe15-4bb6-af94-fde0af5303f4::
  GUID:                  dd13152c-fe15-4bb6-af94-fde5654765
  Location:              <LOCATION>
  Service Name:          databases-for-mongodb
  Service Plan Name:     standard-gen2
  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 mongodb with version 7.17 (100%)
  

• Optional: To delete a service instance, run the following command:

  ibmcloud resource service-instance-delete <INSTANCE_NAME_OR_CRN>
  

The host_flavor parameter

The host_flavor parameter defines your Compute sizing.

• To provision an Isolated Compute instance, input the appropriate value for your desired CPU and RAM configuration.

  Members host flavor sizing parameter

  Host size	vCPU x RAM	host_flavor value
  4x20	4 vCPU x 20 GB RAM	bx3d.4x20.encrypted
  8x40	8 vCPU x 40 GB RAM	bx3d.8x40.encrypted
  8x80	8 vCPU x 80 GB RAM	mx3d.8x80.encrypted
  16x80	16 vCPU x 80 GB RAM	bx3d.16x80.encrypted
  32x160	32 vCPU x 160 GB RAM	bx3d.32x160.encrypted
  48x240	48 vCPU x 240 GB RAM	bx3d.48x240.encrypted

CPU and RAM autoscaling is not supported on Cloud Databases Isolated Compute. Disk autoscaling is coming soon. 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. For example, you can pass Cloud Resource Names (CRNs) as parameter values, 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 bigger host of size 16x80, the command looks like:

ibmcloud resource service-instance-create databases-for-mongodb <SERVICE_NAME> standard-gen2 us-south \
-p \ '{
  "backup_id": "crn:v1:blue:public:databases-for-mongodb:us-south:a/54e8ffe85dcedf470db5b5ee6ac4a8d8:1b8f53db-fc2d-4e24-8470-f82b15c71717:backup:06392e97-df90-46d8-98e8-cb67e9e0a8e6",
  "host_flavor": "bx3d.16x80.encrypted"
}' 

The host_flavor parameter

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

CPU and RAM autoscaling is not supported on Cloud Databases Isolated Compute. Disk autoscaling is coming soon. 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

In the --parameters object you can provide additional information to create your service instance, including:

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

Provisioning Isolated Compute with Terraform

Provision a Databases for MongoDB 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": "bx3d.4x20.encrypted"}. Note that since the host flavor selection includes CPU and RAM sizes (bx3d.4x20.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           = "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 = "bx3d.4x20.encrypted"
    }
    disk {
      allocation_mb = 256000
    }
  }
  users {
    name     = "user123"
    password = "password12"
  }
  allowlist {
    address     = "172.168.1.1/32"
    description = "desc"
  }
}
output "ICD MongoDB 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 an Isolated Compute instance, input the appropriate value for your desired CPU and RAM configuration. See the values in the following table.

CPU and RAM autoscaling is not supported on Cloud Databases Isolated Compute. Disk autoscaling is coming soon. 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.