community.kubernetes.helm_plugin_info – Gather information about Helm plugins

Note

This plugin is part of the community.kubernetes collection (version 1.2.1).

To install it use: ansible-galaxy collection install community.kubernetes.

To use it in a playbook, specify: community.kubernetes.helm_plugin_info.

New in version 1.0.0: of community.kubernetes

Synopsis

  • Gather information about Helm plugins installed in namespace.

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 community.kubernetes
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 community.kubernetes
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 community.kubernetes
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
plugin_name
string
Name of Helm plugin, to gather particular plugin info.
release_namespace
string
Kubernetes namespace where the helm plugins are installed.

aliases: namespace
validate_certs
boolean
added in 1.2.0 of community.kubernetes
    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 Helm plugin info
  community.kubernetes.helm_plugin_info:

- name: Gather Helm env plugin info
  community.kubernetes.helm_plugin_info:
    plugin_name: env

Return Values

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:
helm plugin list ...
plugin_list
list / elements=string
always
Helm plugin dict inside a list

Sample:
{'description': 'Print out the helm environment.', 'name': 'env', 'version': '0.1.0'}
rc
integer
always
Helm plugin command return code

Sample:
1
stderr
string
always
Full `helm` command stderr, in case you want to display it or examine the event log
stdout
string
always
Full `helm` command stdout, in case you want to display it or examine the event log


Authors

  • Abhijeet Kasurde (@Akasurde)