Cosmosdb l100 examples (#100)
This commit is contained in:
208
quickstart/101-cosmos-db-serverside-functionality/README.md
Normal file
208
quickstart/101-cosmos-db-serverside-functionality/README.md
Normal file
@ -0,0 +1,208 @@
|
||||
# Cosmos db serverside functionality with SQL DB
|
||||
This template deploys a cosmos db account with sql db and serverside functionality. A similar example can be created using the [azurerm/cosmosdb module](https://github.com/azure/terraform-azurerm-cosmosdb).
|
||||
|
||||
## Terraform resource types
|
||||
- [azurerm_resource_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group)
|
||||
- [azurerm_cosmosdb_account](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_account)
|
||||
- [azurerm_cosmosdb_sql_database](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_sql_database)
|
||||
- [azurerm_cosmosdb_sql_container](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_sql_container)
|
||||
- [azurerm_cosmosdb_sql_stored_procedure](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_sql_stored_procedure)
|
||||
- [azurerm_cosmosdb_sql_trigger](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_sql_trigger)
|
||||
- [azurerm_cosmosdb_sql_function](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cosmosdb_sql_function)
|
||||
|
||||
## Variables
|
||||
|
||||
| Name | Description |
|
||||
|-|-|
|
||||
| `resource_group_name` | Resource group name |
|
||||
| `resource_group_location` | Resource group location |
|
||||
| `cosmosdb_account_name` | Cosmos db account name |
|
||||
| `cosmosdb_location` | Cosmos db primary location |
|
||||
| `throughput` | DB manual throughput |
|
||||
| `sql_container_name` | Name of sql container |
|
||||
| `sql_stored_procedure_name` | Name of stored procedure |
|
||||
| `sql_trigger_name` | Name of trigger |
|
||||
| `sql_function_name` | Name of function name |
|
||||
|
||||
## Example terraform.tfvars file
|
||||
```
|
||||
resource_group_name = "rg-cosmosdb-101"
|
||||
location = "centralus"
|
||||
cosmosdb_account_name = "cosmosdb-dev-centralus-101"
|
||||
cosmosdb_account_location = "centralus"
|
||||
cosmosdb_sqldb_name = "sqlapidb"
|
||||
throughput = 400
|
||||
sql_container_name = "example-container"
|
||||
sql_stored_procedure_name = "myStoredProcedure"
|
||||
sql_trigger_name = "myPreTrigger"
|
||||
sql_function_name = "myUserDefinedFunction"
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
>terraform plan
|
||||
|
||||
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
|
||||
+ create
|
||||
|
||||
Terraform will perform the following actions:
|
||||
# azurerm_cosmosdb_account.example will be created
|
||||
+ resource "azurerm_cosmosdb_account" "example" {
|
||||
+ access_key_metadata_writes_enabled = true
|
||||
+ analytical_storage_enabled = false
|
||||
+ connection_strings = (sensitive value)
|
||||
+ create_mode = (known after apply)
|
||||
+ default_identity_type = "FirstPartyIdentity"
|
||||
+ enable_automatic_failover = false
|
||||
+ enable_free_tier = false
|
||||
+ enable_multiple_write_locations = false
|
||||
+ endpoint = (known after apply)
|
||||
+ id = (known after apply)
|
||||
+ is_virtual_network_filter_enabled = false
|
||||
+ kind = "GlobalDocumentDB"
|
||||
+ local_authentication_disabled = false
|
||||
+ location = "centralus"
|
||||
+ mongo_server_version = (known after apply)
|
||||
+ name = "cosmosdb-dev-centralus-101"
|
||||
+ network_acl_bypass_for_azure_services = false
|
||||
+ offer_type = "Standard"
|
||||
+ primary_key = (sensitive value)
|
||||
+ primary_readonly_key = (sensitive value)
|
||||
+ public_network_access_enabled = true
|
||||
+ read_endpoints = (known after apply)
|
||||
+ resource_group_name = "rg-cosmosdb-101"
|
||||
+ secondary_key = (sensitive value)
|
||||
+ secondary_readonly_key = (sensitive value)
|
||||
+ write_endpoints = (known after apply)
|
||||
|
||||
+ analytical_storage {
|
||||
+ schema_type = (known after apply)
|
||||
}
|
||||
|
||||
+ backup {
|
||||
+ interval_in_minutes = (known after apply)
|
||||
+ retention_in_hours = (known after apply)
|
||||
+ storage_redundancy = (known after apply)
|
||||
+ type = (known after apply)
|
||||
}
|
||||
|
||||
+ capabilities {
|
||||
+ name = (known after apply)
|
||||
}
|
||||
|
||||
+ capacity {
|
||||
+ total_throughput_limit = (known after apply)
|
||||
}
|
||||
|
||||
+ consistency_policy {
|
||||
+ consistency_level = "BoundedStaleness"
|
||||
+ max_interval_in_seconds = 300
|
||||
+ max_staleness_prefix = 100000
|
||||
}
|
||||
|
||||
+ geo_location {
|
||||
+ failover_priority = 0
|
||||
+ id = (known after apply)
|
||||
+ location = "centralus"
|
||||
+ zone_redundant = false
|
||||
}
|
||||
}
|
||||
|
||||
# azurerm_cosmosdb_sql_container.example will be created
|
||||
+ resource "azurerm_cosmosdb_sql_container" "example" {
|
||||
+ account_name = "cosmosdb-dev-centralus-101"
|
||||
+ database_name = "sqlapidb"
|
||||
+ default_ttl = (known after apply)
|
||||
+ id = (known after apply)
|
||||
+ name = "example-container"
|
||||
+ partition_key_path = "/definition/id"
|
||||
+ partition_key_version = 1
|
||||
+ resource_group_name = "rg-cosmosdb-101"
|
||||
+ throughput = 400
|
||||
|
||||
+ conflict_resolution_policy {
|
||||
+ conflict_resolution_path = (known after apply)
|
||||
+ conflict_resolution_procedure = (known after apply)
|
||||
+ mode = (known after apply)
|
||||
}
|
||||
|
||||
+ indexing_policy {
|
||||
+ indexing_mode = "consistent"
|
||||
|
||||
+ excluded_path {
|
||||
+ path = "/excluded/?"
|
||||
}
|
||||
|
||||
+ included_path {
|
||||
+ path = "/*"
|
||||
}
|
||||
+ included_path {
|
||||
+ path = "/included/?"
|
||||
}
|
||||
}
|
||||
|
||||
+ unique_key {
|
||||
+ paths = [
|
||||
+ "/definition/idlong",
|
||||
+ "/definition/idshort",
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
# azurerm_cosmosdb_sql_database.example will be created
|
||||
+ resource "azurerm_cosmosdb_sql_database" "example" {
|
||||
+ account_name = "cosmosdb-dev-centralus-101"
|
||||
+ id = (known after apply)
|
||||
+ name = "sqlapidb"
|
||||
+ resource_group_name = "rg-cosmosdb-101"
|
||||
+ throughput = 400
|
||||
}
|
||||
|
||||
# azurerm_cosmosdb_sql_function.example will be created
|
||||
+ resource "azurerm_cosmosdb_sql_function" "example" {
|
||||
+ body = "function tax(income){if(income==undefined)throw'no input';if(income<1000)return income*0.1;else if(income<10000)return income*0.2;else return income*0.4;}"
|
||||
+ container_id = (known after apply)
|
||||
+ id = (known after apply)
|
||||
+ name = "myUserDefinedFunction"
|
||||
}
|
||||
|
||||
# azurerm_cosmosdb_sql_stored_procedure.example will be created
|
||||
+ resource "azurerm_cosmosdb_sql_stored_procedure" "example" {
|
||||
+ account_name = "cosmosdb-dev-centralus-101"
|
||||
+ body = <<-EOT
|
||||
function () { var context = getContext(); var response = context.getResponse(); response.setBody('Hello, World'); }
|
||||
EOT
|
||||
+ container_name = "example-container"
|
||||
+ database_name = "sqlapidb"
|
||||
+ id = (known after apply)
|
||||
+ name = "myStoredProcedure"
|
||||
+ resource_group_name = "rg-cosmosdb-101"
|
||||
}
|
||||
|
||||
# azurerm_cosmosdb_sql_trigger.example will be created
|
||||
+ resource "azurerm_cosmosdb_sql_trigger" "example" {
|
||||
+ body = "function validateToDoItemTimestamp(){var context=getContext();var request=context.getRequest();var itemToCreate=request.getBody();if(!('timestamp'in itemToCreate)){var ts=new Date();itemToCreate['timestamp']=ts.getTime();}request.setBody(itemToCreate);}"
|
||||
+ container_id = (known after apply)
|
||||
+ id = (known after apply)
|
||||
+ name = "myPreTrigger"
|
||||
+ operation = "Create"
|
||||
+ type = "Pre"
|
||||
}
|
||||
|
||||
# azurerm_resource_group.example will be created
|
||||
+ resource "azurerm_resource_group" "example" {
|
||||
+ id = (known after apply)
|
||||
+ location = "centralus"
|
||||
+ name = "rg-cosmosdb-101"
|
||||
}
|
||||
|
||||
Plan: 7 to add, 0 to change, 0 to destroy.
|
||||
|
||||
Changes to Outputs:
|
||||
+ cosmosdb_account_id = (known after apply)
|
||||
+ cosmosdb_sql_database_id = (known after apply)
|
||||
|
||||
|
||||
```
|
||||
|
87
quickstart/101-cosmos-db-serverside-functionality/main.tf
Normal file
87
quickstart/101-cosmos-db-serverside-functionality/main.tf
Normal file
@ -0,0 +1,87 @@
|
||||
resource "azurerm_resource_group" "example" {
|
||||
name = var.resource_group_name
|
||||
location = var.location
|
||||
}
|
||||
|
||||
resource "azurerm_cosmosdb_account" "example" {
|
||||
name = var.cosmosdb_account_name
|
||||
location = var.cosmosdb_account_location
|
||||
resource_group_name = azurerm_resource_group.example.name
|
||||
offer_type = "Standard"
|
||||
kind = "GlobalDocumentDB"
|
||||
enable_automatic_failover = false
|
||||
geo_location {
|
||||
location = var.location
|
||||
failover_priority = 0
|
||||
}
|
||||
|
||||
consistency_policy {
|
||||
consistency_level = "BoundedStaleness"
|
||||
max_interval_in_seconds = 300
|
||||
max_staleness_prefix = 100000
|
||||
}
|
||||
|
||||
depends_on = [
|
||||
azurerm_resource_group.example
|
||||
]
|
||||
}
|
||||
|
||||
resource "azurerm_cosmosdb_sql_database" "example" {
|
||||
name = var.cosmosdb_sqldb_name
|
||||
resource_group_name = azurerm_resource_group.example.name
|
||||
account_name = azurerm_cosmosdb_account.example.name
|
||||
throughput = var.throughput
|
||||
}
|
||||
|
||||
resource "azurerm_cosmosdb_sql_container" "example" {
|
||||
name = var.sql_container_name
|
||||
resource_group_name = azurerm_resource_group.example.name
|
||||
account_name = azurerm_cosmosdb_account.example.name
|
||||
database_name = azurerm_cosmosdb_sql_database.example.name
|
||||
partition_key_path = "/definition/id"
|
||||
partition_key_version = 1
|
||||
throughput = 400
|
||||
|
||||
indexing_policy {
|
||||
indexing_mode = "consistent"
|
||||
|
||||
included_path {
|
||||
path = "/*"
|
||||
}
|
||||
|
||||
included_path {
|
||||
path = "/included/?"
|
||||
}
|
||||
|
||||
excluded_path {
|
||||
path = "/excluded/?"
|
||||
}
|
||||
}
|
||||
|
||||
unique_key {
|
||||
paths = ["/definition/idlong", "/definition/idshort"]
|
||||
}
|
||||
}
|
||||
|
||||
resource "azurerm_cosmosdb_sql_stored_procedure" "example" {
|
||||
name = var.sql_stored_procedure_name
|
||||
resource_group_name = azurerm_resource_group.example.name
|
||||
account_name = azurerm_cosmosdb_account.example.name
|
||||
database_name = azurerm_cosmosdb_sql_database.example.name
|
||||
container_name = azurerm_cosmosdb_sql_container.example.name
|
||||
body = "function () { var context = getContext(); var response = context.getResponse(); response.setBody('Hello, World'); }"
|
||||
}
|
||||
|
||||
resource "azurerm_cosmosdb_sql_trigger" "example" {
|
||||
name = var.sql_trigger_name
|
||||
container_id = azurerm_cosmosdb_sql_container.example.id
|
||||
body = "function validateToDoItemTimestamp(){var context=getContext();var request=context.getRequest();var itemToCreate=request.getBody();if(!('timestamp'in itemToCreate)){var ts=new Date();itemToCreate['timestamp']=ts.getTime();}request.setBody(itemToCreate);}"
|
||||
operation = "Create"
|
||||
type = "Pre"
|
||||
}
|
||||
|
||||
resource "azurerm_cosmosdb_sql_function" "example" {
|
||||
name = var.sql_function_name
|
||||
container_id = azurerm_cosmosdb_sql_container.example.id
|
||||
body = "function tax(income){if(income==undefined)throw'no input';if(income<1000)return income*0.1;else if(income<10000)return income*0.2;else return income*0.4;}"
|
||||
}
|
@ -0,0 +1,7 @@
|
||||
output "cosmosdb_account_id" {
|
||||
value = azurerm_cosmosdb_account.example.id
|
||||
}
|
||||
|
||||
output "cosmosdb_sql_database_id" {
|
||||
value = azurerm_cosmosdb_sql_database.example.id
|
||||
}
|
@ -0,0 +1,12 @@
|
||||
terraform {
|
||||
required_providers {
|
||||
azurerm = {
|
||||
source = "hashicorp/azurerm"
|
||||
version = ">=3.0.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
provider "azurerm" {
|
||||
features {}
|
||||
}
|
@ -0,0 +1,57 @@
|
||||
variable "resource_group_name" {
|
||||
type = string
|
||||
description = "Resource group name"
|
||||
}
|
||||
|
||||
variable "location" {
|
||||
type = string
|
||||
description = "Resource group location"
|
||||
}
|
||||
|
||||
variable "cosmosdb_account_name" {
|
||||
type = string
|
||||
description = "Cosmos db account name"
|
||||
}
|
||||
|
||||
variable "cosmosdb_account_location" {
|
||||
type = string
|
||||
description = "Cosmos db account location"
|
||||
}
|
||||
|
||||
variable "cosmosdb_sqldb_name" {
|
||||
type = string
|
||||
description = "value"
|
||||
}
|
||||
|
||||
variable "throughput" {
|
||||
type = number
|
||||
description = "Cosmos db database throughput"
|
||||
validation {
|
||||
condition = var.throughput >= 400 && var.throughput <= 1000000
|
||||
error_message = "Cosmos db manual throughput should be equal to or greater than 400 and less than or equal to 1000000."
|
||||
}
|
||||
validation {
|
||||
condition = var.throughput % 100 == 0
|
||||
error_message = "Cosmos db throughput should be in increments of 100."
|
||||
}
|
||||
}
|
||||
|
||||
variable "sql_container_name" {
|
||||
type = string
|
||||
description = "SQL API container name."
|
||||
}
|
||||
|
||||
variable "sql_stored_procedure_name" {
|
||||
type = string
|
||||
description = "Stored procedure name"
|
||||
}
|
||||
|
||||
variable "sql_trigger_name" {
|
||||
type = string
|
||||
description = "Trigger name"
|
||||
}
|
||||
|
||||
variable "sql_function_name" {
|
||||
type = string
|
||||
description = "User defined function name"
|
||||
}
|
Reference in New Issue
Block a user