docs: clarify Helm timeout behavior#5178
Conversation
Assisted-by: OpenAI Codex Signed-off-by: Puneet Dixit <236133619+puneetdixit200@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Clarifies the helm.timeoutSeconds documentation for Fleet’s Helm deployer by updating the Go API field comment and the generated CRD schema descriptions, aligning them with current internal/helmdeployer behavior referenced in #801.
Changes:
- Update
HelmOptions.TimeoutSecondscomment to describe how Fleet interprets omitted/0 vs positive values. - Update the CRD schema descriptions for
timeoutSecondsacross all occurrences in the generated CRD YAML template.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pkg/apis/fleet.cattle.io/v1alpha1/bundledeployment_types.go | Updates the API doc comment for HelmOptions.TimeoutSeconds. |
| charts/fleet-crd/templates/crds.yaml | Updates CRD field descriptions for timeoutSeconds to match the API comment. |
Comments suppressed due to low confidence (5)
charts/fleet-crd/templates/crds.yaml:979
- This description states that positive timeoutSeconds enables “Helm status waiting”, but Fleet only enables StatusWatcherStrategy for install/upgrade; uninstall and rollback always use HookOnlyStrategy. Consider clarifying that this setting controls install/upgrade waiting behavior rather than all Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values disable
Helm status waiting; positive values enable Helm status
waiting up to the configured timeout.
charts/fleet-crd/templates/crds.yaml:2020
- This description states that positive timeoutSeconds enables “Helm status waiting”, but Fleet only enables StatusWatcherStrategy for install/upgrade; uninstall and rollback always use HookOnlyStrategy. Consider clarifying that this setting controls install/upgrade waiting behavior rather than all Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values disable
Helm status waiting; positive values enable Helm status waiting
up to the configured timeout.
charts/fleet-crd/templates/crds.yaml:3049
- This description states that positive timeoutSeconds enables “Helm status waiting”, but Fleet only enables StatusWatcherStrategy for install/upgrade; uninstall and rollback always use HookOnlyStrategy. Consider clarifying that this setting controls install/upgrade waiting behavior rather than all Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values disable
Helm status waiting; positive values enable Helm status
waiting up to the configured timeout.
charts/fleet-crd/templates/crds.yaml:8248
- This description states that positive timeoutSeconds enables “Helm status waiting”, but Fleet only enables StatusWatcherStrategy for install/upgrade; uninstall and rollback always use HookOnlyStrategy. Consider clarifying that this setting controls install/upgrade waiting behavior rather than all Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values disable
Helm status waiting; positive values enable Helm status waiting
up to the configured timeout.
charts/fleet-crd/templates/crds.yaml:9301
- This description states that positive timeoutSeconds enables “Helm status waiting”, but Fleet only enables StatusWatcherStrategy for install/upgrade; uninstall and rollback always use HookOnlyStrategy. Consider clarifying that this setting controls install/upgrade waiting behavior rather than all Helm operations.
description: TimeoutSeconds is the number of seconds Fleet
passes to Helm operations. Omitted or zero values disable
Helm status waiting; positive values enable Helm status
waiting up to the configured timeout.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| // 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 |
There was a problem hiding this comment.
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.
What this PR does:
Clarifies the
helm.timeoutSecondsdescription in the Fleet API comment and generated CRD template.The current Helm deployer behavior is:
0timeoutSecondsleaves Helm status waiting disabledtimeoutSecondsenables Helm status waiting up to the configured timeoutThis matches
internal/helmdeployerbehavior and the existingTestWaitStrategyConfigurationexpectations.Which issue(s) this PR fixes:
Refers #801
Checklist
CHANGELOG.mdupdated - no user-facing code changedocs/configuration/v1-guarantees.mdupdated if this PR introduces experimental flagsValidation performed:
AI assistance disclosure:
Prepared with OpenAI GPT-5 assistance. AI was used to inspect the issue, trace the current timeout behavior, update the documentation text, and run the validation commands above. The commit includes the required
Assisted-by: OpenAI GPT-5trailer.