Skip to content

Make aws field optional in federated_database_instance resource and upgrade aws provider #1205

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
Merged
merged 5 commits into from
Jun 2, 2023
Merged

Make aws field optional in federated_database_instance resource and upgrade aws provider #1205

merged 5 commits into from
Jun 2, 2023

Conversation

maastha
Copy link
Collaborator

@maastha maastha commented Jun 2, 2023 •
edited
Loading

Description

Changes:

  1. Based on comments here 'aws' should be an optional field if cloudProviderConfig is not to be specified.
    - This should not be a required field if you are just creating a federated database instance to query a cluster. Added acceptance test for the same as well.

  2. Upgrade AWS ExternalProvider version in tests to address error Failed to marshal state to json: unsupported attribute "role_last_used . See AWS Terraform provider issue.

Link to any related issue(s):

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the 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

Screenshot 2023-06-02 at 11 32 34

@maastha maastha marked this pull request as ready for review June 2, 2023 10:41
@maastha maastha requested a review from a team as a code owner June 2, 2023 10:41
andreaangiolillo
andreaangiolillo reviewed Jun 2, 2023
View reviewed changes
website/docs/r/federated_database_instance.html.markdown Outdated
Comment on lines 67 to 69
* `aws` - AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket.
* `aws.0.role_id` - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas [UI](https://docs.atlas.mongodb.com/security/manage-iam-roles/) or [API](https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-get-roles/) to retrieve the role ID. You must also specify the `aws.0.test_s3_bucket`.
* `aws.0.test_s3_bucket` - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the `aws.0.role_id`.
Copy link
Collaborator

@andreaangiolillo andreaangiolillo Jun 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Could you update this field to make it a subsection as explained in CONTRIBUTING.md#documentation-best-practises? (similar to data_process_region)

Documentation Best Practises
In our documentation, when a resource field allows a maximum of only one item, we do not format that field as an array. Instead, we create a subsection specifically for this field. Within this new subsection, we enumerate all the attributes of the field. Let's illustrate this with an example: cloud_backup_schedule.html.markdown

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated

Zuhairahmed
Zuhairahmed approved these changes Jun 2, 2023
View reviewed changes
Copy link
Contributor

@Zuhairahmed Zuhairahmed left a comment

Choose a reason for hiding this comment

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

LGTM

themantissa
themantissa approved these changes Jun 2, 2023
View reviewed changes
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.

TY!

@andreaangiolillo andreaangiolillo merged commit d9e1779 into release-staging-v.1.10.0 Jun 2, 2023
Zuhairahmed added a commit that referenced this pull request Jun 12, 2023
@martinstibbe @maastha
@andreaangiolillo @Zuhairahmed @evertsd @johannaojeling @themantissa @zach-carr
Release staging v.1.10.0 (#1225)
1343855 
* fix: microsoft_teams_webhook_url keeps updating on every apply (#1148)

* INTMDB-783: Point in Time Restore is not enabled when should_copy_oplogs is set to true, when copying backups to other regions (#1150)

* Rebase v1.10.0 (#1156)

* INTMDB-710: Serverless Instance wants to do an in-place update on every run (#1152)

* INTMDB-694: Add PrivateEndpoint.srvShardOptimizedConnectionString to cluster (#1157)

* INTMDB-780: analyzer argument in Atlas search index is required (issue #1132) (#1158)

* INTMDB-809: upgrade atlas go-client to v0.26.0 (#1164)

* INTMDB-809: upgrade atlas go-client

* Update go.mod

* remain doc updates

* INTMDB-801: [Terraform] Create new TF Federated Database Instance resources and data sources (#1163)

* INTMDB-408: Remove Deprecated Resources - cloud_provider resources, private_ip_mode, NEW_RELIC and FLOWDOCK in third_party_integration resource (#1159)

* Remove deprecated resources

* Deprecate additional related resource parameters

* Add log message

* Remove mongodbatlas_private_ip_mode

* Add Full deprecation notice to Docs

* more doc updates

---------

Co-authored-by: Zuhair Ahmed <[email protected]>

* INTMDB-466 - Added is_extended_storage_sizes_enabled (#1128)

* Added is_extended_storage_sizes enabled

* Fixed lint complaints

* INTMDB-834: Address Follow Up comments in INTMDB-804 (#1181)

* node_count docs update

* INTMDB-804: [Terraform] Create new TF Data Lake Pipelines resource and data sources. (#1174)

* INTMDB-805: [Terraform] Create new TF Data Lake Pipelines Run data sources only (not resource) (#1177)

* INTMDB-803: [Terraform] Create a new Private Endpoint resource and data sources which supports Federated Database Instance and Online Archive (#1182)

* INTMDB-806: Deprecate "mongodbatlas_data_lake" and "privatelink_endpoint_service_adl" (#1190)

* Make aws field optional in federated_database_instance resource and upgrade aws provider (#1205)

* INTMDB-835: Create resource mongodbatlas_cluster_outage_simulation (#1188)

* Fix typos in docs for network peering resource imports (#1200)

* Remove delete from create update (#1209)

* INTMDB-781: [Terraform] Parameter Add: retainBackups in Cluster and Advanced_Cluster (#1210)

* INTMDB-856: Add cloudProviderConfig to mongodbatlas_federated_database_instance (#1215)

* INTMDB-655: PAK Resource Updates + Doc Cleanup + Deprecation Warnings (#1208)

* Add project_assignment feature to permit assigning multiple projects to an API key

* Add deprecation

* lint

* Add examples for project and org API key

* Add additional multi project example

* Update versions.tf

* Add deprecation message create function to remove duplicated code

* lint

* Add new deprecation message

* Bump terraform version

* Update project_api_key.html.markdown

* Update project.html.markdown

* Update docs

* Add validation of project_assignment parameter

* Create README.md

* Update README.md

* Create PAK-upgrade-guide-1.10.0.html.markdown

* Update PAK-upgrade-guide-1.10.0.html.markdown

* Update project_api_key.html.markdown

* Update website/docs/r/access_list_api_key.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/d/access_list_api_key.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update examples/atlas-api-key/create-and-assign-pak-together/README.md

Co-authored-by: zach-carr <[email protected]>

* Update examples/atlas-api-key/create-api-key-assign-to-multiple-projects/README.md

Co-authored-by: zach-carr <[email protected]>

* Update examples/atlas-api-key/README.md

Co-authored-by: zach-carr <[email protected]>

* Update website/docs/r/project.html.markdown

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update examples/atlas-api-key/create-and-assign-pak-seperately/README.md

Co-authored-by: zach-carr <[email protected]>

* Update examples/atlas-api-key/create-and-assign-pak-seperately/README.md

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update examples/atlas-api-key/create-and-assign-pak-seperately/README.md

Co-authored-by: zach-carr <[email protected]>

* Add additional deprecation note

* Update README.md

* Bump up SDK to v0.29.0

* Update README.md

More details to Readme explaining that all API keys are Organization Keys to help users

---------

Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: Melissa Plunkett <[email protected]>
Co-authored-by: zach-carr <[email protected]>

* INTMDB-533: Feature Add: Programmatically Create Organizations (#1176)

* Initial version

* Acceptance testing issue for org creation

* Add initial examples of org creation

* skip tests for moment on organization resource

* Add documentation

* typo

* terraform fmt

* lint

* go mod tidy

* Documentation updates PR feedback

* update TF version

* Update variables.tf

* Add additional Readme to show how to apply 2 step example

* Update docs

* Update examples/atlas-organization/Readme.md

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update examples/atlas-organization/Readme.md

* Update examples/atlas-organization/organization-step-1/Readme.md

* Update examples/atlas-organization/organization-step-2/Readme.md

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/r/organization.html.markdown

* Update website/docs/d/organizations.html.markdown

* Update go SDK add Org Update

* Fix broken tests

* Add isDeleted

* Update go.sum

---------

Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: Melissa Plunkett <[email protected]>

* INTMDB-802: Create new TF Data Federation Query Limit resource and data sources (#1173)

* INTMDB-802: Add data_source and resource for Federated Database Query Limit

* INTMDB-802: update provider.go

* INTMDB-802: Add AtlasDataFederation Query Limit resource

* INTMDB-802: Add AtlasDataFederation Query Limit resource

* Update data_source_mongodbatlas_federated_query_limit.go

* Update resource_mongodbatlas_federated_query_limit.go

* INTMDB-802: temp

* INTMDB-802: Add example

* INTMDB-802: Add example

* INTMDB-802: minor

* INTMDB-802: example fix

* Acceptance tests

* Acceptance tests

* Fix docs

* Update main.tf

* Update mongodbatlas/resource_mongodbatlas_federated_query_limit.go

Co-authored-by: Andrea Angiolillo <[email protected]>

* Update mongodbatlas/resource_mongodbatlas_federated_query_limit.go

Co-authored-by: Andrea Angiolillo <[email protected]>

* Update mongodbatlas/data_source_mongodbatlas_federated_query_limit.go

Co-authored-by: Andrea Angiolillo <[email protected]>

* Update mongodbatlas/resource_mongodbatlas_federated_query_limit.go

Co-authored-by: Andrea Angiolillo <[email protected]>

* Update mongodbatlas/resource_mongodbatlas_federated_query_limit.go

Co-authored-by: Andrea Angiolillo <[email protected]>

* Update website/docs/d/federated_query_limit.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/d/federated_query_limit.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/r/federated_query_limit.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/r/federated_query_limit.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/r/federated_query_limit.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/d/federated_query_limits.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update website/docs/r/federated_query_limit.html.markdown

Co-authored-by: Melissa Plunkett <[email protected]>

* Update federated_query_limit.html.markdown

* Update federated_query_limit.html.markdown

* Address PR comments

* Address PR comments

* Update website/docs/d/federated_query_limit.html.markdown

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update website/docs/d/federated_query_limits.html.markdown

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update examples/federated-database-query-limit/README.md

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update examples/federated-database-query-limit/README.md

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update examples/federated-database-query-limit/README.md

Co-authored-by: Zuhair Ahmed <[email protected]>

* Update federated_query_limit.html.markdown

* Update federated_query_limits.html.markdown

* Update README.md

* Address PR comments

* Address PR comments

* Apply suggestions from code review

Co-authored-by: zach-carr <[email protected]>

* INTMDB-805: [Terraform] Create new TF Data Lake Pipelines Run data sources only (not resource) (#1177)

* INTMDB-803: [Terraform] Create a new Private Endpoint resource and data sources which supports Federated Database Instance and Online Archive (#1182)

* Fix AWS provider version and example

* updated federated instance

* Addressed Comments

* Update mongodbatlas/data_source_mongodbatlas_federated_query_limits.go

Co-authored-by: Andrea Angiolillo <[email protected]>

* Update data_source_mongodbatlas_federated_query_limits.go

---------

Co-authored-by: Andrea Angiolillo <[email protected]>
Co-authored-by: Melissa Plunkett <[email protected]>
Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: zach-carr <[email protected]>

* Update .github_changelog_generator

* Update CHANGELOG.md

---------

Co-authored-by: maastha <[email protected]>
Co-authored-by: Andrea Angiolillo <[email protected]>
Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: Dosty Everts <[email protected]>
Co-authored-by: Johanna Öjeling <[email protected]>
Co-authored-by: Melissa Plunkett <[email protected]>
Co-authored-by: zach-carr <[email protected]>
andreaangiolillo pushed a commit that referenced this pull request Jun 12, 2023
@maastha @andreaangiolillo
Make aws field optional in federated_database_instance resource and u…
1a4cfb2 
…pgrade aws provider (#1205)
@andreaangiolillo andreaangiolillo deleted the federated_instance_aws_provider branch July 17, 2023 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andreaangiolillo andreaangiolillo andreaangiolillo left review comments

@themantissa themantissa themantissa approved these changes

@Zuhairahmed Zuhairahmed Zuhairahmed approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@maastha @themantissa @andreaangiolillo @Zuhairahmed