• 格式
  • 验证
  • TLS
  • 存储
  • Git
    • cat-file 缓存
  • gitaly-ruby
  • 极狐GitLab Shell
  • Prometheus
  • Logging
• Concurrency

Gitaly 参考 (BASIC SELF)

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

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

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

格式

在顶层，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"

验证

Gitaly 可以配置为拒绝在其 header 中不包含特定不记名令牌的请求。这是通过 TCP 服务请求时使用的安全措施：

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

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

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

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

Prometheus 中的所有身份验证尝试都在 gitaly_authentications_total 指标下进行计数。

TLS

Gitaly 支持 TLS 加密。您需要携带自己的证书，因为这不是自动提供的。

tls_listen_addr = "localhost:8888"

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

存储

极狐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 缓存

许多 Gitaly RPC 需要从存储库中查找 Git 对象。大多数时候，我们为此使用 git cat-file --batch 进程。为了获得更好的性能，Gitaly 可以在 RPC 调用中重复使用这些 git cat-file 进程。 为了控制使用多少系统资源，我们设置了可以进入缓存的最大数量的 cat 文件进程。

默认限制为 100 个 cat-file，它们构成了一对 git cat-file --batch 和 git cat-file --batch-check 进程。如果您看到 “too many open files” 或无法创建新进程的错误，您可能需要降低此限制。

理想情况下，该数字应该足够大以处理正常流量。如果提高限制，则应测量前后的缓存命中率。如果命中率没有提高，则上限可能不会产生有意义的差异。这是一个用于查看命中率的 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] 部分包含这些 helper 进程的设置。

众所周知，这些进程偶尔会遭受内存泄漏。 当 Gitaly 的内存超过 max_rss 限制时，Gitaly 会重新启动其 gitaly-ruby helper。

示例：

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

极狐GitLab Shell

由于历史原因，极狐GitLab Shell 包含允许极狐GitLab 验证和响应 Git 推送的 Git 钩子。 由于 Gitaly “拥有” Git 推送，因此极狐GitLab Shell 必须与 Gitaly 一起安装。

示例：

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

Prometheus

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

示例：

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 中的日志记录。

虽然主要的 Gitaly 应用程序日志会转到 stdout，但还有一些额外的日志文件会转到配置的目录，例如极狐GitLab Shell 日志。极狐GitLab Shell 不支持 panic 或 trace 级别的日志：

• panic 回退到 error。
• trace 回退到debug。
• 任何其他无效的日志级别默认为 info。

示例：

[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。

示例：

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