Skip to content

Latest commit

 

History

History
127 lines (103 loc) · 3.07 KB

README.md

File metadata and controls

127 lines (103 loc) · 3.07 KB
Raw

pyTerrafile

Simple script for management 3rd party external terraform modules.

Additionally, tfile supports modules from the Terraform Registry, as well as local modules and from git.

Dependencies

Python version >=3.8

Usage

Local

usage: terrafile [-h] [-a [{sync,generate}]] [-f [FILE]] [-p PATH] [-l LEVEL] [-F] [-m MODULE_PATH] [-r]

Terraform modules control

optional arguments:
  -h, --help            show this help message and exit
  -a [{sync,generate}], --action [{sync,generate}]
                        Start/Stop or Restart list of services or service
  -f [FILE], --file [FILE]
                        Tfile full path, if not present current directory
  -p PATH, --path PATH  Path for storing terraform modules, if not present current directory
  -l LEVEL, --level LEVEL
                        Terrafile level of logging
  -F, --force           Force re-download terraform modules from tfile
  -m MODULE_PATH, --module_path MODULE_PATH
                        Terraform module file, if you want to parse tf files in recursive mode please add -r flag
  -r, --recursive       Recursive mode for parsing directory with terraform modules

Via Docker

docker run -it \
  --name pyterrafile --rm \
  -v "$(pwd)"/examples:/app kennyopennix/pyterrafile

tfile structure

For Terraform Registry

module-name:
  source: "source"
  version: "version"

version - git tag if not present by default master

For GIT

module-name:
 source: git_url
 version: git_tag
 provider: provider_name

version - git tag if not present by default master provider - could be aws,google,etc if not present by default custom

For local module

terraform-k8s-vault-module:
  source: "module_path"

Example of tfile

terraform-google-lb:
  source: "GoogleCloudPlatform/lb-http/google"
  version: "4.5.0"
terraform-aws-vpc:
 source: https://github.com/terraform-aws-modules/terraform-aws-vpc.git
 version: v2.64.0
 provider: aws

Installation

From git

python -m pip install git+https://github.com/pyToshka/pyTerrafile.git

Local installation

git clone [email protected]:pyToshka/pyTerrafile.git
cd pyTerrafile
pip install .

Build docker image

git clone [email protected]:pyToshka/pyTerrafile.git
cd pyTerrafile
docker build . -t  pyTerrafile

Generate tfile

For generating tfile from exists terraform file(s) command run command

For example file foo.tf has content

module "service-accounts" {
  source       = "terraform-google-modules/service-accounts/google"
  version      = "3.0.1"

}

You can generate tfile use command

terrafile  -a generate -m ./foo.tf

Output will be

service-accounts:
  source: terraform-google-modules/service-accounts/google
  version: 3.0.1

For recursive generation tfile from existing terraform files you can use command

terrafile  -a generate -m /path/to/tf/modules -r

Script will try to find all 3rd party modules in terraform files and based on it will create tfile for using.