Merge pull request #23 from gruntwork-io/registry

brikis98 · web-flow · commit 028f695ac940 · 2018-06-01T15:42:48.000-04:00
Prepare for release in the Terraform Registry
diff --git a/README.md b/README.md
@@ -14,8 +14,10 @@ Or as multiple clusters for the various Couchbase services (data, management, se
 
 ## Quick start
 
-If you want to quickly spin up a Couchbase cluster, check out the instructions for the [couchbase-cluster-simple
-example](https://github.com/gruntwork-io/terraform-aws-couchbase/blob/master/examples/couchbase-cluster-simple).
+If you want to quickly spin up a Couchbase cluster, you can run the simple example that is in the root of this repo.
+Check out [couchbase-cluster-simple example
+documentation](https://github.com/gruntwork-io/terraform-aws-couchbase/blob/master/examples/couchbase-cluster-simple)
+for instructions.
 
 
 
diff --git a/examples/couchbase-cluster-mds/main.tf b/examples/couchbase-cluster-mds/main.tf
@@ -4,10 +4,6 @@
 # clsuters in AWS.
 # ---------------------------------------------------------------------------------------------------------------------
 
-provider "aws" {
-  region = "${var.aws_region}"
-}
-
 terraform {
   required_version = ">= 0.10.3"
 }
diff --git a/examples/couchbase-cluster-mds/variables.tf b/examples/couchbase-cluster-mds/variables.tf
@@ -5,6 +5,7 @@
 
 # AWS_ACCESS_KEY_ID
 # AWS_SECRET_ACCESS_KEY
+# AWS_DEFAULT_REGION
 
 # ---------------------------------------------------------------------------------------------------------------------
 # REQUIRED PARAMETERS
@@ -21,11 +22,6 @@ variable "ami_id" {
   default     = ""
 }
 
-variable "aws_region" {
-  description = "The AWS region to deploy into (e.g. us-east-1)."
-  default     = "us-east-1"
-}
-
 variable "couchbase_data_node_cluster_name" {
   description = "What to name the Couchbase data nodes cluster and all of its associated resources"
   default     = "couchbase-server-data"
diff --git a/examples/couchbase-cluster-simple-dns-tls/main.tf b/examples/couchbase-cluster-simple-dns-tls/main.tf
@@ -6,10 +6,6 @@
 # for it.
 # ---------------------------------------------------------------------------------------------------------------------
 
-provider "aws" {
-  region = "${var.aws_region}"
-}
-
 terraform {
   required_version = ">= 0.10.3"
 }
diff --git a/examples/couchbase-cluster-simple-dns-tls/variables.tf b/examples/couchbase-cluster-simple-dns-tls/variables.tf
@@ -5,6 +5,7 @@
 
 # AWS_ACCESS_KEY_ID
 # AWS_SECRET_ACCESS_KEY
+# AWS_DEFAULT_REGION
 
 # ---------------------------------------------------------------------------------------------------------------------
 # REQUIRED PARAMETERS
@@ -25,11 +26,6 @@ variable "ami_id" {
   default     = ""
 }
 
-variable "aws_region" {
-  description = "The AWS region to deploy into (e.g. us-east-1)."
-  default     = "us-east-1"
-}
-
 variable "cluster_name" {
   description = "What to name the Couchbase cluster and all of its associated resources"
   default     = "couchbase-server"
diff --git a/examples/couchbase-cluster-simple/README.md b/examples/couchbase-cluster-simple/README.md
@@ -1,6 +1,6 @@
 # Couchbase Single Cluster Example
 
-This folder shows an example of Terraform code that uses the 
+The root folder of this repo shows an example of Terraform code that uses the
 [couchbase-cluster](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/modules/couchbase-cluster) 
 module to deploy a [Couchbase](https://www.couchbase.com/) cluster in [AWS](https://aws.amazon.com/). The cluster 
 consists of one Auto Scaling Group (ASG) that runs all Couchbase services and Sync Gateway:
@@ -30,12 +30,12 @@ To deploy a Couchbase Cluster:
    [couchbase-ami example](https://github.com/gruntwork-io/terraform-aws-couchbase/tree/master/examples/couchbase-ami)
    documentation for instructions. Make sure to note down the ID of the AMI.
 1. Install [Terraform](https://www.terraform.io/).
-1. Open `variables.tf`, set the environment variables specified at the top of the file, and fill in any other variables that
-   don't have a default. If you built a custom AMI, put its ID into the `ami_id` variable. If you didn't, this example
-   will use public AMIs that Gruntwork has published, which are fine for testing/learning, but not recommended for
-   production use.
-1. Run `terraform init`.
-1. Run `terraform apply`.
+1. Open the `variables.tf` file in the root of this repo, set the environment variables specified at the top of the
+   file, and fill in any other variables that don't have a default. If you built a custom AMI, put its ID into the
+   `ami_id` variable. If you didn't, this example will use public AMIs that Gruntwork has published, which are fine for
+   testing/learning, but not recommended for production use.
+1. Run `terraform init` in the root folder of this repo.
+1. Run `terraform apply` in the root folder of this repo.
 
 
 
diff --git a/main.tf b/main.tf
@@ -5,10 +5,6 @@
 # used for health checks and to distribute traffic across Sync Gateway.
 # ---------------------------------------------------------------------------------------------------------------------
 
-provider "aws" {
-  region = "${var.aws_region}"
-}
-
 terraform {
   required_version = ">= 0.10.3"
 }
@@ -21,7 +17,7 @@ module "couchbase" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/couchbase-cluster?ref=v0.0.1"
-  source = "../../modules/couchbase-cluster"
+  source = "./modules/couchbase-cluster"
 
   cluster_name  = "${var.cluster_name}"
   min_size      = 3
@@ -81,7 +77,7 @@ module "couchbase" {
 # ---------------------------------------------------------------------------------------------------------------------
 
 data "template_file" "user_data_server" {
-  template = "${file("${path.module}/user-data/user-data.sh")}"
+  template = "${file("${path.module}/examples/couchbase-cluster-simple/user-data/user-data.sh")}"
 
   vars {
     cluster_asg_name = "${var.cluster_name}"
@@ -113,7 +109,7 @@ module "load_balancer" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/load-balancer?ref=v0.0.1"
-  source = "../../modules/load-balancer"
+  source = "./modules/load-balancer"
 
   name       = "${var.cluster_name}"
   vpc_id     = "${data.aws_vpc.default.id}"
@@ -141,7 +137,7 @@ module "couchbase_target_group" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/load-balancer-target-group?ref=v0.0.1"
-  source = "../../modules/load-balancer-target-group"
+  source = "./modules/load-balancer-target-group"
 
   target_group_name = "${var.cluster_name}-cb"
   asg_name          = "${module.couchbase.asg_name}"
@@ -162,7 +158,7 @@ module "sync_gateway_target_group" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/load-balancer-target-group?ref=v0.0.1"
-  source = "../../modules/load-balancer-target-group"
+  source = "./modules/load-balancer-target-group"
 
   target_group_name = "${var.cluster_name}-sg"
   asg_name          = "${module.couchbase.asg_name}"
@@ -184,7 +180,7 @@ module "couchbase_security_group_rules" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/couchbase-server-security-group-rules?ref=v0.0.1"
-  source = "../../modules/couchbase-server-security-group-rules"
+  source = "./modules/couchbase-server-security-group-rules"
 
   security_group_id = "${module.couchbase.security_group_id}"
 
@@ -203,7 +199,7 @@ module "sync_gateway_security_group_rules" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/sync-gateway-security-group-rules?ref=v0.0.1"
-  source = "../../modules/sync-gateway-security-group-rules"
+  source = "./modules/sync-gateway-security-group-rules"
 
   security_group_id = "${module.couchbase.security_group_id}"
 
@@ -221,7 +217,7 @@ module "iam_policies" {
   # When using these modules in your own code, you will need to use a Git URL with a ref attribute that pins you
   # to a specific version of the modules, such as the following example:
   # source = "git::git@github.com:gruntwork-io/terraform-aws-couchbase.git//modules/couchbase-server-security-group-rules?ref=v0.0.1"
-  source = "../../modules/couchbase-iam-policies"
+  source = "./modules/couchbase-iam-policies"
 
   iam_role_id = "${module.couchbase.iam_role_id}"
 }
diff --git a/outputs.tf b/outputs.tf
diff --git a/test/Gopkg.lock b/test/Gopkg.lock
diff --git a/test/Gopkg.toml b/test/Gopkg.toml
@@ -23,7 +23,7 @@
 
 [[constraint]]
   name = "github.com/gruntwork-io/terratest"
-  version = "0.9.1"
+  version = "0.9.5"
 
 [[constraint]]
   name = "github.com/stretchr/testify"
diff --git a/test/couchbase_helpers.go b/test/couchbase_helpers.go
@@ -15,6 +15,8 @@ import (
 	"github.com/gruntwork-io/terratest/modules/terraform"
 )
 
+const AWS_DEFAULT_REGION_ENV_VAR = "AWS_DEFAULT_REGION"
+
 func checkCouchbaseConsoleIsRunning(t *testing.T, clusterUrl string) {
 	maxRetries := 180
 	sleepBetweenRetries := 5 * time.Second
diff --git a/test/couchbase_multi_cluster_test.go b/test/couchbase_multi_cluster_test.go
@@ -66,12 +66,14 @@ func testCouchbaseMultiCluster(t *testing.T, osName string, edition string) {
 		terraformOptions := &terraform.Options{
 			TerraformDir: couchbaseMultiClusterDir,
 			Vars: map[string]interface{} {
-				"aws_region":                   awsRegion,
 				"ami_id":                       amiId,
 				dataNodeClusterVarName:         formatCouchbaseClusterName("data", uniqueId),
 				indexQuerySearchClusterVarName: formatCouchbaseClusterName("search", uniqueId),
 				syncGatewayClusterVarName: 		formatCouchbaseClusterName("sync", uniqueId),
 			},
+			EnvVars: map[string]string{
+				AWS_DEFAULT_REGION_ENV_VAR: awsRegion,
+			},
 		}
 
 		terraform.InitAndApply(t, terraformOptions)
diff --git a/test/couchbase_single_cluster_dns_tls_test.go b/test/couchbase_single_cluster_dns_tls_test.go
@@ -56,11 +56,13 @@ func testCouchbaseSingleClusterDnsTls(t *testing.T, osName string, edition strin
 		terraformOptions := &terraform.Options{
 			TerraformDir: couchbaseSingleClusterDnsTlsDir,
 			Vars: map[string]interface{}{
-				"aws_region":            awsRegion,
 				"ami_id":                amiId,
 				"domain_name":           domainNameForTest,
 				couchbaseClusterVarName: formatCouchbaseClusterName("single-cluster", uniqueId),
 			},
+			EnvVars: map[string]string{
+				AWS_DEFAULT_REGION_ENV_VAR: awsRegion,
+			},
 		}
 
 		terraform.InitAndApply(t, terraformOptions)
diff --git a/test/couchbase_single_cluster_test.go b/test/couchbase_single_cluster_test.go
@@ -32,57 +32,58 @@ func TestIntegrationCouchbaseEnterpriseSingleClusterAmazonLinux(t *testing.T) {
 }
 
 func testCouchbaseSingleCluster(t *testing.T, osName string, edition string) {
-	examplesFolder := test_structure.CopyTerraformFolderToTemp(t, "../", "examples")
-	couchbaseAmiDir := filepath.Join(examplesFolder, "couchbase-ami")
-	couchbaseSingleClusterDir := filepath.Join(examplesFolder, "couchbase-cluster-simple")
+	rootFolder := test_structure.CopyTerraformFolderToTemp(t, "../", ".")
+	couchbaseAmiDir := filepath.Join(rootFolder, "examples", "couchbase-ami")
 
 	test_structure.RunTestStage(t, "setup_ami", func() {
 		awsRegion := getRandomAwsRegion(t)
 		uniqueId := random.UniqueId()
 
 		amiId := buildCouchbaseAmi(t, osName, couchbaseAmiDir, edition, awsRegion, uniqueId)
 
-		test_structure.SaveAmiId(t, couchbaseSingleClusterDir, amiId)
-		test_structure.SaveString(t, couchbaseSingleClusterDir, savedAwsRegion, awsRegion)
-		test_structure.SaveString(t, couchbaseSingleClusterDir, savedUniqueId, uniqueId)
+		test_structure.SaveAmiId(t, rootFolder, amiId)
+		test_structure.SaveString(t, rootFolder, savedAwsRegion, awsRegion)
+		test_structure.SaveString(t, rootFolder, savedUniqueId, uniqueId)
 	})
 
 	defer test_structure.RunTestStage(t, "teardown", func() {
-		terraformOptions := test_structure.LoadTerraformOptions(t, couchbaseSingleClusterDir)
+		terraformOptions := test_structure.LoadTerraformOptions(t, rootFolder)
 		terraform.Destroy(t, terraformOptions)
 
-		amiId := test_structure.LoadAmiId(t, couchbaseSingleClusterDir)
-		awsRegion := test_structure.LoadString(t, couchbaseSingleClusterDir, savedAwsRegion)
+		amiId := test_structure.LoadAmiId(t, rootFolder)
+		awsRegion := test_structure.LoadString(t, rootFolder, savedAwsRegion)
 		aws.DeleteAmi(t, awsRegion, amiId)
 	})
 
 	defer test_structure.RunTestStage(t, "logs", func() {
-		terraformOptions := test_structure.LoadTerraformOptions(t, couchbaseSingleClusterDir)
-		awsRegion := test_structure.LoadString(t, couchbaseSingleClusterDir, savedAwsRegion)
+		terraformOptions := test_structure.LoadTerraformOptions(t, rootFolder)
+		awsRegion := test_structure.LoadString(t, rootFolder, savedAwsRegion)
 		testStageLogs(t, terraformOptions, couchbaseClusterVarName, awsRegion)
 	})
 
 	test_structure.RunTestStage(t, "setup_deploy", func() {
-		amiId := test_structure.LoadAmiId(t, couchbaseSingleClusterDir)
-		awsRegion := test_structure.LoadString(t, couchbaseSingleClusterDir, savedAwsRegion)
-		uniqueId := test_structure.LoadString(t, couchbaseSingleClusterDir, savedUniqueId)
+		amiId := test_structure.LoadAmiId(t, rootFolder)
+		awsRegion := test_structure.LoadString(t, rootFolder, savedAwsRegion)
+		uniqueId := test_structure.LoadString(t, rootFolder, savedUniqueId)
 
 		terraformOptions := &terraform.Options{
-			TerraformDir: couchbaseSingleClusterDir,
+			TerraformDir: rootFolder,
 			Vars: map[string]interface{}{
-				"aws_region":            awsRegion,
 				"ami_id":                amiId,
 				couchbaseClusterVarName: formatCouchbaseClusterName("single-cluster", uniqueId),
 			},
+			EnvVars: map[string]string{
+				AWS_DEFAULT_REGION_ENV_VAR: awsRegion,
+			},
 		}
 
 		terraform.InitAndApply(t, terraformOptions)
 
-		test_structure.SaveTerraformOptions(t, couchbaseSingleClusterDir, terraformOptions)
+		test_structure.SaveTerraformOptions(t, rootFolder, terraformOptions)
 	})
 
 	test_structure.RunTestStage(t, "validation", func() {
-		terraformOptions := test_structure.LoadTerraformOptions(t, couchbaseSingleClusterDir)
+		terraformOptions := test_structure.LoadTerraformOptions(t, rootFolder)
 		validateSingleClusterWorks(t, terraformOptions, couchbaseClusterVarName, "http")
 	})
 }
diff --git a/variables.tf b/variables.tf
@@ -5,6 +5,7 @@
 
 # AWS_ACCESS_KEY_ID
 # AWS_SECRET_ACCESS_KEY
+# AWS_DEFAULT_REGION
 
 # ---------------------------------------------------------------------------------------------------------------------
 # REQUIRED PARAMETERS
@@ -21,11 +22,6 @@ variable "ami_id" {
   default     = ""
 }
 
-variable "aws_region" {
-  description = "The AWS region to deploy into (e.g. us-east-1)."
-  default     = "us-east-1"
-}
-
 variable "cluster_name" {
   description = "What to name the Couchbase cluster and all of its associated resources"
   default     = "couchbase-server"
