kubernetes.core.helm_plugin_info module – Gather information about Helm plugins

Note

This module is part of the kubernetes.core collection (version 5.0.0).

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in kubernetes.core 1.0.0

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

api_key

string

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

aliases: ssl_ca_cert

path

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

context

aliases: kube_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.

host

string

added in kubernetes.core 1.2.0

Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.

kubeconfig

aliases: kubeconfig_path

any

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.

plugin_name

string

Name of Helm plugin, to gather particular plugin info.

validate_certs

aliases: verify_ssl

boolean

added in kubernetes.core 1.2.0

Whether or not to verify the API server’s SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.

Choices:

  • false

  • true ← (default)

Examples

- name: Gather Helm plugin info
  kubernetes.core.helm_plugin_info:

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

command

string

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 ..."

plugin_list

list / elements=string

Helm plugin dict inside a list

Returned: always

Sample: {"description": "Print out the helm environment.", "name": "env", "version": "0.1.0"}

rc

integer

Helm plugin command return code

Returned: always

Sample: 1

stderr

string

Full `helm` command stderr, in case you want to display it or examine the event log

Returned: always

Sample: ""

stdout

string

Full `helm` command stdout, in case you want to display it or examine the event log

Returned: always

Sample: ""

Authors

  • Abhijeet Kasurde (@Akasurde)