salt.modules.helm¶

Interface with Helm

depends:: pyhelm Python package

Note

This module use the helm-cli. The helm-cli binary have to be present in your Salt-Minion path.

Helm-CLI vs Salt-Modules¶

This module is a wrapper of the helm binary. All helm v3.0 command are implemented.

To install a chart with the helm-cli:

helm install grafana stable/grafana --wait --values /path/to/values.yaml

To install a chart with the Salt-Module:

salt '*' helm.install grafana stable/grafana values='/path/to/values.yaml' flags="['wait']"

Detailed Function Documentation¶

salt.modules.helm.completion(shell, flags=None, kvflags=None)¶

Generate auto-completions script for Helm for the specified shell (bash or zsh). Return the shell auto-completion content.

shell: (string) One of ['bash', 'zsh'].
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.completion bash

salt.modules.helm.create(name, flags=None, kvflags=None)¶

Creates a chart directory along with the common files and directories used in a chart. Return True if succeed, else the error message.

name: (string) The chart name to create.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.create NAME

salt.modules.helm.dependency_build(chart, flags=None, kvflags=None)¶

Build out the charts/ directory from the Chart.lock file. Return True if succeed, else the error message.

chart: (string) The chart name to build dependency.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.dependency_build CHART

salt.modules.helm.dependency_list(chart, flags=None, kvflags=None)¶

List all of the dependencies declared in a chart. Return chart dependencies if succeed, else the error message.

chart: (string) The chart name to list dependency.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.dependency_list CHART

salt.modules.helm.dependency_update(chart, flags=None, kvflags=None)¶

Update the on-disk dependencies to mirror Chart.yaml. Return True if succeed, else the error message.

chart: (string) The chart name to update dependency.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.dependency_update CHART

salt.modules.helm.env(flags=None, kvflags=None)¶

Prints out all the environment information in use by Helm. Return Helm environments variables if succeed, else the error message.

flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.env

salt.modules.helm.get_all(release, flags=None, kvflags=None)¶

Prints a human readable collection of information about the notes, hooks, supplied values, and generated manifest file of the given release. Return release information if succeed, else the error message.

release: (string) Release name to get information from.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.get_all RELEASE

salt.modules.helm.get_hooks(release, flags=None, kvflags=None)¶

Prints a human readable collection of information about the hooks of the given release. Return release hooks information if succeed, else the error message.

release: (string) Release name to get hooks information from.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.get_hooks RELEASE

salt.modules.helm.get_manifest(release, flags=None, kvflags=None)¶

Prints a human readable collection of information about the manifest of the given release. Return release manifest information if succeed, else the error message.

release: (string) Release name to get manifest information from.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.get_manifest RELEASE

salt.modules.helm.get_notes(release, flags=None, kvflags=None)¶

Prints a human readable collection of information about the notes of the given release. Return release notes information if succeed, else the error message.

release: (string) Release name to get notes information from.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.get_notes RELEASE

salt.modules.helm.get_values(release, flags=None, kvflags=None)¶

Prints a human readable collection of information about the values of the given release. Return release values information if succeed, else the error message.

release: (string) Release name to get values information from.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.get_values RELEASE

# In YAML format
salt '*' helm.get_values RELEASE kvflags="{'output': 'yaml'}"

salt.modules.helm.help_(command, flags=None, kvflags=None)¶

Provides help for any command in the application. Return the full help if succeed, else the error message.

command: (string) Command to get help. ex: 'get'
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.help COMMAND

salt.modules.helm.history(release, flags=None, kvflags=None)¶

Prints historical revisions for a given release. Return release historic if succeed, else the error message.

release: (string) Release name to get history from.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.history RELEASE

# In YAML format
salt '*' helm.history RELEASE kvflags="{'output': 'yaml'}"

salt.modules.helm.install(release, chart, values=None, version=None, namespace=None, set=None, flags=None, kvflags=None)¶

Installs a chart archive. Return True if succeed, else the error message.

release: (string) Release name to get values information from.
chart: (string) Chart name to install.
values: (string) Absolute path to the values.yaml file.
version: (string) The exact chart version to install. If this is not specified, the latest version is installed.
namespace: (string) The namespace scope for this request.
set: (string or list) Set a values on the command line.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.install RELEASE CHART

# With values file.
salt '*' helm.install RELEASE CHART values='/path/to/values.yaml'

salt.modules.helm.lint(path, values=None, namespace=None, set=None, flags=None, kvflags=None)¶

Takes a path to a chart and runs a series of tests to verify that the chart is well-formed. Return True if succeed, else the error message.

path: (string) The path to the chart to lint.
values: (string) Absolute path to the values.yaml file.
namespace: (string) The namespace scope for this request.
set: (string or list) Set a values on the command line.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.lint PATH

salt.modules.helm.list_(namespace=None, flags=None, kvflags=None)¶

Lists all of the releases. By default, it lists only releases that are deployed or failed. Return the list of release if succeed, else the error message.

namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.list

# In YAML format
salt '*' helm.list kvflags="{'output': 'yaml'}"

salt.modules.helm.package(chart, flags=None, kvflags=None)¶

Packages a chart into a versioned chart archive file. If a path is given, this will look at that path for a chart (which must contain a Chart.yaml file) and then package that directory. Return True if succeed, else the error message.

chart: (string) Chart name to package. Can be an absolute path.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.package CHART

# With destination path.
salt '*' helm.package CHART kvflags="{'destination': '/path/to/the/package'}"

salt.modules.helm.plugin_install(path, flags=None, kvflags=None)¶

Install a Helm plugin from a url to a VCS repo or a local path. Return True if succeed, else the error message.

path: (string) Path to the local plugin. Can be an url.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.plugin_install PATH

salt.modules.helm.plugin_list(flags=None, kvflags=None)¶

List installed Helm plugins. Return the plugin list if succeed, else the error message.

flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.plugin_list

salt.modules.helm.plugin_uninstall(plugin, flags=None, kvflags=None)¶

Uninstall a Helm plugin. Return True if succeed, else the error message.

plugin: (string) The plugin to uninstall.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.plugin_uninstall PLUGIN

salt.modules.helm.plugin_update(plugin, flags=None, kvflags=None)¶

Update a Helm plugin. Return True if succeed, else the error message.

plugin: (string) The plugin to update.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.plugin_update PLUGIN

salt.modules.helm.pull(pkg, flags=None, kvflags=None)¶

Retrieve a package from a package repository, and download it locally. Return True if succeed, else the error message.

pkg: (string) The package to pull. Can be url or repo/chartname.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.pull PKG

# With destination path to write the chart.
salt '*' helm.pull PKG kvflags="{'destination': '/path/to/the/chart'}"

salt.modules.helm.repo_add(name, url, namespace=None, flags=None, kvflags=None)¶

Add a chart repository. Return True if succeed, else the error message.

name: (string) The local name of the repository to install. Have to be unique.
url: (string) The url to the repository.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.repo_add NAME URL

salt.modules.helm.repo_index(directory, namespace=None, flags=None, kvflags=None)¶

Read the current directory and generate an index file based on the charts found. Return True if succeed, else the error message.

directory: (string) The path to the index.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.index DIRECTORY

salt.modules.helm.repo_list(namespace=None, flags=None, kvflags=None)¶

List a chart repository. Return the repository list if succeed, else the error message.

namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.repo_list

# In YAML format
salt '*' helm.repo_list kvflags="{'output': 'yaml'}"

salt.modules.helm.repo_manage(present=None, absent=None, prune=False, namespace=None, flags=None, kvflags=None)¶

Manage charts repository. Return the summery of all actions.

present: (list) List of repository to be present. It's a list of dict: [{'name': 'local_name', 'url': 'repository_url'}]
absent: (list) List of local name repository to be absent.
prune: (boolean - default: False) If True, all repository already present but not in the present list would be removed.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.repo_manage present="[{'name': 'LOCAL_NAME', 'url': 'REPO_URL'}]" absent="['LOCAL_NAME']"

salt.modules.helm.repo_remove(name, namespace=None, flags=None, kvflags=None)¶

Remove a chart repository. Return True if succeed, else the error message.

name: (string) The local name of the repository to remove.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.repo_remove NAME

salt.modules.helm.repo_update(namespace=None, flags=None, kvflags=None)¶

Update all charts repository. Return True if succeed, else the error message.

namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.repo_update

salt.modules.helm.rollback(release, revision, namespace=None, flags=None, kvflags=None)¶

Rolls back a release to a previous revision. To see release revision number, execute the history module. Return True if succeed, else the error message.

release: (string) The name of the release to managed.
revision: (string) The revision number to roll back to.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.rollback RELEASE REVISION

# In dry-run mode.
salt '*' helm.rollback RELEASE REVISION flags=['dry-run']

salt.modules.helm.search_hub(keyword, flags=None, kvflags=None)¶

Search the Helm Hub or an instance of Monocular for Helm charts. Return the research result if succeed, else the error message.

keyword: (string) The keyword to search in the hub.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.search_hub KEYWORD

# In YAML format
salt '*' helm.search_hub KEYWORD kvflags="{'output': 'yaml'}"

salt.modules.helm.search_repo(keyword, flags=None, kvflags=None)¶

Search reads through all of the repositories configured on the system, and looks for matches. Search of these repositories uses the metadata stored on the system. Return the research result if succeed, else the error message.

keyword: (string) The keyword to search in the repo.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.search_hub KEYWORD

# In YAML format
salt '*' helm.search_hub KEYWORD kvflags="{'output': 'yaml'}"

salt.modules.helm.show_all(chart, flags=None, kvflags=None)¶

Inspects a chart (directory, file, or URL) and displays all its content (values.yaml, Charts.yaml, README). Return chart information if succeed, else the error message.

chart: (string) The chart to inspect.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.show_all CHART

salt.modules.helm.show_chart(chart, flags=None, kvflags=None)¶

Inspects a chart (directory, file, or URL) and displays the contents of the Charts.yaml file. Return chart information if succeed, else the error message.

chart: (string) The chart to inspect.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.show_chart CHART

salt.modules.helm.show_readme(chart, flags=None, kvflags=None)¶

Inspects a chart (directory, file, or URL) and displays the contents of the README file. Return chart information if succeed, else the error message.

chart: (string) The chart to inspect.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.show_readme CHART

salt.modules.helm.show_values(chart, flags=None, kvflags=None)¶

Inspects a chart (directory, file, or URL) and displays the contents of the values.yaml file. Return chart information if succeed, else the error message.

chart: (string) The chart to inspect.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.show_values CHART

salt.modules.helm.status(release, namespace=None, flags=None, kvflags=None)¶

Show the status of the release. Return the release status if succeed, else the error message.

release: (string) The release to status.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.status RELEASE

# In YAML format
salt '*' helm.status RELEASE kvflags="{'output': 'yaml'}"

salt.modules.helm.template(name, chart, values=None, output_dir=None, set=None, flags=None, kvflags=None)¶

Render chart templates locally and display the output. Return the chart renderer if succeed, else the error message.

name: (string) The template name.
chart: (string) The chart to template.
values: (string) Absolute path to the values.yaml file.
output_dir: (string) Absolute path to the output directory.
set: (string or list) Set a values on the command line.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.template NAME CHART

# With values file.
salt '*' helm.template NAME CHART values='/path/to/values.yaml' output_dir='path/to/output/dir'

salt.modules.helm.test(release, flags=None, kvflags=None)¶

Runs the tests for a release. Return the test result if succeed, else the error message.

release: (string) The release name to test.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.test RELEASE

salt.modules.helm.uninstall(release, namespace=None, flags=None, kvflags=None)¶

Uninstall the release name. Return True if succeed, else the error message.

release: (string) The name of the release to managed.
namespace: (string) The namespace scope for this request.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.uninstall RELEASE

# In dry-run mode.
salt '*' helm.uninstall RELEASE flags=['dry-run']

salt.modules.helm.upgrade(release, chart, values=None, version=None, namespace=None, set=None, flags=None, kvflags=None)¶

Upgrades a release to a new version of a chart. Return True if succeed, else the error message.

release: (string) The name of the release to managed.
chart: (string) The chart to managed.
values: (string) Absolute path to the values.yaml file.
version: (string) The exact chart version to install. If this is not specified, the latest version is installed.
namespace: (string) The namespace scope for this request.
set: (string or list) Set a values on the command line.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.upgrade RELEASE CHART

# In dry-run mode.
salt '*' helm.upgrade RELEASE CHART flags=['dry-run']

# With values file.
salt '*' helm.upgrade RELEASE CHART values='/path/to/values.yaml'

salt.modules.helm.verify(path, flags=None, kvflags=None)¶

Verify that the given chart has a valid provenance file. Return True if succeed, else the error message.

path: (string) The path to the chart file.
flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.verify PATH

salt.modules.helm.version(flags=None, kvflags=None)¶

Show the version for Helm. Return version information if succeed, else the error message.

flags: (list) Flags in argument of the command without values. ex: ['help', '--help']
kvflags: (dict) Flags in argument of the command with values. ex: {'v': 2, '--v': 4}

CLI Example:

salt '*' helm.version

Generated on October 23, 2024 at 09:02:06 UTC.

You are viewing docs for the latest stable release, 3007.1. Switch to docs for the previous stable release, 3006.9, or to a recent doc build from the master branch.

saltproject.io