nathanielks · June 3, 2023 17:24 · Dec 3, 2015 · Dec 3, 2015 · Jul 28, 2015 · Jul 28, 2015
diff --git a/README.md b/README.md
@@ -27,4 +27,6 @@ Caveat: this won't work if you've written a plan out to a file and then try to a
 ./terraform-env.sh apply plan
 ```
 
-The above will not work. It's recommend you just run `terraform apply plan` as the plan file will contain all the necessary bits to run the apply.
+The above will not work. It's recommend you just run `terraform apply plan` as the plan file will contain all the necessary bits to run the apply.
+
+This script also allows you to use environment-specific config files. For example, you could have specific dns settings for production in `env/production/dns-extra.tf` and the script will copy the file into the directory you're calling the script from, run terraform, then delete the copied file.
diff --git a/README.md b/README.md
@@ -3,9 +3,10 @@ This script will pull down an S3 remote configuration before running any terrafo
 ```
 main.tf
 terraform.cfg
-vars/dev
-vars/staging
-vars/production
+env/dev/vars
+env/staging/vars
+env/whatever/vars
+env/whatever/somefile.tf
 ```
 
 `terraform.cfg` is required for the remote configuration.

diff --git a/terraform-env.sh b/terraform-env.sh
@@ -1,4 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
+set -o pipefail
+set -u
 
 function help {
     echo "usage: ${0} <environment> <action> [<args>]"
@@ -13,39 +16,42 @@ function contains_element () {
     return 1
 }
 
+function files_exist(){
+  ls ${1} 1> /dev/null 2>&1
+}
+
 #All of the args are mandatory.
 if [ $# -lt 1 ]; then
     help
 fi
 
+
+# Let's set up our environment
+export ENVIRONMENT=$1
+export ACTION=$2
+ADDTL_PARAMS=${*:3}
+
+CONFIG_FILE=./terraform.cfg
+
 # Let's check the existence of the config file
-if [ ! -f $CFG_FILE ]; then
-    echo "Error: $CFG_FILE does not exist. You'll need to create a config file so we know where to set up the remote config."
+if [ ! -f $CONFIG_FILE ]; then
+    echo "Error: $CONFIG_FILE does not exist. You'll need to create a config file so we know where to set up the remote config."
     exit 1
 fi
 
-source ./terraform.cfg
-
-# Let's set up our environment
-if [[ $default_environment && ${default_environment-x} ]]
-then
-    ENVIRONMENT=$default_environment
-    ACTION=$1
-    ADDTL_PARAMS=${*:2}
-else
-    ENVIRONMENT=$1
-    ACTION=$2
-    ADDTL_PARAMS=${*:3}
-fi
+source ${CONFIG_FILE}
 
 # Let's set up our variables
 ALLOWS_VARFILE=(apply plan push refresh destroy)
 ENV_FILE=.terraform/environment
-VARS_FILE=vars/$ENVIRONMENT
+ENV_DIR=env/$ENVIRONMENT
+VARS_FILE=${ENV_DIR}/vars
 VARS_FILE_FLAG=
 BUCKET_KEY=$bucket_prefix/state/$ENVIRONMENT
 PREVIOUS_ENVIRONMENT=$([ -f $ENV_FILE ] && echo "$(<$ENV_FILE)" || echo "previous")
-
+EXTRA_ARGS=${extra_args:-''}
+PRE_CMD=${pre_command:-''}
+POST_CMD=${post_command:-''}
 
 # Let's check to see if a vars file exists for the requested environment before proceeding
 if [ ! -f $VARS_FILE ]; then
@@ -60,7 +66,8 @@ if [ $? -eq 0 ]; then
 fi
 
 # Let's check if the requested environment is different from the previous environment
-if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]; then
+if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ] || [ ! -f '.terraform/terraform.tfstate' ]
+then
 
     # Move current state out of the way to make room for the new state
     mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$PREVIOUS_ENVIRONMENT > /dev/null 2>&1
@@ -74,5 +81,23 @@ if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]; then
 
 fi
 
+# Let's run the PRE_CMD hook if it's defined
+eval ${PRE_CMD}
+
+# let's copy environment specific configuration to the root of the directory
+if files_exist ${ENV_DIR}/*.tf; then
+  cd env/${ENVIRONMENT}
+    pax -wrs'/\.tf$/\.env\.tf/' *.tf ../../
+  cd ../../
+fi
+
 # Let's do work!
-terraform $ACTION $VARS_FILE_FLAG $ADDTL_PARAMS
+terraform $ACTION $VARS_FILE_FLAG $ADDTL_PARAMS ${EXTRA_ARGS}
+
+# Let's remove those environment-specific configuration files we copied earlier
+if files_exist *.env.tf; then
+  rm *.env.tf
+fi
+
+# Let's run the POST_CMD hook if it's defined
+eval ${POST_CMD}
diff --git a/terraform.cfg b/terraform.cfg
@@ -1,4 +1,8 @@
 bucket=some_secret_bucket
 bucket_prefix=example
 region=us-east-1
-default_environment=dev # This is optional. if set, specifying the environment before running commands isn't necessary
+
+# Both are optional. This allows you to run scripts before and after terraform executes
+# (perhaps to decrypt/encrypt files, move files, modify templates, etc)
+pre_command='bin/pre.sh'
+post_command='bin/post.sh'
diff --git a/README.md b/README.md
@@ -17,4 +17,13 @@ You can use it like so:
 ./terraform-env.sh production apply -var="some_var=some_value"
 ```
 
-You can use the script just like you'd use `terraform`, passing whatever arguments you would before. It will only pull the latest environment if the current environment is different from the one you're requesting.
+You can use the script just like you'd use `terraform`, passing whatever arguments you would before. It will only pull the latest environment if the current environment is different from the one you're requesting.
+
+Caveat: this won't work if you've written a plan out to a file and then try to apply that plan as `terraform apply` doesn't accept the `-var-file` flag when reading from a plan. For reference:
+
+```
+./terraform-env.sh plan -out plan
+./terraform-env.sh apply plan
+```
+
+The above will not work. It's recommend you just run `terraform apply plan` as the plan file will contain all the necessary bits to run the apply.
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -63,8 +63,8 @@ fi
 if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]; then
 
     # Move current state out of the way to make room for the new state
-    mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$PREVIOUS_ENVIRONMENT &>2
-    mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$PREVIOUS_ENVIRONMENT &>2
+    mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$PREVIOUS_ENVIRONMENT > /dev/null 2>&1
+    mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$PREVIOUS_ENVIRONMENT > /dev/null 2>&1
 
     # Let's log the new environment for later
     echo $ENVIRONMENT > $ENV_FILE

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ vars/staging
 vars/production
 ```
 
-`ansible.cfg` is required for the remote configuration.
+`terraform.cfg` is required for the remote configuration.
 
 You can use it like so:
 ```

diff --git a/terraform-env.sh b/terraform-env.sh
@@ -14,26 +14,37 @@ function contains_element () {
 }
 
 #All of the args are mandatory.
-if [ $# -lt 2 ]; then
+if [ $# -lt 1 ]; then
     help
 fi
 
-# Let's set up our variables
-ENVIRONMENT=$1
-ACTION=$2
-ALLOWS_VARFILE=(apply plan push refresh destroy)
-ENV_FILE=.terraform/environment
-VARS_FILE=vars/$ENVIRONMENT
-CFG_FILE=./terraform.cfg
-VARS_FILE_FLAG=
-
 # Let's check the existence of the config file
 if [ ! -f $CFG_FILE ]; then
     echo "Error: $CFG_FILE does not exist. You'll need to create a config file so we know where to set up the remote config."
     exit 1
 fi
 
-source $CFG_FILE
+source ./terraform.cfg
+
+# Let's set up our environment
+if [[ $default_environment && ${default_environment-x} ]]
+then
+    ENVIRONMENT=$default_environment
+    ACTION=$1
+    ADDTL_PARAMS=${*:2}
+else
+    ENVIRONMENT=$1
+    ACTION=$2
+    ADDTL_PARAMS=${*:3}
+fi
+
+# Let's set up our variables
+ALLOWS_VARFILE=(apply plan push refresh destroy)
+ENV_FILE=.terraform/environment
+VARS_FILE=vars/$ENVIRONMENT
+VARS_FILE_FLAG=
+BUCKET_KEY=$bucket_prefix/state/$ENVIRONMENT
+PREVIOUS_ENVIRONMENT=$([ -f $ENV_FILE ] && echo "$(<$ENV_FILE)" || echo "previous")
 
 
 # Let's check to see if a vars file exists for the requested environment before proceeding
@@ -49,7 +60,6 @@ if [ $? -eq 0 ]; then
 fi
 
 # Let's check if the requested environment is different from the previous environment
-PREVIOUS_ENVIRONMENT=$([ -f $ENV_FILE ] && echo "$(<$ENV_FILE)" || echo "previous")
 if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]; then
 
     # Move current state out of the way to make room for the new state
@@ -60,9 +70,9 @@ if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]; then
     echo $ENVIRONMENT > $ENV_FILE
 
     # Set up remote configuration and pull latest version
-    terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
+    terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$BUCKET_KEY" -backend-config="region=$region"
 
 fi
 
 # Let's do work!
-terraform $ACTION $VARS_FILE_FLAG ${*:3}
+terraform $ACTION $VARS_FILE_FLAG $ADDTL_PARAMS
diff --git a/terraform.cfg b/terraform.cfg
@@ -1,4 +1,4 @@
 bucket=some_secret_bucket
 bucket_prefix=example
 region=us-east-1
-bucket_key=$bucket_prefix/state/$ENVIRONMENT
+default_environment=dev # This is optional. if set, specifying the environment before running commands isn't necessary
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -24,9 +24,16 @@ ACTION=$2
 ALLOWS_VARFILE=(apply plan push refresh destroy)
 ENV_FILE=.terraform/environment
 VARS_FILE=vars/$ENVIRONMENT
+CFG_FILE=./terraform.cfg
 VARS_FILE_FLAG=
 
-source ./terraform.cfg
+# Let's check the existence of the config file
+if [ ! -f $CFG_FILE ]; then
+    echo "Error: $CFG_FILE does not exist. You'll need to create a config file so we know where to set up the remote config."
+    exit 1
+fi
+
+source $CFG_FILE
 
 
 # Let's check to see if a vars file exists for the requested environment before proceeding

diff --git a/terraform-env.sh b/terraform-env.sh
@@ -21,7 +21,7 @@ fi
 # Let's set up our variables
 ENVIRONMENT=$1
 ACTION=$2
-ALLOWS_VARFILE=(apply plan push refresh)
+ALLOWS_VARFILE=(apply plan push refresh destroy)
 ENV_FILE=.terraform/environment
 VARS_FILE=vars/$ENVIRONMENT
 VARS_FILE_FLAG=

diff --git a/terraform-env.sh b/terraform-env.sh
@@ -43,8 +43,7 @@ fi
 
 # Let's check if the requested environment is different from the previous environment
 PREVIOUS_ENVIRONMENT=$([ -f $ENV_FILE ] && echo "$(<$ENV_FILE)" || echo "previous")
-if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]
-then
+if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]; then
 
     # Move current state out of the way to make room for the new state
     mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$PREVIOUS_ENVIRONMENT &>2

diff --git a/terraform-env.sh b/terraform-env.sh
@@ -18,19 +18,27 @@ if [ $# -lt 2 ]; then
     help
 fi
 
-
+# Let's set up our variables
 ENVIRONMENT=$1
 ACTION=$2
-VARFILE=
 ALLOWS_VARFILE=(apply plan push refresh)
 ENV_FILE=.terraform/environment
+VARS_FILE=vars/$ENVIRONMENT
+VARS_FILE_FLAG=
 
 source ./terraform.cfg
 
+
+# Let's check to see if a vars file exists for the requested environment before proceeding
+if [ ! -f $VARS_FILE ]; then
+    echo "Error: $VARS_FILE does not exist. You'll need to create a vars file for the requested environment before continuing."
+    exit 1
+fi
+
 # Checks if current action allows a varfile to be passed
 contains_element "$ACTION" "${ALLOWS_VARFILE[@]}"
 if [ $? -eq 0 ]; then
-    VARFILE="-var-file=vars/$ENVIRONMENT"
+    VARS_FILE_FLAG="-var-file=$VARS_FILE"
 fi
 
 # Let's check if the requested environment is different from the previous environment
@@ -51,4 +59,4 @@ then
 fi
 
 # Let's do work!
-terraform $ACTION $VARFILE ${*:3}
+terraform $ACTION $VARS_FILE_FLAG ${*:3}
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -33,14 +33,14 @@ if [ $? -eq 0 ]; then
     VARFILE="-var-file=vars/$ENVIRONMENT"
 fi
 
-# Let's check if the requested environment is different from our current environment
-CURRENT_ENVIRONMENT=$(<$ENV_FILE)
-if [ $CURRENT_ENVIRONMENT != $ENVIRONMENT ]
+# Let's check if the requested environment is different from the previous environment
+PREVIOUS_ENVIRONMENT=$([ -f $ENV_FILE ] && echo "$(<$ENV_FILE)" || echo "previous")
+if [ $PREVIOUS_ENVIRONMENT != $ENVIRONMENT ]
 then
 
     # Move current state out of the way to make room for the new state
-    mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$ENVIRONMENT &>2
-    mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$ENVIRONMENT &>2
+    mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$PREVIOUS_ENVIRONMENT &>2
+    mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$PREVIOUS_ENVIRONMENT &>2
 
     # Let's log the new environment for later
     echo $ENVIRONMENT > $ENV_FILE
@@ -51,4 +51,4 @@ then
 fi
 
 # Let's do work!
-terraform $ACTION $VARFILE ${*:3}
+terraform $ACTION $VARFILE ${*:3}
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -23,6 +23,7 @@ ENVIRONMENT=$1
 ACTION=$2
 VARFILE=
 ALLOWS_VARFILE=(apply plan push refresh)
+ENV_FILE=.terraform/environment
 
 source ./terraform.cfg
 
@@ -33,7 +34,7 @@ if [ $? -eq 0 ]; then
 fi
 
 # Let's check if the requested environment is different from our current environment
-CURRENT_ENVIRONMENT=$(<.terraform/environment)
+CURRENT_ENVIRONMENT=$(<$ENV_FILE)
 if [ $CURRENT_ENVIRONMENT != $ENVIRONMENT ]
 then
 
@@ -42,12 +43,12 @@ then
     mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$ENVIRONMENT &>2
 
     # Let's log the new environment for later
-    echo $ENVIRONMENT > .terraform/environment
+    echo $ENVIRONMENT > $ENV_FILE
 
     # Set up remote configuration and pull latest version
     terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
 
 fi
 
 # Let's do work!
-terraform $ACTION $VARFILE ${*:3}
+terraform $ACTION $VARFILE ${*:3}
diff --git a/README.md b/README.md
@@ -17,4 +17,4 @@ You can use it like so:
 ./terraform-env.sh production apply -var="some_var=some_value"
 ```
 
-You can use the script just like you'd use `terraform`, passing whatever arguments you would before.
+You can use the script just like you'd use `terraform`, passing whatever arguments you would before. It will only pull the latest environment if the current environment is different from the one you're requesting.
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -32,15 +32,22 @@ if [ $? -eq 0 ]; then
     VARFILE="-var-file=vars/$ENVIRONMENT"
 fi
 
-# Move current state out of the way to make room for the new state
-mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$ENVIRONMENT &>2
-mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$ENVIRONMENT &>2
+# Let's check if the requested environment is different from our current environment
+CURRENT_ENVIRONMENT=$(<.terraform/environment)
+if [ $CURRENT_ENVIRONMENT != $ENVIRONMENT ]
+then
 
-# Let's log the current environment, may use it later
-echo $ENVIRONMENT > .terraform/environment
+    # Move current state out of the way to make room for the new state
+    mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$ENVIRONMENT &>2
+    mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$ENVIRONMENT &>2
 
-# Set up remote configuration and pull latest version
-terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
+    # Let's log the new environment for later
+    echo $ENVIRONMENT > .terraform/environment
+
+    # Set up remote configuration and pull latest version
+    terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
+
+fi
 
 # Let's do work!
 terraform $ACTION $VARFILE ${*:3}
diff --git a/README.md b/README.md
@@ -15,4 +15,6 @@ You can use it like so:
 ./terraform-env.sh dev show
 ./terraform-env.sh staging plan -out plan
 ./terraform-env.sh production apply -var="some_var=some_value"
-```
+```
+
+You can use the script just like you'd use `terraform`, passing whatever arguments you would before.
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -18,6 +18,7 @@ if [ $# -lt 2 ]; then
     help
 fi
 
+
 ENVIRONMENT=$1
 ACTION=$2
 VARFILE=
@@ -31,5 +32,15 @@ if [ $? -eq 0 ]; then
     VARFILE="-var-file=vars/$ENVIRONMENT"
 fi
 
+# Move current state out of the way to make room for the new state
+mv -f .terraform/terraform.tfstate .terraform/terraform.tfstate.$ENVIRONMENT &>2
+mv -f .terraform/terraform.tfstate.backup .terraform/terraform.tfstate.backup.$ENVIRONMENT &>2
+
+# Let's log the current environment, may use it later
+echo $ENVIRONMENT > .terraform/environment
+
+# Set up remote configuration and pull latest version
 terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
+
+# Let's do work!
 terraform $ACTION $VARFILE ${*:3}
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -18,18 +18,18 @@ if [ $# -lt 2 ]; then
     help
 fi
 
-source ./terraform.cfg
-
 ENVIRONMENT=$1
 ACTION=$2
 VARFILE=
 ALLOWS_VARFILE=(apply plan push refresh)
 
+source ./terraform.cfg
+
 # Checks if current action allows a varfile to be passed
 contains_element "$ACTION" "${ALLOWS_VARFILE[@]}"
 if [ $? -eq 0 ]; then
     VARFILE="-var-file=vars/$ENVIRONMENT"
 fi
 
 terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
-terraform $ACTION $VARFILE ${*:3}
+terraform $ACTION $VARFILE ${*:3}
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -25,7 +25,7 @@ ACTION=$2
 VARFILE=
 ALLOWS_VARFILE=(apply plan push refresh)
 
-# Validate the desired role.
+# Checks if current action allows a varfile to be passed
 contains_element "$ACTION" "${ALLOWS_VARFILE[@]}"
 if [ $? -eq 0 ]; then
     VARFILE="-var-file=vars/$ENVIRONMENT"

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Assumes the following structure:
+This script will pull down an S3 remote configuration before running any terraform actions. Assumes the following structure:
 
 ```
 main.tf

diff --git a/terraform-env.sh b/terraform-env.sh
@@ -31,6 +31,5 @@ if [ $? -eq 0 ]; then
     VARFILE="-var-file=vars/$ENVIRONMENT"
 fi
 
-
-terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_prefix/state/$ENVIRONMENT" -backend-config="region=$region"
+terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_key" -backend-config="region=$region"
 terraform $ACTION $VARFILE ${*:3}
diff --git a/terraform.cfg b/terraform.cfg
@@ -1,3 +1,4 @@
 bucket=some_secret_bucket
 bucket_prefix=example
-region=us-east-1
+region=us-east-1
+bucket_key=$bucket_prefix/state/$ENVIRONMENT
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@ vars/staging
 vars/production
 ```
 
+`ansible.cfg` is required for the remote configuration.
+
 You can use it like so:
 ```
 ./terraform-env.sh dev show

diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+Assumes the following structure:
+
+```
+main.tf
+terraform.cfg
+vars/dev
+vars/staging
+vars/production
+```
+
+You can use it like so:
+```
+./terraform-env.sh dev show
+./terraform-env.sh staging plan -out plan
+./terraform-env.sh production apply -var="some_var=some_value"
+```
diff --git a/terraform-env.sh b/terraform-env.sh
@@ -0,0 +1,36 @@
+#!/bin/bash
+
+function help {
+    echo "usage: ${0} <environment> <action> [<args>]"
+    exit 1
+}
+
+function contains_element () {
+    local i
+    for i in "${@:2}"; do
+        [[ "$i" == "$1" ]] && return 0
+    done
+    return 1
+}
+
+#All of the args are mandatory.
+if [ $# -lt 2 ]; then
+    help
+fi
+
+source ./terraform.cfg
+
+ENVIRONMENT=$1
+ACTION=$2
+VARFILE=
+ALLOWS_VARFILE=(apply plan push refresh)
+
+# Validate the desired role.
+contains_element "$ACTION" "${ALLOWS_VARFILE[@]}"
+if [ $? -eq 0 ]; then
+    VARFILE="-var-file=vars/$ENVIRONMENT"
+fi
+
+
+terraform remote config -backend S3 -backend-config="bucket=$bucket" -backend-config="key=$bucket_prefix/state/$ENVIRONMENT" -backend-config="region=$region"
+terraform $ACTION $VARFILE ${*:3}
diff --git a/terraform.cfg b/terraform.cfg
@@ -0,0 +1,3 @@
+bucket=some_secret_bucket
+bucket_prefix=example
+region=us-east-1
No results found