|
| 1 | +<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK --> |
| 2 | +## Requirements |
| 3 | + |
| 4 | +| Name | Version | |
| 5 | +|------|---------| |
| 6 | +| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 | |
| 7 | +| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | >= 4.0 | |
| 8 | +| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 | |
| 9 | +## Usage |
| 10 | +Basic usage of this module is as follows: |
| 11 | + ```hcl |
| 12 | + module "example" { |
| 13 | + source = "<module-path>" |
| 14 | + |
| 15 | + # Optional variables |
| 16 | + admin_user = "" |
| 17 | + application_name = "devwithkrishna" |
| 18 | + compute_tier = "Free" |
| 19 | + environment = "DEV" |
| 20 | + high_availability_mode = "Disabled" |
| 21 | + location = "" |
| 22 | + mongo_create_mode = "Default" |
| 23 | + mongo_version = "7.0" |
| 24 | + mongodb_cluster_name = "" |
| 25 | + public_network_access = "Enabled" |
| 26 | + resource_group_name = "" |
| 27 | + shard_count = 1 |
| 28 | + storage_size_in_gb = 32 |
| 29 | + temporary = "TRUE" |
| 30 | + } |
| 31 | + ``` |
| 32 | + |
| 33 | +## Resources |
| 34 | + |
| 35 | +| Name | Type | |
| 36 | +|------|------| |
| 37 | +| [azurerm_mongo_cluster.mongo](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mongo_cluster) | resource | |
| 38 | +| [azurerm_resource_group.mongo_rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource | |
| 39 | +| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | |
| 40 | + |
| 41 | +## Inputs |
| 42 | + |
| 43 | +| Name | Description | Type | Required | |
| 44 | +|------|-------------|------|:--------:| |
| 45 | +| <a name="input_admin_user"></a> [admin_user](#input_admin_user) | Azure Mongo DB admin username | `string` | no | |
| 46 | +| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no | |
| 47 | +| <a name="input_compute_tier"></a> [compute_tier](#input_compute_tier) | The compute tier to assign to the MongoDB Cluster | `string` | no | |
| 48 | +| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no | |
| 49 | +| <a name="input_high_availability_mode"></a> [high_availability_mode](#input_high_availability_mode) | The high availability mode for the MongoDB Cluster | `string` | no | |
| 50 | +| <a name="input_location"></a> [location](#input_location) | Azure Mongo DB location | `string` | no | |
| 51 | +| <a name="input_mongo_create_mode"></a> [mongo_create_mode](#input_mongo_create_mode) | The create mode for the MongoDB Cluster | `string` | no | |
| 52 | +| <a name="input_mongo_version"></a> [mongo_version](#input_mongo_version) | The version of the MongoDB Cluster | `string` | no | |
| 53 | +| <a name="input_mongodb_cluster_name"></a> [mongodb_cluster_name](#input_mongodb_cluster_name) | Azure Mongo DB name | `string` | no | |
| 54 | +| <a name="input_public_network_access"></a> [public_network_access](#input_public_network_access) | Public Network Access setting for the MongoDB Cluster | `string` | no | |
| 55 | +| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Mongo DB Rg | `string` | no | |
| 56 | +| <a name="input_shard_count"></a> [shard_count](#input_shard_count) | The Number of shards to provision on the MongoDB Cluster | `number` | no | |
| 57 | +| <a name="input_storage_size_in_gb"></a> [storage_size_in_gb](#input_storage_size_in_gb) | The storage size in GB for the MongoDB Cluster | `number` | no | |
| 58 | +| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no | |
| 59 | + |
| 60 | +## Outputs |
| 61 | + |
| 62 | +| Name | Description | |
| 63 | +|------|-------------| |
| 64 | +| <a name="output_mongodb_admin_password"></a> [mongodb_admin_password](#output_mongodb_admin_password) | Azure Mongo DB admin password | |
| 65 | +| <a name="output_mongodb_admin_username"></a> [mongodb_admin_username](#output_mongodb_admin_username) | Azure Mongo DB admin username | |
| 66 | +| <a name="output_mongodb_cluster_name"></a> [mongodb_cluster_name](#output_mongodb_cluster_name) | Azure Mongo DB name | |
| 67 | +| <a name="output_mongodb_compute_tier"></a> [mongodb_compute_tier](#output_mongodb_compute_tier) | Azure Mongo DB compute tier | |
| 68 | +| <a name="output_mongodb_location"></a> [mongodb_location](#output_mongodb_location) | Azure mongo DB location | |
| 69 | +| <a name="output_mongodb_shard_count"></a> [mongodb_shard_count](#output_mongodb_shard_count) | Azure Mongo DB shard count | |
| 70 | +| <a name="output_mongodb_storage_size"></a> [mongodb_storage_size](#output_mongodb_storage_size) | Azure Mongo DB storage size in GB | |
| 71 | +| <a name="output_public_access_enabled"></a> [public_access_enabled](#output_public_access_enabled) | Azure Mongo DB enabled public access or not | |
| 72 | +| <a name="output_resource_group"></a> [resource_group](#output_resource_group) | Azure mongo DB resource group name | |
| 73 | +<!-- END_AUTOMATED_TF_DOCS_BLOCK --> |
0 commit comments