feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource #2512

AgustinBettati · 2024-08-20T09:03:20Z

Description

Link to any related issue(s): CLOUDP-267659

Documentation, examples, and enabling tests in CI are handled in follow up tickets.

Note: Was not able to reproduce locally the scenario of removing private endpoint connection in networking tab (in azure key vault) and seeing a FAILED status in the Atlas API response. Following GET request continue to return pending acceptance. Will reach out to see if there is some aspect I am missing.

Running acceptance test locally:

2024-08-26T15:00:00.974+0200 [DEBUG] sdk.helper_resource: Finished TestCase: test_name=TestAccEncryptionAtRestPrivateEndpoint_basic
PASS

2024-08-26T15:24:50.315+0200 [DEBUG] sdk.helper_resource: Finished TestCase: test_name=TestAccEncryptionAtRestPrivateEndpoint_transitionPublicToPrivateNetwork
PASS

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. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
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
If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

internal/service/encryptionatrestprivateendpoint/state_transition.go

AgustinBettati · 2024-08-23T07:46:05Z

internal/service/encryptionatrestprivateendpoint/model.go

-		CloudProvider:                 tfPlan.CloudProvider.ValueStringPointer(),
-		ErrorMessage:                  tfPlan.ErrorMessage.ValueStringPointer(),
-		Id:                            tfPlan.ID.ValueStringPointer(),
-		RegionName:                    tfPlan.RegionName.ValueStringPointer(),
-		Status:                        tfPlan.Status.ValueStringPointer(),
-		PrivateEndpointConnectionName: tfPlan.PrivateEndpointConnectionName.ValueStringPointer(),
+		CloudProvider: tfPlan.CloudProvider.ValueStringPointer(),
+		RegionName:    tfPlan.RegionName.ValueStringPointer(),


computed attributes are not included as part of the request for create

aah makes sense

AgustinBettati · 2024-08-23T07:47:13Z

internal/service/encryptionatrestprivateendpoint/model_test.go

-				Status:                        admin.PtrString(testStatus),
-				PrivateEndpointConnectionName: admin.PtrString(testPEConnectionName)},
-		},
-		"Complete TF state with error message": {


case of including error message is not a real scenario when converting from terraform model to SDK model

github-actions · 2024-08-23T08:04:29Z

APIx bot: a message has been sent to Docs Slack channel

maastha · 2024-08-23T08:12:49Z

internal/common/retrystrategy/retry_state.go

+	RetryStrategyIdleState       = "IDLE"
+	RetryStrategyFailedState     = "FAILED"
+	RetryStrategyActiveState     = "ACTIVE"
+	RetryStrategyDeletedState    = "DELETED"


106846 API team is adding DELETING status FYI added you as a reviewer

EspenAlbert

Beautiful. A few nit picks only.

EspenAlbert · 2024-08-23T09:03:57Z

internal/testutil/acc/encryption_at_rest.go

+	"go.mongodb.org/atlas-sdk/v20240805001/admin"
+)
+
+func ConfigEARAzureKeyVault(projectID string, azure *admin.AzureKeyVault, useRequirePrivateNetworking bool) string {


nice refactoring to allow re-use!

internal/service/encryptionatrestprivateendpoint/resource_migration_test.go

internal/service/encryptionatrestprivateendpoint/resource_test.go

EspenAlbert · 2024-08-23T09:13:50Z

internal/common/retrystrategy/retry_state.go

+	RetryStrategyDeletedState    = "DELETED"
+
+	RetryStrategyPendingAcceptanceState = "PENDING_ACCEPTANCE"
+	RetryStrategyPendingRecreationState = "PENDING_RECREATION"


Would it make sense to remove RetryStrategy prefix? (Follow-up PR). Feels verbose repeating: retrystrategy.RetryStrategyXXX

Yes good point, have my doubts of doing it in dev branch as this would modify various resources. Can note this change down.

erabil-mdb

LGTM!

maastha · 2024-08-26T16:27:10Z

internal/service/encryptionatrestprivateendpoint/state_transition.go

+
+const (
+	defaultTimeout    = 20 * time.Minute // The amount of time to wait before timeout
+	defaultMinTimeout = 1 * time.Minute  // Smallest time to wait before refreshes


is this the default we usually have? maybe 30 sec for better UX? I'd think 1 minute might be long gap between refreshes leaving users to wonder if anything is happening

makes sense, adjusted to 30 seconds. FYI tried creation with the new refresh and it is ~2.5 min (mongodbatlas_encryption_at_rest_private_endpoint.test: Creation complete after 2m33s)

…o master (#2569) * update sdk dev (#2490) * chore: Creates TF models & interfaces for new `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2493) * chore: Creates TF models & interfaces for new `mongodbatlas_encryption_at_rest_private_endpoint` data source (#2500) * feat: Updates `mongodbatlas_encryption_at_rest` resource to use new `azure_key_vault_config.require_private_networking` field (#2509) * chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source (#2502) * feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2512) * wip - implementing CRUD * include changelog entry * small adjustments * supporting state transition logic * implement acceptance test * add unit testing for state transitions * handle return error message if failed status is present * add acceptance test transitioning for public to private network * improve messaging for failed status * fix prechecks * use global const for resource name * avoid hardcoded value * adjust state transition logic for delete * adjusting target version in migration test to 1.19.0 * adjust default refresh to 30 seconds for quicker response * feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` singular data source (#2527) * implement singular data source * including changelog entry * doc: Updates existing documentation for `mongodbatlas_encryption_at_rest` resource to be auto-generated (#2529) * doc: Include example for new `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2540) * Include example for ear with private endpoint * fix example * adjust readme * Update examples/mongodbatlas_encryption_at_rest_private_endpoint/azure/README.md Co-authored-by: maastha <[email protected]> * Update examples/mongodbatlas_encryption_at_rest_private_endpoint/azure/README.md Co-authored-by: maastha <[email protected]> * add example cli command * make use of variables to make value of resource id more compact --------- Co-authored-by: maastha <[email protected]> * feat: Implements new `mongodbatlas_encryption_at_rest_private_endpoints` data source (#2536) * temporary change to cloud provider access and getting latest sdk * implements plural data source * adapted cloud provider access with latest changes from dev preview * fix unit test * adding changelog entry * add changes to verify plural data source in basic test case * doc adjust to cloud_provider attribute * feat: Implements new `mongodbatlas_encryption_at_rest` singular data source & adds `valid` attribute for cloud provider configs in the resource (#2538) * fix: Adds error message handling to `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2544) * doc: Adds documentation for new `encryption_at_rest_private_endpoint` resource and data sources (#2547) * adding documentation for encryption_at_rest_private_endpoint resource and data sources * align generated docs * minor typo fix * Adjust description of project_id to make it more concise * align note stating feature is available by request as defined in general docs * chore: Adopt latest changes from master into ear private endpoint dev branch to adopt latest SDK (#2549) * test: Reduce instance size and use of provisioned disk iops for test that verifies transition for symmetric to asymmetric configuration (#2503) * doc: Include changelog entries to mention 2 new guides (#2506) * add entry for 2 new guides * add link * chore: Updates examples link in index.md for v1.18.0 release * chore: Updates CHANGELOG.md header for v1.18.0 release * doc: Update Atlas SP db_role_to_execute info. (#2508) * (DOCSP-41590) Updating Atlas SP db_role_to_execute info. * Update docs/resources/stream_connection.md Co-authored-by: kanchana-mongodb <[email protected]> --------- Co-authored-by: kanchana-mongodb <[email protected]> * doc: Contributing Guidelines Updates (#2494) * Contributing Guidelines Updates * Update README.md * Update README.md * Update contributing/README.md Co-authored-by: kyuan-mongodb <[email protected]> --------- Co-authored-by: kyuan-mongodb <[email protected]> * test: Simply migration test checks after 1.18.0 release and adjust version constraint in advanced_cluster examples uing new schema (#2510) * doc: Add references to the terraform modules in the resources documentations (#2513) * add references to the modules in the resources documentations * fix pr comments * chore: Bump hashicorp/setup-terraform from 3.1.1 to 3.1.2 (#2515) Bumps [hashicorp/setup-terraform](https://github.com/hashicorp/setup-terraform) from 3.1.1 to 3.1.2. - [Release notes](https://github.com/hashicorp/setup-terraform/releases) - [Changelog](https://github.com/hashicorp/setup-terraform/blob/main/CHANGELOG.md) - [Commits](hashicorp/setup-terraform@651471c...b9cd54a) --- updated-dependencies: - dependency-name: hashicorp/setup-terraform dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore: Add mention of support ticket when opening a pull request (#2507) * Add mention of creating support ticket when opening PR * rephrasing to avoid mention of priority * including suggestion * doc: Updates`mongodbatlas_advanced_cluster` ISS migration guide & resource doc with expected 500 error on update (#2525) * chore: Updates mongodbatlas_advanced_cluster tests to expect temporary SERVICE_UNAVAILABLE error when migrating from old to new schema (#2523) * doc: Fixes wordings in the new advanced_cluster sharding guide. (#2524) * chore: Updates examples link in index.md for v1.18.1 release * chore: Updates CHANGELOG.md header for v1.18.1 release * chore: upgrades go SDK from `v20240805001` to `v20240805002` (#2534) * chore: Updates to Go 1.23 (#2535) * update asdf TF version * update to Go 1.23 * update linter * update golang-ci linter * disable Go telemetry * revert TF change * chore: Bump go.mongodb.org/atlas from 0.36.0 to 0.37.0 (#2532) Bumps [go.mongodb.org/atlas](https://github.com/mongodb/go-client-mongodb-atlas) from 0.36.0 to 0.37.0. - [Release notes](https://github.com/mongodb/go-client-mongodb-atlas/releases) - [Changelog](https://github.com/mongodb/go-client-mongodb-atlas/blob/master/CHANGELOG.md) - [Commits](mongodb/go-client-mongodb-atlas@v0.36.0...v0.37.0) --- updated-dependencies: - dependency-name: go.mongodb.org/atlas dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore: Bump github.com/hashicorp/hcl/v2 from 2.21.0 to 2.22.0 (#2530) Bumps [github.com/hashicorp/hcl/v2](https://github.com/hashicorp/hcl) from 2.21.0 to 2.22.0. - [Release notes](https://github.com/hashicorp/hcl/releases) - [Changelog](https://github.com/hashicorp/hcl/blob/main/CHANGELOG.md) - [Commits](hashicorp/hcl@v2.21.0...v2.22.0) --- updated-dependencies: - dependency-name: github.com/hashicorp/hcl/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update asdf TF version to 1.9.5 (#2537) * chore: Changes deprecation message for labels attribute (#2542) * chore: Upgrades go SDK from `v20240805002` to `v20240805003` (#2545) * major version update calling gomajor tool * manual change to reincorporate v20240530005 * reverts temp changes in cloud provider resources, fixes sdk versions in new implementations --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: svc-apix-bot <[email protected]> Co-authored-by: lmkerbey-mdb <[email protected]> Co-authored-by: kanchana-mongodb <[email protected]> Co-authored-by: Zuhair Ahmed <[email protected]> Co-authored-by: kyuan-mongodb <[email protected]> Co-authored-by: rubenVB01 <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: maastha <[email protected]> Co-authored-by: Marco Suma <[email protected]> Co-authored-by: Espen Albert <[email protected]> Co-authored-by: Leo Antoli <[email protected]> Co-authored-by: Oriol <[email protected]> * doc: Adds documentation & examples for `mongodbatlas_encryption_at_rest` singular data source (#2543) * chore: Enables `mongodbatlas_encryption_at_rest` (Azure) tests to run in CI (#2551) * chore: Adds `mongodbatlas_encryption_at_rest_private_endpoint` acceptance test using azapi to approve private endpoint & check ACTIVE status (#2558) * doc: Add user journey considerations in current resource and example documentation (#2559) * minor typo fix * improve initial description in ear * adjust ear docs with mention of azure private link * private link doc adjustments * improve example * improve example * add mention in ear examples about policies * add note on update operation * link adjustments and add header for handling existing clusters * add note on private endpoint * add note in data sources * Update docs/resources/encryption_at_rest_private_endpoint.md Co-authored-by: maastha <[email protected]> * add clarification of preview flag for data sources --------- Co-authored-by: maastha <[email protected]> * update project_ip_addresses action * address doc comment --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Agustin Bettati <[email protected]> Co-authored-by: svc-apix-bot <[email protected]> Co-authored-by: lmkerbey-mdb <[email protected]> Co-authored-by: kanchana-mongodb <[email protected]> Co-authored-by: Zuhair Ahmed <[email protected]> Co-authored-by: kyuan-mongodb <[email protected]> Co-authored-by: rubenVB01 <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Marco Suma <[email protected]> Co-authored-by: Espen Albert <[email protected]> Co-authored-by: Leo Antoli <[email protected]> Co-authored-by: Oriol <[email protected]>

AgustinBettati added 2 commits August 19, 2024 18:01

wip - implementing CRUD

5538fd3

include changelog entry

3602844

AgustinBettati changed the base branch from master to CLOUDP-246459-ear-kms-dev August 20, 2024 09:03

github-actions bot added the enhancement label Aug 20, 2024

AgustinBettati added 5 commits August 20, 2024 16:37

small adjustments

b661d2f

supporting state transition logic

20d961c

implement acceptance test

fc4e776

add unit testing for state transitions

088b9bd

handle return error message if failed status is present

69ec0d1

AgustinBettati force-pushed the CLOUDP-267659 branch from 937bde2 to dd932d2 Compare August 22, 2024 21:29

add acceptance test transitioning for public to private network

83725e4

AgustinBettati force-pushed the CLOUDP-267659 branch from dd932d2 to 83725e4 Compare August 23, 2024 07:42

AgustinBettati commented Aug 23, 2024

View reviewed changes

internal/service/encryptionatrestprivateendpoint/state_transition.go Outdated Show resolved Hide resolved

AgustinBettati commented Aug 23, 2024

View reviewed changes

AgustinBettati marked this pull request as ready for review August 23, 2024 08:04

AgustinBettati requested review from a team as code owners August 23, 2024 08:04

maastha reviewed Aug 23, 2024

View reviewed changes

improve messaging for failed status

08efb0e

EspenAlbert approved these changes Aug 23, 2024

View reviewed changes

maastha approved these changes Aug 23, 2024

View reviewed changes

fix prechecks

2450088

erabil-mdb approved these changes Aug 23, 2024

View reviewed changes

AgustinBettati added 4 commits August 23, 2024 17:39

use global const for resource name

159d835

avoid hardcoded value

6313a75

adjust state transition logic for delete

4f3b650

adjusting target version in migration test to 1.19.0

c6f1403

maastha reviewed Aug 26, 2024

View reviewed changes

adjust default refresh to 30 seconds for quicker response

de5e3a7

AgustinBettati merged commit 33e18d2 into CLOUDP-246459-ear-kms-dev Aug 27, 2024
35 checks passed

AgustinBettati deleted the CLOUDP-267659 branch August 27, 2024 07:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource #2512

feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource #2512

AgustinBettati commented Aug 20, 2024 •

edited

Loading

AgustinBettati Aug 23, 2024

maastha Aug 23, 2024

AgustinBettati Aug 23, 2024

github-actions bot commented Aug 23, 2024

maastha Aug 23, 2024 •

edited

Loading

EspenAlbert left a comment •

edited

Loading

EspenAlbert Aug 23, 2024

EspenAlbert Aug 23, 2024

AgustinBettati Aug 23, 2024

erabil-mdb left a comment

maastha Aug 26, 2024

AgustinBettati Aug 27, 2024

feat: Implements mongodbatlas_encryption_at_rest_private_endpoint resource #2512

feat: Implements mongodbatlas_encryption_at_rest_private_endpoint resource #2512

Conversation

AgustinBettati commented Aug 20, 2024 • edited Loading

Description

Type of change:

Required Checklist:

Further comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Aug 23, 2024

maastha Aug 23, 2024 • edited Loading

Choose a reason for hiding this comment

EspenAlbert left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erabil-mdb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource #2512

feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource #2512

AgustinBettati commented Aug 20, 2024 •

edited

Loading

maastha Aug 23, 2024 •

edited

Loading

EspenAlbert left a comment •

edited

Loading