Clarify docs for CronWorkflow startingDeadlineSeconds
#12971
Labels
area/cron-workflows
area/docs
Incorrect, missing, or mistakes in docs
good first issue
Good for newcomers
solution/suggested
A solution to the bug has been suggested. Someone needs to implement it.
type/bug
Pre-requisites
:latest
image tag (i.e.quay.io/argoproj/workflow-controller:latest
) and can confirm the issue still exists on:latest
. If not, I have explained why, in detail, in my description below.What happened/what did you expect to happen?
The CronWorkflow docs describe
startingDeadlineSeconds
as:This does not match the logic in the implementation. Based on the code, the docs should be reworded to something like the following:
Similar changes should be made elsewhere, as the comparison is not against the last successful run, but rather the last desired/expected/scheduled run time.
tl;dr
startingDeadlineSeconds
should be clearly documented as the "grace period" beyond the scheduled run during which a CronWorkflow may still be executed.Version
v3.5.5
Paste a small workflow that reproduces the issue. We must be able to run the workflow; don't enter a workflows that uses private images.
n/a
Logs from the workflow controller
Logs from in your workflow's wait container
The text was updated successfully, but these errors were encountered: