community.kubernetes.helm_plugin_info (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

Gather information about Helm plugins installed in namespace.

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: Gather Helm plugin info
  community.kubernetes.helm_plugin_info:

Scanned by Steampunk Spotter

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

- name: Gather Helm env plugin info
  community.kubernetes.helm_plugin_info:
    plugin_name: env

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

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, to gather particular plugin info.
    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 plugins are 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
plugin_list:
  description: Helm plugin dict inside a list
  returned: always
  sample:
    description: Print out the helm environment.
    name: env
    version: 0.1.0
  type: list
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