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.

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

INTMDB-206 Documentation and example updates #453

Merged
merged 6 commits into from
May 10, 2021
Merged

INTMDB-206 Documentation and example updates #453

merged 6 commits into from
May 10, 2021

Conversation

leofigy
Copy link
Contributor

@leofigy leofigy commented May 7, 2021

Description

Updating the documentation guide for migration for the cloud_provider_access_setup and adding one example to using it with the encryption_at_rest for aws.

Link to any related issue(s):

#451
#409

Type of change:

  • [] Bug fix (non-breaking change which fixes an issue)
  • [] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the Terraform contribution guidelines
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code

Further comments

@leofigy leofigy requested a review from themantissa as a code owner May 7, 2021 00:35
@leofigy leofigy self-assigned this May 7, 2021
@leofigy leofigy requested review from pitakill and coderGo93 May 7, 2021 15:05
Copy link
Collaborator

@themantissa themantissa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two very small suggested edits for clarify but otherwise LGTM!

@@ -15,6 +15,8 @@ The MongoDB Atlas provider offers two paths to perform an authorization for a cl
* 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 a single and decoupled apply.

-> **IMPORTANT** If it is needed to migrate from the single resource to the two resource paths see the [migration guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/0.9.1-upgrade-guide#migration-to-cloud-provider-access-setup)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would edit this slightly to:
If you want to move from the single resource path to the two resources path see the migration guide

@@ -57,6 +57,15 @@ resource "mongodbatlas_encryption_at_rest" "test" {
}
```

**NOTE** in case using the `cloud_provider_access_setup` and `cloud_provider_access_authorization`, could be a use case where it needs to define the `depends_on` statement for these two resources, because terraform is not able to infer.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested edit that may help clarify:
NOTE if using the two resources path for cloud provider access, cloud_provider_access_setup and cloud_provider_access_authorization, you may need to to define a depends_on statement for these two resources because terraform is not able to infer the dependency.

@leofigy leofigy requested a review from themantissa May 10, 2021 21:33
variable "atlas_region" {
default = "US_EAST_1"
description = "Atlas Region"
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same GH linter error as before

Copy link
Contributor

@coderGo93 coderGo93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@themantissa themantissa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@leofigy leofigy merged commit 1a26462 into master May 10, 2021
@leofigy leofigy deleted the INTMDB-206 branch May 10, 2021 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants