Helm - Documentation

Methods

addRepository(repositoryName, url, flags)

Example

// add a repo
helm.addReposistory('myrepo', 'https://mycharts.example');

// add a repo with authentication
helm.addReposistory('myrepo', 'https://mycharts.example', ['--user foo', '--password bar']);

Parameters:

Name	Type	Description
`repositoryName`	string	Name of repository
`url`	string	URL from repository
`flags`	Array.<string>	Flags of `helm repo add` command

custom(args, flags)

Example

helm.custom('repo list');

Parameters:

Name	Type	Description
`args`	name	Command of helm
`flags`	Array.<string>	Flags of command

history(release, flags)

Example

helm.history('mychart');

Parameters:

Name	Type	Description
`release`	string	Name of release
`flags`	Array.<string>	Flags of `helm history` command

install(release, chart, flags)

Example

//install a package
helm.install('nginx', 'bitnami/nginx');

//install on custom namespace, setting env variables
helm.install('api', 'myrepo/api', ['-n dev', '--set PORT=8000']);

Parameters:

Name	Type	Description
`release`	string	Name of release
`chart`	string	Name of chart (remote or local)
`flags`	Array.<string>	Flags of `helm install` command

list(flags)

Example

//list pcakages
helm.list();

//list packages from specific namespace
helm.list(['-n dev']);

Parameters:

Name	Type	Description
`flags`	Array.<string>	Flags of `helm list` command

rollback(release, revision, flags)

Example

helm.rollback('mychart', 1);

Parameters:

Name	Type	Description
`release`	string	Name of release
`revision`	number	Number of revision
`flags`	Array.<string>	Flags of `helm rollback` command

uninstall(release, flags)

Example

helm.uninstall('nginx');

Parameters:

Name	Type	Description
`release`	string	Name of release
`flags`	Array.<string>	Flags of `helm unintall` command

upgrade(release, chart, flags)

Example

//upgrade a package
helm.upgrade('mychart', 'repo/mychart');

//upgrade a package with flags
helm.upgrade('mychart', 'repo/mychart', ['--install', '-n dev']);

Parameters:

Name	Type	Description
`release`	string	Name of release
`chart`	string	Name of chart
`flags`	Array.<string>	Flags of `helm upgrade` command