kubernetes.core.helm_pull module – download a chart from a repository and (optionally) unpack it in local directory.
Note
This module is part of the kubernetes.core collection (version 2.4.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install kubernetes.core
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: kubernetes.core.helm_pull
.
New in kubernetes.core 2.4.0
Synopsis
Retrieve a package from a package repository, and download it locally.
It can also be used to perform cryptographic verification of a chart without installing the chart.
There are options for unpacking the chart after download.
Requirements
The below requirements are needed on the host that executes this module.
helm >= 3.0 (https://github.com/helm/helm/releases)
Parameters
Parameter |
Comments |
---|---|
The path of a helm binary to use. |
|
Verify certificates of HTTPS-enabled servers using this CA bundle. Requires helm >= 3.1.0. |
|
Use development versions, too. Equivalent to version ‘>0.0.0-0’. Mutually exclusive with Choices:
|
|
chart name on chart repository. absolute URL. |
|
Identify HTTPS client using this SSL certificate file. Requires helm >= 3.1.0. |
|
Identify HTTPS client using this SSL key file Requires helm >= 3.1.0. |
|
Specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). Mutually exclusive with |
|
location to write the chart. |
|
Pass credentials to all domains. Choices:
|
|
Fetch the provenance file, but don’t perform verification. Choices:
|
|
Chart repository password where to locate the requested chart. Required if |
|
chart repository url where to locate the requested chart. |
|
Chart repository username where to locate the requested chart. Required if |
|
Whether or not to check tls certificate for the chart download. Requires helm >= 3.3.0. Choices:
|
|
if set to true, will untar the chart after downloading it. Choices:
|
|
Verify the package before using it. Choices:
|
|
location of public keys used for verification. |
Examples
- name: Download chart using chart url
kubernetes.core.helm_pull:
chart_ref: https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz
destination: /path/to/chart
- name: Download Chart using chart_name and repo_url
kubernetes.core.helm_pull:
chart_ref: redis
repo_url: https://charts.bitnami.com/bitnami
untar_chart: yes
destination: /path/to/chart
- name: Download Chart (skip tls certificate check)
kubernetes.core.helm_pull:
chart_ref: redis
repo_url: https://charts.bitnami.com/bitnami
untar_chart: yes
destination: /path/to/chart
skip_tls_certs_check: yes
- name: Download Chart using chart registry credentials
kubernetes.core.helm_pull:
chart_ref: redis
repo_url: https://charts.bitnami.com/bitnami
untar_chart: yes
destination: /path/to/chart
username: myuser
password: mypassword123
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Full `helm pull` command built by this module, in case you want to re-run the command outside the module or debug a problem. Returned: always Sample: |
|
Helm pull command return code Returned: always Sample: |
|
Full `helm pull` command stderr, in case you want to display it or examine the event log Returned: always Sample: |
|
Full `helm pull` command stdout, in case you want to display it or examine the event log Returned: always Sample: |