Helmfile

https://helmfile.readthedocs.io/en/latest
Admin
Helmfile is a declarative specification for deploying Helm charts to Kubernetes clusters, enabling...
Tokens:101,211
Snippets:791
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install helm-unittest plugin

Source: https://helmfile.readthedocs.io/en/latest/cli

Install the helm-unittest plugin required by the `helmfile unittest` sub-command.

```bash
helm plugin install https://github.com/helm-unittest/helm-unittest

```

--------------------------------

### Base Files Example: common.yaml and helmfile.yaml

Source: https://helmfile.readthedocs.io/en/latest/values-and-merging

Base files are merged first to share common configuration. The helmfile.yaml references common.yaml via the bases: key; both files are required for this setup.

```yaml
# common.yaml
environments:
  default:
  production:

helmDefaults:
  wait: true
  timeout: 300

```

```yaml
# helmfile.yaml
bases:
  - common.yaml

releases:
  - name: myapp
    chart: mychart

```

--------------------------------

### helmfile create usage examples

Source: https://helmfile.readthedocs.io/en/latest/cli

Usage examples for `helmfile create`, which generates a helmfile deployment project scaffold. The command validates the project name and without `--force` atomically checks all target paths before writing.

```bash
# Create a project in a new directory
helmfile create my-project

# Create a project in the current directory
helmfile create

# Specify a custom output directory
helmfile create my-project --output-dir /path/to/project

# Overwrite existing scaffold files
helmfile create my-project --force

```

--------------------------------

### helmfile sync with --timeout flag examples

Source: https://helmfile.readthedocs.io/en/latest/cli

Examples of using the helmfile sync command with the --timeout flag, optionally combined with --wait, --wait-for-jobs, and --selector flags.

```bash
# Override timeout for all releases to 10 minutes
helmfile sync --timeout 600

# Combine timeout with wait flags
helmfile sync --timeout 900 --wait --wait-for-jobs

# Target specific releases with custom timeout
helmfile sync --selector tier=backend --timeout 1200

```

--------------------------------

### range function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Creates a list of numbers by starting from the given starting value, adding the step until reaching or exceeding the stopping value. The example shows a range from 1 to 10 with step 3.

```hcl
range(startingNumber, stoppingNumber, stepNumber)
```

```hcl
range(1, 10, 3)
# [1, 4, 7]
```

--------------------------------

### Minimal CI example: configure OTel env vars and run helmfile with --otel-tracing

Source: https://helmfile.readthedocs.io/en/latest/proposals/otel-tracing

Sets the OTLP endpoint, authorization header, service name, and resource attributes, then runs helmfile with --otel-tracing for a production backend apply. The endpoint defaults to http://localhost:4318 if unset; the header example uses a Bearer token from OTEL_TOKEN.

```shell
export OTEL_EXPORTER_OTLP_ENDPOINT="https://otel.example.com"
export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer ${OTEL_TOKEN}"
export OTEL_SERVICE_NAME="helmfile-ci"
export OTEL_RESOURCE_ATTRIBUTES="cicd.pipeline=deploy,cicd.run_id=4821"
helmfile --otel-tracing -e production -l tier=backend apply

```

--------------------------------

### Install Helmfile on macOS, Linux, and Windows

Source: https://helmfile.readthedocs.io/en/latest

Install Helmfile on macOS via Homebrew, on Linux by downloading the binary from GitHub releases, and on Windows via Scoop. The Linux command downloads the latest release and makes it executable.

```bash
# macOS
brew install helmfile

# Linux - download from GitHub releases
curl -L https://github.com/helmfile/helmfile/releases/latest/download/helmfile_$(uname -s)_$(uname -m) -o /usr/local/bin/helmfile && chmod +x /usr/local/bin/helmfile

# Windows
scoop install helmfile

```

--------------------------------

### keys function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Takes a map and returns a sorted list of the map keys. The example shows the sorted keys of a map.

```hcl
keys(map)
```

```hcl
keys({val1=1, val2=2, val3=3})
# ["val1","val2","val3"]
```

--------------------------------

### Helmfile configuration for kustomization

Source: https://helmfile.readthedocs.io/en/latest/advanced-features

Example `helmfile.yaml` that references a kustomization as the chart and a `values.yaml` file for configuration.

```yaml
releases:
- name: myapp
  chart: mykustomization
  values:
  - values.yaml

```

--------------------------------

### Helmfile .Values vs Helm .Values example

Source: https://helmfile.readthedocs.io/en/latest/writing-helmfile

Shows how Helmfile's .Values (aliased as .StateValues) and Helm's .Values can be used in the same template. The example sets a project name using the environment name and state values, then defines an extraEnvVars block that references Helm's .Values.

```plaintext
app:
  project: {{.Environment.Name}}-{{.StateValues.project}} # Same as {{.Environment.Name}}-{{.Values.project}}

{{`
extraEnvVars:
- name: APP_PROJECT
  value: {{.Values.app.project}}
`}}

```

--------------------------------

### Using envExec to import values with environment variables

Source: https://helmfile.readthedocs.io/en/latest/templating

Example of using envExec, which is like exec but accepts a dict of environment variables.

```yaml
mysetting: |
{{ envExec (dict "envkey" "envValue") "./mycmd" (list "arg1" "arg2" "--flag1") | indent 2 }}

```

--------------------------------

### formatlist function

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Does the same as `format` but for a list of strings. The example shows two calls with their resulting lists.

```hcl
formatlist(formatString, values...)
```

```hcl
formatlist("%s", ["Hello", "World"])
###
[
  "Hello",
  "World"
]

formatlist("%s %s", "hello", ["World", "You"])
###
[
  "hello World",
  "hello You",
]
```

--------------------------------

### default.yaml environment values

Source: https://helmfile.readthedocs.io/en/latest/environments

Provides default values for domain and releaseName, used by the helmfile.yaml example.

```yaml
domain: dev.example.com
releaseName: dev

```

--------------------------------

### Full helmfile.yaml reference with repositories and defaults

Source: https://helmfile.readthedocs.io/en/latest/configuration

Comprehensive example of a helmfile.yaml file showing repository configurations (including helm-git, OCI, TLS, and plain HTTP), helmBinary, kustomizeBinary, lockFilePath, and helmDefaults with various flags. Use as a reference for all top-level options.

```yaml
# Chart repositories used from within this state file
#
# Use `helm-s3` and `helm-git` and whatever Helm Downloader plugins
# to use repositories other than the official repository or one backend by chartmuseum.
repositories:
# To use official "stable" charts a.k.a https://github.com/helm/charts/tree/master/stable
- name: stable
  url: https://charts.helm.sh/stable
# To use official "incubator" charts a.k.a https://github.com/helm/charts/tree/master/incubator
- name: incubator
  url: https://charts.helm.sh/incubator
# helm-git powered repository: You can treat any Git repository as a charts repository
- name: polaris
  url: git+https://github.com/reactiveops/polaris@deploy/helm?ref=master
# Advanced configuration: You can setup basic or tls auth and optionally enable helm OCI integration
- name: roboll
  url: roboll.io/charts
  certFile: optional_client_cert
  keyFile: optional_client_key
  # username is retrieved from the environment with the format <registryNameUpperCase>_USERNAME for CI usage, here ROBOLL_USERNAME
  username: optional_username
  # password is retrieved from the environment with the format <registryNameUpperCase>_PASSWORD for CI usage, here ROBOLL_PASSWORD
  password: optional_password
  oci: true
  passCredentials: true
  verify: true
  keyring: path/to/keyring.gpg
# Advanced configuration: You can use a ca bundle to use an https repo
# with a self-signed certificate
- name: insecure
  url: https://charts.my-insecure-domain.com
  caFile: optional_ca_crt
# Advanced configuration: You can skip the verification of TLS for an https repo
- name: skipTLS
  url: https://ss.my-insecure-domain.com
  skipTLSVerify: true
# Advanced configuration: Connect to a repo served over plain http
- name: plainHTTP
  url: http://just.http.domain.com
  plainHttp: true

# context: kube-context # this directive is deprecated, please consider using helmDefaults.kubeContext

# Path to alternative helm binary (--helm-binary)
# Supports both Helm 3.x and Helm 4.x
helmBinary: path/to/helm

# Path to alternative kustomize binary (--kustomize-binary)
kustomizeBinary: path/to/kustomize

# Path to alternative lock file. The default is <state file name>.lock, i.e for helmfile.yaml it's helmfile.lock.
lockFilePath: path/to/lock.file

# Default values to set for args along with dedicated keys that can be set by contributors, cli args take precedence over these.
# In other words, unset values results in no flags passed to helm.
# See the helm usage (helm SUBCOMMAND -h) for more info on default values when those flags aren't provided.
helmDefaults:
  kubeContext: kube-context          #dedicated default key for kube-context (--kube-context)
  cleanupOnFail: false               #dedicated default key for helm flag --cleanup-on-fail
  # additional and global args passed to helm (default "")
  args:
    - "--set k=v"
  diffArgs:
    - "--suppress-secrets"
  syncArgs:
    - "--labels=app.kubernetes.io/managed-by=helmfile"
  # extra args appended to the helm template / helm diff rendering (default "").
  # most commonly "--dry-run=server" to enable the helm lookup() function.
  # overridden by the --template-args CLI flag on a per-invocation basis.
  templateArgs:
    - "--dry-run=server"
  # verify the chart before upgrading (only works with packaged charts not directories) (default false)
  verify: true
  keyring: path/to/keyring.gpg
  #  --skip-schema-validation flag to helm 'install', 'upgrade' and 'lint' (default false)
  skipSchemaValidation: false
```

--------------------------------

### length function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Returns the number of elements in a collection. The example returns the length of a list.

```hcl
length(list)
```

```hcl
length([1,2,3])
# 3
```

--------------------------------

### Initialize, diff, and apply Helmfile

Source: https://helmfile.readthedocs.io/en/latest

Initializes Helmfile, performs a dry-run diff to preview changes, and then applies the configuration to deploy releases to the cluster.

```bash
# Initialize - checks helm and installs required plugins
helmfile init

# See what would be deployed (dry-run)
helmfile diff

# Deploy to your cluster
helmfile apply

```

--------------------------------

### get

Source: https://helmfile.readthedocs.io/en/latest/templating_funcs

Gets a value at a path, with a default value if the path is not found. Fails template rendering if the operation fails.

```APIDOC
## get

### Description
Gets a value at a path. If the path is not found, returns the default value. If the operation fails, template rendering fails.

### Usage
```
{{ $Getvalue :=  $value | get "path.key" "defaultValue" }}
```

### Parameters
- **value** (any) - Required - The value to search.
- **path** (string) - Required - The path to retrieve.
- **defaultValue** (any) - Optional - The default value if path not found.

### Returns
- **any** - The value at the path, or the default value.

### Errors
- Fails if the operation fails.
```

--------------------------------

### Environment Values Loading Example

Source: https://helmfile.readthedocs.io/en/latest/values-and-merging

Lists YAML and gotmpl files loaded for the default environment appear. Inline values like replicas: 3 are supported. The environment is selected via --environment, defaulting to default.

```yaml
environments:
  default:
    values:
      - env/default.yaml
      - env/common.yaml.gotmpl
  production:
    values:
      - env/production.yaml
      - replicas: 3  # Inline values are also supported

```

--------------------------------

### min function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Returns the minimum number from the given numbers. The example shows min of three numbers.

```hcl
min(numbers)
```

```hcl
min(1,128,70)
# 1
```

--------------------------------

### max function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Returns the maximum number from the given numbers. The example shows max of three numbers.

```hcl
max(numbers)
```

```hcl
max(1,128,70)
# 128
```

--------------------------------

### values.yaml for kustomization

Source: https://helmfile.readthedocs.io/en/latest/advanced-features

Example `values.yaml` for a kustomization, showing how to set image, name prefix/suffix, and namespace via comments that map to `kustomize edit` commands.

```yaml
images:
# kustomize edit set image mysql=eu.gcr.io/my-project/mysql@canary
- name: mysql
  newName: eu.gcr.io/my-project/mysql
  newTag: canary
# kustomize edit set image myapp=my-registry/my-app@sha256:24a0c4b4a4c0eb97a1aabb8e29f18e917d05abfe1b7a7c07857230879ce7d3d3
- name: myapp
  digest: sha256:24a0c4b4a4c0eb97a1aabb8e29f18e917d05abfe1b7a7c07857230879ce7d3d3
  newName: my-registry/my-app

# kustomize edit set nameprefix foo-
namePrefix: foo-

# kustomize edit set namesuffix -bar
nameSuffix: -bar

# kustomize edit set namespace myapp
namespace: myapp

```

--------------------------------

### lower function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Converts a given string to lowercase. The example shows the result of lower on a mixed-case string.

```hcl
lower(string)
```

```hcl
lower("HELLO world")
# hello world
```

--------------------------------

### pow function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Returns the logarithm of a given number in a given base. The example shows pow with different exponents.

```hcl
pow(number, power)
```

```hcl
pow(1, 10)
# 1
pow(3, 12)
# 531441
```

--------------------------------

### jsondecode function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Returns a JSON serialization of the given value. The example decodes a JSON string into an HCL map.

```hcl
jsondecode(string)
```

```hcl
jsondecode("{\"hello\": \"world\"}")
# { hello = "world" }
```

--------------------------------

### Enable startup-only pod logs in helmfile.yaml

Source: https://helmfile.readthedocs.io/en/latest/advanced-features

Configure trackLogsUntilReady to show startup logs only. Logs captured before readiness are flushed; readiness and failure tracking continue for every pod.

```yaml
releases:
  - name: myapp
    chart: ./charts/myapp
    trackMode: kubedog
    trackTimeout: 600
    trackLogs: true
    trackLogsUntilReady: true

```

--------------------------------

### parseint function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Parses a string argument and returns an integer of the specified base. The example shows decimal and binary parsing.

```hcl
parseint(string, base)
```

```hcl
parseint("190", 10)
# 190
parseint("11001", 2)
# 25
```

--------------------------------

### Helmfile release configuration full reference

Source: https://helmfile.readthedocs.io/en/latest/configuration

Complete example of a Helmfile release configuration showing all supported keys: version constraints, condition, missingFileHandler, values (files and inline), setString, set, secrets, and Helm flags. Use as a reference for configuring releases in helmfile.yaml.

```yaml
version: ~1.24.1                       # the semver of the chart. range constraint is supported
condition: vault.enabled               # Filters releases by the boolean value at `vault.enabled`. Can also be set directly to true or false.
missingFileHandler: Warn # set to either "Error" or "Warn". "Error" instructs helmfile to fail when unable to find a values or secrets file. When "Warn", it prints the file and continues.
missingFileHandlerConfig:
  # Ignores missing git branch error so that the Debug/Info/Warn handler can treat a missing branch as non-error.
  # See https://github.com/helmfile/helmfile/issues/392
  ignoreMissingGitBranch: true
# Values files used for rendering the chart
values:
  # Value files passed via --values
  - vault.yaml
  # Inline values, passed via a temporary values file and --values, so that it doesn't suffer from type issues like --set
  - address: https://vault.example.com
  # Go template available in inline values and values files.
  - image:
      # The end result is more or less YAML. So do `quote` to prevent number-like strings from accidentally parsed into numbers!
      # See https://github.com/roboll/helmfile/issues/608
      tag: {{ requiredEnv "IMAGE_TAG" | quote }}
      # Otherwise:
      #   tag: "{{ requiredEnv "IMAGE_TAG" }}"
      #   tag: !!string {{ requiredEnv "IMAGE_TAG" }}
    db:
      username: {{ requiredEnv "DB_USERNAME" }}
      # value taken from environment variable. Quotes are necessary. Will throw an error if the environment variable is not set. $DB_PASSWORD needs to be set in the calling environment ex: export DB_PASSWORD='password1'
      password: {{ requiredEnv "DB_PASSWORD" }}
    proxy:
      # Interpolate environment variable with a fixed string
      domain: {{ requiredEnv "PLATFORM_ID" }}.my-domain.com
      scheme: {{ env "SCHEME" | default "https" }}
# Use `values` whenever possible!
# `setString` translates to helm's `--set-string key=val`
setString:
# set a single array value in an array, translates to --set-string bar[0]={1,2}
- name: bar[0]
  values:
  - 1
  - 2
# set a templated value
- name: namespace
  value: {{ .Namespace }}
# `set` translates to helm's `--set key=val`, that is known to suffer from type issues like https://github.com/roboll/helmfile/issues/608
set:
# single value loaded from a local file, translates to --set-file foo.config=path/to/file
- name: foo.config
  file: path/to/file
# set a single array value in an array, translates to --set bar[0]={1,2}
- name: bar[0]
  values:
  - 1
  - 2
# set a templated value
- name: namespace
  value: {{ .Namespace }}
# will attempt to decrypt it using helm-secrets plugin
secrets:
  - vault_secret.yaml
# Override helmDefaults options for verify, wait, waitForJobs, timeout, recreatePods, force and reuseValues.
verify: true
keyring: path/to/keyring.gpg
#  --skip-schema-validation flag to helm 'install', 'upgrade' and 'lint' (default false)
skipSchemaValidation: false
wait: true
# DEPRECATED: waitRetries is no longer supported - see documentation above
# waitRetries: 3
waitForJobs: true
timeout: 60
recreatePods: true
force: false
reuseValues: false
# set `false` to uninstall this release on sync.  (default true)
installed: true
# Defines the strategy to use when updating. Possible value is:
# - "reinstallIfForbidden": Performs an uninstall before the update only if the update is forbidden (e.g., due to permission issues or conflicts).
updateStrategy: ""
# restores previous state in case of failed release (default false).
# On Helm 4+ this emits --rollback-on-failure (the successor to the deprecated --atomic).
atomic: true
# restores previous state on a failed release via the Helm 4 --rollback-on-failure flag
# (default false). Requires Helm 4 or greater. Mutually exclusive with atomic.
rollbackOnFailure: false
# when true, cleans up any new resources created during a failed release (default false)
cleanupOnFail: false
# --kube-context to be passed to helm commands
# See https://github.com/roboll/helmfile/issues/642
# (default "", which means the standard kubeconfig, either ~/kubeconfig or the file pointed by $KUBECONFIG environment variable)
kubeContext: kube-context
# passes --disable-validation to helm diff plugin, this requires diff plugin >= 3.1.2
# It may be helpful to deploy charts with helm api v1 CRDS
# https://github.com/roboll/helmfile/pull/1373
disableValidation: false
# passes --disable-validation to helm diff plugin, this requires diff plugin >= 3.1.2
# It is useful when any release contains custom resources for CRDs that is not yet installed onto the cluster.
```

--------------------------------

### join function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Concatenates the string elements of one or more lists with a given separator. The example joins a list with a space separator.

```hcl
join(listOfStrings, separator)
```

```hcl
join(" ", ["hello", "world"])
# hello world
```

--------------------------------

### Integrate kustomize with helmfile using helmify hooks

Source: https://helmfile.readthedocs.io/en/latest/hooks

Shows a kustomize project structure and a helmfile release that uses the helmify command in prepare and cleanup hooks to build or clean a local chart from a kustomize overlay.

```text
foo-kustomize/
├── base
│   ├── configMap.yaml
│   ├── deployment.yaml
│   ├── kustomization.yaml
│   └── service.yaml
└── overlays
    ├── default
    │   ├── kustomization.yaml
    │   └── map.yaml
    ├── production
    │   ├── deployment.yaml
    │   └── kustomization.yaml
    └── staging
        ├── kustomization.yaml
        └── map.yaml

5 directories, 10 files

```

```yaml
- name: kustomize
  chart: ./foo
  hooks:
  - events: ["prepare", "cleanup"]
    command: "../helmify"
    args: ["{{`{{if eq .Event.Name \"prepare\"}}build{{else}}clean{{end}}`}}", "{{`{{.Release.Ch\
art}}`}}", "{{`{{.Environment.Name}}`}}"]

```

--------------------------------

### get function usage

Source: https://helmfile.readthedocs.io/en/latest/templating_funcs

Gets a value at a path, with a default value if the path is not found. On failure, rendering fails with an error message.

```Go template
{{ $Getvalue :=  $value | get "path.key" "defaultValue" }}
```

--------------------------------

### log function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Returns the logarithm of a given number in a given base. The example shows log(1, 10) returns 0.

```hcl
log(number, base)
```

```hcl
log(1, 10)
# 0
```

--------------------------------

### include usage example

Source: https://helmfile.readthedocs.io/en/latest/templating_funcs

Use include to render a nested template. It loads functions from _*.tpl files in the directory where the helmfile.yaml is located, or for nested helmfile.yaml files, from the directory of each nested file.

```plaintext
{{ include "my-template" . }}

```

--------------------------------

### jsonencode function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Parses a JSON string and returns the value it represents if valid. The example shows encoding a map to a JSON string.

```hcl
jsonencode(string)
```

```hcl
jsonencode({"hello"="world"})
# {"hello": "world"}
```

--------------------------------

### product2/helmfile.yaml with observability releases

Source: https://helmfile.readthedocs.io/en/latest/shared-configuration-across-teams

Per-service helmfile for Product 2, including its own releases and the observability stack. This duplicates the observability releases, which is later refactored to use a shared sub-helmfile.

```yaml
releases:
- name: product2-api
  chart: product2-charts/api
  # snip
- name: product2-web
  chart: product2-charts/web
  # snip
- name: observability-prometheus-operator
  chart: stable/prometheus-operator
  # snip
- name: observability-process-exporter
  chart: stable/prometheus-operator
  # snip

```

--------------------------------

### int function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Removes the fractional component of a number, rounding towards zero. The example shows that int(6.2) returns 6.

```hcl
int(number)
```

```hcl
int(6.2)
# 6
```

--------------------------------

### Apply commonLabels with reusable release templates (templates/common.yaml + helmfile.yaml)

Source: https://helmfile.readthedocs.io/en/latest

Two YAML files that work together: templates/common.yaml defines reusable release templates (nginx and cert-manager) that reference a common values file and a customer-specific values file via .Release.Labels.customer; helmfile.yaml reads that template file, sets commonLabels.customer to 'company', and instantiates the two releases with YAML anchors. Use this pattern to apply the same label to all releases and vary values per customer.

```yaml
templates:
  nginx: &nginx
    name: nginx
    chart: stable/nginx-ingress
    values:
    - ../values/common/{{ .Release.Name }}.yaml
    - ../values/{{ .Release.Labels.customer }}/{{ .Release.Name }}.yaml

  cert-manager: &cert-manager
    name: cert-manager
    chart: jetstack/cert-manager
    values:
    - ../values/common/{{ .Release.Name }}.yaml
    - ../values/{{ .Release.Labels.customer }}/{{ .Release.Name }}.yaml

```

```yaml
{{ readFile "templates/common.yaml" }}

commonLabels:
  customer: company

releases:
- <<: *nginx
- <<: *cert-manager

```

--------------------------------

### Scaffold a new Helmfile project

Source: https://helmfile.readthedocs.io/en/latest

Scaffolds a new Helmfile project with a best-practice directory structure using `helmfile create`, then changes into the new project directory.

```bash
# Scaffold a new project
helmfile create my-project
cd my-project

```

--------------------------------

### regexall function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Finds all non-overlapping matches in a string and returns a list of them. The result type is always a list. The example extracts all numbers from a version string.

```hcl
regexall(pattern, string)
```

```hcl
regexall("[0-9]+", "v1.2.3")
# [1 2 3]
```

--------------------------------

### Use kubedog tracking flags with helmfile apply

Source: https://helmfile.readthedocs.io/en/latest/advanced-features

Use command-line flags to enable kubedog tracking. The --track-logs-interval minimum is 1s.

```bash
helmfile apply --track-mode kubedog --track-timeout 300 --track-logs --track-logs-interval 1s

```

--------------------------------

### Provide default value with get function

Source: https://helmfile.readthedocs.io/en/latest/writing-helmfile

Uses get with a default value of 1. When eventApi.replicas is missing, the template outputs 1 instead of failing or printing <no value>.

```plaintext
{{ .Values | get "eventApi.replicas" 1 }}

```

--------------------------------

### helmfile.yaml with environment values

Source: https://helmfile.readthedocs.io/en/latest/environments

Defines a production environment with a values file and a release that uses a Go template values file. Running 'helmfile sync' uses the default value 'dev.example.com', while 'helmfile --environment production sync' uses 'prod.example.com'.

```yaml
environments:
  production:
    values:
    - production.yaml

---

releases:
- name: myapp
  values:
  - values.yaml.gotmpl

```

--------------------------------

### Allow missing key with get function

Source: https://helmfile.readthedocs.io/en/latest/writing-helmfile

Uses the get template function to allow missing keys. When the key is absent, it prints <no value>, which may or may not cause a failure.

```plaintext
{{ .Values | get "eventApi.replicas" nil }}

```

--------------------------------

### product1/helmfile.yaml with observability releases

Source: https://helmfile.readthedocs.io/en/latest/shared-configuration-across-teams

Per-service helmfile for Product 1, including its own releases and the observability stack. This duplicates the observability releases, which is later refactored to use a shared sub-helmfile.

```yaml
releases:
- name: product1-api
  chart: product1-charts/api
  # snip
- name: product1-web
  chart: product1-charts/web
  # snip
- name: observability-prometheus-operator
  chart: stable/prometheus-operator
  # snip
- name: observability-process-exporter
  chart: stable/prometheus-operator
  # snip

```

--------------------------------

### indent function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Adds a given number of spaces to the beginnings of all but the first line in a multi-line string. The example shows the result of indenting a multi-line string by 4 spaces.

```hcl
indent(number, string)
```

```hcl
indent(4, "hello,\nWorld\n!")
###
hello
    World
    !
```

--------------------------------

### lookup function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Performs a dynamic lookup into a map. Requires inputMap, key, and a defaultValue to return if the key is not found. The example shows a lookup with a found key and a missing key.

```hcl
lookup(inputMap, key, defaultValue)
```

```hcl
map = { "luke" = "skywalker"}
lookup(hv.maptest, "luke", "none")
# skywalker
lookup(hv.maptest, "leia", "none")
# none
```

--------------------------------

### helmfile CLI help output

Source: https://helmfile.readthedocs.io/en/latest/cli

The helmfile CLI help output listing all available commands and global flags. Use it to see the full set of subcommands (apply, build, diff, template, etc.) and options such as --environment, --file, and --interactive. Note that several commands are deprecated (charts, delete) and that flags can override corresponding HELMFILE_* environment variables.

```text
Declaratively deploy your Kubernetes manifests, Kustomize configs, and Charts as Helm releases in one shot
V1 mode = false
YAML library = go.yaml.in/yaml/v3

Usage:
  helmfile [command]

Available Commands:
  apply        Apply all resources from state file only when there are changes
  build        Build all resources from state file
  create       Create a helmfile deployment project scaffold
  cache        Cache management
  charts       DEPRECATED: sync releases from state file (helm upgrade --install)
  completion   Generate the autocompletion script for the specified shell
  delete       DEPRECATED: delete releases from state file (helm delete)
  deps         Update charts based on their requirements
  destroy      Destroys and then purges releases
  diff         Diff releases defined in state file
  fetch        Fetch charts from state file
  help         Help about any command
  init         Initialize the helmfile, includes version checking and installation of helm and plug-ins
  lint         Lint charts from state file (helm lint)
  list         List releases defined in state file
  repos        Add chart repositories defined in state file
  show-dag     It prints a table with 3 columns, GROUP, RELEASE, and DEPENDENCIES. GROUP is the unsigned, monotonically increasing integer starting from 1. All the releases with the same GROUP are deployed concurrently. Everything in GROUP 2 starts being deployed only after everything in GROUP 1 got successfully deployed. RELEASE is the release that belongs to the GROUP. DEPENDENCIES is the list of releases that the RELEASE depends on. It should always be empty for releases in GROUP 1. DEPENDENCIES for a release in GROUP 2 should have some or all dependencies appeared in GROUP 1. It can be "some" because Helmfile simplifies the DAGs of releases into a DAG of groups, so that Helmfile always produce a single DAG for everything written in helmfile.yaml, even when there are technically two or more independent DAGs of releases in it.
  status       Retrieve status of releases in state file
  sync         Sync releases defined in state file
  template     Template releases defined in state file
  test         Test charts from state file (helm test)
  unittest     Unit test charts from state file using helm-unittest plugin
  version      Print the CLI version
  write-values Write values files for releases. Similar to `helmfile template`, write values files instead of manifests.

Flags:
      --allow-no-matching-release             Do not exit with an error code if the provided selector has no matching releases.
  -c, --chart string                          Set chart. Uses the chart set in release by default, and is available in template as {{ .Chart }}
      --color                                 Output with color
      --debug                                 Enable verbose output for Helm and set log-level to debug, this disables --quiet/-q effect. Overrides "HELMFILE_DEBUG" OS environment variable when specified
      --disable-force-update                  do not force helm repos to update when executing "helm repo add"
      --enable-live-output                    Show live output from the Helm binary Stdout/Stderr into Helmfile own Stdout/Stderr.
                                              It only applies for the Helm CLI commands, Stdout/Stderr for Hooks are still displayed only when it's execution finishes.
  -e, --environment string                    specify the environment name. Overrides "HELMFILE_ENVIRONMENT" OS environment variable when specified. defaults to "default"
  -f, --file helmfile.yaml                    load config from file or directory. defaults to "helmfile.yaml" or "helmfile.yaml.gotmpl" or "helmfile.d" (means "helmfile.d/*.yaml" or "helmfile.d/*.yaml.gotmpl") in this preference. Specify - to load the config from the standard input.
  -b, --helm-binary string                    Path to the helm binary. Overrides "HELMFILE_HELM_BINARY" OS environment variable when specified (default "helm")
  -h, --help                                  help for helmfile
  -i, --interactive                           Request confirmation before attempting to modify clusters
      --kube-context string                   Set kubectl context. Overrides "HELMFILE_KUBE_CONTEXT" OS environment variable when specified. Uses current kubectl context by default
  -k, --kustomize-binary string               Path to the kustomize binary. Overrides "HELMFILE_KUSTOMIZE_BINARY" OS environment variable when specified (default "kustomize")
      --log-level string                      Set log level. Overrides "HELMFILE_LOG_LEVEL" OS environment variable when specified (default "info")
```

--------------------------------

### Enable per-release metrics with HELMFILE_OTEL_METRICS_PER_RELEASE

Source: https://helmfile.readthedocs.io/en/latest/otel

Set HELMFILE_OTEL_METRICS_PER_RELEASE=true to add helmfile.release and helmfile.namespace attributes to helmfile.release.duration. This increases metric cardinality with fleet size; use for bounded CI runs or ensure backend capacity for long-lived collection.

```bash
HELMFILE_OTEL_METRICS_PER_RELEASE=true helmfile --otel-tracing sync

```

--------------------------------

### merge function signature and example

Source: https://helmfile.readthedocs.io/en/latest/hcl_funcs

Takes an arbitrary number of maps and returns a single map with merged elements. The example shows merging three maps, with later values overriding earlier ones.

```hcl
merge(maps)
```

```hcl
merge({a="1"}, {a=[1,2], c="world"}, {d=40})
# { a = [1,2], c = "world", d = 40}
```

--------------------------------

### Local Execution Direct: cd examples/deployments/local/ && helmfile sync

Source: https://helmfile.readthedocs.io/en/latest/paths

Run a Helmfile manifest from its own directory. The relative path is resolved from the manifest's directory.

```bash
cd examples/deployments/local/
helmfile sync

```

--------------------------------

### Environment values precedence example

Source: https://helmfile.readthedocs.io/en/latest/environments

Shows the precedence order of environment values: yaml/yaml.gotmpl, then hcl, then yaml secrets. The example demonstrates that values from higher-precedence files override those from lower-precedence files, and secrets override HCL.

```yaml
# values1.yaml
domain: "dev.example.com"
```

```hcl
# values2.hcl
values {
  domain = "overdev.example.com"
  env = "dev"
  willBeOverridden = "override_me"
}
```

```hcl
# values3.hcl
values {
  env = "local"
}
```

```yaml
# secrets.yml (assuming this one has been encrypted)
willBeOverridden: overridden
```

```yaml
# helmfile.yaml.gotmpl
environments:
  default:
    values:
    - values1.yaml
    - values2.hcl
    - values3.hcl
    secrets:
    - secrets.yml
---
releases:
- name: random-release
  [...]
  values:
    domain: "{{ .Values.domain }}" # == "overdev.example.com"
    env: "{{ .Values.env }}" # == "local"
    willBeOverridden: "{{ .Values.willBeOverridden }}" # == "overridden"
```

--------------------------------

### Helmfile configuration with unitTests

Source: https://helmfile.readthedocs.io/en/latest/cli

Example helmfile configuration that defines a release with `unitTests` paths relative to the chart directory. Paths without glob characters are treated as directories and `/*_test.yaml` is appended automatically.

```yaml
releases:
  - name: my-app
    chart: ./charts/my-app
    values:
      - values.yaml
    unitTests:
      - tests

```

--------------------------------

### Use sub-helmfile as a template with PRODUCT_ID

Source: https://helmfile.readthedocs.io/en/latest/shared-configuration-across-teams

Generalizes product releases into a shared sub-helmfile that uses the PRODUCT_ID environment variable to generate per-product release names. The product helmfile includes the shared template and the observability helmfile, and you must set PRODUCT_ID before running helmfile so it produces differently named releases per product.

```yaml
releases:
- name: product{{ env "PRODUCT_ID" }}-api
  chart: product{{ env "PRODUCT_ID" }}-charts/api
  # snip
- name: product{{ env "PRODUCT_ID" }}-web
  chart: product{{ env "PRODUCT_ID" }}-charts/web
  # snip

```

```yaml
helmfiles:
- ../observability/helmfile.yaml
- ../shared/helmfile.yaml

```

```bash
$ PRODUCT_ID=1 helmfile -f product/helmfile.yaml apply
$ PRODUCT_ID=2 helmfile -f product/helmfile.yaml apply

```
Tokens:
Raw