Bazel rules for Helm.

Rules

chart_file
helm_import
helm_install
helm_lint_test
helm_oci_digest
helm_package
helm_plugin
helm_push
helm_push_images
helm_push_registry
helm_template
helm_template_test
helm_toolchain
helm_uninstall
helm_upgrade

chart_file

load("@rules_helm//helm:defs.bzl", "chart_file")

chart_file(name, api_version, app_version, app_version_file, chart_name, description, icon, type,
           version, version_file)

Create a Helm chart file.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
api_version	The Helm API version	String	optional	`"v2"`
app_version	The version number of the application being deployed.	String	optional	`"1.16.0"`
app_version_file	A file containing the version number of the application being deployed.	Label	optional	`None`
chart_name	The name of the chart	String	optional	`""`
description	A descritpion of the chart.	String	optional	`"A Helm chart for Kubernetes by Bazel."`
icon	A URL to an SVG or PNG image to be used as an icon.	String	optional	`""`
type	The chart type.	String	optional	`"application"`
version	The chart version.	String	optional	`"0.1.0"`
version_file	A file containing the chart version.	Label	optional	`None`

helm_import

load("@rules_helm//helm:defs.bzl", "helm_import")

helm_import(name, chart, version)

A rule that allows pre-packaged Helm charts to be used within Bazel.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
chart	A Helm chart's `.tgz` file.	Label	optional	`None`
version	The version fo the helm chart	String	optional	`""`

helm_install

load("@rules_helm//helm:defs.bzl", "helm_install")

helm_install(name, data, helm_opts, install_name, opts, package, values)

Produce an executable for performing a helm install operation.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
data	Additional data to pass to `helm install`.	List of labels	optional	`[]`
helm_opts	Additional arguments to pass to `helm` during install.	List of strings	optional	`[]`
install_name	The name to use for the `helm install` command. The target name will be used if unset.	String	optional	`""`
opts	Additional arguments to pass to `helm install`.	List of strings	optional	`[]`
package	The helm package to install.	Label	required
values	Values files to pass to `helm install --values`.	List of labels	optional	`[]`

helm_lint_test

load("@rules_helm//helm:defs.bzl", "helm_lint_test")

helm_lint_test(name, chart, opts, substitutions, values)

A rule for performing helm lint on a helm package

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
chart	The helm package to run linting on.	Label	required
opts	Additional arguments to pass to `helm lint`.	List of strings	optional	`[]`
substitutions	A dictionary of substitutions passed to `helm lint --set flag.	Dictionary: String -> String	optional	`{}`
values	A list of files passed to `helm lint --values flag.	List of labels	optional	`[]`

helm_oci_digest

load("@rules_helm//helm:defs.bzl", "helm_oci_digest")

helm_oci_digest(name, chart)

Compute the OCI manifest digest for a Helm chart at build time.

This rule constructs the OCI manifest that helm push (Helm v4) would create and computes its sha256 digest. The .tgz file's mtime is used for the creation annotation, formatted in UTC to match the push side.

The digest file contains a single line: sha256:<hex>.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
chart	A helm_chart target providing HelmPackageInfo.	Label	required

helm_package

load("@rules_helm//helm:defs.bzl", "helm_package")

helm_package(name, deps, chart, chart_json, crds, files, images, opts, schema, stamp, substitutions,
             templates, values, values_json)

Rules for creating Helm chart packages.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Other helm packages this package depends on.	List of labels	optional	`[]`
chart	The `Chart.yaml` file of the helm chart	Label	optional	`None`
chart_json	The `Chart.yaml` file of the helm chart as a json object	String	optional	`""`
crds	All Custom Resource Definitions associated with the current helm chart. E.g., the `./crds` directory	List of labels	optional	`[]`
files	Files accessed in templates via the `.Files` api	List of labels	optional	`[]`
images	A list of oci_push or image_push targets.	List of labels	optional	`[]`
opts	Additional arguments to pass to `helm package` commands.	List of strings	optional	`[]`
schema	The `values.schema.json` file for the current package.	Label	optional	`None`
stamp	Whether to encode build information into the helm actions. Possible values: - `stamp = 1`: Always stamp the build information into the helm actions, even in --nostamp builds. This setting should be avoided, since it potentially kills remote caching for the target and any downstream actions that depend on it. - `stamp = 0`: Always replace build information by constant values. This gives good build result caching. - `stamp = -1`: Embedding of build information is controlled by the --[no]stamp flag. Stamped targets are not rebuilt unless their dependencies change.	Integer	optional	`-1`
substitutions	A dictionary of substitutions to apply to the `values.yaml` file.	Dictionary: String -> String	optional	`{}`
templates	All templates associated with the current helm chart. E.g., the `./templates` directory	List of labels	optional	`[]`
values	The `values.yaml` file for the current package.	Label	optional	`None`
values_json	The `values.yaml` file for the current package as a json object.	String	optional	`""`

helm_plugin

load("@rules_helm//helm:defs.bzl", "helm_plugin")

helm_plugin(name, data, plugin_name, yaml)

Define a helm plugin.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
data	Additional files associated with the plugin.	List of labels	optional	`[]`
plugin_name	An explicit name for the plugin. If unset, `name` will be used.	String	optional	`""`
yaml	The yaml file representing the plugin	Label	required

helm_push

load("@rules_helm//helm:defs.bzl", "helm_push")

helm_push(name, env, include_images, login_url, opts, package, push_cmd, registry_url)

Produce an executable for performing a helm push to a registry.

Before performing helm push the executable produced will conditionally perform helm registry login if the following environment variables are defined:

HELM_REGISTRY_USERNAME: The value of --username.
HELM_REGISTRY_PASSWORD/HELM_REGISTRY_PASSWORD_FILE: The value of --password or a file containing the --password value.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
env	Environment variables to set when running this target.	Dictionary: String -> String	optional	`{}`
include_images	If True, images depended on by `package` will be pushed as well.	Boolean	optional	`False`
login_url	The URL of the registry to use for `helm login`. E.g. `my.registry.io`	String	optional	`""`
opts	Additional arguments to pass to `helm` commands.	List of strings	optional	`[]`
package	The helm package to push to the registry.	Label	required
push_cmd	An alternative command to `push` for publishing the helm chart. E.g. `cm-push`	String	optional	`""`
registry_url	The registry URL at which to push the helm chart to. E.g. `oci://my.registry.io/chart-name`	String	required

helm_push_images

load("@rules_helm//helm:defs.bzl", "helm_push_images")

helm_push_images(name, env, package)

Produce an executable for pushing all oci images used by a helm chart.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
env	Environment variables to set when running this target.	Dictionary: String -> String	optional	`{}`
package	The helm package to upload images from.	Label	required

helm_push_registry

load("@rules_helm//helm:defs.bzl", "helm_push_registry")

helm_push_registry(name, env, include_images, login_url, opts, package, push_cmd, registry_url)

Produce an executable for performing a helm push to a registry.

Before performing helm push the executable produced will conditionally perform helm registry login if the following environment variables are defined:

HELM_REGISTRY_USERNAME: The value of --username.
HELM_REGISTRY_PASSWORD/HELM_REGISTRY_PASSWORD_FILE: The value of --password or a file containing the --password value.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
env	Environment variables to set when running this target.	Dictionary: String -> String	optional	`{}`
include_images	If True, images depended on by `package` will be pushed as well.	Boolean	optional	`False`
login_url	The URL of the registry to use for `helm login`. E.g. `my.registry.io`	String	optional	`""`
opts	Additional arguments to pass to `helm` commands.	List of strings	optional	`[]`
package	The helm package to push to the registry.	Label	required
push_cmd	An alternative command to `push` for publishing the helm chart. E.g. `cm-push`	String	optional	`""`
registry_url	The registry URL at which to push the helm chart to. E.g. `oci://my.registry.io/chart-name`	String	required

helm_template

load("@rules_helm//helm:defs.bzl", "helm_template")

helm_template(name, out, chart, opts, values)

A rule for rendering helm chart templates to a file.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
out	The output file to write the output from `helm template`.	Label; nonconfigurable	optional	`None`
chart	The helm package to resolve charts for.	Label	required
opts	Additional arguments to pass to `helm template`.	List of strings	optional	`[]`
values	Values files to pass to `helm template --values`.	List of labels	optional	`[]`

helm_template_test

load("@rules_helm//helm:defs.bzl", "helm_template_test")

helm_template_test(name, chart, installer, opts, template_patterns, values)

A test rule for rendering helm chart templates.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
chart	The helm package to resolve templates for. Mutually exclusive with `installer`.	Label	required
installer	The `helm_install`/`helm_upgrade` target to resolve templates for. Mutually exclusive with `chart`.	Label	optional	`None`
opts	Additional arguments to pass to `helm template`.	List of strings	optional	`[]`
template_patterns	A mapping of template paths to regex patterns required to match.	Dictionary: String -> List of strings	optional	`{}`
values	Values files to pass to `helm template --values`.	List of labels	optional	`[]`

helm_toolchain

load("@rules_helm//helm:defs.bzl", "helm_toolchain")

helm_toolchain(name, helm, plugins)

A helm toolchain.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
helm	A helm binary	Label	required
plugins	Additional plugins to make available to helm.	List of labels	optional	`[]`

helm_uninstall

load("@rules_helm//helm:defs.bzl", "helm_uninstall")

helm_uninstall(name, data, helm_opts, install_name, opts)

Produce an executable for performing a helm uninstall operation.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
data	Additional data to pass to `helm uninstall`.	List of labels	optional	`[]`
helm_opts	Additional arguments to pass to `helm` during install.	List of strings	optional	`[]`
install_name	The name to use for the `helm install` command. The target name will be used if unset.	String	optional	`""`
opts	Additional arguments to pass to `helm uninstall`.	List of strings	optional	`[]`

helm_upgrade

load("@rules_helm//helm:defs.bzl", "helm_upgrade")

helm_upgrade(name, data, helm_opts, install_name, opts, package, values)

Produce an executable for performing a helm upgrade operation.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
data	Additional data to pass to `helm upgrade`.	List of labels	optional	`[]`
helm_opts	Additional arguments to pass to `helm` during upgrade.	List of strings	optional	`[]`
install_name	The name to use for the `helm upgrade` command. The target name will be used if unset.	String	optional	`""`
opts	Additional arguments to pass to `helm upgrade`.	List of strings	optional	`[]`
package	The helm package to upgrade.	Label	required
values	Values files to pass to `helm upgrade --values`.	List of labels	optional	`[]`

HelmOCIDigestInfo

load("@rules_helm//helm:defs.bzl", "HelmOCIDigestInfo")

HelmOCIDigestInfo(digest)

OCI manifest digest for a Helm chart, computed at build time.

FIELDS

Name	Description
digest	File: Text file containing the OCI manifest digest (sha256:...)

HelmPackageInfo

load("@rules_helm//helm:defs.bzl", "HelmPackageInfo")

HelmPackageInfo(chart, images, metadata)

A provider for helm packages

FIELDS

Name	Description
chart	File: The result of `helm package`
images	list[Target]: A list of @rules_oci//oci:defs.bzl%oci_push or @rules_img//img:push.bzl%image_push targets
metadata	File: A json encoded file containing metadata about the helm chart

chart_content

load("@rules_helm//helm:defs.bzl", "chart_content")

chart_content(name, api_version, description, type, version, app_version, icon)

A convenience wrapper for defining Chart.yaml files with helm_package.chart_json.

PARAMETERS

Name	Description	Default Value
name	The name of the chart	none
api_version	The Helm API version	`"v2"`
description	A descritpion of the chart.	`"A Helm chart for Kubernetes by Bazel."`
type	The chart type.	`"application"`
version	The chart version.	`"0.1.0"`
app_version	The version number of the application being deployed.	`"1.16.0"`
icon	A URL to an SVG or PNG image to be used as an icon.	`None`

RETURNS

str: A json encoded string which represents Chart.yaml contents.

helm_chart

load("@rules_helm//helm:defs.bzl", "helm_chart")

helm_chart(*, name, chart, chart_json, crds, values, values_json, substitutions, templates, schema,
           files, images, deps, install_name, registry_url, login_url, push_cmd, helm_opts,
           install_opts, package_opts, push_opts, upgrade_opts, uninstall_opts, data, stamp, **kwargs)

Rules for producing a helm package and some convenience targets.

target	rule	condition
`{name}`	helm_package	`None`
`{name}.push_images`	helm_push_images	`None`
`{name}.oci_digest`	helm_oci_digest	`None`
`{name}.push_registry`	helm_push (`include_images = False`)	`registry_url` is defined.
`{name}.push`	helm_push (`include_images = True`)	`registry_url` is defined.
`{name}.install`	helm_install	`None`
`{name}.uninstall`	helm_uninstall	`None`
`{name}.upgrade`	helm_upgrade	`None`

PARAMETERS

Name	Description	Default Value
name	The name of the helm_package target.	none
chart	The path to the chart directory. Defaults to `Chart.yaml`.	`None`
chart_json	The json encoded contents of `Chart.yaml`.	`None`
crds	A list of crd files to include in the package.	`None`
values	The path to the values file. Defaults to `values.yaml`.	`None`
values_json	The json encoded contents of `values.yaml`.	`None`
substitutions	A dictionary of substitutions to apply to `values.yaml`.	`{}`
templates	A list of template files to include in the package.	`None`
schema	A JSON Schema file for values. Defaults to `values.schema.json`.	`None`
files	Files accessed in templates via the `.Files` api.	`[]`
images	A list of oci_push or image_push targets	`[]`
deps	A list of helm package dependencies.	`None`
install_name	The `helm install` name to use. `name` will be used if unset.	`None`
registry_url	The registry url for the helm chart. `{name}.push_registry` is only defined when a value is passed here.	`None`
login_url	The registry url to log into for publishing helm charts.	`None`
push_cmd	An alternative command to `push` for publishing helm charts.	`None`
helm_opts	Additional options to pass to helm.	`[]`
install_opts	Additional options to pass to `helm install`.	`[]`
package_opts	Additional options to pass to `helm package`.	`[]`
push_opts	Additional options to pass to `helm push`.	`[]`
upgrade_opts	Additional options to pass to `helm upgrade`.	`[]`
uninstall_opts	Additional options to pass to `helm uninstall`.	`[]`
data	Additional runtime data to pass to the helm install, upgrade, and uninstall targets.	`[]`
stamp	Whether to encode build information into the helm chart.	`None`
kwargs	Additional keyword arguments for `helm_package`.	none

helm_lint_aspect

load("@rules_helm//helm:defs.bzl", "helm_lint_aspect")

helm_lint_aspect()

An aspect for running helm lint on helm package targets

ASPECT ATTRIBUTES

ATTRIBUTES

helm_import_repository

load("@rules_helm//helm:defs.bzl", "helm_import_repository")

helm_import_repository(name, chart_name, repository, sha256, url, version)

A rule for fetching external Helm charts from an arbitrary URL or repository.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this repository.	Name	required
chart_name	Chart name to import. Must be set if `repository` is specified	String	optional	`""`
repository	Chart repository url where to locate the requested chart. Mutually exclusive with `url`.	String	optional	`""`
sha256	The expected SHA-256 hash of the chart imported.	String	optional	`""`
url	The url where a chart can be directly downloaded. Mutually exclusive with `chart_name`, `repository`, and `version`	String	optional	`""`
version	Specify a version constraint for the chart version to use. Must be set if `repository` is specified.	String	optional	`""`

rules_helm

Bazel rules for Helm.

Rules

Providers

Functions

Aspects

Repository Rules

chart_file

helm_import

helm_install

helm_lint_test

helm_oci_digest

helm_package

helm_plugin

helm_push

helm_push_images

helm_push_registry

helm_template

helm_template_test

helm_toolchain

helm_uninstall

helm_upgrade

HelmOCIDigestInfo

HelmPackageInfo

chart_content

helm_chart

helm_lint_aspect

helm_import_repository