2017-03-17 11:19:38 +00:00
|
|
|
# Gitaly
|
|
|
|
|
|
2017-04-18 22:26:35 +00:00
|
|
|
[Gitaly](https://gitlab.com/gitlab-org/gitaly) (introduced in GitLab
|
2017-03-17 11:19:38 +00:00
|
|
|
9.0) is a service that provides high-level RPC access to Git
|
2017-05-30 13:57:11 +00:00
|
|
|
repositories. As of GitLab 9.3 it is still an optional component with
|
2017-03-17 11:19:38 +00:00
|
|
|
limited scope.
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
2017-04-06 13:05:06 +00:00
|
|
|
The Gitaly service itself is configured via a TOML configuration file.
|
|
|
|
|
This file is documented [in the gitaly
|
2017-03-17 11:19:38 +00:00
|
|
|
repository](https://gitlab.com/gitlab-org/gitaly/blob/master/doc/configuration/README.md).
|
|
|
|
|
|
2017-04-06 13:05:06 +00:00
|
|
|
To change a Gitaly setting in Omnibus you can use
|
|
|
|
|
`gitaly['my_setting']` in `/etc/gitlab/gitlab.rb`. Changes will be applied
|
2017-03-17 11:19:38 +00:00
|
|
|
when you run `gitlab-ctl reconfigure`.
|
|
|
|
|
|
|
|
|
|
```ruby
|
2017-04-06 13:05:06 +00:00
|
|
|
gitaly['prometheus_listen_addr'] = 'localhost:9236'
|
2017-03-17 11:19:38 +00:00
|
|
|
```
|
|
|
|
|
|
2017-04-06 13:05:06 +00:00
|
|
|
To change a Gitaly setting in installations from source you can edit
|
|
|
|
|
`/home/git/gitaly/config.toml`.
|
2017-03-17 11:19:38 +00:00
|
|
|
|
2017-04-06 13:05:06 +00:00
|
|
|
```toml
|
|
|
|
|
prometheus_listen_addr = "localhost:9236"
|
2017-03-17 11:19:38 +00:00
|
|
|
```
|
|
|
|
|
|
2017-04-06 13:05:06 +00:00
|
|
|
Changes to `/home/git/gitaly/config.toml` are applied when you run `service
|
2017-03-17 11:19:38 +00:00
|
|
|
gitlab restart`.
|
|
|
|
|
|
|
|
|
|
## Configuring GitLab to not use Gitaly
|
|
|
|
|
|
2017-05-30 13:57:11 +00:00
|
|
|
Gitaly is still an optional component in GitLab 9.3. This means you
|
2017-03-17 11:19:38 +00:00
|
|
|
can choose to not use it.
|
|
|
|
|
|
|
|
|
|
In Omnibus you can make the following change in
|
|
|
|
|
`/etc/gitlab/gitlab.rb` and reconfigure. This will both disable the
|
|
|
|
|
Gitaly service and configure the rest of GitLab not to use it.
|
|
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
|
gitaly['enable'] = false
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
In source installations, edit `/home/git/gitlab/config/gitlab.yml` and
|
2017-04-06 13:05:06 +00:00
|
|
|
make sure `enabled` in the `gitaly` section is set to 'false'. This
|
|
|
|
|
does not disable the Gitaly service in your init script; it only
|
|
|
|
|
prevents it from being used.
|
2017-03-17 11:19:38 +00:00
|
|
|
|
|
|
|
|
Apply the change with `service gitlab restart`.
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
gitaly:
|
2017-04-06 13:05:06 +00:00
|
|
|
enabled: false
|
2017-03-17 11:19:38 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Disabling or enabling the Gitaly service
|
|
|
|
|
|
|
|
|
|
Be careful: if you disable Gitaly without instructing the rest of your
|
|
|
|
|
GitLab installation not to use Gitaly, you may end up with errors
|
|
|
|
|
because GitLab tries to access a service that is not running.
|
|
|
|
|
|
|
|
|
|
To disable the Gitaly service in your Omnibus installation, add the
|
|
|
|
|
following line to `/etc/gitlab/gitlab.rb`:
|
|
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
|
gitaly['enable'] = false
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
When you run `gitlab-ctl reconfigure` the Gitaly service will be
|
|
|
|
|
disabled.
|
|
|
|
|
|
|
|
|
|
To disable the Gitaly service in an installation from source, add the
|
|
|
|
|
following to `/etc/default/gitlab`:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
gitaly_enabled=false
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
When you run `service gitlab restart` Gitaly will be disabled.
|
