Job Reference

September 28, 2020 ยท View on GitHub

Job

Schedule for a list of tasks

PropertyDescriptionRequired
scheduleCron-style job scheduleYes
timezoneTimezone for scheduleNo
enabledWhen false job will not executeNo
run_on_initRun job on startNo
on_errorList of notifier names to send task errors toNo
tasksList of task names for this jobYes

schedule

Cron-style job schedule. The main difference from the vanilla cron syntax is that the finest granularity is seconds instead of minutes. For more information checkout the node-cron documentation

schedule: '*/10 * * * * *' # Run every 10 seconds

timezone

IANA Timezone to adjust the schedule time to. Default is to use the host time

timezone: America/Toronto

enabled

When false job will not execute. Default value is true

enabled: false

run_on_init

Run job on daemon startup. Default value is false

run_on_init: true

on_error

List of notifier names to send task errors to

tasks:
  - notifier1
  - notifier2
  - notifier3

tasks

List of task names for this job. All tasks will be executed sequentially

tasks:
  - task1
  - task2
  - task3