TerraformDevKit 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e92fbd82b70265947a9eb3db56bad0c5b85d78f
-  data.tar.gz: 9048f6a2ea5e8ff08181d87515050ccf10e0931e
+  metadata.gz: 73056367038798386bcc02b1d20f801c27e43ef0
+  data.tar.gz: 0e1f59d12f2dd358ea463360bb3dce9e0f5255b0
 SHA512:
-  metadata.gz: 1ebef969303e8fc2f00e1911a04990d3f3abbf790277f3a863788cdd57ea00bb848c25d5bdb346bd9a931375e3dcd7bbfbdb06a708a83067d950235d77ec6490
-  data.tar.gz: 294017e43b6b007d2c0fc23e93ab7bbed995e65c011eaeda6062ca8a6381f28d1361575ce7cc2ff15e3175d292bd48b7a72570571786f925eccbf6ccf28cfb8b
+  metadata.gz: f61ca6d7b4d70b25298ea785c27245c0e59df4e8e41f8490ece88a33e6e9e900b7e048029bd2429d90b631d519fcf8aa04f1d27754d939a6927f27393609a75f
+  data.tar.gz: 5eef28470ca98ce7e859c20bae13cfc8f1baa4b9c362f2278bd406543c6f0358e80e6e935b04db9572b23679e79984a8c6a17eed01428d5a03dab888e50f80c0

data/README.md

@@ -1,6 +1,6 @@
 # TerraformDevKit
 
-[![Build Status](https://travis-ci.org/vistaprint/TerraformDevKit.svg?branch=master)](https://travis-ci.org/vistaprint/TerraformDevKit) [![Build status](https://ci.appveyor.com/api/projects/status/4vkyr196li83vju6/branch/master?svg=true)](https://ci.appveyor.com/project/betabandido/terraformdevkit/branch/master)
+[![Build Status](https://travis-ci.org/vistaprint/TerraformDevKit.svg?branch=master)](https://travis-ci.org/vistaprint/TerraformDevKit) [![Build status](https://ci.appveyor.com/api/projects/status/74s4yd7dmuwg5tmn/branch/master?svg=true)](https://ci.appveyor.com/project/Vistaprint/terraformdevkit/branch/master)
 
 Set of scripts to ease development and testing with [Terraform](https://www.terraform.io/).
 
@@ -44,6 +44,108 @@ To use the library simply import it as:
 require 'TerraformDevKit'
 ```    
 
+## Managing Terraform Environments
+
+TerraformDevKit provides a set of Rake tasks and Ruby scripts to ease the management of multiple Terraform environments. Three major environment types are supported: `dev`, `test` and `prod`.
+
+There might be many development environments (`dev`), each one with its own name. Development environments use a local Terraform backend. They are intented to be used by developers while adding features to the infrastructure.
+
+Testing (`test`) and production (`prod`) environment use a remote backend. Thus, the Terraform state file is not kept in the local disk, but on S3. This allows multiple developers to easily work on the same infrastructure instance. For safety reasons, operations that affect testing and production environments require manual user input. This is not the case for development environments.
+
+TerraformDevKit expects templated versions (using [Mustache](https://mustache.github.io/)) of the Terraform files. Such files might contain placeholders for several fields such as `Environment`, (AWS) `Region` or (AWS) `Profile`, among others. TerraformDevKit uses the template files to generate the final files that will be consumed by Terraform and Terragrunt. As an example, for the production environment, the resulting files are placed in a directory named `envs/prod`.
+
+### Configuration Files
+
+Configuration files must be placed in a directory named `config`. Each environment type requires a different configuration file. Thus, the following three files must be placed in the `config` directory:
+
+* `config-dev.yml`
+* `config-test.yml`
+* `config-prod.yml`
+
+The first one contains the configuration for **all** the development environments that are created. The other two contain the configuration for the test and production environments, respectively.
+
+A sample configuration files is shown next:
+
+```yaml
+terraform-version: 0.10.8
+terragrunt-version: 0.13.15
+aws:
+  profile: myprofile
+  region: eu-west-1
+```
+
+The AWS profile **must not** be specified for test and production accounts, as users are required to manually type the profile name.
+
+### A Minimal Rakefile
+
+```ruby
+ROOT_PATH = File.dirname(File.expand_path(__FILE__))
+
+spec = Gem::Specification.find_by_name 'TerraformDevKit'
+load "#{spec.gem_dir}/tasks/devkit.rake"
+
+task :custom_test, [:env] do |_, args|
+  # Add some tests here
+end
+```
+
+### Sample Terraform/Terragrunt Templates
+
+The following file (`main.tf.mustache`) contains the infrastructure configuration (a single S3 bucket) as well as information related to the AWS provider.
+
+```hcl
+locals {
+  env    = "{{Environment}}"
+}
+
+terraform {
+    backend {{#LocalBackend}}"local"{{/LocalBackend}}{{^LocalBackend}}"s3"{{/LocalBackend}} {}
+}
+
+provider "aws" {
+  profile = "{{Profile}}"
+  region  = "{{Region}}"
+}
+
+resource "aws_s3_bucket" "raw" {
+  bucket = "foo-${local.env}"
+  acl    = "private"
+
+{{#LocalBackend}}
+  force_destroy = true
+{{/LocalBackend}}
+{{^LocalBackend}}
+  lifecycle {
+    prevent_destroy = true
+  }
+{{/LocalBackend}}
+}
+```
+
+An additional file (`terraform.tfvars.mustache`) contains the Terragrunt configuration. Terragrunt is used as it makes it easier to manage a remote backend. While Terraform is able to keep the state file in S3, it does not transparently create the DynamoDB lock table that prevents multiple developers from concurrently modifying the state file. Terragrunt, however, is able to do this without user intervention.
+
+```hcl
+terragrunt = {
+  remote_state {
+  {{#LocalBackend}}
+    backend = "local"
+    config {}
+  {{/LocalBackend}}
+  {{^LocalBackend}}
+    backend = "s3"
+    config {
+      bucket     = "foo-remote-state"
+      key        = "foo-{{Environment}}.tfstate"
+      lock_table = "foo-{{Environment}}-lock-table"
+      encrypt    = true
+      profile    = "{{Profile}}"
+      region     = "{{Region}}"
+    }
+  {{/LocalBackend}}
+  }
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/TerraformDevKit/terraform_config_manager.rb

@@ -4,14 +4,20 @@ require 'fileutils'
 
 module TerraformDevKit
   class TerraformConfigManager
-    def self.setup(env, extra_vars: {})
+    @extra_vars_proc = proc { {} }
+
+    def self.register_extra_vars_proc(p)
+      @extra_vars_proc = p
+    end
+
+    def self.setup(env)
       fix_configuration(env)
       create_environment_directory(env)
-      render_template_config_files(env, extra_vars)
+      render_template_config_files(env)
     end
 
     def self.update_modules?
-      skip_update = ENV.fetch('TF_DEV_KIT_SKIP_MODULE_UPDATE', 'false')
+      skip_update = ENV.fetch('TF_DEVKIT_SKIP_MODULE_UPDATE', 'false')
                        .strip
                        .downcase
       skip_update != 'true'
@@ -38,7 +44,7 @@ module TerraformDevKit
     end
 
     private_class_method
-    def self.render_template_config_files(env, extra_vars)
+    def self.render_template_config_files(env)
       aws_config = Configuration.get('aws')
       file_list = Dir['*.tf.mustache'] + Dir['*.tfvars.mustache']
       file_list.each do |fname|
@@ -46,7 +52,7 @@ module TerraformDevKit
           File.read(fname),
           env,
           aws_config,
-          extra_vars: extra_vars
+          extra_vars: @extra_vars_proc.call(env)
         )
         config_fname = File.basename(fname, File.extname(fname))
         Dir.chdir(env.working_dir) do
@@ -60,7 +66,7 @@ module TerraformDevKit
       puts "Environment #{env.name} requires manual input of AWS credentials"
       print 'Enter the profile to use: '
       profile = $stdin.gets.tr("\r\n", '')
-      raise 'Invalid profile name' unless /^\w+$/ =~ profile
+      /^\w+$/ =~ profile || (raise 'Invalid profile name')
       profile
     end
   end

data/lib/TerraformDevKit/version.rb

@@ -1,3 +1,3 @@
 module TerraformDevKit
-  VERSION = '0.1.10'.freeze
+  VERSION = '0.1.11'.freeze
 end

data/tasks/devkit.rake

@@ -12,8 +12,6 @@ ENV['PATH'] = TDK::OS.join_env_path(
   ENV['PATH']
 )
 
-TF_CONFIG_EXTRA_VARS = {}.freeze unless defined?(TF_CONFIG_EXTRA_VARS)
-
 def destroy_if_fails(env)
   yield
 rescue StandardError => e
@@ -41,17 +39,19 @@ task :prepare, [:env] do |_, args|
     directory: BIN_PATH
   )
 
-  TDK::TerraformConfigManager.setup(env, extra_vars: TF_CONFIG_EXTRA_VARS)
+  TDK::TerraformConfigManager.setup(env)
 
-  task('custom_prepare').invoke(args.env) if Rake::Task.task_defined?('custom_prepare')
+  if Rake::Task.task_defined?('custom_prepare')
+    task('custom_prepare').invoke(args.env)
+  end
 
   TDK::Command.run(
-    'terragrunt init',
+    'terragrunt init -upgrade=false',
     directory: env.working_dir,
     close_stdin: false
   )
 
-  cmd = 'terragrunt get'
+  cmd  = 'terragrunt get'
   cmd += ' -update=true' if TDK::TerraformConfigManager.update_modules?
   TDK::Command.run(cmd, directory: env.working_dir)
 end
@@ -73,12 +73,14 @@ end
 desc 'Tests a local environment'
 task :test, [:env] do |_, args|
   env = TDK::Environment.new(args.env)
-  raise 'Testing is only allowed for local environments' unless env.local_backend?
+  env.local_backend? || (raise 'Testing is only allowed for local environments')
 
   task('apply').invoke(env.name)
 
   destroy_if_fails(env) do
-    task('custom_test').invoke(args.env) if Rake::Task.task_defined?('custom_test')
+    if Rake::Task.task_defined?('custom_test')
+      task('custom_test').invoke(args.env)
+    end
   end
 end
 
@@ -96,6 +98,9 @@ task :destroy, [:env] => :prepare do |_, args|
   cmd = 'terragrunt destroy'
   cmd += ' -force' if env.local_backend?
   TDK::Command.run(cmd, directory: env.working_dir, close_stdin: false)
+  if Rake::Task.task_defined?('custom_destroy')
+    task('custom_destroy').invoke(args.env)
+  end
 end
 
 desc 'Cleans an environment (infrastructure is destroyed too)'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: TerraformDevKit
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Victor Jimenez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler