kubernetes.core.helm_plugin – Manage Helm plugins

Note

This plugin is part of the kubernetes.core collection (version 2.2.2).

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 kubernetes.core.

To use it in a playbook, specify: kubernetes.core.helm_plugin.

New in version 1.0.0: of kubernetes.core

Synopsis

  • Manages Helm plugins.

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 kubernetes.core
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 kubernetes.core
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 kubernetes.core
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.
Required only if state=absent.
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 state=present.
state
string
    Choices:
  • absent
  • present ←
If state=present the Helm plugin will be installed.
If state=absent the Helm plugin will be removed.
validate_certs
boolean
added in 1.2.0 of kubernetes.core
    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: Install Helm env plugin
  kubernetes.core.helm_plugin:
    plugin_path: https://github.com/adamreese/helm-env
    state: present

- name: Install Helm plugin from local filesystem
  kubernetes.core.helm_plugin:
    plugin_path: https://domain/path/to/plugin.tar.gz
    state: present

- name: Remove Helm env plugin
  kubernetes.core.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)