Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.54 KB

README.md

File metadata and controls

49 lines (37 loc) · 2.54 KB
Raw

Helm Remote

Author: Bob Jackman

Install a remotely hosted Helm chart in a way that it will be properly uninstalled when running tilt down

Usage

Install an HTTPS Chart

load('ext://helm_remote', 'helm_remote')
helm_remote('memcached', repo_url='https://charts.bitnami.com/bitnami')

Install an OCI Chart

load('ext://helm_remote', 'helm_remote')
helm_remote('demo', repo_name='oci://registry-1.docker.io/docker', version='0.1.0')
Additional Parameters
helm_remote(chart, repo_url='', repo_name='', release_name='', namespace='', version='', username='', password='', values=[], set=[])
  • chart ( str ) – the name of the chart to install
  • repo_name ( str ) – the name of the repo within which to find the chart (assuming the repo is already added locally)
    if omitted, defaults to the same value as chart_name
  • repo_url ( str ) – the URL of the repo within which to find the chart (equivalent to helm repo add <repo_name> <repo_url>)
  • release_name (str) - the name of the helm release
    if omitted, defaults to the same value as chart_name
  • namespace ( str ) – the namespace to deploy the chart to (equivalent to helm's --namespace <namespace> flags)
  • version ( str ) – the version of the chart to install. If omitted, defaults to latest version (equivalent to helm's --version flag)
  • username ( str ) – repository authentication username, if needed (equivalent to helm's --username flag)
  • password ( str ) – repository authentication password, if needed (equivalent to helm's --password flag)
  • values ( Union [ str , List [ str ]]) – Specify one or more values files (in addition to the values.yaml file in the chart). Equivalent to the helm's --values or -f flags
  • set ( Union [ str , List [ str ]]) – Directly specify one or more values (equivalent to helm's --set flag)
  • allow_duplicates ( bool ) - Allow duplicate resources. Usually duplicate resources indicate a programmer error. But some charts specify resources twice.
  • create_namespace ( bool ) - Create the namespace specified in namespace ( equivalent to helm's --create_namespace flag)
  • install_crds ( bool ) - extension will try to find CRDs and install them before helm apply (enabled by default)

Change the Cache Location

By default helm_remote will store retrieved helm charts in the .helm directory at your workspace's root. This location can be customized by calling os.putenv('TILT_HELM_REMOTE_CACHE_DIR', new_directory) before loading the module.