Use the latest label module to support the environment attribute (#44)

Author: adamcrews

README.md

@@ -193,33 +193,34 @@ Available targets:
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| attributes | Additional attributes (e.g. `policy` or `role`) | list(string) | `<list>` | no |
+| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no |
 | autoscale_max_read_capacity | DynamoDB autoscaling max read capacity | number | `20` | no |
 | autoscale_max_write_capacity | DynamoDB autoscaling max write capacity | number | `20` | no |
 | autoscale_min_read_capacity | DynamoDB autoscaling min read capacity | number | `5` | no |
 | autoscale_min_write_capacity | DynamoDB autoscaling min write capacity | number | `5` | no |
 | autoscale_read_target | The target value (in %) for DynamoDB read autoscaling | number | `50` | no |
 | autoscale_write_target | The target value (in %) for DynamoDB write autoscaling | number | `50` | no |
 | billing_mode | DynamoDB Billing mode. Can be PROVISIONED or PAY_PER_REQUEST | string | `PROVISIONED` | no |
-| delimiter | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes` | string | `-` | no |
+| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no |
 | dynamodb_attributes | Additional DynamoDB attributes in the form of a list of mapped values | object | `<list>` | no |
 | enable_autoscaler | Flag to enable/disable DynamoDB autoscaling | string | `true` | no |
 | enable_encryption | Enable DynamoDB server-side encryption | bool | `true` | no |
 | enable_point_in_time_recovery | Enable DynamoDB point in time recovery | bool | `true` | no |
 | enable_streams | Enable DynamoDB streams | bool | `false` | no |
 | enabled | Set to false to prevent the module from creating any resources | bool | `true` | no |
+| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
 | global_secondary_index_map | Additional global secondary indexes in the form of a list of mapped values | object | `<list>` | no |
 | hash_key | DynamoDB table Hash Key | string | - | yes |
 | hash_key_type | Hash Key type, which must be a scalar type: `S`, `N`, or `B` for (S)tring, (N)umber or (B)inary data | string | `S` | no |
 | local_secondary_index_map | Additional local secondary indexes in the form of a list of mapped values | object | `<list>` | no |
-| name | Name  (e.g. `app` or `cluster`) | string | - | yes |
-| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no |
+| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
+| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
 | range_key | DynamoDB table Range Key | string | `` | no |
 | range_key_type | Range Key type, which must be a scalar type: `S`, `N`, or `B` for (S)tring, (N)umber or (B)inary data | string | `S` | no |
 | regex_replace_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed | string | `/[^a-zA-Z0-9-]/` | no |
-| stage | Stage (e.g. `prod`, `dev`, `staging`, `infra`) | string | `` | no |
+| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no |
 | stream_view_type | When an item in the table is modified, what information is written to the stream | string | `` | no |
-| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map(string) | `<map>` | no |
+| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
 | ttl_attribute | DynamoDB table TTL attribute | string | `Expires` | no |
 
 ## Outputs
@@ -325,7 +326,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
 ## Copyright
 
-Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
+Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)
 
 
 

docs/terraform.md

@@ -2,33 +2,34 @@
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| attributes | Additional attributes (e.g. `policy` or `role`) | list(string) | `<list>` | no |
+| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no |
 | autoscale_max_read_capacity | DynamoDB autoscaling max read capacity | number | `20` | no |
 | autoscale_max_write_capacity | DynamoDB autoscaling max write capacity | number | `20` | no |
 | autoscale_min_read_capacity | DynamoDB autoscaling min read capacity | number | `5` | no |
 | autoscale_min_write_capacity | DynamoDB autoscaling min write capacity | number | `5` | no |
 | autoscale_read_target | The target value (in %) for DynamoDB read autoscaling | number | `50` | no |
 | autoscale_write_target | The target value (in %) for DynamoDB write autoscaling | number | `50` | no |
 | billing_mode | DynamoDB Billing mode. Can be PROVISIONED or PAY_PER_REQUEST | string | `PROVISIONED` | no |
-| delimiter | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes` | string | `-` | no |
+| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no |
 | dynamodb_attributes | Additional DynamoDB attributes in the form of a list of mapped values | object | `<list>` | no |
 | enable_autoscaler | Flag to enable/disable DynamoDB autoscaling | string | `true` | no |
 | enable_encryption | Enable DynamoDB server-side encryption | bool | `true` | no |
 | enable_point_in_time_recovery | Enable DynamoDB point in time recovery | bool | `true` | no |
 | enable_streams | Enable DynamoDB streams | bool | `false` | no |
 | enabled | Set to false to prevent the module from creating any resources | bool | `true` | no |
+| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
 | global_secondary_index_map | Additional global secondary indexes in the form of a list of mapped values | object | `<list>` | no |
 | hash_key | DynamoDB table Hash Key | string | - | yes |
 | hash_key_type | Hash Key type, which must be a scalar type: `S`, `N`, or `B` for (S)tring, (N)umber or (B)inary data | string | `S` | no |
 | local_secondary_index_map | Additional local secondary indexes in the form of a list of mapped values | object | `<list>` | no |
-| name | Name  (e.g. `app` or `cluster`) | string | - | yes |
-| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no |
+| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
+| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
 | range_key | DynamoDB table Range Key | string | `` | no |
 | range_key_type | Range Key type, which must be a scalar type: `S`, `N`, or `B` for (S)tring, (N)umber or (B)inary data | string | `S` | no |
 | regex_replace_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed | string | `/[^a-zA-Z0-9-]/` | no |
-| stage | Stage (e.g. `prod`, `dev`, `staging`, `infra`) | string | `` | no |
+| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no |
 | stream_view_type | When an item in the table is modified, what information is written to the stream | string | `` | no |
-| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map(string) | `<map>` | no |
+| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
 | ttl_attribute | DynamoDB table TTL attribute | string | `Expires` | no |
 
 ## Outputs

main.tf

@@ -3,6 +3,7 @@ module "dynamodb_label" {
   enabled             = var.enabled
   namespace           = var.namespace
   stage               = var.stage
+  environment         = var.environment
   name                = var.name
   delimiter           = var.delimiter
   attributes          = var.attributes
@@ -119,10 +120,11 @@ resource "aws_dynamodb_table" "default" {
 }
 
 module "dynamodb_autoscaler" {
-  source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler.git?ref=tags/0.4.0"
+  source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler.git?ref=tags/0.5.0"
   enabled                      = var.enabled && var.enable_autoscaler && var.billing_mode == "PROVISIONED"
   namespace                    = var.namespace
   stage                        = var.stage
+  environment                  = var.environment
   name                         = var.name
   delimiter                    = var.delimiter
   attributes                   = var.attributes

variables.tf

@@ -1,42 +1,49 @@
 variable "namespace" {
   type        = string
-  description = "Namespace (e.g. `eg` or `cp`)"
   default     = ""
+  description = "Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'"
 }
 
-variable "stage" {
+variable "environment" {
   type        = string
-  description = "Stage (e.g. `prod`, `dev`, `staging`, `infra`)"
   default     = ""
+  description = "Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT'"
 }
 
-variable "enabled" {
-  type        = bool
-  description = "Set to false to prevent the module from creating any resources"
-  default     = true
+variable "stage" {
+  type        = string
+  default     = ""
+  description = "Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'"
 }
 
 variable "name" {
   type        = string
-  description = "Name  (e.g. `app` or `cluster`)"
+  default     = ""
+  description = "Solution name, e.g. 'app' or 'jenkins'"
+}
+
+variable "enabled" {
+  type        = bool
+  default     = true
+  description = "Set to false to prevent the module from creating any resources"
 }
 
 variable "delimiter" {
   type        = string
   default     = "-"
-  description = "Delimiter to be used between `namespace`, `stage`, `name`, and `attributes`"
+  description = "Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`"
 }
 
 variable "attributes" {
   type        = list(string)
   default     = []
-  description = "Additional attributes (e.g. `policy` or `role`)"
+  description = "Additional attributes (e.g. `1`)"
 }
 
 variable "tags" {
   type        = map(string)
   default     = {}
-  description = "Additional tags (e.g. map(`BusinessUnit`,`XYZ`)"
+  description = "Additional tags (e.g. `map('BusinessUnit','XYZ')`"
 }
 
 variable "autoscale_write_target" {