community.kubernetes.helm_plugin_info – Gather information about Helm plugins
Note
This plugin is part of the community.kubernetes collection (version 1.2.1).
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 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 |
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 |
|
Name of Helm plugin, to gather particular plugin info. |
|
Kubernetes namespace where the helm plugins are installed. |
|
Whether or not to verify the API server’s SSL certificates. Can also be specified via Choices:
|
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 |
Description |
---|---|
Full helm command built by this module, in case you want to re-run the command outside the module or debug a problem. Returned: always Sample: “helm plugin list …” |
|
Helm plugin dict inside a list Returned: always Sample: {“description”: “Print out the helm environment.”, “name”: “env”, “version”: “0.1.0”} |
|
Helm plugin command return code Returned: always Sample: 1 |
|
Full helm command stderr, in case you want to display it or examine the event log Returned: always Sample: “” |
|
Full helm command stdout, in case you want to display it or examine the event log Returned: always Sample: “” |
Authors
Abhijeet Kasurde (@Akasurde)