Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Latest commit

 

History

History
171 lines (112 loc) · 4.15 KB

azure-document-db.md

File metadata and controls

171 lines (112 loc) · 4.15 KB
Raw

Azure DocumentDB Service

Azure DocumentDB is a NoSQL document database service designed from the ground up to natively support JSON and JavaScript directly inside the database engine.

Behaviors

Provision

  1. Create a DocumentDB account.

Provision-Poll

  1. Check whether creating the DocumentDB account succeeds or not. If yes then go to 2, else retry 1.

  2. Create a database.

Bind

  1. Collect credentials.

Unbind

Do nothing.

Deprovision

  1. Delete the DocumentDB account.

Deprovision-Poll

  1. Check whether deleting the DocumentDB account succeeds or not.

Create an Azure DocumentDB service

  1. Get the service name and plans
cf marketplace

Sample output:

service           plans       description
azure-documentdb  standard*   Azure DocumentDb Service

If you can not find the service name, please use the following command to make the plans public.

cf enable-service-access azure-documentdb
  1. Create a service instance

Configuration parameters are supported with the provision request. These parameters are passed in a valid JSON object containing configuration parameters, provided either in-line or in a file.

cf create-service azure-documentdb $service_plan $service_instance_name -c $path_to_parameters

Supported configuration parameters:

{
  "resourceGroup": "<resource-group-name>",        // [Required] Unique. Only allow up to 90 characters
  "docDbAccountName": "<DocumentDB-account-name>", // [Required] Unique. Can contain only lowercase letters, numbers, and the '-' character and must be between 3 and 50 characters.
  "docDbName": "<DocumentDB-database-name>",       // [Required] Unique. Can contain only lowercase letters, numbers, and the '-' character and must be between 3 and 50 characters.
  "location": "<location>"                         // [Required] e.g. eastasia, eastus2, westus, etc. You can use azure cli command 'azure location list' to list all locations.
}

For example:

cf create-service azure-documentdb standard mydocdb -c examples/documentdb-example-config.json

The contents of examples/documentdb-example-config.json:

{
  "resourceGroup": "azure-service-broker",
  "docDbAccountName": "generated-string",
  "docDbName": "generated-string",
  "location": "eastus"
}

NOTE: Please remove the comments in the JSON file before you use it.

Above parameters are also the defaults if the broker operator doesn't change broker default settings. You can just run the following command to create a service instance without the json file:

cf create-service azure-documentdb standard mydocdb
  1. Check the operation status of creating the service instance

The creating operation is asynchronous. You can get the operation status after the creating operation.

cf service $service_instance_name

For example:

cf service mydocdb

More information.

Using the services in your application

Binding

cf bind-service $app_name $service_instance_name

For example:

cf bind-service demoapp mydocdb

Format of Credentials

Verify that the credentials are set as environment variables

cf env $app_name

The credentials have the following format:

"credentials": {
  "documentdb_host_endpoint": "https://YOUR_DOCUMENTDB_NAME.documents.azure.com:443/",
  "documentdb_master_key": "YOUR_SECRET_KEY_ENDING_IN_==",
  "documentdb_database_id": "YOUR_DOCUMENTDB_NAME",
  "documentdb_database_link": "dbs/ID_ENDING_IN_==/"
}

NOTE: On AzureChinaCloud, "documentdb_host": "https://YOUR_DOCUMENTDB_NAME.documents.azure.cn:443/"

Unbinding

cf unbind-service $app_name $service_instance_name

For example:

cf unbind-service demoapp mydocdb

Delete the service instance

cf delete-service $service_instance_name -f

For example:

cf delete-service mydocdb -f