reckoner
Command line helper for helm. This utility adds to the functionality of Helm in multiple ways:
- Creates a declarative syntax to manage multiple releases in one place
- Allows installation of charts from a git commit/branch/release
Requirements
- python >= 2.7
- helm: installed and initialized
As standalone shell command
pip install reckoner
Usage
As standalone shell command
- Usage: reckoner [OPTIONS] COMMAND [ARGS]...
- Options:
--help
Show this message and exit.--log-level=TEXT
Set the log level for reckoner (defaults toINFO
. Set toDEBUG
for more details including helm commands)
- Commands:
plot FILE
: Runs helm based on specified yaml file (see configuration example below)- Options:
--debug
: Pass --debug to helm--dry-run
: Pass --dry-run to helm so no action is taken. Also includes--debug
--heading <chart>
: Run only the specified chart out of the course.yml--helm-args <helm-arg>
: Pass arbitrary flags and parameters to all helm chart commands in your course.yml. Example:--helm-args --set=foo=toast
, or--helm-args --recreate-pods
. Multiples are supported but only one parameter per--helm-args
is supported. Note that specifying this flag will overridehelm_args
in the course.yml file.--local-development
: Runreckoner
in local-development mode where Tiller is not required and no helm commands are run. Useful for rapid or offline development.
- Options:
generate
: Generates example filecourse.yml
with extensive descriptionsversion
: Output reckoner version
Example configuration file:
There is an example file in reckoner/example-course.yml
Further customization is documented below.
Options
Global Options
namespace
The default namespace to deploy into. Defaults to kube-system
repository
Repository to download chart from, defaults to 'stable'
context
Optional. The kubectl cluster context to use for installing, defaults to the current context.
repositories
Where to get charts from. We recommend at least the stable and incubator charts.
repositories:
incubator:
url: https://kubernetes-charts-incubator.storage.googleapis.com
stable:
url: https://kubernetes-charts.storage.googleapis.com
helm_args
A list of arguments to pass to helm each time reckoner is run. Arguments are applied for every chart install in your course. This cannot be used for args that specify how Helm connects to the tiller.
helm_args:
- --recreate-pods
Options for Charts
values
In-line values overrides for this chart. By default these are set using --set
. This introduces some interesting behavior. Make sure to read the Caveats
values-strings
This is a wrapper around the helm functionality --set-string
. Allows the specification of variables that would normally be interpreted as boolean or int as strings.
charts:
chartname:
values:
some.value: test
values-strings:
some.value.that.you.need.to.be.a.string: '1'
files
Use a values file(s) rather than leaving them in-line:
charts:
chart_name:
files:
- /path/to/values/file.yml
Note: The file paths will be interpreted as relative to the working directory of the shell calling reckoner.
namespace
Override the default namespace.
hooks
Hooks are run locally. For complex hooks, use an external script or Runner task.
charts:
chart_name:
hooks:
pre_install:
- ls
- env
post_install:
- rm testfile
- cp file1 file2
version
The version of the chart to use
Repository Options
name
Optional, name of repository.
url
Optional if repository is listed above. Url of repository to add if not already included in above repositories section.
git
Git url where chart exists. Supercedes url argument
path
Path where chart is in the git repository. NOTE: If the chart folder is in the root, leave this blank.
charts:
chart_name:
repository: repository to download chart from, overrides global value
name: Optional, name of repository.
url: Optional if repository is listed above. Url of repository to add if not already included in above repositories section
git: Git url where chart exists. Supercedes url argument
path: Path where chart is in git repository. If the chart is at the root, leave blank
namespace: namespace to install chart in, overrides above value
Caveats
Escaping
Keys and Values that have dots in the name need to be escaped. Have a look at the helm docs on escaping complicated values.
Example:
charts:
grafana:
namespace: grafana
values:
datasources:
datasources\.yaml:
apiVersion: 1
The alternative is to use the files method described above