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

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
  kubernetes.core.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
  kubernetes.core.helm_repository:
    name: redhat-charts
    repo_url: https://redhat-developer.github.com/redhat-helm-charts

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: 2.3.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: 2.3.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: 2.3.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
    version_added: 2.4.0
    version_added_collection: kubernetes.core

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

repo_name:
    aliases:
    - name
    description:
    - Chart repository name.
    required: true
    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.
    type: raw
    version_added: 2.4.0
    version_added_collection: kubernetes.core

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

force_update:
    aliases:
    - force
    default: false
    description:
    - Whether or not to replace (overwrite) the repo if it already exists.
    type: bool
    version_added: 2.4.0
    version_added_collection: kubernetes.core

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

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

pass_credentials:
    default: false
    description:
    - Pass credentials to all domains.
    required: false
    type: bool
    version_added: 2.3.0
    version_added_collection: kubernetes.core

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