kubernetes.core.helm_info module – Get information from Helm package deployed inside the cluster
Note
This module is part of the kubernetes.core collection (version 2.3.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: kubernetes.core.helm_info
.
New in kubernetes.core 0.11.0
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 |
Comments |
---|---|
Token used to authenticate with the API. Can also be specified via |
|
The path of a helm binary to use. |
|
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 |
|
Helm option to specify which kubeconfig context to use. If the value is not specified in the task, the value of environment variable |
|
Provide a URL for accessing the API. Can also be specified via |
|
Helm option to specify kubeconfig path to use. If the value is not specified in the task, the value of environment variable |
|
Release name to manage. |
|
Kubernetes namespace where the chart should be installed. |
|
Show releases as per their states. Default value is If set to If set to If set to If set to If set to If set to If set to |
|
Whether or not to verify the API server’s SSL certificates. Can also be specified via Choices:
|
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 |
Description |
---|---|
A dictionary of status output Returned: only when release exists |
|
Version of app deployed Returned: always |
|
Chart name and chart version Returned: always |
|
Name of the release Returned: always |
|
Namespace where the release is deployed Returned: always |
|
Number of time where the release has been updated Returned: always |
|
Status of release (can be DEPLOYED, FAILED, …) Returned: always |
|
The Date of last update Returned: always |
|
Dict of Values used to deploy Returned: always |