community.kubernetes.helm_info – Get information from Helm package deployed inside the cluster
Note
This plugin is part of the community.kubernetes collection (version 1.1.1).
To install it use: ansible-galaxy collection install community.kubernetes.
To use it in a playbook, specify: community.kubernetes.helm_info.
New in version 0.11.0: of community.kubernetes
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 |
|---|---|---|
| binary_path
path
|
The path of a helm binary to use.
|
|
| 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 |
|
| 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 |
Examples
- name: Deploy latest version of Grafana chart inside monitoring namespace
community.kubernetes.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
|
|
| appversion
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/helm_info_module.html