Merging in template

Author: yhakbar

.github/workflows/document.yml

@@ -42,7 +42,7 @@ jobs:
 
       - name: "Confirm"
         run: |
-          if [[ "$(basename "$(git rev-parse --show-toplevel)")" != 'terraform-aws-template' ]]; then
+          if [[ "$(basename "$(git rev-parse --show-toplevel)")" != *'terraform-aws-template'* ]]; then
             echo "Setting core.fileMode to false to avoid false positives in documentation check."
             git config core.fileMode false
             if [[ -n $(git status --porcelain) ]]; then

.github/workflows/todo.yml

@@ -22,6 +22,6 @@ jobs:
 
       - name: "TODO"
         run: |
-          if [[ "$(basename $(git rev-parse --show-toplevel))" != 'terraform-aws-template' ]]; then
+          if [[ "$(basename $(git rev-parse --show-toplevel))" != *'terraform-aws-template'* ]]; then
             ./scripts/todo.sh
           fi

.tflint.hcl

@@ -1,45 +1,45 @@
 plugin "aws" {
-    enabled = true
-    version = "0.9.0"
-    source  = "github.com/terraform-linters/tflint-ruleset-aws"
+  enabled = true
+  version = "0.15.0"
+  source  = "github.com/terraform-linters/tflint-ruleset-aws"
 }
 
 rule "terraform_deprecated_interpolation" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_deprecated_index" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_unused_declarations" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_comment_syntax" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_documented_outputs" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_documented_variables" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_typed_variables" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_module_pinned_source" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_naming_convention" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_required_version" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_required_providers" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_unused_required_providers" {
-    enabled = true
+  enabled = true
 }
 rule "terraform_workspace_remote" {
-    enabled = true
+  enabled = true
 }

.tool-versions

@@ -1,7 +1,7 @@
-terraform 1.1.7
-golang 1.17.6
+terraform 1.2.7
+golang 1.18.5
 ripgrep 13.0.0
-tflint 0.34.1
-github-cli 2.8.0
-fd 8.3.2
+tflint 0.39.3
+github-cli 2.14.4
+fd 8.4.0
 terraform-docs 0.16.0

README-HEADER.md

@@ -1,4 +1,4 @@
-# PBS TF rds module
+# PBS TF RDS Module
 
 ## Installation
 

README.md

@@ -1,4 +1,4 @@
-# PBS TF rds module
+# PBS TF RDS Module
 
 ## Installation
 
@@ -115,7 +115,7 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_environment"></a> [environment](#input\_environment) | Environment (sharedtools, dev, staging, prod) | `string` | n/a | yes |
+| <a name="input_environment"></a> [environment](#input\_environment) | Environment (sharedtools, dev, staging, qa, prod) | `string` | n/a | yes |
 | <a name="input_organization"></a> [organization](#input\_organization) | Organization using this module. Used to prefix tags so that they are easily identified as being from your organization | `string` | n/a | yes |
 | <a name="input_product"></a> [product](#input\_product) | Tag used to group resources according to product | `string` | n/a | yes |
 | <a name="input_repo"></a> [repo](#input\_repo) | Tag used to point to the repo using this module | `string` | n/a | yes |

docs/module/README.md

@@ -1,3 +1,3 @@
-# rds module
+# RDS Module
 
 This directory will be used for any documentation that is unique to this module.

examples/lambda/.gitignore

@@ -0,0 +1,2 @@
+backend.tf
+provider.tf

examples/lambda/.terraform.lock.hcl

@@ -0,0 +1,18 @@
+module "rds" {
+  source = "../.."
+
+  private_hosted_zone = var.private_hosted_zone
+
+  use_prefix = false
+
+  use_proxy = true
+
+  # Just to make testing easier
+  deletion_protection = false
+  skip_final_snapshot = true
+
+  organization = var.organization
+  environment  = var.environment
+  product      = var.product
+  repo         = var.repo
+}

examples/lambda/main.tf

@@ -0,0 +1,25 @@
+output "name" {
+  description = "Name of the DB"
+  value       = module.rds.name
+}
+
+output "db_admin_username" {
+  description = "Admin Username for DB"
+  value       = module.rds.db_admin_username
+}
+
+output "db_admin_password" {
+  description = "Admin password for DB"
+  value       = module.rds.db_admin_password
+  sensitive   = true
+}
+
+output "db_cluster_dns" {
+  description = "DB Cluster private DNS record"
+  value       = module.rds.db_cluster_dns
+}
+
+output "sg_id" {
+  description = "Security group ID for DB"
+  value       = module.rds.sg_id
+}

examples/lambda/outputs.tf

@@ -0,0 +1,9 @@
+# terraform {
+#   backend "s3" {
+#     bucket         = "my-bucket-tfstate"
+#     key            = "example-terraform-aws-rds-lambda"
+#     profile        = "my-profile"
+#     region         = "us-east-1"
+#     dynamodb_table = "terraform-lock"
+#   }
+# }

examples/lambda/sample-backend.tf

@@ -0,0 +1,12 @@
+# provider "aws" {
+#   region  = "us-east-1"
+#   profile = "my-profile"
+#   default_tags {
+#     tags = {
+#       product      = var.product
+#       environment  = var.environment
+#       repo         = var.repo
+#       organization = var.organization
+#     }
+#   }
+# }

examples/lambda/sample-provider.tf

@@ -0,0 +1,45 @@
+variable "environment" {
+  description = "Environment (sharedtools, dev, staging, prod)"
+  type        = string
+
+  default = "sharedtools"
+
+  validation {
+    condition     = contains(["sharedtools", "dev", "staging", "prod"], var.environment)
+    error_message = "The environment variable must be one of [sharedtools, dev, staging, prod]."
+  }
+}
+
+variable "product" {
+  description = "Tag used to group resources according to application"
+
+  default = "example-tf-rds-lambda"
+
+  validation {
+    condition     = can(regex("[a-z\\-]+", var.product))
+    error_message = "The product variable violates approved regex."
+  }
+}
+
+variable "repo" {
+  description = "Tag used to point to the repo using this module"
+
+  default = "https://github.com/pbs/terraform-rds-module.git"
+
+  validation {
+    condition     = can(regex("(?:git|ssh|https?|git@[-\\w.]+):(\\/\\/)?(.*?)(\\.git)(\\/?|\\#[-\\d\\w._]+?)$", var.repo))
+    error_message = "The repo variable violates approved regex."
+  }
+}
+
+variable "organization" {
+  description = "Organization using this module. Used to prefix tags so that they are easily identified as being from your organization"
+  type        = string
+
+  default = "example"
+
+  validation {
+    condition     = can(regex("[a-z\\-]+", var.organization))
+    error_message = "The organization variable violates approved regex."
+  }
+}

examples/lambda/tags.tf

@@ -0,0 +1,4 @@
+variable "private_hosted_zone" {
+  type        = string
+  description = "Private hosted zone for this RDS Cluster. Populate `TF_VAR_private_hosted_zone` before running any tests to have this value populated."
+}

examples/lambda/vars.tf

@@ -0,0 +1,3 @@
+go 1.18
+
+use ./tests