diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-13 18:10:17 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-13 18:10:17 +0300 |
commit | effc12bf9dac4bf1e48f1397c25e0381ac1bd76f (patch) | |
tree | e2ff447fff4e156a94b684df6edddc108a767365 /doc | |
parent | c3eeb6a8d6a4b11f0bc5e5eb1ed43b0726f1ea26 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
101 files changed, 460 insertions, 475 deletions
diff --git a/doc/administration/auth/atlassian.md b/doc/administration/auth/atlassian.md index 27e33c85761..8525b3e9b98 100644 --- a/doc/administration/auth/atlassian.md +++ b/doc/administration/auth/atlassian.md @@ -76,7 +76,7 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu 1. Save the configuration file. 1. For the changes to take effect: - - If you installed using the Linux package, [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + - If you installed using the Linux package, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). - If you self-compiled your installation, [restart GitLab](../restart_gitlab.md#installations-from-source). On the sign-in page there should now be an Atlassian icon below the regular sign in form. Select the icon to begin the authentication process. diff --git a/doc/administration/auth/cognito.md b/doc/administration/auth/cognito.md index d821a1e9cfe..8c8abf1524f 100644 --- a/doc/administration/auth/cognito.md +++ b/doc/administration/auth/cognito.md @@ -88,7 +88,7 @@ To enable AWS Cognito as an authentication provider, complete the following step ``` 1. Save the configuration file. -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. Your sign-in page should now display a Cognito option below the regular sign-in form. Select this option to begin the authentication process. diff --git a/doc/administration/auth/crowd.md b/doc/administration/auth/crowd.md index c4ebb9a5dee..08c1f5e7513 100644 --- a/doc/administration/auth/crowd.md +++ b/doc/administration/auth/crowd.md @@ -77,7 +77,7 @@ this provider also allows Crowd authentication for Git-over-https requests. 1. Change `YOUR_APP_NAME` to the application name from Crowd applications page. 1. Change `YOUR_APP_PASSWORD` to the application password you've set. 1. Save the configuration file. -1. [Reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) (Linux package installations) or +1. [Reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) (Linux package installations) or [restart](../restart_gitlab.md#installations-from-source) (self-compiled installations) for the changes to take effect. On the sign in page there should now be a Crowd tab in the sign in form. diff --git a/doc/administration/auth/jwt.md b/doc/administration/auth/jwt.md index 0f2036bea04..9a74064136a 100644 --- a/doc/administration/auth/jwt.md +++ b/doc/administration/auth/jwt.md @@ -76,7 +76,7 @@ JWT provides you with a secret key for you to use. 1. Change `YOUR_APP_SECRET` to the client secret and set `auth_url` to your redirect URL. 1. Save the configuration file. 1. For changes to take effect, if you: - - Used the Linux package to install GitLab, [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + - Used the Linux package to install GitLab, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). - Self-compiled your GitLab installation, [restart GitLab](../restart_gitlab.md#installations-from-source). On the sign in page there should now be a JWT icon below the regular sign in form. diff --git a/doc/administration/auth/ldap/google_secure_ldap.md b/doc/administration/auth/ldap/google_secure_ldap.md index 8084633c3ba..d484059c79f 100644 --- a/doc/administration/auth/ldap/google_secure_ldap.md +++ b/doc/administration/auth/ldap/google_secure_ldap.md @@ -140,7 +140,7 @@ For Linux package installations: EOS ``` -1. Save the file and [reconfigure](../../restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. +1. Save the file and [reconfigure](../../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. For self-compiled installations: diff --git a/doc/administration/auth/ldap/ldap-troubleshooting.md b/doc/administration/auth/ldap/ldap-troubleshooting.md index c9e93043819..fe4430fd235 100644 --- a/doc/administration/auth/ldap/ldap-troubleshooting.md +++ b/doc/administration/auth/ldap/ldap-troubleshooting.md @@ -733,7 +733,7 @@ cause: To resolve this error, you must apply a new license to the GitLab instance without the web interface: 1. Remove or comment out the GitLab configuration lines for all non-primary LDAP servers. -1. [Reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) so that it temporarily uses only one LDAP server. +1. [Reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) so that it temporarily uses only one LDAP server. 1. Enter the [Rails console and add the license key](../../../user/admin_area/license_file.md#add-a-license-through-the-console). 1. Re-enable the additional LDAP servers in the GitLab configuration and reconfigure GitLab again. diff --git a/doc/administration/auth/oidc.md b/doc/administration/auth/oidc.md index 620bf1fa8c4..23d2ab512db 100644 --- a/doc/administration/auth/oidc.md +++ b/doc/administration/auth/oidc.md @@ -186,7 +186,7 @@ The OpenID Connect provides you with a client's details and secret for you to us 1. Save the configuration file. 1. For changes to take effect, if you: - - Used the Linux package to install GitLab, [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + - Used the Linux package to install GitLab, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). - Self-compiled your GitLab installation, [restart GitLab](../restart_gitlab.md#installations-from-source). On the sign in page, you have an OpenID Connect option below the regular sign in form. @@ -805,7 +805,7 @@ For Linux package installations: ] ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For self-compiled installations: @@ -884,7 +884,7 @@ For Linux package installations: ] ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For self-compiled installations: @@ -961,7 +961,7 @@ For Linux package installations: ] ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For self-compiled installations: diff --git a/doc/administration/auth/smartcard.md b/doc/administration/auth/smartcard.md index 0fa585bace5..9432a627ed7 100644 --- a/doc/administration/auth/smartcard.md +++ b/doc/administration/auth/smartcard.md @@ -137,7 +137,7 @@ For Linux package installations: `gitlab_rails['smartcard_client_certificate_required_host']` or `gitlab_rails['smartcard_client_certificate_required_port']`. -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. For self-compiled installations: @@ -243,7 +243,7 @@ For Linux package installations: gitlab_rails['smartcard_san_extensions'] = true ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. For self-compiled installations: @@ -279,7 +279,7 @@ For Linux package installations: EOS ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. For self-compiled installations: @@ -310,7 +310,7 @@ For Linux package installations: gitlab_rails['smartcard_required_for_git_access'] = true ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. For self-compiled installations: diff --git a/doc/administration/cicd.md b/doc/administration/cicd.md index f015658761b..a3d9a853aaf 100644 --- a/doc/administration/cicd.md +++ b/doc/administration/cicd.md @@ -88,7 +88,7 @@ is listed in the [GitLab.com settings](../user/gitlab_com/index.md#gitlab-cicd). To change the frequency of the pipeline schedule worker: 1. Edit the `gitlab_rails['pipeline_schedule_worker_cron']` value in your instance's `gitlab.rb` file. -1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For example, to set the maximum frequency of pipelines to twice a day, set `pipeline_schedule_worker_cron` to a cron value of `0 */12 * * *` (`00:00` and `12:00` every day). diff --git a/doc/administration/clusters/kas.md b/doc/administration/clusters/kas.md index cbd32dea95c..b44c9571715 100644 --- a/doc/administration/clusters/kas.md +++ b/doc/administration/clusters/kas.md @@ -38,7 +38,7 @@ To enable the agent server on a single node: gitlab_kas['enable'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). For additional configuration options, see the **Enable GitLab KAS** section of the [`gitlab.rb.template`](https://gitlab.com/gitlab-org/omnibus-gitlab/-/blob/master/files/gitlab-config-template/gitlab.rb.template). @@ -68,7 +68,7 @@ To configure KAS to listen on a UNIX socket: } ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). #### Enable on multiple nodes @@ -94,7 +94,7 @@ To enable the agent server on multiple nodes: gitlab_rails['gitlab_kas_external_k8s_proxy_url'] = 'https://gitlab.example.com/-/kubernetes-agent/k8s-proxy/' ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ##### Agent server node settings diff --git a/doc/administration/consul.md b/doc/administration/consul.md index c5b1cc0ed2a..5a8946dbcf7 100644 --- a/doc/administration/consul.md +++ b/doc/administration/consul.md @@ -49,7 +49,7 @@ On _each_ Consul server node: gitlab_rails['auto_migrate'] = false ``` -1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes +1. [Reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Run the following command to ensure Consul is both configured correctly and to verify that all server nodes are communicating: diff --git a/doc/administration/geo/disaster_recovery/index.md b/doc/administration/geo/disaster_recovery/index.md index 4757c730c7b..29fe72a9dce 100644 --- a/doc/administration/geo/disaster_recovery/index.md +++ b/doc/administration/geo/disaster_recovery/index.md @@ -236,7 +236,7 @@ do this manually. roles ['geo_secondary_role'] ``` - After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) + After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) on each machine so the changes take effect. 1. Promote the **secondary** to **primary**. SSH into a single application @@ -444,7 +444,7 @@ required: roles ['geo_secondary_role'] ``` - After making these changes [Reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) + After making these changes [Reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) on each node so the changes take effect. 1. Promote the **secondary** to **primary**. SSH into a single secondary application @@ -554,7 +554,7 @@ sudo rm -rf /var/opt/gitlab/geo-postgresql ``` If you have any `geo_secondary[]` configuration options enabled in your `gitlab.rb` -file, these can be safely commented out or removed, and then [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +file, these can be safely commented out or removed, and then [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ## Promoting secondary Geo replica in multi-secondary configurations @@ -732,7 +732,7 @@ If you are running GitLab 14.4 and earlier: roles ['geo_secondary_role'] ``` - After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) on the database node. + After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) on the database node. 1. Find the task runner pod: diff --git a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md index 22637ad84bc..4cd332d6250 100644 --- a/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md +++ b/doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md @@ -312,7 +312,7 @@ Data that was created on the primary while the secondary was paused is lost. roles ['geo_secondary_role'] ``` - After making these changes [Reconfigure GitLab](../../../restart_gitlab.md#omnibus-gitlab-reconfigure) each + After making these changes, [reconfigure GitLab](../../../restart_gitlab.md#reconfigure-a-linux-package-installation) each machine so the changes take effect. 1. Promote the **secondary** to **primary**. SSH into a single Rails node diff --git a/doc/administration/geo/replication/disable_geo.md b/doc/administration/geo/replication/disable_geo.md index bb47b8a3524..abd6fd941af 100644 --- a/doc/administration/geo/replication/disable_geo.md +++ b/doc/administration/geo/replication/disable_geo.md @@ -80,7 +80,7 @@ Geo node in a PostgreSQL console (`sudo gitlab-psql`): roles ['geo_primary_role'] ``` -1. After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ## (Optional) Revert PostgreSQL settings to use a password and listen on an IP diff --git a/doc/administration/geo/replication/multiple_servers.md b/doc/administration/geo/replication/multiple_servers.md index 54213139fb4..4e597a21922 100644 --- a/doc/administration/geo/replication/multiple_servers.md +++ b/doc/administration/geo/replication/multiple_servers.md @@ -77,7 +77,7 @@ The following steps enable a GitLab site to serve as the Geo **primary** site. gitlab_rails['auto_migrate'] = false ``` -After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) so the changes take effect. +After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) so the changes take effect. ### Step 2: Define the site as the **primary** site @@ -179,7 +179,7 @@ the instructions below. gitlab_rails['auto_migrate'] = false ``` -After making these changes, [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) so the changes take effect. +After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) so the changes take effect. If using an external PostgreSQL instance, refer also to [Geo with external PostgreSQL instances](../setup/external_database.md). @@ -271,7 +271,7 @@ Make sure that current node's IP is listed in `postgresql['md5_auth_cidr_addresses']` setting of the read-replica database to allow Rails on this node to connect to PostgreSQL. -After making these changes [Reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) so the changes take effect. +After making these changes, [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) so the changes take effect. In the [architecture overview](#architecture-overview) topology, the following GitLab services are enabled on the "frontend" nodes: diff --git a/doc/administration/geo/setup/external_database.md b/doc/administration/geo/setup/external_database.md index 0ca1356246b..81541d1cb9c 100644 --- a/doc/administration/geo/setup/external_database.md +++ b/doc/administration/geo/setup/external_database.md @@ -179,7 +179,7 @@ To configure the connection to the external read-replica database and enable Log postgresql['enable'] = false ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) ### Configure the tracking database @@ -244,7 +244,7 @@ the tracking database on port 5432. geo_postgresql['enable'] = false # don't use internal managed instance ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) 1. The reconfigure should automatically create the database. If needed, you can perform this task manually. This task (whether run by itself or during reconfigure) requires the database user to be a superuser. diff --git a/doc/administration/geo/setup/index.md b/doc/administration/geo/setup/index.md index e401f07795f..359f706a8aa 100644 --- a/doc/administration/geo/setup/index.md +++ b/doc/administration/geo/setup/index.md @@ -31,7 +31,7 @@ a single-node Geo site or a multi-node Geo site. If both Geo sites are based on the [1K reference architecture](../../reference_architectures/1k_users.md): 1. Set up the database replication based on your choice of PostgreSQL instances (`primary (read-write) <-> secondary (read-only)` topology): - - [Using Omnibus PostgreSQL instances](database.md) . + - [Using Linux package PostgreSQL instances](database.md) . - [Using external PostgreSQL instances](external_database.md) 1. [Configure GitLab](../replication/configuration.md) to set the **primary** and **secondary** sites. 1. Recommended: [Configure unified URLs](../secondary_proxy/index.md) to use a single, unified URL for all Geo sites. diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index f3eb2de3f1d..35554e77ad5 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -14,7 +14,7 @@ Configure Gitaly in one of two ways: 1. Edit `/etc/gitlab/gitlab.rb` and add or change the [Gitaly settings](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/1dd07197c7e5ae23626aad5a4a070a800b670380/files/gitlab-config-template/gitlab.rb.template#L1622-1676). -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). :::TabTitle Self-compiled (source) @@ -301,7 +301,7 @@ Configure Gitaly server in one of two ways: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. Confirm that Gitaly can perform callbacks to the GitLab internal API: - For GitLab 15.3 and later, run `sudo /opt/gitlab/embedded/bin/gitaly check /var/opt/gitlab/gitaly/config.toml`. - For GitLab 15.2 and earlier, run `sudo /opt/gitlab/embedded/bin/gitaly-hooks check /var/opt/gitlab/gitaly/config.toml`. @@ -424,7 +424,7 @@ Configure Gitaly clients in one of two ways: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. Run `sudo gitlab-rake gitlab:gitaly:check` on the Gitaly client (for example, the Rails application) to confirm it can connect to Gitaly servers. 1. Tail the logs to see the requests: @@ -564,7 +564,7 @@ Disable Gitaly on a GitLab server in one of two ways: gitaly['enable'] = false ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). :::TabTitle Self-compiled (source) @@ -633,7 +633,7 @@ Configure Gitaly with TLS in one of two ways: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Gitaly servers, create the `/etc/gitlab/ssl` directory and copy your key and certificate there: @@ -668,14 +668,14 @@ Configure Gitaly with TLS in one of two ways: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. Verify Gitaly traffic is being served over TLS by [observing the types of Gitaly connections](#observe-type-of-gitaly-connections). 1. Optional. Improve security by: 1. Disabling non-TLS connections by commenting out or deleting `gitaly['configuration'][:listen_addr]` in `/etc/gitlab/gitlab.rb`. 1. Saving the file. - 1. [Reconfiguring GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + 1. [Reconfiguring GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). :::TabTitle Self-compiled (source) @@ -1537,7 +1537,7 @@ Configure Gitaly to sign commits made with the GitLab UI in one of two ways: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). :::TabTitle Self-compiled (source) diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 2e5a9db2be8..02c1c933a06 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -670,7 +670,7 @@ Updates to example must be made at: 1. Enable [distribution of reads](index.md#distributed-reads). 1. Save the changes to `/etc/gitlab/gitlab.rb` and - [reconfigure Praefect](../restart_gitlab.md#omnibus-gitlab-reconfigure): + [reconfigure Praefect](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl reconfigure @@ -694,7 +694,7 @@ Updates to example must be made at: additional configuration changes can be done and then reconfigure can be run manually. 1. Save the changes to `/etc/gitlab/gitlab.rb` and - [reconfigure Praefect](../restart_gitlab.md#omnibus-gitlab-reconfigure): + [reconfigure Praefect](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl reconfigure @@ -702,7 +702,7 @@ Updates to example must be made at: 1. To ensure that Praefect [has updated its Prometheus listen address](https://gitlab.com/gitlab-org/gitaly/-/issues/2734), - [restart Praefect](../restart_gitlab.md#omnibus-gitlab-restart): + [restart Praefect](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl restart praefect @@ -788,7 +788,7 @@ To configure Praefect with TLS: } ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (including each Gitaly server), copy the certificates, or their certificate authority, into `/etc/gitlab/trusted-certs`: @@ -809,7 +809,7 @@ To configure Praefect with TLS: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). **For installations from source** @@ -950,7 +950,7 @@ You can also appoint an authoritative name server by setting it in this format: praefect['consul_service_name'] = 'praefect' ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (except Gitaly servers), edit `git_data_dirs` in `/etc/gitlab/gitlab.rb` as follows. Replace `PRAEFECT_SERVICE_DISCOVERY_ADDRESS` with Praefect service discovery address, such as `praefect.service.consul`. @@ -964,7 +964,7 @@ with Praefect service discovery address, such as `praefect.service.consul`. }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). :::TabTitle Self-compiled (source) @@ -1091,7 +1091,7 @@ For more information on Gitaly server configuration, see our 1. Copy `/etc/gitlab/gitlab-secrets.json` from the Gitaly client to same path on the Gitaly servers and any other Gitaly clients. - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) on Gitaly servers. + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) on Gitaly servers. - Method 2: @@ -1146,7 +1146,7 @@ For more information on Gitaly server configuration, see our ``` 1. Save the changes to `/etc/gitlab/gitlab.rb` and - [reconfigure Gitaly](../restart_gitlab.md#omnibus-gitlab-reconfigure): + [reconfigure Gitaly](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl reconfigure @@ -1154,7 +1154,7 @@ For more information on Gitaly server configuration, see our 1. To ensure that Gitaly [has updated its Prometheus listen address](https://gitlab.com/gitlab-org/gitaly/-/issues/2734), - [restart Gitaly](../restart_gitlab.md#omnibus-gitlab-restart): + [restart Gitaly](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl restart gitaly @@ -1273,7 +1273,7 @@ Particular attention should be shown to: 1. Copy `/etc/gitlab/gitlab-secrets.json` from the Gitaly client to same path on the Gitaly servers and any other Gitaly clients. - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) on Gitaly servers. + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) on Gitaly servers. - Method 2: @@ -1317,7 +1317,7 @@ Particular attention should be shown to: ] ``` -1. Save the changes to `/etc/gitlab/gitlab.rb` and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure): +1. Save the changes to `/etc/gitlab/gitlab.rb` and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl reconfigure @@ -1388,7 +1388,7 @@ To get started quickly: ``` 1. Save the changes to `/etc/gitlab/gitlab.rb` and - [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure): + [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation): ```shell gitlab-ctl reconfigure diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index ef1f4e06595..f95d7f44e3c 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -103,7 +103,7 @@ environment variable. To set this in an Omnibus GitLab install: } ``` -1. [Reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab. +1. [Reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab. ### Correlating Git processes with RPCs @@ -216,7 +216,7 @@ Confirm the following are all true: To fix this problem, confirm that your [`gitlab-secrets.json` file](configure_gitaly.md#configure-gitaly-servers) on the Gitaly server matches the one on Gitaly client. If it doesn't match, update the secrets file on the Gitaly server to match the Gitaly client, then -[reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +[reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). If you've confirmed that your `gitlab-secrets.json` file is the same on all Gitaly servers and clients, the application might be fetching this secret from a different file. Your Gitaly server's diff --git a/doc/administration/merge_request_diffs.md b/doc/administration/merge_request_diffs.md index c49a9f8accb..00ea1e43600 100644 --- a/doc/administration/merge_request_diffs.md +++ b/doc/administration/merge_request_diffs.md @@ -38,7 +38,7 @@ For Linux package installations: gitlab_rails['external_diffs_storage_path'] = "/mnt/storage/external-diffs" ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. GitLab then migrates your existing merge request diffs to external storage. For self-compiled installations: @@ -83,7 +83,7 @@ For Linux package installations: ``` 1. Set [object storage settings](#object-storage-settings). -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. GitLab then migrates your existing merge request diffs to external storage. For self-compiled installations: @@ -151,7 +151,7 @@ For Linux package installations: } ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For self-compiled installations: @@ -190,7 +190,7 @@ For Linux package installations: gitlab_rails['external_diffs_when'] = 'outdated' ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For self-compiled installations: diff --git a/doc/administration/monitoring/ip_allowlist.md b/doc/administration/monitoring/ip_allowlist.md index 94d6876b16f..72640cd6218 100644 --- a/doc/administration/monitoring/ip_allowlist.md +++ b/doc/administration/monitoring/ip_allowlist.md @@ -20,7 +20,7 @@ hosts or use IP ranges: gitlab_rails['monitoring_whitelist'] = ['127.0.0.0/8', '192.168.0.1'] ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. --- diff --git a/doc/administration/monitoring/prometheus/gitlab_exporter.md b/doc/administration/monitoring/prometheus/gitlab_exporter.md index 1f4156349c5..0bd13fe5a87 100644 --- a/doc/administration/monitoring/prometheus/gitlab_exporter.md +++ b/doc/administration/monitoring/prometheus/gitlab_exporter.md @@ -24,7 +24,7 @@ To enable the GitLab exporter in an Omnibus GitLab instance: gitlab_exporter['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Prometheus automatically begins collecting performance data from @@ -49,7 +49,7 @@ To change the Rack server to Puma: gitlab_exporter['server_name'] = 'puma' ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. The supported Rack servers are `webrick` and `puma`. diff --git a/doc/administration/monitoring/prometheus/gitlab_metrics.md b/doc/administration/monitoring/prometheus/gitlab_metrics.md index d26cf2ed0af..63715df45e1 100644 --- a/doc/administration/monitoring/prometheus/gitlab_metrics.md +++ b/doc/administration/monitoring/prometheus/gitlab_metrics.md @@ -12,7 +12,7 @@ To enable the GitLab Prometheus metrics: 1. On the top bar, select **Main menu > Admin**. 1. On the left sidebar, select **Settings > Metrics and profiling**. 1. Find the **Metrics - Prometheus** section, and select **Enable GitLab Prometheus metrics endpoint**. -1. [Restart GitLab](../../restart_gitlab.md#omnibus-gitlab-restart) for the changes to take effect. +1. [Restart GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For installations from source you must configure it yourself. diff --git a/doc/administration/monitoring/prometheus/index.md b/doc/administration/monitoring/prometheus/index.md index 3c8b9bf187f..dec4b92b03c 100644 --- a/doc/administration/monitoring/prometheus/index.md +++ b/doc/administration/monitoring/prometheus/index.md @@ -49,7 +49,7 @@ To disable Prometheus and all of its exporters, as well as any added in the futu prometheus_monitoring['enable'] = false ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Changing the port and address Prometheus listens on @@ -80,7 +80,7 @@ listens on: prometheus['listen_address'] = '0.0.0.0:9090' ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect ### Adding custom scrape configurations @@ -158,7 +158,7 @@ The next step is to tell all the other nodes where the monitoring node is: Where `10.0.0.1:9090` is the IP address and port of the Prometheus node. -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. After monitoring using Service Discovery is enabled with `consul['monitoring_service_discovery'] = true`, @@ -240,7 +240,7 @@ server IP address to the [monitoring IP allowlist](../ip_allowlist.md): 1. As we are setting each bundled service's [exporter](#bundled-software-metrics) to listen on a network address, update the firewall on the instance to only allow traffic from your Prometheus IP for the exporters enabled. A full reference list of exporter services and their respective ports can be found [here](../../package_information/defaults.md#ports). -1. [Reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) to apply the changes. +1. [Reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) to apply the changes. 1. Edit the Prometheus server's configuration file. 1. Add each node's exporters to the Prometheus server's [scrape target configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#%3Cscrape_config%3E). @@ -437,7 +437,7 @@ To disable the monitoring of Kubernetes: prometheus['monitor_kubernetes'] = false ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ## Troubleshooting diff --git a/doc/administration/monitoring/prometheus/node_exporter.md b/doc/administration/monitoring/prometheus/node_exporter.md index 337ab9becaa..f4d5d9942ca 100644 --- a/doc/administration/monitoring/prometheus/node_exporter.md +++ b/doc/administration/monitoring/prometheus/node_exporter.md @@ -21,7 +21,7 @@ To enable the node exporter: node_exporter['enable'] = true ``` -1. Save the file, and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file, and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Prometheus begins collecting performance data from the node exporter diff --git a/doc/administration/monitoring/prometheus/pgbouncer_exporter.md b/doc/administration/monitoring/prometheus/pgbouncer_exporter.md index f8d48832288..a95dc47dc34 100644 --- a/doc/administration/monitoring/prometheus/pgbouncer_exporter.md +++ b/doc/administration/monitoring/prometheus/pgbouncer_exporter.md @@ -21,7 +21,7 @@ To enable the PgBouncer exporter: pgbouncer_exporter['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Prometheus begins collecting performance data from the PgBouncer exporter diff --git a/doc/administration/monitoring/prometheus/postgres_exporter.md b/doc/administration/monitoring/prometheus/postgres_exporter.md index 1cae28a069f..39f6c81e8d0 100644 --- a/doc/administration/monitoring/prometheus/postgres_exporter.md +++ b/doc/administration/monitoring/prometheus/postgres_exporter.md @@ -23,7 +23,7 @@ To enable the PostgreSQL Server Exporter: address is [listed in `trust_auth_cidr_addresses`](../../postgresql/replication_and_failover.md#network-information) or the exporter can't connect to the database. -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Prometheus begins collecting performance data from @@ -70,5 +70,5 @@ use the following configuration options: postgres_exporter['sslrootcert'] = 'ssl-root.crt' ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. diff --git a/doc/administration/monitoring/prometheus/redis_exporter.md b/doc/administration/monitoring/prometheus/redis_exporter.md index b17bf9787a7..5f11034dc15 100644 --- a/doc/administration/monitoring/prometheus/redis_exporter.md +++ b/doc/administration/monitoring/prometheus/redis_exporter.md @@ -22,7 +22,7 @@ To enable the Redis exporter: redis_exporter['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Prometheus begins collecting performance data from diff --git a/doc/administration/monitoring/prometheus/registry_exporter.md b/doc/administration/monitoring/prometheus/registry_exporter.md index 3f4d6cfb14d..1c46224f7b3 100644 --- a/doc/administration/monitoring/prometheus/registry_exporter.md +++ b/doc/administration/monitoring/prometheus/registry_exporter.md @@ -16,7 +16,7 @@ To enable it: registry['debug_addr'] = "localhost:5001" # localhost:5001/metrics ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Prometheus automatically begins collecting performance data from diff --git a/doc/administration/monitoring/prometheus/web_exporter.md b/doc/administration/monitoring/prometheus/web_exporter.md index 0212091f14c..eb6fe6d4d60 100644 --- a/doc/administration/monitoring/prometheus/web_exporter.md +++ b/doc/administration/monitoring/prometheus/web_exporter.md @@ -47,7 +47,7 @@ To enable the dedicated server: to `localhost:8083/metrics`. Refer to the [Adding custom scrape configurations](index.md#adding-custom-scrape-configurations) page for how to configure scraper targets. For external Prometheus setup, refer to [Using an external Prometheus server](index.md#using-an-external-prometheus-server) instead. -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Metrics can now be served and scraped from `localhost:8083/metrics`. @@ -66,7 +66,7 @@ To serve metrics via HTTPS instead of HTTP, enable TLS in the exporter settings: puma['exporter_tls_key_path'] = "/path/to/private-key.pem" ``` -1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. When TLS is enabled, the same `port` and `address` is used as described above. diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 1e6605e41a8..a6f3a96cb0f 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -315,8 +315,7 @@ Bucket encryption with the [Cloud Key Management Service (KMS)](https://cloud.go #### GCS example -For Omnibus installations, this is an example of the `connection` setting -in the consolidated form: +For Linux Package installations, this is an example of the `connection` setting in the consolidated form: ```ruby gitlab_rails['object_store']['connection'] = { @@ -376,8 +375,7 @@ The following are the valid connection parameters for Azure. For more informatio | `azure_storage_access_key` | Storage account access key used to access the container. This is typically a secret, 512-bit encryption key encoded in base64. | `czV2OHkvQj9FKEgrTWJRZVRoV21ZcTN0Nnc5eiRDJkYpSkBOY1JmVWpYbjJy\nNHU3eCFBJUQqRy1LYVBkU2dWaw==\n` | | `azure_storage_domain` | Domain name used to contact the Azure Blob Storage API (optional). Defaults to `blob.core.windows.net`. Set this if you are using Azure China, Azure Germany, Azure US Government, or some other custom Azure domain. | `blob.core.windows.net` | -- For Omnibus installations, this is an example of the `connection` setting - in the consolidated form: +- For Linux package installations, this is an example of the `connection` setting in the consolidated form: ```ruby gitlab_rails['object_store']['connection'] = { @@ -388,8 +386,8 @@ The following are the valid connection parameters for Azure. For more informatio } ``` -- For source installations, Workhorse also needs to be configured with Azure - credentials. This isn't needed in Omnibus installs, because the Workhorse +- For self-compiled installations, Workhorse also needs to be configured with Azure + credentials. This isn't needed in Linux package installations because the Workhorse settings are populated from the previous settings. 1. Edit `/home/git/gitlab-workhorse/config.toml` and add or amend the following lines: @@ -738,7 +736,7 @@ Prior to GitLab 13.2: - Object store connection parameters such as passwords and endpoint URLs had to be duplicated for each type. -For example, an Omnibus GitLab install might have the following configuration: +For example, a Linux package installation might have the following configuration: ```ruby # Original object storage configuration @@ -833,10 +831,9 @@ your object storage provider instead. Using separate buckets for each data type is the recommended approach for GitLab. This ensures there are no collisions across the various types of data GitLab stores. -There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) -in the future. +[Issue 292958](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) proposes to enable the use of a single bucket. -With Omnibus and source installations it is possible to split a single +With Linux package and self-compiled installations, it is possible to split a single real bucket into multiple virtual buckets. If your object storage bucket is called `my-gitlab-objects` you can configure uploads to go into `my-gitlab-objects/uploads`, artifacts into @@ -941,7 +938,7 @@ mismatch` error during an upload. When the consolidated form is: -- Used with an S3-compatible object storage or an istance profile, Workhorse +- Used with an S3-compatible object storage or an instance profile, Workhorse uses its internal S3 client which has S3 credentials so that it can compute the `Content-MD5` header. This eliminates the need to compare ETag headers returned from the S3 server. diff --git a/doc/administration/operations/puma.md b/doc/administration/operations/puma.md index b2fa41a2caa..d7d6f6228f9 100644 --- a/doc/administration/operations/puma.md +++ b/doc/administration/operations/puma.md @@ -398,7 +398,7 @@ gitlab_rails['env'] = { For source installations, set the environment variable. Refer to [Puma Worker timeout](../operations/puma.md#change-the-worker-timeout). -[Reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. +[Reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. #### Troubleshooting without affecting other users diff --git a/doc/administration/packages/container_registry.md b/doc/administration/packages/container_registry.md index caebf1f78ae..53ae7046292 100644 --- a/doc/administration/packages/container_registry.md +++ b/doc/administration/packages/container_registry.md @@ -147,7 +147,7 @@ under the `registry_external_url` line, rather than the port listed under registry_nginx['ssl_certificate_key'] = "/path/to/certificate.key" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Validate using: @@ -226,7 +226,7 @@ Let's assume that you want the container Registry to be accessible at The `registry_external_url` is listening on HTTPS. -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. If you have a [wildcard certificate](https://en.wikipedia.org/wiki/Wildcard_certificate), you must specify the path to the certificate in addition to the URL, in this case `/etc/gitlab/gitlab.rb` @@ -272,7 +272,7 @@ Registry application itself. registry['enable'] = false ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -300,7 +300,7 @@ the Container Registry by themselves, follow the steps below. gitlab_rails['gitlab_default_projects_features_container_registry'] = false ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -391,7 +391,7 @@ The default location where images are stored in Omnibus, is gitlab_rails['registry_path'] = "/path/to/registry/storage" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -490,7 +490,7 @@ To configure the `s3` storage driver in Omnibus: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -556,7 +556,7 @@ you can pull from the Container Registry, but you cannot push. 1. To perform the final data sync, [put the Container Registry in `read-only` mode](#performing-garbage-collection-without-downtime) and - [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. Sync any changes dating from after the initial data load to your S3 bucket, and delete files that exist in the destination bucket but not in the source: ```shell @@ -586,7 +586,7 @@ you can pull from the Container Registry, but you cannot push. The output of these commands should match, except for the content in the `_uploads` directories and sub-directories. 1. Configure your registry to [use the S3 bucket for storage](#use-object-storage). -1. For the changes to take effect, set the Registry back to `read-write` mode and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. For the changes to take effect, set the Registry back to `read-write` mode and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). #### Moving to Azure Object Storage @@ -654,7 +654,7 @@ However, this behavior is undesirable for registries used by internal hosts that } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -705,7 +705,7 @@ For Omnibus GitLab installations: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For installations from source: @@ -746,7 +746,7 @@ In the examples below we set the Registry's port to `5010`. registry['registry_http_addr'] = "localhost:5010" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -850,7 +850,7 @@ You can use GitLab as an auth endpoint with an external container registry. gitlab_rails['registry_port'] = "5005" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -905,7 +905,7 @@ To configure a notification endpoint in Omnibus: ] ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -1449,7 +1449,7 @@ Start with a value between `25000000` (25 MB) and `50000000` (50 MB). } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **For installations from source** @@ -1483,7 +1483,7 @@ You can add a configuration option for backwards compatibility. registry['compatibility_schema1_enabled'] = true ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **For installations from source** @@ -1531,7 +1531,7 @@ and a simple solution would be to enable relative URLs in the Registry. } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **For installations from source** @@ -1559,7 +1559,7 @@ in your `gitlab.rb` configuration. registry['debug_addr'] = "localhost:5001" ``` -After adding the setting, [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) to apply the change. +After adding the setting, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) to apply the change. Use curl to request debug output from the debug server: @@ -1851,7 +1851,7 @@ In this case, follow these steps: gitlab_rails['registry_enabled'] = true ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Try the removal again. diff --git a/doc/administration/packages/dependency_proxy.md b/doc/administration/packages/dependency_proxy.md index a29d6d93051..5e770c2464b 100644 --- a/doc/administration/packages/dependency_proxy.md +++ b/doc/administration/packages/dependency_proxy.md @@ -39,7 +39,7 @@ correspond to your GitLab installation: gitlab_rails['dependency_proxy_enabled'] = false ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Helm chart installations @@ -104,7 +104,7 @@ To change the local storage path: gitlab_rails['dependency_proxy_storage_path'] = "/mnt/dependency_proxy" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -156,7 +156,7 @@ This section describes the earlier configuration format. [Migration steps still } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **Installations from source** @@ -266,4 +266,4 @@ The default expiration and the expiration on GitLab.com is 15 minutes. "https_proxy" => "http://USERNAME:PASSWORD@example.com:8080" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index 1626a4fd41a..b4d5531b984 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -146,7 +146,7 @@ The Pages daemon doesn't listen to the outside world. pages_external_url "http://pages.example.com" # not a subdomain of external_url ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). Watch the [video tutorial](https://youtu.be/dD8c7WNcc6s) for this configuration. @@ -182,7 +182,7 @@ you must also add the full paths as shown below: pages_nginx['ssl_certificate_key'] = "/etc/gitlab/ssl/pages-nginx.key" ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. If you're using [Pages Access Control](#access-control), update the redirect URI in the GitLab Pages [System OAuth application](../../integration/oauth_provider.md#create-an-instance-wide-application) to use the HTTPS protocol. @@ -221,13 +221,13 @@ This setup is primarily intended to be used when [installing a GitLab POC on Ama pages_nginx['redirect_http_to_https'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Global settings Below is a table of all configuration settings known to Pages in Omnibus GitLab, and what they do. These options can be adjusted in `/etc/gitlab/gitlab.rb`, -and take effect after you [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +and take effect after you [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). Most of these settings don't have to be configured manually unless you need more granular control over how the Pages daemon runs and serves content in your environment. @@ -343,7 +343,7 @@ world. Custom domains are supported, but no TLS. If you don't have IPv6, you can omit the IPv6 address. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Custom domains with TLS support @@ -385,7 +385,7 @@ then you need to also add the full paths as shown below: gitlab_pages['cert_key'] = "/etc/gitlab/ssl/example.io.key" ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. If you're using [Pages Access Control](#access-control), update the redirect URI in the GitLab Pages [System OAuth application](../../integration/oauth_provider.md#create-an-instance-wide-application) to use the HTTPS protocol. @@ -453,7 +453,7 @@ Pages access control is disabled by default. To enable it: gitlab_pages['access_control'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. Users can now configure it in their [projects' settings](../../user/project/pages/pages_access_control.md). NOTE: @@ -512,7 +512,7 @@ internet connectivity is gated by a proxy. To use a proxy for GitLab Pages: gitlab_pages['env']['http_proxy'] = 'http://example:8080' ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Using a custom Certificate Authority (CA) @@ -598,7 +598,7 @@ Follow the steps below to configure verbose logging of GitLab Pages daemon. gitlab_pages['log_verbose'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## Propagating the correlation ID @@ -617,7 +617,7 @@ To enable the propagation of the correlation ID: gitlab_pages['propagate_correlation_id'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## Change storage path @@ -632,7 +632,7 @@ are stored. gitlab_rails['pages_path'] = "/mnt/storage/pages" ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## Configure listener for reverse proxy requests @@ -654,7 +654,7 @@ Follow the steps below to configure the proxy listener of GitLab Pages. gitlab_pages['listen_proxy'] = "localhost:10080" ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## Set global maximum size of each GitLab Pages site **(FREE SELF)** @@ -754,7 +754,7 @@ database encryption. Proceed with caution. 1. Configure [the object storage and migrate pages data to it](#using-object-storage). -1. [Reconfigure the **GitLab server**](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the +1. [Reconfigure the **GitLab server**](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. The `gitlab-secrets.json` file is now updated with the new configuration. @@ -794,7 +794,7 @@ database encryption. Proceed with caution. mv /var/opt/gitlab/gitlab-rails/shared/pages/gitlab-secrets.json /etc/gitlab/gitlab-secrets.json ``` -1. [Reconfigure the **Pages server**](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure the **Pages server**](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. On the **GitLab server**, make the following changes to `/etc/gitlab/gitlab.rb`: @@ -804,7 +804,7 @@ database encryption. Proceed with caution. pages_nginx['enable'] = false ``` -1. [Reconfigure the **GitLab server**](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure the **GitLab server**](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. It's possible to run GitLab Pages on multiple servers if you wish to distribute the load. You can do this through standard load balancing practices such as @@ -853,7 +853,7 @@ To explicitly enable API source: gitlab_pages['domain_config_source'] = "gitlab" ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Or if you want to use legacy configuration source you can: @@ -863,7 +863,7 @@ Or if you want to use legacy configuration source you can: gitlab_pages['domain_config_source'] = "disk" ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### GitLab API cache configuration @@ -960,7 +960,7 @@ In Omnibus installations: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Migrate existing Pages deployments to object storage.](#migrate-pages-deployments-to-object-storage) @@ -1102,7 +1102,7 @@ If you use [object storage](#using-object-storage), you can disable local storag gitlab_rails['pages_local_store_enabled'] = false ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Starting from GitLab 13.12, this setting also disables the [legacy storage](#migrate-legacy-storage-to-zip-storage), so if you were using NFS to serve Pages, you can completely disconnect from it. @@ -1176,7 +1176,7 @@ TLS connection-based rate limits are enforced using the following: gitlab_pages['rate_limit_source_ip_burst'] = 600 ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). #### Enable HTTP requests rate limits by domain @@ -1189,7 +1189,7 @@ TLS connection-based rate limits are enforced using the following: gitlab_pages['rate_limit_domain_burst'] = 5000 ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). #### Enable TLS connections rate limits by source-IP @@ -1202,7 +1202,7 @@ TLS connection-based rate limits are enforced using the following: gitlab_pages['rate_limit_tls_source_ip_burst'] = 600 ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). #### Enable TLS connections rate limits by domain @@ -1215,7 +1215,7 @@ TLS connection-based rate limits are enforced using the following: gitlab_pages['rate_limit_tls_domain_burst'] = 5000 ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## Related topics diff --git a/doc/administration/pages/troubleshooting.md b/doc/administration/pages/troubleshooting.md index 6f00ae074f5..27322c2a537 100644 --- a/doc/administration/pages/troubleshooting.md +++ b/doc/administration/pages/troubleshooting.md @@ -234,7 +234,7 @@ To enable disk access: gitlab_pages['enable_disk'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## `httprange: new resource 403` @@ -275,7 +275,7 @@ To do that: gitlab_pages['use_legacy_storage'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## GitLab Pages deploy job fails with error "is not a recognized provider" @@ -292,7 +292,7 @@ To fix that: - Configure object storage for your Pages deployments, following the [S3-compatible connection settings](index.md#s3-compatible-connection-settings) guide. - Store your deployments locally, by commenting out that line. -1. Save the changes you made to your `gitlab.rb` file, then [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the changes you made to your `gitlab.rb` file, then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ## 404 error `The page you're looking for could not be found` diff --git a/doc/administration/postgresql/database_load_balancing.md b/doc/administration/postgresql/database_load_balancing.md index 1007f4e2429..cc550dbe389 100644 --- a/doc/administration/postgresql/database_load_balancing.md +++ b/doc/administration/postgresql/database_load_balancing.md @@ -93,7 +93,7 @@ nodes for each environment you want to balance: These hosts must be reachable on the same port configured with `gitlab_rails['db_port']`. -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). NOTE: Adding the primary to the hosts list is optional, but recommended. @@ -130,7 +130,7 @@ record. For example: } ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. | Option | Description | Default | |----------------------|---------------------------------------------------------------------------------------------------|-----------| diff --git a/doc/administration/postgresql/replication_and_failover.md b/doc/administration/postgresql/replication_and_failover.md index 1f9ed6f3c48..392f9f2b89c 100644 --- a/doc/administration/postgresql/replication_and_failover.md +++ b/doc/administration/postgresql/replication_and_failover.md @@ -328,10 +328,10 @@ consul['configuration'] = { All database nodes use the same configuration. The leader node is not determined in configuration, and there is no additional or different configuration for either leader or replica nodes. -After the configuration of a node is complete, you must [reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +After the configuration of a node is complete, you must [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) on each node for the changes to take effect. -Generally, when Consul cluster is ready, the first node that [reconfigures](../restart_gitlab.md#omnibus-gitlab-reconfigure) +Generally, when Consul cluster is ready, the first node that [reconfigures](../restart_gitlab.md#reconfigure-a-linux-package-installation) becomes the leader. You do not need to sequence the nodes reconfiguration. You can run them in parallel or in any order. If you choose an arbitrary order, you do not have any predetermined leader. @@ -552,7 +552,7 @@ attributes set, but the following need to be set. gitlab_rails['db_load_balancing'] = { 'hosts' => ['POSTGRESQL_NODE_1', 'POSTGRESQL_NODE_2', 'POSTGRESQL_NODE_3'] } ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Application node post-configuration @@ -625,7 +625,7 @@ consul['configuration'] = { consul['monitoring_service_discovery'] = true ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Example recommended setup for PgBouncer servers @@ -654,7 +654,7 @@ consul['configuration'] = { consul['monitoring_service_discovery'] = true ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Internal load balancer setup @@ -703,7 +703,7 @@ consul['configuration'] = { consul['monitoring_service_discovery'] = true ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Example recommended setup manual steps @@ -979,7 +979,7 @@ You can switch an exiting database cluster to use Patroni instead of repmgr with 1. On the primary node, [configure Patroni](#configuring-patroni-cluster). Remove `repmgr` and any other repmgr-specific configuration. Also remove any configuration that is related to PostgreSQL replication. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) on the primary node. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) on the primary node. It makes it the leader. You can check this with: ```shell @@ -1305,7 +1305,7 @@ To fix the problem, add the IP address to `/etc/gitlab/gitlab.rb`. postgresql['trust_auth_cidr_addresses'] = %w(123.123.123.123/32 <other_cidrs>) ``` -[Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Reinitialize a replica @@ -1426,7 +1426,7 @@ To fix the problem, ensure the loopback interface is included in the CIDR addres postgresql['trust_auth_cidr_addresses'] = %w(<other_cidrs> 127.0.0.1/32) ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Check that [all the replicas are synchronized](#check-replication-status) ### Errors in Patroni logs: the requested start point is ahead of the Write Ahead Log (WAL) flush position diff --git a/doc/administration/postgresql/standalone.md b/doc/administration/postgresql/standalone.md index 77ff9fd2fe1..d00310ecee0 100644 --- a/doc/administration/postgresql/standalone.md +++ b/doc/administration/postgresql/standalone.md @@ -57,7 +57,7 @@ together with Omnibus GitLab. This is recommended as part of our gitlab_rails['auto_migrate'] = false ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Note the PostgreSQL node's IP address or hostname, port, and plain text password. These are necessary when configuring the GitLab application servers later. diff --git a/doc/administration/redis/replication_and_failover.md b/doc/administration/redis/replication_and_failover.md index a37794ec44b..257d6cb54cb 100644 --- a/doc/administration/redis/replication_and_failover.md +++ b/doc/administration/redis/replication_and_failover.md @@ -275,7 +275,7 @@ If you fail to replicate first, you may loose data (unprocessed background jobs) gitlab_rails['auto_migrate'] = false ``` -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. NOTE: You can specify multiple roles like sentinel and Redis as: @@ -332,7 +332,7 @@ Read more about [roles](https://docs.gitlab.com/omnibus/roles/). gitlab_rails['auto_migrate'] = false ``` -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes. NOTE: @@ -458,7 +458,7 @@ multiple machines with the Sentinel daemon. Only the primary GitLab application server should handle migrations. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other Sentinel nodes. ### Step 4. Configuring the GitLab application @@ -495,7 +495,7 @@ which ideally should not have Redis or Sentinels on it for a HA setup. ] ``` -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Step 5. Enable Monitoring @@ -576,7 +576,7 @@ sentinel['quorum'] = 2 # sentinel['failover_timeout'] = 60000 ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Example configuration for Redis replica 1 and Sentinel 2 @@ -598,7 +598,7 @@ sentinel['quorum'] = 2 # sentinel['failover_timeout'] = 60000 ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Example configuration for Redis replica 2 and Sentinel 3 @@ -620,7 +620,7 @@ sentinel['quorum'] = 2 # sentinel['failover_timeout'] = 60000 ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Example configuration for the GitLab application @@ -636,7 +636,7 @@ gitlab_rails['redis_sentinels'] = [ ] ``` -[Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +[Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ## Advanced configuration diff --git a/doc/administration/redis/standalone.md b/doc/administration/redis/standalone.md index c36d75a566d..703601cda42 100644 --- a/doc/administration/redis/standalone.md +++ b/doc/administration/redis/standalone.md @@ -42,7 +42,7 @@ Omnibus GitLab: gitlab_rails['auto_migrate'] = false ``` -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Note the Redis node's IP address or hostname, port, and Redis password. These are necessary when [configuring the GitLab application servers](#set-up-the-gitlab-rails-application-instance). @@ -68,7 +68,7 @@ On the instance where GitLab is installed: 1. Save your changes to `/etc/gitlab/gitlab.rb`. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ## Troubleshooting diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index f114a4a50c5..c3cf7c599a3 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -456,7 +456,7 @@ To configure Consul: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other Consul nodes, and make sure you set up the correct IPs. @@ -656,7 +656,7 @@ For more information, see the various [Patroni replication methods](../postgresq 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Advanced [configuration options](https://docs.gitlab.com/omnibus/settings/database.html) are supported and can be added if needed. @@ -745,7 +745,7 @@ The following IPs will be used as an example: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. If an error `execute[generate databases.ini]` occurs, this is due to an existing [known issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4713). @@ -758,7 +758,7 @@ The following IPs will be used as an example: gitlab-ctl write-pgpass --host 127.0.0.1 --database pgbouncer --user pgbouncer --hostuser gitlab-consul ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) once again +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) once again to resolve any potential errors from the previous steps. 1. Ensure each node is talking to the current primary: @@ -919,7 +919,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Configure the replica Redis Cache nodes @@ -992,7 +992,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -1074,7 +1074,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Configure the replica Redis Persistent nodes @@ -1137,7 +1137,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -1256,7 +1256,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Follow the [post configuration](#praefect-postgresql-post-configuration). @@ -1488,10 +1488,10 @@ Updates to example must be made at: sudo touch /etc/gitlab/skip-auto-reconfigure ``` - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect and + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect and to run the Praefect database migrations. -1. On all other Praefect nodes, [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. On all other Praefect nodes, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Configure Gitaly @@ -1659,7 +1659,7 @@ Updates to example must be made at: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Gitaly Cluster TLS support @@ -1715,7 +1715,7 @@ To configure Praefect with TLS: } ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (including each Gitaly server), copy the certificates, or their certificate authority, into `/etc/gitlab/trusted-certs`: @@ -1736,7 +1736,7 @@ To configure Praefect with TLS: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). <div align="right"> <a type="button" class="btn btn-default" href="#setup-components"> @@ -1893,7 +1893,7 @@ Updates to example must be made at: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. NOTE: If you find that the environment's Sidekiq job processing is slow with long queues, @@ -2057,7 +2057,7 @@ On each node perform the following: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Enable incremental logging](#enable-incremental-logging). 1. Confirm the node can connect to Gitaly: @@ -2168,7 +2168,7 @@ To configure the Monitoring node: nginx['enable'] = true ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. In the GitLab UI, set `admin/application_settings/metrics_and_profiling` > Metrics - Grafana to `/-/grafana` to `http[s]://<MONITOR NODE>/-/grafana` diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 7ac5d1fadbe..37571ed5771 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -473,7 +473,7 @@ To configure Consul: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other Consul nodes, and make sure you set up the correct IPs. @@ -673,7 +673,7 @@ For more information, see the various [Patroni replication methods](../postgresq 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Advanced [configuration options](https://docs.gitlab.com/omnibus/settings/database.html) are supported and can be added if needed. @@ -762,7 +762,7 @@ The following IPs will be used as an example: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. If an error `execute[generate databases.ini]` occurs, this is due to an existing [known issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4713). @@ -775,7 +775,7 @@ The following IPs will be used as an example: gitlab-ctl write-pgpass --host 127.0.0.1 --database pgbouncer --user pgbouncer --hostuser gitlab-consul ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) once again +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) once again to resolve any potential errors from the previous steps. 1. Ensure each node is talking to the current primary: @@ -935,7 +935,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Configure the replica Redis Cache nodes @@ -1007,7 +1007,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -1089,7 +1089,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Configure the replica Redis Persistent nodes @@ -1155,7 +1155,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -1275,7 +1275,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Follow the [post configuration](#praefect-postgresql-post-configuration). @@ -1505,10 +1505,10 @@ the file of the same name on this server. If this is the first Omnibus node you sudo touch /etc/gitlab/skip-auto-reconfigure ``` - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect and + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect and to run the Praefect database migrations. -1. On all other Praefect nodes, [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. On all other Praefect nodes, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Configure Gitaly @@ -1676,7 +1676,7 @@ Updates to example must be made at: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Gitaly Cluster TLS support @@ -1732,7 +1732,7 @@ To configure Praefect with TLS: } ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (including each Gitaly server), copy the certificates, or their certificate authority, into `/etc/gitlab/trusted-certs`: @@ -1753,7 +1753,7 @@ To configure Praefect with TLS: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). <div align="right"> <a type="button" class="btn btn-default" href="#setup-components"> @@ -1910,7 +1910,7 @@ Updates to example must be made at: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. NOTE: If you find that the environment's Sidekiq job processing is slow with long queues, @@ -2076,7 +2076,7 @@ On each node perform the following: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Enable incremental logging](#enable-incremental-logging). 1. Confirm the node can connect to Gitaly: @@ -2187,7 +2187,7 @@ To configure the Monitoring node: nginx['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. In the GitLab UI, set `admin/application_settings/metrics_and_profiling` > Metrics - Grafana to `/-/grafana` to `http[s]://<MONITOR NODE>/-/grafana` diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 72079060724..455b0fbafd1 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -311,7 +311,7 @@ If you use a third party external service: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Note the PostgreSQL node's IP address or hostname, port, and plain text password. These will be necessary when configuring the [GitLab application server](#configure-gitlab-rails) later. @@ -370,7 +370,7 @@ Omnibus: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Note the Redis node's IP address or hostname, port, and Redis password. These will be necessary when @@ -520,7 +520,7 @@ Updates to example must be made at: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Confirm that Gitaly can perform callbacks to the internal API: - For GitLab 15.3 and later, run `sudo /opt/gitlab/embedded/bin/gitaly check /var/opt/gitlab/gitaly/config.toml`. @@ -583,7 +583,7 @@ To configure Gitaly with TLS: ``` 1. Delete `gitaly['listen_addr']` to allow only encrypted connections. -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). <div align="right"> <a type="button" class="btn btn-default" href="#setup-components"> @@ -729,7 +729,7 @@ On each node perform the following: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Enable incremental logging](#enable-incremental-logging). 1. Run `sudo gitlab-rake gitlab:gitaly:check` to confirm the node can connect to Gitaly. @@ -863,7 +863,7 @@ running [Prometheus](../monitoring/prometheus/index.md) and ] ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. In the GitLab UI, set `admin/application_settings/metrics_and_profiling` > Metrics - Grafana to `/-/grafana` to `http[s]://<MONITOR NODE>/-/grafana` diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 705b06e00f7..6a7d9864376 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -521,7 +521,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. You can specify multiple roles, like sentinel and Redis, as: `roles ['redis_sentinel_role', 'redis_master_role']`. Read more about @@ -606,7 +606,7 @@ run: redis-exporter: (pid 30075) 76861s; run: log: (pid 29674) 76896s 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -742,7 +742,7 @@ To configure the Sentinel: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other Consul/Sentinel nodes, and make sure you set up the correct IPs. @@ -943,7 +943,7 @@ For more information, see the various [Patroni replication methods](../postgresq 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Advanced [configuration options](https://docs.gitlab.com/omnibus/settings/database.html) are supported and can be added if needed. @@ -1033,7 +1033,7 @@ The following IPs will be used as an example: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Create a `.pgpass` file so Consul is able to reload PgBouncer. Enter the PgBouncer password twice when asked: @@ -1203,7 +1203,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Follow the [post configuration](#praefect-postgresql-post-configuration). <div align="right"> @@ -1432,10 +1432,10 @@ the file of the same name on this server. If this is the first Omnibus node you sudo touch /etc/gitlab/skip-auto-reconfigure ``` - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect and + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect and to run the Praefect database migrations. -1. On all other Praefect nodes, [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. On all other Praefect nodes, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Configure Gitaly @@ -1607,7 +1607,7 @@ Updates to example must be made at: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Gitaly Cluster TLS support @@ -1663,7 +1663,7 @@ To configure Praefect with TLS: } ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (including each Gitaly server), copy the certificates, or their certificate authority, into `/etc/gitlab/trusted-certs`: @@ -1684,7 +1684,7 @@ To configure Praefect with TLS: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). <div align="right"> <a type="button" class="btn btn-default" href="#setup-components"> @@ -1836,7 +1836,7 @@ Updates to example must be made at: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. Verify the GitLab services are running: @@ -2026,7 +2026,7 @@ On each node perform the following: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Enable incremental logging](#enable-incremental-logging). 1. Run `sudo gitlab-rake gitlab:gitaly:check` to confirm the node can connect to Gitaly. 1. Tail the logs to see the requests: @@ -2137,7 +2137,7 @@ running [Prometheus](../monitoring/prometheus/index.md) and nginx['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. In the GitLab UI, set `admin/application_settings/metrics_and_profiling` > Metrics - Grafana to `/-/grafana` to `http[s]://<MONITOR NODE>/-/grafana`. 1. Verify the GitLab services are running: diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 54a57a92aa2..9a2c354f27c 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -465,7 +465,7 @@ To configure Consul: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other Consul nodes, and make sure you set up the correct IPs. @@ -666,7 +666,7 @@ For more information, see the various [Patroni replication methods](../postgresq 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Advanced [configuration options](https://docs.gitlab.com/omnibus/settings/database.html) are supported and can be added if needed. @@ -755,7 +755,7 @@ The following IPs will be used as an example: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. If an error `execute[generate databases.ini]` occurs, this is due to an existing [known issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4713). @@ -768,7 +768,7 @@ The following IPs will be used as an example: gitlab-ctl write-pgpass --host 127.0.0.1 --database pgbouncer --user pgbouncer --hostuser gitlab-consul ``` -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) once again +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) once again to resolve any potential errors from the previous steps. 1. Ensure each node is talking to the current primary: @@ -929,7 +929,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Configure the replica Redis Cache nodes @@ -1004,7 +1004,7 @@ a node and change its status from primary to replica (and vice versa). server. If this is the first Omnibus node you are configuring then you can skip this step. - 1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and @@ -1087,7 +1087,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. #### Configure the replica Redis Persistent nodes @@ -1150,7 +1150,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -1269,7 +1269,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Follow the [post configuration](#praefect-postgresql-post-configuration). @@ -1501,10 +1501,10 @@ the file of the same name on this server. If this is the first Omnibus node you sudo touch /etc/gitlab/skip-auto-reconfigure ``` - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect and + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect and to run the Praefect database migrations. -1. On all other Praefect nodes, [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. On all other Praefect nodes, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Configure Gitaly @@ -1672,7 +1672,7 @@ Updates to example must be made at: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Gitaly Cluster TLS support @@ -1728,7 +1728,7 @@ To configure Praefect with TLS: } ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (including each Gitaly server), copy the certificates, or their certificate authority, into `/etc/gitlab/trusted-certs`: @@ -1749,7 +1749,7 @@ To configure Praefect with TLS: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). <div align="right"> <a type="button" class="btn btn-default" href="#setup-components"> @@ -1906,7 +1906,7 @@ Updates to example must be made at: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. NOTE: If you find that the environment's Sidekiq job processing is slow with long queues, @@ -2075,7 +2075,7 @@ On each node perform the following: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Enable incremental logging](#enable-incremental-logging). 1. Confirm the node can connect to Gitaly: @@ -2186,7 +2186,7 @@ To configure the Monitoring node: nginx['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. In the GitLab UI, set `admin/application_settings/metrics_and_profiling` > Metrics - Grafana to `/-/grafana` to `http[s]://<MONITOR NODE>/-/grafana` diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 873d269d44b..b0bc70aaf00 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -515,7 +515,7 @@ a node and change its status from primary to replica (and vice versa). 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. You can specify multiple roles, like sentinel and Redis, as: `roles(['redis_sentinel_role', 'redis_master_role'])`. Read more about @@ -600,7 +600,7 @@ run: redis-exporter: (pid 30075) 76861s; run: log: (pid 29674) 76896s 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other replica nodes, and make sure to set up the IPs correctly. @@ -736,7 +736,7 @@ To configure the Sentinel: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Go through the steps again for all the other Consul/Sentinel nodes, and make sure you set up the correct IPs. @@ -936,7 +936,7 @@ For more information, see the various [Patroni replication methods](../postgresq 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. Advanced [configuration options](https://docs.gitlab.com/omnibus/settings/database.html) are supported and can be added if needed. @@ -1026,7 +1026,7 @@ The following IPs are used as an example: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure Omnibus GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Create a `.pgpass` file so Consul is able to reload PgBouncer. Enter the PgBouncer password twice when asked: @@ -1196,7 +1196,7 @@ in the second step, do not supply the `EXTERNAL_URL` value. 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Follow the [post configuration](#praefect-postgresql-post-configuration). @@ -1426,10 +1426,10 @@ the file of the same name on this server. If this is the first Omnibus node you sudo touch /etc/gitlab/skip-auto-reconfigure ``` - 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect and + 1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect and to run the Praefect database migrations. -1. On all other Praefect nodes, [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. On all other Praefect nodes, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ### Configure Gitaly @@ -1597,7 +1597,7 @@ Updates to example must be made at: 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from the first Omnibus node you configured and add or replace the file of the same name on this server. If this is the first Omnibus node you are configuring then you can skip this step. -1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file, and then [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). ### Gitaly Cluster TLS support @@ -1653,7 +1653,7 @@ To configure Praefect with TLS: } ``` -1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. On the Praefect clients (including each Gitaly server), copy the certificates, or their certificate authority, into `/etc/gitlab/trusted-certs`: @@ -1674,7 +1674,7 @@ To configure Praefect with TLS: }) ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). <div align="right"> <a type="button" class="btn btn-default" href="#setup-components"> @@ -1825,7 +1825,7 @@ Updates to example must be made at: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Verify the GitLab services are running: @@ -2018,7 +2018,7 @@ On each node perform the following: Only a single designated node should handle migrations as detailed in the [GitLab Rails post-configuration](#gitlab-rails-post-configuration) section. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Enable incremental logging](#enable-incremental-logging). 1. Run `sudo gitlab-rake gitlab:gitaly:check` to confirm the node can connect to Gitaly. 1. Tail the logs to see the requests: @@ -2129,7 +2129,7 @@ running [Prometheus](../monitoring/prometheus/index.md) and nginx['enable'] = true ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation). 1. In the GitLab UI, set `admin/application_settings/metrics_and_profiling` > Metrics - Grafana to `/-/grafana` to `http[s]://<MONITOR NODE>/-/grafana`. 1. Verify the GitLab services are running: diff --git a/doc/administration/repository_checks.md b/doc/administration/repository_checks.md index 3f715e451a8..894dceb2151 100644 --- a/doc/administration/repository_checks.md +++ b/doc/administration/repository_checks.md @@ -41,7 +41,7 @@ When enabled, GitLab periodically runs a repository check on all project reposit repositories to detect possible data corruption. A project is checked no more than once per month. Administrators can configure the frequency of repository checks. To edit the frequency: -- For Omnibus GitLab installations, edit `gitlab_rails['repository_check_worker_cron']` in +- For Linux package installations, edit `gitlab_rails['repository_check_worker_cron']` in `/etc/gitlab/gitlab.rb`. - For source-based installations, edit `[gitlab.cron_jobs.repository_check_worker]` in `/home/git/gitlab/config/gitlab.yml`. @@ -59,7 +59,7 @@ You can run [`git fsck`](https://git-scm.com/docs/git-fsck) using the command li [Gitaly servers](gitaly/index.md). To locate the repositories: 1. Go to the storage location for repositories: - - For Omnibus GitLab installations, repositories are stored in the `/var/opt/gitlab/git-data/repositories` directory + - For Linux package installations, repositories are stored in the `/var/opt/gitlab/git-data/repositories` directory by default. - For GitLab Helm chart installations, repositories are stored in the `/home/git/repositories` directory inside the Gitaly pod by default. @@ -79,8 +79,8 @@ You can run [`git fsck`](https://git-scm.com/docs/git-fsck) using the command li If a repository check fails, locate the error in the [`repocheck.log` file](logs/index.md#repochecklog) on disk at: -- `/var/log/gitlab/gitlab-rails` for Omnibus GitLab installations. -- `/home/git/gitlab/log` for installations from source. +- `/var/log/gitlab/gitlab-rails` for Linux package installations. +- `/home/git/gitlab/log` for self-compiled installations. - `/var/log/gitlab` in the Sidekiq pod for GitLab Helm chart installations. If periodic repository checks cause false alarms, you can clear all repository check states: diff --git a/doc/administration/repository_storage_paths.md b/doc/administration/repository_storage_paths.md index 808659132f9..4679d51e3dd 100644 --- a/doc/administration/repository_storage_paths.md +++ b/doc/administration/repository_storage_paths.md @@ -18,7 +18,7 @@ storage is either: GitLab allows you to define multiple repository storages to distribute the storage load between several mount points. For example: -- When using Gitaly (Omnibus GitLab-style configuration): +- When using Gitaly (Linux package installation-style configuration): ```ruby git_data_dirs({ @@ -27,7 +27,7 @@ several mount points. For example: }) ``` -- When using direct repository storage (source install-style configuration): +- When using direct repository storage (self-compiled installation-style configuration): ```plaintext default: @@ -51,8 +51,8 @@ configuration option is deprecated in favor of using [Gitaly](gitaly/index.md). To configure repository storage paths: 1. Edit the necessary configuration files: - - `/etc/gitlab/gitlab.rb`, for Omnibus GitLab installations. - - `gitlab.yml`, for installations from source. + - `/etc/gitlab/gitlab.rb`, for Linux package installations. + - `gitlab.yml`, for self-compiled installations. 1. Add the required repository storage paths. For repository storage paths: @@ -78,15 +78,15 @@ For [backups](../raketasks/backup_restore.md) to work correctly: - The repository storage path cannot be a mount point. - The GitLab user must have correct permissions for the parent directory of the path. -Omnibus GitLab takes care of these issues for you, but for source installations you should be extra +The Linux package takes care of these issues for you but for self-compiled installations, you should be extra careful. While restoring a backup, the current contents of `/home/git/repositories` are moved to `/home/git/repositories.old`. If `/home/git/repositories` is a mount point, then `mv` would be moving things between mount points, and problems can occur. -Ideally, `/home/git` is the mount point, so things remain inside the same mount point. Omnibus -GitLab installations guarantee this because they don't specify the full repository path but instead +Ideally, `/home/git` is the mount point, so things remain inside the same mount point. Linux package +installations guarantee this because they don't specify the full repository path but instead the parent path, but source installations do not. ### Example configuration @@ -94,14 +94,14 @@ the parent path, but source installations do not. In the examples below, we add two additional repository storage paths configured to two additional mount points. -For compatibility reasons `gitlab.yml` has a different structure than Omnibus GitLab configuration: +For compatibility reasons `gitlab.yml` has a different structure than Linux package installation configuration: -- In `gitlab.yml`, you indicate the path for the repositories, for example `/home/git/repositories` -- In Omnibus GitLab configuration you indicate `git_data_dirs`, which could be `/home/git` for - example. Then Omnibus GitLab creates a `repositories` directory under that path to use with +- In `gitlab.yml`, you indicate the path for the repositories. For example, `/home/git/repositories`. +- In Linux package installation configuration, you indicate `git_data_dirs`, which could be `/home/git` for + example. The Linux package installation then creates a `repositories` directory under that path to use with `gitlab.yml`. -**For installations from source** +For self-compiled installations: 1. Edit `gitlab.yml` and add the storage paths: @@ -122,7 +122,7 @@ For compatibility reasons `gitlab.yml` has a different structure than Omnibus Gi 1. [Configure where new repositories are stored](#configure-where-new-repositories-are-stored). -**For Omnibus installations** +For Linux package installations: 1. Edit `/etc/gitlab/gitlab.rb` by appending the rest of the paths to the default one: @@ -134,12 +134,12 @@ For compatibility reasons `gitlab.yml` has a different structure than Omnibus Gi }) ``` -1. [Restart GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Restart GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Configure where new repositories are stored](#configure-where-new-repositories-are-stored). NOTE: -Omnibus stores the repositories in a `repositories` subdirectory of the `git-data` directory. +Linux package installations store the repositories in a `repositories` subdirectory of the `git-data` directory. ## Configure where new repositories are stored diff --git a/doc/administration/repository_storage_types.md b/doc/administration/repository_storage_types.md index ab95887380d..375c9a6e981 100644 --- a/doc/administration/repository_storage_types.md +++ b/doc/administration/repository_storage_types.md @@ -19,9 +19,8 @@ GitLab can be configured to use one or multiple repository storages. These stora In GitLab: - Repository storages are configured in: - - `/etc/gitlab/gitlab.rb` by the `git_data_dirs({})` configuration hash for Omnibus GitLab - installations. - - `gitlab.yml` by the `repositories.storages` key for installations from source. + - `/etc/gitlab/gitlab.rb` by the `git_data_dirs({})` configuration hash for Linux package installations. + - `gitlab.yml` by the `repositories.storages` key for self-compiled installations. - The `default` repository storage is available in any installations that haven't customized it. By default, it points to a Gitaly node. @@ -115,7 +114,7 @@ To look up a project's name using the Rails console: ``` The quoted string in that command is the directory tree you can find on your GitLab server. For -example, on a default Omnibus installation this would be `/var/opt/gitlab/git-data/repositories/@hashed/b1/7e/b17ef6d19c7a5b1ee83b907c595526dcb1eb06db8227d650d5dda0a9f4ce8cd9.git` +example, on a default Linux package installation this would be `/var/opt/gitlab/git-data/repositories/@hashed/b1/7e/b17ef6d19c7a5b1ee83b907c595526dcb1eb06db8227d650d5dda0a9f4ce8cd9.git` with `.git` from the end of the directory name removed. The output includes the project ID and the project name. For example: @@ -126,8 +125,8 @@ The output includes the project ID and the project name. For example: To look up a project's name using the `config` file in the `*.git` directory: -1. Navigate to the to the `*.git` directory. This directory is located in `/var/opt/gitlab/git-data/repositories/@hashed/`, where the first four - characters of the hash are the first two directories in the path under `@hashed/`. For example, on a default Omnibus GitLab installation the +1. Locate the `*.git` directory. This directory is located in `/var/opt/gitlab/git-data/repositories/@hashed/`, where the first four + characters of the hash are the first two directories in the path under `@hashed/`. For example, on a default Linux package installation the `*.git` directory of the hash `b17eb17ef6d19c7a5b1ee83b907c595526dcb1eb06db8227d650d5dda0a9f4ce8cd9` would be `/var/opt/gitlab/git-data/repositories/@hashed/b1/7e/b17ef6d19c7a5b1ee83b907c595526dcb1eb06db8227d650d5dda0a9f4ce8cd9.git`. 1. Open the `config` file and locate the `fullpath=` key under `[gitlab]`. diff --git a/doc/administration/restart_gitlab.md b/doc/administration/restart_gitlab.md index e86541b7ced..51a4fe40b16 100644 --- a/doc/administration/restart_gitlab.md +++ b/doc/administration/restart_gitlab.md @@ -12,12 +12,12 @@ its services. NOTE: A short downtime is expected for all methods. -## Omnibus installations +## Linux package installations -If you have used the [Omnibus packages](https://about.gitlab.com/install/) to install GitLab, +If you have used the [Linux package](https://about.gitlab.com/install/) to install GitLab, you should already have `gitlab-ctl` in your `PATH`. -`gitlab-ctl` interacts with the Omnibus packages and can be used to restart the +`gitlab-ctl` interacts with the Linux package installation and can be used to restart the GitLab Rails application (Puma) as well as the other components, like: - GitLab Workhorse @@ -28,10 +28,10 @@ GitLab Rails application (Puma) as well as the other components, like: - [Mailroom](reply_by_email.md) - Logrotate -### Omnibus GitLab restart +### Restart a Linux package installation There may be times in the documentation where you are asked to _restart_ -GitLab. To restart, run the following command: +GitLab. To restart a Linux package installation, run: ```shell sudo gitlab-ctl restart @@ -71,15 +71,14 @@ In that case, you can use `gitlab-ctl kill <service>` to send the `SIGKILL` signal to the service, for example `sidekiq`. After that, a restart should perform fine. -As a last resort, you can try to -[reconfigure GitLab](#omnibus-gitlab-reconfigure) instead. +As a last resort, you can try to reconfigure GitLab instead. -### Omnibus GitLab reconfigure +### Reconfigure a Linux package installation There may be times in the documentation where you are asked to _reconfigure_ -GitLab. Remember that this method applies only for the Omnibus packages. +GitLab. Remember that this method applies only for Linux package installations. -Reconfigure Omnibus GitLab with: +To reconfigure a Linux package installation, run: ```shell sudo gitlab-ctl reconfigure @@ -89,10 +88,10 @@ Reconfiguring GitLab should occur in the event that something in its configuration (`/etc/gitlab/gitlab.rb`) has changed. When you run `gitlab-ctl reconfigure`, [Chef](https://www.chef.io/products/chef-infra), -the underlying configuration management application that powers Omnibus GitLab, runs some checks. +the underlying configuration management application that powers Linux package installations, runs some checks. Chef ensures directories, permissions, and services are in place and working. -Chef also [restarts GitLab components](#how-to-restart-gitlab) if any of their configuration files have changed. +Chef also restarts GitLab components if any of their configuration files have changed. If you manually edit any files in `/var/opt/gitlab` that are managed by Chef, running `reconfigure` reverts the changes and restarts the services that diff --git a/doc/administration/sidekiq/index.md b/doc/administration/sidekiq/index.md index 6fb12aa6ef9..bb517e21fd0 100644 --- a/doc/administration/sidekiq/index.md +++ b/doc/administration/sidekiq/index.md @@ -278,7 +278,7 @@ To serve metrics via HTTPS instead of HTTP, enable TLS in the exporter settings: sidekiq['exporter_tls_key_path'] = "/path/to/private-key.pem" ``` -1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. When TLS is enabled, the same `port` and `address` are used as described above. diff --git a/doc/administration/sidekiq/sidekiq_job_migration.md b/doc/administration/sidekiq/sidekiq_job_migration.md index 1332d9b35d8..89da174eb34 100644 --- a/doc/administration/sidekiq/sidekiq_job_migration.md +++ b/doc/administration/sidekiq/sidekiq_job_migration.md @@ -17,7 +17,7 @@ If the Sidekiq routing rules are changed, administrators need to take care with 1. Listen to both the old and new queues. 1. Update the routing rules. -1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Run the [Rake tasks for migrating queued and future jobs](#migrate-queued-and-future-jobs). 1. Stop listening to the old queues. diff --git a/doc/administration/smime_signing_email.md b/doc/administration/smime_signing_email.md index 4e49eef44df..0620a68f1f4 100644 --- a/doc/administration/smime_signing_email.md +++ b/doc/administration/smime_signing_email.md @@ -42,7 +42,7 @@ third parties. gitlab_rails['gitlab_email_smime_ca_certs_file'] = '/etc/gitlab/ssl/gitlab_smime_cas.crt' ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. The key must be readable by the GitLab system user (`git` by default). diff --git a/doc/administration/terraform_state.md b/doc/administration/terraform_state.md index 3ac9a5fdce8..2da6916c313 100644 --- a/doc/administration/terraform_state.md +++ b/doc/administration/terraform_state.md @@ -48,7 +48,7 @@ Prerequisite: gitlab_rails['terraform_state_enabled'] = false ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **In installations from source:** @@ -75,7 +75,7 @@ Terraform state files are stored locally, follow the steps below. gitlab_rails['terraform_state_storage_path'] = "/mnt/storage/terraform_state" ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **In installations from source:** @@ -207,7 +207,7 @@ See [the available connection settings for different providers](object_storage.m } ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. [Migrate any existing local states to the object storage](#migrate-to-object-storage) **In installations from source:** diff --git a/doc/administration/troubleshooting/postgresql.md b/doc/administration/troubleshooting/postgresql.md index 2a26a48541e..120d566a7e7 100644 --- a/doc/administration/troubleshooting/postgresql.md +++ b/doc/administration/troubleshooting/postgresql.md @@ -135,7 +135,7 @@ postgresql['statement_timeout'] = '15s' postgresql['idle_in_transaction_session_timeout'] = '60s' ``` -Once saved, [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +Once saved, [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. NOTE: These are Omnibus GitLab settings. If an external database, such as a customer's PostgreSQL installation or Amazon RDS is being used, these values don't get set, and would have to be set externally. @@ -148,7 +148,7 @@ The following advice does not apply in case because the changed timeout might affect more transactions than intended. In some situations, it may be desirable to set a different statement timeout -without having to [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure), +without having to [reconfigure GitLab](../restart_gitlab.md#reconfigure-a-linux-package-installation), which in this case would restart Puma and Sidekiq. For example, a backup may fail with the following errors in the output of the diff --git a/doc/administration/uploads.md b/doc/administration/uploads.md index ab900d7ea9f..dd311ba26cb 100644 --- a/doc/administration/uploads.md +++ b/doc/administration/uploads.md @@ -36,7 +36,7 @@ _The uploads are stored by default in `/var/opt/gitlab/gitlab-rails/uploads`._ This setting only applies if you haven't changed the `gitlab_rails['uploads_storage_path']` directory. -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. **In installations from source:** @@ -110,7 +110,7 @@ _The uploads are stored by default in } ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. 1. Migrate any existing local uploads to the object storage with the [`gitlab:uploads:migrate:all` Rake task](raketasks/uploads/migrate.md). **In installations from source:** diff --git a/doc/administration/user_settings.md b/doc/administration/user_settings.md index b02e1c7244b..2df7f882223 100644 --- a/doc/administration/user_settings.md +++ b/doc/administration/user_settings.md @@ -28,7 +28,7 @@ To disable new users' ability to create top-level groups using the configuration gitlab_rails['gitlab_default_can_create_group'] = false ``` -1. [Reconfigure and restart GitLab](restart_gitlab.md#omnibus-installations). +1. [Reconfigure and restart GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation). **Source installations** @@ -60,7 +60,7 @@ ability to change their usernames: gitlab_rails['gitlab_username_changing_enabled'] = false ``` -1. [Reconfigure and restart GitLab](restart_gitlab.md#omnibus-installations). +1. [Reconfigure and restart GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation). **Source installations** diff --git a/doc/api/integrations.md b/doc/api/integrations.md index da19a4de72b..7e7a514acf4 100644 --- a/doc/api/integrations.md +++ b/doc/api/integrations.md @@ -1389,6 +1389,8 @@ Parameters: | `confidential_note_events` | boolean | false | Enable notifications for confidential note events | | `deployment_channel` | string | false | The name of the channel to receive deployment events notifications | | `deployment_events` | boolean | false | Enable notifications for deployment events | +| `incident_channel` | string | false | The name of the channel to receive incidents events notifications | +| `incidents_events` | boolean | false | Enable notifications for incident events | | `issue_channel` | string | false | The name of the channel to receive issues events notifications | | `issues_events` | boolean | false | Enable notifications for issue events | | `job_events` | boolean | false | Enable notifications for job events | diff --git a/doc/api/rest/index.md b/doc/api/rest/index.md index 773b7b78eec..3a2e49cdcf9 100644 --- a/doc/api/rest/index.md +++ b/doc/api/rest/index.md @@ -208,7 +208,7 @@ By default, impersonation is enabled. To disable impersonation: gitlab_rails['impersonation_enabled'] = false ``` -1. Save the file, and then [reconfigure](../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file, and then [reconfigure](../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. To re-enable impersonation, remove this configuration, and then reconfigure diff --git a/doc/ci/runners/saas/linux_saas_runner.md b/doc/ci/runners/saas/linux_saas_runner.md index eb26c0a73a4..d95fc701056 100644 --- a/doc/ci/runners/saas/linux_saas_runner.md +++ b/doc/ci/runners/saas/linux_saas_runner.md @@ -10,7 +10,7 @@ When you run jobs on SaaS runners on Linux, the runners are on auto-scaled ephem The default region for the VMs is `us-east1`. Each VM uses the Google Container-Optimized OS (COS) and the latest version of Docker Engine running the `docker+machine` -[executor](https://docs.gitlab.com/runner/executors#docker-machine-executor). +[executor](https://docs.gitlab.com/runner/executors/#docker-machine-executor). ## Machine types available for Linux (x86-64) @@ -32,7 +32,7 @@ The machine type and underlying processor type can change. Jobs optimized for a ## Container images -As runners on Linux are using the `docker+machine` [executor](https://docs.gitlab.com/runner/executors#docker-machine-executor), +As runners on Linux are using the `docker+machine` [executor](https://docs.gitlab.com/runner/executors/#docker-machine-executor), you can choose any container image by defining the [`image`](../../../ci/yaml/index.md#image) in your `.gitlab-ci.yml` file. If no image is set, the default is `ruby:3.1`. diff --git a/doc/development/contributing/index.md b/doc/development/contributing/index.md index bc8ed6e2cd4..17e45f8c96d 100644 --- a/doc/development/contributing/index.md +++ b/doc/development/contributing/index.md @@ -60,8 +60,9 @@ To write and test your code, you will use the GitLab Development Kit. consider doing so with an empty rails app and port it to GDK after. - To run a pre-configured GDK instance in the cloud, use [GDK with Gitpod](../../integration/gitpod.md). - From a project's repository, select the caret (angle-down) next to **Web IDE**, - and select **Gitpod** from the list. + From a project repository: + 1. On the top bar, select **Main menu > Projects** and find your project. + 1. In the upper right, select **Edit > Gitpod**. 1. If you want to contribute to the [website](https://about.gitlab.com/) or the [handbook](https://about.gitlab.com/handbook/), go to the footer of any page and select **Edit in Web IDE** to open the [Web IDE](../../user/project/web_ide/index.md). diff --git a/doc/development/deprecation_guidelines/index.md b/doc/development/deprecation_guidelines/index.md index bc14b0f127c..e81bed07da9 100644 --- a/doc/development/deprecation_guidelines/index.md +++ b/doc/development/deprecation_guidelines/index.md @@ -9,54 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w This page includes information about how and when to remove or make breaking changes to GitLab features. -## Terminology - -<!-- -If updating these definitions, be sure to update them in the handbook as well: -https://about.gitlab.com/handbook/product/gitlab-the-product/#definitions ---> - -**Deprecation**: - -- Required before ending support for a feature or removing a feature. -- Feature not recommended for use. -- Development restricted to Priority 1 / Severity 1 bug fixes. -- Will be removed in a future major release. -- Begins after a deprecation announcement outlining an end-of-support or removal date. -- Ends after the end-of-support date or removal date has passed. - -**End of Support**: - -- Optional step before removal. -- Feature usage strongly discouraged. -- No support or fixes provided. -- No longer tested internally. -- Will be removed in a future major release. -- Begins after an end-of-support date has passed. - -[Announcing an End of Support period](https://about.gitlab.com/handbook/marketing/blog/release-posts/#announcing-an-end-of-support-period) -should only be used in special circumstances and is not recommended for general use. -Most features should be deprecated and then removed. - -**Removal**: - -- Feature usage impossible. -- Feature no longer supported (if End of Support period hasn't already been announced). -- Happens in a major release in line with our - [semantic versioning policy](../../policy/maintenance.md). -- Begins after removal date has passed. - -**Breaking change**: - -A "breaking change" is any change that requires users to make a corresponding change to their code, settings, or workflow. "Users" might be humans, API clients, or even code classes that "use" another class. Examples of breaking changes include: - -- Removing a user-facing feature without a replacement/workaround. -- Changing the definition of an existing API (by doing things like re-naming query parameters or changing routes). -- Removing a public method from a code class. - -A breaking change can be considered major if it affects many users, or represents a significant change in behavior. - -![Deprecation, End of Support, Removal process](img/deprecation_removal_process.png) +For details about the terms used on this page, see [the terminology](../../update/terminology.md). ## When can a feature be deprecated? @@ -68,6 +21,8 @@ Do not include the deprecation announcement in the merge request that introduces Use a separate MR to create a deprecation entry. For steps to create a deprecation entry, see [Deprecations](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations). +![Deprecation, End of Support, Removal process](img/deprecation_removal_process.png) + ## How are Community Contributions to a deprecated feature handled? Development on deprecated features is restricted to Priority 1 / Severity 1 bug fixes. Any community contributions to deprecated features are unlikely to be prioritized during milestone planning. diff --git a/doc/development/documentation/contribute.md b/doc/development/documentation/contribute.md index 8b08743c6e9..e86cf4318b8 100644 --- a/doc/development/documentation/contribute.md +++ b/doc/development/documentation/contribute.md @@ -50,9 +50,7 @@ When you are ready to update the documentation: 1. In your fork, find the documentation page in the `\doc` directory. 1. If you know Git, make your changes and open a merge request. If not, follow these steps: - 1. In the upper-right corner, select **Edit** if it is visible. - If it is not, select the down arrow (**{chevron-lg-down}**) next to - **Open in Web IDE** or **Gitpod**, and select **Edit**. + 1. In the upper right, select **Edit > Edit single file**. 1. In the **Commit message** text box, enter a commit message. Use 3-5 words, start with a capital letter, and do not end with a period. 1. Select **Commit changes**. diff --git a/doc/integration/alicloud.md b/doc/integration/alicloud.md index 4270444f0bb..db27cb78173 100644 --- a/doc/integration/alicloud.md +++ b/doc/integration/alicloud.md @@ -88,6 +88,6 @@ Sign in to the AliCloud platform and create an application on it. AliCloud gener 1. Save the configuration file. -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) - if you installed using Omnibus, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) + if you installed using the Linux package, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) if you installed from source. diff --git a/doc/integration/auth0.md b/doc/integration/auth0.md index 07a750143d6..03b4980ad66 100644 --- a/doc/integration/auth0.md +++ b/doc/integration/auth0.md @@ -48,7 +48,7 @@ application. 1. Add the provider configuration: - For Omnibus GitLab: + For Linux package installations: ```ruby gitlab_rails['omniauth_providers'] = [ @@ -65,7 +65,7 @@ application. ] ``` - For installations from source: + For self-compiled installations: ```yaml - { name: 'auth0', @@ -82,9 +82,9 @@ application. 1. Replace `<your_auth0_client_secret>` with the client secret from the Auth0 Console page. 1. Replace `<your_auth0_client_secret>` with the domain from the Auth0 Console page. 1. Reconfigure or restart GitLab, depending on your installation method: - - *If you installed from Omnibus GitLab,* - [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab. - - *If you installed from source,* + - If you installed using the Linux package, + [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - If you self-compiled your installation, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). On the sign-in page there should now be an Auth0 icon below the regular sign-in diff --git a/doc/integration/azure.md b/doc/integration/azure.md index 8d993dfbb63..d49fa8f53f7 100644 --- a/doc/integration/azure.md +++ b/doc/integration/azure.md @@ -315,9 +315,9 @@ Alternatively, add the `User.Read.All` application permission. 1. Save the configuration file. -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) - if you installed using Omnibus, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) - if you installed from source. +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) + if you installed using the Linux package, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) + if you self-compiled your installation. 1. Refresh the GitLab sign-in page. A Microsoft icon should display below the sign-in form. diff --git a/doc/integration/bitbucket.md b/doc/integration/bitbucket.md index 8019eccc421..81564e6eaae 100644 --- a/doc/integration/bitbucket.md +++ b/doc/integration/bitbucket.md @@ -110,9 +110,9 @@ you to use. from the Bitbucket application page. 1. Save the configuration file. -1. For the changes to take effect, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) - if you installed using Omnibus GitLab, or [restart](../administration/restart_gitlab.md#installations-from-source) - if you installed from source. +1. For the changes to take effect, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) + if you installed using the Linux package, or [restart](../administration/restart_gitlab.md#installations-from-source) + if you self-compiled your installation. On the sign-in page there should now be a Bitbucket icon below the regular sign-in form. Select the icon to begin the authentication process. Bitbucket asks diff --git a/doc/integration/ding_talk.md b/doc/integration/ding_talk.md index 97ffab146a0..fd836b80208 100644 --- a/doc/integration/ding_talk.md +++ b/doc/integration/ding_talk.md @@ -86,6 +86,6 @@ Sign in to DingTalk Open Platform and create an application on it. DingTalk gene 1. Save the configuration file. -1. For the changes to take effect, if you installed: - - Using Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - From source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). +1. For the changes to take effect, if you: + - Installed using the Linux package, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - Self-compiled your installation, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). diff --git a/doc/integration/facebook.md b/doc/integration/facebook.md index aeea798715f..4dd17d71602 100644 --- a/doc/integration/facebook.md +++ b/doc/integration/facebook.md @@ -107,8 +107,8 @@ Facebook. Facebook generates an app ID and secret key for you to use. 1. Save the configuration file. 1. For the changes to take effect: - - If you installed via Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - If you installed from source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). + - If you installed using the Linux package, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - If you self-compiled your installation, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). On the sign in page there should now be a Facebook icon below the regular sign in form. Select the icon to begin the authentication process. Facebook asks the diff --git a/doc/integration/github.md b/doc/integration/github.md index 00303754d85..4a5123e19f7 100644 --- a/doc/integration/github.md +++ b/doc/integration/github.md @@ -81,7 +81,7 @@ your website could enable the covert redirect attack. ] ``` - 1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) + 1. Save the file and [reconfigure](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab. - **For installations from source** @@ -187,9 +187,9 @@ To fix this issue, you must disable SSL verification: git config --global http.sslVerify false ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) - if you installed using Omnibus, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) - if you installed from source. +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) + if you installed using the Linux package, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) + if you self-compiled your installation. ### Signing in using GitHub Enterprise returns a 500 error diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md index 59f122a5110..b40df1f86be 100644 --- a/doc/integration/gitlab.md +++ b/doc/integration/gitlab.md @@ -111,10 +111,9 @@ GitLab.com generates an application ID and secret key for you to use. 1. Change `'YOUR_APP_ID'` to the Application ID from the GitLab.com application page. 1. Change `'YOUR_APP_SECRET'` to the secret from the GitLab.com application page. 1. Save the configuration file. -1. Based on how GitLab was installed, implement these changes by using - the appropriate method: - - Omnibus GitLab: [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - Source: [restart GitLab](../administration/restart_gitlab.md#installations-from-source). +1. Implement these changes by using the appropriate method: + - For Linux package installations, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - For self-compiled installations, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). On the sign-in page, there should now be a GitLab.com icon following the regular sign-in form. Select the icon to begin the authentication process. diff --git a/doc/integration/gitpod.md b/doc/integration/gitpod.md index 0ba227c2a85..c47aca2c7d8 100644 --- a/doc/integration/gitpod.md +++ b/doc/integration/gitpod.md @@ -59,16 +59,12 @@ GitLab users can then [enable the Gitpod integration for themselves](#enable-git You can launch Gitpod directly from GitLab in one of these ways: -- *From your project's page:* - 1. Go to your project, then go to the page you want to edit. - 1. Select the caret (**{chevron-lg-down}**) next to **Web IDE**, and select **Gitpod** - from the list: +- **From a project repository:** + 1. On the top bar, select **Main menu > Projects** and find your project. + 1. In the upper right, select **Edit > Gitpod**. - ![Gitpod Button on Project Page](img/gitpod_button_project_page_v13_4.png) - - 1. Select **Open in Gitpod**. -- *From a merge request:* +- **From a merge request:** 1. Go to your merge request. - 1. In the upper-right corner, select **Code**, then select **Open in Gitpod**. + 1. In the upper-right corner, select **Code > Open in Gitpod**. Gitpod builds your development environment for your branch. diff --git a/doc/integration/google.md b/doc/integration/google.md index 1c027921e4d..211c86b557a 100644 --- a/doc/integration/google.md +++ b/doc/integration/google.md @@ -125,8 +125,8 @@ To see your new project in the list, refresh the page. 1. Save the configuration file. 1. For the changes to take effect: - - If you installed via Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - If you installed from source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). + - If you installed using the Linux package, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - If you self-compiled your installation, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). On the sign in page there should now be a Google icon below the regular sign in form. Select the icon to begin the authentication process. Google asks the diff --git a/doc/integration/img/gitpod_button_project_page_v13_4.png b/doc/integration/img/gitpod_button_project_page_v13_4.png Binary files differdeleted file mode 100644 index 55a70d89169..00000000000 --- a/doc/integration/img/gitpod_button_project_page_v13_4.png +++ /dev/null diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md index c2be5a5a91c..f331a9c2fda 100644 --- a/doc/integration/kerberos.md +++ b/doc/integration/kerberos.md @@ -82,7 +82,7 @@ For source installations, make sure the `kerberos` gem group To avoid GitLab creating users automatically on their first sign in through Kerberos, don't set `kerberos` for `gitlab_rails['omniauth_allow_single_sign_on']`. -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. GitLab now offers the `negotiate` authentication method for signing in and HTTP Git access, enabling Git clients that support this authentication protocol @@ -193,7 +193,7 @@ ignored and an LDAP identity is not linked. gitlab_rails['kerberos_simple_ldap_linking_allowed_realms'] = ['example.com','kerberos.example.com'] ``` -1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. Save the file and [reconfigure](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab for the changes to take effect. --- @@ -284,7 +284,7 @@ this can happen in GitLab CI/CD jobs that [authenticate with the CI/CD job token gitlab_rails['kerberos_https'] = true ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. After this change, Git remote URLs have to be updated to `https://gitlab.example.com:8443/mygroup/myproject.git` to use @@ -332,7 +332,7 @@ To disable password-based Kerberos sign-ins, remove the OmniAuth provider ] ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. NOTE: Removing the `kerberos` OmniAuth provider can also resolve a rare diff --git a/doc/integration/salesforce.md b/doc/integration/salesforce.md index 8c43f038f86..40e1c4616a5 100644 --- a/doc/integration/salesforce.md +++ b/doc/integration/salesforce.md @@ -85,8 +85,8 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create 1. Save the configuration file. 1. For the changes to take effect: - - If you installed via Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - If you installed from source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). + - If you installed using the Linux package, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - If you self-compiled your installation, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). On the sign in page, there should now be a Salesforce icon below the regular sign in form. Select the icon to begin the authentication process. Salesforce asks the user to sign in and authorize the GitLab application. diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md index 11b14c0dfd2..db49b30fa21 100644 --- a/doc/integration/shibboleth.md +++ b/doc/integration/shibboleth.md @@ -85,7 +85,7 @@ To enable Shibboleth: If some of your users appear to be authenticated by Shibboleth and Apache, but GitLab rejects their account with a URI that contains "e-mail is invalid" then your Shibboleth Identity Provider or Attribute Authority may be asserting multiple email addresses. In this instance, consider setting the `multi_values` argument to `first`. 1. For the changes to take effect: - - For Omnibus GitLab, [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab. - - For installations from source, [restart](../administration/restart_gitlab.md#installations-from-source) GitLab. + - For Linux package installations, [reconfigure](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab. + - For self-compiled installations, [restart](../administration/restart_gitlab.md#installations-from-source) GitLab. On the sign in page, there should now be a **Sign in with: Shibboleth** icon below the regular sign-in form. Select the icon to begin the authentication process. You are redirected to the appropriate IdP server for your Shibboleth module configuration. If everything goes well, you are returned to GitLab and signed in. diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md index 0ccda59f9b3..3edb0f25938 100644 --- a/doc/integration/twitter.md +++ b/doc/integration/twitter.md @@ -96,10 +96,9 @@ Twitter. Twitter generates a client ID and secret key for you to use. 1. Save the configuration file. -1. For the changes to take effect, if you installed: - - - Using Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - From source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). +1. For the changes to take effect: + - For Linux package installations, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). + - For self-compiled installations, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). On the sign-in page, find the Twitter option below the regular sign-in form. Select the option to begin the authentication process. Twitter asks you to sign in and authorize the GitLab application. After authorization, you are returned to GitLab and signed in. diff --git a/doc/raketasks/backup_gitlab.md b/doc/raketasks/backup_gitlab.md index 08c9475305d..a6635c589aa 100644 --- a/doc/raketasks/backup_gitlab.md +++ b/doc/raketasks/backup_gitlab.md @@ -453,7 +453,7 @@ For Omnibus GitLab packages: # gitlab_rails['backup_multipart_chunk_size'] = 104857600 ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect #### S3 Encrypted Buckets @@ -537,7 +537,7 @@ This example can be used for a bucket in Amsterdam (AMS3): gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket' ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect If you see a `400 Bad Request` error message when using Digital Ocean Spaces, @@ -678,7 +678,7 @@ For Omnibus GitLab packages: gitlab_rails['backup_upload_remote_directory'] = 'my.google.bucket' ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect For installations from source: @@ -716,7 +716,7 @@ For Omnibus GitLab packages: gitlab_rails['backup_upload_remote_directory'] = '<AZURE BLOB CONTAINER>' ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect For installations from source: @@ -817,7 +817,7 @@ For Omnibus GitLab packages: gitlab_rails['backup_upload_remote_directory'] = 'gitlab_backups' ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For installations from source: @@ -855,7 +855,7 @@ For Omnibus GitLab packages: gitlab_rails['backup_archive_permissions'] = 0644 # Makes the backup archives world-readable ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For installations from source: @@ -939,7 +939,7 @@ For Omnibus GitLab packages: gitlab_rails['backup_keep_time'] = 604800 ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. For installations from source: diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md index cf7adb9d354..4f4bf9dfefe 100644 --- a/doc/raketasks/backup_restore.md +++ b/doc/raketasks/backup_restore.md @@ -55,7 +55,7 @@ If you have a specific reason to change the path, it can be configured in Omnibu gitlab_rails['backup_gitaly_backup_path'] = '/path/to/gitaly-backup' ``` -1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) +1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) for the changes to take effect. ## Backup timestamp diff --git a/doc/security/hardening_configuration_recommendations.md b/doc/security/hardening_configuration_recommendations.md index 06a13015633..475ec06835c 100644 --- a/doc/security/hardening_configuration_recommendations.md +++ b/doc/security/hardening_configuration_recommendations.md @@ -69,7 +69,7 @@ works, and review the information on ## Environment Variables You can customize multiple -[environment variables](https://docs.gitlab.com/omnibus/settings/environment-variables.md) +[environment variables](https://docs.gitlab.com/omnibus/settings/environment-variables.html) on self-managed systems. The main environment variable to take advantage of from a security perspective is `GITLAB_ROOT_PASSWORD` during the installation process. If you are installing the self-managed system with a diff --git a/doc/topics/autodevops/cicd_variables.md b/doc/topics/autodevops/cicd_variables.md index 529f449e452..dff36727bf2 100644 --- a/doc/topics/autodevops/cicd_variables.md +++ b/doc/topics/autodevops/cicd_variables.md @@ -136,8 +136,8 @@ Prerequisite: To configure secret variables: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. 1. Expand **Variables**. 1. Create a CI/CD variable with the prefix `K8S_SECRET_`. For example, you can create a variable called `K8S_SECRET_RAILS_MASTER_KEY`. diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md index 0d865b5cf0d..af396e159da 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_ecs.md @@ -13,8 +13,8 @@ You can choose to target AWS ECS as a deployment platform instead of using Kuber To get started on Auto DevOps to AWS ECS, you must add a specific CI/CD variable. To do so, follow these steps: -1. In GitLab, on the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Specify which AWS platform to target during the Auto DevOps deployment by adding the `AUTO_DEVOPS_PLATFORM_TARGET` variable with one of the following values: diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_eks.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_eks.md index 32a47bb790b..6348e3a5fa0 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_eks.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_eks.md @@ -48,8 +48,7 @@ those projects provide a bare-bones application built on some well-known framewo WARNING: Create the application project in the group hierarchy at the same level or below the project for cluster management. Otherwise, it fails to [authorize the agent](../../../user/clusters/agent/ci_cd_workflow.md#authorize-the-agent). -1. On the top bar in GitLab, select the plus icon (**{plus-square}**), and select - **New project/repository**. +1. On the left sidebar, at the top, select **Create new** (**{plus}**) and **New project/repository**. 1. Select **Create from template**. 1. Select the **Ruby on Rails** template. 1. Give your project a name, optionally a description, and make it public so that @@ -133,8 +132,8 @@ While Auto DevOps is enabled by default, Auto DevOps can be disabled at both the instance level (for self-managed instances) and the group level. Complete these steps to enable Auto DevOps if it's disabled: -1. On the top bar, select **Main menu > Projects** and find the application project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find the application project. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Select **Default to Auto DevOps pipeline** to display more options. 1. In **Deployment strategy**, select your desired [continuous deployment strategy](../requirements.md#auto-devops-deployment-strategy) diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md index 1a03a66d17a..dac85926ff5 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md @@ -62,8 +62,7 @@ those projects provide a bare-bones application built on some well-known framewo WARNING: Create the application project in the group hierarchy at the same level or below the project for cluster management. Otherwise, it fails to [authorize the agent](../../../user/clusters/agent/ci_cd_workflow.md#authorize-the-agent). -1. On the top bar in GitLab, select the plus icon (**{plus-square}**), and select - **New project/repository**. +1. On the left sidebar, at the top, select **Create new** (**{plus}**) and **New project/repository**. 1. Select **Create from template**. 1. Select the **Ruby on Rails** template. 1. Give your project a name, optionally a description, and make it public so that @@ -137,8 +136,8 @@ While Auto DevOps is enabled by default, Auto DevOps can be disabled at both the instance level (for self-managed instances) and the group level. Complete these steps to enable Auto DevOps if it's disabled: -1. On the top bar, select **Main menu > Projects** and find the application project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find the application project. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Select **Default to Auto DevOps pipeline** to display more options. 1. In **Deployment strategy**, select your desired [continuous deployment strategy](../requirements.md#auto-devops-deployment-strategy) diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index 87810193a8d..d51899ee7ca 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -102,8 +102,8 @@ Prerequisites: To enable Auto DevOps for a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Select the **Default to Auto DevOps pipeline** checkbox. 1. Optional but recommended. Add the [base domain](requirements.md#auto-devops-base-domain). @@ -133,8 +133,8 @@ Prerequisites: To enable Auto DevOps for a group: -1. On the top bar, select **Main menu > Groups** and find your group. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Select the **Default to Auto DevOps pipeline** checkbox. 1. Select **Save changes**. @@ -145,9 +145,9 @@ clear the **Default to Auto DevOps pipeline** checkbox. After enabling Auto DevOps at the group level, you can trigger the Auto DevOps pipeline for any project that belongs to that group: -1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. Make sure the project doesn't contain a `.gitlab-ci.yml` file. -1. On the left sidebar, select **CI/CD > Pipelines**. +1. Select **Build > Pipelines**. 1. To trigger the Auto DevOps pipeline, select **Run pipeline**. #### At the instance level **(FREE SELF)** @@ -165,8 +165,9 @@ Prerequisites: To enable Auto DevOps for your instance: -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Select the **Default to Auto DevOps pipeline** checkbox. 1. Optional. Add the Auto DevOps [base domain](requirements.md#auto-devops-base-domain). diff --git a/doc/topics/autodevops/requirements.md b/doc/topics/autodevops/requirements.md index dc126edf1aa..ce53fe26868 100644 --- a/doc/topics/autodevops/requirements.md +++ b/doc/topics/autodevops/requirements.md @@ -41,8 +41,8 @@ that works best for your needs: You can choose the deployment method when enabling Auto DevOps or later: -1. In GitLab, on the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > CI/CD**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. 1. Expand **Auto DevOps**. 1. Choose the deployment strategy. 1. Select **Save changes**. diff --git a/doc/topics/git/lfs/index.md b/doc/topics/git/lfs/index.md index 9c32ab2ed94..5f3458821dd 100644 --- a/doc/topics/git/lfs/index.md +++ b/doc/topics/git/lfs/index.md @@ -32,8 +32,8 @@ Prerequisites: To do this: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. 1. Expand the **Visibility, project features, permissions** section. 1. Turn on the **Git Large File Storage (LFS)** toggle. 1. Select **Save changes**. diff --git a/doc/tutorials/dependency_scanning.md b/doc/tutorials/dependency_scanning.md index c5f65a8affc..53f329d5bfd 100644 --- a/doc/tutorials/dependency_scanning.md +++ b/doc/tutorials/dependency_scanning.md @@ -138,8 +138,8 @@ need to upgrade the `fastify` package. To fix the vulnerability: -1. Go to **Repository > Files**. -1. From the **WebIDE** dropdown list select **GitPod**, then right-click on **GitPod** to open +1. On the top bar, select **Main menu > Projects** and find your project. +1. In the upper right, select **Edit > GitPod** and open GitPod in a new tab. 1. If you are prompted to, select **Continue with GitLab**, then select **Authorize**. 1. On the **New Workspace** page, select **Continue**. diff --git a/doc/update/terminology.md b/doc/update/terminology.md new file mode 100644 index 00000000000..6babbdbc991 --- /dev/null +++ b/doc/update/terminology.md @@ -0,0 +1,47 @@ +--- +stage: none +group: unassigned +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Deprecation terms + +## Deprecation + +- Required before ending support for a feature or removing a feature. +- Feature not recommended for use. +- Development restricted to Priority 1 / Severity 1 bug fixes. +- Will be removed in a future major release. +- Begins after a deprecation announcement outlining an end-of-support or removal date. +- Ends after the end-of-support date or removal date has passed. + +## End of Support + +- Optional step before removal. +- Feature usage strongly discouraged. +- No support or fixes provided. +- No longer tested internally. +- Will be removed in a future major release. +- Begins after an end-of-support date has passed. + +[Announcing an End of Support period](https://about.gitlab.com/handbook/marketing/blog/release-posts/#announcing-an-end-of-support-period) +should only be used in special circumstances and is not recommended for general use. +Most features should be deprecated and then removed. + +## Removal + +- Feature usage impossible. +- Feature no longer supported (if End of Support period hasn't already been announced). +- Happens in a major release in line with our + [semantic versioning policy](../policy/maintenance.md). +- Begins after removal date has passed. + +## Breaking change + +A "breaking change" is any change that requires users to make a corresponding change to their code, settings, or workflow. "Users" might be humans, API clients, or even code classes that "use" another class. Examples of breaking changes include: + +- Removing a user-facing feature without a replacement/workaround. +- Changing the definition of an existing API (by doing things like re-naming query parameters or changing routes). +- Removing a public method from a code class. + +A breaking change can be considered major if it affects many users, or represents a significant change in behavior. diff --git a/doc/user/profile/account/two_factor_authentication.md b/doc/user/profile/account/two_factor_authentication.md index 57852d3e6ac..b856366bb58 100644 --- a/doc/user/profile/account/two_factor_authentication.md +++ b/doc/user/profile/account/two_factor_authentication.md @@ -145,8 +145,9 @@ Configure FortiAuthenticator in GitLab. On your GitLab server: ``` 1. Save the configuration file. -1. [Reconfigure](../../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) (Linux package) or - [restart](../../../administration/restart_gitlab.md#installations-from-source) (self-compiled installations). +1. [Reconfigure](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) + (Linux package installations) or [restart](../../../administration/restart_gitlab.md#installations-from-source) + (self-compiled installations). ### Enable one-time password using Duo @@ -209,7 +210,7 @@ On your GitLab server: ``` 1. Save the configuration file. -1. For Linux package installations, [reconfigure GitLab](../../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). +1. For Linux package installations, [reconfigure GitLab](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation). For installations from source, [restart GitLab](../../../administration/restart_gitlab.md#installations-from-source). ### Enable one-time password using FortiToken Cloud @@ -266,7 +267,7 @@ Configure FortiToken Cloud in GitLab. On your GitLab server: ``` 1. Save the configuration file. -1. [Reconfigure](../../../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) (Linux package) or +1. [Reconfigure](../../../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) (Linux package installations) or [restart](../../../administration/restart_gitlab.md#installations-from-source) (self-compiled installations). ### Set up a WebAuthn device diff --git a/doc/user/project/issues/confidential_issues.md b/doc/user/project/issues/confidential_issues.md index 79278d1b3ad..2f698b5424c 100644 --- a/doc/user/project/issues/confidential_issues.md +++ b/doc/user/project/issues/confidential_issues.md @@ -15,36 +15,35 @@ keep security vulnerabilities private or prevent surprises from leaking out. You can make an issue confidential when you create or edit an issue. +### In a new issue + When you create a new issue, a checkbox right below the text area is available to mark the issue as confidential. Check that box and select **Create issue** -to create the issue. For existing issues, edit them, check the -confidential checkbox and select **Save changes**. +to create the issue. When you create a confidential issue in a project, the project becomes listed in the **Contributed projects** section in your [profile](../../profile/index.md). **Contributed projects** does not show information about the confidential issue; it only shows the project name. -![Creating a new confidential issue](img/confidential_issues_create_v15_4.png) - -## Modify issue confidentiality +To create a confidential issue: -There are two ways to change an issue's confidentiality. +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the top bar, select the plus sign (**{plus-square}**) and then, under **This project**, + select **New issue**. +1. Complete the [fields](create_issues.md#fields-in-the-new-issue-form). + - Select the **This issue is confidential...** checkbox. +1. Select **Create issue**. -The first way is to edit the issue and toggle the confidentiality checkbox. -After you save the issue, the confidentiality of the issue is updated. +### In an existing issue -The second way is to locate the **Confidentiality** section in the sidebar and select -**Edit**. A popup should appear and give you the option to turn on or turn off confidentiality. +To change the confidentiality of an existing issue: -| Turn off confidentiality | Turn on confidentiality | -| :-----------: | :----------: | -| ![Turn off confidentiality](img/turn_off_confidentiality_v15_1.png) | ![Turn on confidentiality](img/turn_on_confidentiality_v15_1.png) | - -Every change from regular to confidential and vice versa, is indicated by a -system note in the issue's comments: +1. On the top bar, select **Main menu > Projects** and find your project. +1. Select **Issues**, then select the title of your issue to view it. +1. On the right sidebar, next to **Confidentiality**, select **Edit**. +1. Select **Turn on** (or **Turn off** to make the issue non-confidential). -![Confidential issues system notes](img/confidential_issues_system_notes_v15_4.png) +Alternatively, you can use the `/confidential` [quick action](../quick_actions.md#issues-merge-requests-and-epics). -- **{eye-slash}** The issue is made confidential. -- **{eye}** The issue is made public. +## Who can see confidential issues When an issue is made confidential, only users with at least the Reporter role for the project have access to the issue. @@ -53,8 +52,8 @@ the issue even if they were actively participating before the change. ## Confidential issue indicators -There are a few things that visually separate a confidential issue from a -regular one. In the issues index page view, you can see the confidential (**{eye-slash}**) icon +Confidential issues are visually different from regular issues in a few ways. +In the issues index page view, you can see the confidential (**{eye-slash}**) icon next to the issues that are marked as confidential: ![Confidential issues index page](img/confidential_issues_index_page.png) @@ -62,8 +61,6 @@ next to the issues that are marked as confidential: If you don't have [enough permissions](#permissions-and-access-to-confidential-issues), you cannot see confidential issues at all. ---- - Likewise, while inside the issue, you can see the confidential (**{eye-slash}**) icon right next to the issue number. There is also an indicator in the comment area that the issue you are commenting on is confidential. @@ -76,6 +73,14 @@ There is also an indicator on the sidebar denoting confidentiality. | :-----------: | :----------: | | ![Sidebar confidential issue](img/sidebar_confidential_issue.png) | ![Sidebar not confidential issue](img/sidebar_not_confidential_issue.png) | +Every change from regular to confidential and vice versa, is indicated by a +system note in the issue's comments: + +- **{eye-slash}** The issue is made confidential. +- **{eye}** The issue is made public. + +![Confidential issues system notes](img/confidential_issues_system_notes_v15_4.png) + ## Merge requests for confidential issues Although you can create confidential issues (and make existing issues confidential) in a public project, you cannot make confidential merge requests. @@ -83,7 +88,7 @@ Learn how to create [merge requests for confidential issues](../merge_requests/c ## Permissions and access to confidential issues -There are two kinds of level access for confidential issues. The general rule +Access to confidential issues is by one of two routes. The general rule is that confidential issues are visible only to members of a project with at least the **Reporter role**. diff --git a/doc/user/project/issues/create_issues.md b/doc/user/project/issues/create_issues.md index 4511c89b0ff..1fc7118f2e6 100644 --- a/doc/user/project/issues/create_issues.md +++ b/doc/user/project/issues/create_issues.md @@ -197,7 +197,7 @@ To offer email support, enable [Service Desk](../service_desk.md) for your proje Now, when your customer sends a new email, a new issue can be created in the appropriate project and followed up from there. -### Fields in the new issue form +## Fields in the new issue form > - Adding the new issue to an epic [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13847) in GitLab 13.1. > - Iteration field [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233517) in GitLab 15.6. diff --git a/doc/user/project/issues/img/confidential_issues_create_v15_4.png b/doc/user/project/issues/img/confidential_issues_create_v15_4.png Binary files differdeleted file mode 100644 index ff489ad8605..00000000000 --- a/doc/user/project/issues/img/confidential_issues_create_v15_4.png +++ /dev/null diff --git a/doc/user/project/issues/img/turn_off_confidentiality_v15_1.png b/doc/user/project/issues/img/turn_off_confidentiality_v15_1.png Binary files differdeleted file mode 100644 index e6050aec0de..00000000000 --- a/doc/user/project/issues/img/turn_off_confidentiality_v15_1.png +++ /dev/null diff --git a/doc/user/project/issues/img/turn_on_confidentiality_v15_1.png b/doc/user/project/issues/img/turn_on_confidentiality_v15_1.png Binary files differdeleted file mode 100644 index c81ac85ab13..00000000000 --- a/doc/user/project/issues/img/turn_on_confidentiality_v15_1.png +++ /dev/null diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index dc988846676..c81f4e93166 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -58,13 +58,7 @@ To edit a text file in the Web Editor: 1. On the top bar, select **Main menu > Projects** and find your project. 1. Go to your file. -1. In the upper-right corner of the file, select **Edit**. - - If **Edit** is not visible: - - 1. Next to **Open in Web IDE** or **Open in Gitpod**, select the down arrow (**{chevron-lg-down}**). - 1. From the dropdown list, select **Edit** as your default setting. - 1. Select **Edit**. +1. In the upper right, select **Edit > Edit single file**. ### Keyboard shortcuts diff --git a/doc/user/project/service_desk.md b/doc/user/project/service_desk.md index b777110d670..249a83ff022 100644 --- a/doc/user/project/service_desk.md +++ b/doc/user/project/service_desk.md @@ -716,7 +716,7 @@ In GitLab 15.9 and earlier, uploads to a comment are sent as links in the email. Service Desk issues are [confidential](issues/confidential_issues.md), so they are only visible to project members. The project owner can -[make an issue public](issues/confidential_issues.md#modify-issue-confidentiality). +[make an issue public](issues/confidential_issues.md#in-an-existing-issue). When a Service Desk issue becomes public, the issue creator's and participants' email addresses are visible to signed-in users with at least the Reporter role for the project. diff --git a/doc/user/project/web_ide/index.md b/doc/user/project/web_ide/index.md index cb04957a2b6..1e54566ab3f 100644 --- a/doc/user/project/web_ide/index.md +++ b/doc/user/project/web_ide/index.md @@ -36,13 +36,7 @@ You can also open the Web IDE from: To open the Web IDE from a file or the repository file list: -- In the upper-right corner of the page, select **Open in Web IDE**. - -If **Open in Web IDE** is not visible: - -1. Next to **Edit** or **Gitpod**, select the down arrow (**{chevron-lg-down}**). -1. From the dropdown list, select **Open in Web IDE**. -1. Select **Open in Web IDE**. +- In the upper right, select **Edit > Open in Web IDE**. ### From a merge request |