Skip to content

Latest commit

 

History

History
230 lines (168 loc) · 6 KB

README.md

File metadata and controls

230 lines (168 loc) · 6 KB
Raw

Static Tests Int Test Linux Int Test MacOS Int Test Windows

helmenv

Helm version manager inspired by tfenv.

If you are coming from the helmenv bash version, you should read the FAQ!

Features

  • Install helm versions in a reproducible and easy way
  • Enforce version in your git repositories with a .helm_version file

Supported OS

Currently helmenv supports the following OSes

  • Mac OS
  • Linux
  • Windows

Installation

There are two components in helmenv. One is the helmenv binary, the other one is a helm wrapper. It works as if were helm, but it has some logic to choose the version to execute. You should take care and ensure that you don't have any helm binary in your path. To check which binary you're executing, you can see it with:

$ which helm
/opt/brew/bin/helm

Homebrew

This is the recomended way, since it provides upgrades. It should work in Mac, Linux and Windows with WSL.

# Just the first time, activate the repository
brew tap little-angry-clouds/homebrew-my-brews
# To install
brew install helmenv
# To upgrade
brew upgrade helmenv

You should add your homebrew binary path to your PATH:

echo 'export PATH="$(brew --prefix)/bin/:$PATH"' >> ~/.bashrc
# Or
echo 'export PATH="$(brew --prefix)/bin/:$PATH"' >> ~/.zshrc

For Windows you should do the weird stuff that it needs to to set an environmental variable.

Manually

  1. Add ~/.bin to your $PATH and create it if doesn't exist
echo 'export PATH="$HOME/.bin:$PATH"' >> ~/.bashrc
# Or
echo 'export PATH="$HOME/.bin:$PATH"' >> ~/.zshrc

mkdir -p ~/.bin

For Windows you should do the weird stuff that it needs to to set an environmental variable.

  1. Download the binaries and put them on your path

Go to the releases page and download the version you want. For example:

wget https://github.com/little-angry-clouds/kubernetes-binaries-managers/releases/download/v1.0.0/kubernetes-binaries-managers_1.0.0_linux_amd64.tar.gz
tar -xzf kubernetes-binaries-managers_1.0.0_linux_amd64.tar.gz
mv helm-linux-amd64/helmenv ~/.bin/helmenv
mv helm-linux-amd64/helm-wrapper ~/.bin/helm

And that's it!

Usage

Help

$ helmenv help
Kubectl version manager

Usage:
  helmenv [command]

Available Commands:
  help        Help about any command
  install     Install binary
  list        Lists local and remote versions
  uninstall   Uninstall binary
  use         Set the default version to use

Flags:
  -h, --help     help

Use "helmenv [command] --help" for more information about a command.

List installable versions

This option uses Github API to paginate all versions. Github API has some usage limitations. It usually works, but if you happen to do a lot of requests to github or are on an office or similar, chances are that this command will fail. You can still install binaries if you know the version you want, thought.

$ helmenv list remote
1.18.2
1.18.1
1.18.0
1.17.5
...

List installed versions

$ helmenv list local
1.18.0
1.16.4
1.14.8

Install version

$ helmenv install 1.16.5
Downloading binary...
Done! Saving it at /home/user/.bin/kubectl-v1.16.5

Use version

$ helmenv use 1.16.5
Done! Using 1.16.5 version.

Uninstall version

$ helmenv uninstall 1.16.5
Done! 1.16.5 version uninstalled from /home/ap/.bin/kubectl-v1.16.5.

FAQ

Why migrate from bash to go?

The project just as a way of downloading the binary versions. Progressively it began to grow a little. And then they came some PR for different stuff, but the hard ones where the ones for adding better support for MacOS. I don't own a Mac, so I couldn't test them properly.

Also, kbenv and helmenv where pretty much a copy paste, but they didn't have the same code, so any change from one place I would have to add it to the other.

So, with this to problems (and because I was bored) I decided to migrate them for Go. Go is cool because it lets you have self contained binaries, so no more worries about the OS! I even add support for Windows, because why not. I only had to do a little specific development for Windows be able to use the .helmenv_version file, but it was'nt traumatic. And also, being Go a real programming language, I could add tests. Not that there's any right now, but I'm on it.

How to migrate from the bash version

For doing so you have to:

  • Delete the helmenv repository: rm -r ~/.helmenv
  • Delete the line that sources the bash script: source $HOME/.helmenv/helmenv.sh

And that's it. The way how the Go version works is very similar. The changed beehaviours are:

  • You don't have to set the v before the versions. For example:
$ helmenv install v2.0.1
# Would be
$ helmenv install 2.0.1
  • The listing commands have been separed:
# Before
$ helmenv list
$ helmenv list-remote
# After
$ helmenv list local
$ helmenv list remote

How to enforce a helm version

Just create a .helm_version in your directory pointing to the version you want to use. For example:

$ helmenv install 2.14.3
...
$ helmenv install 2.14.2
...
$ helmenv use 2.14.3
...
$ helm version --client
Client: &version.Version{SemVer:"v2.14.3", GitCommit:"0e7f3b6637f7af8fcfddb3d2941fcc7cbebb0085", GitTreeState:"clean"}
$ echo 2.14.2 > .helm_version
$ helm version --client
Client: &version.Version{SemVer:"v2.14.2", GitCommit:"a8b13cc5ab6a7dbef0a58f5061bcc7c0c61598e7", GitTreeState:"clean"}

License

GPL3