Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/operations/incident_management')
-rw-r--r--doc/operations/incident_management/alerts.md2
-rw-r--r--doc/operations/incident_management/img/custom_alert_mapping_v13_10.pngbin100141 -> 0 bytes
-rw-r--r--doc/operations/incident_management/img/custom_alert_mapping_v13_11.pngbin0 -> 16700 bytes
-rw-r--r--doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.pngbin0 -> 15722 bytes
-rw-r--r--doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.pngbin0 -> 31139 bytes
-rw-r--r--doc/operations/incident_management/incidents.md4
-rw-r--r--doc/operations/incident_management/index.md5
-rw-r--r--doc/operations/incident_management/integrations.md32
-rw-r--r--doc/operations/incident_management/oncall_schedules.md109
-rw-r--r--doc/operations/incident_management/paging.md8
-rw-r--r--doc/operations/incident_management/status_page.md2
11 files changed, 141 insertions, 21 deletions
diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md
index 3c60c737309..276009ac200 100644
--- a/doc/operations/incident_management/alerts.md
+++ b/doc/operations/incident_management/alerts.md
@@ -1,6 +1,6 @@
---
stage: Monitor
-group: Health
+group: Monitor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
diff --git a/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png b/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png
deleted file mode 100644
index b2527d3a298..00000000000
--- a/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png
+++ /dev/null
Binary files differ
diff --git a/doc/operations/incident_management/img/custom_alert_mapping_v13_11.png b/doc/operations/incident_management/img/custom_alert_mapping_v13_11.png
new file mode 100644
index 00000000000..ea097af878f
--- /dev/null
+++ b/doc/operations/incident_management/img/custom_alert_mapping_v13_11.png
Binary files differ
diff --git a/doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png b/doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png
new file mode 100644
index 00000000000..b51b7faf2d6
--- /dev/null
+++ b/doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png
Binary files differ
diff --git a/doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png b/doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png
new file mode 100644
index 00000000000..154d1b57d28
--- /dev/null
+++ b/doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png
Binary files differ
diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md
index 317797376fc..078a1a0be08 100644
--- a/doc/operations/incident_management/incidents.md
+++ b/doc/operations/incident_management/incidents.md
@@ -1,6 +1,6 @@
---
stage: Monitor
-group: Health
+group: Monitor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
@@ -39,7 +39,7 @@ Incident, you have two options to do this manually.
1. Go to **Issues > List**, and select **New issue**.
1. In the **Type** dropdown, select **Incident**. Only fields relevant to
incidents are displayed on the page.
-1. Create the incident as needed, and select **Submit issue** to save the
+1. Create the incident as needed, and select **Create issue** to save the
incident.
![Incident List Create](img/new_incident_create_v13_4.png)
diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md
index 6e285300b12..ff5f41e59e9 100644
--- a/doc/operations/incident_management/index.md
+++ b/doc/operations/incident_management/index.md
@@ -1,6 +1,6 @@
---
stage: Monitor
-group: Health
+group: Monitor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
@@ -13,6 +13,7 @@ generated by their application. By surfacing alerts and incidents where the code
being developed, efficiency and awareness can be increased. Check out the following sections for more information:
- [Integrate your monitoring tools](integrations.md).
-- Receive [notifications](paging.md) for triggered alerts.
+- Manage [on-call schedules](oncall_schedules.md) and receive [notifications](paging.md) for
+ triggered alerts.
- Triage [Alerts](alerts.md) and [Incidents](incidents.md).
- Inform stakeholders with [Status Page](status_page.md).
diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md
index 62a50255dd8..c675d995444 100644
--- a/doc/operations/incident_management/integrations.md
+++ b/doc/operations/incident_management/integrations.md
@@ -1,6 +1,6 @@
---
stage: Monitor
-group: Health
+group: Monitor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
@@ -18,10 +18,10 @@ to use this endpoint.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab Free 13.5.
-With Maintainer or higher [permissions](../../user/permissions.md), you can view
-the list of configured alerts integrations by navigating to
-**Settings > Operations** in your project's sidebar menu, and expanding **Alerts** section.
-The list displays the integration name, type, and status (enabled or disabled):
+With Maintainer or higher [permissions](../../user/permissions.md),
+you can view the list of configured alerts integrations by navigating to **Settings > Operations**
+in your project's sidebar menu, and expanding the **Alert integrations** section. The list displays
+the integration name, type, and status (enabled or disabled):
![Current Integrations](img/integrations_list_v13_5.png)
@@ -39,9 +39,11 @@ receive alert payloads in JSON format. You can always
1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md)
for a project.
1. Navigate to **Settings > Operations** in your project.
-1. Expand the **Alerts** section, and in the **Integration** dropdown menu, select **Generic**.
-1. Toggle the **Active** alert setting to display the **URL** and **Authorization Key**
- for the webhook configuration.
+1. Expand the **Alert integrations** section, and in the **Select integration type** dropdown menu,
+ select **HTTP Endpoint**.
+1. Toggle the **Active** alert setting. The URL and Authorization Key for the webhook configuration
+ are available in the **View credentials** tab after you save the integration. You must also input
+ the URL and Authorization Key in your external service.
### HTTP Endpoints **(PREMIUM)**
@@ -54,11 +56,11 @@ and you can [customize the payload](#customize-the-alert-payload-outside-of-gitl
1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md)
for a project.
1. Navigate to **Settings > Operations** in your project.
-1. Expand the **Alerts** section.
+1. Expand the **Alert integrations** section.
1. For each endpoint you want to create:
1. Click the **Add new integration** button.
- 1. In the **Integration** dropdown menu, select **HTTP Endpoint**.
+ 1. In the **Select integration type** dropdown menu, select **HTTP Endpoint**.
1. Name the integration.
1. Toggle the **Active** alert setting. The **URL** and **Authorization Key** for the webhook
configuration are available in the **View credentials** tab after you save the integration.
@@ -85,7 +87,7 @@ correct information in the [Alert list](alerts.md) and the
[Alert Details page](alerts.md#alert-details-page), map your alert's fields to
GitLab fields when you [create an HTTP endpoint](#http-endpoints):
-![Alert Management List](img/custom_alert_mapping_v13_10.png)
+![Alert Management List](img/custom_alert_mapping_v13_11.png)
### External Prometheus integration
@@ -165,9 +167,11 @@ alert to confirm your integration works properly.
1. Sign in as a user with Developer or greater [permissions](../../user/permissions.md).
1. Navigate to **Settings > Operations** in your project.
-1. Click **Alerts endpoint** to expand the section.
-1. Enter a sample payload in **Alert test payload** (valid JSON is required).
-1. Click **Test alert payload**.
+1. Click **Alert integrations** to expand the section.
+1. Click the **{settings}** settings icon on the right side of the integration in [the list](#integrations-list).
+1. Select the **Send test alert** tab to open it.
+1. Enter a test payload in the payload field (valid JSON is required).
+1. Click **Send**.
GitLab displays an error or success message, depending on the outcome of your test.
diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md
new file mode 100644
index 00000000000..87745639c69
--- /dev/null
+++ b/doc/operations/incident_management/oncall_schedules.md
@@ -0,0 +1,109 @@
+---
+stage: Monitor
+group: Monitor
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
+---
+
+# On-call Schedule Management **(PREMIUM)**
+
+> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.11.
+
+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.
+With an on-call schedule, your team is notified immediately when things go wrong so they can quickly
+respond to service outages and disruptions.
+
+To use on-call schedules, users with Maintainer [permissions](../../user/permissions.md)
+must do the following:
+
+1. [Create a schedule](#schedules).
+1. [Add a rotation to the schedule](#rotations).
+
+If you have at least Maintainer [permissions](../../user/permissions.md)
+to create a schedule, you can do this manually.
+
+## Schedules
+
+Set up an on-call schedule for your team to add rotations to.
+
+Follow these steps to create a schedule:
+
+1. Go to **Operations > On-call Schedules** and select **Add a schedule**.
+1. In the **Add schedule** form, enter the schedule's name and description, and select a timezone.
+1. Click **Add schedule**.
+
+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
+
+Follow these steps to update a schedule:
+
+1. Go to **Operations > On-call Schedules** and select the **Pencil** icon on the top right of the
+ schedule card, across from the schedule name.
+1. In the **Edit schedule** form, edit the information you wish to update.
+1. Click the **Edit schedule** button to save your changes.
+
+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
+
+Follow these steps to delete a schedule:
+
+1. Go to **Operations > On-call Schedules** and select the **Trash Can** icon on the top right of the
+ schedule card.
+1. In the **Delete schedule** window, click the **Delete schedule** button.
+
+## Rotations
+
+Add rotations to an existing schedule to put your team members on-call.
+
+Follow these steps to create a rotation:
+
+1. Go to **Operations > On-call Schedules** and select **Add a rotation** on the top right of the
+ current schedule.
+1. In the **Add rotation** form, enter the following:
+
+ - **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.
+ - **Enable end date:** With the toggle set to on, you can select the date and time your rotation
+ ends.
+ - **Restrict to time intervals:** With the toggle set to on, you can restrict your rotation to the
+ time period you select.
+
+### Edit a rotation
+
+Follow these steps to edit a rotation:
+
+1. Go to **Operations > On-call Schedules** and select the **Pencil** icon to the right of the title
+ of the rotation that you want to update.
+1. In the **Edit rotation** form, make the changes that you want.
+1. Select the **Edit rotation** button.
+
+### Delete a rotation
+
+Follow these steps to delete a rotation:
+
+1. Go to **Operations > On-call Schedules** and select the **Trash Can** icon to the right of the
+ title of the rotation that you want to delete.
+1. In the **Delete rotation** window, select the **Delete rotation** button.
+
+## 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
+
+When an alert is created in a project, GitLab sends an email to the on-call responder(s) in the
+on-call schedule for that project. If there is no schedule or no one on-call in that schedule at the
+time the alert is triggered, no email is sent.
diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md
index 4801f94d494..1588cb96218 100644
--- a/doc/operations/incident_management/paging.md
+++ b/doc/operations/incident_management/paging.md
@@ -1,6 +1,6 @@
---
stage: Monitor
-group: Health
+group: Monitor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
@@ -32,3 +32,9 @@ a single email notification for new alerts.
1. In the **Alert Integration** tab, select the checkbox
**Send a single email notification to Owners and Maintainers for new alerts**.
1. Select **Save changes**.
+
+## Paging **(PREMIUM)**
+
+In projects that have an [on-call schedule](oncall_schedules.md) configured, on-call responders are
+paged through email for triggered alerts. The on-call responder(s) receive one email for triggered
+alerts.
diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md
index 46f0a6f278c..1e11a9c62e0 100644
--- a/doc/operations/incident_management/status_page.md
+++ b/doc/operations/incident_management/status_page.md
@@ -1,6 +1,6 @@
---
stage: Monitor
-group: Health
+group: Monitor
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---