debian-mirror-gitlab/doc/administration/gitaly/index.md

248 lines
7.9 KiB
Markdown
Raw Normal View History

2017-08-17 22:00:37 +05:30
# Gitaly
[Gitaly](https://gitlab.com/gitlab-org/gitaly) (introduced in GitLab
9.0) is a service that provides high-level RPC access to Git
2018-03-27 19:54:05 +05:30
repositories. Gitaly was optional when it was first introduced in
GitLab, but since GitLab 9.4 it is a mandatory component of the
application.
2017-08-17 22:00:37 +05:30
GitLab components that access Git repositories (gitlab-rails,
gitlab-shell, gitlab-workhorse) act as clients to Gitaly. End users do
not have direct access to Gitaly.
## Configuring Gitaly
The Gitaly service itself is configured via a TOML configuration file.
This file is documented [in the gitaly
repository](https://gitlab.com/gitlab-org/gitaly/blob/master/doc/configuration/README.md).
To change a Gitaly setting in Omnibus you can use
`gitaly['my_setting']` in `/etc/gitlab/gitlab.rb`. Changes will be applied
when you run `gitlab-ctl reconfigure`.
```ruby
gitaly['prometheus_listen_addr'] = 'localhost:9236'
```
To change a Gitaly setting in installations from source you can edit
2018-12-13 13:39:08 +05:30
`/home/git/gitaly/config.toml`. Changes will be applied when you run
`service gitlab restart`.
2017-08-17 22:00:37 +05:30
```toml
prometheus_listen_addr = "localhost:9236"
```
2018-03-17 18:26:18 +05:30
## Client-side GRPC logs
Gitaly uses the [gRPC](https://grpc.io/) RPC framework. The Ruby gRPC
client has its own log file which may contain useful information when
you are seeing Gitaly errors. You can control the log level of the
gRPC client with the `GRPC_LOG_LEVEL` environment variable. The
default level is `WARN`.
2017-09-10 17:25:29 +05:30
## Running Gitaly on its own server
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
> This is an optional way to deploy Gitaly which can benefit GitLab
installations that are larger than a single machine. Most
installations will be better served with the default configuration
used by Omnibus and the GitLab source installation guide.
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
Starting with GitLab 9.4 it is possible to run Gitaly on a different
server from the rest of the application. This can improve performance
when running GitLab with its repositories stored on an NFS server.
At the moment (GitLab 9.4) Gitaly is not yet a replacement for NFS
because some parts of GitLab still bypass Gitaly when accessing Git
repositories. If you choose to deploy Gitaly on your NFS server you
must still also mount your Git shares on your GitLab application
servers.
Gitaly network traffic is unencrypted so you should use a firewall to
restrict access to your Gitaly server.
Below we describe how to configure a Gitaly server at address
2018-11-18 11:00:15 +05:30
`gitaly.internal:8075` with secret token `abc123secret`. We assume
2017-09-10 17:25:29 +05:30
your GitLab installation has two repository storages, `default` and
`storage1`.
### Client side token configuration
Start by configuring a token on the client side.
Omnibus installations:
2017-08-17 22:00:37 +05:30
```ruby
2017-09-10 17:25:29 +05:30
# /etc/gitlab/gitlab.rb
gitlab_rails['gitaly_token'] = 'abc123secret'
```
Source installations:
```yaml
# /home/git/gitlab/config/gitlab.yml
gitlab:
gitaly:
token: 'abc123secret'
```
You need to reconfigure (Omnibus) or restart (source) for these
changes to be picked up.
### Gitaly server configuration
Next, on the Gitaly server, we need to configure storage paths, enable
the network listener and configure the token.
Note: if you want to reduce the risk of downtime when you enable
authentication you can temporarily disable enforcement, see [the
documentation on configuring Gitaly
authentication](https://gitlab.com/gitlab-org/gitaly/blob/master/doc/configuration/README.md#authentication)
.
2018-12-05 23:21:45 +05:30
Gitaly must trigger some callbacks to GitLab via GitLab Shell. As a result,
the GitLab Shell secret must be the same between the other GitLab servers and
the Gitaly server. The easiest way to accomplish this is to copy `/etc/gitlab/gitlab-secrets.json`
from an existing GitLab server to the Gitaly server. Without this shared secret,
Git operations in GitLab will result in an API error.
2018-11-20 20:47:30 +05:30
> **NOTE:** In most or all cases the storage paths below end in `/repositories` which is
2018-11-18 11:00:15 +05:30
different than `path` in `git_data_dirs` of Omnibus installations. Check the
2017-09-10 17:25:29 +05:30
directory layout on your Gitaly server to be sure.
Omnibus installations:
```ruby
# /etc/gitlab/gitlab.rb
2018-11-18 11:00:15 +05:30
# Avoid running unnecessary services on the gitaly server
postgresql['enable'] = false
redis['enable'] = false
nginx['enable'] = false
prometheus['enable'] = false
unicorn['enable'] = false
sidekiq['enable'] = false
gitlab_workhorse['enable'] = false
# Prevent database connections during 'gitlab-ctl reconfigure'
gitlab_rails['rake_cache_clear'] = false
gitlab_rails['auto_migrate'] = false
# Configure the gitlab-shell API callback URL. Without this, `git push` will
# fail. This can be your 'front door' GitLab URL or an internal load
# balancer.
gitlab_rails['internal_api_url'] = 'https://gitlab.example.com'
# Make Gitaly accept connections on all network interfaces. You must use
# firewalls to restrict access to this address/port.
gitaly['listen_addr'] = "0.0.0.0:8075"
2017-09-10 17:25:29 +05:30
gitaly['auth_token'] = 'abc123secret'
2018-11-18 11:00:15 +05:30
2017-09-10 17:25:29 +05:30
gitaly['storage'] = [
2018-11-18 11:00:15 +05:30
{ 'name' => 'default', 'path' => '/mnt/gitlab/default/repositories' },
{ 'name' => 'storage1', 'path' => '/mnt/gitlab/storage1/repositories' },
2017-09-10 17:25:29 +05:30
]
```
Source installations:
```toml
# /home/git/gitaly/config.toml
2018-11-18 11:00:15 +05:30
listen_addr = '0.0.0.0:8075'
2017-09-10 17:25:29 +05:30
[auth]
token = 'abc123secret'
2018-11-20 20:47:30 +05:30
[[storage]]
2017-09-10 17:25:29 +05:30
name = 'default'
2018-11-18 11:00:15 +05:30
path = '/mnt/gitlab/default/repositories'
2017-09-10 17:25:29 +05:30
[[storage]]
name = 'storage1'
2018-11-18 11:00:15 +05:30
path = '/mnt/gitlab/storage1/repositories'
2017-08-17 22:00:37 +05:30
```
2017-09-10 17:25:29 +05:30
Again, reconfigure (Omnibus) or restart (source).
### Converting clients to use the Gitaly server
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
Now as the final step update the client machines to switch from using
their local Gitaly service to the new Gitaly server you just
configured. This is a risky step because if there is any sort of
network, firewall, or name resolution problem preventing your GitLab
server from reaching the Gitaly server then all Gitaly requests will
fail.
We assume that your Gitaly server can be reached at
2018-11-18 11:00:15 +05:30
`gitaly.internal:8075` from your GitLab server, and that your GitLab
2017-09-10 17:25:29 +05:30
NFS shares are mounted at `/mnt/gitlab/default` and
`/mnt/gitlab/storage1` respectively.
Omnibus installations:
```ruby
# /etc/gitlab/gitlab.rb
git_data_dirs({
2018-11-18 11:00:15 +05:30
'default' => { 'path' => '/mnt/gitlab/default', 'gitaly_address' => 'tcp://gitaly.internal:8075' },
'storage1' => { 'path' => '/mnt/gitlab/storage1', 'gitaly_address' => 'tcp://gitaly.internal:8075' },
2017-09-10 17:25:29 +05:30
})
gitlab_rails['gitaly_token'] = 'abc123secret'
```
Source installations:
2017-08-17 22:00:37 +05:30
```yaml
2017-09-10 17:25:29 +05:30
# /home/git/gitlab/config/gitlab.yml
gitlab:
repositories:
storages:
default:
path: /mnt/gitlab/default/repositories
2018-11-18 11:00:15 +05:30
gitaly_address: tcp://gitaly.internal:8075
2017-09-10 17:25:29 +05:30
storage1:
path: /mnt/gitlab/storage1/repositories
2018-11-18 11:00:15 +05:30
gitaly_address: tcp://gitaly.internal:8075
2017-09-10 17:25:29 +05:30
2017-08-17 22:00:37 +05:30
gitaly:
2017-09-10 17:25:29 +05:30
token: 'abc123secret'
2017-08-17 22:00:37 +05:30
```
2017-09-10 17:25:29 +05:30
Now reconfigure (Omnibus) or restart (source). When you tail the
Gitaly logs on your Gitaly server (`sudo gitlab-ctl tail gitaly` or
`tail -f /home/git/gitlab/log/gitaly.log`) you should see requests
coming in. One sure way to trigger a Gitaly request is to clone a
repository from your GitLab server over HTTP.
2018-03-27 19:54:05 +05:30
## Disabling or enabling the Gitaly service in a cluster environment
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
If you are running Gitaly [as a remote
service](#running-gitaly-on-its-own-server) you may want to disable
2018-12-05 23:21:45 +05:30
the local Gitaly service that runs on your GitLab server by default.
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
> 'Disabling Gitaly' only makes sense when you run GitLab in a custom
cluster configuration, where different services run on different
machines. Disabling Gitaly on all machines in the cluster is not a
valid configuration.
If you are setting up a GitLab cluster where Gitaly does not need to
run on all machines, you can disable the Gitaly service in your
Omnibus installation, add the following line to `/etc/gitlab/gitlab.rb`:
2017-08-17 22:00:37 +05:30
```ruby
gitaly['enable'] = false
```
When you run `gitlab-ctl reconfigure` the Gitaly service will be
disabled.
2018-03-27 19:54:05 +05:30
To disable the Gitaly service in a GitLab cluster where you installed
GitLab from source, add the following to `/etc/default/gitlab` on the
machine where you want to disable Gitaly.
2017-08-17 22:00:37 +05:30
```shell
gitaly_enabled=false
```
2018-03-27 19:54:05 +05:30
When you run `service gitlab restart` Gitaly will be disabled on this
particular machine.