Skip to content

Commit ef15073

Browse files
nikhil-mongonikhil-mongo
authored
Example added for database user scope (#327)
* modified the cluster auto-scaling documentation to make it more clear * modified the cluster auto-scaling documentation to make it more clear * add examples for the database users scope * add the database users scope example * updated cluster resource documentation to switch from legacy to cloud backups * updated cluster resources documentation for Azure disk type name * add the newline at the end
1 parent 61d9097 commit ef15073

File tree

10 files changed

+213
-2
lines changed

10 files changed

+213
-2
lines changed

‎examples/Atlas_Database_Users/.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
atlaspl.code-workspace
2+
terraform.tfvars
3+
.terraform/
4+
*.tfstate*

‎examples/Atlas_Database_Users/Readme.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Example - MongoDB Atlas Database User Scope Use
2+
3+
This project aims to provide a very straight-forward example of setting up scope on database user in MongoDB Atlas. Using this, the database user access can be limited to a cluster or data lake.
4+
5+
![MongoDB Atlas DB User](https://github.com/nikhil-mongo/atlas-database-users/blob/master/atlas-1.png?raw=true)
6+
7+
You can view the MongoDB Atlas Cluster Regions from the [documentation](https://docs.atlas.mongodb.com/cloud-providers-regions/).
8+
9+
## Dependencies
10+
11+
* Terraform v0.13
12+
* A MongoDB Atlas account - terraform-providers/mongodbatlas v0.6.5
13+
14+
## Usage
15+
16+
**1\. Ensure your MongoDB Atlas credentials are set up.**
17+
18+
This can be done using environment variables:
19+
20+
21+
```bash
22+
export MONGODB_ATLAS_PUBLIC_KEY="xxxx"
23+
export MONGODB_ATLAS_PRIVATE_KEY="xxxx"
24+
```
25+
26+
... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**.
27+
28+
**2\. Review the Terraform plan.**
29+
30+
Execute the below command and ensure you are happy with the plan.
31+
32+
``` bash
33+
$ terraform plan
34+
```
35+
This project currently does the below deployments:
36+
37+
- MongoDB cluster - M10
38+
- Creates 2 database users, with the access scope to the database and data lake.
39+
40+
**4\. Execute the Terraform apply.**
41+
42+
Now execute the plan to provision the AWS and Atlas resources.
43+
44+
``` bash
45+
$ terraform apply
46+
```
47+
48+
**5\. Destroy the resources.**
49+
50+
Once you are finished your testing, ensure you destroy the resources to avoid unnecessary charges.
51+
52+
``` bash
53+
$ terraform destroy
54+
```
55+
56+
**Important Point**
57+
58+
- Using the **terraform.tfvars** for storing the password does not shows it in the **terraform plan**. Please refer the **variables.tf** to know more and use **.tfvars** file for storing or passing the details.
59+
60+
```bash
61+
+ resource "mongodbatlas_database_user" "user2" {
62+
+ auth_database_name = "admin"
63+
+ aws_iam_type = "NONE"
64+
+ id = (known after apply)
65+
+ password = (sensitive value)
66+
...
67+
}
68+
```
69+
70+
**Output**
71+
72+
```bash
73+
Outputs:
74+
atlasclusterstring = [
75+
{
76+
"aws_private_link" = {}
77+
"aws_private_link_srv" = {}
78+
"private" = ""
79+
"private_srv" = ""
80+
"standard" = "mongodb://MongoDB_Atlas-shard-00-00.xgpi2.mongodb.net:27017,MongoDB_Atlas-shard-00-01.xgpi2.mongodb.net:27017,MongoDB_Atlas-shard-00-02.xgpi2.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-90b49a-shard-0"
81+
"standard_srv" = "mongodb+srv://MongoDB_Atlas.xgpi2.mongodb.net"
82+
},
83+
]
84+
project_name = Atlas-DB-Scope
85+
user1 = dbuser1
86+
user2 = dbuser2
87+
```

‎examples/Atlas_Database_Users/atlas-1.png

115 KB
Loading

‎examples/Atlas_Database_Users/atlas_cluster.tf

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
resource "mongodbatlas_cluster" "cluster" {
2+
project_id = mongodbatlas_project.project1.id
3+
name = "MongoDB_Atlas"
4+
num_shards = 1
5+
mongo_db_major_version = "4.4"
6+
replication_factor = 3
7+
8+
//Provider Settings "block"
9+
provider_backup_enabled = true
10+
auto_scaling_disk_gb_enabled = true
11+
provider_name = "AWS"
12+
disk_size_gb = 10
13+
provider_disk_iops = 100
14+
provider_volume_type = "STANDARD"
15+
provider_instance_size_name = "M10"
16+
provider_encrypt_ebs_volume = true
17+
provider_region_name = var.region
18+
}
19+
output "atlasclusterstring" {
20+
value = mongodbatlas_cluster.cluster.connection_strings
21+
}

‎examples/Atlas_Database_Users/database_user.tf

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
//DATABASE USER
2+
resource "mongodbatlas_database_user" "user1" {
3+
username = var.user[0]
4+
password = var.password[0]
5+
project_id = mongodbatlas_project.project1.id
6+
auth_database_name = "admin"
7+
8+
roles {
9+
role_name = "readWrite"
10+
database_name = var.database_name[0]
11+
}
12+
labels {
13+
key = "Name"
14+
value = "DB User1"
15+
}
16+
17+
scopes {
18+
name = mongodbatlas_cluster.cluster.name
19+
type = "CLUSTER"
20+
}
21+
}
22+
output "user1" {
23+
value = mongodbatlas_database_user.user1.username
24+
}
25+
//DATA LAKE USER
26+
resource "mongodbatlas_database_user" "user2" {
27+
username = var.user[1]
28+
password = var.password[1]
29+
project_id = mongodbatlas_project.project1.id
30+
auth_database_name = "admin"
31+
32+
roles {
33+
role_name = "readWrite"
34+
database_name = var.database_name[1]
35+
}
36+
labels {
37+
key = "Name"
38+
value = "DB User2"
39+
}
40+
41+
scopes {
42+
name = var.data_lake
43+
type = "DATA_LAKE"
44+
}
45+
}
46+
output "user2" {
47+
value = mongodbatlas_database_user.user2.username
48+
}

‎examples/Atlas_Database_Users/project.tf

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
resource "mongodbatlas_project" "project1" {
2+
name = "Atlas-DB-Scope"
3+
org_id = var.org_id
4+
}
5+
output "project_name" {
6+
value = mongodbatlas_project.project1.name
7+
}

‎examples/Atlas_Database_Users/provider.tf

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
provider "mongodbatlas" {
2+
public_key = var.public_key
3+
private_key = var.private_key
4+
}

‎examples/Atlas_Database_Users/variables.tf

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
variable "public_key" {
2+
description = "Public API key to authenticate to Atlas"
3+
}
4+
variable "private_key" {
5+
description = "Private API key to authenticate to Atlas"
6+
}
7+
variable "user" {
8+
description = "MongoDB Atlas User"
9+
type = list(string)
10+
default = ["dbuser1", "dbuser2"]
11+
}
12+
variable "password" {
13+
description = "MongoDB Atlas User Password"
14+
type = list(string)
15+
}
16+
variable "database_name" {
17+
description = "The Database in the cluster"
18+
type = list(string)
19+
}
20+
variable "data_lake" {
21+
description = "The datalake name"
22+
}
23+
variable "org_id" {
24+
description = "MongoDB Organization ID"
25+
}
26+
variable "region" {
27+
description = "MongoDB Atlas Cluster Region"
28+
}

‎examples/Atlas_Database_Users/versions.tf

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
terraform {
2+
required_providers {
3+
mongodbatlas = {
4+
source = "terraform-providers/mongodbatlas"
5+
}
6+
}
7+
required_version = ">= 0.13"
8+
}

‎website/docs/r/cluster.html.markdown

+6-2
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,11 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif
232232
* `backup_enabled` - (Optional) Legacy Backup - Set to true to enable Atlas legacy backups for the cluster.
233233
**Important** - MongoDB deprecated the Legacy Backup feature. Clusters that use Legacy Backup can continue to use it. MongoDB recommends using [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/).
234234
* Any net new Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backup, `provider_backup_enabled`, to enable Cloud Backup. If you create a new Atlas cluster and set `backup_enabled` to true, the Provider will respond with an error. This change doesn’t affect existing clusters that use legacy backups.
235-
* Set to false to disable legacy backups for the cluster. Atlas deletes any stored snapshots.
235+
* Setting this value to false to disable legacy backups for the cluster will let Atlas delete any stored snapshots. In order to preserve the legacy backups snapshots, disable the legacy backups and enable the cloud backups in the single **terraform apply** action.
236+
```
237+
backup_enabled = "false"
238+
provider_backup_enabled = "true"
239+
```
236240
* The default value is false. M10 and above only.
237241

238242
* `bi_connector` - (Optional) Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See [BI Connector](#bi-connector) below for more details.
@@ -274,7 +278,7 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif
274278
- AZURE - Microsoft Azure
275279

276280
* `provider_disk_iops` - (Optional) The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected `provider_instance_size_name` and `disk_size_gb`.
277-
* `provider_disk_type_name` - (Optional - Azure Only) Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
281+
* `provider_disk_type_name` - (Optional - Azure Only) Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
278282
* `provider_encrypt_ebs_volume` - (Optional- AWS ONLY) If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. **Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default**.
279283
* `provider_region_name` - (Optional) Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the **Atlas region name**, see the reference list for [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
280284
Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

0 commit comments

Comments
 (0)