feat: Add stream_workspace resource + ds to replace stream_instance #3832

kpatel71716 · 2025-10-30T20:23:45Z

Description

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

Link to any related issue(s):

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

kpatel71716 · 2025-10-31T13:19:37Z

Please review by individual commit to filter out all the docs updates. My thought was that we can take an initial approach to convert the stream workspace model to the stream instance model and back to reduce code duplication. Happy to take a different approach if the team does not feel comfortable with this approach

As a follow-up to this PR we can consider refactoring this approach, but for now I felt it provides functionality without making the PR too complex. I mostly copied over a lot of the stream instance code to achieve the addition of the new resource and datasource

github-actions · 2025-10-31T13:20:33Z

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

xargom

lgtm

lantoli · 2025-11-03T11:12:55Z

docs/data-sources/stream_instance.md

+To migrate from `mongodbatlas_stream_instance` to `mongodbatlas_stream_workspace`, update your data source configuration:
+
+```terraform
+# Old (deprecated)


nit: have the recommended one first

@kpatel71716 we usually have this as an upgrade guide doc, separated by the resource / data-source doc (but we add a link).
For example: https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/cluster-to-advanced-cluster-migration-guide (this is a bit more complex)

to add: we also provide an example in the examples/ repository folder to show exactly how to upgrade

lantoli · 2025-11-03T11:13:58Z

examples/mongodbatlas_stream_workspace/README.md

+
+You must set the following variables:
+
+- `atlas_client_id`: MongoDB Atlas Service Account Client ID


nit: add ending periods

lantoli · 2025-11-03T11:15:54Z

internal/service/streamworkspace/resource_schema.go

+	}
+}
+
+type TFStreamsWorkspaceModel struct {


as it's already in package streamworkspace, we use TFModel better

lantoli · 2025-11-03T11:17:12Z

internal/service/streamworkspace/resource_schema.go

+}
+
+// GetInstanceName returns the workspace name as instance name for API compatibility
+func (m *TFStreamsWorkspaceModel) GetInstanceName() types.String {


I can't find where GetInstanceName or SetInstanceName are used

lantoli · 2025-11-03T11:18:39Z

internal/service/streamworkspace/resource_stream_workspace.go

+}
+
+func (r *streamsWorkspaceRS) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
+	var streamsWorkspacePlan TFStreamsWorkspaceModel


nit: as similar comments, you can just say plan as we're already in the stream workspace package and this is even a local func var

lantoli · 2025-11-03T11:21:30Z

internal/service/streamworkspace/resource_stream_workspace.go

+	config.RSCommon
+}
+
+func (r *streamsWorkspaceRS) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {


as it's already in resource package we normally use (r *rs) for resources and (d *ds) for datasources

lantoli · 2025-11-03T11:24:44Z

.changelog/3832.txt

+```
+
+```release-note:note
+data-source/mongodbatlas_stream_instance: Deprecates the `mongodbatlas_stream_instance` datasource, use `mongodbatlas_stream_workspace` 


DeprecationMessage is missing in the deprecated resource/datasource schemas

lantoli · 2025-11-03T11:25:32Z

docs/resources/stream_instance.md


 # Resource: mongodbatlas_stream_instance

+~> **DEPRECATED:** This resource is deprecated. Please use [`mongodbatlas_stream_workspace`](stream_workspace.md) instead.


Suggested change

~> **DEPRECATED:** This resource is deprecated. Please use [`mongodbatlas_stream_workspace`](stream_workspace.md) instead.

~> **DEPRECATED:** This resource is deprecated. Please use [`mongodbatlas_stream_workspace`](stream_workspace) instead.

links in TF registry don't have .md

marcosuma · 2025-11-03T12:59:01Z

docs/data-sources/stream_instance.md

+To migrate from `mongodbatlas_stream_instance` to `mongodbatlas_stream_workspace`, update your data source configuration:
+
+```terraform
+# Old (deprecated)


@kpatel71716 we usually have this as an upgrade guide doc, separated by the resource / data-source doc (but we add a link).
For example: https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/cluster-to-advanced-cluster-migration-guide (this is a bit more complex)

marcosuma · 2025-11-03T12:59:38Z

.changelog/3832.txt

+```
+
+```release-note:note
+data-source/mongodbatlas_stream_instance: Deprecates the `mongodbatlas_stream_instance` datasource, use `mongodbatlas_stream_workspace` 


IIUC, we're also deprecating the plural

marcosuma · 2025-11-03T13:00:24Z

docs/data-sources/stream_workspaces.md

+
+`mongodbatlas_stream_workspaces` describes the stream workspaces defined in a project.
+
+~> **NOTE:** This data source is an alias for `mongodbatlas_stream_instances`. Use this data source for new configurations.


What do we mean with alias? It might be confusing since we're saying mongodbatlas_stream_instances is deprecated

marcosuma · 2025-11-03T13:01:23Z

docs/data-sources/stream_workspaces.md

+
+## Migration from stream_instances
+
+To migrate from `mongodbatlas_stream_instances` data source to `mongodbatlas_stream_workspaces`, use the following `moved` block:


same comment. Make a single upgrade guide and move all this content there.

marcosuma · 2025-11-03T13:01:47Z

docs/data-sources/stream_instance.md

+To migrate from `mongodbatlas_stream_instance` to `mongodbatlas_stream_workspace`, update your data source configuration:
+
+```terraform
+# Old (deprecated)


to add: we also provide an example in the examples/ repository folder to show exactly how to upgrade

marcosuma · 2025-11-03T13:15:43Z

examples/mongodbatlas_stream_workspace/README.md

+
+To learn more, see the [Stream Workspace Documentation](https://www.mongodb.com/docs/atlas/atlas-sp/manage-processing-instance/#configure-a-stream-processing-instance).
+
+## Migration from stream_instance


marcosuma · 2025-11-03T13:16:40Z

internal/service/streamworkspace/resource_stream_workspace.go

@@ -0,0 +1,200 @@
+package streamworkspace


just double checking: is this a copy paste of the streaminstance file?

EspenAlbert · 2025-11-03T19:59:10Z

internal/service/streamworkspace/resource_stream_workspace.go

+	return
+}
+
+func (r *streamsWorkspaceRS) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse) {


I don't see usage of this or why it would be needed

EspenAlbert · 2025-11-03T20:02:03Z

internal/service/streamworkspace/resource_stream_workspace.go

+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/streaminstance"
+)
+
+var _ resource.ResourceWithConfigure = &streamsWorkspaceRS{}


I think we need to avoid duplicating all the logic in these two resources.
I would instead abstract out the CRUD operations just after the model conversion so all the API calls and diagnostic handling is the same.
Then you can keep the streaminstance.TFModel --> steamworkspace.TFModel as a final step.

kpatel71716 changed the title ~~feat: add stream_workspace resource + ds to replace stream_instance~~ feat: Add stream_workspace resource + ds to replace stream_instance Oct 30, 2025

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

kpatel71716 added 3 commits October 31, 2025 07:45

doc: add docs for new stream_workspace rs/ds to replace instance

8ca635d

doc: add deprecation messaging to stream_instance docs

88da550

feat: add stream_workspace resource + ds to replace stream_instance

19286c8

kpatel71716 force-pushed the CLOUDP-335390_2 branch from 2c62840 to 19286c8 Compare October 31, 2025 13:06

kpatel71716 marked this pull request as ready for review October 31, 2025 13:20

kpatel71716 requested review from a team as code owners October 31, 2025 13:20

xargom approved these changes Oct 31, 2025

View reviewed changes

lantoli reviewed Nov 3, 2025

View reviewed changes

marcosuma reviewed Nov 3, 2025

View reviewed changes

EspenAlbert reviewed Nov 3, 2025

View reviewed changes


		You must set the following variables:

		- `atlas_client_id`: MongoDB Atlas Service Account Client ID


		# Resource: mongodbatlas_stream_instance

		~> DEPRECATED: This resource is deprecated. Please use [`mongodbatlas_stream_workspace`](stream_workspace.md) instead.


		`mongodbatlas_stream_workspaces` describes the stream workspaces defined in a project.

		~> NOTE: This data source is an alias for `mongodbatlas_stream_instances`. Use this data source for new configurations.


		## Migration from stream_instances

		To migrate from `mongodbatlas_stream_instances` data source to `mongodbatlas_stream_workspaces`, use the following `moved` block:


		To learn more, see the [Stream Workspace Documentation](https://www.mongodb.com/docs/atlas/atlas-sp/manage-processing-instance/#configure-a-stream-processing-instance).

		## Migration from stream_instance

feat: Add stream_workspace resource + ds to replace stream_instance #3832

Are you sure you want to change the base?

feat: Add stream_workspace resource + ds to replace stream_instance #3832

Conversation

kpatel71716 commented Oct 30, 2025

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

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

Uh oh!

Uh oh!

github-actions bot commented Oct 31, 2025

Uh oh!

xargom left a comment

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!

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kpatel71716 commented Oct 31, 2025 •

edited

Loading