doc: The commit adds Azure Streams PrivateLink documentation and examples #3299

jwongmongodb · 2025-04-24T15:34:56Z

Description

This adds an example for adding Azure PL with Streams using EVENTHUB. I also updated the streams privatelink documentation to match the latest Admin API for Streams CreatePrivateLinkConnections.

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

Note: there is a slight deviation from the API docs for the vendor field. The API always had this field as optional when terraform has it as required. However, omitting the vendor field is only valid for AZURE which defaults it to the EVENTHUB value. To keep from introducing a breaking change, we will omit this documentation for TF. (We will likely change this vendor field to required in a future breaking API audit for streams and want to avoid flip flopping the field in terraform from required to not required back to required)

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

…ples

jwongmongodb · 2025-04-24T18:14:01Z

internal/service/searchdeployment/resource_schema.go

 	Timeouts                 timeouts.Value `tfsdk:"timeouts"`
-	SkipWaitOnUpdate         types.Bool     `tfsdk:"skip_wait_on_update"`
 	EncryptionAtRestProvider types.String   `tfsdk:"encryption_at_rest_provider"`
+	SkipWaitOnUpdate         types.Bool     `tfsdk:"skip_wait_on_update"`


this is from the automatic fieldalignment

github-actions · 2025-04-24T18:14:38Z

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

examples/mongodbatlas_stream_privatelink_endpoint/azure/README.md

examples/mongodbatlas_stream_privatelink_endpoint/azure/main.tf

EspenAlbert · 2025-04-25T05:36:45Z

.changelog/3299.txt

@@ -0,0 +1,7 @@
+```release-note:note


Not sure if we include changelog for example/docs updates?

Usually we dont, reference https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/contributing/changelog-process.md#changes-that-should-not-have-a-changelog-entry

So, I should remove the changelog?

I see in your link that it says the following doesn't need a changelog, does this include datasource docs too?

Resource and provider documentation updates

I removed the changelog

lantoli · 2025-04-25T06:09:29Z

.changelog/3299.txt

+
+```release-note:note
+datasource/mongodbatlas_stream_privatelink_endpoint: Add documentation and example for using Azure PrivateLink with Atlas Streams
+```


Use 3rd person: Adds ...

also plural ds, stream_privatelink_endpoints, is missing in changelog

EspenAlbert · 2025-04-28T13:07:18Z

docs/resources/stream_privatelink_endpoint.md

-**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
- `provider_name` (String) Provider where the Kafka cluster is deployed.
- `vendor` (String) Vendor who manages the Kafka cluster.
+- `project_id` (String) Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.<br>**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.


Interesting usage of <br> inside attribute description!

EspenAlbert

LGTM. Thank you for addressing the comments

oarbusi

LGTM!

jwongmongodb added 4 commits April 24, 2025 11:24

doc: The commit adds Azure Streams PrivateLink documentation and exam…

5ef0199

…ples

fix formatting

560519c

add missing vars in example

8865407

revert unintended model reordering

ce20904

jwongmongodb commented Apr 24, 2025

View reviewed changes

jwongmongodb marked this pull request as ready for review April 24, 2025 18:14

jwongmongodb requested review from a team as code owners April 24, 2025 18:14

jwongmongodb requested a review from oarbusi April 24, 2025 18:14

kanchana-mongodb approved these changes Apr 24, 2025

View reviewed changes

EspenAlbert reviewed Apr 25, 2025

View reviewed changes

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

EspenAlbert reviewed Apr 25, 2025

View reviewed changes

lantoli reviewed Apr 25, 2025

View reviewed changes

jwongmongodb added 2 commits April 25, 2025 09:00

fix documentation phrasing

54107e5

remove unneeded changelog

b90d4a6

jwongmongodb requested review from AgustinBettati, EspenAlbert and lantoli April 25, 2025 14:28

EspenAlbert reviewed Apr 28, 2025

View reviewed changes

EspenAlbert approved these changes Apr 28, 2025

View reviewed changes

oarbusi approved these changes Apr 29, 2025

View reviewed changes

jwongmongodb merged commit 35b8476 into master Apr 29, 2025
43 of 44 checks passed

jwongmongodb deleted the CLOUDP-301853_update_azure_pl_doc_example branch April 29, 2025 13:13

doc: The commit adds Azure Streams PrivateLink documentation and examples #3299

doc: The commit adds Azure Streams PrivateLink documentation and examples #3299

Uh oh!

Conversation

jwongmongodb commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

jwongmongodb Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 24, 2025

Uh oh!

kanchana-mongodb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

EspenAlbert Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

AgustinBettati Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

jwongmongodb Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

jwongmongodb Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

lantoli Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EspenAlbert Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

EspenAlbert left a comment

Choose a reason for hiding this comment

Uh oh!

oarbusi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jwongmongodb commented Apr 24, 2025 •

edited

Loading

lantoli Apr 25, 2025 •

edited

Loading