API Reference
April 8, 2026 ยท View on GitHub
Packages
helm.cattle.io/v1
FailurePolicy
Underlying type: string
Validation:
- Enum: [abort reinstall]
Appears in:
HelmChart
HelmChart represents configuration and state for the deployment of a Helm chart.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec HelmChartSpec | |||
status HelmChartStatus |
HelmChartCondition
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type HelmChartConditionType | Type of job condition. | ||
status ConditionStatus | Status of the condition, one of True, False, Unknown. | ||
reason string | (brief) reason for the condition's last transition. | ||
message string | Human readable message indicating details about last transition. |
HelmChartConditionType
Underlying type: string
Appears in:
| Field | Description |
|---|---|
JobCreated | |
Failed |
HelmChartConfig
HelmChartConfig represents additional configuration for the installation of Helm chart release. This resource is intended for use when additional configuration needs to be passed to a HelmChart that is managed by an external system.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec HelmChartConfigSpec |
HelmChartConfigSpec
HelmChartConfigSpec represents additional user-configurable details of an installed and configured Helm chart release. These fields are merged with or override the corresponding fields on the related HelmChart resource.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
values JSON | Override complex Chart values via structured YAML. Takes precedence over options set via valuesContent. Helm CLI positional argument/flag: --values | ||
valuesContent string | Override complex Chart values via inline YAML content. Helm CLI positional argument/flag: --values | ||
valuesSecrets SecretSpec array | Override complex Chart values via references to external Secrets. Helm CLI positional argument/flag: --values | ||
failurePolicy FailurePolicy | Configures handling of failed chart installation or upgrades. - reinstall will perform a clean uninstall and reinstall of the chart.- abort will take no action and leave the chart in a failed state so that the administrator can manually resolve the error. | reinstall | Enum: [abort reinstall] |
HelmChartSpec
HelmChartSpec represents the user-configurable details for installation and upgrade of a Helm chart release.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
targetNamespace string | Helm Chart target namespace. Helm CLI positional argument/flag: --namespace | ||
createNamespace boolean | Create target namespace if not present. Helm CLI positional argument/flag: --create-namespace | ||
chart string | Helm Chart name in repository, or complete HTTPS URL to chart archive (.tgz) Helm CLI positional argument/flag: CHART | ||
version string | Helm Chart version. Only used when installing from repository; ignored when .spec.chart or .spec.chartContent is used to install a specific chart archive. Helm CLI positional argument/flag: --version | ||
repo string | Helm Chart repository URL. Helm CLI positional argument/flag: --repo | ||
repoCA string | Verify certificates of HTTPS-enabled servers using this CA bundle. Should be a string containing one or more PEM-encoded CA Certificates. Helm CLI positional argument/flag: --ca-file | ||
repoCAConfigMap LocalObjectReference | Reference to a ConfigMap containing CA Certificates to be be trusted by Helm. Can be used along with or instead of .spec.repoCAHelm CLI positional argument/flag: --ca-file | ||
set object (keys:string, values:IntOrString) | Override simple Chart values. These take precedence over options set via values or valuesContent. Helm CLI positional argument/flag: --set, --set-string | ||
values JSON | Override complex Chart values via structured YAML. Takes precedence over options set via valuesContent. Helm CLI positional argument/flag: --values | ||
valuesContent string | Override complex Chart values via inline YAML content. Helm CLI positional argument/flag: --values | ||
valuesSecrets SecretSpec array | Override complex Chart values via references to external Secrets. Helm CLI positional argument/flag: --values | ||
helmVersion string | DEPRECATED. Helm version to use. Only v3 is currently supported. | ||
bootstrap boolean | Set to True if this chart is needed to bootstrap the cluster (Cloud Controller Manager, CNI, etc). | ||
takeOwnership boolean | Set to True if helm should take ownership of existing resources when installing/upgrading the chart. Helm CLI positional argument/flag: --take-ownership | ||
chartContent string | Base64-encoded chart archive .tgz; overides .spec.chart and .spec.version.Helm CLI positional argument/flag: CHART | ||
jobImage string | Specify the image to use for tht helm job pod when installing or upgrading the helm chart. | ||
backOffLimit integer | Specify the number of retries before considering the helm job failed. | ||
timeout Duration | Timeout for Helm operations. Helm CLI positional argument/flag: --timeout | ||
failurePolicy FailurePolicy | Configures handling of failed chart installation or upgrades. - reinstall will perform a clean uninstall and reinstall of the chart.- abort will take no action and leave the chart in a failed state so that the administrator can manually resolve the error. | reinstall | Enum: [abort reinstall] |
authSecret LocalObjectReference | Reference to Secret of type kubernetes.io/basic-auth holding Basic auth credentials for the Chart repo. | ||
authPassCredentials boolean | Pass Basic auth credentials to all domains. Helm CLI positional argument/flag: --pass-credentials | ||
insecureSkipTLSVerify boolean | Skip TLS certificate checks for the chart download. Helm CLI positional argument/flag: --insecure-skip-tls-verify | ||
plainHTTP boolean | Use insecure HTTP connections for the chart download. Helm CLI positional argument/flag: --plain-http | ||
dockerRegistrySecret LocalObjectReference | Reference to Secret of type kubernetes.io/dockerconfigjson holding Docker auth credentials for the OCI-based registry acting as the Chart repo. | ||
podSecurityContext PodSecurityContext | Custom PodSecurityContext for the helm job pod. | ||
securityContext SecurityContext | custom SecurityContext for the helm job pod. | ||
driver HelmDriver | Helm storage driver to use for this chart's release metadata.secret stores releases in Kubernetes Secrets (default).configmap stores releases in ConfigMaps.This field is effectively immutable after the first install; changing the storage backend is not a supported migration path. Helm CLI environment variable: HELM_DRIVER | secret | Enum: [secret configmap] |
HelmChartStatus
HelmChartStatus represents the resulting state from processing HelmChart events
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
jobName string | The name of the job created to install or upgrade the chart. | ||
conditions HelmChartCondition array | JobCreated indicates that a job has been created to install or upgrade the chart.Failed indicates that the helm job has failed and the failure policy is set to abort. |
HelmDriver
Underlying type: string
Validation:
- Enum: [secret configmap]
Appears in:
SecretSpec
SecretSpec describes a key in a secret to load chart values from.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the secret. Must be in the same namespace as the HelmChart resource. | ||
keys string array | Keys to read values content from. If no keys are specified, the secret is not used. | ||
ignoreUpdates boolean | Ignore changes to the secret, and mark the secret as optional. By default, the secret must exist, and changes to the secret will trigger an upgrade of the chart to apply the updated values. If ignoreUpdates is true, the secret is optional, and changes to the secret will not trigger an upgrade of the chart. |