helm_push rules.

Rules

helm_push

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

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

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

NameDescriptionTypeMandatoryDefault
nameA unique name for this target.Namerequired
envEnvironment variables to set when running this target.Dictionary: String -> Stringoptional{}
include_imagesIf True, images depended on by package will be pushed as well.BooleanoptionalFalse
login_urlThe URL of the registry to use for helm login. E.g. my.registry.ioStringoptional""
optsAdditional arguments to pass to helm commands.List of stringsoptional[]
packageThe helm package to push to the registry.Labelrequired
push_cmdAn alternative command to push for publishing the helm chart. E.g. cm-pushStringoptional""
registry_urlThe registry URL at which to push the helm chart to. E.g. oci://my.registry.io/chart-name. Mutually exclusive with registry_url_file.Stringoptional""
registry_url_fileA file containing the registry URL at which to push the helm chart to. Mutually exclusive with registry_url.LabeloptionalNone

helm_push_images

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

helm_push_images(name, env, package)

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

ATTRIBUTES

NameDescriptionTypeMandatoryDefault
nameA unique name for this target.Namerequired
envEnvironment variables to set when running this target.Dictionary: String -> Stringoptional{}
packageThe helm package to upload images from.Labelrequired

helm_push_registry

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

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

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

NameDescriptionTypeMandatoryDefault
nameA unique name for this target.Namerequired
envEnvironment variables to set when running this target.Dictionary: String -> Stringoptional{}
include_imagesIf True, images depended on by package will be pushed as well.BooleanoptionalFalse
login_urlThe URL of the registry to use for helm login. E.g. my.registry.ioStringoptional""
optsAdditional arguments to pass to helm commands.List of stringsoptional[]
packageThe helm package to push to the registry.Labelrequired
push_cmdAn alternative command to push for publishing the helm chart. E.g. cm-pushStringoptional""
registry_urlThe registry URL at which to push the helm chart to. E.g. oci://my.registry.io/chart-name. Mutually exclusive with registry_url_file.Stringoptional""
registry_url_fileA file containing the registry URL at which to push the helm chart to. Mutually exclusive with registry_url.LabeloptionalNone