debian-mirror-gitlab/doc/operations/incident_management/oncall_schedules.md

122 lines
4.4 KiB
Markdown
Raw Normal View History

2021-04-29 21:17:54 +05:30
---
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-04-29 21:17:54 +05:30
---
# On-call Schedule Management **(PREMIUM)**
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in GitLab 13.11.
2021-04-29 21:17:54 +05:30
Use on-call schedule management to create schedules for responders to rotate on-call
responsibilities. Maintain the availability of your software services by putting your teams on-call.
2022-05-07 20:08:51 +05:30
With [escalation policies](escalation_policies.md) and on-call schedules, your team is notified immediately
when things go wrong so they can quickly respond to service outages and disruptions.
2021-04-29 21:17:54 +05:30
2021-10-27 15:23:28 +05:30
To use on-call schedules:
2021-04-29 21:17:54 +05:30
1. [Create a schedule](#schedules).
1. [Add a rotation to the schedule](#rotations).
## Schedules
Set up an on-call schedule for your team to add rotations to.
2021-10-27 15:23:28 +05:30
Prerequisite:
2022-04-04 11:22:00 +05:30
- You must have at least the Maintainer role.
2021-10-27 15:23:28 +05:30
To create an on-call schedule:
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-10-27 15:23:28 +05:30
1. On the left sidebar, select **Monitor > On-call Schedules**.
1. Select **Add a schedule**.
2021-11-18 22:05:49 +05:30
1. Enter the schedule's name and description and select a time zone.
2021-10-27 15:23:28 +05:30
1. Select **Add schedule**.
2021-04-29 21:17:54 +05:30
You now have an empty schedule with no rotations. This renders as an empty state, prompting you to
create [rotations](#rotations) for your schedule.
![Schedule Empty Grid](img/oncall_schedule_empty_grid_v13_10.png)
### Edit a schedule
2021-10-27 15:23:28 +05:30
To update a schedule:
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-10-27 15:23:28 +05:30
1. On the left sidebar, select **Monitor > On-call Schedules**.
1. Select **Edit schedule** (**{pencil}**).
1. Edit the information.
1. Select **Save changes**.
2021-04-29 21:17:54 +05:30
If you change the schedule's time zone, GitLab automatically updates the rotation's restricted time
interval (if one is set) to the corresponding times in the new time zone.
### Delete a schedule
2021-10-27 15:23:28 +05:30
To delete a schedule:
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-10-27 15:23:28 +05:30
1. On the left sidebar, select **Monitor > On-call Schedules**.
1. Select **Delete escalation policy** (**{remove}**).
1. On the confirmation dialog, select **Delete schedule**.
2021-04-29 21:17:54 +05:30
## Rotations
Add rotations to an existing schedule to put your team members on-call.
2021-10-27 15:23:28 +05:30
To create a rotation:
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-10-27 15:23:28 +05:30
1. On the left sidebar, select **Monitor > On-call Schedules**.
1. Select the **Add a rotation** link.
1. Enter the following information:
2021-04-29 21:17:54 +05:30
- **Name:** Your rotation's name.
- **Participants:** The people you want in the rotation.
- **Rotation length:** The rotation's duration.
- **Starts on:** The date and time the rotation begins.
2021-10-27 15:23:28 +05:30
- **Enable end date:** With the toggle on, you can select the date and time your rotation
2021-04-29 21:17:54 +05:30
ends.
2021-10-27 15:23:28 +05:30
- **Restrict to time intervals:** With the toggle on, you can restrict your rotation to the
2021-04-29 21:17:54 +05:30
time period you select.
### Edit a rotation
2021-10-27 15:23:28 +05:30
To edit a rotation:
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-10-27 15:23:28 +05:30
1. On the left sidebar, select **Monitor > On-call Schedules**.
1. In the **Rotations** section, select **Edit rotation** (**{pencil}**).
1. Edit the information.
1. Select **Save changes**.
2021-04-29 21:17:54 +05:30
### Delete a rotation
2021-10-27 15:23:28 +05:30
To delete a rotation:
2021-04-29 21:17:54 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-10-27 15:23:28 +05:30
1. On the left sidebar, select **Monitor > On-call Schedules**.
1. In the **Rotations** section, select **Delete rotation** (**{remove}**).
1. On the confirmation dialog, select **Delete rotation**.
2021-04-29 21:17:54 +05:30
## View schedule rotations
You can view the on-call schedules of a single day or two weeks. To switch between these time
periods, select the **1 day** or **2 weeks** buttons on the schedule. Two weeks is the default view.
Hover over any rotation shift participants in the schedule to view their individual shift details.
![1 Day Grid View](img/oncall_schedule_day_grid_v13_10.png)
## Page an on-call responder
2022-05-07 20:08:51 +05:30
See [Paging](paging.md#paging) for more details.
2021-06-08 01:23:25 +05:30
## Removal or deletion of on-call user
If an on-call user is removed from the project or group, or their account is deleted, the
confirmation modal displays the list of that user's on-call schedules. If the user's removal or
deletion is confirmed, GitLab recalculates the on-call rotation and sends an email to the project
owners and the rotation's participants.