Skip to content

Files

Latest commit

Jun 5, 2025
b1fbd38 · Jun 5, 2025

History

History
460 lines (427 loc) · 20.3 KB

kubernetes.core.helm_repository_module.rst

File metadata and controls

460 lines (427 loc) · 20.3 KB

kubernetes.core.helm_repository

Manage Helm repositories.

Version added: 0.11.0

  • Manage Helm repositories.

The below requirements are needed on the host that executes this module.

Parameter Choices/Defaults Comments
api_key
string
added in 2.3.0
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
binary_path
path
The path of a helm binary to use.
ca_cert
path
added in 2.3.0
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.

aliases: ssl_ca_cert
context
string
added in 2.4.0
Helm option to specify which kubeconfig context to use.
If the value is not specified in the task, the value of environment variable K8S_AUTH_CONTEXT will be used instead.

aliases: kube_context
force_update
boolean
added in 2.4.0
    Choices:
  • no ←
  • yes
Whether or not to replace (overwrite) the repo if it already exists.

aliases: force
host
string
added in 2.3.0
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
insecure_skip_tls_verify
boolean
added in 5.3.0
    Choices:
  • no ←
  • yes
Skip tls certificate checks for the repository url.

aliases: skip_tls_certs_check
kubeconfig
raw
added in 2.4.0
Helm option to specify kubeconfig path to use.
If the value is not specified in the task, the value of environment variable K8S_AUTH_KUBECONFIG will be used instead.
The configuration can be provided as dictionary.

aliases: kubeconfig_path
pass_credentials
boolean
added in 2.3.0
    Choices:
  • no ←
  • yes
Pass credentials to all domains.
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
validate_certs
boolean
added in 2.3.0
    Choices:
  • no
  • yes ←
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.

aliases: verify_ssl

- 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

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
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
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)