Merge pull request #25078 from shekhar-rajak/92636_cron_syntax
Add basic cron syntax in documentationpull/25783/head
commit
c6db174ca9
|
@ -49,6 +49,37 @@ This example CronJob manifest prints the current time and a hello message every
|
||||||
([Running Automated Tasks with a CronJob](/docs/tasks/job/automated-tasks-with-cron-jobs/)
|
([Running Automated Tasks with a CronJob](/docs/tasks/job/automated-tasks-with-cron-jobs/)
|
||||||
takes you through this example in more detail).
|
takes you through this example in more detail).
|
||||||
|
|
||||||
|
### Cron schedule syntax
|
||||||
|
|
||||||
|
```
|
||||||
|
# ┌───────────── minute (0 - 59)
|
||||||
|
# │ ┌───────────── hour (0 - 23)
|
||||||
|
# │ │ ┌───────────── day of the month (1 - 31)
|
||||||
|
# │ │ │ ┌───────────── month (1 - 12)
|
||||||
|
# │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday;
|
||||||
|
# │ │ │ │ │ 7 is also Sunday on some systems)
|
||||||
|
# │ │ │ │ │
|
||||||
|
# │ │ │ │ │
|
||||||
|
# * * * * *
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
| Entry | Description | Equivalent to |
|
||||||
|
| ------------- | ------------- |------------- |
|
||||||
|
| @yearly (or @annually) | Run once a year at midnight of 1 January | 0 0 1 1 * |
|
||||||
|
| @monthly | Run once a month at midnight of the first day of the month | 0 0 1 * * |
|
||||||
|
| @weekly | Run once a week at midnight on Sunday morning | 0 0 * * 0 |
|
||||||
|
| @daily (or @midnight) | Run once a day at midnight | 0 0 * * * |
|
||||||
|
| @hourly | Run once an hour at the beginning of the hour | 0 * * * * |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
For example, the line below states that the task must be started every Friday at midnight, as well as on the 13th of each month at midnight:
|
||||||
|
|
||||||
|
`0 0 13 * 5`
|
||||||
|
|
||||||
|
To generate CronJob schedule expressions, you can also use web tools like [crontab.guru](https://crontab.guru/).
|
||||||
|
|
||||||
## CronJob limitations {#cron-job-limitations}
|
## CronJob limitations {#cron-job-limitations}
|
||||||
|
|
||||||
A cron job creates a job object _about_ once per execution time of its schedule. We say "about" because there
|
A cron job creates a job object _about_ once per execution time of its schedule. We say "about" because there
|
||||||
|
|
Loading…
Reference in New Issue