Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 13, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b97d42f
deprecate serverless/shared features
oarbusi Mar 12, 2025
71342e6
increase version
oarbusi Mar 12, 2025
d311bd5
correct date
oarbusi Mar 12, 2025
bdea3ca
add extra warning for serverless private endpoint
oarbusi Mar 12, 2025
bbd3ce3
pr suggestion
oarbusi Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cfn-resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ Note these are also hosted on AWS CloudFormation Public Registry under Third Par
| 26 | project-invitation | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/project-invitation/project-invitation.json) | [./project-invitation/test](./project-invitation/test) |
| 27 | project-ip-access-list | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/project-ip-access-list/ip-access-list.yaml) | [./project-ip-access-list/test](./project-ip-access-list/test) |
| 28 | search-index | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/search-index/searchIndex.json) | [./search-indexes/test](./search-indexes/test) |
| 29 | serverless-instance | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/serverless-instance/serverless-instance.json) | [./serverless-instance/test](./serverless-instance/test) |
| 29 | serverless-instance | ![Build](https://img.shields.io/badge/Deprecated-red) | [example](../examples/serverless-instance/serverless-instance.json) | [./serverless-instance/test](./serverless-instance/test) |
| 30 | teams | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/teams/teams.json) | [./teams/test](./teams/test) |
| 31 | third-party-integration | ![Build](https://img.shields.io/badge/GA-green) | [example files](../examples/thirdpartyintegrations) | [./third-party-integration/test](./third-party-integration/test) |
| 32 | trigger | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/trigger/trigger.json) | [./trigger/test](./trigger/test) |
| 33 | X509AuthenticationDatabaseUser | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/x509-authentication-db-user/x509-authentication-db-user.json) | [./x509-authentication-database-user/test](./x509-authentication-database-user/test) |
| 34 | federated-database-instance | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/federated-database-instance/federatedDatabaseInstance.json) | [./federated-database-instance/test](./federated-database-instance/test) |
| 35 | privatelink-endpoint-service-data-federation-online-archive | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/privatelink-endpoint-service-data-federation-online-archive/privatelink-endpoint-service-data-federation-online-archive.json) | [./privatelink-endpoint-service-data-federation-online-archive/test](./privatelink-endpoint-service-data-federation-online-archive/test) |
| 36 | federated-query-limit | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/federated-query-limit/federatedQueryLimit.json) | [./federated-query-limit/test](./federated-query-limit/test) |
| 37 | serverless-private-endpoint | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/serverless-private-endpoint/serverless-private-endpoint-with-aws-private-endpoint.json) | [./serverless-private-endpoint/test](./serverless-private-endpoint/test) |
| 37 | serverless-private-endpoint | ![Build](https://img.shields.io/badge/Deprecated-red) | [example](../examples/serverless-private-endpoint/serverless-private-endpoint-with-aws-private-endpoint.json) | [./serverless-private-endpoint/test](./serverless-private-endpoint/test) |
| 38 | api-key | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/api-key/api-key.json) | [./api-key/test](./api-key/test) |
| 39 | access-list-api-key | ![Build](https://img.shields.io/badge/GA-green) | [example](../examples/access-list-api-key/access-list-api-key.json) | [./access-list-api-key/test](./access-list-api-key/test) |
| 40 | data-lake-pipeline | ![Build](https://img.shields.io/badge/Deprecated-red) | [example](../examples/data-lake-pipeline/datalakepipeline.json) | [./data-lake-pipeline/test](./data-lake-pipeline/test) |
Expand Down
2 changes: 2 additions & 0 deletions cfn-resources/cloud-backup-restore-jobs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## Description
Resource for managing [Cloud BackUp Restore Jobs](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Cloud-Backup-Restore-Jobs).

**WARNING:** `serverless` instance type 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/).

## Requirements

Set up an AWS profile to securely give CloudFormation access to your Atlas credentials.
Expand Down
2 changes: 1 addition & 1 deletion cfn-resources/cloud-backup-restore-jobs/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/l

#### InstanceType

Type of instance specified on the Instance Name serverless or cluster
Type of instance specified on the Instance Name serverless or cluster. **WARNING:** `serverless` instance type 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/).

_Required_: Yes

Expand Down
2 changes: 1 addition & 1 deletion cfn-resources/cloud-backup-restore-jobs/mongodb-atlas-cloudbackuprestorejobs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"type": "string"
},
"InstanceType": {
"description": "Type of instance specified on the Instance Name serverless or cluster",
"description": "Type of instance specified on the Instance Name serverless or cluster. **WARNING:** `serverless` instance type 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/).",
"type": "string",
"enum": [
"serverless",
Expand Down
2 changes: 1 addition & 1 deletion cfn-resources/cloud-backup-restore-jobs/test/cfn-test-create-inputs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ ClusterName=$projectName
clusterId=$(atlas clusters list --projectId "${projectId}" --output json | jq --arg NAME "${ClusterName}" -r '.results[]? | select(.name==$NAME) | .id')
if [ -z "$clusterId" ]; then
echo "creating cluster.."
atlas clusters create "${ClusterName}" --projectId "${projectId}" --backup --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 --output=json
atlas clusters create "${ClusterName}" --projectId "${projectId}" --backup --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 8.0 --diskSizeGB 10 --output=json
atlas clusters watch "${ClusterName}" --projectId "${projectId}"
echo -e "Created Cluster \"${ClusterName}\""
fi
Expand Down
2 changes: 2 additions & 0 deletions cfn-resources/serverless-instance/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/).
Copy link
Collaborator

@marcosuma marcosuma Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

@marcosuma marcosuma Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

@oarbusi oarbusi Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

@oarbusi oarbusi Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

@marcosuma marcosuma Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Collaborator Author

@oarbusi oarbusi Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

@oarbusi oarbusi Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in bdea3ca


## Description
Resource for managing [Serverless Instances](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Serverless-Instances).

Expand Down
19 changes: 19 additions & 0 deletions cfn-resources/serverless-instance/cmd/resource/config.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cfn-resources/serverless-instance/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MongoDB::Atlas::ServerlessInstance

Returns, adds, edits, and removes serverless instances.
**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/). Returns, adds, edits, and removes serverless instances.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion cfn-resources/serverless-instance/mongodb-atlas-serverlessinstance.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"typeName": "MongoDB::Atlas::ServerlessInstance",
"sourceUrl": "https://github.com/mongodb/mongodbatlas-cloudformation-resources/tree/master/cfn-resources/serverless-instance",
"additionalProperties": false,
"description": "Returns, adds, edits, and removes serverless instances.",
"description": "**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/). Returns, adds, edits, and removes serverless instances.",
"definitions": {
"ServerlessInstanceConnectionStrings": {
"type": "object",
Expand Down
2 changes: 2 additions & 0 deletions cfn-resources/serverless-private-endpoint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MongoDB::Atlas::ServerlessPrivateEndpoint

**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/).

Resource for creating and managing [Private Endpoint Services](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints).

If the CreateAndAssignAWSPrivateEndpoint Only the Atlas private endpoint will be deleted, the AWS private endpoint will remain and might need to be deleted manually
Expand Down
2 changes: 1 addition & 1 deletion cfn-resources/serverless-private-endpoint/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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 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.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion cfn-resources/serverless-private-endpoint/mongodb-atlas-serverlessprivateendpoint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"typeName": "MongoDB::Atlas::ServerlessPrivateEndpoint",
"description": "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.",
"description": "**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.",
"sourceUrl": "https://github.com/mongodb/mongodbatlas-cloudformation-resources/tree/master/cfn-resources/serverless-private-endpoint",
"definitions": {
"awsPrivateEndpointConfig": {
Expand Down
Loading