terraform-template-renderer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cef4859595c7d96c5122dbe5b058da92806f7905
-  data.tar.gz: 162af8691305d44a0cb024d1f2ceac8efe83a5a4
+  metadata.gz: 48bac62d1bd59cb46a67cfcc05d0a3a92a5d2300
+  data.tar.gz: 3ca5b7f8ce549c3a498bd688e8b9e2b83df16f35
 SHA512:
-  metadata.gz: e221e4184fa8e12e9ce5c0c850071bcdf1a5a84e734872790ba3cb5250112f08547babeab991e13a951aa5246e6d1099c13d310ab4ad0562876446657b13870d
-  data.tar.gz: 372ebfe28e1e7d077c0ea60ed8827410e4d1a6c45c17c39721a684b5af8a025c3ea016ff4b39823baf8c1f4d21839aa38e1eec14d8b602d787c5d320e889f87a
+  metadata.gz: 05208a74a1873f77c36647a90edc1407fe5856b54bb41398f14839256bc8c47152a3ae49c59062ac145d29b71ccb388c1f52bec5ab370377dc61f7e878396453
+  data.tar.gz: 7666c567d1a7c0973ae06b9df0dbf155d6feae5f31ebb2bbb8bc53da5cb4f6cc16c7e11b08591b155aabfa2f2a4c627832735a788f25b187688bc42436ea38f5

data/.gitignore

@@ -10,6 +10,10 @@
 # rspec failure tracking
 .rspec_status
 
-Gemfile.lock
+/Gemfile.lock
 
 .ruby-version
+
+examples/*/.terraform/
+examples/*/terraform.tfstate*
+examples/*/sample_output

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 (2018-01-29)
+
+Features:
+
+ - Enabled trim mode for ERB templates using a hyphen (e.g. `<%- code -%>` will remove preceeding indentation and a
+   following newline).
+ - Example directory giving real usage examples in terraform.
+
 ## 0.1.0 (2018-01-28)
 
 Features:

data/README.md

@@ -22,3 +22,22 @@ The purpose for this strange behaviour is to be a [terraform external
 provider](https://www.terraform.io/docs/providers/external/data_source.html) to render arbitrarily complex templates,
 terraform passes in the variables to render as a json blob to stdin as described above and expects a json blob
 back.
+
+## ERB Template notes
+
+Trim mode is enabled and the trim character is a hyphen `-`.
+
+## Examples
+
+There are a number of examples in the examples folder. To run these examples you will need terraform 0.11, you can run
+the example as follows:
+
+    cd examples/simple_strings
+    terraform init
+    terraform apply
+
+In each example there is an erb template and a terraform file, applying the terraform code will produce a file called
+`example_output`.
+
+___WARNING___: Some of the examples incur AWS costs, _ALWAYS_ remember to `terraform destroy` after you have finished
+running the example. You are solely responsible for any AWS costs incurred running these examples.

data/examples/Gemfile

@@ -0,0 +1 @@
+gem "terraform-template-renderer", path: "../"

data/examples/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: ..
+  specs:
+    terraform-template-renderer (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  terraform-template-renderer!
+
+BUNDLED WITH
+   1.16.1

data/examples/cloudwatch_dashboard/README.md

@@ -0,0 +1,17 @@
+# Multi Resource Lookup example
+
+This example requires applying the terraform in 2 stages. The easiest way to do this is to comment
+out everything in `cloudwatch_dashboard.tf` run `terraform apply`, allow the aws instances to be created,
+and then uncomment `cloudwatch_dashboard.tf`
+
+This example directory includes a screenshot of the resultant dashboard which was a result of running terraform
+apply as described above.
+
+## COSTS!
+
+Be warned, this example will cost money to perform, it requires starting up 2 t2.nano instances and an ELB.
+You are solely responsible for any resources created and costs incurred.
+
+I strongly recommend running `terraform destroy` once you have finished running the test to remove all the resources
+that the test created.
+

data/examples/cloudwatch_dashboard/cloudwatch_dashboard.erb

@@ -0,0 +1,136 @@
+<%
+  def instances_by_name_list_for(statistic)
+    rows = JSON.parse(@instances_by_name).map do |instance|
+      row = ["AWS/EC2", statistic, "InstanceId", instance["id"], { label: instance["name"] }]
+      JSON.dump(row)
+    end
+    rows.join(",")
+  end
+
+  def instances_by_id_list_for(statistic)
+    rows = JSON.parse(@instances_by_id).map do |instance|
+      row = ["AWS/EC2", statistic, "InstanceId", instance]
+      JSON.dump(row)
+    end
+    rows.join(",")
+  end
+
+-%>
+{
+  "widgets": [
+    {
+      "type": "text",
+      "x": 0,
+      "y": 0,
+      "width": 24,
+      "height": 1,
+      "properties": {
+        "markdown": "## Instances"
+      }
+    },
+    {
+      "type": "metric",
+      "x": 0,
+      "y": 1,
+      "width": 12,
+      "height": 5,
+      "properties": {
+        "metrics": [<%=instances_by_name_list_for("NetworkIn")%>],
+        "period": 300,
+        "stat": "Maximum",
+        "region": "eu-west-1",
+        "title": "Network In"
+      }
+    },
+    {
+      "type": "metric",
+      "x": 12,
+      "y": 1,
+      "width": 12,
+      "height": 5,
+      "properties": {
+        "metrics": [<%=instances_by_name_list_for("NetworkOut")%>],
+        "period": 300,
+        "stat": "Maximum",
+        "region": "eu-west-1",
+        "title": "Network Out"
+      }
+    },
+    {
+      "type": "metric",
+      "x": 0,
+      "y": 6,
+      "width": 24,
+      "height": 5,
+      "properties": {
+        "metrics": [<%=instances_by_id_list_for("CPUUtilization")%>],
+        "period": 300,
+        "stat": "Maximum",
+        "region": "eu-west-1",
+        "title": "EC2 Instance CPU"
+      }
+    },
+    {
+      "type": "text",
+      "x": 0,
+      "y": 11,
+      "width": 24,
+      "height": 1,
+      "properties": {
+        "markdown": "## ELB"
+      }
+    },
+    {
+      "type": "metric",
+      "x": 0,
+      "y": 12,
+      "width": 8,
+      "height": 5,
+      "properties": {
+        "metrics": [
+          [ "AWS/ELB", "HealthyHostCount", "LoadBalancerName", "<%=@elb_name%>" ],
+          [ "AWS/ELB", "UnHealthyHostCount", "LoadBalancerName", "<%=@elb_name%>" ]
+        ],
+        "period": 300,
+        "stat": "Maximum",
+        "region": "eu-west-1",
+        "title": "Host Health"
+      }
+    },
+    {
+      "type": "metric",
+      "x": 8,
+      "y": 12,
+      "width": 8,
+      "height": 5,
+      "properties": {
+        "metrics": [
+          [ "AWS/ELB", "RequestCount", "LoadBalancerName", "<%=@elb_name%>" ]
+        ],
+        "period": 300,
+        "stat": "Maximum",
+        "region": "eu-west-1",
+        "title": "Request Latency"
+      }
+    },
+    {
+      "type": "metric",
+      "x": 16,
+      "y": 12,
+      "width": 8,
+      "height": 5,
+      "properties": {
+        "metrics": [
+          [ "AWS/ELB", "HTTPCode_Backend_2XX", "LoadBalancerName", "<%=@elb_name%>", { "label": "2xx responses" } ],
+          [ "AWS/ELB", "HTTPCode_Backend_3XX", "LoadBalancerName", "<%=@elb_name%>", { "label": "3xx responses" } ],
+          [ "AWS/ELB", "HTTPCode_Backend_4XX", "LoadBalancerName", "<%=@elb_name%>", { "label": "4xx responses" } ],
+          [ "AWS/ELB", "HTTPCode_Backend_5XX", "LoadBalancerName", "<%=@elb_name%>", { "label": "5xx responses" } ]
+        ],
+        "period": 300,
+        "stat": "Maximum",
+        "region": "eu-west-1",
+        "title": "Request Latency"
+      }
+    }
+  ]
+}

data/examples/cloudwatch_dashboard/cloudwatch_dashboard.tf

@@ -0,0 +1,32 @@
+data "aws_instances" "cloudwatch_dashboard" {
+  instance_tags {
+    Stage = "Development"
+  }
+}
+
+locals {
+  aws_instances_by_name = [
+    { name = "${aws_instance.cloudwatch_dashboard_1.tags.Name}", id = "${aws_instance.cloudwatch_dashboard_1.id}" },
+    { name = "${aws_instance.cloudwatch_dashboard_2.tags.Name}", id = "${aws_instance.cloudwatch_dashboard_2.id}" }
+  ]
+}
+
+data "external" "cloudwatch_dashboard" {
+  program = ["bundle", "exec", "render-template", "cloudwatch_dashboard.erb"]
+
+  query {
+    instances_by_name = "${jsonencode(local.aws_instances_by_name)}"
+    instances_by_id = "${jsonencode(data.aws_instances.cloudwatch_dashboard.ids)}"
+    elb_name = "${aws_elb.cloudwatch_dashboard.name}"    
+  }
+}
+
+resource "aws_cloudwatch_dashboard" "cloudwatch_dashboard" {
+  dashboard_name = "TerraformTemplateRendererExample"
+  dashboard_body = "${data.external.cloudwatch_dashboard.result.rendered}"
+}
+
+resource "local_file" "cloudwatch_dashboard" {
+  content = "${data.external.cloudwatch_dashboard.result.rendered}"
+  filename = "sample_output"
+}

data/examples/cloudwatch_dashboard/terraform_setup.tf

@@ -0,0 +1,97 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+provider "aws" {
+  version = "~> 1.7"
+  region = "eu-west-1"
+}
+
+resource "aws_vpc" "cloudwatch_dashboard" {
+  cidr_block = "10.254.254.0/24"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+  }
+}
+
+resource "aws_internet_gateway" "cloudwatch_dashboard" {
+  vpc_id = "${aws_vpc.cloudwatch_dashboard.id}"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+  }
+}
+
+resource "aws_subnet" "cloudwatch_dashboard" {
+  vpc_id = "${aws_vpc.cloudwatch_dashboard.id}"
+  cidr_block = "10.254.254.0/24"
+  availability_zone = "eu-west-1a"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+  }
+}
+
+data "aws_ami" "cloudwatch_dashboard" {
+  most_recent      = true
+
+  filter {
+    name   = "name"
+    values = ["amzn-ami-2017.09.*-amazon-ecs-optimized"]
+  }
+
+  owners     = ["amazon"]
+}
+
+resource "aws_instance" "cloudwatch_dashboard_1" {
+  ami = "${data.aws_ami.cloudwatch_dashboard.id}"
+  instance_type = "t2.nano"
+  subnet_id = "${aws_subnet.cloudwatch_dashboard.id}"
+
+  tags {
+    Name = "terraform-template-renderer-example-1"
+    Stage = "Development"
+  }
+}
+
+resource "aws_instance" "cloudwatch_dashboard_2" {
+  ami = "${data.aws_ami.cloudwatch_dashboard.id}"
+  instance_type = "t2.nano"
+  subnet_id = "${aws_subnet.cloudwatch_dashboard.id}"
+
+  tags {
+    Name = "terraform-template-renderer-example-2"
+    Stage = "Development"
+  }
+}
+
+resource "aws_elb" "cloudwatch_dashboard" {
+  name = "terraform-template-renderer-ex"
+  subnets = ["${aws_subnet.cloudwatch_dashboard.id}"]
+
+  instances = [
+    "${aws_instance.cloudwatch_dashboard_1.id}",
+    "${aws_instance.cloudwatch_dashboard_2.id}"
+  ]
+
+  listener {
+    instance_port = 80
+    instance_protocol = "HTTP"
+    lb_port = 80
+    lb_protocol = "HTTP"
+  }
+
+  tags {
+    Name = "terraform-template-renderer-example"
+    Stage = "Development"
+  }
+
+  depends_on = [
+    "aws_internet_gateway.cloudwatch_dashboard"
+  ]
+}

data/examples/json_encoded_hash/json_encoded_hash.erb

@@ -0,0 +1,3 @@
+<% hash = JSON.parse(@hash) %>
+KEY1 [<%=hash["key1"]%>]
+KEY2 [<%=hash["key2"]%>]

data/examples/json_encoded_hash/json_encoded_hash.tf

@@ -0,0 +1,25 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+data "external" "json_encoded_hash" {
+  program = ["bundle", "exec", "render-template", "json_encoded_hash.erb"]
+
+  query {
+    hash = <<EOF
+{
+  "key1": "value1",
+  "key2": "value2"
+}
+EOF
+  }
+}
+
+resource "local_file" "json_encoded_hash" {
+  content = "${data.external.json_encoded_hash.result.rendered}"
+  filename = "sample_output"
+}

data/examples/multi_resource_lookup/README.md

@@ -0,0 +1,14 @@
+# Multi Resource Lookup example
+
+This example requires applying the terraform in 2 stages. The easiest way to do this is to comment
+out everything in `multi_resource_lookup.tf` run `terraform apply`, allow the aws instances to be created,
+and then uncomment `multi_resource_lookup.tf`
+
+## COSTS!
+
+Be warned, this example will cost money to perform, it requires starting up 2 t2.nano instances. You are solely
+responsible for any resources created or costs incurred.
+
+I strongly recommend running `terraform destroy` once you have finished running the test to remove all the resources
+that the test created.
+

data/examples/multi_resource_lookup/multi_resource_lookup.erb

@@ -0,0 +1,7 @@
+<%=
+  lines = JSON.parse(@instances).map.with_index do |instance_id, index|
+    "#{index} [#{instance_id}]"
+  end
+
+  lines.join("\n")
+%>

data/examples/multi_resource_lookup/multi_resource_lookup.tf

@@ -0,0 +1,18 @@
+data "aws_instances" "multi_resource_lookup" {
+  instance_tags {
+    Stage = "Development"
+  }
+}
+
+data "external" "multi_resource_lookup" {
+  program = ["bundle", "exec", "render-template", "multi_resource_lookup.erb"]
+
+  query {
+    instances = "${jsonencode(data.aws_instances.multi_resource_lookup.ids)}"
+  }
+}
+
+resource "local_file" "multi_resource_lookup" {
+  content = "${data.external.multi_resource_lookup.result.rendered}"
+  filename = "sample_output"
+}

data/examples/multi_resource_lookup/terraform_setup.tf

@@ -0,0 +1,63 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+provider "aws" {
+  version = "~> 1.7"
+  region = "eu-west-1"
+}
+
+resource "aws_vpc" "multi_resource_lookup" {
+  cidr_block = "10.254.254.0/24"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+  }
+}
+
+resource "aws_subnet" "multi_resource_lookup" {
+  vpc_id = "${aws_vpc.multi_resource_lookup.id}"
+  cidr_block = "10.254.254.0/24"
+  availability_zone = "eu-west-1a"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+  }
+}
+
+data "aws_ami" "multi_resource_lookup" {
+  most_recent      = true
+
+  filter {
+    name   = "name"
+    values = ["amzn-ami-2017.09.*-amazon-ecs-optimized"]
+  }
+
+  owners     = ["amazon"]
+}
+
+resource "aws_instance" "multi_resource_lookup_1" {
+  ami = "${data.aws_ami.multi_resource_lookup.id}"
+  instance_type = "t2.nano"
+  subnet_id = "${aws_subnet.multi_resource_lookup.id}"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+    Stage = "Development"
+  }
+}
+
+resource "aws_instance" "multi_resource_lookup_2" {
+  ami = "${data.aws_ami.multi_resource_lookup.id}"
+  instance_type = "t2.nano"
+  subnet_id = "${aws_subnet.multi_resource_lookup.id}"
+
+  tags {
+    Name = "terraform-template-renderer-example"
+    Stage = "Development"
+  }
+}

data/examples/simple_list/simple_list.erb

@@ -0,0 +1,7 @@
+<%=
+  lines = JSON.parse(@list).map.with_index do |item, index|
+    "KEY#{index} [#{item}]"
+  end
+
+  lines.join("\n")
+%>

data/examples/simple_list/simple_list.tf

@@ -0,0 +1,22 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+variable "simple_list" { default = ["list_value_a", "list_value_2"] }
+
+data "external" "simple_list" {
+  program = ["bundle", "exec", "render-template", "simple_list.erb"]
+
+  query {
+    list = "${jsonencode(var.simple_list)}"
+  }
+}
+
+resource "local_file" "simple_list" {
+  content = "${data.external.simple_list.result.rendered}"
+  filename = "sample_output"
+}

data/examples/simple_map/simple_map.erb

@@ -0,0 +1,7 @@
+<%=
+  lines = JSON.parse(@map).map do |key, value|
+    "#{key} [#{value}]"
+  end
+
+  lines.join("\n")
+%>

data/examples/simple_map/simple_map.tf

@@ -0,0 +1,27 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+variable "simple_map" {
+  default = {
+    key1 = "value1"
+    key2 = "value2"
+  }
+} 
+
+data "external" "simple_map" {
+  program = ["bundle", "exec", "render-template", "simple_map.erb"]
+
+  query {
+    map = "${jsonencode(var.simple_map)}"
+  }
+}
+
+resource "local_file" "simple_map" {
+  content = "${data.external.simple_map.result.rendered}"
+  filename = "sample_output"
+}

data/examples/simple_strings/simple_strings.erb

@@ -0,0 +1,2 @@
+KEY1 [<%=@key1%>]
+KEY2 [<%=@key2%>]

data/examples/simple_strings/simple_strings.tf

@@ -0,0 +1,21 @@
+terraform {
+  required_version = "~> 0.11.1"
+}
+
+provider "external" {
+  version = "~> 1.0.0"
+}
+
+data "external" "simple_strings" {
+  program = ["bundle", "exec", "render-template", "simple_strings.erb"]
+
+  query {
+    key1 = "value1" 
+    key2 = "value2"
+  }
+}
+
+resource "local_file" "simple_strings" {
+  content = "${data.external.simple_strings.result.rendered}"
+  filename = "sample_output"
+}

data/lib/terraform_template_renderer/renderer.rb

@@ -4,7 +4,8 @@ require "json"
 module TerraformTemplateRenderer
   class Renderer
     def initialize(template)
-      @erb_template = ERB.new(template)
+      # The third argument enables trim mode using a hyphen
+      @erb_template = ERB.new(template, nil, "-")
     end
 
     # The passed in json_variables needs to be a JSON object (not array), all the keys will be used

data/lib/terraform_template_renderer/version.rb

@@ -1,3 +1,3 @@
 module TerraformTemplateRenderer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraform-template-renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Harden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -104,6 +104,25 @@ files:
 - Rakefile
 - bin/rake
 - bin/rspec
+- examples/Gemfile
+- examples/Gemfile.lock
+- examples/cloudwatch_dashboard/README.md
+- examples/cloudwatch_dashboard/cloudwatch_dashboard.erb
+- examples/cloudwatch_dashboard/cloudwatch_dashboard.png
+- examples/cloudwatch_dashboard/cloudwatch_dashboard.tf
+- examples/cloudwatch_dashboard/terraform_setup.tf
+- examples/json_encoded_hash/json_encoded_hash.erb
+- examples/json_encoded_hash/json_encoded_hash.tf
+- examples/multi_resource_lookup/README.md
+- examples/multi_resource_lookup/multi_resource_lookup.erb
+- examples/multi_resource_lookup/multi_resource_lookup.tf
+- examples/multi_resource_lookup/terraform_setup.tf
+- examples/simple_list/simple_list.erb
+- examples/simple_list/simple_list.tf
+- examples/simple_map/simple_map.erb
+- examples/simple_map/simple_map.tf
+- examples/simple_strings/simple_strings.erb
+- examples/simple_strings/simple_strings.tf
 - exe/render-template
 - lib/terraform_template_renderer.rb
 - lib/terraform_template_renderer/binding.rb