aaratn / terraenv Goto Github PK

View Code? Open in Web Editor NEW

85.0 3.0 12.0 48 KB

Terraform & Terragrunt Version Manager

License: MIT License

Makefile 3.44% Python 95.79% Dockerfile 0.77%

terraform terragrunt version-manager python tfenv rbenv osx linux

terraenv's Introduction

terraenv

Terraform & Terragrunt version manager inspired by rbenv, tfenv, tgenv

Support

Currently terraenv supports the following Operating System

Mac OS X (64bit)
Linux (64bit)

Installation

Automatic

Install via Homebrew on OSx

$ brew tap aaratn/terraenv
$ brew install terraenv

Install via Python pip

$ pip install terraenv

Upgrade

via Homebrew on OSx

$ brew upgrade terraenv

Manual on Linux And OSX

Download terraenv for your operating system

Linux

$ wget https://github.com/aaratn/terraenv/releases/latest/download/terraenv_linux_x64.tar.gz

OSX

$ wget https://github.com/aaratn/terraenv/releases/latest/download/terraenv_osx_x64.tar.gz

Extract Tar Archive

Linux

$ tar -xvzf terraenv_linux_x64.tar.gz

OSX

$ tar -xvzf terraenv_osx_x64.tar.gz

Copy the extracted file to your /usr/local/bin directory

$ cp terraenv /usr/local/bin/terraenv

On Ubuntu/Debian touching /usr/local/bin might require sudo access

Usage

terraenv <terraform / terragrunt > install [version]

Install a specific version of Terraform. Available options for version:

1.2.3 exact version to install
latest installs latest version

$ terraenv terraform install 0.12.15
$ terraenv terragrunt install 0.21.6

$ terraenv terraform install latest
$ terraenv terragrunt install latest

terraenv < terraform / terragrunt > list remote

.terraenv

If you use a .terraenv, terraenv <terraform / terragrunt > install (no argument) will install the version written in it.

terraenv <terraform/terragrunt> use <version>

Switch a version to use

$ terraenv terraform use 0.11.14
$ terraenv terragrunt use 0.21.6

terraenv uninstall <terraform/terragrunt> <version>

Uninstall a specific version of Terraform

$ terraenv terraform uninstall 0.12.15
$ terraenv terragrunt uninstall 0.21.5

terraenv <terraform/terragrunt> list local

List installed versions

% terraenv terraform list local
0.12
0.11.13
0.11.14
0.12.11
0.12.0
0.12.12
0.12.13

% terraenv terragrunt list local
0.18.7
0.21.6

terraenv <terraform/terragrunt> list remote

List installable versions

% terraenv terraform list remote
...
0.11.3
0.11.4
0.11.5
0.11.6
0.11.7
0.11.8
0.11.9
0.11.10
0.11.11
0.11.12
0.11.13
0.11.14
0.12.0
0.12.1
0.12.2
0.12.3
0.12.4
0.12.5
0.12.6
0.12.7
0.12.8
0.12.9
0.12.10
0.12.11
0.12.12
0.12.13
0.12.14
0.12.15

.terraenv file

If you put a .terraenv file on your project root, terraenv detects it and uses the version written in it.

$ cat .terraenv
TERRAFORM=0.12.15
TERRAGRUNT=0.21.6

$ terraenv terraform install

$ terraform -version
Terraform v0.12.15

$ terraenv terragrunt install

$ terragrunt -version
terragrunt version v0.21.6

To use Terraform or Terragrunt version from `.terraenv` file present at your current directory path.

$ terraenv terraform use

$ terraenv terragrunt use

LICENSE

Inspiration

terraenv's People

Contributors

Stargazers

Watchers

Forkers

jhabikal21 kikou2016 piyushsonigra kapilbarad devops-ua carlosjgp ebut99 marshall7m dhoeric markoraiha pc-star feiming

terraenv's Issues

Note: author has died from COVID-19

Aarat Nathwani has died from COVID-19.

terraspace support

since we are using this tool for all terraform related binaries, I suggest supporting terraspace https://terraspace.cloud/ as well

github API rate limiting when running terraenv terragrunt install

We've been running into an issue occasionally in our deployment pipelines where we use the terraenv terragrunt install command:

> terraenv terragrunt install
API rate limit exceeded for XX.XX.63.182. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)
Traceback (most recent call last):
  File "/usr/local/bin/terraenv", line 46, in <module>
    args.func(args)
  File "/usr/local/lib/python3.7/dist-packages/commands/install.py", line 89, in install
    download_program(args, program, version)
  File "/usr/local/lib/python3.7/dist-packages/commands/install.py", line 19, in download_program
    available_versions = list_remote(args)
  File "/usr/local/lib/python3.7/dist-packages/commands/list.py", line 68, in list_remote
    available_versions.append(version['name'].lstrip('v'))
TypeError: string indices must be integers

The issue appears to happen because running the terragrunt install command first runs the list command to fetch a list of available versions. Perhaps the list command can be skipped when a specific version is requested (we're using .terraenv file for this). If "latest" is provided, then it would still be necessary to figure out which is the latest version. But for a specific version, maybe it's better to just try to download that version, and fail if it is invalid?

Custom installation location - non-admin privileges

Hello,

For non admin users with limited privileges on our computers please have a switch that overrides the location of terraform and terragrunt.

https://github.com/warrensbox/terraform-switcher and https://github.com/warrensbox/tgswitch allows this.

And this single tool terraenv would be much better as not all of us have admin privileges