MongoDB Enterprise Edition Analytics Add-On

Provision using Terraform

Analytics Node and BI Connector are group attributes that can be added to a Terraform script. You can see an example here:

data "ibm_resource_group" "test_acc" {
  is_default = true
}

resource "ibm_database" "mongodb_enterprise" {
  resource_group_id = data.ibm_resource_group.test_acc.id
  name              = "test"
  service           = "databases-for-mongodb"
  plan              = "enterprise"
  location          = "us-south"
  adminpassword     = "password12"
  tags              = ["one:two"]

  group {
    group_id = "member"

    host_flavor {
      id = "b3c.8x32.encrypted"
    }

    disk {
      allocation_mb = 256000
    }
  }

  group {
    group_id = "analytics"

    members { 
      allocation_count = 1
    }
  }

  group {
    group_id = "bi_connector"

    members { 
      allocation_count = 1
    }
  }

  timeouts {
    create = "120m"
    update = "120m"
    delete = "15m"
  }
}

data "ibm_database_connection" "mongodb_conn" {
  deployment_id = ibm_database.mongodb_enterprise.id
  user_type     = "database"
  user_id       = "admin"
  endpoint_type = "public"
}

output "bi_connector_connection" {
  description = "BI Connector connection string"
  value       = data.ibm_database_connection.mongodb_conn.bi_connector.0.composed.0
}

output "analytics_connection" {
  description = "Analytics Node connection string"
  value       = data.ibm_database_connection.mongodb_conn.analytics.0.composed.0
}

For more information, see our Terraform documentation.

Remember that the Analytics Node must be scaled before the BI Connector or your request will fail.

Provisioning through the IBM Cloud Databases API

Provisioning via the API is a two-step process:

1. Create a Databases for MongoDB EE deployment.
2. After that you can add the Analytics Node and BI Connector group to your deployment by using the Scale Group method.

Example for Analytics Node:

curl --request PATCH \
  --url https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/analytics \
  --header 'Authorization: Bearer <> \
  --header 'Content-Type: application/json' \
  --data '{
    "group": {
        "members": {
            "allocation_count": 1
        }
    }
}'

Example for BI Connector:

curl --request PATCH \
  --url https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/groups/bi_connector \
  --header 'Authorization: Bearer <> \
  --header 'Content-Type: application/json' \
  --data '{
    "group": {
        "members": {
            "allocation_count": 1
        }
    }
}'

Remember that the Analytics Node must be deployed before the BI Connector or your request will fail.

To get the connection strings to connect to the Analytics Node and/or BI Connector, follow the instructions here.