Gitaly reference

原文：https://docs.gitlab.com/ee/administration/gitaly/reference.html

• Format

  • Authentication
  • TLS
  • Storage

  • Git

    • cat-file cache

  • gitaly-ruby

  • GitLab Shell
  • Prometheus
  • Logging

• Concurrency

Gitaly reference

通过TOML配置文件配置 Gitaly. 与源安装不同，在 Omnibus GitLab 中，您不会直接编辑此文件.

配置文件作为参数传递给gitaly可执行文件. 通常由 Omnibus GitLab 或您的init脚本完成.

可以在 Gitaly 项目中找到示例配置文件 .

Format

在顶层， config.toml定义下表中描述的项目.

例如：

socket_path = "/home/git/gitlab/tmp/sockets/private/gitaly.socket"
listen_addr = "localhost:9999"
tls_listen_addr = "localhost:8888"
bin_dir = "/home/git/gitaly"
prometheus_listen_addr = "localhost:9236" 

Authentication

可以将 Gitaly 配置为拒绝标头中不包含特定承载令牌的请求. 这是通过 TCP 服务请求时要使用的一种安全措施：

[auth]
# A non-empty token enables authentication.
token = "the secret token" 

当config.toml的令牌设置不存在或为空字符串时，将禁用身份验证.

可以使用transitioning设置暂时禁用身份验证. 这使您可以监视所有客户端是否都在正确认证，而不会导致尚未正确配置的客户端的服务中断：

[auth]
token = "the secret token"
transitioning = true 

警告：完成更改令牌设置后，切记禁用transitioning .

所有身份验证尝试均以gitaly_authentications_total指标在 Prometheus 中进行计数.

TLS

Gitaly 支持 TLS 加密. 您将需要携带自己的证书，因为该证书不会自动提供.

tls_listen_addr = "localhost:8888"

[tls]
certificate_path = '/home/git/cert.cert'
key_path = '/home/git/key.pem' 

在 Gitaly 中了解有关 TLS 的更多信息.

Storage

GitLab 存储库被分组到称为"存储"的目录中（例如/home/git/repositories ），其中包含由 GitLab 管理的裸存储库，其名称（例如default ）.

这些名称和路径也在 GitLab 的gitlab.yml配置文件中定义. 当你在同一台机器 GitLab，这是默认和推荐的配置上运行 Gitaly，在 Gitaly 的定义存储路径config.toml必须与在gitlab.yml .

例如：

[[storage]]
path = "/path/to/storage/repositories"
name = "my_shard"

[[storage]]
path = "/path/to/other/repositories"
name = "other_storage" 

Git

可以在配置文件的[git]部分中设置以下值.

cat-file cache

许多 Gitaly RPC 需要从存储库中查找 Git 对象. 大多数时候，我们使用git cat-file --batch进程. 为了获得更好的性能，Gitaly 可以在 RPC 调用之间重用这些git cat-file过程. 先前使用的进程保留在" Git cat-file 缓存"中 . 为了控制其使用多少系统资源，我们拥有可进入高速缓存的 cat 文件进程的最大数量.

默认限制是 100 个cat-file ，它们构成了一对git cat-file --batch和git cat-file --batch-check进程. 如果您看到抱怨"打开的文件太多"或无法创建新进程的错误，则可以降低此限制.

理想情况下，该数量应该足够大以处理正常流量. 如果提高该限制，则应在前后测量缓存命中率. 如果命中率没有提高，则上限可能不会产生有意义的变化. 这是一个 Prometheus 查询示例，用于查看命中率：

sum(rate(gitaly_catfile_cache_total{type="hit"}[5m])) / sum(rate(gitaly_catfile_cache_total{type=~"(hit)|(miss)"}[5m])) 

gitaly-ruby

一个 Gitaly 进程使用一个或多个gitaly-ruby帮助程序进程来执行在 Ruby 中而非 Go 中实现的 RPC. 配置文件的[gitaly-ruby]部分包含这些帮助程序的设置.

已知这些进程有时会遭受内存泄漏. 当其内存超过max_rss限制时，Gitaly 将重新启动其gitaly-ruby帮助max_rss .

Example:

[gitaly-ruby]
dir = "/home/git/gitaly/ruby"
max_rss = 200000000
graceful_restart_timeout = "10m"
restart_delay = "5m"
num_workers = 2 

GitLab Shell

出于历史原因， GitLab Shell包含 Git 挂钩，这些挂钩允许 GitLab 验证并响应 Git 推送. 由于 Gitaly 拥有 Git 推送，因此必须在 Gitaly 旁边安装 GitLab Shell. 将来会简化 .

Example:

[gitlab-shell]
dir = "/home/git/gitlab-shell" 

Prometheus

您可以选择配置 Gitaly 以记录 Prometheus 中 GRPC 方法调用的直方图延迟.

Example:

prometheus_listen_addr = "localhost:9236"

[prometheus]
grpc_latency_buckets = [0.001, 0.005, 0.025, 0.1, 0.5, 1.0, 10.0, 30.0, 60.0, 300.0, 1500.0] 

Logging

以下值在[logging]部分下的 Gitaly 中配置日志[logging] .

While the main Gitaly application logs go to stdout, there are some extra log files that go to a configured directory, like the GitLab Shell logs. GitLab Shell does not support panic or trace level logs. panic will fall back to error, while trace will fall back to debug. Any other invalid log levels will default to info.

Example:

[logging]
level = "warn"
dir = "/home/gitaly/logs"
format = "json"
sentry_dsn = "https://<key>:<secret>@sentry.io/<project>"
ruby_sentry_dsn = "https://<key>:<secret>@sentry.io/<project>" 

Concurrency

您可以调整每个 RPC 端点的concurrency性.

Example:

[[concurrency]]
rpc = "/gitaly.RepositoryService/GarbageCollect"
max_per_repo = 1