kubernetes.core.helm_pull (3.0.1) — module

Install collection

Install with ansible-galaxy collection install kubernetes.core:==3.0.1

Add to requirements.yml

  collections:
    - name: kubernetes.core
      version: 3.0.1

Description

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

• helm >= 3.0 (https://github.com/helm/helm/releases)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
repo_url:
    aliases:
    - url
    - chart_repo_url
    description:
    - chart repository url where to locate the requested chart.
    type: str

chart_ref:
    description:
    - chart name on chart repository.
    - absolute URL.
    required: true
    type: str

provenance:
    default: false
    description:
    - Fetch the provenance file, but don't perform verification.
    type: bool

binary_path:
    description:
    - The path of a helm binary to use.
    required: false
    type: path

chart_devel:
    description:
    - Use development versions, too. Equivalent to version '>0.0.0-0'.
    - Mutually exclusive with C(chart_version).
    type: bool

destination:
    description:
    - location to write the chart.
    required: true
    type: path

untar_chart:
    default: false
    description:
    - if set to true, will untar the chart after downloading it.
    type: bool

verify_chart:
    default: false
    description:
    - Verify the package before using it.
    type: bool

chart_ca_cert:
    description:
    - Verify certificates of HTTPS-enabled servers using this CA bundle.
    - Requires helm >= 3.1.0.
    type: path

chart_version:
    description:
    - 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 C(chart_devel).
    type: str

repo_password:
    aliases:
    - password
    - chart_repo_password
    description:
    - Chart repository password where to locate the requested chart.
    - Required if C(repo_username) is specified.
    type: str

repo_username:
    aliases:
    - username
    - chart_repo_username
    description:
    - Chart repository username where to locate the requested chart.
    - Required if C(repo_password) is specified.
    type: str

pass_credentials:
    default: false
    description:
    - Pass credentials to all domains.
    type: bool

chart_ssl_key_file:
    description:
    - Identify HTTPS client using this SSL key file
    - Requires helm >= 3.1.0.
    type: path

chart_ssl_cert_file:
    description:
    - Identify HTTPS client using this SSL certificate file.
    - Requires helm >= 3.1.0.
    type: path

skip_tls_certs_check:
    default: false
    description:
    - Whether or not to check tls certificate for the chart download.
    - Requires helm >= 3.3.0.
    type: bool

verify_chart_keyring:
    description:
    - location of public keys used for verification.
    type: path

Outputs

command:
  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 --repo test ...
  type: str
rc:
  description: Helm pull command return code
  returned: always
  sample: 1
  type: int
stderr:
  description: Full `helm pull` command stderr, in case you want to display it or
    examine the event log
  returned: always
  sample: ''
  type: str
stdout:
  description: Full `helm pull` command stdout, in case you want to display it or
    examine the event log
  returned: always
  sample: ''
  type: str