@@ -1473,8 +1394,8 @@ Kubernetes meta/v1.Duration
|
(Optional)
- Timeout is the time to wait for any individual Kubernetes operation (like Jobs
-for hooks) during the performance of a Helm upgrade action. Defaults to
+ Timeout is the time to wait for any individual Kubernetes operation (like
+Jobs for hooks) during the performance of a Helm upgrade action. Defaults to
‘HelmReleaseSpec.Timeout’.
|
@@ -1489,9 +1410,8 @@ UpgradeRemediation
(Optional)
- Remediation holds the remediation configuration for when the
-Helm upgrade action for the HelmRelease fails. The default
-is to not perform any action.
+Remediation holds the remediation configuration for when the Helm upgrade
+action for the HelmRelease fails. The default is to not perform any action.
|
@@ -1503,8 +1423,8 @@ bool
|
(Optional)
- DisableWait disables the waiting for resources to be ready after a
-Helm upgrade has been performed.
+DisableWait disables the waiting for resources to be ready after a Helm
+upgrade has been performed.
|
@@ -1528,8 +1448,8 @@ bool
|
(Optional)
- DisableOpenAPIValidation prevents the Helm upgrade action from
-validating rendered templates against the Kubernetes OpenAPI Schema.
+DisableOpenAPIValidation prevents the Helm upgrade action from validating
+rendered templates against the Kubernetes OpenAPI Schema.
|
@@ -1553,8 +1473,8 @@ bool
|
(Optional)
- PreserveValues will make Helm reuse the last release’s values and merge
-in overrides from ‘Values’. Setting this flag makes the HelmRelease
+ PreserveValues will make Helm reuse the last release’s values and merge in
+overrides from ‘Values’. Setting this flag makes the HelmRelease
non-declarative.
|
@@ -1615,8 +1535,8 @@ bool
(Optional)
- IgnoreTestFailures tells the controller to skip remediation when
-the Helm tests are run after an upgrade action but fail.
+ IgnoreTestFailures tells the controller to skip remediation when the Helm
+tests are run after an upgrade action but fail.
Defaults to ‘Test.IgnoreFailures’.
|
@@ -1629,9 +1549,8 @@ bool
(Optional)
- RemediateLastFailure tells the controller to remediate the last
-failure, when no retries remain. Defaults to ‘false’ unless ‘Retries’
-is greater than 0.
+RemediateLastFailure tells the controller to remediate the last failure, when
+no retries remain. Defaults to ‘false’ unless ‘Retries’ is greater than 0.
|
@@ -1645,8 +1564,7 @@ RemediationStrategy
|
(Optional)
- Strategy to use for failure remediation.
-Defaults to ‘rollback’.
+Strategy to use for failure remediation. Defaults to ‘rollback’.
|
@@ -1703,8 +1621,8 @@ string
(Optional)
- ValuesKey is the data key where the values.yaml or a specific value can
-be found at. Defaults to ‘values.yaml’.
+ValuesKey is the data key where the values.yaml or a specific value can be
+found at. Defaults to ‘values.yaml’.
|
@@ -1716,9 +1634,9 @@ string
|
(Optional)
- TargetPath is the YAML dot notation path the value should be merged at.
-When set, the ValuesKey is expected to be a single flat value.
-Defaults to ‘None’, which results in the values getting merged at the root.
+TargetPath is the YAML dot notation path the value should be merged at. When
+set, the ValuesKey is expected to be a single flat value. Defaults to ‘None’,
+which results in the values getting merged at the root.
|
@@ -1730,8 +1648,8 @@ bool
|
(Optional)
- Optional marks this ValuesReference as optional. When set, a not found
-error for the values reference is ignored, but any ValuesKey, TargetPath or
+ Optional marks this ValuesReference as optional. When set, a not found error
+for the values reference is ignored, but any ValuesKey, TargetPath or
transient error will still result in a reconciliation failure.
|
diff --git a/docs/spec/v2alpha1/helmreleases.md b/docs/spec/v2alpha1/helmreleases.md
index 71eea9267..ed5e3bb4d 100644
--- a/docs/spec/v2alpha1/helmreleases.md
+++ b/docs/spec/v2alpha1/helmreleases.md
@@ -10,7 +10,7 @@ reconciliation should happen at, and a set of options to control the settings of
automated Helm actions that are being performed.
```go
-// HelmReleaseSpec defines the desired state of HelmRelease.
+// HelmReleaseSpec defines the desired state of a Helm Release.
type HelmReleaseSpec struct {
// Chart defines the template of the v1alpha1.HelmChart that should be created
// for this HelmRelease.
@@ -42,10 +42,11 @@ type HelmReleaseSpec struct {
// +optional
TargetNamespace string `json:"targetNamespace,omitempty"`
- // DependsOn may contain a list of HelmReleases that must be ready before this
- // HelmRelease can be reconciled.
+ // DependsOn may contain a dependency.CrossNamespaceDependencyReference slice with
+ // references to HelmRelease resources that must be ready before this HelmRelease
+ // can be reconciled.
// +optional
- DependsOn []string `json:"dependsOn,omitempty"`
+ DependsOn []dependency.CrossNamespaceDependencyReference `json:"dependsOn,omitempty"`
// Timeout is the time to wait for any individual Kubernetes operation (like Jobs
// for hooks) during the performance of a Helm action. Defaults to '5m0s'.
@@ -86,23 +87,24 @@ type HelmReleaseSpec struct {
Values *apiextensionsv1.JSON `json:"values,omitempty"`
}
-// HelmChartTemplate defines the template from which the controller will generate a
-// v1alpha1.HelmChart object in the same namespace as the referenced v1alpha1.Source.
+// HelmChartTemplate defines the template from which the controller will
+// generate a v1alpha1.HelmChart object in the same namespace as the referenced
+// v1alpha1.Source.
type HelmChartTemplate struct {
// Spec holds the template for the v1alpha1.HelmChartSpec for this HelmRelease.
// +required
Spec HelmChartTemplateSpec `json:"spec"`
}
-// HelmChartTemplateSpec defines the template from which the controller will generate
-// a v1alpha1.HelmChartSpec object.
+// HelmChartTemplateSpec defines the template from which the controller will
+// generate a v1alpha1.HelmChartSpec object.
type HelmChartTemplateSpec struct {
// The name or path the Helm chart is available at in the SourceRef.
// +required
Chart string `json:"chart"`
- // Version semver expression, ignored for charts from GitRepository and
- // Bucket sources. Defaults to latest when omitted.
+ // Version semver expression, ignored for charts from v1alpha1.GitRepository and
+ // v1alpha1.Bucket sources. Defaults to latest when omitted.
// +optional
Version string `json:"version,omitempty"`
@@ -110,28 +112,33 @@ type HelmChartTemplateSpec struct {
// +required
SourceRef CrossNamespaceObjectReference `json:"sourceRef"`
- // Interval at which to check the v1alpha1.Source for updates.
- // Defaults to 'HelmReleaseSpec.Interval'.
+ // Interval at which to check the v1alpha1.Source for updates. Defaults to
+ // 'HelmReleaseSpec.Interval'.
// +optional
Interval *metav1.Duration `json:"interval,omitempty"`
+
+ // Alternative values file to use as the default chart values, expected to be a
+ // relative path in the SourceRef. Ignored when omitted.
+ // +optional
+ ValuesFile string `json:"valuesFile,omitempty"`
}
-// Install holds the configuration for Helm install actions performed for this HelmRelease.
+// Install holds the configuration for Helm install actions performed for this
+// HelmRelease.
type Install struct {
- // Timeout is the time to wait for any individual Kubernetes operation (like Jobs
- // for hooks) during the performance of a Helm install action. Defaults to
+ // Timeout is the time to wait for any individual Kubernetes operation (like
+ // Jobs for hooks) during the performance of a Helm install action. Defaults to
// 'HelmReleaseSpec.Timeout'.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
- // Remediation holds the remediation configuration for when the
- // Helm install action for the HelmRelease fails. The default
- // is to not perform any action.
+ // Remediation holds the remediation configuration for when the Helm install
+ // action for the HelmRelease fails. The default is to not perform any action.
// +optional
Remediation *InstallRemediation `json:"remediation,omitempty"`
- // DisableWait disables the waiting for resources to be ready after a
- // Helm install has been performed.
+ // DisableWait disables the waiting for resources to be ready after a Helm
+ // install has been performed.
// +optional
DisableWait bool `json:"disableWait,omitempty"`
@@ -139,13 +146,13 @@ type Install struct {
// +optional
DisableHooks bool `json:"disableHooks,omitempty"`
- // DisableOpenAPIValidation prevents the Helm install action from
- // validating rendered templates against the Kubernetes OpenAPI Schema.
+ // DisableOpenAPIValidation prevents the Helm install action from validating
+ // rendered templates against the Kubernetes OpenAPI Schema.
// +optional
DisableOpenAPIValidation bool `json:"disableOpenAPIValidation,omitempty"`
- // Replace tells the Helm install action to re-use the 'ReleaseName', but
- // only if that name is a deleted release which remains in the history.
+ // Replace tells the Helm install action to re-use the 'ReleaseName', but only
+ // if that name is a deleted release which remains in the history.
// +optional
Replace bool `json:"replace,omitempty"`
@@ -163,34 +170,34 @@ type InstallRemediation struct {
// +optional
Retries int `json:"retries,omitempty"`
- // IgnoreTestFailures tells the controller to skip remediation when
- // the Helm tests are run after an install action but fail.
- // Defaults to 'Test.IgnoreFailures'.
+ // IgnoreTestFailures tells the controller to skip remediation when the Helm
+ // tests are run after an install action but fail. Defaults to
+ // 'Test.IgnoreFailures'.
// +optional
IgnoreTestFailures *bool `json:"ignoreTestFailures,omitempty"`
- // RemediateLastFailure tells the controller to remediate the last
- // failure, when no retries remain. Defaults to 'false'.
+ // RemediateLastFailure tells the controller to remediate the last failure, when
+ // no retries remain. Defaults to 'false'.
// +optional
RemediateLastFailure *bool `json:"remediateLastFailure,omitempty"`
}
-// Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.
+// Upgrade holds the configuration for Helm upgrade actions for this
+// HelmRelease.
type Upgrade struct {
- // Timeout is the time to wait for any individual Kubernetes operation (like Jobs
- // for hooks) during the performance of a Helm upgrade action. Defaults to
+ // Timeout is the time to wait for any individual Kubernetes operation (like
+ // Jobs for hooks) during the performance of a Helm upgrade action. Defaults to
// 'HelmReleaseSpec.Timeout'.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
- // Remediation holds the remediation configuration for when the
- // Helm upgrade action for the HelmRelease fails. The default
- // is to not perform any action.
+ // Remediation holds the remediation configuration for when the Helm upgrade
+ // action for the HelmRelease fails. The default is to not perform any action.
// +optional
Remediation *UpgradeRemediation `json:"remediation,omitempty"`
- // DisableWait disables the waiting for resources to be ready after a
- // Helm upgrade has been performed.
+ // DisableWait disables the waiting for resources to be ready after a Helm
+ // upgrade has been performed.
// +optional
DisableWait bool `json:"disableWait,omitempty"`
@@ -198,8 +205,8 @@ type Upgrade struct {
// +optional
DisableHooks bool `json:"disableHooks,omitempty"`
- // DisableOpenAPIValidation prevents the Helm upgrade action from
- // validating rendered templates against the Kubernetes OpenAPI Schema.
+ // DisableOpenAPIValidation prevents the Helm upgrade action from validating
+ // rendered templates against the Kubernetes OpenAPI Schema.
// +optional
DisableOpenAPIValidation bool `json:"disableOpenAPIValidation,omitempty"`
@@ -207,8 +214,8 @@ type Upgrade struct {
// +optional
Force bool `json:"force,omitempty"`
- // PreserveValues will make Helm reuse the last release's values and merge
- // in overrides from 'Values'. Setting this flag makes the HelmRelease
+ // PreserveValues will make Helm reuse the last release's values and merge in
+ // overrides from 'Values'. Setting this flag makes the HelmRelease
// non-declarative.
// +optional
PreserveValues bool `json:"preserveValues,omitempty"`
@@ -227,20 +234,18 @@ type UpgradeRemediation struct {
// +optional
Retries int `json:"retries,omitempty"`
- // IgnoreTestFailures tells the controller to skip remediation when
- // the Helm tests are run after an upgrade action but fail.
+ // IgnoreTestFailures tells the controller to skip remediation when the Helm
+ // tests are run after an upgrade action but fail.
// Defaults to 'Test.IgnoreFailures'.
// +optional
IgnoreTestFailures *bool `json:"ignoreTestFailures,omitempty"`
- // RemediateLastFailure tells the controller to remediate the last
- // failure, when no retries remain. Defaults to 'false' unless 'Retries'
- // is greater than 0.
+ // RemediateLastFailure tells the controller to remediate the last failure, when
+ // no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.
// +optional
RemediateLastFailure *bool `json:"remediateLastFailure,omitempty"`
- // Strategy to use for failure remediation.
- // Defaults to 'rollback'.
+ // Strategy to use for failure remediation. Defaults to 'rollback'.
// +kubebuilder:validation:Enum=rollback;uninstall
// +optional
Strategy *RemediationStrategy `json:"strategy,omitempty"`
@@ -248,35 +253,34 @@ type UpgradeRemediation struct {
// Test holds the configuration for Helm test actions for this HelmRelease.
type Test struct {
- // Enable enables Helm test actions for this HelmRelease after an
- // Helm install or upgrade action has been performed.
+ // Enable enables Helm test actions for this HelmRelease after an Helm install
+ // or upgrade action has been performed.
// +optional
Enable bool `json:"enable,omitempty"`
- // Timeout is the time to wait for any individual Kubernetes operation
- // during the performance of a Helm test action. Defaults to
- // 'HelmReleaseSpec.Timeout'.
+ // Timeout is the time to wait for any individual Kubernetes operation during
+ // the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
- // IgnoreFailures tells the controller to skip remediation when
- // the Helm tests are run but fail.
- // Can be overwritten for tests run after install or upgrade actions
- // in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.
+ // IgnoreFailures tells the controller to skip remediation when the Helm tests
+ // are run but fail. Can be overwritten for tests run after install or upgrade
+ // actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.
// +optional
IgnoreFailures bool `json:"ignoreFailures,omitempty"`
}
-// Rollback holds the configuration for Helm rollback actions for this HelmRelease.
+// Rollback holds the configuration for Helm rollback actions for this
+// HelmRelease.
type Rollback struct {
- // Timeout is the time to wait for any individual Kubernetes operation (like Jobs
- // for hooks) during the performance of a Helm rollback action. Defaults to
+ // Timeout is the time to wait for any individual Kubernetes operation (like
+ // Jobs for hooks) during the performance of a Helm rollback action. Defaults to
// 'HelmReleaseSpec.Timeout'.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
- // DisableWait disables the waiting for resources to be ready after a
- // Helm rollback has been performed.
+ // DisableWait disables the waiting for resources to be ready after a Helm
+ // rollback has been performed.
// +optional
DisableWait bool `json:"disableWait,omitempty"`
@@ -298,11 +302,12 @@ type Rollback struct {
CleanupOnFail bool `json:"cleanupOnFail,omitempty"`
}
-// Uninstall holds the configuration for Helm uninstall actions for this HelmRelease.
+// Uninstall holds the configuration for Helm uninstall actions for this
+// HelmRelease.
type Uninstall struct {
- // Timeout is the time to wait for any individual Kubernetes operation (like Jobs
- // for hooks) during the performance of a Helm uninstall action. Defaults to
- // 'HelmReleaseSpec.Timeout'.
+ // Timeout is the time to wait for any individual Kubernetes operation (like
+ // Jobs for hooks) during the performance of a Helm uninstall action. Defaults
+ // to 'HelmReleaseSpec.Timeout'.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
@@ -310,14 +315,14 @@ type Uninstall struct {
// +optional
DisableHooks bool `json:"disableHooks,omitempty"`
- // KeepHistory tells Helm to remove all associated resources and mark the release as
- // deleted, but retain the release history.
+ // KeepHistory tells Helm to remove all associated resources and mark the
+ // release as deleted, but retain the release history.
// +optional
KeepHistory bool `json:"keepHistory,omitempty"`
}
```
-Reference types:
+### Reference types
```go
// CrossNamespaceObjectReference contains enough information to let you locate the
@@ -361,94 +366,155 @@ type ValuesReference struct {
// +required
Name string `json:"name"`
- // ValuesKey is the data key where the values.yaml or a specific value can
- // be found at. Defaults to 'values.yaml'.
+ // ValuesKey is the data key where the values.yaml or a specific value can be
+ // found at. Defaults to 'values.yaml'.
// +optional
ValuesKey string `json:"valuesKey,omitempty"`
- // TargetPath is the YAML dot notation path the value should be merged at.
- // When set, the ValuesKey is expected to be a single flat value.
- // Defaults to 'None', which results in the values getting merged at the root.
+ // TargetPath is the YAML dot notation path the value should be merged at. When
+ // set, the ValuesKey is expected to be a single flat value. Defaults to 'None',
+ // which results in the values getting merged at the root.
// +optional
TargetPath string `json:"targetPath,omitempty"`
+
+ // Optional marks this ValuesReference as optional. When set, a not found error
+ // for the values reference is ignored, but any ValuesKey, TargetPath or
+ // transient error will still result in a reconciliation failure.
+ // +optional
+ Optional bool `json:"optional,omitempty"`
}
```
-Status condition types:
+### Status
```go
-const (
- // ReadyCondition represents the fact that the HelmRelease has been successfully reconciled.
- ReadyCondition string = "Ready"
+// HelmReleaseStatus defines the observed state of a HelmRelease.
+type HelmReleaseStatus struct {
+ // ObservedGeneration is the last observed generation.
+ // +optional
+ ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+
+ // LastHandledReconcileAt is the last manual reconciliation request (by
+ // annotating the HelmRelease) handled by the reconciler.
+ // +optional
+ LastHandledReconcileAt string `json:"lastHandledReconcileAt,omitempty"`
+
+ // Conditions holds the conditions for the HelmRelease.
+ // +optional
+ Conditions []meta.Condition `json:"conditions,omitempty"`
+
+ // LastAppliedRevision is the revision of the last successfully applied source.
+ // +optional
+ LastAppliedRevision string `json:"lastAppliedRevision,omitempty"`
+
+ // LastAttemptedRevision is the revision of the last reconciliation attempt.
+ // +optional
+ LastAttemptedRevision string `json:"lastAttemptedRevision,omitempty"`
+
+ // LastAttemptedValuesChecksum is the SHA1 checksum of the values of the last
+ // reconciliation attempt.
+ // +optional
+ LastAttemptedValuesChecksum string `json:"lastAttemptedValuesChecksum,omitempty"`
+
+ // LastReleaseRevision is the revision of the last successful Helm release.
+ // +optional
+ LastReleaseRevision int `json:"lastReleaseRevision,omitempty"`
- // ReleasedCondition represents the fact that the HelmRelease has been successfully released.
+ // HelmChart is the namespaced name of the HelmChart resource created by
+ // the controller for the HelmRelease.
+ // +optional
+ HelmChart string `json:"helmChart,omitempty"`
+
+ // Failures is the reconciliation failure count against the latest observed
+ // state. It is reset after a successful reconciliation.
+ // +optional
+ Failures int64 `json:"failures,omitempty"`
+
+ // InstallFailures is the install failure count against the latest observed
+ // state. It is reset after a successful reconciliation.
+ // +optional
+ InstallFailures int64 `json:"installFailures,omitempty"`
+
+ // UpgradeFailures is the upgrade failure count against the latest observed
+ // state. It is reset after a successful reconciliation.
+ // +optional
+ UpgradeFailures int64 `json:"upgradeFailures,omitempty"`
+}
+```
+
+#### Condition types
+
+```go
+const (
+ // ReleasedCondition represents the fact that the HelmRelease has been
+ // successfully released.
ReleasedCondition string = "Released"
- // TestSuccessCondition represents the fact that the tests for the HelmRelease are succeeding.
+ // TestSuccessCondition represents the fact that the tests for the HelmRelease
+ // are succeeding.
TestSuccessCondition string = "TestSuccess"
- // RemediatedCondition represents the fact that the HelmRelease has been successfully remediated.
+ // RemediatedCondition represents the fact that the HelmRelease has been
+ // successfully remediated.
RemediatedCondition string = "Remediated"
)
```
-Status condition reasons:
+#### Condition reasons
```go
const (
- // ReconciliationSucceededReason represents the fact that the reconciliation of the HelmRelease has succeeded.
- ReconciliationSucceededReason string = "ReconciliationSucceeded"
-
- // ReconciliationFailedReason represents the fact that the reconciliation of the HelmRelease has failed.
- ReconciliationFailedReason string = "ReconciliationFailed"
-
- // InstallSucceededReason represents the fact that the Helm install for the HelmRelease succeeded.
+ // InstallSucceededReason represents the fact that the Helm install for the
+ // HelmRelease succeeded.
InstallSucceededReason string = "InstallSucceeded"
- // InstallFailedReason represents the fact that the Helm install for the HelmRelease failed.
+ // InstallFailedReason represents the fact that the Helm install for the
+ // HelmRelease failed.
InstallFailedReason string = "InstallFailed"
- // UpgradeSucceededReason represents the fact that the Helm upgrade for the HelmRelease succeeded.
+ // UpgradeSucceededReason represents the fact that the Helm upgrade for the
+ // HelmRelease succeeded.
UpgradeSucceededReason string = "UpgradeSucceeded"
- // UpgradeFailedReason represents the fact that the Helm upgrade for the HelmRelease failed.
+ // UpgradeFailedReason represents the fact that the Helm upgrade for the
+ // HelmRelease failed.
UpgradeFailedReason string = "UpgradeFailed"
- // TestSucceededReason represents the fact that the Helm tests for the HelmRelease succeeded.
+ // TestSucceededReason represents the fact that the Helm tests for the
+ // HelmRelease succeeded.
TestSucceededReason string = "TestSucceeded"
- // TestFailedReason represents the fact that the Helm tests for the HelmRelease failed.
+ // TestFailedReason represents the fact that the Helm tests for the HelmRelease
+ // failed.
TestFailedReason string = "TestsFailed"
- // RollbackSucceededReason represents the fact that the Helm rollback for the HelmRelease succeeded.
+ // RollbackSucceededReason represents the fact that the Helm rollback for the
+ // HelmRelease succeeded.
RollbackSucceededReason string = "RollbackSucceeded"
- // RollbackFailedReason represents the fact that the Helm test for the HelmRelease failed.
+ // RollbackFailedReason represents the fact that the Helm test for the
+ // HelmRelease failed.
RollbackFailedReason string = "RollbackFailed"
- // UninstallSucceededReason represents the fact that the Helm uninstall for the HelmRelease succeeded.
+ // UninstallSucceededReason represents the fact that the Helm uninstall for the
+ // HelmRelease succeeded.
UninstallSucceededReason string = "UninstallSucceeded"
- // UninstallFailedReason represents the fact that the Helm uninstall for the HelmRelease failed.
+ // UninstallFailedReason represents the fact that the Helm uninstall for the
+ // HelmRelease failed.
UninstallFailedReason string = "UninstallFailed"
- // ArtifactFailedReason represents the fact that the artifact download for the HelmRelease failed.
+ // ArtifactFailedReason represents the fact that the artifact download for the
+ // HelmRelease failed.
ArtifactFailedReason string = "ArtifactFailed"
- // InitFailedReason represents the fact that the initialization of the Helm configuration failed.
+ // InitFailedReason represents the fact that the initialization of the Helm
+ // configuration failed.
InitFailedReason string = "InitFailed"
- // GetLastReleaseFailedReason represents the fact that observing the last release failed.
+ // GetLastReleaseFailedReason represents the fact that observing the last
+ // release failed.
GetLastReleaseFailedReason string = "GetLastReleaseFailed"
-
- // ProgressingReason represents the fact that the reconciliation for the resource is underway.
- ProgressingReason string = "Progressing"
-
- // DependencyNotReadyReason represents the fact that the one of the dependencies is not ready.
- DependencyNotReadyReason string = "DependencyNotReady"
-
- // SuspendedReason represents the fact that the reconciliation of the HelmRelease is suspended.
- SuspendedReason string = "Suspended"
)
```
@@ -473,17 +539,7 @@ interval time units are `s`, `m` and `h` e.g. `interval: 5m`, the minimum value
The reconcilation can be suspended by setting `spec.susped` to `true`.
The reconciler can be told to reconcile the `HelmRelease` outside of the specified interval
-by annotating the object with:
-
-```go
-const (
- // ReconcileAtAnnotation is the annotation used for triggering a
- // reconciliation outside of the specified schedule.
- ReconcileAtAnnotation string = "fluxcd.io/reconcileAt"
-)
-```
-
-On-demand execution example:
+by annotating the object:
```bash
kubectl annotate --overwrite helmrelease/podinfo fluxcd.io/reconcileAt="$(date +%s)"
diff --git a/go.mod b/go.mod
index 7db3d1723..28e712aa9 100644
--- a/go.mod
+++ b/go.mod
@@ -6,18 +6,19 @@ replace github.com/fluxcd/helm-controller/api => ./api
require (
github.com/fluxcd/helm-controller/api v0.0.10
+ github.com/fluxcd/pkg/apis/meta v0.0.2
github.com/fluxcd/pkg/recorder v0.0.5
- github.com/fluxcd/pkg/runtime v0.0.3
+ github.com/fluxcd/pkg/runtime v0.0.6
github.com/fluxcd/source-controller/api v0.0.18
github.com/go-logr/logr v0.1.0
github.com/onsi/ginkgo v1.12.1
github.com/onsi/gomega v1.10.1
go.uber.org/zap v1.13.0
helm.sh/helm/v3 v3.3.4
- k8s.io/api v0.18.8
- k8s.io/apimachinery v0.18.8
- k8s.io/cli-runtime v0.18.8
- k8s.io/client-go v0.18.8
+ k8s.io/api v0.18.9
+ k8s.io/apimachinery v0.18.9
+ k8s.io/cli-runtime v0.18.9
+ k8s.io/client-go v0.18.9
rsc.io/letsencrypt v0.0.3 // indirect
- sigs.k8s.io/controller-runtime v0.6.2
+ sigs.k8s.io/controller-runtime v0.6.3
)
diff --git a/go.sum b/go.sum
index 18aec707e..bf43a8cfa 100644
--- a/go.sum
+++ b/go.sum
@@ -185,15 +185,21 @@ github.com/evanphx/json-patch v0.0.0-20200808040245-162e5629780b/go.mod h1:NAJj0
github.com/evanphx/json-patch v4.2.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
github.com/evanphx/json-patch v4.5.0+incompatible h1:ouOWdg56aJriqS0huScTkVXPC5IcNrDCXZ6OoTAWu7M=
github.com/evanphx/json-patch v4.5.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
+github.com/evanphx/json-patch v4.9.0+incompatible h1:kLcOMZeuLAJvL2BPWLMIj5oaZQobrkAqrL+WFZwQses=
+github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d h1:105gxyaGwCFad8crR9dcMQWvV9Hvulu6hwUh4tWPJnM=
github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d/go.mod h1:ZZMPRZwes7CROmyNKgQzC3XPs6L/G2EJLHddWejkmf4=
github.com/fatih/camelcase v1.0.0/go.mod h1:yN2Sb0lFhZJUdVvtELVWefmrXpuZESvPmqwoZc+/fpc=
github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
+github.com/fluxcd/pkg/apis/meta v0.0.2 h1:kyA4Y0IzNjf1joBOnFqpWG7aNDHvtLExZcaHQM7qhRI=
+github.com/fluxcd/pkg/apis/meta v0.0.2/go.mod h1:nCNps5JJOcEQr3MNDmZqI4o0chjePSUYL6Q2ktDtotU=
github.com/fluxcd/pkg/recorder v0.0.5 h1:D8qfupahIvh6ncCMn2yTHsrzG91S05sp4zdpsbKWeaU=
github.com/fluxcd/pkg/recorder v0.0.5/go.mod h1:2UG6EroZ6ZbqmqoL8k/cQMe09e6A36WyH4t4UDUGyuU=
github.com/fluxcd/pkg/runtime v0.0.3 h1:x9rOThl1qh5srIUpW0YHEj1I84swMj5m76UqrR1QknY=
github.com/fluxcd/pkg/runtime v0.0.3/go.mod h1:ECBTeplxhgbCJYIjmtwn3ZS0A91/+6YtOS4w2G0LeK4=
+github.com/fluxcd/pkg/runtime v0.0.6 h1:m7qwr2wRePs1vzVlM0Y88vitXSsv1lb3QCJflRpa3qQ=
+github.com/fluxcd/pkg/runtime v0.0.6/go.mod h1:iLjncjktQVpqpb1NsY2fW+UYDFOtVyt+yJrxqrrK8A0=
github.com/fluxcd/source-controller/api v0.0.18 h1:9goqqsW3vhwO6Nxr8SNxIUW/5t1JL9cgIs4UctlaJVk=
github.com/fluxcd/source-controller/api v0.0.18/go.mod h1:PUe+EYQ/s+KPnz2iOCgdf+L6clM0SWkyvdXIpbfpkQE=
github.com/franela/goblin v0.0.0-20200105215937-c9ffbefa60db/go.mod h1:7dvUGVsVBjqR7JHJk0brhHOZYGmfBYOrK0ZhYMEtBr4=
@@ -928,25 +934,39 @@ k8s.io/api v0.18.4/go.mod h1:lOIQAKYgai1+vz9J7YcDZwC26Z0zQewYOGWdyIPUUQ4=
k8s.io/api v0.18.6/go.mod h1:eeyxr+cwCjMdLAmr2W3RyDI0VvTawSg/3RFFBEnmZGI=
k8s.io/api v0.18.8 h1:aIKUzJPb96f3fKec2lxtY7acZC9gQNDLVhfSGpxBAC4=
k8s.io/api v0.18.8/go.mod h1:d/CXqwWv+Z2XEG1LgceeDmHQwpUJhROPx16SlxJgERY=
+k8s.io/api v0.18.9 h1:7VDtivqwbvLOf8hmXSd/PDSSbpCBq49MELg84EYBYiQ=
+k8s.io/api v0.18.9/go.mod h1:9u/h6sUh6FxfErv7QqetX1EB3yBMIYOBXzdcf0Gf0rc=
k8s.io/apiextensions-apiserver v0.18.6/go.mod h1:lv89S7fUysXjLZO7ke783xOwVTm6lKizADfvUM/SS/M=
k8s.io/apiextensions-apiserver v0.18.8 h1:pkqYPKTHa0/3lYwH7201RpF9eFm0lmZDFBNzhN+k/sA=
k8s.io/apiextensions-apiserver v0.18.8/go.mod h1:7f4ySEkkvifIr4+BRrRWriKKIJjPyg9mb/p63dJKnlM=
+k8s.io/apiextensions-apiserver v0.18.9 h1:tVEf8rVKh5BnXORnYYCztjbf6CSyGNMt/rAIEyfU00Q=
+k8s.io/apiextensions-apiserver v0.18.9/go.mod h1:JagmAhU0TVENzgUZqHJsjCSDh7YuV5o6g01G1Fwh7zI=
k8s.io/apimachinery v0.18.4/go.mod h1:OaXp26zu/5J7p0f92ASynJa1pZo06YlV9fG7BoWbCko=
k8s.io/apimachinery v0.18.6/go.mod h1:OaXp26zu/5J7p0f92ASynJa1pZo06YlV9fG7BoWbCko=
k8s.io/apimachinery v0.18.8 h1:jimPrycCqgx2QPearX3to1JePz7wSbVLq+7PdBTTwQ0=
k8s.io/apimachinery v0.18.8/go.mod h1:6sQd+iHEqmOtALqOFjSWp2KZ9F0wlU/nWm0ZgsYWMig=
+k8s.io/apimachinery v0.18.9 h1:3ZABKQx3F3xPWlsGhCfUl8W+JXRRblV6Wo2A3zn0pvY=
+k8s.io/apimachinery v0.18.9/go.mod h1:PF5taHbXgTEJLU+xMypMmYTXTWPJ5LaW8bfsisxnEXk=
k8s.io/apiserver v0.18.6/go.mod h1:Zt2XvTHuaZjBz6EFYzpp+X4hTmgWGy8AthNVnTdm3Wg=
k8s.io/apiserver v0.18.8/go.mod h1:12u5FuGql8Cc497ORNj79rhPdiXQC4bf53X/skR/1YM=
+k8s.io/apiserver v0.18.9/go.mod h1:vXQzMtUCLsGg1Bh+7Jo2mZKHpHZFCZn8eTNSepcIA1M=
k8s.io/cli-runtime v0.18.8 h1:ycmbN3hs7CfkJIYxJAOB10iW7BVPmXGXkfEyiV9NJ+k=
k8s.io/cli-runtime v0.18.8/go.mod h1:7EzWiDbS9PFd0hamHHVoCY4GrokSTPSL32MA4rzIu0M=
+k8s.io/cli-runtime v0.18.9 h1:ko+hFWGCgB3Ue3CPB/525btshO+Sya/D4qNSZ1Nu7J8=
+k8s.io/cli-runtime v0.18.9/go.mod h1:Pw7UPmZd/wIlGd7DWGTUWA7qn92jCeybNeiS5WYJI6A=
k8s.io/client-go v0.18.6/go.mod h1:/fwtGLjYMS1MaM5oi+eXhKwG+1UHidUEXRh6cNsdO0Q=
k8s.io/client-go v0.18.8 h1:SdbLpIxk5j5YbFr1b7fq8S7mDgDjYmUxSbszyoesoDM=
k8s.io/client-go v0.18.8/go.mod h1:HqFqMllQ5NnQJNwjro9k5zMyfhZlOwpuTLVrxjkYSxU=
+k8s.io/client-go v0.18.9 h1:sPHX49yOtUqv1fl49TwV3f8cC0N3etSnwgFGsIsXnZc=
+k8s.io/client-go v0.18.9/go.mod h1:UjkEetDmr40P9NX0Ok3Idt08FCf2I4mIHgjFsot77uY=
k8s.io/code-generator v0.18.6/go.mod h1:TgNEVx9hCyPGpdtCWA34olQYLkh3ok9ar7XfSsr8b6c=
k8s.io/code-generator v0.18.8/go.mod h1:TgNEVx9hCyPGpdtCWA34olQYLkh3ok9ar7XfSsr8b6c=
+k8s.io/code-generator v0.18.9/go.mod h1:TgNEVx9hCyPGpdtCWA34olQYLkh3ok9ar7XfSsr8b6c=
k8s.io/component-base v0.18.6/go.mod h1:knSVsibPR5K6EW2XOjEHik6sdU5nCvKMrzMt2D4In14=
k8s.io/component-base v0.18.8 h1:BW5CORobxb6q5mb+YvdwQlyXXS6NVH5fDXWbU7tf2L8=
k8s.io/component-base v0.18.8/go.mod h1:00frPRDas29rx58pPCxNkhUfPbwajlyyvu8ruNgSErU=
+k8s.io/component-base v0.18.9 h1:7G0D/PUKrVxyUxjT5HV4aTqYqhPj60erA1ab1JUw7m8=
+k8s.io/component-base v0.18.9/go.mod h1:tUo4qZtV8m7t/U+0DgY+fcnn4BFZ480fZdzxOkWH4zk=
k8s.io/gengo v0.0.0-20190128074634-0689ccc1d7d6/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0=
k8s.io/gengo v0.0.0-20200114144118-36b2048a9120/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0=
k8s.io/klog v0.0.0-20181102134211-b9b56d5dfc92/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk=
@@ -969,6 +989,8 @@ rsc.io/letsencrypt v0.0.3/go.mod h1:buyQKZ6IXrRnB7TdkHP0RyEybLx18HHyOSoTyoOLqNY=
sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.7/go.mod h1:PHgbrJT7lCHcxMU+mDHEm+nx46H4zuuHZkDP6icnhu0=
sigs.k8s.io/controller-runtime v0.6.2 h1:jkAnfdTYBpFwlmBn3pS5HFO06SfxvnTZ1p5PeEF/zAA=
sigs.k8s.io/controller-runtime v0.6.2/go.mod h1:vhcq/rlnENJ09SIRp3EveTaZ0yqH526hjf9iJdbUJ/E=
+sigs.k8s.io/controller-runtime v0.6.3 h1:SBbr+inLPEKhvlJtrvDcwIpm+uhDvp63Bl72xYJtoOE=
+sigs.k8s.io/controller-runtime v0.6.3/go.mod h1:WlZNXcM0++oyaQt4B7C2lEE5JYRs8vJUzRP4N4JpdAY=
sigs.k8s.io/kustomize v2.0.3+incompatible h1:JUufWFNlI44MdtnjUqVnvh29rR37PQFzPbLXqhyOyX0=
sigs.k8s.io/kustomize v2.0.3+incompatible/go.mod h1:MkjgH3RdOWrievjo6c9T245dYlB5QeXV4WCbnt/PEpU=
sigs.k8s.io/structured-merge-diff/v3 v3.0.0-20200116222232-67a7b8c61874/go.mod h1:PlARxl6Hbt/+BC80dRLi1qAmnMqwqDg62YvvVkZjemw=
diff --git a/hack/api-docs/config.json b/hack/api-docs/config.json
index 5ac73197e..363232048 100644
--- a/hack/api-docs/config.json
+++ b/hack/api-docs/config.json
@@ -22,13 +22,18 @@
{
"typeMatchPrefix": "^github.com/fluxcd/pkg/runtime/dependency\\.CrossNamespaceDependencyReference$",
"docsURLTemplate": "https://godoc.org/github.com/fluxcd/pkg/runtime/dependency#CrossNamespaceDependencyReference"
+ },
+ {
+ "typeMatchPrefix": "^github.com/fluxcd/pkg/apis/meta\\.Condition$",
+ "docsURLTemplate": "https://godoc.org/github.com/fluxcd/pkg/apis/meta#Condition"
}
],
"typeDisplayNamePrefixOverrides": {
"k8s.io/api/": "Kubernetes ",
"k8s.io/apimachinery/pkg/apis/": "Kubernetes ",
"k8s.io/apiextensions-apiserver/": "Kubernetes ",
- "github.com/fluxcd/pkg/runtime/": "Runtime "
+ "github.com/fluxcd/pkg/runtime/": "Runtime ",
+ "github.com/fluxcd/pkg/apis/meta/": "Meta "
},
"markdownDisabled": false
}