The tfswitch command line tool lets you switch between different versions of terraform.
If you do not have a particular version of terraform installed, tfswitch will download the version you desire.
The installation is minimal and easy.
Once installed, simply select the version you require from the dropdown and start using terraform.
Installation
tfswitch is available for MacOS and Linux based operating systems.
If a .tf file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to the latest version:
Use .tfswitch.toml file (For non-admin - users with limited privilege on their computers)
This is similiar to using a .tfswitchrc file, but you can specify a custom binary path for your terraform installation
Create a custom binary path. Ex: mkdir /Users/warrenveerasingam/bin (replace warrenveerasingam with your username)
Add the path to your PATH. Ex: export PATH=$PATH:/Users/warrenveerasingam/bin (add this to your bash profile or zsh profile)
Pass -b or --bin parameter with your custom path to install terraform. Ex: tfswitch -b /Users/warrenveerasingam/bin/terraform 0.10.8
Optionally, you can create a .tfswitch.toml file in your terraform directory(current directory) OR in your home directory(~/.tfswitch.toml). The toml file in the current directory has a higher precedence than toml file in the home directory
Run tfswitch and it should automatically install the required terraform version in the specified binary path
NOTE
For linux users that do not have write permission to /usr/local/bin/, tfswitch will attempt to install terraform at $HOME/bin. Run export PATH=$PATH:$HOME/bin to append bin to PATH
For windows host, tfswitch need to be run under Administrator mode, and $HOME/.tfswitch.toml with bin must be defined (with a valid path) as minimum, below is an example for $HOME/.tfswitch.toml on windows
bin = "C:\\Users\\<%USRNAME%>\\bin\\terraform.exe"
Use .tfswitchrc file
Create a .tfswitchrc file containing the desired version
For example, echo "0.10.5" >> .tfswitchrc for version 0.10.5 of terraform
Run the command tfswitch in the same directory as your .tfswitchrc
Instead of a .tfswitchrc file, a .terraform-version file may be used for compatibility with tfenv and other tools which use it
Use terragrunt.hcl file
If a terragrunt.hcl file with the terraform constrain is included in the current directory, it should automatically download or switch to that terraform version. For example, the following should automatically switch terraform to the latest version 0.13:
To install from a remote mirror other than the default(https://releases.hashicorp.com/terraform). Use the -m or --mirror parameter.
Ex: tfswitch --mirror https://example.jfrog.io/artifactory/hashicorp
Automation
Automatically switch with bash
Add the following to the end of your ~/.bashrc file:
(Use either .tfswitchrc or .tfswitch.toml or .terraform-version)
cdtfswitch(){
builtincd"$@";
cdir=$PWD;if [ -e"$cdir/.tfswitchrc" ];then
tfswitch
fi
}
alias cd='cdtfswitch'
Automatically switch with zsh
Add the following to the end of your ~/.zshrc file:
load-tfswitch() {
local tfswitchrc_path=".tfswitchrc"if [ -f"$tfswitchrc_path" ];then
tfswitch
fi
}
add-zsh-hook chpwd load-tfswitch
load-tfswitch
NOTE: if you see an error like this: command not found: add-zsh-hook, then you might be on an older version of zsh (see below), or you simply need to load add-zsh-hook by adding this to your .zshrc:
autoload -U add-zsh-hook
older version of zsh
cd(){
builtincd"$@";
cdir=$PWD;if [ -e"$cdir/.tfswitchrc" ];then
tfswitch
fi
}
Automatically switch with fish shell
Add the following to the end of your ~/.config/fish/config.fish file:
functionswitch_terraform --on-event fish_postexec
string match --regex '^cd\s'"$argv"> /dev/null
set --local is_command_cd $statusiftest$is_command_cd -eq 0
if count *.tf > /dev/null
grep -c "required_version"*.tf > /dev/null
set --local tf_contains_version $statusiftest$tf_contains_version -eq 0
command tfswitch
end
end
end
end
Jenkins setup
#!/bin/bash echo"Installing tfswitch locally"
wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine
chmod 755 install.sh #Make installer executable
./install.sh -b `pwd`/.bin #Install tfswitch in a location you have permission
CUSTOMBIN=`pwd`/.bin #set custom bin pathexport PATH=$PATH:$CUSTOMBIN#Add custom bin path to PATH environment$CUSTOMBIN/tfswitch -b $CUSTOMBIN/terraform 0.11.7 #or simply tfswitch -b $CUSTOMBIN/terraform 0.11.7
terraform -v #testing version
Circle CI setup
Example config yaml
version: 2jobs:
build:
docker:
- image: ubuntuworking_directory: /go/src/github.com/warrensbox/terraform-switchersteps:
- checkout
- run:
command: | set +e apt-get update apt-get install -y wget rm -rf /var/lib/apt/lists/* echo "Installing tfswitch locally" wget https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh #Get the installer on to your machine chmod 755 install.sh #Make installer executable ./install.sh -b `pwd`/.bin #Install tfswitch in a location you have permission CUSTOMBIN=`pwd`/.bin #set custom bin path export PATH=$PATH:$CUSTOMBIN #Add custom bin path to PATH environment $CUSTOMBIN/tfswitch -b $CUSTOMBIN/terraform 0.11.7 #or simply tfswitch -b $CUSTOMBIN/terraform 0.11.7 terraform -v #testing version
Order of precedence
Order
Method
1
.tfswitch.toml
2
.tfswitchrc
3
.terraform-version
4
Environment variable
With 1 being the highest precedence and 4 the lowest (If you disagree with this order of precedence, please open an issue)
How to contribute
An open source project becomes meaningful when people collaborate to improve the code.
Feel free to look at the code, critique and make suggestions. Lets make tfswitch better!
See step-by-step instructions on how to contribute here: Contribute
Additional Info
See how to upgrade, uninstall, troubleshoot here: More info
请发表评论