schedule Block
This feature requires Nomad Enterprise(opens in new tab).
Placement | job -> group -> task -> periodic |
Note: Time based task execution is an experimental feature and subject to change. This feature is supported for select customers. Please refer to the Upgrade Guide to find breaking changes.
Time based task execution is enabled by using the schedule
block. The
schedule
block controls when a task is allowed to be running.
Unlike periodic
jobs, the schedule
block applies to individual
tasks. The Nomad Client starts and stops tasks at the specified time without
interaction with the Nomad Servers. This means time based task execution works
even when a Client is disconnected from Servers. The task's resources remain
allocated even outside the schedule
when the task itself is stopped.
schedule
Parameters
The schedule
block must have a cron
block containing:
start
(string: <required>)
- When the task should be started. Specified in 6 field cron format (no seconds) without,
or/
characters.end
(string: <required>)
- When the task should be stopped (kill_signal
andkill_timeout
apply). Specified in 2 field cron format (minute and hour) without,
or/
characters.timezone
(string: "Local")
- What time zone thestart
andend
times are specified in. Defaults to the local time zone of the Nomad Client the job is scheduled onto.
Limitations
Job deployments outside of the specified
schedule
will be unable to succeed. To update a job using time based task execution outside of its schedule, do a force update.Overnight schedules are currently not supported. Adjusting the
timezone
should allow converting overnight schedules to times within a single day.