This Terraform module streamlines the creation and administration of Cosmos DB resources on Azure, offering customizable options for database accounts, consistency levels, throughput settings, and more, to ensure a highly scalable, globally distributed, and secure data management platform in the cloud.
The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.
The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.
A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.
A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.
These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.
They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.
Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.
End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.
- supports multiple mongodb databases and collections for efficient data organization
- enables management of multiple sql databases and containers
- utilization of terratest for robust validation
- supports assigning multiple user assigned identities
- integrates seamlessly with private endpoint capabilities for direct and secure connectivity
- supports both system and multiple user assigned identities
| Name | Version |
|---|---|
| terraform | ~> 1.0 |
| azurerm | ~> 4.0 |
| Name | Version |
|---|---|
| azurerm | ~> 4.0 |
| Name | Type |
|---|---|
| azurerm_cosmosdb_account.db | resource |
| azurerm_cosmosdb_mongo_collection.mongodb_collection | resource |
| azurerm_cosmosdb_mongo_database.mongodb | resource |
| azurerm_cosmosdb_sql_container.sqlc | resource |
| azurerm_cosmosdb_sql_database.sqldb | resource |
| azurerm_cosmosdb_table.tables | resource |
| azurerm_user_assigned_identity.identity | resource |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| account | n/a | any |
n/a | yes |
| location | default azure region to be used. | string |
null |
no |
| resource_group | default resource group to be used. | string |
null |
no |
| tags | tags to be added to the resources | map(string) |
{} |
no |
| Name | Description |
|---|---|
| account | n/a |
| mongodb | n/a |
| mongodb_collection | n/a |
| sql_container | n/a |
| sqldb | n/a |
| tables | n/a |
For more information, please see our testing guidelines
Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes.
Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory.
To update the module's documentation run make doc
Module is maintained by these awesome contributors.
We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.
For more information, please see our contribution guidelines.
MIT Licensed. See LICENSE for full details.