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

Manage Helm repositories.

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: Add a repository
  community.kubernetes.helm_repository:
    name: stable
    repo_url: https://kubernetes.github.io/ingress-nginx

Scanned by Steampunk Spotter

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

- name: Add Red Hat Helm charts repository
  community.kubernetes.helm_repository:
    name: redhat-charts
    repo_url: https://redhat-developer.github.com/redhat-helm-charts

Inputs

    
repo_url:
    aliases:
    - url
    description:
    - Chart repository url
    type: str

repo_name:
    aliases:
    - name
    description:
    - Chart repository name.
    required: true
    type: str

repo_state:
    aliases:
    - state
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of repository.
    required: false
    type: str

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

repo_password:
    aliases:
    - password
    description:
    - Chart repository password for repository with basic auth.
    - Required if chart_repo_username is specified.
    required: false
    type: str

repo_username:
    aliases:
    - username
    description:
    - Chart repository username for repository with basic auth.
    - Required if chart_repo_password is specified.
    required: false
    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: /usr/local/bin/helm repo add bitnami https://charts.bitnami.com/bitnami
  type: str
msg:
  description: Error message returned by `helm` command
  returned: on failure
  sample: Repository already have a repository named bitnami
  type: str
stderr:
  description: Full `helm` command stderr, in case you want to display it or examine
    the event log
  returned: always
  sample: ''
  type: str
stderr_lines:
  description: Full `helm` command stderr in list, in case you want to display it
    or examine the event log
  returned: always
  sample:
  - ''
  type: list
stdout:
  description: Full `helm` command stdout, in case you want to display it or examine
    the event log
  returned: always
  sample: '"bitnami" has been added to your repositories'
  type: str
stdout_lines:
  description: Full `helm` command stdout in list, in case you want to display it
    or examine the event log
  returned: always
  sample:
  - '"bitnami" has been added to your repositories'
  type: list