release#

States module for Helm Release.

async idem_helm.states.helm.release.present(hub, ctx, name: str, chart: str, namespace: str, repository: str = None, resource_id: str = None, values: Dict = None, version: str = None, key_file: str = None, keyring: str = None, ca_file: str = None, cert_file: str = None, username: str = None, password: str = None, values_files: List = None, dependency_update: bool = False, create_namespace: bool = False, atomic: bool = False, devel: bool = False, disable_openapi_validation: bool = False, no_hooks: bool = False, verify: bool = False, timeout: str = None) → Dict[str, Any][source]#

Create/Update a Helm Release.

Parameters:

  • name (str) – An Idem name of the resource.

  • chart (str) – Chart name to be installed

  • namespace (str) – namespace scope for helm release

  • resource_id (str, Optional) – An identifier of the resource in the provider.

  • repository (str, Optional) – chart repository url where to locate the requested chart

  • values (Dict, Optional) – Specify values in a YAML

  • version (str, Optional) – Chart version to install. If this is not specified, the latest version is installed.

  • key_file (str, Optional) – The repositories cert key file

  • keyring (str, Optional) – location of public keys used for verification (default “~/.gnupg/pubring.gpg”)

  • values_files (List, Optional) – specify values in a YAML file

  • ca_file (str, Optional) – verify certificates of HTTPS-enabled servers using this CA bundle

  • cert_file (str, Optional) – identify HTTPS client using this SSL certificate file

  • username (str, Optional) – chart repository username where to locate the requested chart

  • password (str, Optional) – chart repository password where to locate the requested chart

  • dependency_update (bool, Optional) – update dependencies if they are missing before installing the chart

  • create_namespace (bool, Optional) – create the release namespace if not present

  • atomic (bool, Optional) – if True, the installation process deletes the installation on failure.

  • devel (bool, Optional) – use development versions, too. Equivalent to version ‘>0.0.0-0’. If –version is set, this is ignored

  • disable_openapi_validation (bool, Optional) – if set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema

  • no_hooks (bool, Optional) – prevent hooks from running during install

  • verify (bool, Optional) – verify the package before using it. If verify is set, the chart MUST have a provenance file, and the provenance file MUST pass all verification steps.

  • timeout (str, Optional) – time to wait for Kubernetes commands to complete. (Ex-: 100s, 200s, 10m)

Returns:

Dict[str, Any]

Examples

idem-helm-release-test:
  helm.release.present:
    - name: idem-redis
    - resource_id: idem-redis
    - repository: https://charts.bitnami.com/bitnami
    - chart: redis
    - namespace: kube-system
    - timeout: 200s
async idem_helm.states.helm.release.absent(hub, ctx, name: str, namespace: str = 'default', resource_id: str = None) → Dict[str, Any][source]#

Delete a helm release

Parameters:

  • name (str) – An Idem name of the resource.

  • namespace (str, Optional) – namespace scope for helm release. Defaults to ‘default’ namespace, in case of value not provided in absent state.

  • resource_id (str, Optional) – An identifier of the resource in the provider.

Returns:

Dict[str, Any]

Examples

idem-helm-release-test:
  helm.release.absent:
    - name: idem-redis
    - resource_id: idem-redis
    - namespace: kube-system
async idem_helm.states.helm.release.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

list of helm releases in all namespaces.

Repository attributes and other flags are not being persisted as metadata by helm, it will not be set to any value by default.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe helm.release