Helm Charts as Code
Helmsman v3.0.0 works only with Helm versions >=3.0.0. For older Helm versions, use Helmsman v1.x
Helmsman is a Helm Charts (k8s applications) as Code tool which allows you to automate the deployment/management of your Helm charts from version controlled code.
Helmsman uses a simple declarative TOML file to allow you to describe a desired state for your k8s applications as in the example toml file. Alternatively YAML declaration is also acceptable example yaml file.
The desired state file (DSF) follows the desired state specification.
Helmsman sees what you desire, validates that your desire makes sense (e.g. that the charts you desire are available in the repos you defined), compares it with the current state of Helm and figures out what to do to make your desire come true.
To plan without executing:
$ helmsman -f example.toml
To plan and execute the plan:
$ helmsman --apply -f example.toml
To show debugging details:
$ helmsman --debug --apply -f example.toml
To run a dry-run:
$ helmsman --debug --dry-run -f example.toml
To limit execution to specific application:
$ helmsman --debug --dry-run --target artifactory -f example.toml
Please make sure the following are installed prior to using
helmsmanas a binary (the docker image contains all of them):
helmsman>= 1.6.0, helm >=v3.0.0 for
If you use private helm repos, you will need either
helm-s3plugin or you can use basic auth to authenticate to your repos. See the docs for details.
Check the releases page for the different versions.
# on Linux curl -L https://github.com/Praqma/helmsman/releases/download/v3.6.7/helmsman_3.6.4_linux_amd64.tar.gz | tar zx # on MacOS curl -L https://github.com/Praqma/helmsman/releases/download/v3.6.7/helmsman_3.6.4_darwin_amd64.tar.gz | tar zx
mv helmsman /usr/local/bin/helmsman
Check the images on dockerhub
Helmsman has been packaged in Archlinux under
helmsman-binfor the latest binary release, and
Documentation for Helmsman v1.x can be found at: docs v1.x
Helmsman can be used in three different settings:
latestimage can (at times) be unstable.
Pull requests, feedback/feature requests are welcome. Please check our contribution guide.