Create a Mongodb Atlas cluster with peering connection to Azure
No requirements.
Name | Version |
---|---|
mongodbatlas | 0.8.2 |
random | n/a |
The peering service principal has to be created via az
cli tool
az ad sp create --id $PEER_SP_UUID
Name | Description | Type | Default | Required |
---|---|---|---|---|
atlas_mongo_cidr | target cidr for the peering connection | string |
"" |
no |
atlas_mongo_cluster_type | Configure cluster type | string |
"REPLICASET" |
no |
atlas_mongo_offering | instance type to use | string |
"M20" |
no |
atlas_mongo_org | mongodb organization id | string |
"" |
no |
atlas_mongo_provider | Cloud provider | string |
"" |
no |
atlas_mongo_region | atlas mongo identifier for azure region | string |
"EUROPE_WEST" |
no |
atlas_mongo_replicas | replication factor | number |
3 |
no |
atlas_mongo_version | database version | string |
"" |
no |
audit_team | mongo atlas team for read only project access | string |
"" |
no |
auto_scaling_compute_enabled | Specifies wether compute up scaling is enabled. | bool |
false |
no |
auto_scaling_compute_scale_down_enabled | Specifies wether compute down scaling is enabled. | bool |
false |
no |
auto_scaling_disk_gb_enabled | Specifies whether disk auto-scaling is enabled. For M2 and M5 it must be false. | bool |
false |
no |
backup_reference_hour | hour for the first daily snapshot to be taken | number |
3 |
no |
backup_reference_minute | minute for the first daily snapshot to be taken | number |
0 |
no |
backup_retention_window_days | number of days to be able to run point-in-time recovery operations | number |
6 |
no |
daily_snapshot_frequency | number of days between snapshots | number |
3 |
no |
daily_snapshot_retention | retention in days to keep hourly snapshots | number |
15 |
no |
disk_size_gb | The size in gigabytes of the server’s root volume. Maximum possible value of 4096 (i.e., 4 TB), minimum 10GB. | number |
10 |
no |
env | environment | string |
"" |
no |
hourly_snapshot_frequency | number of hours between snapshots | number |
6 |
no |
hourly_snapshot_retention | retention in days to keep hourly snapshots | number |
1 |
no |
mongodb_collection_name | main collection name(s) | list(string) |
[] |
no |
monthly_snapshot_frequency | number of months between snapshots | number |
1 |
no |
monthly_snapshot_retention | retention in months to keep monthly snapshots | number |
6 |
no |
name | base name | string |
"" |
no |
number_of_shards | shards created per default | number |
1 |
no |
peer_cidr | cidr subnet of the vnet for peering | string |
"0.0.0.0/0" |
no |
peering_enabled | Helper variable for network peering | bool |
false |
no |
provider_auto_scaling_compute_max_instance_size | maximum instance size if scaling enabled | string |
"M20" |
no |
provider_auto_scaling_compute_min_instance_size | minimum instance size if scaling enabled | string |
"M10" |
no |
provider_backup_enabled | Set to true to enable Atlas continuous backups for the cluster | bool |
true |
no |
public_access_enabled | allow database access from everywhere | bool |
false |
no |
resource_group_name | azure resource group name | string |
"" |
no |
subscription | azure subscription id | string |
"" |
no |
team | MongoDB atlas Team for project access | string |
"" |
no |
tenant | azure ad tenant id | string |
"" |
no |
vnet_name | name of the peering vnet | string |
"" |
no |
weekly_snapshot_frequency | number of weeks between snapshots | number |
1 |
no |
weekly_snapshot_retention | retention in weeks to keep weekly snapshots | number |
4 |
no |
Name | Description |
---|---|
mongo_admin_user_password | n/a |
mongo_app_user_password | n/a |
mongo_audit_user_password | n/a |
mongodb_peering_id | n/a |
private_endpoints | n/a |