Upgrade Advisory
This documentation is for Flux (v1) and Helm Operator (v1). Both projects are in maintenance mode and will soon reach end-of-life. We strongly recommend you familiarise yourself with the newest Flux and start looking at your migration path.
For documentation regarding the latest Flux, please refer to this section.
HelmRelease Custom Resource
Packages:
helm.fluxcd.io/v1
Package v1 is the v1 version of the API. The prior version was flux.weave.works/v1beta1.
Resource Types:HelmRelease
HelmRelease is a type to represent a Helm release.
Field | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | helm.fluxcd.io/v1 | ||||||||||||||||||||||||||||||||||
kind string | HelmRelease | ||||||||||||||||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
metadata field. | ||||||||||||||||||||||||||||||||||
spec HelmReleaseSpec |
| ||||||||||||||||||||||||||||||||||
status HelmReleaseStatus |
|
ChartFileSelector
(Appears on: ValuesFromSource)
Field | Description |
---|---|
path string | Path is the file path to the source relative to the chart root. |
optional bool | (Optional) Optional will mark this ChartFileSelector as optional. The result of this are that operations are permitted without the source, due to it e.g. being temporarily unavailable. |
ChartSource
(Appears on: HelmReleaseSpec)
Field | Description |
---|---|
GitChartSource GitChartSource | (Members of |
RepoChartSource RepoChartSource | (Members of |
ConditionStatus
(string
alias)
(Appears on: HelmReleaseCondition)
ConfigMapKeySelector
(Appears on: OptionalConfigMapKeySelector)
Field | Description |
---|---|
LocalObjectReference LocalObjectReference | (Members of |
namespace string | (Optional) |
key string | (Optional) |
ExternalSourceSelector
(Appears on: ValuesFromSource)
Field | Description |
---|---|
url string | URL is the URL of the external source. |
optional bool | (Optional) Optional will mark this ExternalSourceSelector as optional. The result of this are that operations are permitted without the source, due to it e.g. being temporarily unavailable. |
GitChartSource
(Appears on: ChartSource)
GitChartSource describes a Helm chart sourced from Git.
Field | Description |
---|---|
git string | Git URL is the URL of the Git repository, e.g.
|
ref string | Ref is the Git branch (or other reference) to use. Defaults to ‘master’, or the configured default Git ref. |
path string | Path is the path to the chart relative to the repository root. |
secretRef ObjectReference | (Optional) SecretRef holds the authentication secret for accessing the Git repository (over HTTPS). The credentials will be added to an HTTPS GitURL before the mirror is started. |
skipDepUpdate bool | (Optional) SkipDepUpdate will tell the operator to skip running ‘helm dep update’ before installing or upgrading the chart, the chart dependencies must be present for this to succeed. |
HelmReleaseCondition
(Appears on: HelmReleaseStatus)
Field | Description |
---|---|
type HelmReleaseConditionType | Type of the condition, one of (‘ChartFetched’, ‘Deployed’, ‘Released’, ‘RolledBack’, ‘Tested’). |
status ConditionStatus | Status of the condition, one of (‘True’, ‘False’, ‘Unknown’). |
lastUpdateTime Kubernetes meta/v1.Time | (Optional) LastUpdateTime is the timestamp corresponding to the last status update of this condition. |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
HelmReleaseConditionType
(string
alias)
(Appears on: HelmReleaseCondition)
HelmReleaseConditionType represents an HelmRelease condition value. Valid HelmReleaseConditionType values are: “ChartFetched”, “Deployed”, “Released”, “RolledBack” “Tested”,
HelmReleasePhase
(string
alias)
(Appears on: HelmReleaseStatus)
HelmReleasePhase represents the phase a HelmRelease is in. Valid HelmReleasePhase values are: “ChartFetched”, “ChartFetchFailed”, “Installing”, “Upgrading”, “Deployed”, “DeployFailed”, “Testing”, “TestFailed”, “Tested”, “Succeeded”, “Failed”, “RollingBack”, “RolledBack”, “RollbackFailed”,
HelmReleaseSpec
(Appears on: HelmRelease)
Field | Description | ||||
---|---|---|---|---|---|
helmVersion HelmVersion | |||||
chart ChartSource |
| ||||
releaseName string | ReleaseName is the name of the The Helm release. If not supplied, it will be generated by affixing the namespace to the resource name. | ||||
maxHistory int | MaxHistory is the maximum amount of revisions to keep for the Helm release. If not supplied, it defaults to 10. | ||||
valuesFrom []ValuesFromSource | |||||
targetNamespace string | (Optional) TargetNamespace overrides the targeted namespace for the Helm release. The default namespace equals to the namespace of the HelmRelease resource. | ||||
timeout int64 | (Optional) Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during installation and upgrade operations. | ||||
resetValues bool | (Optional) ResetValues will mark this Helm release to reset the values
to the defaults of the targeted chart before performing
an upgrade. Not explicitly setting this to | ||||
skipCRDs bool | (Optional) SkipCRDs will mark this Helm release to skip the creation of CRDs during a Helm 3 installation. | ||||
wait bool | (Optional) Wait will mark this Helm release to wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. | ||||
forceUpgrade bool | (Optional) Force will mark this Helm release to | ||||
rollback Rollback | (Optional) The rollback settings for this Helm release. | ||||
test Test | (Optional) The test settings for this Helm release. | ||||
values k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON | (Optional) Values holds the values for this Helm release. | ||||
disableOpenAPIValidation bool | (Optional) DisableOpenAPIValidation controls whether OpenAPI validation is enforced. |
HelmReleaseStatus
(Appears on: HelmRelease)
HelmReleaseStatus contains status information about an HelmRelease.
Field | Description |
---|---|
observedGeneration int64 | (Optional) ObservedGeneration is the most recent generation observed by the operator. |
phase HelmReleasePhase | (Optional) Phase the release is in, one of (‘ChartFetched’, ‘ChartFetchFailed’, ‘Installing’, ‘Upgrading’, ‘Deployed’, ‘DeployFailed’, ‘Testing’, ‘TestFailed’, ‘Tested’, ‘Succeeded’, ‘RollingBack’, ‘RolledBack’, ‘RollbackFailed’) |
releaseName string | (Optional) ReleaseName is the name as either supplied or generated. |
releaseStatus string | (Optional) ReleaseStatus is the status as given by Helm for the release managed by this resource. |
revision string | (Optional) Revision holds the Git hash or version of the chart currently deployed. |
lastAttemptedRevision string | (Optional) LastAttemptedRevision is the revision of the latest chart sync, and may be of a failed release. |
rollbackCount int64 | (Optional) RollbackCount records the amount of rollback attempts made, it is incremented after a rollback failure and reset after a successful upgrade or revision change. |
conditions []HelmReleaseCondition | (Optional) Conditions contains observations of the resource’s state, e.g., has the chart which it refers to been fetched. |
HelmVersion
(string
alias)
(Appears on: HelmReleaseSpec)
HelmVersion is the version of Helm to target. If not supplied, the lowest enabled Helm version will be targeted. Valid HelmVersion values are: “v2”, “v3”
LocalObjectReference
(Appears on: ConfigMapKeySelector, HelmReleaseSpec, ObjectReference, RepoChartSource, SecretKeySelector)
Field | Description |
---|---|
name string |
ObjectReference
(Appears on: GitChartSource)
Field | Description |
---|---|
LocalObjectReference LocalObjectReference | (Members of |
namespace string |
OptionalConfigMapKeySelector
(Appears on: ValuesFromSource)
Field | Description |
---|---|
ConfigMapKeySelector ConfigMapKeySelector | (Members of |
optional bool | (Optional) |
OptionalSecretKeySelector
(Appears on: ValuesFromSource)
Field | Description |
---|---|
SecretKeySelector SecretKeySelector | (Members of |
optional bool | (Optional) |
RepoChartSource
(Appears on: ChartSource)
RepoChartSources describes a Helm chart sourced from a Helm repository.
Field | Description |
---|---|
repository string | RepoURL is the URL of the Helm repository, e.g.
|
name string | Name is the name of the Helm chart without an alias, e.g.
redis (for |
version string | Version is the targeted Helm chart version, e.g. 7.0.1. |
chartPullSecret LocalObjectReference | (Optional) ChartPullSecret holds the reference to the authentication secret for accessing the Helm repository using HTTPS basic auth. NOT IMPLEMENTED! |
Rollback
(Appears on: HelmReleaseSpec)
Field | Description |
---|---|
enable bool | (Optional) Enable will mark this Helm release for rollbacks. |
retry bool | (Optional) Retry will mark this Helm release for upgrade retries after a rollback. |
maxRetries int64 | (Optional) MaxRetries is the maximum amount of upgrade retries the operator should make before bailing. |
force bool | (Optional) Force will mark this Helm release to |
recreate bool | (Optional) Recreate will mark this Helm release to |
disableHooks bool | (Optional) DisableHooks will mark this Helm release to prevent hooks from running during the rollback. |
timeout int64 | (Optional) Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during rollback. |
wait bool | (Optional) Wait will mark this Helm release to wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. |
SecretKeySelector
(Appears on: OptionalSecretKeySelector)
Field | Description |
---|---|
LocalObjectReference LocalObjectReference | (Members of |
namespace string | (Optional) |
key string | (Optional) |
Test
(Appears on: HelmReleaseSpec)
Field | Description |
---|---|
enable bool | (Optional) Enable will mark this Helm release for tests. |
ignoreFailures bool | (Optional) IgnoreFailures will cause a Helm release to be rolled back if it fails otherwise it will be left in a released state |
timeout int64 | (Optional) Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during test. |
cleanup bool | (Optional) Cleanup, when targeting Helm 2, determines whether to delete test pods between each test run initiated by the Helm Operator. |
ValuesFromSource
(Appears on: HelmReleaseSpec)
Field | Description |
---|---|
configMapKeyRef OptionalConfigMapKeySelector | (Optional) The reference to a config map with release values. |
secretKeyRef OptionalSecretKeySelector | (Optional) The reference to a secret with release values. |
externalSourceRef ExternalSourceSelector | (Optional) The reference to an external source with release values. |
chartFileRef ChartFileSelector | (Optional) The reference to a local chart file with release values. |
This page was automatically generated with gen-crd-api-reference-docs