helm_chart rule.

Functions

helm_chart

helm_chart

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

helm_chart(*, name, chart, chart_json, crds, values, values_json, substitutions, templates, schema,
           files, images, deps, install_name, registry_url, registry_url_file, 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` or `registry_url_file` is defined.
`{name}.push`	helm_push (`include_images = True`)	`registry_url` or `registry_url_file` 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. Mutually exclusive with `registry_url_file`.	`None`
registry_url_file	A file containing the registry url for the helm chart. `{name}.push_registry` is only defined when a value is passed here. Mutually exclusive with `registry_url`.	`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