Commit 1860ec5f authored by Paul Okstad's avatar Paul Okstad Committed by Imre Farkas

Document Praefect subcommand

Updates Praefect documentation to mention new connection checker
subcommand for diagnosis of configuration and connectivity issues.
parent 43650748
---
title: Update Praefect docs for subcommand
merge_request: 23255
author:
type: added
...@@ -260,6 +260,14 @@ git_data_dirs({ ...@@ -260,6 +260,14 @@ git_data_dirs({
For more information on Gitaly server configuration, see our [Gitaly documentation](index.md#3-gitaly-server-configuration). For more information on Gitaly server configuration, see our [Gitaly documentation](index.md#3-gitaly-server-configuration).
When all Gitaly servers are configured, you can run the Praefect connection
checker to verify Praefect can connect to all Gitaly servers in the Praefect
config:
```shell
sudo /opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml dial-nodes
```
#### GitLab #### GitLab
When Praefect is running, it should be exposed as a storage to GitLab. This When Praefect is running, it should be exposed as a storage to GitLab. This
...@@ -311,4 +319,5 @@ Here are common errors and potential causes: ...@@ -311,4 +319,5 @@ Here are common errors and potential causes:
- **GRPC::Unavailable (14:failed to connect to all addresses)** - **GRPC::Unavailable (14:failed to connect to all addresses)**
- GitLab was unable to reach Praefect. - GitLab was unable to reach Praefect.
- **GRPC::Unavailable (14:all SubCons are in TransientFailure...)** - **GRPC::Unavailable (14:all SubCons are in TransientFailure...)**
- Praefect cannot reach one or more of its child Gitaly nodes. - Praefect cannot reach one or more of its child Gitaly nodes. Try running
the Praefect connection checker to diagnose.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment