community.general.helm – Manages Kubernetes packages with the Helm package manager
community.general.helm – Manages Kubernetes packages with the Helm package manager
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.helm
.
DEPRECATED
- Removed in
- version 3.0.0
- Why
- For more details https://github.com/ansible/ansible/issues/61546.
- Alternative
- Use community.kubernetes.helm instead.
Synopsis
- Install, upgrade, delete and list packages with the Helm package manager.
Requirements
The below requirements are needed on the host that executes this module.
- pyhelm
- grpcio
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
chart dictionary |
Default: {} |
A map describing the chart to install. See examples for available options. |
disable_hooks boolean |
|
Whether to disable hooks during the uninstall process. |
host string |
Default: "localhost" |
Tiller's server host. |
name string |
Release name to manage. | |
namespace string |
Default: "default" |
Kubernetes namespace where the chart should be installed. |
port integer |
Default: 44134 |
Tiller's server port. |
state string |
|
Whether to install |
values dictionary |
Default: {} |
A map of value options for the chart. |
Examples
- name: Install helm chart
community.general.helm:
host: localhost
chart:
name: memcached
version: 0.4.0
source:
type: repo
location: https://kubernetes-charts.storage.googleapis.com
state: present
name: my-memcached
namespace: default
- name: Uninstall helm chart
community.general.helm:
host: localhost
state: absent
name: my-memcached
- name: Install helm chart from a git repo
community.general.helm:
host: localhost
chart:
source:
type: git
location: https://github.com/user/helm-chart.git
state: present
name: my-example
namespace: default
values:
foo: "bar"
- name: Install helm chart from a git repo specifying path
community.general.helm:
host: localhost
chart:
source:
type: git
location: https://github.com/helm/charts.git
path: stable/memcached
state: present
name: my-memcached
namespace: default
values: "{{ lookup('file', '/path/to/file/values.yaml') | from_yaml }}"
Status
- This module will be removed in version 3.0.0. [deprecated]
- For more information see DEPRECATED.
Authors
- Flavio Percoco (@flaper87)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/helm_module.html