kubernetes.core.helm_plugin_module.rst

kubernetes.core.helm_plugin

Manage Helm plugins

Version added: 1.0.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Manages Helm plugins.

Requirements

The below requirements are needed on the host that executes this module.

• helm (https://github.com/helm/helm/releases)

Parameters

Parameter	Choices/Defaults	Comments
api_key string added in 1.2.0		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		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		Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
kubeconfig raw		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. The configuration can be provided as dictionary. Added in version 2.4.0. aliases: kubeconfig_path
plugin_name string		Name of Helm plugin. Required only if state=absent or state=latest.
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.
plugin_version string added in 2.3.0		Plugin version to install. If this is not specified, the latest version is installed. Ignored when state=absent or state=latest.
state string	Choices: absent present ← latest	If state=present the Helm plugin will be installed. If state=latest the Helm plugin will be updated. Added in version 2.3.0. If state=absent the Helm plugin will be removed.
validate_certs boolean added in 1.2.0	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

- name: Install Helm plugin with a specific version
  kubernetes.core.helm_plugin:
    plugin_version: 2.0.1
    plugin_path: https://domain/path/to/plugin.tar.gz
    state: present

- name: Update Helm plugin
  kubernetes.core.helm_plugin:
    plugin_name: secrets
    state: latest

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

Status

Authors

• Abhijeet Kasurde (@Akasurde)