Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: documentation errors in cloud provider access #1615

Merged
merged 5 commits into from
Nov 15, 2023
Merged

doc: documentation errors in cloud provider access #1615

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2024f52
doc: Fix typos and syntax errors
Nov 10, 2023
0ec5400
doc: Add details about how this resource can be used
Nov 10, 2023
22796a1
Update website/docs/r/cloud_provider_access.markdown
milh0use Nov 13, 2023
7eb3bf1
doc: Add references to documentation in Github
Nov 13, 2023
55c8d6a
Update website/docs/r/cloud_provider_access.markdown
milh0use Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 5 additions & 7 deletions website/docs/r/cloud_provider_access.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ The Terraform MongoDB Atlas Provider offers two either-or/mutually exclusive pat
* A Two Resource path: consisting of `mongodbatlas_cloud_provider_access_setup` and `mongodbatlas_cloud_provider_access_authorization`. The first resource, `mongodbatlas_cloud_provider_access_setup`, only generates
the initial configuration (create, delete operations). The second resource, `mongodbatlas_cloud_provider_access_authorization`, helps to perform the authorization using the role_id of the first resource. This path is helpful in a multi-provider Terraform file, and allows for a single and decoupled apply. See example of this Two Resource path option with AWS Cloud [here](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/atlas-cloud-provider-access/aws) and AZURE Cloud [here](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/atlas-cloud-provider-access/azure).

* A Single Resource path: using the `mongodbatlas_cloud_provider_access` that at provision time sets up all the required configuration for a given provider, then with a subsequent update it can perform the authorize of the role. Note this path requires two `terraform apply` commands, once for setup and once for auth. This resource supports only `AWS`.
* A Two Resource path: consisting of `mongodbatlas_cloud_provider_access_setup` and `mongodbatlas_cloud_provider_access_authorization`. The first resource, `mongodbatlas_cloud_provider_access_setup`, only generates
the initial configuration (create, delete operations). The second resource, `mongodbatlas_cloud_provider_access_authorization`, helps to perform the authorization using the role_id of the first resource. This path is helpful in a multi-provider Terraform file, and allows for a single and decoupled apply. See example of this Two Resource path option with AWS Cloud [here](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/atlas-cloud-provider-access/aws) and AZURE Cloud [here](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/atlas-cloud-provider-access/azure).

* A Single Resource path: using the `mongodbatlas_cloud_provider_access` that at provision time sets up all the required configuration for a given provider, then with a subsequent update it can perform the authorize of the role. Note this path requires two `terraform apply` commands, once for setup and once for auth. This resource supports only `AWS`.
**WARNING:** The resource `mongodbatlas_cloud_provider_access` is deprecated and will be removed in version v1.14.0, use the Two Resource path instead.

Expand Down Expand Up @@ -77,6 +73,8 @@ resource "mongodbatlas_cloud_provider_access_setup" "test_role" {
* `last_updated_date` - Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
* `role_id` - Unique ID of this role.

-> **NOTE:** Code examples of how the mongodbatlas_cloud_provider_access_setup resource and its attributes should be used to permit Atlas to access resources in your own cloud provider accounts are in Github, for [AWS](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/atlas-cloud-provider-access/aws) and for [Azure](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/atlas-cloud-provider-access/azure)
milh0use marked this conversation as resolved.
Show resolved Hide resolved

## Import: mongodbatlas_cloud_provider_access_setup
For consistency is has the same format as the regular mongodbatlas_cloud_provider_access resource
can be imported using project ID and the provider name and mongodbatlas role id, in the format
Expand All @@ -86,7 +84,7 @@ can be imported using project ID and the provider name and mongodbatlas role id,
$ terraform import mongodbatlas_cloud_provider_access_setup.my_role 1112222b3bf99403840e8934-AWS-5fc17d476f7a33224f5b224e
```

## mongodbatlas_cloud_provider_authorization
## mongodbatlas_cloud_provider_access_authorization

This is the second resource in the two-resource path as described above.
`mongodbatlas_cloud_provider_access_authorization` Allows you to authorize an AWS or AZURE IAM roles in Atlas.
Expand All @@ -104,8 +102,8 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth_role" {
project_id = mongodbatlas_cloud_provider_access_setup.setup_only.project_id
role_id = mongodbatlas_cloud_provider_access_setup.setup_only.role_id

aws_config {
atlas_aws_account_arn = "arn:aws:iam::772401394250:role/test-user-role"
aws {
iam_assumed_role_arn = "arn:aws:iam::772401394250:role/test-user-role"
}
}

Expand Down