Skip to content

Commit 90c456b

Browse files
jasonodonnellJeff McCormick
authored andcommitted
Fix scheduler documentation (#548)
1 parent 5bee4ad commit 90c456b

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

hugo/content/Design/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,21 @@ Schedules are removed automatically when the configmaps are deleted.
194194

195195
PGO Scheduler uses the `UTC` timezone for all schedules.
196196

197+
### Schedule Expression Format
198+
199+
Schedules are expressed using the following rules:
200+
201+
```
202+
Field name | Mandatory? | Allowed values | Allowed special characters
203+
---------- | ---------- | -------------- | --------------------------
204+
Seconds | Yes | 0-59 | * / , -
205+
Minutes | Yes | 0-59 | * / , -
206+
Hours | Yes | 0-23 | * / , -
207+
Day of month | Yes | 1-31 | * / , - ?
208+
Month | Yes | 1-12 or JAN-DEC | * / , -
209+
Day of week | Yes | 0-6 or SUN-SAT | * / , - ?
210+
```
211+
197212
### pgBackRest Schedules
198213

199214
pgBackRest schedules require pgBackRest enabled on the cluster to backup. The scheduler

hugo/content/Operator CLI/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,12 +226,12 @@ before you do a restore.
226226

227227
#### Automated full pgBackRest backups every Sunday at 1 am
228228

229-
pgo create schedule mycluster --schedule="0 1 * * 7" \
229+
pgo create schedule mycluster --schedule="0 1 * * SUN" \
230230
--schedule-type=pgbackrest --pgbackrest-backup-type=full
231231

232-
#### Automated diff pgBackRest backups every Sunday at 1 am
232+
#### Automated diff pgBackRest backups every Monday-Saturday at 1 am
233233

234-
pgo create schedule mycluster --schedule="0 1 * * 7" \
234+
pgo create schedule mycluster --schedule="0 1 * * MON-SAT" \
235235
--schedule-type=pgbackrest --pgbackrest-backup-type=diff
236236

237237
#### Automated pgBaseBackup backups every day at 1 am

0 commit comments

Comments
 (0)