| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 1 | :title: Timer Driver |
| 2 | |
| 3 | Timer |
| 4 | ===== |
| 5 | |
| 6 | The timer driver supports triggers only. It is used for configuring |
| 7 | pipelines so that jobs run at scheduled times. No connection |
| 8 | configuration is required. |
| 9 | |
| 10 | Trgger Configuration |
| 11 | -------------------- |
| 12 | |
| 13 | Timers don't require a special connection or driver. Instead they can |
| James E. Blair | e9a0f9d | 2017-08-04 08:45:53 -0700 | [diff] [blame] | 14 | simply be used by listing ``timer`` as the trigger. |
| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 15 | |
| James E. Blair | e9a0f9d | 2017-08-04 08:45:53 -0700 | [diff] [blame] | 16 | This trigger will run based on a cron-style time specification. It |
| 17 | will enqueue an event into its pipeline for every project defined in |
| 18 | the configuration. Any job associated with the pipeline will run in |
| 19 | response to that event. |
| James E. Blair | eff5a9d | 2017-06-20 00:00:37 -0700 | [diff] [blame] | 20 | |
| James E. Blair | e9a0f9d | 2017-08-04 08:45:53 -0700 | [diff] [blame] | 21 | .. attr:: pipeline.trigger.timer |
| 22 | |
| 23 | The timer trigger supports the following attributes: |
| 24 | |
| 25 | .. attr:: time |
| 26 | :required: |
| 27 | |
| 28 | The time specification in cron syntax. Only the 5 part syntax |
| 29 | is supported, not the symbolic names. Example: ``0 0 * * *`` |
| 30 | runs at midnight. The first weekday is Monday. |