Note
This plugin is part of the kubernetes.core collection (version 1.1.1).
To install it use: ansible-galaxy collection install kubernetes.core.
To use it in a playbook, specify: kubernetes.core.helm_plugin_info.
New in version 1.0.0: of kubernetes.core
Note
This module has a corresponding action plugin.
The below requirements are needed on the host that executes this module.
| 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 | |
| plugin_name string | Name of Helm plugin, to gather particular plugin info. | |
| release_namespace string / required | Kubernetes namespace where the helm plugins are installed. aliases: namespace |
- name: Gather Helm plugin info
kubernetes.core.helm_plugin_info:
- name: Gather Helm env plugin info
kubernetes.core.helm_plugin_info:
plugin_name: env
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/kubernetes/core/helm_plugin_info_module.html