doc: Adds examples and docs for `mongodbatlas_stream_privatelink_endpoint` resource and data sources #2923

oarbusi · 2024-12-20T16:10:55Z

Description

Adds examples and docs for mongodbatlas_stream_privatelink_endpoint resource and data sources

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

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 have added appropriate changelog entries.
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

github-actions · 2024-12-20T16:13:12Z

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

kanchana-mongodb

LGTM % copy

docs/data-sources/stream_privatelink_endpoint.md

docs/data-sources/stream_privatelink_endpoints.md

docs/resources/stream_privatelink_endpoint.md

oarbusi · 2024-12-23T09:49:54Z

failing tests is TestAccStreamProcessor_withOptions which is failing for reasons unrelated to this PR

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/main.tf

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/README.md

EspenAlbert · 2024-12-23T13:58:39Z

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/versions.tf

+  required_providers {
+    mongodbatlas = {
+      source  = "mongodb/mongodbatlas"
+      version = "1.24.0"


1.25? Or did we decide not to include these?

I seem to remeber that if we put a version that does not exist yet it fails, might be wrong though

I would change it to >~ to use latest 1.x by default

We decided not to include the TF version which is the required_version below

For our provider TF version I think we can try >~ as suggested by @EspenAlbert . I think we have a backlog ticket to fix this in the job at some point

EspenAlbert · 2024-12-23T14:00:00Z

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/main.tf

@@ -0,0 +1,59 @@
+resource "confluent_environment" "staging" {
+  display_name = "Staging"


Should this be a variable?

No strong opinion on this, but I think there's no need for this to be a variable. Users that already use the Confluent TF provider will have their environment already set up. I think the important part of this example is the new mongodb resource part

IMO: Staging is a bit strange. I would prefer a placeholder (e.g., my-env) value to make it more obvious for the users to change it.

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/main.tf

EspenAlbert · 2024-12-23T14:01:43Z

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/main.tf

+  }
+}
+
+module "privatelink" {


Curious why we are using a module here

No reason apart from the fact that it makes the main.tf smaller

I would move it to a top level file privatelink.tf instead of the module then.

EspenAlbert · 2024-12-23T14:04:17Z

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/main.tf

@@ -0,0 +1,59 @@
+resource "confluent_environment" "staging" {


Should there be a serverless instance in this example?

Serverless products in this case would be for example AWS Lambda, not Confluent serveless products/instance

Not sure I understand the purpose of this example.
We create a private link between confluence and Atlas accounts, but no service/products is using it?

Example purpose is to show how to use & create this resource (mongodbatlas_stream_privatelink_endpoint), in this case no products or services are using it, but this is like all our other examples( for example mongodbatlas_advanced_cluster example creates the cluster, we don't show services/products using the cluster)

EspenAlbert

Thanks for addressing the comments. Still left a few follow-ups 😅

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/README.md

maastha · 2024-12-23T15:35:14Z

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/versions.tf

+  required_providers {
+    mongodbatlas = {
+      source  = "mongodb/mongodbatlas"
+      version = "1.24.0"


We decided not to include the TF version which is the required_version below

…dicated_cluster/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/README.md

…rverless/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

…ta sources (#2924) * chore: Generate `mongodbatlas_stream_privatelink_endpoint` file structure and resource schema (#2878) * initial scaffolding and generation of schema * schema adjustments * temporary nolint:gocritic for commented out code * comment out test * chore: Generate `mongodbatlas_stream_privatelink_endpoint` data sources schema (#2884) * data source schema * comment out implementation * feat: Implements `mongodbatlas_stream_privatelink_endpoint` resource (#2890) * initial implementation of resource * implement resource & model conversion necessary for resource * handle nil/empty dnssubdomain * refresh function for the deletion of the resource * empty list for dnsSubDomain attribute * retry strategy for creation * changelog * adjust latest SDK * fix unit test after dnssubdomain fix * fix generate docs all check * feat: Implements `mongodbatlas_stream_privatelink_endpoint` data sources (#2897) * singular data source * plural data source * changelog * example check fix * pr * use correct states for creation * test: Add tests for `mongodbatlas_stream_privatelink_endpoint` resource and data source (#2910) * wip: tests * set up confluent provider in tests * test fixes * run tests in CI * adjust migration test to use confluent external provider * change detection * depends on * specific project for tests * failedonupdate fix * test improvement * changes to tests * remove config in import step * externalprovider for failed update test case * error on update * chore: Changes Confluent specific attributes from Required to Optional to easily support future vendors (#2921) * change required and validate in model conversion * test required * doc: Adds examples and docs for `mongodbatlas_stream_privatelink_endpoint` resource and data sources (#2923) * examples * generate docs * fix example * pr docs copy * versions * format * fix * pr comments * docs update for example update * docs generation * Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com> * Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com> * Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com> * Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com> * version constraint --------- Co-authored-by: maastha <122359335+maastha@users.noreply.github.com> * merge from master * remove unnecessary CI var * chore: Correct dnsSubDomain value sent in the API request when empty in the configuration (#2925) * skip tests in CI * feat: Supports `PRIVATE_LINK` networking type in `mongodbatlas_stream_connection` resource and data sources (#2940) * wip: networking attributes for private link connection * changelog * changelog fix * final adjustments * ajustments * final adjustment * fix conversion * test privatelink in stream connection * skip test * skip mig test * add reason on skipped mig test * clean up leftover from wrong api --------- Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

oarbusi added 2 commits December 20, 2024 16:46

examples

c71ef52

generate docs

ff134ae

oarbusi changed the base branch from master to CLOUDP-288973-stream-privatelink December 20, 2024 16:11

oarbusi marked this pull request as ready for review December 20, 2024 16:12

oarbusi requested review from a team as code owners December 20, 2024 16:12

kanchana-mongodb approved these changes Dec 20, 2024

View reviewed changes

oarbusi added 5 commits December 20, 2024 17:25

fix example

7f2442c

pr docs copy

98e7046

versions

3dc31fd

format

3c4b92a

fix

e4e4884

EspenAlbert reviewed Dec 23, 2024

View reviewed changes

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/main.tf Outdated Show resolved Hide resolved

EspenAlbert reviewed Dec 23, 2024

View reviewed changes

examples/mongodbatlas_stream_privatelink_endpoint/confluent_dedicated_cluster/README.md Show resolved Hide resolved

EspenAlbert reviewed Dec 23, 2024

View reviewed changes

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/main.tf Outdated Show resolved Hide resolved

EspenAlbert reviewed Dec 23, 2024

View reviewed changes

oarbusi added 4 commits December 23, 2024 15:41

pr comments

676478e

docs update for example update

c897f57

Merge branch 'CLOUDP-288973-stream-privatelink' into CLOUDP-290833

9194d0e

docs generation

91aabec

EspenAlbert approved these changes Dec 23, 2024

View reviewed changes

maastha reviewed Dec 23, 2024

View reviewed changes

oarbusi and others added 2 commits December 23, 2024 16:36

Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_de…

a6aad88

…dicated_cluster/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_de…

9981fd5

…dicated_cluster/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

maastha reviewed Dec 23, 2024

View reviewed changes

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/README.md Outdated Show resolved Hide resolved

maastha reviewed Dec 23, 2024

View reviewed changes

examples/mongodbatlas_stream_privatelink_endpoint/confluent_serverless/README.md Outdated Show resolved Hide resolved

oarbusi and others added 3 commits December 23, 2024 16:38

Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_se…

4673c31

…rverless/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

Update examples/mongodbatlas_stream_privatelink_endpoint/confluent_se…

65831f6

…rverless/README.md Co-authored-by: maastha <122359335+maastha@users.noreply.github.com>

version constraint

36d3d13

oarbusi merged commit b2fe118 into CLOUDP-288973-stream-privatelink Dec 23, 2024
39 of 40 checks passed

oarbusi deleted the CLOUDP-290833 branch December 23, 2024 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Adds examples and docs for `mongodbatlas_stream_privatelink_endpoint` resource and data sources #2923

doc: Adds examples and docs for `mongodbatlas_stream_privatelink_endpoint` resource and data sources #2923

oarbusi commented Dec 20, 2024

github-actions bot commented Dec 20, 2024

kanchana-mongodb left a comment

oarbusi commented Dec 23, 2024

EspenAlbert Dec 23, 2024

oarbusi Dec 23, 2024

EspenAlbert Dec 23, 2024

maastha Dec 23, 2024

maastha Dec 23, 2024

EspenAlbert Dec 23, 2024

oarbusi Dec 23, 2024

EspenAlbert Dec 23, 2024

EspenAlbert Dec 23, 2024

oarbusi Dec 23, 2024

EspenAlbert Dec 23, 2024

EspenAlbert Dec 23, 2024

oarbusi Dec 23, 2024

EspenAlbert Dec 23, 2024

oarbusi Dec 23, 2024

EspenAlbert left a comment

maastha Dec 23, 2024

		@@ -0,0 +1,59 @@
		resource "confluent_environment" "staging" {
		display_name = "Staging"

doc: Adds examples and docs for mongodbatlas_stream_privatelink_endpoint resource and data sources #2923

doc: Adds examples and docs for mongodbatlas_stream_privatelink_endpoint resource and data sources #2923

Conversation

oarbusi commented Dec 20, 2024

Description

Type of change:

Required Checklist:

Further comments

github-actions bot commented Dec 20, 2024

kanchana-mongodb left a comment

Choose a reason for hiding this comment

oarbusi commented Dec 23, 2024

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EspenAlbert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

doc: Adds examples and docs for `mongodbatlas_stream_privatelink_endpoint` resource and data sources #2923

doc: Adds examples and docs for `mongodbatlas_stream_privatelink_endpoint` resource and data sources #2923