Skip to content

Introduce RetryOnFailure lifecycle management strategy #1281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Introduce RetryOnFailure lifecycle management strategy #1281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee651bf
Remove tautology
matheuscscp Aug 9, 2025
c053726
Introduce `RetryOnFailure` lifecycle management strategy
matheuscscp Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 122 additions & 1 deletion api/v2/helmrelease_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,20 @@ type Remediation interface {
RetriesExhausted(hr *HelmRelease) bool
}

// Strategy defines a consistent interface for InstallStrategy and
// UpgradeStrategy.
// +kubebuilder:object:generate=false
type Strategy interface {
GetRetry() Retry
}

// Retry defines a consistent interface for retry strategies from
// InstallStrategy and UpgradeStrategy.
// +kubebuilder:object:generate=false
type Retry interface {
GetRetryInterval() time.Duration
}

// Install holds the configuration for Helm install actions performed for this
// HelmRelease.
type Install struct {
Expand All @@ -448,6 +462,11 @@ type Install struct {
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`

// Strategy defines the install strategy to use for this HelmRelease.
// Defaults to 'RemediateOnFailure'.
// +optional
Strategy *InstallStrategy `json:"strategy,omitempty"`

// Remediation holds the remediation configuration for when the Helm install
// action for the HelmRelease fails. The default is to not perform any action.
// +optional
Expand Down Expand Up @@ -541,6 +560,41 @@ func (in Install) GetRemediation() Remediation {
return *in.Remediation
}

// GetRetry returns the configured retry strategy for the Helm install
// action.
func (in Install) GetRetry() Retry {
if in.Strategy == nil || in.Strategy.Name != string(ActionStrategyRetryOnFailure) {
return nil
}
return in.Strategy
}

// InstallStrategy holds the configuration for Helm install strategy.
// +kubebuilder:validation:XValidation:rule="!has(self.retryInterval) || self.name != 'RemediateOnFailure'", message=".retryInterval cannot be set when .name is 'RemediateOnFailure'"
type InstallStrategy struct {
// Name of the install strategy.
// +kubebuilder:validation:Enum=RemediateOnFailure;RetryOnFailure
// +required
Name string `json:"name"`

// RetryInterval is the interval at which to retry a failed install.
// Can be used only when Name is set to RetryOnFailure.
// Defaults to '5m'.
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
// +optional
RetryInterval *metav1.Duration `json:"retryInterval,omitempty"`
}

// GetRetryInterval returns the configured retry interval for the Helm install
// action, or the default.
func (in InstallStrategy) GetRetryInterval() time.Duration {
if in.RetryInterval == nil {
return 5 * time.Minute
}
return in.RetryInterval.Duration
}

// InstallRemediation holds the configuration for Helm install remediation.
type InstallRemediation struct {
// Retries is the number of retries that should be attempted on failures before
Expand Down Expand Up @@ -631,6 +685,11 @@ type Upgrade struct {
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`

// Strategy defines the upgrade strategy to use for this HelmRelease.
// Defaults to 'RemediateOnFailure'.
// +optional
Strategy *UpgradeStrategy `json:"strategy,omitempty"`

// Remediation holds the remediation configuration for when the Helm upgrade
// action for the HelmRelease fails. The default is to not perform any action.
// +optional
Expand Down Expand Up @@ -719,6 +778,41 @@ func (in Upgrade) GetRemediation() Remediation {
return *in.Remediation
}

// GetRetry returns the configured retry strategy for the Helm upgrade
// action.
func (in Upgrade) GetRetry() Retry {
if in.Strategy == nil || in.Strategy.Name != string(ActionStrategyRetryOnFailure) {
return nil
}
return in.Strategy
}

// UpgradeStrategy holds the configuration for Helm upgrade strategy.
// +kubebuilder:validation:XValidation:rule="!has(self.retryInterval) || self.name == 'RetryOnFailure'", message=".retryInterval can only be set when .name is 'RetryOnFailure'"
type UpgradeStrategy struct {
// Name of the upgrade strategy.
// +kubebuilder:validation:Enum=RemediateOnFailure;RetryOnFailure
// +required
Name string `json:"name"`

// RetryInterval is the interval at which to retry a failed upgrade.
// Can be used only when Name is set to RetryOnFailure.
// Defaults to '5m'.
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$"
// +optional
RetryInterval *metav1.Duration `json:"retryInterval,omitempty"`
}

// GetRetryInterval returns the configured retry interval for the Helm upgrade
// action, or the default.
func (in UpgradeStrategy) GetRetryInterval() time.Duration {
if in.RetryInterval == nil {
return 5 * time.Minute
}
return in.RetryInterval.Duration
}

// UpgradeRemediation holds the configuration for Helm upgrade remediation.
type UpgradeRemediation struct {
// Retries is the number of retries that should be attempted on failures before
Expand Down Expand Up @@ -791,6 +885,19 @@ func (in UpgradeRemediation) RetriesExhausted(hr *HelmRelease) bool {
return in.Retries >= 0 && in.GetFailureCount(hr) > int64(in.Retries)
}

// ActionStrategyName is a valid name for an action strategy.
type ActionStrategyName string

const (
// ActionStrategyRemediateOnFailure is the action strategy name for
// remediate on failure.
ActionStrategyRemediateOnFailure ActionStrategyName = "RemediateOnFailure"

// ActionStrategyRetryOnFailure is the action strategy name for retry on
// failure.
ActionStrategyRetryOnFailure ActionStrategyName = "RetryOnFailure"
)

// RemediationStrategy returns the strategy to use to remediate a failed install
// or upgrade.
type RemediationStrategy string
Expand Down Expand Up @@ -1012,7 +1119,8 @@ type HelmReleaseStatus struct {
History Snapshots `json:"history,omitempty"`

// LastAttemptedReleaseAction is the last release action performed for this
// HelmRelease. It is used to determine the active remediation strategy.
// HelmRelease. It is used to determine the active retry or remediation
// strategy.
// +kubebuilder:validation:Enum=install;upgrade
// +optional
LastAttemptedReleaseAction ReleaseAction `json:"lastAttemptedReleaseAction,omitempty"`
Expand Down Expand Up @@ -1195,6 +1303,19 @@ func (in HelmRelease) GetActiveRemediation() Remediation {
}
}

// GetActiveRetry returns the active retry configuration for the
// HelmRelease.
func (in HelmRelease) GetActiveRetry() Retry {
switch in.Status.LastAttemptedReleaseAction {
case ReleaseActionInstall:
return in.GetInstall().GetRetry()
case ReleaseActionUpgrade:
return in.GetUpgrade().GetRetry()
default:
return nil
}
}

// GetRequeueAfter returns the duration after which the HelmRelease
// must be reconciled again.
func (in HelmRelease) GetRequeueAfter() time.Duration {
Expand Down
50 changes: 50 additions & 0 deletions api/v2/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

51 changes: 50 additions & 1 deletion config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,30 @@ spec:

Deprecated use CRD policy (`crds`) attribute with value `Skip` instead.
type: boolean
strategy:
description: |-
Strategy defines the install strategy to use for this HelmRelease.
Defaults to 'RemediateOnFailure'.
properties:
name:
description: Name of the install strategy.
enum:
- RemediateOnFailure
- RetryOnFailure
type: string
retryInterval:
description: |-
RetryInterval is the interval at which to retry a failed install.
Can be used only when Name is set to RetryOnFailure.
Defaults to '5m'.
pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
type: string
required:
- name
type: object
x-kubernetes-validations:
- message: .retryInterval cannot be set when .name is 'RemediateOnFailure'
rule: '!has(self.retryInterval) || self.name != ''RemediateOnFailure'''
timeout:
description: |-
Timeout is the time to wait for any individual Kubernetes operation (like
Expand Down Expand Up @@ -912,6 +936,30 @@ spec:
- uninstall
type: string
type: object
strategy:
description: |-
Strategy defines the upgrade strategy to use for this HelmRelease.
Defaults to 'RemediateOnFailure'.
properties:
name:
description: Name of the upgrade strategy.
enum:
- RemediateOnFailure
- RetryOnFailure
type: string
retryInterval:
description: |-
RetryInterval is the interval at which to retry a failed upgrade.
Can be used only when Name is set to RetryOnFailure.
Defaults to '5m'.
pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
type: string
required:
- name
type: object
x-kubernetes-validations:
- message: .retryInterval can only be set when .name is 'RetryOnFailure'
rule: '!has(self.retryInterval) || self.name == ''RetryOnFailure'''
timeout:
description: |-
Timeout is the time to wait for any individual Kubernetes operation (like
Expand Down Expand Up @@ -1178,7 +1226,8 @@ spec:
lastAttemptedReleaseAction:
description: |-
LastAttemptedReleaseAction is the last release action performed for this
HelmRelease. It is used to determine the active remediation strategy.
HelmRelease. It is used to determine the active retry or remediation
strategy.
enum:
- install
- upgrade
Expand Down
Loading