debian-mirror-gitlab/doc/user/admin_area/geo_nodes.md

109 lines
5.6 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Enablement
group: Geo
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-09-04 21:01:54 +05:30
type: howto
---
2021-10-27 15:23:28 +05:30
# Geo sites Admin Area **(PREMIUM SELF)**
2019-07-31 22:56:46 +05:30
2021-10-27 15:23:28 +05:30
You can configure various settings for GitLab Geo sites. For more information, see
2020-11-24 15:15:51 +05:30
[Geo documentation](../../administration/geo/index.md).
2019-07-31 22:56:46 +05:30
2021-10-27 15:23:28 +05:30
On either the primary or secondary site:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Geo > Nodes**.
2019-07-31 22:56:46 +05:30
## Common settings
2021-10-27 15:23:28 +05:30
All Geo sites have the following settings:
2019-07-31 22:56:46 +05:30
| Setting | Description |
| --------| ----------- |
2021-10-27 15:23:28 +05:30
| Primary | This marks a Geo site as **primary** site. There can be only one **primary** site. |
| Name | The unique identifier for the Geo site. It's highly recommended to use a physical location as a name. Good examples are "London Office" or "us-east-1". Avoid words like "primary", "secondary", "Geo", or "DR". This makes the failover process easier because the physical location does not change, but the Geo site role can. All nodes in a single Geo site use the same site name. Nodes use the `gitlab_rails['geo_node_name']` setting in `/etc/gitlab/gitlab.rb` to lookup their Geo site record in the PostgreSQL database. If `gitlab_rails['geo_node_name']` is not set, then the node's `external_url` with trailing slash is used as fallback. The value of `Name` is case-sensitive, and most characters are allowed. |
2019-07-31 22:56:46 +05:30
| URL | The instance's user-facing URL. |
2021-10-27 15:23:28 +05:30
The site you're currently browsing is indicated with a blue `Current` label, and
the **primary** node is listed first as `Primary site`.
2019-07-31 22:56:46 +05:30
2021-10-27 15:23:28 +05:30
## **Secondary** site settings
2019-07-31 22:56:46 +05:30
2021-10-27 15:23:28 +05:30
**Secondary** sites have a number of additional settings available:
2019-07-31 22:56:46 +05:30
| Setting | Description |
|---------------------------|-------------|
2021-10-27 15:23:28 +05:30
| Selective synchronization | Enable Geo [selective sync](../../administration/geo/replication/configuration.md#selective-synchronization) for this **secondary** site. |
| Repository sync capacity | Number of concurrent requests this **secondary** site will make to the **primary** site when backfilling repositories. |
| File sync capacity | Number of concurrent requests this **secondary** site will make to the **primary** site when backfilling files. |
2019-07-31 22:56:46 +05:30
## Geo backfill
2021-10-27 15:23:28 +05:30
**Secondary** sites are notified of changes to repositories and files by the **primary** site,
2019-07-31 22:56:46 +05:30
and will always attempt to synchronize those changes as quickly as possible.
2021-10-27 15:23:28 +05:30
Backfill is the act of populating the **secondary** site with repositories and files that
existed *before* the **secondary** site was added to the database. Since there may be
2019-07-31 22:56:46 +05:30
extremely large numbers of repositories and files, it's infeasible to attempt to
download them all at once, so GitLab places an upper limit on the concurrency of
these operations.
How long the backfill takes is a function of the maximum concurrency, but higher
2021-10-27 15:23:28 +05:30
values place more strain on the **primary** site. From [GitLab 10.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3107),
the limits are configurable. If your **primary** site has lots of surplus capacity,
2019-07-31 22:56:46 +05:30
you can increase the values to complete backfill in a shorter time. If it's
under heavy load and backfill is reducing its availability for normal requests,
you can decrease them.
## Using a different URL for synchronization
2021-10-27 15:23:28 +05:30
The **primary** site's Internal URL is used by **secondary** sites to contact it
2019-07-31 22:56:46 +05:30
(to sync repositories, for example). The name Internal URL distinguishes it from
[External URL](https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-the-external-url-for-gitlab)
which is used by users. Internal URL does not need to be a private address.
2021-09-04 01:27:46 +05:30
Internal URL defaults to external URL, but you can also customize it:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Geo > Nodes**.
2021-10-27 15:23:28 +05:30
1. Select **Edit** on the site you want to customize.
2021-09-04 01:27:46 +05:30
1. Edit the internal URL.
1. Select **Save changes**.
2019-07-31 22:56:46 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2021-10-27 15:23:28 +05:30
We recommend using an HTTPS connection while configuring the Geo sites. To avoid
breaking communication between **primary** and **secondary** sites when using
2019-09-30 21:07:59 +05:30
HTTPS, customize your Internal URL to point to a load balancer with TLS
terminated at the load balancer.
2021-04-29 21:17:54 +05:30
WARNING:
Starting with GitLab 13.3 and [until 13.11](https://gitlab.com/gitlab-org/gitlab/-/issues/325522),
using an internal URL that is not accessible to the users will result in the
OAuth authorization flow not working properly, as the users will get redirected
to the internal URL instead of the external one.
2021-10-27 15:23:28 +05:30
## Multiple secondary sites behind a load balancer
2019-07-31 22:56:46 +05:30
2021-10-27 15:23:28 +05:30
In GitLab 11.11, **secondary** sites can use identical external URLs as long as
a unique `name` is set for each Geo site. The `gitlab.rb` setting
2019-12-21 20:55:43 +05:30
`gitlab_rails['geo_node_name']` must:
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
- Be set for each GitLab instance that runs `puma`, `sidekiq`, or `geo_logcursor`.
2021-10-27 15:23:28 +05:30
- Match a Geo site name.
2019-07-31 22:56:46 +05:30
The load balancer must use sticky sessions in order to avoid authentication
failures and cross site request errors.
2019-09-04 21:01:54 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
2019-09-30 21:07:59 +05:30
but commented out to help encourage others to add to it in the future. -->