community.kubernetes.helm_plugin – Manage Helm plugins
community.kubernetes.helm_plugin – Manage Helm plugins
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_plugin
.
New in version 1.0.0: of community.kubernetes
Synopsis
- Manages Helm plugins.
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
| |
kubeconfig path |
Helm option to specify kubeconfig path to use. If the value is not specified in the task, the value of environment variable
| |
plugin_name string |
Name of Helm plugin. Required only if | |
plugin_path string |
Plugin path to a plugin on your local file system or a url of a remote VCS repo. If plugin path from file system is provided, make sure that tar is present on remote machine and not on Ansible controller. Required only if | |
release_namespace string / required |
Kubernetes namespace where the helm plugin should be installed.
| |
state string |
|
If If |
Examples
- name: Install Helm env plugin
community.kubernetes.helm_plugin:
plugin_path: https://github.com/adamreese/helm-env
state: present
- name: Install Helm plugin from local filesystem
community.kubernetes.helm_plugin:
plugin_path: https://domain/path/to/plugin.tar.gz
state: present
- name: Remove Helm env plugin
community.kubernetes.helm_plugin:
plugin_name: env
state: absent
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 ... |
msg string |
always |
Info about successful command
Sample: Plugin installed successfully |
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)
© 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/community/kubernetes/helm_plugin_module.html