Skip to content

Latest commit

 

History

History
467 lines (432 loc) · 18.7 KB

kubernetes.core.helm_pull_module.rst

File metadata and controls

467 lines (432 loc) · 18.7 KB
Raw

kubernetes.core.helm_pull

download a chart from a repository and (optionally) unpack it in local directory.

Version added: 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.

Parameters

Parameter Choices/Defaults Comments
binary_path
path
The path of a helm binary to use.
chart_ca_cert
path
Verify certificates of HTTPS-enabled servers using this CA bundle.
Requires helm >= 3.1.0.
chart_devel
boolean
    Choices:
  • no
  • yes
Use development versions, too. Equivalent to version '>0.0.0-0'.
Mutually exclusive with chart_version.
chart_ref
string / required
chart name on chart repository.
absolute URL.
chart_ssl_cert_file
path
Identify HTTPS client using this SSL certificate file.
Requires helm >= 3.1.0.
chart_ssl_key_file
path
Identify HTTPS client using this SSL key file
Requires helm >= 3.1.0.
chart_version
string
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 chart_devel.
destination
path / required
location to write the chart.
pass_credentials
boolean
    Choices:
  • no ←
  • yes
Pass credentials to all domains.
provenance
boolean
    Choices:
  • no ←
  • yes
Fetch the provenance file, but don't perform verification.
repo_password
string
Chart repository password where to locate the requested chart.
Required if repo_username is specified.

aliases: password, chart_repo_password
repo_url
string
chart repository url where to locate the requested chart.

aliases: url, chart_repo_url
repo_username
string
Chart repository username where to locate the requested chart.
Required if repo_password is specified.

aliases: username, chart_repo_username
skip_tls_certs_check
boolean
    Choices:
  • no ←
  • yes
Whether or not to check tls certificate for the chart download.
Requires helm >= 3.3.0.
untar_chart
boolean
    Choices:
  • no ←
  • yes
if set to true, will untar the chart after downloading it.
verify_chart
boolean
    Choices:
  • no ←
  • yes
Verify the package before using it.
verify_chart_keyring
path
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 Returned Description
command
string
always
Full `helm pull` command built by this module, in case you want to re-run the command outside the module or debug a problem.

Sample:
helm pull --repo test ...
rc
integer
always
Helm pull command return code

Sample:
1
stderr
string
always
Full `helm pull` command stderr, in case you want to display it or examine the event log
stdout
string
always
Full `helm pull` command stdout, in case you want to display it or examine the event log


Status

Authors

  • Aubin Bikouo (@abikouo)