You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

helm - Manages Kubernetes packages with the Helm package manager¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
- Status

Synopsis ¶

Install, upgrade, delete and list packages with the Helm package manage

Requirements (on host that executes module)¶

pyhelm

grpcio

Options ¶

parameter	required	default	choices	comments
chart	no			A map describing the chart to install. For example: chart: name: memcached version: 0.4.0 source: type: repo location: https://kubernetes-charts.storage.googleapis.com
disable_hooks	no			Whether to disable hooks during the uninstall process
host	no	localhost		Tiller's server host
name	no			Release name to manage
namespace	no	default		Kubernetes namespace where the chart should be installed
port	no	44134		Tiller's server port
state	no	installed	absent purged present	Whether to install `present`, remove `absent`, or purge `purged` a package.
values	no			A map of value options for the chart.

Examples ¶

- name: Install helm chart
  helm:
    host: localhost
    chart:
      name: memcached
      version: 0.4.0
      source:
        type: repo
        location: https://kubernetes-charts.storage.googleapis.com
    state: installed
    name: my-memcached
    namespace: default

- name: Uninstall helm chart
  helm:
    host: localhost
    state: absent
    name: my-memcached

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.