Skip to content
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.

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

feat: INTMDB 1005 Serverless private endpoint #669

Merged
merged 24 commits into from
Aug 30, 2023

Conversation

Adelmar92
Copy link
Contributor

@Adelmar92 Adelmar92 commented Aug 17, 2023

Proposed changes

Added new resource Pirvate Endpoint Serverless:

  • this version of private endpoint serverless, has 2 flows:
  • Without AWS private endpoint
  • With AWS private endpoint

Without AWS Private Endpoint Flow:

In this configuration, you have the flexibility to establish an Atlas private endpoint independently. By opting not to immediately connect it, you can manually set up the linkage with an AWS private endpoint or Azure. Simply set the CreateAndAssignAWSPrivateEndpoint attribute to false during resource creation.

With AWS Private Endpoint Flow:

For a streamlined experience, you can enable the automatic generation of both Atlas private and AWS private endpoints, along with their interconnection, all within a single resource. Achieve this by configuring the CreateAndAssignAWSPrivateEndpoint attribute as true and supplying the following configuration structure:

"AwsPrivateEndpointConfigurationProperties": {
    "VpcId": "vpc-xxxxxx",
    "SubnetIds": ["subnet-xxxxx", "subnet-yyyyy"],
    "Region": "us_east_1"
}

cfn testing:
image

stack testing:

Without aws Private endpoint

image image

With aws Private endpoint

image

result:
atlas private endpoint
image

aws private endpoint
image

Jira ticket: INTMDB-1005

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

Manual QA performed:

  • cfn invoke for each of CRUDL/cfn test
  • Updated resource in example
  • Published to AWS private registry
  • Used the template in example to create and update a stack in AWS
  • Deleted stack to ensure resources are deleted
  • Created multiple resources in same stack
  • Validated in Atlas UI
  • Included screenshots

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

@Adelmar92 Adelmar92 requested a review from a team as a code owner August 17, 2023 15:59
@Adelmar92 Adelmar92 self-assigned this Aug 17, 2023
@govardhanpagidi
Copy link
Contributor

@Adelmar92 we need to add contract testing as well.

@maastha
Copy link
Collaborator

maastha commented Aug 21, 2023

@Adelmar92 Could you please include a manual QA/testing guide as well when adding any new features?
See following for examples:
https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/ldap-configuration/test/README.md
https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/cloud-backup-snapshot/test/README.md

The idea is that testing/any manual setup required for testing should be clearly outlined, this would help us in later automating all testing.
This also helps to outline the expected result from the resource on successful implementation.

@Adelmar92
Copy link
Contributor Author

@Adelmar92 Could you please include a manual QA/testing guide as well when adding any new features? See following for examples: https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/ldap-configuration/test/README.md https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/cfn-resources/cloud-backup-snapshot/test/README.md

The idea is that testing/any manual setup required for testing should be clearly outlined, this would help us in later automating all testing. This also helps to outline the expected result from the resource on successful implementation.

Done!

Copy link
Collaborator

@andreaangiolillo andreaangiolillo left a comment

Choose a reason for hiding this comment

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

LGTM

@govardhanpagidi
Copy link
Contributor

LGTM

@Adelmar92 Adelmar92 merged commit a6696d4 into master Aug 30, 2023
@Adelmar92 Adelmar92 deleted the feature/INTMDB-1005-Serverless-Private-Endpoint branch August 30, 2023 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants