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.

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

Jump to bottom

Enhance documentation of .spec.startingDeadlineSeconds #9296

Merged
merged 8 commits into from
Jul 19, 2018
Merged

Enhance documentation of .spec.startingDeadlineSeconds #9296

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1513d9f
Update cron-jobs.md
heshamMassoud Jun 28, 2018
9e777c5
Update automated-tasks-with-cron-jobs.md
heshamMassoud Jun 28, 2018
29f12d7
Update cron-jobs.md
heshamMassoud Jun 28, 2018
f4f5f03
Reword added documentation and add info about error message.
heshamMassoud Jul 9, 2018
c32c1a5
Fix grammatical typo.
heshamMassoud Jul 9, 2018
23a1bca
adjust grammar and punctuation
chenopis Jul 18, 2018
b3e315d
adjust grammar and punctuation
chenopis Jul 18, 2018
bef0c57
adjust tense
chenopis Jul 18, 2018
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
8 changes: 4 additions & 4 deletions content/en/docs/concepts/workloads/controllers/cron-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ If `startingDeadlineSeconds` is set to a large value or left unset (the default)
and if `concurrencyPolicy` is set to `Allow`, the jobs will always run
at least once.

Jobs may fail to run if the CronJob controller is not running or broken for a
span of time from before the start time of the CronJob to start time plus
`startingDeadlineSeconds`, or if the span covers multiple start times and
`concurrencyPolicy` does not allow concurrency.
For every CronJob, the CronJob controller checks how many schedules it missed in the duration from its last scheduled time till now. If there are more than 100 missed schedules, then it doesn't start the job. This would mean that, for example, If `concurrencyPolicy` does not allow concurrency, a job will be counted as missed if it was attempted to be scheduled when there was a previously scheduled cronjob still running.

It is important to note, that if the field `startingDeadlineSeconds` is set (not `nil`), it will count how many missed jobs occurred from the value of `startingDeadlineSeconds` till now. For example, if `startingDeadlineSeconds` is `200`, It will count how many missed jobs occurred in the last 200 seconds.
Copy link
Member

Choose a reason for hiding this comment

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

when you say "count" do you mean "count as Failed"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ericat If a cronjob was to be scheduled at a certain point in time, but the controller didn't schedule it for some reason. I explained it a bit more here: f4f5f03


For example, suppose a cron job is set to start at exactly `08:30:00` and its
`startingDeadlineSeconds` is set to 10, if the CronJob controller happens to
be down from `08:29:00` to `08:42:00`, the job will not start.
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ After the deadline, the cron job does not start the job.
Jobs that do not meet their deadline in this way count as failed jobs.
If this field is not specified, the jobs have no deadline.

It is important to note, that if the field `.spec.startingDeadlineSeconds` is set (not nil), the CronJob controller will count how many missed jobs occurred from the value of `.spec.startingDeadlineSeconds` till now. For example, if it set to `200`, It will count how many missed schedules occurred in the last 200 seconds. If there were more than a 100 missed schedules, the cronjob will not be scheduled.

### Concurrency Policy

The `.spec.concurrencyPolicy` field is also optional.
Expand Down