Skip to content

Commit

Permalink
Removed extra ' from tfstate name (BREAKING CHANGE)
Browse files Browse the repository at this point in the history
Updated README
  • Loading branch information
Tristan Cole committed Jun 28, 2017
1 parent a483d26 commit a874cb7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The wrapper assumes a few things:
### Terrafirm Helpers
**Usage**
```
./terrafirm -(terrafirm_helper_option) (args)
./terrafirm (terrafirm_helper) (args)
```

**NOTE**
Expand All @@ -84,15 +84,16 @@ basic structure in your project:
See this project's structure for a more detailed layout.

### Secret Variables File Editor (edit_secrets)
Working with secrets in Terrafirm requires you to have a file named ```secret.tfvars(.encrypted)````
Working with secrets in Terrafirm requires you to have a file named ```secret.tfvars(.encrypted)```
in your environment variables folder. If this file is present, Terrafirm will
automatically decrypt it at runtime and then re-encrypt it after Terraform finishes
running.

You can create this encrypted file in one of two ways: by calling this helper and
letting it create this file for you (you will have a chance to edit it as well)
or creating a ```variables/environments/(env)/secret.tfvars``` file with your
secrets and running Terrafirm as you would normally.
secrets and running Terrafirm as you would normally. The secret file will be
encrypted at next runtime.

**NOTE** This is a variables file by nature. It has not been tested with any
other Terraform specific configuration. However, you could in theory include
Expand All @@ -105,7 +106,7 @@ show as uncommited even if you have not changed the content. If you just want to
view your secrets, use the ```view_secrets``` helper instead.

### Secret Variables File Viewer (view_secrets)
Prints out the contents of the secret variables file to STDOUT for the environment
Prints out the contents of the secret variables file to ```stdout``` for the environment
specified. This will allow you to see your current secrets without causing git to
detect any changes.

Expand Down
2 changes: 1 addition & 1 deletion terrafirm
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ fi
rm -rf .terraform/

# Initialize the Terrafirm remote state and gather modules
terraform init -input=false -get=true -backend=true -backend-config="key=${environment}/${config}/terrafirm.tfstate'" \
terraform init -input=false -get=true -backend=true -backend-config="key=${environment}/${config}/terrafirm.tfstate" \
-backend-config="bucket=${s3_bucket}" -backend-config="region=${s3_bucket_region}" \
-backend-config="profile=${aws_profile}" -backend-config="shared_credentials_file=${aws_creds_file}"

Expand Down

0 comments on commit a874cb7

Please sign in to comment.