andrelohmann.terrahelper

Panoramica Versioni Approfondimenti

terrahelper

terrahelper combines Terraform and terrahelp best practices for small teams.

Best Practices:

Create a repository for your Terraform template files.
Create a repository for your Terraform state.
Keep the state separate from the Terraform templates folder (that's why you need the second repository).

Workflow:

Create or edit your templates.
Check out the latest state from the state repository.
Decrypt the state using terrahelp and your state secret.
Run terraform plan and terraform apply.
Encrypt the new state using terrahelp.
Commit the new state to the state repository.

Requirements

This role requires Ubuntu.

Example Playbook

- hosts: terrahelper
  roles:
    - { role: andrelohmann.terraform }
    - { role: andrelohmann.terrahelp }
    - { role: andrelohmann.terrahelper }

Usage

terrahelper manages the steps to encrypt and decrypt the Terraform state along with the necessary Terraform commands to initialize, plan, apply, and destroy your stack.

You need a state secret for encrypting and decrypting the Terraform state, along with two separate repositories (one for the templates and one for the state).

Run terrahelper just like you usually run the Terraform command from your Terraform templates directory.

Usage:

terrahelper init | plan | apply | destroy | output 
[-s | --statesecret __SECRET__] 
[-d | --statedirectory __STATEDIRECTORY__] 
[-f | --statefile terraform.tfstate] 
[-b | --statefilebackup terraform.tfstate.backup] 
[-e | --echo] 
[-h | --help] 
[any Terraform parameters]

If the following environment variables are set, the respective parameters are not needed:

TH_SECRET: terrahelp secret used for encryption/decryption of the state.
TH_STATE_DIRECTORY: path (absolute or relative from the Terraform templates directory) to the Terraform state directory.
TH_STATE_FILE: Terraform state file (defaults to terraform.tfstate).
TH_STATE_FILE_BACKUP: Backup for the Terraform state file (defaults to terraform.tfstate.backup).

You can also add any specific Terraform command parameters to the end, and they will be included in the Terraform command.