diff options
Diffstat (limited to 'doc/administration/gitaly/praefect.md')
-rw-r--r-- | doc/administration/gitaly/praefect.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 0fc9794e688..5c1f8a33246 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -12,7 +12,7 @@ be run in a clustered configuration to increase fault tolerance. In this configuration, every Git repository is stored on every Gitaly node in the cluster. Multiple clusters (or shards), can be configured. -NOTE: **Note:** +NOTE: Gitaly Clusters can be created using [GitLab Core](https://about.gitlab.com/pricing/#self-managed) and higher tiers. However, technical support is limited to GitLab Premium and Ultimate customers only. Not available in GitLab.com. @@ -188,7 +188,7 @@ We note in the instructions below where these secrets are required. ### PostgreSQL -NOTE: **Note:** +NOTE: Do not store the GitLab application database and the Praefect database on the same PostgreSQL server if using [Geo](../geo/index.md). The replication state is internal to each instance @@ -287,7 +287,7 @@ The `praefect` user and its password should be included in the file (default is `userlist.txt`) used by PgBouncer if the [`auth_file`](https://www.pgbouncer.org/config.html#auth_file) configuration option is set. -NOTE: **Note:** +NOTE: By default PgBouncer uses port `6432` to accept incoming connections. You can change it by setting the [`listen_port`](https://www.pgbouncer.org/config.html#listen_port) configuration option. We recommend setting it to the default port value (`5432`) used by @@ -298,7 +298,7 @@ PostgreSQL instances. Otherwise you should change the configuration parameter > [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2634) in GitLab 13.4, Praefect nodes can no longer be designated as `primary`. -NOTE: **Note:** +NOTE: If there are multiple Praefect nodes, complete these steps for **each** node. To complete this section you need a [configured PostgreSQL server](#postgresql), including: @@ -398,7 +398,7 @@ application server, or a Gitaly node. so we use `default` here as well. This cluster has three Gitaly nodes `gitaly-1`, `gitaly-2`, and `gitaly-3`, which are intended to be replicas of each other. - CAUTION: **Caution:** + WARNING: If you have data on an already existing storage called `default`, you should configure the virtual storage with another name and [migrate the data to the Gitaly Cluster storage](#migrate-existing-repositories-to-gitaly-cluster) @@ -573,7 +573,7 @@ To configure Praefect with TLS: path: /some/local/path ``` - NOTE: **Note:** + NOTE: `/some/local/path` should be set to a local folder that exists, however no data is stored in this folder. This requirement is scheduled to be removed when [this issue](https://gitlab.com/gitlab-org/gitaly/-/issues/1282) is resolved. @@ -602,7 +602,7 @@ To configure Praefect with TLS: ### Gitaly -NOTE: **Note:** +NOTE: Complete these steps for **each** Gitaly node. To complete this section you need: @@ -763,7 +763,7 @@ internal traffic from the GitLab application to the Praefect nodes. The specifics on which load balancer to use or the exact configuration is beyond the scope of the GitLab documentation. -NOTE: **Note:** +NOTE: The load balancer must be configured to accept traffic from the Gitaly nodes in addition to the GitLab nodes. Some requests handled by [`gitaly-ruby`](index.md#gitaly-ruby) sidecar processes call into the main Gitaly @@ -817,7 +817,7 @@ Particular attention should be shown to: 1. Disable the default Gitaly service running on the GitLab host. It isn't needed because GitLab connects to the configured cluster. - CAUTION: **Caution:** + WARNING: If you have existing data stored on the default Gitaly storage, you should [migrate the data your Gitaly Cluster storage](#migrate-existing-repositories-to-gitaly-cluster) first. @@ -1116,7 +1116,7 @@ available: - In GitLab 13.3 and later, `-partially-replicated` that specifies whether to display a list of [outdated replicas of writable repositories](#outdated-replicas-of-writable-repositories). -NOTE: **Note:** +NOTE: `dataloss` is still in beta and the output format is subject to change. To check for outdated replicas of read-only repositories, run: @@ -1214,7 +1214,7 @@ Praefect provides the following subcommands to re-enable writes: sudo /opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml accept-dataloss -virtual-storage <virtual-storage> -repository <relative-path> -authoritative-storage <storage-name> ``` -CAUTION: **Caution:** +WARNING: `accept-dataloss` causes permanent data loss by overwriting other versions of the repository. Data [recovery efforts](#data-recovery) must be performed before using it. @@ -1278,7 +1278,7 @@ Gitaly Cluster automatically. Repositories may be moved from one storage location using the [Project repository storage moves API](../../api/project_repository_storage_moves.md): -NOTE: **Note:** +NOTE: The Project repository storage moves API [cannot move all repository types](../../api/project_repository_storage_moves.md#limitations). To move repositories to Gitaly Cluster: |