kubernetes.core.helm_info_module.rst

kubernetes.core.helm_info

Get information from Helm package deployed inside the cluster

Version added: 0.11.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

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

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	Choices/Defaults	Comments
api_key string added in 1.2.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 1.2.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		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
get_all_values boolean added in 2.4.0	Choices: no ← yes	Set to True if you want to get all (computed) values of the release. When False (default), only user supplied values are returned.
host string added in 1.2.0		Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
kubeconfig raw		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. Added in version 2.4.0. 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
release_state list / elements=string added in 2.3.0	Default: []	Show releases as per their states. Default value is deployed and failed. If set to all, show all releases without any filter applied. If set to deployed, show deployed releases. If set to failed, show failed releases. If set to pending, show pending releases. If set to superseded, show superseded releases. If set to uninstalled, show uninstalled releases, if helm uninstall --keep-history was used. If set to uninstalling, show releases that are currently being uninstalled.
validate_certs boolean added in 1.2.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

Examples

- name: Gather information of Grafana chart inside monitoring namespace
  kubernetes.core.helm_info:
    name: test
    release_namespace: monitoring

- name: Gather information about test-chart with pending state
  kubernetes.core.helm_info:
    name: test-chart
    release_namespace: testenv
    release_state:
    - pending

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
	hooks list / elements=dictionary added in 2.4.0	always	Hooks of the release
	manifest list / elements=dictionary added in 2.4.0	always	Manifest of the release
	name string	always	Name of the release
	namespace string	always	Namespace where the release is deployed
	notes string added in 2.4.0	always	Notes of the release
	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

Status

Authors

• Lucas Boisserie (@LucasBoisserie)