.. _kubernetes.core.helm_module:
********************
kubernetes.core.helm
********************
**Manages Kubernetes packages with the Helm package manager**
Version added: 0.11.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- Install, upgrade, delete packages with the Helm package manager.
Requirements
------------
The below requirements are needed on the host that executes this module.
- helm (https://github.com/helm/helm/releases)
- yaml (https://pypi.org/project/PyYAML/)
Parameters
----------
.. raw:: html
| Parameter |
Choices/Defaults |
Comments |
|
api_key
string
added in 1.2.0
|
|
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
|
|
atomic
boolean
|
|
If set, the installation process deletes the installation on failure.
|
|
binary_path
path
|
|
The path of a helm binary to use.
|
|
ca_cert
path
added in 1.2.0
|
|
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
aliases: ssl_ca_cert
|
|
chart_ref
path
|
|
chart_reference on chart repository.
path to a packaged chart.
path to an unpacked chart directory.
absolute URL.
Required when release_state is set to present.
|
|
chart_repo_url
string
|
|
Chart repository URL where to locate the requested chart.
|
|
chart_version
string
|
|
Chart version to install. If this is not specified, the latest version is installed.
|
|
context
string
|
|
Helm option to specify which kubeconfig context to use.
If the value is not specified in the task, the value of environment variable K8S_AUTH_CONTEXT will be used instead.
aliases: kube_context
|
|
create_namespace
boolean
added in 0.11.1
|
|
Create the release namespace if not present.
|
|
disable_hook
boolean
|
|
Helm option to disable hook on install/upgrade/delete.
|
|
force
boolean
|
|
Helm option to force reinstall, ignore on new install.
|
|
history_max
integer
added in 2.2.0
|
|
Limit the maximum number of revisions saved per release.
mutually exclusive with with replace.
|
|
host
string
added in 1.2.0
|
|
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
|
kubeconfig
path
|
|
Helm option to specify kubeconfig path to use.
If the value is not specified in the task, the value of environment variable K8S_AUTH_KUBECONFIG will be used instead.
aliases: kubeconfig_path
|
|
purge
boolean
|
|
Remove the release from the store and make its name free for later use.
|
|
release_name
string
/ required
|
|
Release name to manage.
aliases: name
|
|
release_namespace
string
/ required
|
|
Kubernetes namespace where the chart should be installed.
aliases: namespace
|
|
release_state
string
|
Choices:
present ←
- absent
|
Desirated state of release.
aliases: state
|
|
release_values
dictionary
|
Default:
{}
|
Value to pass to chart.
aliases: values
|
|
replace
boolean
added in 1.11.0
|
|
Reuse the given name, only if that name is a deleted release which remains in the history.
This is unsafe in production environment.
mutually exclusive with with history_max.
|
|
skip_crds
boolean
added in 1.2.0
|
|
Skip custom resource definitions when installing or upgrading.
|
|
update_repo_cache
boolean
|
|
Run helm repo update before the operation. Can be run as part of the package installation or as a separate step.
|
|
validate_certs
boolean
added in 1.2.0
|
|
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
aliases: verify_ssl
|
|
values_files
list
/ elements=string
added in 1.1.0
|
Default:
[]
|
Value files to pass to chart.
Paths will be read from the target host's filesystem, not the host running ansible.
values_files option is evaluated before values option if both are used.
Paths are evaluated in the order the paths are specified.
|
|
wait
boolean
|
|
Wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful.
|
|
wait_timeout
string
|
|
Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).
|