summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristiaan Conover <cconover@gitlab.com>2019-08-22 16:25:36 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2019-08-22 16:25:36 +0000
commit30db6e853c0d65b9086f3ba4ccd91a6cb9eb1b8f (patch)
treef7c9681cef7e7f811ff2a4db00c255f7654eba83
parentfdd5177ac3d85bedb7b28f71942d220c9a3edff7 (diff)
downloadgitlab-ce-30db6e853c0d65b9086f3ba4ccd91a6cb9eb1b8f.tar.gz
Document Gitaly CLI connection troubleshooting
Provide documentation around possible reasons and solutions to CLI tools not being able to connect to Gitaly nodes.
-rw-r--r--doc/administration/gitaly/index.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md
index 878f0ef842d..e0a06e71316 100644
--- a/doc/administration/gitaly/index.md
+++ b/doc/administration/gitaly/index.md
@@ -655,3 +655,33 @@ To fix this problem, confirm that your [`gitlab-secrets.json` file](#3-gitaly-se
on the Gitaly node matches the one on all other nodes. If it doesn't match,
update the secrets file on the Gitaly node to match the others, then
[reconfigure the node](../restart_gitlab.md#omnibus-gitlab-reconfigure).
+
+### Command line tools cannot connect to Gitaly
+
+If you are having trouble connecting to a Gitaly node with command line (CLI) tools, and certain actions result in a `14: Connect Failed` error message, it means that gRPC cannot reach your Gitaly node.
+
+Verify that you can reach Gitaly via TCP:
+
+```bash
+sudo gitlab-rake gitlab:tcp_check[GITALY_SERVER_IP,GITALY_LISTEN_PORT]
+```
+
+If the TCP connection fails, check your network settings and your firewall rules. If the TCP connection succeeds, your networking and firewall rules are correct.
+
+If you use proxy servers in your command line environment, such as Bash, these can interfere with your gRPC traffic.
+
+If you use Bash or a compatible command line environment, run the following commands to determine whether you have proxy servers configured:
+
+```bash
+echo $http_proxy
+echo $https_proxy
+```
+
+If either of these variables have a value, your Gitaly CLI connections may be getting routed through a proxy which cannot connect to Gitaly.
+
+To remove the proxy setting, run the following commands (depending on which variables had values):
+
+```bash
+unset http_proxy
+unset https_proxy
+``` \ No newline at end of file