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:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-03-16 21:18:33 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-03-16 21:18:33 +0300
commitf64a639bcfa1fc2bc89ca7db268f594306edfd7c (patch)
treea2c3c2ebcc3b45e596949db485d6ed18ffaacfa1 /doc/operations
parentbfbc3e0d6583ea1a91f627528bedc3d65ba4b10f (diff)
Add latest changes from gitlab-org/gitlab@13-10-stable-eev13.10.0-rc40
Diffstat (limited to 'doc/operations')
-rw-r--r--doc/operations/feature_flags.md6
-rw-r--r--doc/operations/incident_management/img/custom_alert_mapping_v13_10.pngbin0 -> 100141 bytes
-rw-r--r--doc/operations/incident_management/incidents.md2
-rw-r--r--doc/operations/incident_management/integrations.md35
-rw-r--r--doc/operations/incident_management/paging.md12
-rw-r--r--doc/operations/incident_management/status_page.md2
-rw-r--r--doc/operations/metrics/dashboards/variables.md2
-rw-r--r--doc/operations/metrics/embed.md4
-rw-r--r--doc/operations/metrics/embed_grafana.md101
-rw-r--r--doc/operations/metrics/img/grafana_embedded.pngbin28071 -> 0 bytes
-rw-r--r--doc/operations/metrics/img/grafana_live_embed.pngbin44603 -> 0 bytes
-rw-r--r--doc/operations/metrics/img/grafana_panel_v12_5.pngbin44193 -> 0 bytes
-rw-r--r--doc/operations/metrics/img/grafana_sharing_dialog_v12_5.pngbin41203 -> 0 bytes
-rw-r--r--doc/operations/metrics/img/http_proxy_access_v12_5.pngbin47813 -> 0 bytes
-rw-r--r--doc/operations/metrics/img/select_query_variables_v12_5.pngbin7368 -> 0 bytes
15 files changed, 90 insertions, 74 deletions
diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md
index f23880554a6..216e6adcdaf 100644
--- a/doc/operations/feature_flags.md
+++ b/doc/operations/feature_flags.md
@@ -79,8 +79,8 @@ is 200. For GitLab SaaS, the maximum number is determined by [tier](https://abou
You can apply a feature flag strategy across multiple environments, without defining
the strategy multiple times.
-GitLab Feature Flags use [Unleash](https://unleash.github.io) as the feature flag
-engine. In Unleash, there are [strategies](https://unleash.github.io/docs/activation_strategy)
+GitLab Feature Flags use [Unleash](https://docs.getunleash.io/) as the feature flag
+engine. In Unleash, there are [strategies](https://docs.getunleash.io/docs/activation_strategy)
for granular feature flag controls. GitLab Feature Flags can have multiple strategies,
and the supported strategies are:
@@ -95,7 +95,7 @@ and clicking **{pencil}** (edit).
### All users
-Enables the feature for all users. It uses the [`default`](https://unleash.github.io/docs/activation_strategy#default)
+Enables the feature for all users. It uses the [`default`](https://docs.getunleash.io/docs/activation_strategy#default)
Unleash activation strategy.
### Percent Rollout
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
new file mode 100644
index 00000000000..b2527d3a298
--- /dev/null
+++ b/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png
Binary files differ
diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md
index f0bb9a8e950..317797376fc 100644
--- a/doc/operations/incident_management/incidents.md
+++ b/doc/operations/incident_management/incidents.md
@@ -54,7 +54,7 @@ With Maintainer or higher [permissions](../../user/permissions.md), you can enab
1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**.
1. Check the **Create an incident** checkbox.
1. To customize the incident, select an
- [issue template](../../user/project/description_templates.md#creating-issue-templates).
+ [issue template](../../user/project/description_templates.md#create-an-issue-template).
1. To send [an email notification](paging.md#email-notifications) to users
with [Developer permissions](../../user/permissions.md), select
**Send a separate email notification to Developers**. Email notifications are
diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md
index b3e7d9c544d..62a50255dd8 100644
--- a/doc/operations/incident_management/integrations.md
+++ b/doc/operations/incident_management/integrations.md
@@ -4,7 +4,7 @@ group: Health
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
---
-# Alert integrations **(FREE)**
+# Integrations **(FREE)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13203) in GitLab Ultimate 12.4.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) to GitLab Free in 12.8.
@@ -57,19 +57,36 @@ and you can [customize the payload](#customize-the-alert-payload-outside-of-gitl
1. Expand the **Alerts** 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. Name the integration.
- 1. Toggle the **Active** alert setting to display the **URL** and **Authorization Key**
- for the webhook configuration. You must also input the URL and Authorization Key
- in your external service.
- 1. _(Optional)_ To generate a test alert to test the new integration, enter a
- sample payload, then click **Save and test alert payload**. Valid JSON is required.
- 1. Click **Save 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.
+ You must also input the URL and Authorization Key in your external service.
+ 1. _(Optional)_ To map fields from your monitoring tool's alert to GitLab fields, enter a sample
+ payload and click **Parse payload for custom mapping**. Valid JSON is required. If you update
+ a sample payload, you must also remap the fields.
+
+ 1. _(Optional)_ If you provided a valid sample payload, select each value in
+ **Payload alert key** to [map to a **GitLab alert key**](#map-fields-in-custom-alerts).
+ 1. To save your integration, click **Save Integration**. If desired, you can send a test alert
+ from your integration's **Send test alert** tab after the integration is created.
The new HTTP Endpoint displays in the [integrations list](#integrations-list).
-You can edit the integration by selecting the **{pencil}** pencil icon on the right
+You can edit the integration by selecting the **{settings}** settings icon on the right
side of the integrations list.
+#### Map fields in custom alerts
+
+> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4443) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.10.
+
+You can integrate your monitoring tool's alert format with GitLab alerts. To show the
+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)
+
### External Prometheus integration
For GitLab versions 13.1 and greater, read
@@ -79,7 +96,7 @@ to configure alerts for this integration.
## Customize the alert payload outside of GitLab
For all integration types, you can customize the payload by sending the following
-parameters. All fields are optional. If the incoming alert does not contain a value for the `Title` field, a default value of `New: Incident` will be applied.
+parameters. All fields are optional. If the incoming alert does not contain a value for the `Title` field, a default value of `New: Alert` will be applied.
| Property | Type | Description |
| ------------------------- | --------------- | ----------- |
diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md
index dd04cd63a54..4801f94d494 100644
--- a/doc/operations/incident_management/paging.md
+++ b/doc/operations/incident_management/paging.md
@@ -23,14 +23,12 @@ you never miss a page.
## Email notifications
-Email notifications are available in projects that have been
-[configured to create incidents automatically](incidents.md#create-incidents-automatically)
-for triggered alerts. Project members with the **Owner** or **Maintainer** roles are
-sent an email notification automatically. (This is not configurable.) To optionally
-send additional email notifications to project members with the **Developer** role:
+Email notifications are available in projects for triggered alerts. Project
+members with the **Owner** or **Maintainer** roles have the option to receive
+a single email notification for new alerts.
1. Navigate to **Settings > Operations**.
1. Expand the **Incidents** section.
-1. In the **Alert Integration** tab, select the **Send a separate email notification to Developers**
- check box.
+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**.
diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md
index fe0bfa3318b..46f0a6f278c 100644
--- a/doc/operations/incident_management/status_page.md
+++ b/doc/operations/incident_management/status_page.md
@@ -80,7 +80,7 @@ the necessary CI/CD variables to deploy the Status Page to AWS S3:
- `AWS_DEFAULT_REGION` - The AWS region.
- `AWS_ACCESS_KEY_ID` - The AWS access key ID.
- `AWS_SECRET_ACCESS_KEY` - The AWS secret.
-1. Navigate to **CI / CD > Pipelines > Run Pipeline**, and run the pipeline to
+1. Navigate to **CI/CD > Pipelines > Run Pipeline**, and run the pipeline to
deploy the Status Page to S3.
WARNING:
diff --git a/doc/operations/metrics/dashboards/variables.md b/doc/operations/metrics/dashboards/variables.md
index c0d0f65cc65..df2dd0939bb 100644
--- a/doc/operations/metrics/dashboards/variables.md
+++ b/doc/operations/metrics/dashboards/variables.md
@@ -16,7 +16,7 @@ Queries that continue to use the old format display no data.
## Predefined variables
-GitLab supports a limited set of [CI variables](../../../ci/variables/README.md)
+GitLab supports a limited set of [CI/CD variables](../../../ci/variables/README.md)
in the Prometheus query. This is particularly useful for identifying a specific
environment, for example with `ci_environment_slug`. Variables for Prometheus queries
must be lowercase. The supported variables are:
diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md
index e5ab391afe5..87d84bfdfc0 100644
--- a/doc/operations/metrics/embed.md
+++ b/doc/operations/metrics/embed.md
@@ -4,10 +4,10 @@ group: Health
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
---
-# Embedding metric charts within GitLab-flavored Markdown **(FREE)**
+# Embedding metric charts within GitLab Flavored Markdown **(FREE)**
You can display metrics charts within
-[GitLab Flavored Markdown](../../user/markdown.md#gitlab-flavored-markdown-gfm)
+[GitLab Flavored Markdown](../../user/markdown.md#gitlab-flavored-markdown)
fields such as issue or merge request descriptions. The maximum number of embedded
charts allowed in a GitLab Flavored Markdown field is 100.
Embedding charts is useful when sharing an application incident or performance
diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md
index f9db3750bb9..2548e81813b 100644
--- a/doc/operations/metrics/embed_grafana.md
+++ b/doc/operations/metrics/embed_grafana.md
@@ -4,75 +4,76 @@ group: Health
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
---
-# Embedding Grafana charts **(FREE)**
+# Embed Grafana panels in Markdown **(FREE)**
-Grafana metrics can be embedded in [GitLab Flavored Markdown](../../user/markdown.md).
+Grafana panels can be embedded in [GitLab Flavored Markdown](../../user/markdown.md). You can
+embed Grafana panels using either:
-## Embedding charts via Grafana rendered images
+- [Grafana-rendered images](#use-grafana-rendered-images).
+- [Grafana API](#use-integration-with-grafana-api).
-You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html)
-charts in issues as a
-[direct linked rendered image](https://grafana.com/docs/grafana/latest/reference/share_panel/#direct-link-rendered-image). Your Grafana instance must be available to the
-target user, either as a public dashboard or on the same network. The
-**Direct link rendered image** sharing dialog within Grafana provides the link:
+## Use Grafana-rendered images
-![Grafana Direct Linked Rendered Image](img/grafana_live_embed.png)
+You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html) panels as a
+[direct linked rendered image](https://grafana.com/docs/grafana/latest/reference/share_panel/#direct-link-rendered-image).
+Your Grafana instance must:
-For this embed to display correctly, the
+- Be available to the target user, either as a public dashboard or on the same network.
+- Have [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer) installed.
-Copy the link and add an image tag as [inline HTML](../../user/markdown.md#inline-html)
-in your Markdown. You can tweak the query parameters to meet your needs, such as
-removing the `&from=` and `&to=` parameters to display a live chart. Here is example
-markup for a live chart from a GitLab public dashboard:
+To use Grafana-rendered images:
-```html
-<img src="https://dashboards.gitlab.com/d/RZmbBr7mk/gitlab-triage?orgId=1&refresh=30s&var-env=gprd&var-environment=gprd&var-prometheus=prometheus-01-inf-gprd&var-prometheus_app=prometheus-app-01-inf-gprd&var-backend=All&var-type=All&var-stage=main&from=1580444107655&to=1580465707655"/>
-```
+1. Go to the dashboard containing the panel in Grafana.
+1. From the panel's menu, select **Share**.
+1. Select the **Direct link rendered image** button, which provides the link.
+1. Copy the link and add an image tag as [inline HTML](../../user/markdown.md#inline-html) in your
+ Markdown in the format `<img src="your_link"/>`. You can tweak the query parameters to meet your needs, such as removing the `&from=`
+ and `&to=` parameters to display a live panel.
-This markup renders a graph of `5xx` errors, like this:
-
-![Grafana dashboard embedded preview](img/grafana_embedded.png)
-
-## Embedding charts via integration with Grafana HTTP API
+## Use integration with Grafana API
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31376) in GitLab 12.5.
-Each project can support integration with one Grafana instance. This configuration
-enables you to copy a link to a panel in Grafana, then paste it into a GitLab Markdown
-field. The chart renders in the GitLab chart format. To embed charts
-from a Grafana instance, the data source must:
+Each project can support integration with one Grafana instance. This enables you to copy a link to a
+panel in Grafana, then paste it into a GitLab Markdown field. The panel renders in the GitLab panel
+format. To embed panels from a Grafana instance, the data source must be:
-1. Be a Prometheus instance.
-1. Be proxyable, so the HTTP Access setting should be set to `Server`:
+- A Prometheus instance.
+- Proxyable, so the **HTTP > Access** setting for the Grafana data source should be set to
+ **Server (default)**.
- ![HTTP Proxy Access](img/http_proxy_access_v12_5.png)
+### Set up Grafana integration
-## Setting up the Grafana integration
+To set up the Grafana API in Grafana:
1. In Grafana, [generate an Admin-level API Token](https://grafana.com/docs/grafana/latest/http_api/auth/#create-api-token).
-1. In your GitLab project, navigate to **Settings > Operations > Grafana Authentication**.
+1. In your GitLab project, go to **Settings > Operations** and expand the **Grafana authentication**
+ section.
1. To enable the integration, check the **Active** checkbox.
1. For **Grafana URL**, enter the base URL of the Grafana instance.
-1. For **API Token**, enter the Admin API Token you just generated.
+1. For **API Token**, enter the Admin API token you just generated.
1. Click **Save Changes**.
-## Generating a link to a chart
+### Generate a link to a panel
+
+To generate a link to a panel:
-1. In Grafana, navigate to the dashboard you wish to embed a panel from.
- ![Grafana Metric Panel](img/grafana_panel_v12_5.png)
-1. In the upper-left corner of the page, select a specific value for each variable
- required for the queries in the chart.
- ![Select Query Variables](img/select_query_variables_v12_5.png)
-1. In Grafana, click on a panel's title, then click **Share** to open the panel's
- sharing dialog to the **Link** tab. If you click the _dashboard's_ share panel
- instead, GitLab attempts to embed the first supported panel on the dashboard (if available).
+1. In Grafana, go to the dashboard you wish to embed a panel from.
+1. In the upper-left corner of the page, select a specific value for each variable required for the
+ queries in the dashboard.
+1. In Grafana click on a panel's title, then click **Share** to open the panel's sharing dialog to
+ the **Link** tab.
+
+ If you click the dashboard's share button instead, GitLab attempts to embed the first supported
+ panel on the dashboard (if available).
1. If your Prometheus queries use Grafana's custom template variables, ensure the
- **Template variables** option is toggled to **On**. Of Grafana global template
- variables, only `$__interval`, `$__from`, and `$__to` are supported.
-1. Toggle **On** the **Current time range** option to specify the time range of
- the chart. Otherwise, the default range is the last 8 hours.
- ![Grafana Sharing Dialog](img/grafana_sharing_dialog_v12_5.png)
-1. Click **Copy** to copy the URL to the clipboard.
-1. In GitLab, paste the URL into a Markdown field and save. The chart takes a few
- moments to render.
- ![GitLab Rendered Grafana Panel](img/rendered_grafana_embed_v12_5.png)
+ **Template variables** option is set to on. Only the Grafana global template variables
+ `$__interval`, `$__from`, and `$__to` are supported.
+1. Set the **Current time range** option to on, to specify the time range of the panel. Otherwise,
+ the default range is the last 8 hours.
+1. Select **Copy** to copy the URL to the clipboard.
+1. In GitLab, paste the URL into a Markdown field and save. The panel takes a few moments to render.
+
+See the following example of a rendered panel.
+
+![GitLab Rendered Grafana Panel](img/rendered_grafana_embed_v12_5.png)
diff --git a/doc/operations/metrics/img/grafana_embedded.png b/doc/operations/metrics/img/grafana_embedded.png
deleted file mode 100644
index c7946aa4b10..00000000000
--- a/doc/operations/metrics/img/grafana_embedded.png
+++ /dev/null
Binary files differ
diff --git a/doc/operations/metrics/img/grafana_live_embed.png b/doc/operations/metrics/img/grafana_live_embed.png
deleted file mode 100644
index 91970cd379a..00000000000
--- a/doc/operations/metrics/img/grafana_live_embed.png
+++ /dev/null
Binary files differ
diff --git a/doc/operations/metrics/img/grafana_panel_v12_5.png b/doc/operations/metrics/img/grafana_panel_v12_5.png
deleted file mode 100644
index 18c17b910cd..00000000000
--- a/doc/operations/metrics/img/grafana_panel_v12_5.png
+++ /dev/null
Binary files differ
diff --git a/doc/operations/metrics/img/grafana_sharing_dialog_v12_5.png b/doc/operations/metrics/img/grafana_sharing_dialog_v12_5.png
deleted file mode 100644
index fae62dd50df..00000000000
--- a/doc/operations/metrics/img/grafana_sharing_dialog_v12_5.png
+++ /dev/null
Binary files differ
diff --git a/doc/operations/metrics/img/http_proxy_access_v12_5.png b/doc/operations/metrics/img/http_proxy_access_v12_5.png
deleted file mode 100644
index 0036a916a12..00000000000
--- a/doc/operations/metrics/img/http_proxy_access_v12_5.png
+++ /dev/null
Binary files differ
diff --git a/doc/operations/metrics/img/select_query_variables_v12_5.png b/doc/operations/metrics/img/select_query_variables_v12_5.png
deleted file mode 100644
index 23503577327..00000000000
--- a/doc/operations/metrics/img/select_query_variables_v12_5.png
+++ /dev/null
Binary files differ