kubernetes.core.helm_info (3.0.1) — module

Install collection

Install with ansible-galaxy collection install kubernetes.core:==3.0.1

Add to requirements.yml

  collections:
    - name: kubernetes.core
      version: 3.0.1

Description

Get information (values, states, ...) from Helm package deployed inside the cluster.

Requirements

• helm (https://github.com/helm/helm/releases)
• yaml (https://pypi.org/project/PyYAML/)

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather information of Grafana chart inside monitoring namespace
  kubernetes.core.helm_info:
    name: test
    release_namespace: monitoring

Scanned by Steampunk Spotter

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

- name: Gather information about test-chart with pending state
  kubernetes.core.helm_info:
    name: test-chart
    release_namespace: testenv
    release_state:
    - pending

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

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

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

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.
    - The configuration can be provided as dictionary. Added in version 2.4.0.
    type: raw

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

release_name:
    aliases:
    - name
    description:
    - Release name to manage.
    required: true
    type: str

release_state:
    default: []
    description:
    - Show releases as per their states.
    - Default value is C(deployed) and C(failed).
    - If set to C(all), show all releases without any filter applied.
    - If set to C(deployed), show deployed releases.
    - If set to C(failed), show failed releases.
    - If set to C(pending), show pending releases.
    - If set to C(superseded), show superseded releases.
    - If set to C(uninstalled), show uninstalled releases, if C(helm uninstall --keep-history)
      was used.
    - If set to C(uninstalling), show releases that are currently being uninstalled.
    elements: str
    type: list
    version_added: 2.3.0
    version_added_collection: kubernetes.core

get_all_values:
    default: false
    description:
    - Set to C(True) if you want to get all (computed) values of the release.
    - When C(False) (default), only user supplied values are returned.
    required: false
    type: bool
    version_added: 2.4.0
    version_added_collection: kubernetes.core

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

release_namespace:
    aliases:
    - namespace
    description:
    - Kubernetes namespace where the chart should be installed.
    required: true
    type: str

Outputs

status:
  contains:
    app_version:
      description: Version of app deployed
      returned: always
      type: str
    chart:
      description: Chart name and chart version
      returned: always
      type: str
    hooks:
      description: Hooks of the release
      elements: dict
      returned: always
      type: list
      version_added: 2.4.0
      version_added_collection: kubernetes.core
    manifest:
      description: Manifest of the release
      elements: dict
      returned: always
      type: list
      version_added: 2.4.0
      version_added_collection: kubernetes.core
    name:
      description: Name of the release
      returned: always
      type: str
    namespace:
      description: Namespace where the release is deployed
      returned: always
      type: str
    notes:
      description: Notes of the release
      returned: always
      type: str
      version_added: 2.4.0
      version_added_collection: kubernetes.core
    revision:
      description: Number of time where the release has been updated
      returned: always
      type: str
    status:
      description: Status of release (can be DEPLOYED, FAILED, ...)
      returned: always
      type: str
    updated:
      description: The Date of last update
      returned: always
      type: str
    values:
      description: Dict of Values used to deploy
      returned: always
      type: str
  description: A dictionary of status output
  returned: only when release exists
  type: complex