@@ -180,7 +180,7 @@ are listed in the descriptions of the relevant settings.
...
@@ -180,7 +180,7 @@ are listed in the descriptions of the relevant settings.
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | :------: | ----------- |
| --------- | ---- | :------: | ----------- |
| `admin_notification_email` | string | no | Abuse reports will be sent to this address if it is set. Abuse reports are always available in the admin area. |
| `admin_notification_email` | string | no | Abuse reports will be sent to this address if it is set. Abuse reports are always available in the Admin Area. |
| `after_sign_out_path` | string | no | Where to redirect users after logout. |
| `after_sign_out_path` | string | no | Where to redirect users after logout. |
| `after_sign_up_text` | string | no | Text shown to the user after signing up |
| `after_sign_up_text` | string | no | Text shown to the user after signing up |
| `akismet_api_key` | string | required by: `akismet_enabled` | API key for Akismet spam protection. |
| `akismet_api_key` | string | required by: `akismet_enabled` | API key for Akismet spam protection. |
**For a single node Elasticsearch cluster the functional cluster health status will be yellow** (will never be green) because the primary shard is allocated but replicas can not be as there is no other node to which Elasticsearch can assign a replica.
**For a single node Elasticsearch cluster the functional cluster health status will be yellow** (will never be green) because the primary shard is allocated but replicas can not be as there is no other node to which Elasticsearch can assign a replica.
Once the data is added to the database or repository and [Elasticsearch is
Once the data is added to the database or repository and [Elasticsearch is
enabled in the admin area](#enabling-elasticsearch) the search index will be
enabled in the Admin Area](#enabling-elasticsearch) the search index will be
updated automatically.
updated automatically.
## Elasticsearch repository indexer
## Elasticsearch repository indexer
...
@@ -201,7 +201,7 @@ To backfill existing data, you can use one of the methods below to index it in b
...
@@ -201,7 +201,7 @@ To backfill existing data, you can use one of the methods below to index it in b
> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/15390) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/15390) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3.
To index via the admin area:
To index via the Admin Area:
1.[Configure your Elasticsearch host and port](#enabling-elasticsearch).
1.[Configure your Elasticsearch host and port](#enabling-elasticsearch).
1. Create empty indexes using one of the following commands:
1. Create empty indexes using one of the following commands:
@@ -184,7 +184,7 @@ The Auto DevOps base domain is required if you want to make use of
...
@@ -184,7 +184,7 @@ The Auto DevOps base domain is required if you want to make use of
places:
places:
- either under the cluster's settings, whether for [projects](../../user/project/clusters/index.md#base-domain) or [groups](../../user/group/clusters/index.md#base-domain)
- either under the cluster's settings, whether for [projects](../../user/project/clusters/index.md#base-domain) or [groups](../../user/group/clusters/index.md#base-domain)
- or in instance-wide settings in the **admin area > Settings** under the "Continuous Integration and Delivery" section
- or in instance-wide settings in the **Admin Area > Settings** under the "Continuous Integration and Delivery" section
- or at the project level as a variable: `KUBE_INGRESS_BASE_DOMAIN`
- or at the project level as a variable: `KUBE_INGRESS_BASE_DOMAIN`
- or at the group level as a variable: `KUBE_INGRESS_BASE_DOMAIN`.
- or at the group level as a variable: `KUBE_INGRESS_BASE_DOMAIN`.
...
@@ -263,7 +263,7 @@ the subgroup or project.
...
@@ -263,7 +263,7 @@ the subgroup or project.
Even when disabled at the instance level, group owners and project maintainers can still enable
Even when disabled at the instance level, group owners and project maintainers can still enable
Auto DevOps at the group and project level, respectively.
Auto DevOps at the group and project level, respectively.
1. Go to **Admin area > Settings > Continuous Integration and Deployment**.
1. Go to **Admin Area > Settings > Continuous Integration and Deployment**.
1. Toggle the checkbox labeled **Default to Auto DevOps pipeline for all projects**.
1. Toggle the checkbox labeled **Default to Auto DevOps pipeline for all projects**.
1. If enabling, optionally set up the Auto DevOps [base domain](#auto-devops-base-domain) which will be used for Auto Deploy and Auto Review Apps.
1. If enabling, optionally set up the Auto DevOps [base domain](#auto-devops-base-domain) which will be used for Auto Deploy and Auto Review Apps.
1. Click **Save changes** for the changes to take effect.
1. Click **Save changes** for the changes to take effect.
GitLab Inc. will periodically collect information about your instance in order
GitLab Inc. will periodically collect information about your instance in order
to perform various actions.
to perform various actions.
All statistics are opt-out, you can enable/disable them from the admin panel
All statistics are opt-out. You can enable/disable them in the
under **Admin area > Settings > Metrics and profiling > Usage statistics**.
**Admin Area > Settings > Metrics and profiling** section **Usage statistics**.
## Version Check **(CORE ONLY)**
## Version Check **(CORE ONLY)**
...
@@ -31,7 +31,7 @@ patches will need to be backported, making sure active GitLab instances remain
...
@@ -31,7 +31,7 @@ patches will need to be backported, making sure active GitLab instances remain
secure.
secure.
If you disable version check, this information will not be collected. Enable or
If you disable version check, this information will not be collected. Enable or
disable the version check at **Admin area > Settings > Metrics and profiling > Usage statistics**.
disable the version check in **Admin Area > Settings > Metrics and profiling > Usage statistics**.
### Request flow example
### Request flow example
...
@@ -64,9 +64,9 @@ of the instance.
...
@@ -64,9 +64,9 @@ of the instance.
You can view the exact JSON payload in the administration panel. To view the payload:
You can view the exact JSON payload in the administration panel. To view the payload:
1.Go to the **Admin area** (spanner symbol on the top bar).
1.Navigate to the **Admin Area > Settings > Metrics and profiling**.
1. Expand **Settings** in the left sidebar and click on **Metrics and profiling**.
1. Expand the **Usage statistics** section.
1.Expand **Usage statistics** and click on the **Preview payload** button.
1.Click the **Preview payload** button.
You can see how [the usage ping data maps to different stages of the product](https://gitlab.com/gitlab-data/analytics/blob/master/transform/snowflake-dbt/data/version_usage_stats_to_stage_mappings.csv).
You can see how [the usage ping data maps to different stages of the product](https://gitlab.com/gitlab-data/analytics/blob/master/transform/snowflake-dbt/data/version_usage_stats_to_stage_mappings.csv).
...
@@ -125,8 +125,8 @@ Once usage ping is enabled, GitLab will gather data from other instances and
...
@@ -125,8 +125,8 @@ Once usage ping is enabled, GitLab will gather data from other instances and
will be able to show [usage statistics](../../instance_statistics/index.md)
will be able to show [usage statistics](../../instance_statistics/index.md)
of your instance to your users.
of your instance to your users.
This can be restricted to admins by selecting "Only admins" in the Instance
To make this visible only to admins, go to **Admin Area > Settings > Metrics and profiling**, expand
Statistics visibility section under **Admin area > Settings > Metrics and profiling > Usage statistics**.
**Usage statistics**, and set the **Instance Statistics visibility** option to **Only admins**.