Docs: Add documentation for gitlab_shell_git_timeout configuration setting
Problem to solve
The gitlab_shell_git_timeout setting controls repository clone/fetch timeouts and is especially relevant for Geo deployments with limited bandwidth.
Currently:
-
The setting is not clearly documented in admin or rails documentation
-
It is only indirectly mentioned in Geo troubleshooting pages
-
The default value (10800 seconds) and its purpose are not explained in a single, discoverable location
This can make it difficult for administrators to understand and diagnose Geo sync timeouts.
Further details
Adding clear documentation would help:
-
Geo administrators operating over slow or constrained networks
-
Reduce confusion when repository syncs fail due to timeouts
-
Reduce reliance on troubleshooting only documentation
Audience: Gitlab admins managing geo replication.
Proposal
-
Add explicit documentation for
gitlab_shell_git_timeoutin admin docs -
Explain:
-
What the setting controls
-
Default value (10800 seconds)
-
When and why it may need adjustment (e.g. large repos, slow links)
-
-
Link or reference existing Geo troubleshooting documentation where relevant
Who can address the issue
-
Contributors familiar with Gitlab geo and admin documentation
-
Guidance from geo maintainers on preferred documentation location would be helpful
Other links/references
- Related MR: omnibus-gitlab!9036 (merged)
- Related issue: #9052 (closed)