feat: Support OIDC configs in mongodbatlas_stream_connection #3766

LijieZhang1998 · 2025-10-08T16:28:02Z

Description

Please include a summary of the fix/feature/change, including any relevant motivation and context.

Link to any related issue(s): https://jira.mongodb.org/browse/CLOUDP-338207

This PR is very similar to this PR we've reviewed and merged. But it was reverted in the master for the last release.

This PR has the two failed tests that Oriol and I looked into in the test run. We'll revert one change from our side to fix the test about stream processor states transition. I'm still checking the other failed test. And, neither of them are related to this change.

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 · 2025-10-09T02:47:28Z

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

marcosuma · 2025-10-09T06:34:59Z

.gitignore


 #used for schema code generation but is not commited to avoid constant updates
 tools/codegen/open-api-spec.yml
+vendor/


what's vendor and why do we need to ignore it? is it needed for development?

I usually run go mod vendor locally to get the dependencies, which generates this folder. I accidentally merged the files the day before yesterday that triggered a secret leak alert.

in this repo you just need to run the first time: make link-git-hooks tools, and I recommend with any change: make build && golangci-lint run
nothing else needed

marcosuma · 2025-10-09T06:37:57Z

examples/mongodbatlas_stream_connection/main.tf

  }
 }

+resource "mongodbatlas_stream_connection" "example-kafka-oauthbearer" {


is there a README.md for this example? should we add more information there about this new resource?

We have this README.md file. Do you mean by adding some information to the file? I don't see we add any information about the example resources?

marcosuma · 2025-10-09T06:39:09Z

docs/resources/stream_connection.md

 }    
 ```

+### Example Kafka SASL OAuthbearer Connection


is there any Altas docs link we could add here?

can you show me an example of adding an atlas doc link to the docs? The atlas doc is WIP. But I think I can get the link for it. I followed the pattern in this file to add this example. But I'd like to add extra information if needed.

can you show me an example of adding an atlas doc link to the docs

you should be able to find it in the advanced_cluster.md file. We usually link the public external link of the docs if there is any other further explanation of how things work.

@LijieZhang1998 please reach out to @jvincent-mongodb he can create a dochub link (our redirect layer) so you can add a link that we can redirect to a different location on our end when the docs are live

marcosuma · 2025-10-09T06:41:47Z

@LijieZhang1998 your tests are failing, I haven't looked into why but as a general rule would you mind asking for review only when all your tests are succeeding? if they are flaky, please add this information in the ticket summary to show they're also failing in master for some time

.changelog/3766.txt

docs/data-sources/stream_connection.md

docs/data-sources/stream_connections.md

docs/resources/stream_connection.md

LijieZhang1998 · 2025-10-09T14:56:09Z

@LijieZhang1998 your tests are failing, I haven't looked into why but as a general rule would you mind asking for review only when all your tests are succeeding? if they are flaky, please add this information in the ticket summary to show they're also failing in master for some time

The failed tests are still the two ones Oriol and I looked into. We'll revert one change from our side to fix the test about stream processor states transition. I'm still checking the other failed test. And, neither of them are related to this change. I updated the description of the PR with the content.

LijieZhang1998 · 2025-10-10T13:56:35Z

Hi @kanchana-mongodb @marcosuma, can you review it again? We have a task depending on its release. Thanks.

docs/resources/stream_connection.md

internal/service/streamconnection/resource_stream_connection_test.go

LijieZhang1998 · 2025-10-13T21:41:38Z

The failed tests TestAccStreamRSStreamConnection_kafkaOAuthBearer and TestAccStreamRSStreamConnection_kafkaPlaintext passed on my local. I'll rerun it to see if it's flaky.

.gitignore

internal/service/streamconnection/model_stream_connection.go

internal/service/streamconnection/resource_stream_connection_test.go

marcosuma · 2025-10-14T13:11:43Z

docs/resources/stream_connection.md

 }    
 ```

+### Example Kafka SASL OAuthbearer Connection


can you show me an example of adding an atlas doc link to the docs

you should be able to find it in the advanced_cluster.md file. We usually link the public external link of the docs if there is any other further explanation of how things work.

jwilliams-mongo

few minor comments but LGTM overall

.changelog/3766.txt

jwilliams-mongo · 2025-10-14T18:52:56Z

.changelog/3766.txt

+```
+
+```release-note:enhancement
+data-source/mongodbatlas_stream_connection: Adds new authentication mechanism (OIDC) to the Kafka connection


Suggested change

data-source/mongodbatlas_stream_connection: Adds new authentication mechanism (OIDC) to the Kafka connection

data-source/mongodbatlas_stream_connection: Adds new authentication mechanism (OIDC) to the Kafka connection.

.changelog/3766.txt

jwilliams-mongo · 2025-10-14T19:01:19Z

docs/data-sources/stream_connection.md

+* `method` - SASL OAUTHBEARER authentication method. Value must be OIDC.
 * `username` - Username of the account to connect to the Kafka cluster.
 * `password` - Password of the account to connect to the Kafka cluster.
+* `token_endpoint_url` -  OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.


can this be either an HTTP or HTTPS URI? or more than one HTTP URI? might be useful to clarify

Just one HTTP(S) URI.

jwilliams-mongo · 2025-10-14T19:02:23Z

docs/resources/stream_connection.md

 }    
 ```

+### Example Kafka SASL OAuthbearer Connection


@LijieZhang1998 please reach out to @jvincent-mongodb he can create a dochub link (our redirect layer) so you can add a link that we can redirect to a different location on our end when the docs are live

jwilliams-mongo · 2025-10-14T19:03:39Z

docs/data-sources/stream_connection.md


-* `mechanism` - Style of authentication. Can be one of `PLAIN`, `SCRAM-256`, or `SCRAM-512`.
+* `mechanism` - Method of authentication. Value can be `PLAIN`, `SCRAM-256`, `SCRAM-512`, or `OAUTHBEARER`.
+* `method` - SASL OAUTHBEARER authentication method. Value must be OIDC.


if this value must be OIDC does the user really need to specify it here? or could it be implicit whenever mechanism = OAUTHBEARER

It's just for now. We may add more method value in the future. Should I say Value must be OIDC currently

.changelog/3766.txt

LijieZhang1998 added 4 commits October 8, 2025 11:22

feat: Support OIDC configs in mongodbatlas_stream_connection

8f86a64

fix typos

f7a00e3

fix changelog and lint

d799890

fix lint

d88d16d

LijieZhang1998 changed the title ~~Feat streams kafka OIDC~~ feat: Support OIDC configs in mongodbatlas_stream_connection Oct 8, 2025

github-actions bot added the enhancement label Oct 8, 2025

fix accept test

11e5ea6

LijieZhang1998 marked this pull request as ready for review October 9, 2025 02:47

LijieZhang1998 requested review from a team as code owners October 9, 2025 02:47

marcosuma reviewed Oct 9, 2025

View reviewed changes

kanchana-mongodb reviewed Oct 9, 2025

View reviewed changes

edit by comments

c85d0f8

LijieZhang1998 requested review from kanchana-mongodb and marcosuma October 9, 2025 16:10

LijieZhang1998 added 2 commits October 13, 2025 15:33

fix the int tests

634fb64

fix int tests

639831c

lantoli reviewed Oct 13, 2025

View reviewed changes

docs/resources/stream_connection.md Show resolved Hide resolved

lantoli reviewed Oct 13, 2025

View reviewed changes

internal/service/streamconnection/resource_stream_connection_test.go Show resolved Hide resolved

lantoli reviewed Oct 13, 2025

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

lantoli reviewed Oct 13, 2025

View reviewed changes

internal/service/streamconnection/model_stream_connection.go Show resolved Hide resolved

lantoli approved these changes Oct 13, 2025

View reviewed changes

LijieZhang1998 added 2 commits October 13, 2025 17:10

update by comments

fca069e

add attribute checks helper function by comment

8a903a8

lantoli reviewed Oct 14, 2025

View reviewed changes

internal/service/streamconnection/resource_stream_connection_test.go Outdated Show resolved Hide resolved

marcosuma approved these changes Oct 14, 2025

View reviewed changes

update the helper func

412dcf5

jwilliams-mongo approved these changes Oct 14, 2025

View reviewed changes

LijieZhang1998 added 2 commits October 14, 2025 14:27

update by comments

df2844f

update by comments

255b808

lantoli reviewed Oct 14, 2025

View reviewed changes

.changelog/3766.txt Outdated Show resolved Hide resolved

remove .

4e0ff16

LijieZhang1998 merged commit 5f75212 into master Oct 15, 2025
45 checks passed

LijieZhang1998 deleted the feat-StreamsKafkaOIDC branch October 15, 2025 03:55

svc-apix-Bot added a commit that referenced this pull request Oct 15, 2025

chore: Updates CHANGELOG.md for #3766

5c6320e

	data-source/mongodbatlas_stream_connection: Adds new authentication mechanism (OIDC) to the Kafka connection
	data-source/mongodbatlas_stream_connection: Adds new authentication mechanism (OIDC) to the Kafka connection.

feat: Support OIDC configs in mongodbatlas_stream_connection #3766

feat: Support OIDC configs in mongodbatlas_stream_connection #3766

Uh oh!

Conversation

LijieZhang1998 commented Oct 8, 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!

github-actions bot commented Oct 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LijieZhang1998 Oct 9, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcosuma commented Oct 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LijieZhang1998 commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LijieZhang1998 commented Oct 10, 2025

Uh oh!

Uh oh!

Uh oh!

LijieZhang1998 commented Oct 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jwilliams-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

LijieZhang1998 commented Oct 8, 2025 •

edited

Loading

LijieZhang1998 Oct 9, 2025 •

edited

Loading

LijieZhang1998 commented Oct 9, 2025 •

edited

Loading