Skip to content

INTMDB-434 - Fixed private_endpoint output documentation #907

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

Merged
merged 12 commits into from
Nov 29, 2022

Conversation

evertsd
Copy link
Contributor

@evertsd evertsd commented Nov 8, 2022

Description

Updated documentation on cluster connection_strings to contain instructions on how to output a private_endpoint srv_connection_string given an endpoint_id

Closes #713

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

@evertsd evertsd requested a review from a team as a code owner November 8, 2022 21:52
@evertsd evertsd changed the base branch from release-staging-v1.5.1 to release-staging-v1.6.0 November 9, 2022 20:28
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.

Since we have GCP PSC as well now should we add that example too?

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.

Can we move this to v1.6.1 release branch?

@evertsd evertsd changed the base branch from release-staging-v1.6.0 to release-staging-v1.6.1 November 15, 2022 19:05
@evertsd evertsd force-pushed the release-staging-v1.6.1 branch from a2ba298 to 7c813e6 Compare November 17, 2022 18:54
@evertsd
Copy link
Contributor Author

evertsd commented Nov 19, 2022

@themantissa I changed the format a bit to be a generic example for getting a connection_string from a endpoint_service_id.

The specific example given is for GCP, however it would work for Azure, AWS, or whatever other theoretical provider depending on how the endpoint_service_id is set.

Then I've linked to full examples for AWS, Azure, and GCP.

@martinstibbe martinstibbe added the not_stale Not stale issue or PR label Nov 29, 2022
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.

Few minor edits and added a few formatting/typo commits directly. Also can you update Advanced Cluster docs as you did with Cluster to add the entire Return Connection String examples to help users?

Example - Return a Connection String

evertsd and others added 2 commits November 29, 2022 11:12
Copy updates on example readme

Co-authored-by: Zuhair Ahmed <[email protected]>
@evertsd
Copy link
Contributor Author

evertsd commented Nov 29, 2022

Thanks for the feedback and suggestions @Zuhairahmed -- I've implemented and applied them.

@evertsd evertsd requested a review from Zuhairahmed November 29, 2022 17:53
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! Thanks @evertsd feel free to merge

@evertsd evertsd merged commit 92b0373 into release-staging-v1.6.1 Nov 29, 2022
Zuhairahmed added a commit that referenced this pull request Dec 1, 2022
* INTMDB-438 ForceNew on cluster name change (#902)

* Added ForceNew for name on Cluster

* Updated documentation to include information on name changes for cluster

* INTMDB-481: Add support for identity provider display name import (#924)

* Add support for identity provider display name import

* Update example for mongodbatlas_federated_settings_org_config

* Update documentation for mongodbatlas_federated_settings_org_configs

* Remove confusing verbiage

* INTMDB-498: Updated Prometheus Example (#942)

* Serverless Endpoint Service Doc Bug (#930)

* Update CHANGELOG.md

* Chore(deps): Bump github.com/gruntwork-io/terratest (#936)

Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.41.0 to 0.41.3.
- [Release notes](https://github.com/gruntwork-io/terratest/releases)
- [Commits](gruntwork-io/terratest@v0.41.0...v0.41.3)

---
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 additional context for prometheus example

* Update Readme.md

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* INTMDB-484: Skip tests for OPS GENIE and GOV (#937)

* Serverless Endpoint Service Doc Bug (#930)

* Update CHANGELOG.md

* Skip broken OPS_GENIE token and GOV tests in main ACC test run

* make fmt

* Remove comment

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

* INTMDB-438 ForceNew on cluster name change (#929)

* Added ForceNew for name on Cluster

* Updated documentation to include information on name changes for cluster

* INTMDB-434 - Fixed private_endpoint output documentation (#907)

* Fixed documentation to include more accurate information on how to output a private_endpoint by endpoint_id

* Updated cluster docs to have a generic example for getting connection_string from endpoint_service_id, and links to full examples for AWS, AZURE, and GCP

* Updated examples to have a reference to a cluster, optionally, in order to extract the connection strings

* Updated readme to contain information on the optional cluster_name variable

* Removed moved documentation and added example output in comment

* formatting

* formatting -GCP

* Typo fix

* typo fix - azure

* Apply suggestions from code review

Copy updates on example readme

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

* Updated advanced_cluster documentation to have information on getting connection string

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

* INTMDB-493: Serverless Private Endpoint Connection String Example Fix (#940)

* Serverless Endpoint Service Doc Bug (#930)

* Update CHANGELOG.md

* Change connection_strings_private_srv to a list of connections

* Update connection_strings_private_srv to connection_strings_private_endpoint_srv

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

* INTMDB-426: Alert Configuration -- Api Token erroneous changes (#941)

* Serverless Endpoint Service Doc Bug (#930)

* Update CHANGELOG.md

* Ignore API keys after apply

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

* INTMDB-368: Shorten test names that are too long to allow for targeting specific tests (#932)

* Serverless Endpoint Service Doc Bug (#930)

* Update CHANGELOG.md

* Split tests in segments to permit retry failed test areas in less time

* Change Regex

* skip TestAccConfigRSThirdPartyIntegration_basic

* skip TestAccNetworkRSPrivateEndpointRegionalMode_basic

* Skip Gov tests during regular test run

* Skip OPS_GENIE test

* Change skip test method

* Split out cluster RS and DS

* Single thread private link ADL tests that conflict during parallel execution

* Split out Clusters

* Lower max number of tests to run at once

* Lower concurrent jobs due to cluster limits

* Chain job deps to enforce order

* Combine Clusters back into one workflow

* Skip TestAccClusterRSAdvancedCluster_Paused

* go fmt

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

* INTMDB-463 Cluster container_id documentation (#931)

* container_id documentation updated to reflect that it's a computed field

* Updated documentation around network_peering

* Moved container_id to attribute reference

* Fixed documentation reference

* INTMDB-478: Auto-Generate Changelog (#944)

* Serverless Endpoint Service Doc Bug (#930)

* Update CHANGELOG.md

* Chore(deps): Bump github.com/gruntwork-io/terratest (#936)

Bumps [github.com/gruntwork-io/terratest](https://github.com/gruntwork-io/terratest) from 0.41.0 to 0.41.3.
- [Release notes](https://github.com/gruntwork-io/terratest/releases)
- [Commits](gruntwork-io/terratest@v0.41.0...v0.41.3)

---
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>

* Create .github_changelog_generator

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* INTMDB-465 - PrivateLink Endpoint Service & Connection Strings (#943)

* INTMDB-384 Fix PrivateLink test flakiness (#895)

* Using different endpointID values for the endpoint service adl tests

* Removed parallelization with private link endpoint test which had overlap with others

* Reverted changes to the endpointID

* Waiting for Clusters to be idle on pes create

* Formatted and added Deleted as a target status

* Removed unintended changes

* Updated Delete to use TimeoutDelete

* Utilizing error when ClusterListAdvancedRefreshFunc fails

* Updated RefreshFunc to just return PENDING if cluster is not IDLE

* Updated StateChanegConf for endpoints vs. cluster status

* Fixed Pending/Target status' for PrivateEndpointServiceLinkDelete

* Added INITIATING back to list of Pending statuses on delete

* Added serverless instance list refresh func & utlizing it on serverless endpoint service

* Removed unintentional changes to tests and using a proper error message string

* Fixed error message wording to reference proper resource

* Removed extra quote on serverless instance

* WaitForStateContext inline with conditional

* Added documentation on completion condition for endponit service creation & deletion

* INTMDB-470: Private Endpoint Regional Mode test fixes (#946)

* Added a separate test for the basics of perm that does not require aws access

* Skipping complex test

* Renamed tests to fit more w/refac

* Updated RefreshFunc to just return PENDING if cluster is not IDLE

* Updated StateChanegConf for endpoints vs. cluster status

* Fixed Pending/Target status' for PrivateEndpointServiceLinkDelete

* Added INITIATING back to list of Pending statuses on delete

* Putting WaitForStateContext inline with condition checking if it err

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Dosty Everts <[email protected]>
Co-authored-by: Zuhair Ahmed <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@Zuhairahmed Zuhairahmed deleted the INTMDB-434 branch January 4, 2023 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not_stale Not stale issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants