diff options
Diffstat (limited to 'doc/administration/gitaly/configure_gitaly.md')
| -rw-r--r-- | doc/administration/gitaly/configure_gitaly.md | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index 51ad376a625..c9b6fd4c510 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -378,13 +378,26 @@ server (with `gitaly_address`) unless you use 1. Edit `/etc/gitlab/gitlab.rb`: ```ruby + # Use the same token value configured on all Gitaly servers + gitlab_rails['gitaly_token'] = '<AUTH_TOKEN>' + git_data_dirs({ - 'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075' }, + 'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075' }, 'storage1' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075' }, 'storage2' => { 'gitaly_address' => 'tcp://gitaly2.internal:8075' }, }) ``` + Alternatively, if each Gitaly server is configured to use a different authentication token: + + ```ruby + git_data_dirs({ + 'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075', 'gitaly_token' => '<AUTH_TOKEN_1>' }, + 'storage1' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075', 'gitaly_token' => '<AUTH_TOKEN_1>' }, + 'storage2' => { 'gitaly_address' => 'tcp://gitaly2.internal:8075', 'gitaly_token' => '<AUTH_TOKEN_2>' }, + }) + ``` + 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Run `sudo gitlab-rake gitlab:gitaly:check` on the Gitaly client (for example, the Rails application) to confirm it can connect to Gitaly servers. @@ -404,12 +417,15 @@ server (with `gitaly_address`) unless you use storages: default: gitaly_address: tcp://gitaly1.internal:8075 + gitaly_token: AUTH_TOKEN_1 path: /some/local/path storage1: gitaly_address: tcp://gitaly1.internal:8075 + gitaly_token: AUTH_TOKEN_1 path: /some/local/path storage2: gitaly_address: tcp://gitaly2.internal:8075 + gitaly_token: AUTH_TOKEN_2 path: /some/local/path ``` @@ -979,7 +995,7 @@ identical fetches. It: The pack-objects cache is a local cache. It: - Stores its metadata in the memory of the Gitaly process it is enabled in. -- Stores the actual Git data it is caching in files on local storage. +- Stores the actual Git data it is caching in files on local storage. Using local files has the benefit that the operating system may automatically keep parts of the pack-objects cache files in RAM, @@ -1021,7 +1037,7 @@ we felt we cannot assume this is true everywhere. The cache needs a directory to store its files in. This directory should be: -- In a filesystem with enough space. If the cache filesystem runs out of space, all +- In a file system with enough space. If the cache file system runs out of space, all fetches start failing. - On a disk with enough IO bandwidth. If the cache disk runs out of IO bandwidth, all fetches, and probably the entire server, slows down. @@ -1036,8 +1052,8 @@ uses a unique random string as part of the cache filenames it creates. This mean - They do not reuse another process's files. While the default directory puts the cache files in the same -filesystem as your repository data, this is not requirement. You can -put the cache files on a different filesystem if that works better for +file system as your repository data, this is not requirement. You can +put the cache files on a different file system if that works better for your infrastructure. The amount of IO bandwidth required from the disk depends on: @@ -1141,7 +1157,7 @@ The following cache metrics are available. |Metric|Type|Labels|Description| |:---|:---|:---|:---| -|`gitaly_pack_objects_cache_enabled`|gauge|`dir`,`max_age`|Set to `1` when the cache is enabled via the Gitaly config file| +|`gitaly_pack_objects_cache_enabled`|gauge|`dir`,`max_age`|Set to `1` when the cache is enabled via the Gitaly configuration file| |`gitaly_pack_objects_cache_lookups_total`|counter|`result`|Hit/miss counter for cache lookups| |`gitaly_pack_objects_generated_bytes_total`|counter||Number of bytes written into the cache| |`gitaly_pack_objects_served_bytes_total`|counter||Number of bytes read from the cache| |