Skip to content
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.

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

docs: Clarify maxDuration behavior when used with activeDeadlineSeconds. Fixes #13044 #13068

Merged
merged 1 commit into from
May 20, 2024

Conversation

leesungbin
Copy link
Contributor

@leesungbin leesungbin commented May 20, 2024

Fixes #13044

Motivation

The current documentation for maxDuration in the Argo workflow is unclear and potentially misleading, particularly when used in conjunction with activeDeadlineSeconds.
The description does not accurately reflect the behavior observed in the code, where the pod's deadline set by activeDeadlineSeconds is overridden by maxDuration upon workflow failure.

woc.log.WithField("node", node.Name).Infof("node has maxDuration set, setting executionDeadline to: %s", humanize.Timestamp(maxDurationDeadline))
opts.executionDeadline = maxDurationDeadline

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 and activeDeadlineSeconds work together in the context of workflow retries and backoff strategies.

Modifications

Updated comments in pkg/apis/workflow/v1alpha1/workflow_types.go and run make pre-commit -B.

Verification

make docs passed.

…ds. Fixes argoproj#13044

Signed-off-by: leesungbin <lee@sungbin.dev>
@leesungbin leesungbin marked this pull request as ready for review May 20, 2024 01:48
@terrytangyuan terrytangyuan merged commit 34ab2e3 into argoproj:main May 20, 2024
29 checks passed
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/spec Changes to the workflow specification. area/retryStrategy Template-level retryStrategy labels May 27, 2024
agilgur5 pushed a commit that referenced this pull request Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs area/retryStrategy Template-level retryStrategy area/spec Changes to the workflow specification.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Retrying workflows have short deadline ignoring activeDeadlineSeconds
3 participants