helmfile

Helmfile is a declarative spec for deploying helm charts

Type object
File match helmfile.yaml **/helmfile.d/**/*.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/helmfile/latest.json
Source https://www.schemastore.org/helmfile.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

apiVersions string[]

Configure a fixed list of API versions to pass to 'helm template' via the --api-versions flag.

bases string[]
environments object

The list of environments managed by helmfile.

Default:
{
  "default": {}
}
Examples: {"default":{"values":[]}}
commonLabels object
helmBinary string

Path to alternative helm binary (--helm-binary)

Examples: "path/to/helm3"
helmDefaults object

Default values to set for args along with dedicated keys that can be set by contributors, cli args take precedence over these.

17 nested properties
kubeContext string

Dedicated default key for kube-context (--kube-context).

cleanupOnFail boolean

When true, cleans up any new resources created during a failed release.

Default: false
args string[]
verify boolean

Verify the chart before upgrading (only works with packaged charts not directories).

Default: false
wait boolean

Wait for k8s resources via --wait.

Default: false
waitForJobs boolean

If true and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout

Default: false
timeout number

Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness)

Default: 300
recreatePods boolean

Performs pods restart for the resource if applicable.

Default: false
force boolean

Forces resource update through delete/recreate if needed.

Default: false
historyMax number

Limit the maximum number of revisions saved per release. Use 0 for no limit.

Default: 10
createNamespace boolean

When using helm 3.2+, automatically create release namespaces if they do not exist.

Default: true
devel boolean

If used with charts museum allows to pull unstable charts for deployment, for example: if 1.2.3 and 1.2.4-dev versions exist and set to true, 1.2.4-dev will be pulled (default false)

Default: false
reuseValues boolean

If set to true, reuses the last release's values and merges them with ones provided in helmfile.

Default: false
skipDeps boolean

When set to true, skips running helm dep up and helm dep build on this release's chart.

Default: false
cascade string

Cascade --cascade to helmv3 delete, available values: background, foreground, or orphan.

Default: "background"
Values: "background" "foreground" "orphan"
postRenderer string

Propagate --post-renderer to helmv3 template and helm install.

Examples: "path/to/postRenderer"
insecureSkipTLSVerify boolean

Is true if the TLS verification should be skipped when fetching remote chart.

Default: false
helmfiles helmfile[]
hooks hook[]
missingFileHandler string
Values: "Error" "Warn" "Info" "Debug"
releases release[]

Helmfile runs various helm commands to converge the current state in the live cluster to the desired state defined here.

repositories repository[]

Definitions

repository object
name string required
url string
certFile string
keyFile string
caFile string
username string
password string
oci boolean
passCredentials boolean
helmDefaults object

Default values to set for args along with dedicated keys that can be set by contributors, cli args take precedence over these.

kubeContext string

Dedicated default key for kube-context (--kube-context).

cleanupOnFail boolean

When true, cleans up any new resources created during a failed release.

Default: false
args string[]
verify boolean

Verify the chart before upgrading (only works with packaged charts not directories).

Default: false
wait boolean

Wait for k8s resources via --wait.

Default: false
waitForJobs boolean

If true and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout

Default: false
timeout number

Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness)

Default: 300
recreatePods boolean

Performs pods restart for the resource if applicable.

Default: false
force boolean

Forces resource update through delete/recreate if needed.

Default: false
historyMax number

Limit the maximum number of revisions saved per release. Use 0 for no limit.

Default: 10
createNamespace boolean

When using helm 3.2+, automatically create release namespaces if they do not exist.

Default: true
devel boolean

If used with charts museum allows to pull unstable charts for deployment, for example: if 1.2.3 and 1.2.4-dev versions exist and set to true, 1.2.4-dev will be pulled (default false)

Default: false
reuseValues boolean

If set to true, reuses the last release's values and merges them with ones provided in helmfile.

Default: false
skipDeps boolean

When set to true, skips running helm dep up and helm dep build on this release's chart.

Default: false
cascade string

Cascade --cascade to helmv3 delete, available values: background, foreground, or orphan.

Default: "background"
Values: "background" "foreground" "orphan"
postRenderer string

Propagate --post-renderer to helmv3 template and helm install.

Examples: "path/to/postRenderer"
insecureSkipTLSVerify boolean

Is true if the TLS verification should be skipped when fetching remote chart.

Default: false
release object
name string required

The name of the release.

namespace string

The namespace to install the release into.

chart string

The chart name to be installed. The chart name can be either: 1) a chart reference: https://helm.sh/docs/topics/charts/#chart-references, 2) a path to a directory containing a chart, 3) a path to a packaged chart, or 4) a URL.

atomic boolean

Restores previous state in case of failed release.

Default: false
cleanupOnFail boolean

When true, cleans up any new resources created during a failed release.

Default: false
kubeContext string

--kube-context to be passed to helm commands. Defaults tp an empty string, which means the standard kubeconfig, either ~/kubeconfig or the file pointed by $KUBECONFIG environment variable)

Default: ""
condition string

Wen set, helmfile will only attempt to install the release if the condition is true

createNamespace boolean

When using helm 3.2+, automatically create release namespaces if they do not exist.

Default: true
devel boolean

If used with charts museum allows to pull unstable charts for deployment, for example: if 1.2.3 and 1.2.4-dev versions exist and set to true, 1.2.4-dev will be pulled.

Default: false
disableValidation boolean

Disables validation of the rendered templates before releasing.

Default: false
disableValidationOnInstall boolean

Passes --disable-validation to helm 3 diff plugin, this requires diff plugin >= 3.1.2

Default: false
disableOpenAPIValidation boolean

Passes --disable-openapi-validation to helm 3 diff plugin, this requires diff plugin >= 3.1.2

Default: false
historyMax number

Limit the maximum number of revisions saved per release. Use 0 for no limit.

Default: 10
skipDeps boolean

When set to true, skips running helm dep up and helm dep build on this release's chart.

Default: false
cascade string

Cascade --cascade to helmv3 delete, available values: background, foreground, or orphan

Default: "background"
Values: "background" "foreground" "orphan"
postRenderer string

Propagate --post-renderer to helmv3 template and helm install.

Examples: "path/to/postRenderer"
insecureSkipTLSVerify boolean

Is true if the TLS verification should be skipped when fetching remote chart

Default: false
hooks hook[]

Hooks allow to trigger actions at certain points in helm's lifecycle.

installed boolean | string | object

Set false to uninstall this release on sync.

Default: true
labels object
missingFileHandler string
Values: "Error" "Warn" "Info" "Debug"
secrets string[]

Will attempt to decrypt it using helm-secrets plugin

inherit object[]

Inherit from one or more release templates

set object | object | object[]
timeout number

Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness)

Default: 300
recreatePods boolean

Performs pods restart for the resource if applicable

Default: false
force boolean

Forces resource update through delete/recreate if needed.

Default: false
values string | map[]
verify boolean
version string | number | integer
wait boolean

Wait for k8s resources via --wait.

Default: false
waitForJobs boolean

If set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout.

Default: false
needs string[]

Define dependencies between releases. This release will only be installed after all releases in the needs list are installed.

dependencies object[]

Add chart dependencies without forking. Can be local paths or OCI charts.

strategicMergePatches string[]

Apply strategic merge patches to Kubernetes resources using Kustomize.

transformers string[]

Apply Kustomize transformers to add labels, annotations, etc.

jsonPatches object[]

Apply JSON patches to Kubernetes resources.

adopt string[]

Adopt existing resources into Helm management.

helmfile string | object
missingFileHandler string
environment object
values string | map[]
secrets string[]
missingFileHandler string
Values: "Error" "Warn" "Info" "Debug"
kubeContext string
hook object
events string[]
showlogs boolean
command string
args string | string[]
map object