A Helm Charts as Code tool.
Clone or download
sami-alajrami Merge pull request #103 from kleetus/master
Fixes chart version that are valid semantic version strings.
Latest commit b7edf55 Oct 17, 2018
Permalink
Failed to load latest commit information.
.circleci no need for make tools Oct 9, 2018
aws fixnig noColors Sep 25, 2018
data fixing #48 Jul 17, 2018
dockerfile bumping helm version in dockerfile to v2.10.0 Oct 8, 2018
docs Minor spelling fix Sep 30, 2018
gcs fixnig noColors Sep 25, 2018
test_files updating the makefile to use dep to ensure the necessary dependencies Oct 9, 2018
.gitignore adding a Makefile Sep 3, 2018
.goreleaser.yml adding static binding flag for the application build. Mar 19, 2018
CONTRIBUTION.md adding a Makefile Sep 3, 2018
Gopkg.lock adding godep files #91 Sep 28, 2018
Gopkg.toml adding godep files #91 Sep 28, 2018
LICENSE Create LICENSE Nov 19, 2017
Makefile not so fancy Oct 9, 2018
README.md Adding prereqs for helmsman Oct 2, 2018
bindata.go use helm's json output Aug 28, 2018
command.go adding dry-run option #60 #77 Sep 16, 2018
command_test.go updating tests. Mar 31, 2018
decision_maker.go Don't pass --wait to helm diff Oct 16, 2018
decision_maker_test.go fixing #59 to support relative paths for values files Aug 30, 2018
example.toml updating docs Sep 26, 2018
example.yaml updating docs Sep 26, 2018
helm_helpers.go Fixes chart version that are valid semantic version strings. Oct 16, 2018
helm_helpers_test.go Fixes chart version that are valid semantic version strings. Oct 16, 2018
init.go adding destroy support. #88 Sep 26, 2018
init_test.go #2 adding unit tests. Nov 16, 2017
kube_helpers.go Adding some quotes Sep 28, 2018
main.go adding destroy support. #88 Sep 26, 2018
plan.go adding a flag to disable the color output Sep 21, 2018
plan_test.go fixing tests Aug 7, 2018
release-notes.md bumping version Sep 28, 2018
release.go updating docs Sep 26, 2018
release_test.go fixing tests Sep 9, 2018
state.go consolidate env var substitution Sep 16, 2018
state_test.go fixing tests Sep 9, 2018
utils.go fixnig noColors Sep 25, 2018
utils_test.go support for yaml files May 25, 2018

README.md

version
v1.6.2

helmsman-logo

What is Helmsman?

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.

How does it work?

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

Features

  • Built for CD: Helmsman can be used as a docker image or a binary.
  • Applications as code: describe your desired applications and manage them from a single version-controlled declarative file.
  • Suitable for Multitenant Clusters: deploy Tiller in different namespaces with service accounts and TLS.
  • Easy to use: deep knowledge of Helm CLI and Kubectl is NOT mandatory to use Helmsman.
  • Plan, View, apply: you can run Helmsman to generate and view a plan with/without executing it.
  • Portable: Helmsman can be used to manage charts deployments on any k8s cluster.
  • Protect Namespaces/Releases: you can define certain namespaces/releases to be protected against accidental human mistakes.
  • Define the order of managing releases: you can define the priorities at which releases are managed by helmsman (useful for dependencies).
  • Idempotency: As long your desired state file does not change, you can execute Helmsman several times and get the same result.
  • Continue from failures: In the case of partial deployment due to a specific chart deployment failure, fix your helm chart and execute Helmsman again without needing to rollback the partial successes first.

Install

From binary

Please make sure the following are installed prior to using helmsman:

Check the releases page for the different versions.

# on Linux
curl -L https://github.com/Praqma/helmsman/releases/download/v1.6.2/helmsman_1.6.2_linux_amd64.tar.gz | tar zx
# on MacOS
curl -L https://github.com/Praqma/helmsman/releases/download/v1.6.2/helmsman_1.6.2_darwin_amd64.tar.gz | tar zx

mv helmsman /usr/local/bin/helmsman

As a docker image

Check the images on dockerhub

As a package

Helmsman has been packaged in Archlinux under helmsman-bin for the latest binary release, and helmsman-git for master.

Documentation

Documentation and How-Tos can be found here. Helmsman lets you:

Usage

Helmsman can be used in three different settings:

Contributing

Pull requests, feedback/feature requests are welcome. Please check our contribution guide.