From 2965bc994584324b7a442cb72b9da58685be669e Mon Sep 17 00:00:00 2001 From: Govardhan Pagidi Date: Thu, 28 Sep 2023 09:43:27 -0500 Subject: [PATCH] module naming convention (#1500) --- modules/examples/atlas-basic/main.tf | 2 +- modules/examples/sagemaker/main.tf | 2 +- .../README.md | 2 +- .../outputs.tf | 0 .../sagemaker.tf | 0 .../variables.tf | 0 .../versions.tf | 0 .../terraform-mongodbatlas-basic/README.md | 42 +++++++++++++++++++ .../aws-vpc.tf | 0 .../main.tf | 0 .../terraform-mongodbatlas-basic/outputs.tf | 1 + .../variables.tf | 0 .../versions.tf | 0 13 files changed, 46 insertions(+), 3 deletions(-) rename modules/{examples/sagemaker => terraform-mongodbatlas-amazon-sagemaker-integration}/README.md (94%) rename modules/{mongodb-atlas-analytics-amazon-sagemaker-integration => terraform-mongodbatlas-amazon-sagemaker-integration}/outputs.tf (100%) rename modules/{mongodb-atlas-analytics-amazon-sagemaker-integration => terraform-mongodbatlas-amazon-sagemaker-integration}/sagemaker.tf (100%) rename modules/{mongodb-atlas-analytics-amazon-sagemaker-integration => terraform-mongodbatlas-amazon-sagemaker-integration}/variables.tf (100%) rename modules/{mongodb-atlas-analytics-amazon-sagemaker-integration => terraform-mongodbatlas-amazon-sagemaker-integration}/versions.tf (100%) create mode 100644 modules/terraform-mongodbatlas-basic/README.md rename modules/{atlas-basic => terraform-mongodbatlas-basic}/aws-vpc.tf (100%) rename modules/{atlas-basic => terraform-mongodbatlas-basic}/main.tf (100%) create mode 100644 modules/terraform-mongodbatlas-basic/outputs.tf rename modules/{atlas-basic => terraform-mongodbatlas-basic}/variables.tf (100%) rename modules/{atlas-basic => terraform-mongodbatlas-basic}/versions.tf (100%) diff --git a/modules/examples/atlas-basic/main.tf b/modules/examples/atlas-basic/main.tf index e74e32c2e7..1fb35f72a0 100644 --- a/modules/examples/atlas-basic/main.tf +++ b/modules/examples/atlas-basic/main.tf @@ -1,5 +1,5 @@ module "atlas-basic" { - source = "../../atlas-basic" + source = "../../terraform-mongodbatlas-basic" public_key = "" private_key = "" diff --git a/modules/examples/sagemaker/main.tf b/modules/examples/sagemaker/main.tf index 3332e01295..f295a7684a 100644 --- a/modules/examples/sagemaker/main.tf +++ b/modules/examples/sagemaker/main.tf @@ -4,7 +4,7 @@ module "mongodb-atlas-analytics-amazon-sagemaker-integration" { - source = "../../mongodb-atlas-analytics-amazon-sagemaker-integration" + source = "../../terraform-mongodbatlas-amazon-sagemaker-integration" public_key = "" private_key = "" diff --git a/modules/examples/sagemaker/README.md b/modules/terraform-mongodbatlas-amazon-sagemaker-integration/README.md similarity index 94% rename from modules/examples/sagemaker/README.md rename to modules/terraform-mongodbatlas-amazon-sagemaker-integration/README.md index 8fe11b16e9..5f545d0150 100644 --- a/modules/examples/sagemaker/README.md +++ b/modules/terraform-mongodbatlas-amazon-sagemaker-integration/README.md @@ -9,7 +9,7 @@ This Partner Solutions template enables you to begin working with your machine l ## MongoDB Atlas terraform Resources used by the templates -- [mongodbatlas_event_trigger](../../../mongodbatlas/data_source_mongodbatlas_event_trigger.go) +- [mongodbatlas_event_trigger](../../mongodbatlas/data_source_mongodbatlas_event_trigger.go) ## Environment Configured by the Partner Solutions template diff --git a/modules/mongodb-atlas-analytics-amazon-sagemaker-integration/outputs.tf b/modules/terraform-mongodbatlas-amazon-sagemaker-integration/outputs.tf similarity index 100% rename from modules/mongodb-atlas-analytics-amazon-sagemaker-integration/outputs.tf rename to modules/terraform-mongodbatlas-amazon-sagemaker-integration/outputs.tf diff --git a/modules/mongodb-atlas-analytics-amazon-sagemaker-integration/sagemaker.tf b/modules/terraform-mongodbatlas-amazon-sagemaker-integration/sagemaker.tf similarity index 100% rename from modules/mongodb-atlas-analytics-amazon-sagemaker-integration/sagemaker.tf rename to modules/terraform-mongodbatlas-amazon-sagemaker-integration/sagemaker.tf diff --git a/modules/mongodb-atlas-analytics-amazon-sagemaker-integration/variables.tf b/modules/terraform-mongodbatlas-amazon-sagemaker-integration/variables.tf similarity index 100% rename from modules/mongodb-atlas-analytics-amazon-sagemaker-integration/variables.tf rename to modules/terraform-mongodbatlas-amazon-sagemaker-integration/variables.tf diff --git a/modules/mongodb-atlas-analytics-amazon-sagemaker-integration/versions.tf b/modules/terraform-mongodbatlas-amazon-sagemaker-integration/versions.tf similarity index 100% rename from modules/mongodb-atlas-analytics-amazon-sagemaker-integration/versions.tf rename to modules/terraform-mongodbatlas-amazon-sagemaker-integration/versions.tf diff --git a/modules/terraform-mongodbatlas-basic/README.md b/modules/terraform-mongodbatlas-basic/README.md new file mode 100644 index 0000000000..ff2e72d91b --- /dev/null +++ b/modules/terraform-mongodbatlas-basic/README.md @@ -0,0 +1,42 @@ +# quickstart-mongodb-atlas + + + +## Overview + +![image](https://user-images.githubusercontent.com/5663078/229103723-4c6b9ab1-9492-47ba-b04d-7f29079e3817.png) + +The Atlas Partner Solutions templates allow you to set up all you need to start using MongoDB Atlas. We provide four different templates: + +- Deploy MongoDB Atlas without VPC peering. This option peers MongoDB Atlas with your existing VPC. +- Deploy MongoDB Atlas with VPC peering into a new VPC (end-to-end deployment). This option builds a complete MongoDB Atlas environment within AWS consisting of a project, cluster, and more. +- Deploy MongoDB Atlas with VPC peering into an existing VPC. This option peers MongoDB Atlas with a new VPC. +- Deploy MongoDB Atlas with Private Endpoint. This option connects MongoDB Atlas AWS VPC using Private Endpoint. + +All the quickstart templates create an Atlas Project, Cluster, Database User and enable public access into your cluster. + + + +## MongoDB Atlas CFN Resources used by the templates + +- [MongoDB::Atlas::Cluster](../../mongodbatlas/resource_mongodbatlas_cluster.go) +- [MongoDB::Atlas::ProjectIpAccessList](../../mongodbatlas/fw_resource_mongodbatlas_project_ip_access_list.go) +- [MongoDB::Atlas::DatabaseUser](../../mongodbatlas/fw_resource_mongodbatlas_database_user.go) +- [MongoDB::Atlas::Project](../../mongodbatlas/fw_resource_mongodbatlas_project.go) +- [MongoDB::Atlas::NetworkPeering](../../mongodbatlas/resource_mongodbatlas_network_peering.go) +- [MongoDB::Atlas::NetworkContainer](../../mongodbatlas/resource_mongodbatlas_network_container.go) +- [MongoDB::Atlas::PrivateEndpoint](../../mongodbatlas/resource_mongodbatlas_privatelink_endpoint.go) + + +## Environment Configured by the Partner Solution templates +All Partner Solutions templates will generate the following resources: +- An Atlas Project in the organization that was provided as input. +- An Atlas Cluster with authentication and authorization enabled, which cannot be accessed through the public internet. +- A Database user that can access the cluster. +- The IP address range provided as input will be added to the Atlas access list, allowing the cluster to be accessed through the public internet. + +The specific resources that will be created depend on which Partner Solutions template is used: + +- A new AWS VPC (Virtual Private Cloud) will be created. +- A VPC peering connection will be established between the MongoDB Atlas VPC (where your cluster is located) and the VPC on AWS. + diff --git a/modules/atlas-basic/aws-vpc.tf b/modules/terraform-mongodbatlas-basic/aws-vpc.tf similarity index 100% rename from modules/atlas-basic/aws-vpc.tf rename to modules/terraform-mongodbatlas-basic/aws-vpc.tf diff --git a/modules/atlas-basic/main.tf b/modules/terraform-mongodbatlas-basic/main.tf similarity index 100% rename from modules/atlas-basic/main.tf rename to modules/terraform-mongodbatlas-basic/main.tf diff --git a/modules/terraform-mongodbatlas-basic/outputs.tf b/modules/terraform-mongodbatlas-basic/outputs.tf new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/modules/terraform-mongodbatlas-basic/outputs.tf @@ -0,0 +1 @@ + diff --git a/modules/atlas-basic/variables.tf b/modules/terraform-mongodbatlas-basic/variables.tf similarity index 100% rename from modules/atlas-basic/variables.tf rename to modules/terraform-mongodbatlas-basic/variables.tf diff --git a/modules/atlas-basic/versions.tf b/modules/terraform-mongodbatlas-basic/versions.tf similarity index 100% rename from modules/atlas-basic/versions.tf rename to modules/terraform-mongodbatlas-basic/versions.tf