kubernetes.core.helm_info – Get information from Helm package deployed inside the cluster

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_info.

New in version 0.11.0: of kubernetes.core

Synopsis

  • Get information (values, states, …) from Helm package deployed inside the cluster.

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
api_key
string
added in 1.2.0 of kubernetes.core
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 1.2.0 of kubernetes.core
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
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
host
string
added in 1.2.0 of kubernetes.core
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
kubeconfig
path
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.

aliases: kubeconfig_path
release_name
string / required
Release name to manage.

aliases: name
release_namespace
string / required
Kubernetes namespace where the chart should be installed.

aliases: namespace
validate_certs
boolean
added in 1.2.0 of kubernetes.core
    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

Examples

- name: Deploy latest version of Grafana chart inside monitoring namespace
  kubernetes.core.helm_info:
    name: test
    release_namespace: monitoring

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
status
complex
only when release exists
A dictionary of status output

 
app_version
string
always
Version of app deployed

 
chart
string
always
Chart name and chart version

 
name
string
always
Name of the release

 
namespace
string
always
Namespace where the release is deployed

 
revision
string
always
Number of time where the release has been updated

 
status
string
always
Status of release (can be DEPLOYED, FAILED, ...)

 
updated
string
always
The Date of last update

 
values
string
always
Dict of Values used to deploy



Authors

  • Lucas Boisserie (@LucasBoisserie)