Skip to content

docs: clarify Helm timeout behavior #5178

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
puneetdixit200 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify Helm timeout behavior #5178

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
e930ddc
docs: clarify Helm timeout behavior
puneetdixit200 May 20, 2026
dd49094
docs: clarify helm timeout wait scope
puneetdixit200 May 23, 2026
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
40 changes: 30 additions & 10 deletions charts/fleet-crd/templates/crds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,8 +505,11 @@ spec:
nullable: true
type: object
timeoutSeconds:
description: TimeoutSeconds is the time to wait for Helm
operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values use hook-only
waiting. Positive values enable Helm status waiting during
install and upgrade operations up to the configured timeout;
uninstall and rollback operations keep hook-only waiting.
type: integer
values:
description: 'Values passed to Helm. It is possible to specify
Expand Down Expand Up @@ -971,8 +974,11 @@ spec:
nullable: true
type: object
timeoutSeconds:
description: TimeoutSeconds is the time to wait for Helm
operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values use hook-only
waiting. Positive values enable Helm status waiting during
install and upgrade operations up to the configured timeout;
uninstall and rollback operations keep hook-only waiting.
type: integer
values:
description: 'Values passed to Helm. It is possible to specify
Expand Down Expand Up @@ -2010,7 +2016,11 @@ spec:
nullable: true
type: object
timeoutSeconds:
description: TimeoutSeconds is the time to wait for Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values use hook-only
waiting. Positive values enable Helm status waiting during install
and upgrade operations up to the configured timeout; uninstall
and rollback operations keep hook-only waiting.
type: integer
values:
description: 'Values passed to Helm. It is possible to specify
Expand Down Expand Up @@ -3036,8 +3046,11 @@ spec:
nullable: true
type: object
timeoutSeconds:
description: TimeoutSeconds is the time to wait for Helm
operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values use hook-only
waiting. Positive values enable Helm status waiting during
install and upgrade operations up to the configured timeout;
uninstall and rollback operations keep hook-only waiting.
type: integer
values:
description: 'Values passed to Helm. It is possible to
Expand Down Expand Up @@ -8233,7 +8246,11 @@ spec:
nullable: true
type: object
timeoutSeconds:
description: TimeoutSeconds is the time to wait for Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values use hook-only
waiting. Positive values enable Helm status waiting during install
and upgrade operations up to the configured timeout; uninstall
and rollback operations keep hook-only waiting.
type: integer
values:
description: 'Values passed to Helm. It is possible to specify
Expand Down Expand Up @@ -9283,8 +9300,11 @@ spec:
nullable: true
type: object
timeoutSeconds:
description: TimeoutSeconds is the time to wait for Helm
operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values use hook-only
waiting. Positive values enable Helm status waiting during
install and upgrade operations up to the configured timeout;
uninstall and rollback operations keep hook-only waiting.
type: integer
values:
description: 'Values passed to Helm. It is possible to
Expand Down
5 changes: 4 additions & 1 deletion pkg/apis/fleet.cattle.io/v1alpha1/bundledeployment_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,10 @@ type HelmOptions struct {
// Version of the chart to download
Version string `json:"version,omitempty"`

// TimeoutSeconds is the time to wait for Helm operations.
// TimeoutSeconds is the number of seconds Fleet passes to Helm operations.
// Omitted or zero values use hook-only waiting. Positive values enable Helm

@weyfonk weyfonk Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "hook-only waiting" mean here? Brief research suggests that it means "only wait for execution of hooks to complete", not waiting for chart resources, but that may not be immediately obvious to users.

// status waiting during install and upgrade operations up to the configured
// timeout; uninstall and rollback operations keep hook-only waiting.
TimeoutSeconds int `json:"timeoutSeconds,omitempty"`

// Values passed to Helm. It is possible to specify the keys and values
Expand Down