Commit de412e29 authored by Suzanne Selhorn's avatar Suzanne Selhorn Committed by Russell Dickenson

Removed references to admin wrench

parent 1b70d217
...@@ -143,7 +143,7 @@ Instance events do not include group or project audit events. ...@@ -143,7 +143,7 @@ Instance events do not include group or project audit events.
To view the server-wide audit events: To view the server-wide audit events:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Audit Events**. 1. On the left sidebar, select **Monitoring > Audit Events**.
The following user actions are recorded: The following user actions are recorded:
...@@ -249,7 +249,7 @@ audit events. ...@@ -249,7 +249,7 @@ audit events.
To export the Audit Events to CSV: To export the Audit Events to CSV:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Audit Events**. 1. On the left sidebar, select **Monitoring > Audit Events**.
1. Select the available search [filters](#search). 1. Select the available search [filters](#search).
1. Select **Export as CSV**. 1. Select **Export as CSV**.
......
...@@ -57,7 +57,7 @@ helpful: ...@@ -57,7 +57,7 @@ helpful:
To create an Auditor user: To create an Auditor user:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Users**. 1. On the left sidebar, select **Overview > Users**.
1. Create a new user or edit an existing one, and in the **Access** section 1. Create a new user or edit an existing one, and in the **Access** section
select Auditor. select Auditor.
......
...@@ -705,7 +705,7 @@ When enabled, the following applies: ...@@ -705,7 +705,7 @@ When enabled, the following applies:
To enable it you need to: To enable it you need to:
1. [Enable LDAP](#configuration) 1. [Enable LDAP](#configuration)
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings > General**.
1. Expand the **Visibility and access controls** section. 1. Expand the **Visibility and access controls** section.
1. Ensure the **Lock memberships to LDAP synchronization** checkbox is selected. 1. Ensure the **Lock memberships to LDAP synchronization** checkbox is selected.
......
...@@ -145,7 +145,7 @@ may see the following message: `Access denied for your LDAP account`. ...@@ -145,7 +145,7 @@ may see the following message: `Access denied for your LDAP account`.
We have a workaround, based on toggling the access level of affected users: We have a workaround, based on toggling the access level of affected users:
1. As an administrator, on the top bar, select **Menu >** **{admin}** **Admin**. 1. As an administrator, on the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Users**. 1. On the left sidebar, select **Overview > Users**.
1. Select the name of the affected user. 1. Select the name of the affected user.
1. In the user's administrative page, press **Edit** on the top right of the page. 1. In the user's administrative page, press **Edit** on the top right of the page.
...@@ -203,7 +203,7 @@ field contains no data: ...@@ -203,7 +203,7 @@ field contains no data:
To resolve this: To resolve this:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, go to **Settings > General**. 1. On the left sidebar, go to **Settings > General**.
1. Expand both of the following: 1. Expand both of the following:
- **Account and limit**. - **Account and limit**.
...@@ -348,7 +348,7 @@ things to check to debug the situation. ...@@ -348,7 +348,7 @@ things to check to debug the situation.
group](index.md#adding-group-links). group](index.md#adding-group-links).
- Check that the user has an LDAP identity: - Check that the user has an LDAP identity:
1. Sign in to GitLab as an administrator user. 1. Sign in to GitLab as an administrator user.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Users**. 1. On the left sidebar, select **Overview > Users**.
1. Search for the user. 1. Search for the user.
1. Open the user by clicking their name. Do not click **Edit**. 1. Open the user by clicking their name. Do not click **Edit**.
......
...@@ -60,7 +60,7 @@ Feature.enable('geo_repository_verification') ...@@ -60,7 +60,7 @@ Feature.enable('geo_repository_verification')
On the **primary** node: On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Expand **Verification information** tab for that node to view automatic checksumming 1. Expand **Verification information** tab for that node to view automatic checksumming
status for repositories and wikis. Successes are shown in green, pending work status for repositories and wikis. Successes are shown in green, pending work
...@@ -70,7 +70,7 @@ On the **primary** node: ...@@ -70,7 +70,7 @@ On the **primary** node:
On the **secondary** node: On the **secondary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Expand **Verification information** tab for that node to view automatic checksumming 1. Expand **Verification information** tab for that node to view automatic checksumming
status for repositories and wikis. Successes are shown in green, pending work status for repositories and wikis. Successes are shown in green, pending work
...@@ -100,7 +100,7 @@ increase load and vice versa. ...@@ -100,7 +100,7 @@ increase load and vice versa.
On the **primary** node: On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Select **Edit** for the **primary** node to customize the minimum 1. Select **Edit** for the **primary** node to customize the minimum
re-verification interval: re-verification interval:
...@@ -151,7 +151,7 @@ sudo gitlab-rake geo:verification:wiki:reset ...@@ -151,7 +151,7 @@ sudo gitlab-rake geo:verification:wiki:reset
If the **primary** and **secondary** nodes have a checksum verification mismatch, the cause may not be apparent. To find the cause of a checksum mismatch: If the **primary** and **secondary** nodes have a checksum verification mismatch, the cause may not be apparent. To find the cause of a checksum mismatch:
1. On the **primary** node: 1. On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Projects**. 1. On the left sidebar, select **Overview > Projects**.
1. Find the project that you want to check the checksum differences and 1. Find the project that you want to check the checksum differences and
select its name. select its name.
......
...@@ -111,7 +111,7 @@ ensure these processes are close to 100% as possible during active use. ...@@ -111,7 +111,7 @@ ensure these processes are close to 100% as possible during active use.
On the **secondary** node: On the **secondary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
Replicated objects (shown in green) should be close to 100%, Replicated objects (shown in green) should be close to 100%,
and there should be no failures (shown in red). If a large proportion of and there should be no failures (shown in red). If a large proportion of
...@@ -139,7 +139,7 @@ This [content was moved to another location](background_verification.md). ...@@ -139,7 +139,7 @@ This [content was moved to another location](background_verification.md).
On the **primary** node: On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Messages**. 1. On the left sidebar, select **Messages**.
1. Add a message notifying users on the maintenance window. 1. Add a message notifying users on the maintenance window.
You can check under **Geo > Nodes** to estimate how long it You can check under **Geo > Nodes** to estimate how long it
...@@ -152,7 +152,7 @@ To ensure that all data is replicated to a secondary site, updates (write reques ...@@ -152,7 +152,7 @@ To ensure that all data is replicated to a secondary site, updates (write reques
be disabled on the **primary** site: be disabled on the **primary** site:
1. Enable [maintenance mode](../../maintenance_mode/index.md) on the **primary** node. 1. Enable [maintenance mode](../../maintenance_mode/index.md) on the **primary** node.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Cron**. 1. On the Sidekiq dashboard, select **Cron**.
1. Select `Disable All` to disable non-Geo periodic background jobs. 1. Select `Disable All` to disable non-Geo periodic background jobs.
...@@ -165,7 +165,7 @@ be disabled on the **primary** site: ...@@ -165,7 +165,7 @@ be disabled on the **primary** site:
1. If you are manually replicating any data not managed by Geo, trigger the 1. If you are manually replicating any data not managed by Geo, trigger the
final replication process now. final replication process now.
1. On the **primary** node: 1. On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Queues**, and wait for all queues except 1. On the Sidekiq dashboard, select **Queues**, and wait for all queues except
those with `geo` in the name to drop to 0. those with `geo` in the name to drop to 0.
...@@ -180,7 +180,7 @@ be disabled on the **primary** site: ...@@ -180,7 +180,7 @@ be disabled on the **primary** site:
- The Geo log cursor is up to date (0 events behind). - The Geo log cursor is up to date (0 events behind).
1. On the **secondary** node: 1. On the **secondary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Queues**, and wait for all the `geo` 1. On the Sidekiq dashboard, select **Queues**, and wait for all the `geo`
queues to drop to 0 queued and 0 running jobs. queues to drop to 0 queued and 0 running jobs.
......
...@@ -65,7 +65,7 @@ promote a Geo replica and perform a failover. ...@@ -65,7 +65,7 @@ promote a Geo replica and perform a failover.
On the **secondary** node: On the **secondary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes** to see its status. 1. On the left sidebar, select **Geo > Nodes** to see its status.
Replicated objects (shown in green) should be close to 100%, Replicated objects (shown in green) should be close to 100%,
and there should be no failures (shown in red). If a large proportion of and there should be no failures (shown in red). If a large proportion of
...@@ -130,7 +130,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -130,7 +130,7 @@ follow these steps to avoid unnecessary data loss:
connection. connection.
1. On the **primary** node: 1. On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dhasboard, select **Cron**. 1. On the Sidekiq dhasboard, select **Cron**.
1. Select `Disable All` to disable any non-Geo periodic background jobs. 1. Select `Disable All` to disable any non-Geo periodic background jobs.
...@@ -148,7 +148,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -148,7 +148,7 @@ follow these steps to avoid unnecessary data loss:
[data not managed by Geo](../../replication/datatypes.md#limitations-on-replicationverification), [data not managed by Geo](../../replication/datatypes.md#limitations-on-replicationverification),
trigger the final replication process now. trigger the final replication process now.
1. On the **primary** node: 1. On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Queues**, and wait for all queues except 1. On the Sidekiq dashboard, select **Queues**, and wait for all queues except
those with `geo` in the name to drop to 0. those with `geo` in the name to drop to 0.
...@@ -163,7 +163,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -163,7 +163,7 @@ follow these steps to avoid unnecessary data loss:
- The Geo log cursor is up to date (0 events behind). - The Geo log cursor is up to date (0 events behind).
1. On the **secondary** node: 1. On the **secondary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Queues**, and wait for all the `geo` 1. On the Sidekiq dashboard, select **Queues**, and wait for all the `geo`
queues to drop to 0 queued and 0 running jobs. queues to drop to 0 queued and 0 running jobs.
......
...@@ -115,7 +115,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -115,7 +115,7 @@ follow these steps to avoid unnecessary data loss:
connection. connection.
1. On the **primary** node: 1. On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dhasboard, select **Cron**. 1. On the Sidekiq dhasboard, select **Cron**.
1. Select `Disable All` to disable any non-Geo periodic background jobs. 1. Select `Disable All` to disable any non-Geo periodic background jobs.
...@@ -133,7 +133,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -133,7 +133,7 @@ follow these steps to avoid unnecessary data loss:
[data not managed by Geo](../../replication/datatypes.md#limitations-on-replicationverification), [data not managed by Geo](../../replication/datatypes.md#limitations-on-replicationverification),
trigger the final replication process now. trigger the final replication process now.
1. On the **primary** node: 1. On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Queues**, and wait for all queues except 1. On the Sidekiq dashboard, select **Queues**, and wait for all queues except
those with `geo` in the name to drop to 0. those with `geo` in the name to drop to 0.
...@@ -148,7 +148,7 @@ follow these steps to avoid unnecessary data loss: ...@@ -148,7 +148,7 @@ follow these steps to avoid unnecessary data loss:
- The Geo log cursor is up to date (0 events behind). - The Geo log cursor is up to date (0 events behind).
1. On the **secondary** node: 1. On the **secondary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. On the Sidekiq dashboard, select **Queues**, and wait for all the `geo` 1. On the Sidekiq dashboard, select **Queues**, and wait for all the `geo`
queues to drop to 0 queued and 0 running jobs. queues to drop to 0 queued and 0 running jobs.
......
...@@ -199,7 +199,7 @@ keys must be manually replicated to the **secondary** site. ...@@ -199,7 +199,7 @@ keys must be manually replicated to the **secondary** site.
gitlab-ctl reconfigure gitlab-ctl reconfigure
``` ```
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Sites**. 1. On the left sidebar, select **Geo > Sites**.
1. Select **New site**. 1. Select **New site**.
![Add secondary site](img/adding_a_secondary_v13_3.png) ![Add secondary site](img/adding_a_secondary_v13_3.png)
...@@ -257,7 +257,7 @@ method to be enabled. This is enabled by default, but if converting an existing ...@@ -257,7 +257,7 @@ method to be enabled. This is enabled by default, but if converting an existing
On the **primary** site: On the **primary** site:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings > General**.
1. Expand **Visibility and access controls**. 1. Expand **Visibility and access controls**.
1. Ensure "Enabled Git access protocols" is set to either "Both SSH and HTTP(S)" or "Only HTTP(S)". 1. Ensure "Enabled Git access protocols" is set to either "Both SSH and HTTP(S)" or "Only HTTP(S)".
...@@ -267,7 +267,7 @@ On the **primary** site: ...@@ -267,7 +267,7 @@ On the **primary** site:
You can sign in to the **secondary** site with the same credentials you used with You can sign in to the **secondary** site with the same credentials you used with
the **primary** site. After you sign in: the **primary** site. After you sign in:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Sites**. 1. On the left sidebar, select **Geo > Sites**.
1. Verify that it's correctly identified as a **secondary** Geo site, and that 1. Verify that it's correctly identified as a **secondary** Geo site, and that
Geo is enabled. Geo is enabled.
......
...@@ -36,7 +36,7 @@ to do that. ...@@ -36,7 +36,7 @@ to do that.
To remove the **primary** site: To remove the **primary** site:
1. [Remove all secondary Geo sites](remove_geo_site.md) 1. [Remove all secondary Geo sites](remove_geo_site.md)
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Select **Remove** for the **primary** node. 1. Select **Remove** for the **primary** node.
1. Confirm by selecting **Remove** when the prompt appears. 1. Confirm by selecting **Remove** when the prompt appears.
......
...@@ -130,7 +130,7 @@ For each application and Sidekiq node on the **secondary** site: ...@@ -130,7 +130,7 @@ For each application and Sidekiq node on the **secondary** site:
To verify Container Registry replication is working, on the **secondary** site: To verify Container Registry replication is working, on the **secondary** site:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
The initial replication, or "backfill", is probably still in progress. The initial replication, or "backfill", is probably still in progress.
......
...@@ -42,7 +42,7 @@ whether they are stored on the local file system or in object storage. ...@@ -42,7 +42,7 @@ whether they are stored on the local file system or in object storage.
To enable GitLab replication: To enable GitLab replication:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Select **Edit** on the **secondary** site. 1. Select **Edit** on the **secondary** site.
1. In the **Synchronization Settings** section, find the **Allow this secondary node to replicate content on Object Storage** 1. In the **Synchronization Settings** section, find the **Allow this secondary node to replicate content on Object Storage**
......
...@@ -9,7 +9,7 @@ type: howto ...@@ -9,7 +9,7 @@ type: howto
**Secondary** sites can be removed from the Geo cluster using the Geo administration page of the **primary** site. To remove a **secondary** site: **Secondary** sites can be removed from the Geo cluster using the Geo administration page of the **primary** site. To remove a **secondary** site:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Select the **Remove** button for the **secondary** site you want to remove. 1. Select the **Remove** button for the **secondary** site you want to remove.
1. Confirm by selecting **Remove** when the prompt appears. 1. Confirm by selecting **Remove** when the prompt appears.
......
...@@ -27,7 +27,7 @@ Before attempting more advanced troubleshooting: ...@@ -27,7 +27,7 @@ Before attempting more advanced troubleshooting:
On the **primary** node: On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
We perform the following health checks on each **secondary** node We perform the following health checks on each **secondary** node
...@@ -610,7 +610,7 @@ to start again from scratch, there are a few steps that can help you: ...@@ -610,7 +610,7 @@ to start again from scratch, there are a few steps that can help you:
### Design repository failures on mirrored projects and project imports ### Design repository failures on mirrored projects and project imports
On the top bar, under **Menu >** **{admin}** **Admin > Geo > Nodes**, On the top bar, under **Menu > Admin > Geo > Nodes**,
if the Design repositories progress bar shows if the Design repositories progress bar shows
`Synced` and `Failed` greater than 100%, and negative `Queued`, then the instance `Synced` and `Failed` greater than 100%, and negative `Queued`, then the instance
is likely affected by is likely affected by
...@@ -836,7 +836,7 @@ node's URL matches its external URL. ...@@ -836,7 +836,7 @@ node's URL matches its external URL.
On the **primary** node: On the **primary** node:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Find the affected **secondary** site and select **Edit**. 1. Find the affected **secondary** site and select **Edit**.
1. Ensure the **URL** field matches the value found in `/etc/gitlab/gitlab.rb` 1. Ensure the **URL** field matches the value found in `/etc/gitlab/gitlab.rb`
......
...@@ -14,7 +14,7 @@ in the background. ...@@ -14,7 +14,7 @@ in the background.
On the **primary** site: On the **primary** site:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Geo > Nodes**. 1. On the left sidebar, select **Geo > Nodes**.
1. Select **Edit** of the secondary node you want to tune. 1. Select **Edit** of the secondary node you want to tune.
1. Under **Tuning settings**, there are several variables that can be tuned to 1. Under **Tuning settings**, there are several variables that can be tuned to
......
...@@ -995,7 +995,7 @@ Particular attention should be shown to: ...@@ -995,7 +995,7 @@ Particular attention should be shown to:
1. Check that the Praefect storage is configured to store new repositories: 1. Check that the Praefect storage is configured to store new repositories:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Repository**. 1. On the left sidebar, select **Settings > Repository**.
1. Expand the **Repository storage** section. 1. Expand the **Repository storage** section.
......
...@@ -23,7 +23,7 @@ See also [Gitaly timeout](../../user/admin_area/settings/gitaly_timeouts.md) set ...@@ -23,7 +23,7 @@ See also [Gitaly timeout](../../user/admin_area/settings/gitaly_timeouts.md) set
When using standalone Gitaly servers, you must make sure they are the same version When using standalone Gitaly servers, you must make sure they are the same version
as GitLab to ensure full compatibility: as GitLab to ensure full compatibility:
1. On the top bar, select **Menu >** **{admin}** **Admin** on your GitLab instance. 1. On the top bar, select **Menu > Admin** on your GitLab instance.
1. On the left sidebar, select **Overview > Gitaly Servers**. 1. On the left sidebar, select **Overview > Gitaly Servers**.
1. Confirm all Gitaly servers indicate that they are up to date. 1. Confirm all Gitaly servers indicate that they are up to date.
......
...@@ -27,7 +27,7 @@ GitLab automatically runs `git gc` and `git repack` on repositories after Git pu ...@@ -27,7 +27,7 @@ GitLab automatically runs `git gc` and `git repack` on repositories after Git pu
You can change how often this happens or turn it off: You can change how often this happens or turn it off:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Repository**. 1. On the left sidebar, select **Settings > Repository**.
1. Expand **Repository maintenance**. 1. Expand **Repository maintenance**.
1. In the **Housekeeping** section, configure the [housekeeping options](#housekeeping-options). 1. In the **Housekeeping** section, configure the [housekeeping options](#housekeeping-options).
......
...@@ -56,7 +56,7 @@ read the [Kroki installation](https://docs.kroki.io/kroki/setup/install/#_images ...@@ -56,7 +56,7 @@ read the [Kroki installation](https://docs.kroki.io/kroki/setup/install/#_images
You need to enable Kroki integration from Settings under Admin Area. You need to enable Kroki integration from Settings under Admin Area.
To do that, log in with an administrator account and follow these steps: To do that, log in with an administrator account and follow these steps:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. Go to **Settings > General**. 1. Go to **Settings > General**.
1. Expand the **Kroki** section. 1. Expand the **Kroki** section.
1. Select **Enable Kroki** checkbox. 1. Select **Enable Kroki** checkbox.
......
...@@ -206,7 +206,7 @@ stop; ...@@ -206,7 +206,7 @@ stop;
After configuring your local PlantUML server, you're ready to enable the PlantUML integration: After configuring your local PlantUML server, you're ready to enable the PlantUML integration:
1. Sign in to GitLab as an [Administrator](../../user/permissions.md) user. 1. Sign in to GitLab as an [Administrator](../../user/permissions.md) user.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. In the left sidebar, go to **Settings > General** and expand the **PlantUML** section. 1. In the left sidebar, go to **Settings > General** and expand the **PlantUML** section.
1. Select the **Enable PlantUML** checkbox. 1. Select the **Enable PlantUML** checkbox.
1. Set the PlantUML instance as `https://gitlab.example.com/-/plantuml/`, 1. Set the PlantUML instance as `https://gitlab.example.com/-/plantuml/`,
......
...@@ -100,7 +100,7 @@ they receive a `Connection failed` message. ...@@ -100,7 +100,7 @@ they receive a `Connection failed` message.
By default, terminal sessions do not expire. To limit the terminal session By default, terminal sessions do not expire. To limit the terminal session
lifetime in your GitLab instance: lifetime in your GitLab instance:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. Select 1. Select
[**Settings > Web terminal**](../../user/admin_area/settings/index.md#general). [**Settings > Web terminal**](../../user/admin_area/settings/index.md#general).
1. Set a `max session time`. 1. Set a `max session time`.
...@@ -21,7 +21,7 @@ Maintenance Mode allows most external actions that do not change internal state. ...@@ -21,7 +21,7 @@ Maintenance Mode allows most external actions that do not change internal state.
There are three ways to enable Maintenance Mode as an administrator: There are three ways to enable Maintenance Mode as an administrator:
- **Web UI**: - **Web UI**:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings > General**.
1. Expand **Maintenance Mode**, and toggle **Enable Maintenance Mode**. 1. Expand **Maintenance Mode**, and toggle **Enable Maintenance Mode**.
You can optionally add a message for the banner as well. You can optionally add a message for the banner as well.
...@@ -45,7 +45,7 @@ There are three ways to enable Maintenance Mode as an administrator: ...@@ -45,7 +45,7 @@ There are three ways to enable Maintenance Mode as an administrator:
There are three ways to disable Maintenance Mode: There are three ways to disable Maintenance Mode:
- **Web UI**: - **Web UI**:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings > General**.
1. Expand **Maintenance Mode**, and toggle **Enable Maintenance Mode**. 1. Expand **Maintenance Mode**, and toggle **Enable Maintenance Mode**.
You can optionally add a message for the banner as well. You can optionally add a message for the banner as well.
...@@ -171,7 +171,7 @@ it is recommended that you disable all cron jobs except for those related to Geo ...@@ -171,7 +171,7 @@ it is recommended that you disable all cron jobs except for those related to Geo
To monitor queues and disable jobs: To monitor queues and disable jobs:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
### Incident management ### Incident management
......
...@@ -34,7 +34,7 @@ This project can be used to: ...@@ -34,7 +34,7 @@ This project can be used to:
## Create the self monitoring project ## Create the self monitoring project
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling** and expand **Self monitoring**. 1. On the left sidebar, select **Settings > Metrics and profiling** and expand **Self monitoring**.
1. Toggle **Self monitoring** on. 1. Toggle **Self monitoring** on.
1. After your GitLab instance creates the project, GitLab displays a link to the 1. After your GitLab instance creates the project, GitLab displays a link to the
...@@ -47,7 +47,7 @@ WARNING: ...@@ -47,7 +47,7 @@ WARNING:
Deleting the self monitoring project removes any changes made to the project. If Deleting the self monitoring project removes any changes made to the project. If
you create the project again, it's created in its default state. you create the project again, it's created in its default state.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, go to **Settings > Metrics and profiling** and expand **Self monitoring**. 1. On the left sidebar, go to **Settings > Metrics and profiling** and expand **Self monitoring**.
1. Toggle **Self monitoring** off. 1. Toggle **Self monitoring** off.
1. In the confirmation dialog that opens, click **Delete self monitoring project**. 1. In the confirmation dialog that opens, click **Delete self monitoring project**.
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
GitLab Performance Monitoring is disabled by default. To enable it and change any of its GitLab Performance Monitoring is disabled by default. To enable it and change any of its
settings: settings:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling** 1. On the left sidebar, select **Settings > Metrics and profiling**
(`/admin/application_settings/metrics_and_profiling`). (`/admin/application_settings/metrics_and_profiling`).
1. Add the necessary configuration changes. 1. Add the necessary configuration changes.
......
...@@ -62,7 +62,7 @@ repository. ...@@ -62,7 +62,7 @@ repository.
After setting up Grafana, you can enable a link to access it easily from the After setting up Grafana, you can enable a link to access it easily from the
GitLab sidebar: GitLab sidebar:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling** 1. On the left sidebar, select **Settings > Metrics and profiling**
and expand **Metrics - Grafana**. and expand **Metrics - Grafana**.
1. Select the **Add a link to Grafana** checkbox. 1. Select the **Add a link to Grafana** checkbox.
...@@ -79,7 +79,7 @@ GitLab displays your link in the **Menu > Admin > Monitoring > Metrics Dashboard ...@@ -79,7 +79,7 @@ GitLab displays your link in the **Menu > Admin > Monitoring > Metrics Dashboard
> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5822) in GitLab 13.10. > [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5822) in GitLab 13.10.
When setting up Grafana through the process above, no scope shows in the screen at When setting up Grafana through the process above, no scope shows in the screen at
**Menu >** **{admin}** **Admin > Applications > GitLab Grafana**. However, the `read_user` scope is **Menu > Admin > Applications > GitLab Grafana**. However, the `read_user` scope is
required and is provided to the application automatically. Setting any scope other than required and is provided to the application automatically. Setting any scope other than
`read_user` without also including `read_user` leads to this error when you try to log in using `read_user` without also including `read_user` leads to this error when you try to log in using
GitLab as the OAuth provider: GitLab as the OAuth provider:
......
...@@ -104,7 +104,7 @@ The performance bar is disabled by default for non-administrators. To enable it ...@@ -104,7 +104,7 @@ The performance bar is disabled by default for non-administrators. To enable it
for a given group: for a given group:
1. Sign in as a user with Administrator [role](../../../user/permissions.md). 1. Sign in as a user with Administrator [role](../../../user/permissions.md).
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling** 1. On the left sidebar, select **Settings > Metrics and profiling**
(`admin/application_settings/metrics_and_profiling`), and expand (`admin/application_settings/metrics_and_profiling`), and expand
**Profiling - Performance bar**. **Profiling - Performance bar**.
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
To enable the GitLab Prometheus metrics: To enable the GitLab Prometheus metrics:
1. Log in to GitLab as a user with Administrator [role](../../../user/permissions.md). 1. Log in to GitLab as a user with Administrator [role](../../../user/permissions.md).
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**. 1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Find the **Metrics - Prometheus** section, and select **Add link to Prometheus**. 1. Find the **Metrics - Prometheus** section, and select **Add link to Prometheus**.
1. [Restart GitLab](../../restart_gitlab.md#omnibus-gitlab-restart) for the changes to take effect. 1. [Restart GitLab](../../restart_gitlab.md#omnibus-gitlab-restart) for the changes to take effect.
......
...@@ -90,7 +90,7 @@ To start multiple processes: ...@@ -90,7 +90,7 @@ To start multiple processes:
To view the Sidekiq processes in GitLab: To view the Sidekiq processes in GitLab:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
## Negate settings ## Negate settings
......
...@@ -106,7 +106,7 @@ users as long as a large file exists. ...@@ -106,7 +106,7 @@ users as long as a large file exists.
To disable any more writes to the `authorized_keys` file: To disable any more writes to the `authorized_keys` file:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Network**. 1. On the left sidebar, select **Settings > Network**.
1. Expand **Performance optimization**. 1. Expand **Performance optimization**.
1. Clear the **Write to "authorized_keys" file** checkbox. 1. Clear the **Write to "authorized_keys" file** checkbox.
......
...@@ -393,7 +393,7 @@ adding a GitLab-controlled verification code to the DNS records for that domain. ...@@ -393,7 +393,7 @@ adding a GitLab-controlled verification code to the DNS records for that domain.
If your user base is private or otherwise trusted, you can disable the If your user base is private or otherwise trusted, you can disable the
verification requirement: verification requirement:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**. 1. On the left sidebar, select **Settings > Preferences**.
1. Expand **Pages**. 1. Expand **Pages**.
1. Clear the **Require users to prove ownership of custom domains** checkbox. 1. Clear the **Require users to prove ownership of custom domains** checkbox.
...@@ -410,7 +410,7 @@ sites served under a custom domain. ...@@ -410,7 +410,7 @@ sites served under a custom domain.
To enable it: To enable it:
1. Choose an email address on which you want to receive notifications about expiring domains. 1. Choose an email address on which you want to receive notifications about expiring domains.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**. 1. On the left sidebar, select **Settings > Preferences**.
1. Expand **Pages**. 1. Expand **Pages**.
1. Enter the email address for receiving notifications and accept Let's Encrypt's Terms of Service. 1. Enter the email address for receiving notifications and accept Let's Encrypt's Terms of Service.
...@@ -465,7 +465,7 @@ pre-existing applications must modify the GitLab Pages OAuth application. Follow ...@@ -465,7 +465,7 @@ pre-existing applications must modify the GitLab Pages OAuth application. Follow
this: this:
1. Enable [access control](#access-control). 1. Enable [access control](#access-control).
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Applications**. 1. On the left sidebar, select **Settings > Applications**.
1. Expand **GitLab Pages**. 1. Expand **GitLab Pages**.
1. Clear the `api` scope's checkbox and select the desired scope's checkbox (for example, 1. Clear the `api` scope's checkbox and select the desired scope's checkbox (for example,
...@@ -484,7 +484,7 @@ This can be useful to preserve information published with Pages websites to the ...@@ -484,7 +484,7 @@ This can be useful to preserve information published with Pages websites to the
of your instance only. of your instance only.
To do that: To do that:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**. 1. On the left sidebar, select **Settings > Preferences**.
1. Expand **Pages**. 1. Expand **Pages**.
1. Select the **Disable public access to Pages sites** checkbox. 1. Select the **Disable public access to Pages sites** checkbox.
...@@ -665,7 +665,7 @@ Follow the steps below to configure the proxy listener of GitLab Pages. ...@@ -665,7 +665,7 @@ Follow the steps below to configure the proxy listener of GitLab Pages.
To set the global maximum pages size for a project: To set the global maximum pages size for a project:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**. 1. On the left sidebar, select **Settings > Preferences**.
1. Expand **Pages**. 1. Expand **Pages**.
1. Edit the **Maximum size of pages**. 1. Edit the **Maximum size of pages**.
...@@ -1309,7 +1309,7 @@ Upgrading to an [officially supported operating system](https://about.gitlab.com ...@@ -1309,7 +1309,7 @@ Upgrading to an [officially supported operating system](https://about.gitlab.com
This problem comes from the permissions of the GitLab Pages OAuth application. To fix it: This problem comes from the permissions of the GitLab Pages OAuth application. To fix it:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Applications > GitLab Pages**. 1. On the left sidebar, select **Applications > GitLab Pages**.
1. Edit the application. 1. Edit the application.
1. Under **Scopes**, ensure that the `api` scope is selected. 1. Under **Scopes**, ensure that the `api` scope is selected.
......
...@@ -473,7 +473,7 @@ The default for the maximum size of unpacked archives per project is 100 MB. ...@@ -473,7 +473,7 @@ The default for the maximum size of unpacked archives per project is 100 MB.
To change this value: To change this value:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**. 1. On the left sidebar, select **Settings > Preferences**.
1. Expand **Pages**. 1. Expand **Pages**.
1. Update the value for **Maximum size of pages (MB)**. 1. Update the value for **Maximum size of pages (MB)**.
......
...@@ -26,7 +26,7 @@ The default value (`1`) is recommended for the majority of GitLab installations. ...@@ -26,7 +26,7 @@ The default value (`1`) is recommended for the majority of GitLab installations.
To adjust the polling interval multiplier: To adjust the polling interval multiplier:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**. 1. On the left sidebar, select **Settings > Preferences**.
1. Expand **Polling interval multiplier**. 1. Expand **Polling interval multiplier**.
1. Set a value for the polling interval multiplier. This multiplier is applied to all resources at 1. Set a value for the polling interval multiplier. This multiplier is applied to all resources at
......
...@@ -52,7 +52,7 @@ Note the following: ...@@ -52,7 +52,7 @@ Note the following:
compatible as described in the [Version history](../../user/project/settings/import_export.md#version-history). compatible as described in the [Version history](../../user/project/settings/import_export.md#version-history).
- The project import option must be enabled: - The project import option must be enabled:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**. 1. On the left sidebar, select **Settings > General**.
1. Expand **Visibility and access controls**. 1. Expand **Visibility and access controls**.
1. Under **Import sources**, check the "Project export enabled" option. 1. Under **Import sources**, check the "Project export enabled" option.
......
...@@ -109,7 +109,7 @@ sudo gitlab-rake gitlab:storage:migrate_to_hashed ID_FROM=50 ID_TO=100 ...@@ -109,7 +109,7 @@ sudo gitlab-rake gitlab:storage:migrate_to_hashed ID_FROM=50 ID_TO=100
To monitor the progress in GitLab: To monitor the progress in GitLab:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Monitoring > Background Jobs**. 1. On the left sidebar, select **Monitoring > Background Jobs**.
1. Watch how long the `hashed_storage:hashed_storage_project_migrate` queue 1. Watch how long the `hashed_storage:hashed_storage_project_migrate` queue
will take to finish. After it reaches zero, you can confirm every project will take to finish. After it reaches zero, you can confirm every project
......
...@@ -11,7 +11,7 @@ You can use [`git fsck`](https://git-scm.com/docs/git-fsck) to verify the integr ...@@ -11,7 +11,7 @@ You can use [`git fsck`](https://git-scm.com/docs/git-fsck) to verify the integr
committed to a repository. GitLab administrators can trigger this check for a project using the committed to a repository. GitLab administrators can trigger this check for a project using the
GitLab UI: GitLab UI:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Projects**. 1. On the left sidebar, select **Overview > Projects**.
1. Select the project to check. 1. Select the project to check.
1. In the **Repository check** section, select **Trigger repository check**. 1. In the **Repository check** section, select **Trigger repository check**.
...@@ -25,7 +25,7 @@ This setting is off by default, because it can cause many false alarms. ...@@ -25,7 +25,7 @@ This setting is off by default, because it can cause many false alarms.
Instead of checking repositories manually, GitLab can be configured to run the checks periodically: Instead of checking repositories manually, GitLab can be configured to run the checks periodically:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Repository** (`/admin/application_settings/repository`). 1. On the left sidebar, select **Settings > Repository** (`/admin/application_settings/repository`).
1. Expand the **Repository maintenance** section. 1. Expand the **Repository maintenance** section.
1. Enable **Enable repository checks**. 1. Enable **Enable repository checks**.
...@@ -50,7 +50,7 @@ disk at: ...@@ -50,7 +50,7 @@ disk at:
If periodic repository checks cause false alarms, you can clear all repository check states: If periodic repository checks cause false alarms, you can clear all repository check states:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Repository** (`/admin/application_settings/repository`). 1. On the left sidebar, select **Settings > Repository** (`/admin/application_settings/repository`).
1. Expand the **Repository maintenance** section. 1. Expand the **Repository maintenance** section.
1. Select **Clear all repository checks**. 1. Select **Clear all repository checks**.
......
...@@ -146,7 +146,7 @@ Omnibus stores the repositories in a `repositories` subdirectory of the `git-dat ...@@ -146,7 +146,7 @@ Omnibus stores the repositories in a `repositories` subdirectory of the `git-dat
After you [configure](#configure-repository-storage-paths) multiple repository storage paths, you After you [configure](#configure-repository-storage-paths) multiple repository storage paths, you
can choose where new repositories are stored: can choose where new repositories are stored:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Repository** and expand the **Repository storage** 1. On the left sidebar, select **Settings > Repository** and expand the **Repository storage**
section. section.
1. Enter values in the **Storage nodes for new repositories** fields. 1. Enter values in the **Storage nodes for new repositories** fields.
......
...@@ -80,7 +80,7 @@ Administrators can look up a project's hashed path from its name or ID using: ...@@ -80,7 +80,7 @@ Administrators can look up a project's hashed path from its name or ID using:
To look up a project's hash path in the Admin Area: To look up a project's hash path in the Admin Area:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Projects** and select the project. 1. On the left sidebar, select **Overview > Projects** and select the project.
The **Gitaly relative path** is displayed there and looks similar to: The **Gitaly relative path** is displayed there and looks similar to:
......
...@@ -16,7 +16,7 @@ storage such as a content delivery network (CDN). ...@@ -16,7 +16,7 @@ storage such as a content delivery network (CDN).
To configure external storage for static objects: To configure external storage for static objects:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. In the left sidebar, select **Settings > Repository**. 1. In the left sidebar, select **Settings > Repository**.
1. Expand the **External storage for repository static objects** section. 1. Expand the **External storage for repository static objects** section.
1. Enter the base URL and an arbitrary token. When you [set up external storage](#set-up-external-storage), 1. Enter the base URL and an arbitrary token. When you [set up external storage](#set-up-external-storage),
......
...@@ -196,7 +196,7 @@ Troubleshooting search result issues is rather straight forward on Elasticsearch ...@@ -196,7 +196,7 @@ Troubleshooting search result issues is rather straight forward on Elasticsearch
The first step is to confirm GitLab is using Elasticsearch for the search function. The first step is to confirm GitLab is using Elasticsearch for the search function.
To do this: To do this:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**, and then confirm the 1. On the left sidebar, select **Settings > General**, and then confirm the
integration is enabled. integration is enabled.
1. Confirm searches use Elasticsearch by accessing the rails console 1. Confirm searches use Elasticsearch by accessing the rails console
......
...@@ -29,7 +29,7 @@ in the first patch release, such as `13.10.1`. ...@@ -29,7 +29,7 @@ in the first patch release, such as `13.10.1`.
You can configure the What's new variant: You can configure the What's new variant:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Preferences**, then expand **What's new**. 1. On the left sidebar, select **Settings > Preferences**, then expand **What's new**.
1. Choose one of the following options: 1. Choose one of the following options:
......
...@@ -10,7 +10,7 @@ All methods require administrator authorization. ...@@ -10,7 +10,7 @@ All methods require administrator authorization.
You can configure the URL endpoint of the system hooks from the GitLab user interface: You can configure the URL endpoint of the system hooks from the GitLab user interface:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. Select **System Hooks** (`/admin/hooks`). 1. Select **System Hooks** (`/admin/hooks`).
Read more about [system hooks](../system_hooks/system_hooks.md). Read more about [system hooks](../system_hooks/system_hooks.md).
......
...@@ -142,7 +142,7 @@ different places. ...@@ -142,7 +142,7 @@ different places.
To view the IP address of a shared runner you must have admin access to To view the IP address of a shared runner you must have admin access to
the GitLab instance. To determine this: the GitLab instance. To determine this:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Runners**. 1. On the left sidebar, select **Overview > Runners**.
1. Find the runner in the table and view the **IP Address** column. 1. Find the runner in the table and view the **IP Address** column.
......
...@@ -228,7 +228,7 @@ You can define instance variables via the UI or [API](../../api/instance_level_c ...@@ -228,7 +228,7 @@ You can define instance variables via the UI or [API](../../api/instance_level_c
To add an instance variable: To add an instance variable:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > CI/CD** and expand the **Variables** section. 1. On the left sidebar, select **Settings > CI/CD** and expand the **Variables** section.
1. Select the **Add variable** button, and fill in the details: 1. Select the **Add variable** button, and fill in the details:
......
...@@ -24,7 +24,7 @@ brew services start jenkins ...@@ -24,7 +24,7 @@ brew services start jenkins
GitLab does not allow requests to localhost or the local network by default. When running Jenkins on your local machine, you need to enable local access. GitLab does not allow requests to localhost or the local network by default. When running Jenkins on your local machine, you need to enable local access.
1. Log into your GitLab instance as an administrator. 1. Log into your GitLab instance as an administrator.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. In the left sidebar, select **Settings > Network**. 1. In the left sidebar, select **Settings > Network**.
1. Expand **Outbound requests** and check the following checkboxes: 1. Expand **Outbound requests** and check the following checkboxes:
......
...@@ -85,7 +85,7 @@ Registration is not yet required for participation, but will be added in a futur ...@@ -85,7 +85,7 @@ Registration is not yet required for participation, but will be added in a futur
You can view the exact JSON payload sent to GitLab Inc. in the Admin Area. To view the payload: You can view the exact JSON payload sent to GitLab Inc. in the Admin Area. To view the payload:
1. Sign in as a user with the [Administrator](../../user/permissions.md) role. 1. Sign in as a user with the [Administrator](../../user/permissions.md) role.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**. 1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand the **Usage statistics** section. 1. Expand the **Usage statistics** section.
1. Select **Preview payload**. 1. Select **Preview payload**.
...@@ -107,7 +107,7 @@ configuration file. ...@@ -107,7 +107,7 @@ configuration file.
To disable Service Ping in the GitLab UI: To disable Service Ping in the GitLab UI:
1. Sign in as a user with the [Administrator](../../user/permissions.md) role. 1. Sign in as a user with the [Administrator](../../user/permissions.md) role.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**. 1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand the **Usage statistics** section. 1. Expand the **Usage statistics** section.
1. Clear the **Enable service ping** checkbox. 1. Clear the **Enable service ping** checkbox.
...@@ -494,7 +494,7 @@ checking the configuration file of your GitLab instance: ...@@ -494,7 +494,7 @@ checking the configuration file of your GitLab instance:
- Using the Admin Area: - Using the Admin Area:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**. 1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand **Usage Statistics**. 1. Expand **Usage Statistics**.
1. Are you able to check or uncheck the checkbox to disable Service Ping? 1. Are you able to check or uncheck the checkbox to disable Service Ping?
...@@ -551,7 +551,7 @@ To work around this bug, you have two options: ...@@ -551,7 +551,7 @@ To work around this bug, you have two options:
sudo gitlab-ctl reconfigure sudo gitlab-ctl reconfigure
``` ```
1. In GitLab, on the top bar, select **Menu >** **{admin}** **Admin**. 1. In GitLab, on the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**. 1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand **Usage Statistics**. 1. Expand **Usage Statistics**.
1. Clear the **Enable service ping** checkbox. 1. Clear the **Enable service ping** checkbox.
......
...@@ -53,7 +53,7 @@ Snowplow tracking is enabled on GitLab.com, and we use it for most of our tracki ...@@ -53,7 +53,7 @@ Snowplow tracking is enabled on GitLab.com, and we use it for most of our tracki
To enable Snowplow tracking on a self-managed instance: To enable Snowplow tracking on a self-managed instance:
1. On the top bar, select **Menu >** **{admin}** **Admin**, then select **Settings > General**. 1. On the top bar, select **Menu > Admin**, then select **Settings > General**.
Alternatively, go to `admin/application_settings/general` in your browser. Alternatively, go to `admin/application_settings/general` in your browser.
1. Expand **Snowplow**. 1. Expand **Snowplow**.
......
...@@ -248,7 +248,7 @@ in this section whenever you need to update GitLab. ...@@ -248,7 +248,7 @@ in this section whenever you need to update GitLab.
To determine the version of GitLab you're currently running: To determine the version of GitLab you're currently running:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Overview > Dashboard**. 1. On the left sidebar, select **Overview > Dashboard**.
1. Find the version under the **Components** table. 1. Find the version under the **Components** table.
......
...@@ -30,7 +30,7 @@ To use Akismet: ...@@ -30,7 +30,7 @@ To use Akismet:
1. Sign in or create a new account. 1. Sign in or create a new account.
1. Click **Show** to reveal the API key, and copy the API key's value. 1. Click **Show** to reveal the API key, and copy the API key's value.
1. Sign in to GitLab as an administrator. 1. Sign in to GitLab as an administrator.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. In the left sidebar, select **Settings > Reporting** (`/admin/application_settings/reporting`). 1. In the left sidebar, select **Settings > Reporting** (`/admin/application_settings/reporting`).
1. Select the **Enable Akismet** checkbox. 1. Select the **Enable Akismet** checkbox.
1. Fill in the API key from step 3. 1. Fill in the API key from step 3.
......
...@@ -27,7 +27,7 @@ project, group, or instance level: ...@@ -27,7 +27,7 @@ project, group, or instance level:
1. *For project-level or group-level integrations:* In GitLab, go to your project or group. 1. *For project-level or group-level integrations:* In GitLab, go to your project or group.
1. *For instance-level integrations:* 1. *For instance-level integrations:*
1. Sign in to GitLab as a user with the [Administrator role](../user/permissions.md). 1. Sign in to GitLab as a user with the [Administrator role](../user/permissions.md).
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. In the left sidebar, select **Settings > Integrations**. 1. In the left sidebar, select **Settings > Integrations**.
1. Scroll to **Add an integration**, and select **Datadog**. 1. Scroll to **Add an integration**, and select **Datadog**.
1. Select **Active** to enable the integration. 1. Select **Active** to enable the integration.
......
...@@ -191,7 +191,7 @@ instances](#indexing-large-instances) below. ...@@ -191,7 +191,7 @@ instances](#indexing-large-instances) below.
To enable Advanced Search, you need to have admin access to GitLab: To enable Advanced Search, you need to have admin access to GitLab:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Advanced Search**. 1. On the left sidebar, select **Settings > Advanced Search**.
NOTE: NOTE:
...@@ -286,7 +286,7 @@ You can improve the language support for Chinese and Japanese languages by utili ...@@ -286,7 +286,7 @@ You can improve the language support for Chinese and Japanese languages by utili
To enable language(s) support: To enable language(s) support:
1. Install the desired plugin(s), please refer to [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/plugins/7.9/installation.html) for plugins installation instructions. The plugin(s) must be installed on every node in the cluster, and each node must be restarted after installation. For a list of plugins, see the table later in this section. 1. Install the desired plugin(s), please refer to [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/plugins/7.9/installation.html) for plugins installation instructions. The plugin(s) must be installed on every node in the cluster, and each node must be restarted after installation. For a list of plugins, see the table later in this section.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Advanced Search**. 1. On the left sidebar, select **Settings > Advanced Search**.
1. Locate **Custom analyzers: language support**. 1. Locate **Custom analyzers: language support**.
1. Enable plugin(s) support for **Indexing**. 1. Enable plugin(s) support for **Indexing**.
...@@ -307,7 +307,7 @@ For guidance on what to install, see the following Elasticsearch language plugin ...@@ -307,7 +307,7 @@ For guidance on what to install, see the following Elasticsearch language plugin
To disable the Elasticsearch integration: To disable the Elasticsearch integration:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Advanced Search**. 1. On the left sidebar, select **Settings > Advanced Search**.
1. Uncheck **Elasticsearch indexing** and **Search with Elasticsearch enabled**. 1. Uncheck **Elasticsearch indexing** and **Search with Elasticsearch enabled**.
1. Click **Save changes** for the changes to take effect. 1. Click **Save changes** for the changes to take effect.
...@@ -339,7 +339,7 @@ index alias to it which becomes the new `primary` index. At the end, we resume t ...@@ -339,7 +339,7 @@ index alias to it which becomes the new `primary` index. At the end, we resume t
To trigger the reindexing process: To trigger the reindexing process:
1. Sign in to your GitLab instance as an administrator. 1. Sign in to your GitLab instance as an administrator.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Advanced Search**. 1. On the left sidebar, select **Settings > Advanced Search**.
1. Expand **Elasticsearch zero-downtime reindexing**. 1. Expand **Elasticsearch zero-downtime reindexing**.
1. Select **Trigger cluster reindexing**. 1. Select **Trigger cluster reindexing**.
...@@ -356,7 +356,7 @@ While the reindexing is running, you will be able to follow its progress under t ...@@ -356,7 +356,7 @@ While the reindexing is running, you will be able to follow its progress under t
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55681) in GitLab 13.12. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55681) in GitLab 13.12.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Advanced Search**. 1. On the left sidebar, select **Settings > Advanced Search**.
1. Expand **Elasticsearch zero-downtime reindexing**, and you'll 1. Expand **Elasticsearch zero-downtime reindexing**, and you'll
find the following options: find the following options:
...@@ -404,7 +404,7 @@ Sometimes, you might want to abandon the unfinished reindex job and resume the i ...@@ -404,7 +404,7 @@ Sometimes, you might want to abandon the unfinished reindex job and resume the i
bundle exec rake gitlab:elastic:mark_reindex_failed RAILS_ENV=production bundle exec rake gitlab:elastic:mark_reindex_failed RAILS_ENV=production
``` ```
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Advanced Search**. 1. On the left sidebar, select **Settings > Advanced Search**.
1. Expand **Elasticsearch zero-downtime reindexing**. 1. Expand **Elasticsearch zero-downtime reindexing**.
1. Clear the **Pause Elasticsearch indexing** checkbox. 1. Clear the **Pause Elasticsearch indexing** checkbox.
...@@ -558,7 +558,7 @@ For basic guidance on choosing a cluster configuration you may refer to [Elastic ...@@ -558,7 +558,7 @@ For basic guidance on choosing a cluster configuration you may refer to [Elastic
- A good guideline is to ensure you keep the number of shards per node below 20 per GB heap it has configured. A node with a 30GB heap should therefore have a maximum of 600 shards, but the further below this limit you can keep it the better. This will generally help the cluster stay in good health. - A good guideline is to ensure you keep the number of shards per node below 20 per GB heap it has configured. A node with a 30GB heap should therefore have a maximum of 600 shards, but the further below this limit you can keep it the better. This will generally help the cluster stay in good health.
- Number of Elasticsearch shards: - Number of Elasticsearch shards:
- Small shards result in small segments, which increases overhead. Aim to keep the average shard size between at least a few GB and a few tens of GB. - Small shards result in small segments, which increases overhead. Aim to keep the average shard size between at least a few GB and a few tens of GB.
- Another consideration is the number of documents. To determine the number of shards to use, sum the numbers in the **Menu >** **{admin}** **Admin > Dashboard > Statistics** pane (the number of documents to be indexed), divide by 5 million, and add 5. For example: - Another consideration is the number of documents. To determine the number of shards to use, sum the numbers in the **Menu > Admin > Dashboard > Statistics** pane (the number of documents to be indexed), divide by 5 million, and add 5. For example:
- If you have fewer than about 2,000,000 documents, use the default of 5 shards - If you have fewer than about 2,000,000 documents, use the default of 5 shards
- 10,000,000 documents: `10000000/5000000 + 5` = 7 shards - 10,000,000 documents: `10000000/5000000 + 5` = 7 shards
- 100,000,000 documents: `100000000/5000000 + 5` = 25 shards - 100,000,000 documents: `100000000/5000000 + 5` = 25 shards
...@@ -635,7 +635,7 @@ Sidekiq processes](../administration/operations/extra_sidekiq_processes.md). ...@@ -635,7 +635,7 @@ Sidekiq processes](../administration/operations/extra_sidekiq_processes.md).
``` ```
This enqueues a Sidekiq job for each project that needs to be indexed. This enqueues a Sidekiq job for each project that needs to be indexed.
You can view the jobs in **Menu >** **{admin}** **Admin > Monitoring > Background Jobs > Queues Tab** You can view the jobs in **Menu > Admin > Monitoring > Background Jobs > Queues Tab**
and click `elastic_commit_indexer`, or you can query indexing status using a Rake task: and click `elastic_commit_indexer`, or you can query indexing status using a Rake task:
```shell ```shell
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment