docs: Clarify maxDuration behavior when used with activeDeadlineSeconds. Fixes #13044 #13068
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #13044
Motivation
The current documentation for
maxDuration
in the Argo workflow is unclear and potentially misleading, particularly when used in conjunction withactiveDeadlineSeconds
.The description does not accurately reflect the behavior observed in the code, where the pod's deadline set by
activeDeadlineSeconds
is overridden bymaxDuration
upon workflow failure.argo-workflows/workflow/controller/operator.go
Lines 1053 to 1054 in a1db80a
This can lead to confusion for users trying to understand how these two parameters interact.
The updated documentation aims to clarify this behavior, ensuring that users have a precise understanding of how
maxDuration
andactiveDeadlineSeconds
work together in the context of workflow retries and backoff strategies.Modifications
Updated comments in
pkg/apis/workflow/v1alpha1/workflow_types.go
and runmake pre-commit -B
.Verification
make docs
passed.