You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.kubernetes.helm_repository – Manage Helm repositories.

Note

This plugin is part of the community.kubernetes collection (version 1.2.1).

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 community.kubernetes.

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

New in version 0.11.0: of community.kubernetes

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.

• helm (https://github.com/helm/helm/releases)

• yaml (https://pypi.org/project/PyYAML/)

Parameters

Parameter	Comments
binary_path path	The path of a helm binary to use.
repo_name aliases: name string / required	Chart repository name.
repo_password aliases: password string	Chart repository password for repository with basic auth. Required if chart_repo_username is specified.
repo_state aliases: state string	Desired state of repository. Choices: present ← (default) absent
repo_url aliases: url string	Chart repository url
repo_username aliases: username string	Chart repository username for repository with basic auth. Required if chart_repo_password is specified.

Examples

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

- name: Add Red Hat Helm charts repository
  community.kubernetes.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	Description
command string	Full helm command built by this module, in case you want to re-run the command outside the module or debug a problem. Returned: always Sample: “/usr/local/bin/helm repo add bitnami https://charts.bitnami.com/bitnami”
msg string	Error message returned by helm command Returned: on failure Sample: “Repository already have a repository named bitnami”
stderr string	Full helm command stderr, in case you want to display it or examine the event log Returned: always Sample: “”
stderr_lines list / elements=string	Full helm command stderr in list, in case you want to display it or examine the event log Returned: always Sample: [“”]
stdout string	Full helm command stdout, in case you want to display it or examine the event log Returned: always Sample: “\”bitnami\” has been added to your repositories”
stdout_lines list / elements=string	Full helm command stdout in list, in case you want to display it or examine the event log Returned: always Sample: [“\”bitnami\” has been added to your repositories”]

Authors

• Lucas Boisserie (@LucasBoisserie)