kubernetes.core.helm_repository – Manage Helm repositories.

Note

This plugin is part of the kubernetes.core collection (version 2.2.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.

To use it in a playbook, specify: kubernetes.core.helm_repository.

New in version 0.11.0: of kubernetes.core

Synopsis

  • Manage Helm repositories.

Note

This module has a corresponding action plugin.

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.
repo_name
string / required
Chart repository name.

aliases: name
repo_password
string
Chart repository password for repository with basic auth.
Required if chart_repo_username is specified.

aliases: password
repo_state
string
    Choices:
  • present ←
  • absent
Desired state of repository.

aliases: state
repo_url
string
Chart repository url

aliases: url
repo_username
string
Chart repository username for repository with basic auth.
Required if chart_repo_password is specified.

aliases: username

Examples

- name: Add a repository
  kubernetes.core.helm_repository:
    name: stable
    repo_url: https://kubernetes.github.io/ingress-nginx

- name: Add Red Hat Helm charts repository
  kubernetes.core.helm_repository:
    name: redhat-charts
    repo_url: https://redhat-developer.github.com/redhat-helm-charts

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` command built by this module, in case you want to re-run the command outside the module or debug a problem.

Sample:
/usr/local/bin/helm repo add bitnami https://charts.bitnami.com/bitnami
msg
string
on failure
Error message returned by `helm` command

Sample:
Repository already have a repository named bitnami
stderr
string
always
Full `helm` command stderr, in case you want to display it or examine the event log

stderr_lines
list / elements=string
always
Full `helm` command stderr in list, in case you want to display it or examine the event log

Sample:
['']
stdout
string
always
Full `helm` command stdout, in case you want to display it or examine the event log

Sample:
"bitnami" has been added to your repositories
stdout_lines
list / elements=string
always
Full `helm` command stdout in list, in case you want to display it or examine the event log

Sample:
['"bitnami" has been added to your repositories']


Authors

  • Lucas Boisserie (@LucasBoisserie)