terraform-http-backend-pass: HTTP backend to store terraform state using pass and git

[ library, program, terraform ] [ Propose Tags ]
Versions [RSS] 0.1.0.0, 0.1.0.1
Change log CHANGELOG.md
Dependencies aeson, base (>=4.14 && <5), bytestring, directory, mtl, optparse-applicative, optparse-generic, servant, servant-server, shelly, terraform-http-backend-pass, text, warp [details]
License LicenseRef-AGPL
Copyright 2021 Akshay Mankar
Author Akshay Mankar
Maintainer itsakshaymankar@gmail.com
Category Terraform
Home page https://github.com/akshaymankar/terraform-http-backend-pass#readme
Bug tracker https://github.com/akshaymankar/terraform-http-backend-pass/issues
Source repo head: git clone https://github.com/akshaymankar/terraform-http-backend-pass
Uploaded by axeman at 2023-05-29T19:37:01Z
Distributions NixOS:0.1.0.1
Executables terraform-http-backend-pass
Downloads 171 total (8 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2023-05-29 [all 1 reports]

Readme for terraform-http-backend-pass-0.1.0.1

[back to package description]

Terraform HTTP Backend Pass

Catchy name! What does it do?

According to terraform docs:

Each Terraform configuration can specify a backend, which defines where and how operations are performed, where state snapshots are stored, etc.

There are a few backends which terraform provides, none of which are very customizable. The http backend, however, provides a way to define where (and how) state snapshots are stored. It additionally allows for a locking the state while some operation is being perfomed.

This project aims to provide a backend to store the terraform state in a git repository. As the state can contain sensitive information, it should be encrypted before storing, for which pass is used.

How to use

  1. Install the backend in one of these ways:
    • Using Stack:
      stack install terraform-http-backend-pass
      
    • Using Cabal:
      cabal install terraform-http-backend-pass
      
    • Using nix:
      nix registry add terraform-http-backend-pass git+https://git.coop/akshay/terraform-http-backend-pass
      nix build 'terraform-http-backend-pass#' --profile $HOME/.nix-profile
      
  2. Create a pass repository:
    export PASSWORD_STORE_DIR=/desired/path/to/store
    pass init <gpg-keys>
    pass git init
    
  3. Push the repository somewhere, set push upstream:
    export PASSWORD_STORE_DIR=/desired/path/to/store
    pass git remote add origin <remote-url>
    pass git push -u origin master
    
  4. Start the backend:
    terraform-http-backend-pass --repositoryPath /desired/path/to/store --port 8888 
    
  5. Setup terraform with backend information:
    terraform {
      backend "http" {
        # Or, something else if the server is not running on localhost
        address = "http://localhost:8888"
      }
    }
    
    The address can also be specified dynamically using the -backend-config option while running terraform init
  6. Use terraform as usual:
    terraform init
    terraform apply