Skip to content

Commit

Permalink
feat: document new setup
Browse files Browse the repository at this point in the history
  • Loading branch information
miiila committed Jun 6, 2017
1 parent a4dd7f0 commit 06bd759
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
- `PAGERDUTY_READ_ONLY_TOKEN` is used for reading schedules and checking the overlaps.
- `SCHEDULES` array can contain one or more `SCHEDULE` items to check
- every `SCHEDULE` should have a `NOTIFICATIONS` to create incident or send message if overlap is found
- `SCHEDULE` can contain a `DAYS` key, which speficies numbers of days in UTC (0 = Sunday) for verification (`[0, 1, 2, 3, 4]` below represents days without weekend)
- `SCHEDULE` can contain a `EXCLUSION_DAYS` key, which specifies days (3 letter abb.) in form of object with optional `start` and `end` time (`hh:mm` format). If `start` or `end` is omitted, whole day is considered excluded.
Example below represents current weekend on-call setup. All datetimes are translated to UTC, so feel free to use a local time.

Currently, we only support Slack (`SLACK` with `SLACK_WEBHOOK_URL` and `CHANNEL`) and PagerDuty (`PAGERDUTY_TOKEN`) notifications.

Expand All @@ -37,7 +38,7 @@ Currently, we only support Slack (`SLACK` with `SLACK_WEBHOOK_URL` and `CHANNEL`
"NOTIFICATIONS": {
"PAGERDUTY_TOKEN": "22222222222222222222"
},
"DAYS": [0, 1, 2, 3, 4]
"EXCLUSION_DAYS": {"Fri": {"start": "16:00", "end": "23:59"}, "Sat": {}, "Sun": {"start": "00:00", "end": "16:00"}}
}]
}
```
Expand Down

0 comments on commit 06bd759

Please sign in to comment.