Make range_key optional (#17)

aknysh · web-flow · commit d474d242826f · 2018-08-24T14:26:53.000-04:00
diff --git a/Makefile b/Makefile
@@ -7,4 +7,4 @@ export README_DEPS ?= docs/targets.md docs/terraform.md
 
 ## Lint terraform code
 lint:
-	$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate
+	$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE).
 ```hcl
 module "dynamodb_table" {
   source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
-  namespace                    = "cp"
+  namespace                    = "eg"
   stage                        = "dev"
   name                         = "cluster"
   hash_key                     = "HashKey"
@@ -55,7 +55,7 @@ module "dynamodb_table" {
 ```hcl
 module "dynamodb_table" {
   source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
-  namespace                    = "cp"
+  namespace                    = "eg"
   stage                        = "dev"
   name                         = "cluster"
   hash_key                     = "HashKey"
@@ -107,8 +107,9 @@ module "dynamodb_table" {
 ```
 Available targets:
 
-  help                                This help screen
+  help                                Help screen
   help/all                            Display help for all targets
+  help/short                          This help short screen
   lint                                Lint terraform code
 
 ```
@@ -133,11 +134,11 @@ Available targets:
 | global_secondary_index_map | Additional global secondary indexes in the form of a list of mapped values | list | `<list>` | no |
 | hash_key | DynamoDB table Hash Key | string | - | yes |
 | name | Name  (e.g. `app` or `cluster`) | string | - | yes |
-| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes |
-| range_key | DynamoDB table Range Key | string | - | yes |
+| namespace | Namespace (e.g. `eg` or `cp`) | string | - | yes |
+| range_key | DynamoDB table Range Key | string | `` | no |
 | stage | Stage (e.g. `prod`, `dev`, `staging`, `infra`) | string | - | yes |
 | 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 | `<map>` | no |
+| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `<map>` | no |
 | ttl_attribute | DynamoDB table TTL attribute | string | `Expires` | no |
 
 ## Outputs
diff --git a/README.yaml b/README.yaml
@@ -37,19 +37,19 @@ related:
     url: "https://github.com/cloudposse/terraform-aws-tfstate-backend"
   - name: "terraform-aws-elasticache-redis"
     description: "Terraform module to provision an ElastiCache Redis Cluster"
-    url: "https://github.com/cloudposse/terraform-aws-elasticache-redis"  
+    url: "https://github.com/cloudposse/terraform-aws-elasticache-redis"
   - name: "terraform-aws-elasticache-memcached"
     description: "Terraform Module for ElastiCache Memcached Cluster"
-    url: "https://github.com/cloudposse/terraform-aws-elasticache-memcached"  
+    url: "https://github.com/cloudposse/terraform-aws-elasticache-memcached"
   - name: "terraform-aws-elasticache-cloudwatch-sns-alarms"
     description: "Terraform module that configures CloudWatch SNS alerts for ElastiCache"
-    url: "https://github.com/cloudposse/terraform-aws-elasticache-cloudwatch-sns-alarms"  
+    url: "https://github.com/cloudposse/terraform-aws-elasticache-cloudwatch-sns-alarms"
   - name: "terraform-aws-rds-cluster"
     description: "Terraform module to provision an RDS Aurora cluster for MySQL or Postgres"
-    url: "https://github.com/cloudposse/terraform-aws-rds-cluster"  
+    url: "https://github.com/cloudposse/terraform-aws-rds-cluster"
   - name: "terraform-aws-rds"
     description: "Terraform module to provision AWS RDS instances"
-    url: "https://github.com/cloudposse/terraform-aws-rds"  
+    url: "https://github.com/cloudposse/terraform-aws-rds"
 
 # Short description of this project
 description: |-
@@ -66,7 +66,7 @@ usage: |-
   ```hcl
   module "dynamodb_table" {
     source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
-    namespace                    = "cp"
+    namespace                    = "eg"
     stage                        = "dev"
     name                         = "cluster"
     hash_key                     = "HashKey"
@@ -86,7 +86,7 @@ usage: |-
   ```hcl
   module "dynamodb_table" {
     source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
-    namespace                    = "cp"
+    namespace                    = "eg"
     stage                        = "dev"
     name                         = "cluster"
     hash_key                     = "HashKey"
@@ -142,4 +142,4 @@ contributors:
   - name: "Jamie Nelson"
     github: "Jamie-BitFlight"
   - name: "Daren Desjardins"
-    github: "darend"
+    github: "darend"
diff --git a/docs/targets.md b/docs/targets.md
@@ -2,8 +2,9 @@
 ```
 Available targets:
 
-  help                                This help screen
+  help                                Help screen
   help/all                            Display help for all targets
+  help/short                          This help short screen
   lint                                Lint terraform code
 
 ```
diff --git a/docs/terraform.md b/docs/terraform.md
@@ -19,11 +19,11 @@
 | global_secondary_index_map | Additional global secondary indexes in the form of a list of mapped values | list | `<list>` | no |
 | hash_key | DynamoDB table Hash Key | string | - | yes |
 | name | Name  (e.g. `app` or `cluster`) | string | - | yes |
-| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes |
-| range_key | DynamoDB table Range Key | string | - | yes |
+| namespace | Namespace (e.g. `eg` or `cp`) | string | - | yes |
+| range_key | DynamoDB table Range Key | string | `` | no |
 | stage | Stage (e.g. `prod`, `dev`, `staging`, `infra`) | string | - | yes |
 | 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 | `<map>` | no |
+| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `<map>` | no |
 | ttl_attribute | DynamoDB table TTL attribute | string | `Expires` | no |
 
 ## Outputs
diff --git a/main.tf b/main.tf
@@ -1,5 +1,5 @@
 module "dynamodb_label" {
-  source     = "git::https://github.com/cloudposse/terraform-terraform-label.git?ref=tags/0.1.2"
+  source     = "git::https://github.com/cloudposse/terraform-terraform-label.git?ref=tags/0.1.6"
   namespace  = "${var.namespace}"
   stage      = "${var.stage}"
   name       = "${var.name}"
@@ -9,16 +9,23 @@ module "dynamodb_label" {
 }
 
 locals {
-  attributes = [{
-    name = "${var.hash_key}"
-    type = "S"
-  },
+  attributes = [
     {
       name = "${var.range_key}"
       type = "S"
     },
+    {
+      name = "${var.hash_key}"
+      type = "S"
+    },
     "${var.dynamodb_attributes}",
   ]
+
+  # Use the `slice` pattern (instead of `conditional`) to remove the first map from the list if no `range_key` is provided
+  # Terraform does not support conditionals with `lists` and `maps`: aws_dynamodb_table.default: conditional operator cannot be used with list values
+  from_index = "${length(var.range_key) > 0 ? 0 : 1}"
+
+  attributes_final = "${slice(local.attributes, local.from_index, length(local.attributes))}"
 }
 
 resource "null_resource" "global_secondary_indexes" {
@@ -47,7 +54,7 @@ resource "aws_dynamodb_table" "default" {
     ignore_changes = ["read_capacity", "write_capacity"]
   }
 
-  attribute              = ["${local.attributes}"]
+  attribute              = ["${local.attributes_final}"]
   global_secondary_index = ["${var.global_secondary_index_map}"]
 
   ttl {
@@ -59,7 +66,7 @@ resource "aws_dynamodb_table" "default" {
 }
 
 module "dynamodb_autoscaler" {
-  source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler.git?ref=tags/0.2.1"
+  source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler.git?ref=tags/0.2.4"
   enabled                      = "${var.enable_autoscaler}"
   namespace                    = "${var.namespace}"
   stage                        = "${var.stage}"
diff --git a/variables.tf b/variables.tf
@@ -1,6 +1,6 @@
 variable "namespace" {
   type        = "string"
-  description = "Namespace (e.g. `cp` or `cloudposse`)"
+  description = "Namespace (e.g. `eg` or `cp`)"
 }
 
 variable "stage" {
@@ -28,7 +28,7 @@ variable "attributes" {
 variable "tags" {
   type        = "map"
   default     = {}
-  description = "Additional tags (e.g. map('BusinessUnit`,`XYZ`)"
+  description = "Additional tags (e.g. map(`BusinessUnit`,`XYZ`)"
 }
 
 variable "autoscale_write_target" {
@@ -92,6 +92,7 @@ variable "hash_key" {
 
 variable "range_key" {
   type        = "string"
+  default     = ""
   description = "DynamoDB table Range Key"
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`variable "namespace" {`
`2`	`2`	`type = "string"`
`3`		- description = "Namespace (e.g. `cp` or `cloudposse`)"
	`3`	+ description = "Namespace (e.g. `eg` or `cp`)"
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`variable "stage" {`
`@@ -28,7 +28,7 @@ variable "attributes" {`
`28`	`28`	`variable "tags" {`
`29`	`29`	`type = "map"`
`30`	`30`	`default = {}`
`31`		- description = "Additional tags (e.g. map('BusinessUnit`,`XYZ`)"
	`31`	+ description = "Additional tags (e.g. map(`BusinessUnit`,`XYZ`)"
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`variable "autoscale_write_target" {`
`@@ -92,6 +92,7 @@ variable "hash_key" {`
`92`	`92`
`93`	`93`	`variable "range_key" {`
`94`	`94`	`type = "string"`
	`95`	`+ default = ""`
`95`	`96`	`description = "DynamoDB table Range Key"`
`96`	`97`	`}`
`97`	`98`