2.2 KiB
layout | page_title | sidebar_current | description |
---|---|---|---|
docs | periodic Stanza - Job Specification | docs-job-specification-periodic | The "periodic" stanza allows a job to run at fixed times, dates, or intervals. The easiest way to think about the periodic scheduler is "Nomad cron" or "distributed cron". |
periodic
Stanza
Placement |
job -> **periodic**
|
---|
The periodic
stanza allows a job to run at fixed times, dates, or intervals.
The easiest way to think about the periodic scheduler is "Nomad cron" or
"distributed cron".
job "docs" {
periodic {
cron = "*/15 * * * * *"
prohibit_overlap = true
}
}
The periodic expression is always evaluated in the UTC timezone to ensure consistent evaluation when Nomad spans multiple time zones.
periodic
Requirements
- The job's scheduler type must be
batch
.
periodic
Parameters
-
cron
(string: <required>)
- Specifies a cron expression configuring the interval to launch the job. In addition to cron-specific formats, this option also includes predefined expressions such as@daily
or@weekly
. -
prohibit_overlap
(bool: false)
- Specifies if this job should wait until previous instances of this job have completed. This only applies to this job; it does not prevent other periodic jobs from running at the same time. -
time_zone
(string: "UTC")
- Specifies the time zone to evaluate the next launch interval against. This is useful when wanting to account for day light savings in various time zones. The time zone must be parsable by Golang's LoadLocation.
periodic
Examples
The following examples only show the periodic
stanzas. Remember that the
periodic
stanza is only valid in the placements listed above.
Run Daily
This example shows running a periodic job daily:
periodic {
cron = "@daily"
}