community.kubernetes.helm_plugin (1.2.1) — module

Install collection

Install with ansible-galaxy collection install community.kubernetes:==1.2.1

Add to requirements.yml

  collections:
    - name: community.kubernetes
      version: 1.2.1

Description

Manages Helm plugins.

Requirements

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Install Helm env plugin
  community.kubernetes.helm_plugin:
    plugin_path: https://github.com/adamreese/helm-env
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove Helm env plugin
  community.kubernetes.helm_plugin:
    plugin_name: env
    state: absent

Inputs

    
host:
    description:
    - Provide a URL for accessing the API. Can also be specified via C(K8S_AUTH_HOST)
      environment variable.
    type: str
    version_added: 1.2.0
    version_added_collection: community.kubernetes

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(state=present) the Helm plugin will be installed.
    - If C(state=absent) the Helm plugin will be removed.
    type: str

api_key:
    description:
    - Token used to authenticate with the API. Can also be specified via C(K8S_AUTH_API_KEY)
      environment variable.
    type: str
    version_added: 1.2.0
    version_added_collection: community.kubernetes

ca_cert:
    aliases:
    - ssl_ca_cert
    description:
    - 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 C(K8S_AUTH_SSL_CA_CERT) environment variable.
    type: path
    version_added: 1.2.0
    version_added_collection: community.kubernetes

context:
    aliases:
    - kube_context
    description:
    - Helm option to specify which kubeconfig context to use.
    - If the value is not specified in the task, the value of environment variable C(K8S_AUTH_CONTEXT)
      will be used instead.
    type: str

kubeconfig:
    aliases:
    - kubeconfig_path
    description:
    - Helm option to specify kubeconfig path to use.
    - If the value is not specified in the task, the value of environment variable C(K8S_AUTH_KUBECONFIG)
      will be used instead.
    type: path

binary_path:
    description:
    - The path of a helm binary to use.
    required: false
    type: path

plugin_name:
    description:
    - Name of Helm plugin.
    - Required only if C(state=absent).
    type: str

plugin_path:
    description:
    - 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 C(state=present).
    type: str

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description:
    - Whether or not to verify the API server's SSL certificates. Can also be specified
      via C(K8S_AUTH_VERIFY_SSL) environment variable.
    type: bool
    version_added: 1.2.0
    version_added_collection: community.kubernetes

release_namespace:
    aliases:
    - namespace
    description:
    - Kubernetes namespace where the helm plugin should be installed.
    type: str

Outputs

command:
  description: 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 ...
  type: str
msg:
  description: Info about successful command
  returned: always
  sample: Plugin installed successfully
  type: str
rc:
  description: Helm plugin command return code
  returned: always
  sample: 1
  type: int
stderr:
  description: Full `helm` command stderr, in case you want to display it or examine
    the event log
  returned: always
  sample: ''
  type: str
stdout:
  description: Full `helm` command stdout, in case you want to display it or examine
    the event log
  returned: always
  sample: ''
  type: str