-
Notifications
You must be signed in to change notification settings - Fork 178
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-354: [Terraform] Update docs around what requires an API key access list #834
Conversation
Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few suggestions and we need to add to two more pages that aren't in our docs:
website/docs/r/cloud_backup_snapshot_export_bucket.html.markdown
website/docs/r/cloud_backup_snapshot_export_job.html.markdown
I just tested because I was 99% sure they would require an IP entry and they do.
website/docs/index.html.markdown
Outdated
@@ -36,6 +36,7 @@ The [MongoDB Atlas documentation](https://docs.atlas.mongodb.com/tutorial/manage | |||
|
|||
**IP access list**: Some API resources, such as backup resources, require an IP access list by default. We highly suggest that you add an IP access list as soon as possible. See [Require IP Access List for Public API](https://docs.atlas.mongodb.com/tutorial/manage-organization-settings/#require-ip-access-list-for-public-api) for more info. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove line 37, "IP access list". This was before we had before the new section you are linking to below was available.
website/docs/index.html.markdown
Outdated
@@ -36,6 +36,7 @@ The [MongoDB Atlas documentation](https://docs.atlas.mongodb.com/tutorial/manage | |||
|
|||
**IP access list**: Some API resources, such as backup resources, require an IP access list by default. We highly suggest that you add an IP access list as soon as possible. See [Require IP Access List for Public API](https://docs.atlas.mongodb.com/tutorial/manage-organization-settings/#require-ip-access-list-for-public-api) for more info. | |||
|
|||
**API Key List**: Some API resources such as Organization API Access List Entries, Cloud Backup Restores, Cloud Backup Snapshots, Cloud Backup Schedules, Legacy Backups, require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a tweak to wording to match our naming and a bit of extra explanation:
**API Key List**: Some API resources such as Organization API Access List Entries, Cloud Backup Restores, Cloud Backup Snapshots, Cloud Backup Schedules, Legacy Backups, require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) | |
**API Key Access List**: Some Atlas API resources such as Cloud Backup Restores, Cloud Backup Snapshots, and Cloud Backup Schedules **require** an Atlas API Key Access List to utilize these feature. Hence, if using Terraform, or any other programmatic control, to manage these resources you must have the IP address or CIDR block that the connection is coming from added to the Atlas API Key Access List of the Atlas API key you are using. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) |
@@ -12,6 +12,8 @@ description: |- | |||
|
|||
-> **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation. | |||
|
|||
-> **API Key List**: Some API resources require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make super specific:
-> **API Key List**: Some API resources require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details | |
-> **API Key Access List**: This resource requires an Atlas API Access Key List to utilize this feature. This means to manage this resources you must have the IP address or CIDR block that the Terraform connection is coming from added to the Atlas API Key Access List of the Atlas API key you are using. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details. |
@@ -13,6 +13,7 @@ On-demand snapshots happen immediately, unlike scheduled snapshots which occur a | |||
|
|||
-> **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation. | |||
|
|||
-> **API Key List**: Some API resources require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-> **API Key List**: Some API resources require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details | |
-> **API Key Access List**: This resource requires an Atlas API Access Key List to utilize this feature. This means to manage this resources you must have the IP address or CIDR block that the Terraform connection is coming from added to the Atlas API Key Access List of the Atlas API key you are using. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details. |
@@ -19,6 +19,7 @@ description: |- | |||
|
|||
-> **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation. | |||
|
|||
-> **API Key List**: Some API resources require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-> **API Key List**: Some API resources require an API Key list to utilize this feature. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details | |
-> **API Key Access List**: This resource requires an Atlas API Access Key List to utilize this feature. This means to manage this resources you must have the IP address or CIDR block that the Terraform connection is coming from added to the Atlas API Key Access List of the Atlas API key you are using. See [Resources that require API Key List](https://www.mongodb.com/docs/atlas/configure-api-access/#use-api-resources-that-require-an-access-list) for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Beautiful - thank you!
* Add support for use_org_and_group_names_in_export_prefix parameter (#829) * INTMDB-381: Add support to ignore export bucket when auto_export_enabled = false (#823) * Add support to ignore export bucket when auto_export_enabled = false * Update mongodbatlas/resource_mongodbatlas_cloud_backup_schedule.go Co-authored-by: Andrea Angiolillo <[email protected]> * go fmt * go fmt Co-authored-by: Andrea Angiolillo <[email protected]> * INTMDB-354: [Terraform] Update docs around what requires an API key access list (#834) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-354: [Terraform] Update docs around what requires an API key access list * Expand detail in documentation for API key list * Add additional resources that require API Key access list Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-383: [Terraform] Update the BYOK/encryption at rest resource (#832) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update key rotation alert to 90 days vs 365 Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-363: [Updated Feature] Add serverless backup to mongodbatlas_serverless_instance (#830) * Add support for ServerlessContinuousBackupEnabled * Update datasources, tests and documentation * Update docs add link for backup information * INTMDB-342: [Terraform] Update TestAccDataSourceMongoDBAtlasPrivateEndpointRegionalMode_basic test to use a new project to prevent conflicts (#837) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * MONGODB_ATLAS_NETWORK_PROJECT_ID to permit multi region testing to run in different project Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update tests related to alert configuratiopn (#836) * INTMDB-387: Enable Azure NVME for Atlas Dedicated clusters (#833) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add Azure as validation candidate for NVME * Split out Azure setting Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: Fix create index error msg (#824) * INTMDB-386 Defer project_invitation role validation to api (#840) * Update project_invitation documentation and removed validations on roles * Updated role documentation on project_invitation * Added role documentation onto the argument reference * INTMDB-347: [Terraform] cloud_backup is not being correctly imported - issue 768 (#839) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add support to migrate legacy backup parameter to cloud_backup value * Update error message Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-358: [terraform] Upgrade to go1.18 (#835) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update build to go 1.18 Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-371: PrivateLink Endpoint Timeout (#841) * Updated privatelink_endpoint CD endpoints to match refresh func timeout * Using Configured timeout times in refresh func * Updated docs to contain timeout instructions * Corrected default timeout value on privatelink_endpoint * Moved the timeout documentation to the resource * PrivateLink Endpoint documentation refers to the proper resource and includes an example * Fixed casing on Private Endpoint * Added to docs on how to learn more about timeouts * Update CHANGELOG.md * Add links * Update CHANGELOG.md Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Andrea Angiolillo <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Eliot Boutherin <[email protected]> Co-authored-by: Dosty Everts <[email protected]>
* Add support for use_org_and_group_names_in_export_prefix parameter (#829) * INTMDB-381: Add support to ignore export bucket when auto_export_enabled = false (#823) * Add support to ignore export bucket when auto_export_enabled = false * Update mongodbatlas/resource_mongodbatlas_cloud_backup_schedule.go Co-authored-by: Andrea Angiolillo <[email protected]> * go fmt * go fmt Co-authored-by: Andrea Angiolillo <[email protected]> * INTMDB-354: [Terraform] Update docs around what requires an API key access list (#834) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-354: [Terraform] Update docs around what requires an API key access list * Expand detail in documentation for API key list * Add additional resources that require API Key access list Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-383: [Terraform] Update the BYOK/encryption at rest resource (#832) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update key rotation alert to 90 days vs 365 Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-363: [Updated Feature] Add serverless backup to mongodbatlas_serverless_instance (#830) * Add support for ServerlessContinuousBackupEnabled * Update datasources, tests and documentation * Update docs add link for backup information * INTMDB-342: [Terraform] Update TestAccDataSourceMongoDBAtlasPrivateEndpointRegionalMode_basic test to use a new project to prevent conflicts (#837) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * MONGODB_ATLAS_NETWORK_PROJECT_ID to permit multi region testing to run in different project Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update tests related to alert configuratiopn (#836) * INTMDB-387: Enable Azure NVME for Atlas Dedicated clusters (#833) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add Azure as validation candidate for NVME * Split out Azure setting Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: Fix create index error msg (#824) * INTMDB-386 Defer project_invitation role validation to api (#840) * Update project_invitation documentation and removed validations on roles * Updated role documentation on project_invitation * Added role documentation onto the argument reference * INTMDB-347: [Terraform] cloud_backup is not being correctly imported - issue 768 (#839) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add support to migrate legacy backup parameter to cloud_backup value * Update error message Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-358: [terraform] Upgrade to go1.18 (#835) * Chore(deps): Bump github.com/gruntwork-io/terratest (#825) Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.40.20 to 0.40.21. - [Release notes](https://github.com/gruntwork-io/terratest/releases) - [Commits](gruntwork-io/terratest@v0.40.20...v0.40.21) --- updated-dependencies: - dependency-name: github.com/gruntwork-io/terratest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update build to go 1.18 Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * INTMDB-371: PrivateLink Endpoint Timeout (#841) * Updated privatelink_endpoint CD endpoints to match refresh func timeout * Using Configured timeout times in refresh func * Updated docs to contain timeout instructions * Corrected default timeout value on privatelink_endpoint * Moved the timeout documentation to the resource * PrivateLink Endpoint documentation refers to the proper resource and includes an example * Fixed casing on Private Endpoint * Added to docs on how to learn more about timeouts * Update CHANGELOG.md * Add links * Update CHANGELOG.md * Remove Azure unrelated EBS encryption flag for NVME disks Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Andrea Angiolillo <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Eliot Boutherin <[email protected]> Co-authored-by: Dosty Everts <[email protected]>
Description
INTMDB-354: [Terraform] Update docs around what requires an API key access list
Link to any related issue(s):
Type of change:
Required Checklist:
Further comments