chore: Deprecates `ServerlessInstance`, `ServerlessPrivateEndpoint` and Serverless type in `CloudBackupRestoreJobs` #1306

oarbusi · 2025-03-12T10:11:40Z

Proposed changes

Deprecates ServerlessInstance, ServerlessPrivateEndpoing and Serverless type in CloudBackupRestoreJobs .
There's no mention of M2 or M5 instance sizes in cluster, so no changes are needed in the Cluster resource

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

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

Required Checklist:

I have signed the MongoDB CLA
I have added tests that prove my fix is effective or that my feature works
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
For CFN Resources: I have released by changes in the private registry and proved by change
works in Atlas

Further comments

oarbusi · 2025-03-12T11:09:37Z

failing test is due to the shimming logic for serverless API that now creates flex clusters instead of serverless instances.

POST: HTTP 400 Bad Request (Error code: "NOT_SERVERLESS_TENANT_CLUSTER") Detail: The specified cluster ct-private-endpoint-serverless in group <group> is not a serverless tenant cluster. Reason: Bad Request. Params: [ct-private-endpoint-serverless <group>]

marcosuma · 2025-03-12T11:44:02Z

cfn-resources/serverless-instance/README.md

@@ -1,5 +1,7 @@
 # MongoDB::Atlas::ServerlessInstance

+**WARNING:** This resource is deprecated and will be removed in January 2026. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/).


Should we tell them if they try to create it will fail because a Flex cluster will be created instead?

Also I think we should add a sentence that we are planning to support Flex in CloudFormation, with a (timeline yet to be announced)

Create will not fail, but it will create a flex cluster. The linked guide already mentions that the flex clusters are created instead of shared/serverless instanced. I don't think it's necessary here IMO

The link also states that Flex support is coming: https://www.mongodb.com/docs/atlas/flex-migration/#atlas-cloudformation-migration I don't think it's necessary to mention it in the CFN docs IMO

my only advice is find a way to tell customers they will experience the error like the one you got for the failing tests (link to your comment)

Oh okay, you were referring to ServerlessPrivateEndpoint, not ServerlessInstance. I understand now, I will add your suggestion to ServerlessPrivateEndpoint docs

done in bdea3ca

marcosuma · 2025-03-12T11:46:23Z

cfn-resources/serverless-private-endpoint/README.md

@@ -1,5 +1,7 @@
 # MongoDB::Atlas::ServerlessPrivateEndpoint

+**WARNING:** This resource is deprecated and will be removed in January 2026. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/).


I remember this was going to be stopped in March 2025, am I right?

Good catch, after reviewing again https://www.mongodb.com/docs/atlas/flex-migration/, I see that the date has been changed to May. Changing accordingly

lmkerbey-mdb · 2025-03-12T15:49:03Z

cfn-resources/serverless-private-endpoint/docs/README.md

 # MongoDB::Atlas::ServerlessPrivateEndpoint

-Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.
+**WARNING:** This resource is deprecated and will be removed in May 2025. If you try to create a ServerlessPrivateEndpoint for a newly created ServerlessInstance, it will fail because the newly created ServerlessInstance are now Flex clusters. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/). Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.


Suggested change

**WARNING:** This resource is deprecated and will be removed in May 2025. If you try to create a ServerlessPrivateEndpoint for a newly created ServerlessInstance, it will fail because the newly created ServerlessInstance are now Flex clusters. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/). Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

**WARNING:** This resource is deprecated and will be removed in May 2025. If you try to create a new ServerlessInstance, you will create a Flex cluster. As a result, you can't create ServerlessPrivateEndpoints for these new instances. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/). Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

Let's try to avoid using 'fail', and let's make sure that the cause is foregrounded. Please make this change elsewhere as it applies.

Applied in all the places it applies bbd3ce3. Thanks!

lantoli

LGTM, can you also do a follow-up PR to update CDK?

oarbusi · 2025-03-13T08:17:24Z

@lantoli yes I will do the changes in CDK aswell

oarbusi · 2025-03-13T08:18:49Z

Merging, test failure is expected and docs has said that LGTM once suggested change has been applied

deprecate serverless/shared features

b97d42f

oarbusi requested a review from a team as a code owner March 12, 2025 10:11

increase version

71342e6

marcosuma reviewed Mar 12, 2025

View reviewed changes

oarbusi added 2 commits March 12, 2025 14:23

correct date

d311bd5

add extra warning for serverless private endpoint

bdea3ca

lmkerbey-mdb suggested changes Mar 12, 2025

View reviewed changes

pr suggestion

bbd3ce3

lantoli approved these changes Mar 13, 2025

View reviewed changes

oarbusi merged commit 43583d4 into master Mar 13, 2025
34 of 35 checks passed

oarbusi deleted the CLOUDP-277813 branch March 13, 2025 08:18

oarbusi changed the title ~~chore: Deprecates ServerlessInstance, ServerlessPrivateEndpoing and Serverless type in CloudBackupRestoreJobs~~ chore: Deprecates ServerlessInstance, ServerlessPrivateEndpoint and Serverless type in CloudBackupRestoreJobs Mar 13, 2025

		@@ -1,5 +1,7 @@
		# MongoDB::Atlas::ServerlessInstance

		WARNING: This resource is deprecated and will be removed in January 2026. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/).

		@@ -1,5 +1,7 @@
		# MongoDB::Atlas::ServerlessPrivateEndpoint

		WARNING: This resource is deprecated and will be removed in January 2026. For more details, see [Migrate your programmatic tools from M2, M5, or Serverless Instances to Flex Clusters](https://www.mongodb.com/docs/atlas/flex-migration/).

chore: Deprecates ServerlessInstance, ServerlessPrivateEndpoint and Serverless type in CloudBackupRestoreJobs #1306

chore: Deprecates ServerlessInstance, ServerlessPrivateEndpoint and Serverless type in CloudBackupRestoreJobs #1306

Uh oh!

Conversation

oarbusi commented Mar 12, 2025

Proposed changes

Type of change:

Required Checklist:

Further comments

Uh oh!

oarbusi commented Mar 12, 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!

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!

lantoli left a comment

Choose a reason for hiding this comment

Uh oh!

oarbusi commented Mar 13, 2025

Uh oh!

oarbusi commented Mar 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chore: Deprecates `ServerlessInstance`, `ServerlessPrivateEndpoint` and Serverless type in `CloudBackupRestoreJobs` #1306

chore: Deprecates `ServerlessInstance`, `ServerlessPrivateEndpoint` and Serverless type in `CloudBackupRestoreJobs` #1306