使用 Globals 配置 chart

为了在安装 Helm chart 时减少重复配置,可以在 values.yamlglobal 部分进行一些全局配置。这些全局配置跨多个 chart 使用,其它设置都在各个 chart 自己的范围内。有关全局变量如何工作的更多信息,请查看 Helm 全局配置文档

Host 配置

全局 host 配置位于 global.hosts 设置之下:

global:
  hosts:
    domain: example.com
    hostSuffix: staging
    https: false
    externalIP:
    gitlab:
      name: gitlab.example.com
      https: false
    registry:
      name: registry.example.com
      https: false
    minio:
      name: minio.example.com
      https: false
    smartcard:
      name: smartcard.example.com
    kas:
      name: kas.example.com
    pages:
      name: pages.example.com
      https: false
名称 类型 默认值 说明
domain String example.com 基础域名。GitLab 和 Registry 在其子域名中暴露。默认值为 example.com,不适用于配置了 name 属性的 hosts。请查看下面的 gitlab.nameminio.nameregistry.name 的说明。
externalIP   nil 设置云提供商生命的外部 IP 地址。将被模板化到 NGINX chart 中,代替更复杂的 nginx.service.loadBalancerIP
https Boolean true 如果设置为 true, 您需要确保 NGINX chart 可以访问证书。如果您的 Ingress 前有 TLS 终止,您可能需要查看 global.ingress.tls.enabled。如果要外部 URL 使用 http:// 而不是 https,设置为 false。
hostSuffix String   查看下面的主机后缀文档
gitlab.https Boolean false 如果 hosts.httpsgitlab.https 设置为 truegitlab 的外部 URL 将使用 https:// 而不是 http://
gitlab.name String   gitlab 的主机名。如果设置了该值,则使用此主机名,无论 global.hosts.domainglobal.hosts.hostSuffix 设置为何。
gitlab.hostnameOverride String   覆盖 Webservice 的 Ingress 配置中使用的主机名。如果存在必须将主机名重写为内部主机名的 WAF (例如:gitlab.example.com –> gitlab.cluster.local),且 gitlab 必须在其后,设置该值很有用。
gitlab.serviceName String webservice 运行 gitlab 服务器的 service 名称。chart 将模板化服务的主机名(和当前的 .Release.Name),以创建正确的内部 serviceName。
gitlab.servicePort String workhorse 可以用于访问 gitlab 服务器的命名端口。
minio.https Boolean false 如果 hosts.httpsminio.https 设置为 true,MinIO 的外部 URL 将使用 https:// 而不是 http://
minio.name String minio MinIO 的主机名。如果设置了该值,则使用此主机名,无论 global.hosts.domainglobal.hosts.hostSuffix 设置为何。
minio.serviceName String minio 运行 MinIO 服务器的 service 名称。chart 将模板化服务的主机名(和当前的 .Release.Name),以创建正确的内部 serviceName。
minio.servicePort String minio 可以用于访问 MinIO 服务器的命名端口。
registry.https Boolean false 如果 hosts.httpsgitlab.https 设置为 true,Registry 的外部 URL 将使用 https:// 而不是 http://
registry.name String registry Registry 的主机名。如果设置了该值,则使用此主机名,无论 global.hosts.domainglobal.hosts.hostSuffix 设置为何。
registry.serviceName String registry 运行 Registry 服务器的 service 名称。chart 将模板化服务的主机名(和当前的 .Release.Name),以创建正确的内部 serviceName。
registry.servicePort String registry 可以用于访问 Registry 服务器的命名端口。
smartcard.name String smartcard smartcard 认证的主机名。如果设置了该值,则使用此主机名,无论 global.hosts.domainglobal.hosts.hostSuffix 设置为何。
kas.name String kas KAS 的主机名。如果设置了该值,则使用此主机名,无论 global.hosts.domainglobal.hosts.hostSuffix 设置为何。
kas.https Boolean false 如果 hosts.httpsgitlab.https 设置为 true,KAS 的外部 URL 将使用 wss:// 而不是 ws://
pages.name String pages GitLab Pages 的主机名。如果设置了该值,则使用此主机名,无论 global.hosts.domainglobal.hosts.hostSuffix 设置为何。
pages.https String   如果 global.pages.httpsglobal.hosts.pages.httpsglobal.hosts.https 设置为 true, 项目设置 UI 中 GitLab Pages 使用的 URL 将 使用 https:// 而不是 http://

hostSuffix

在使用基本域名组成主机名时,hostSuffix 附加到子域,但不用于具有自己 name 集的主机。

默认为未设置。如果设置,后缀将使用连字符附加到子域。下面的示例配置的外部域名例如 gitlab-staging.example.comregistry-staging.example.com

global:
  hosts:
    domain: example.com
    hostSuffix: staging

Ingress 配置

全局 Ingress 配置位于 global.ingress 设置之下:

Name Type Default Description
apiVersion String   在 Ingress 对象定义中使用的 API 版本。
annotations.*annotation-key* String   annotation-key 是一个字符串,与该值一起作为每个 Ingress 的 annotation。例如:global.ingress.annotations."nginx\.ingress\.kubernetes\.io/enable-access-log"=true。默认不提供全局 annotation。
configureCertmanager Boolean true 查看下面的文档.
class String gitlab-nginx 控制 Ingress 资源中 kubernetes.io/ingress.class annotation 的全局设置。
enabled Boolean true 控制是否创建支持 services 的 Ingress 对象的全局设置。
tls.enabled Boolean true 当设置为 false 时,在极狐GitLab 中禁用 TLS。这对于不能使用 Ingress 的 TLS 终止的情况很有用,例如在 Ingress Controller 之前有一个 TLS 终止代理时。如果您想完全禁用 https,应该和 global.hosts.https 一起设置为 false
tls.secretName String   Kubernetes TLS Secret 的名称,该 Secret 包含用于 global.hosts.domain 中设置的域名的 全局 证书和密钥。
path String / Ingress 对象path 条目的默认值。
pathType String Prefix Path Type 允许您指定路径的匹配方式。当前的默认值为 Prefix,但您可以根据使用情况使用 ImplementationSpecificExact
provider String nginx 定义使用的 Ingress provider。nginx 是默认的 provider。

Ingress Path

该 chart 使用 global.ingress.path 作为更改 Ingress 对象的 path 条目的方法。大部分用户不需要该设置,不应该进行配置

对于那些需要将 path 定义用 /* 结尾以匹配其负载均衡器或代理的用户,例如在 GCP 中使用 ingress.class: gce,在 AWS 中使用 ingress.class: alb,或其它类似提供商。该设置确保整个 chart 的 Ingress 中的所有 path 条目都使用该设置。唯一的例外是 gitlab/webservice deployments 设置,必须指定 path

云提供商负载均衡器

多种云提供商的 LoadBalancer 实现对 Ingress 资源的配置和作为 chart 一部分部署的 NGINX 控制器有影响。下表提供了示例。

云提供商 Layer 示例
AWS 4 aws/elb-layer4-loadbalancer
AWS 7 aws/elb-layer7-loadbalancer

global.ingress.configureCertmanager

控制自动配置 Ingress 对象的 cert-manager 。如果设置为 true,依赖于设置的 certmanager-issuer.email

如果设置为 false 并且 global.ingress.tls.secretName 未设置,这将激活自动自签名证书的生成,即为所有 Ingress 对象创建 通配符 证书。

如果您希望使用外部 cert-manager,您必须提供以下内容:

  • gitlab.webservice.ingress.tls.secretName
  • registry.ingress.tls.secretName
  • minio.ingress.tls.secretName
  • global.ingress.annotations

极狐GitLab 版本

note该值仅用于开发目的,或应技术支持的要求使用。请避免在生产环境中使用此值,并按照 使用 Helm 部署文档 所述设置版本。

可以使用 global.gitlabVersion 键,更改默认镜像 tag 中使用的极狐GitLab 版本:

--set global.gitlabVersion=11.0.1

这会影响 webservicesidekiqmigration chart 的默认镜像 tag。注意 gitalygitlab-shellgitlab-runner 的镜像标签应分别更新为与极狐GitLab 版本兼容的版本。

PostgreSQL 设置

全局 PostgreSQL 配置位于 global.psql 设置之下:

global:
  psql:
    host: psql.example.com
    # serviceName: pgbouncer
    port: 5432
    database: gitlabhq_production
    username: gitlab
    applicationName:
    preparedStatements: false
    connectTimeout:
    keepalives:
    keepalivesIdle:
    keepalivesInterval:
    keepalivesCount:
    tcpUserTimeout:
    password:
      useSecret: true
      secret: gitlab-postgres
      key: psql-password
      file:
名称 类型 默认值 说明
host String   要使用数据库所在的 PostgreSQL 服务器的主机名。如果使用本 chart 部署的 PostgreSQL,则可以省略此项。
serviceName String   运行 PostgreSQL 数据库的 service 的名称。如果该配置存在,且 host 的值不存在 , 则 chart 将服务的主机名替换 host 的值。
database String gitlabhq_production 要在 PostgreSQL 服务器上使用的数据库的名称。
password.useSecret Boolean true 控制从 Secret 还是从文件中读取密码。
password.file String   定义包含 PostgreSQL 密码的文件路径。如果 password.useSecret 设置为 true,则忽略该配置。
password.key String   定义 Secret 中包含密码的 key 的名称。如果 password.useSecret 设置为 false,则忽略该配置。
password.secret String   定义要拉取的 Kubernetes Secret 的名称,如果 password.useSecret 设置为 false,则忽略该配置。
port Integer 5432 连接 PostgreSQL 服务器的端口。
username String gitlab 用于对数据库进行身份验证的用户名。
preparedStatements Boolean false 在与 PostgreSQL 服务器通信时,是否使用 prepared statements。
connectTimeout Integer   数据库连接的等待秒数。
keepalives Integer   Controls whether client-side TCP keepalives are used (1, meaning on, 0, meaning off).
keepalivesIdle Integer   TCP 应向服务器发送 keepalive 消息之前的非活动秒数。零值使用系统默认值。
keepalivesInterval Integer   应重新传输未被服务器确认的 TCP 保持连接消息的秒数。 零值使用系统默认值。
keepalivesCount Integer   在客户端与服务器的连接被视为死亡之前可能丢失的 TCP 保持连接数。 零值使用系统默认值。
tcpUserTimeout Integer   在连接被强制关闭之前,传输的数据可能保持未被确认的毫秒数。 零值使用系统默认值。
applicationName String   连接数据库的应用程序名称。设置为空字符串 ("") 表示禁用。默认情况下,将设置为正在运行的进程的名称 (例如 sidekiq, puma) 。

PostgreSQL per chart

在一些复杂的部署中,可能需要使用不同的 PostgreSQL 配置对应 chart 的不同部分。从 v4.2.0 开始,global.psql 中可用的所有属性可以以每个 chart 为基础进行配置,例如 gitlab.sidekiq.psql。如果提供了本地设置,将覆盖全局配置值,并继承任何_不存在于_ global.psql 的值,psql.load_balancing 除外。

按照设计,PostgreSQL 负载均衡 从不 继承全局配置值。

PostgreSQL SSL

noteSSL 支持仅限于双向 TLS。

如果要通过双向 TLS 连接 PostgreSQL 数据库和极狐GitLab,创建一个 Secret,包含客户端密钥、客户端证书和服务器证书颁发机构作为不同的 key。然后使用 global.psql.ssl 映射描述 Secret 的结构。

global:
  psql:
    ssl:
      secret: db-example-ssl-secrets # Name of the secret
      clientCertificate: cert.pem    # Secret key storing the certificate
      clientKey: key.pem             # Secret key of the certificate's key
      serverCA: server-ca.pem        # Secret key containing the CA for the database server
名称 类型 默认值 说明
secret String   包含以下 key 的 Kubernetes Secret 的名称。
clientCertificate String   Secret 中,包含客户端证书的 key 的名称。
clientKey String   Secret 中,包含客户端证书密码文件的 key 的名称。
serverCA String   Secret 中,包含服务器证书颁发机构的 key 的名称。

您可能还需要设置 extraEnv 值,使导出环境值指向正确的键。

global:
  extraEnv:
      PGSSLCERT: '/etc/gitlab/postgres/ssl/client-certificate.pem'
      PGSSLKEY: '/etc/gitlab/postgres/ssl/client-key.pem'
      PGSSLROOTCERT: '/etc/gitlab/postgres/ssl/server-ca.pem'

PostgreSQL 负载均衡

该特性功能需要使用 外部 PostgreSQL,因为 chart 在 HA 模式下不会部署 PostgreSQL。Rails 组件能够利用 PostgreSQL 集群对只读查询进行负载均衡。

该特性可以通过两种方式配置:

  • 使用域名静态列表作为辅助。
  • 使用基于 DNS 的服务发现机制。

带有静态列表的配置如下:

global:
  psql:
    host: primary.database
    load_balancing:
       hosts:
       - secondary-1.database
       - secondary-2.database

服务发现的配置可能更复杂。有关配置、参数及相关操作的详细信息,请查看 服务发现文档

global:
  psql:
    host: primary.database
    load_balancing:
      discover:
        record:  secondary.postgresql.service.consul
        # record_type: A
        # nameserver: localhost
        # port: 8600
        # interval: 60
        # disconnect_timeout: 120
        # use_tcp: false

关于处理陈旧数据,还可以进行进一步修改。管理中心文档详细介绍了相关信息,这些属性可以直接添加到 load_balancing 下。

global:
  psql:
    load_balancing:
      max_replication_difference: # See documentation
      max_replication_lag_time:   # See documentation
      replica_check_interval:     # See documentation

Redis 配置

全局 Redis 配置位于 global.redis 设置之下。

默认情况下使用单个、非复制的 Redis 实例。如果需要,可以改为部署高度可用的 Redis。要安装 HA Redis 集群,需要在安装极狐GitLab chart 时设置 redis.cluster.enabled=true

您可以通过设置 redis.install=false,并按照我们的高级配置文档进行配置,带入一个外部 Redis 实例。

global:
  redis:
    host: redis.example.com
    serviceName: redis
    port: 6379
    password:
      enabled: true
      secret: gitlab-redis
      key: redis-password
    scheme:
名称 类型 默认值 说明
host String   要使用数据库所在的 Redis 服务器的主机名。可以省略,使用 serviceName 进行代替。
serviceName String redis 运行 Redis 数据库的 service名称。如果该配置存在,且 host 的值不存在 , 则 chart 将服务的主机名替换 host 的值。这样使用 Redis 作为整个 chart 一部分时很方便。
port Integer 6379 连接 Redis 服务器的端口。
password.enabled Boolean true 提供了是否在 Redis 实例中使用密码的切换功能。
password.key String   定义 Secret 中包含密码的 key 的名称。
password.secret String   定义要拉取的 Kubernetes Secret 的名称。
scheme String redis 用于生成 Redis URL 的 URI 方案。有效值为 redisredisstcp。如果使用 rediss(SSL 加密连接)方案,服务器使用的证书应该是系统可信链的一部分。可以通过将它们添加到自定义证书颁发机构列表来完成。

Redis 特定 chart 配置

直接在 redis 键下,配置 Redis chart

redis:
  install: true
  image:
    registry: registry.example.com
    repository: example/redis
    tag: x.y.z

有关更多信息,请参考完整参数列表

Redis Sentinel support

当前仅支持 Sentinel 与 极狐GitLab 分开部署。这样,应该使用 redis.install=false 禁用通过 chart 部署 Redis 。在部署 chart 之前,需要手动创建包含 Redis 密码的 Kubernetes Secret。

从 chart 安装 HA Redis 集群不支持使用 sentinels。如果希望使用 sentinel support,Redis 集群需要与 chart 分开创建。可以在 Kubernetes 集群内部或外部完成。

redis:
  install: false
global:
  redis:
    host: redis.example.com
    serviceName: redis
    port: 6379
    sentinels:
      - host: sentinel1.example.com
        port: 26379
      - host: sentinel2.exeample.com
        port: 26379
    password:
      enabled: true
      secret: gitlab-redis
      key: redis-password
名称 类型 默认值 说明
host String   需要设置为在 sentinel.conf 中指定的集群名称。
sentinels.[].host String   用于 Redis HA 设置的 Redis Sentinel 服务器的主机名。
sentinels.[].port Integer 26379 连接 Redis Sentinel 服务器的端口。

除非重新指定上表中的属性,否则常规 Redis 配置中的所有之前配置的 Redis 属性将继续适用于 Sentinel support。

多 Redis 支持

极狐GitLab chart 支持针对不同的持久化类,使用单独的 Redis 实例运行,目前包括:

实例 目的
cache 存储缓存数据
queues 存储 Sidekiq 后台任务
sharedState 存储分布式锁等各种持久化数据
actioncable ActionCable 的发布/订阅后端队列
traceChunks 临时存储作业跟踪
rateLimiting 存储 RackAttack 和 Application Limits 的速率限制使用情况
sessions 存储用户会话数据

可以指定任意数量的实例。任何未指定的实例将由指定的主 Redis 实例处理,主 Redis 通过 global.redis.host 指定,或使用 chart 部署 Redis 实例。 例如:

redis:
  install: false
global:
  redis:
    host: redis.example
    port: 6379
    password:
      enabled: true
      secret: redis-secret
      key: redis-password
    cache:
      host: cache.redis.example
      port: 6379
      password:
        enabled: true
        secret: cache-secret
        key: cache-password
    sharedState:
      host: shared.redis.example
      port: 6379
      password:
        enabled: true
        secret: shared-secret
        key: shared-password
    queues:
      host: queues.redis.example
      port: 6379
      password:
        enabled: true
        secret: queues-secret
        key: queues-password
    actioncable:
      host: cable.redis.example
      port: 6379
      password:
        enabled: true
        secret: cable-secret
        key: cable-password
    traceChunks:
      host: traceChunks.redis.example
      port: 6379
      password:
        enabled: true
        secret: traceChunks-secret
        key: traceChunks-password
    rateLimiting:
      host: rateLimiting.redis.example
      port: 6379
      password:
        enabled: true
        secret: rateLimiting-secret
        key: rateLimiting-password
    sessions:
      host: sessions.redis.example
      port: 6379
      password:
        enabled: true
        secret: sessions-secret
        key: sessions-password

下表描述了 Redis 实例中的属性。

名称 类型 默认值 说明
.host String   要使用数据库所在的 Redis 服务器的主机名。
.port Integer 6379 连接 Redis 服务器的端口。
.password.enabled Boolean true 提供了是否在 Redis 实例中使用密码的切换功能。
.password.key String   定义 Secret 中包含密码的 key 的名称。
.password.secret String   定义要拉取的 Kubernetes Secret 的名称。

需要定义主 Redis,因为还有未分开的其它持久化类。

每个实例定义也可能使用 Redis Sentinel support。Sentinel 配置不共享,需要为每个使用 Sentinels 的实例指定。关于配置 Sentinel 服务器的属性,请参考 Sentinel 配置文档

指定 Redis 安全方案 (SSL)

为了使用 SSL 连接到 Redis,需要配置以下 rediss(注意有两个 s)方案参数:

global:
  redis:
    scheme: rediss
  --set global.redis.scheme=rediss

配置 Grafana 集成

全局 Grafana 设置位于 global.grafana 下。目前,唯一可用的设置是 global.grafana.enabled

当设置为 true 时,chart 将部署 grafana/grafana chart,将其暴露在 GitLab Ingress 的 /-/grafana 下,并预先配置使用安全的随机密码。生成的密码可以在名为 gitlab-grafana-initial-root-password 的 Secret 中找到。

chart 连接到已部署的 Prometheus 实例。

Registry 配置

全局 Registry 设置位于 global.registry 下。

global:
  registry:
    bucket: registry
    certificate:
    httpSecret:
    notificationSecret:
    notifications: {}

有关 bucketcertificatehttpSecretnotificationSecret 设置的更多详细信息,请参阅 Registry chart 文档

通知

该设置用于配置 Registry 通知。参考以下示例片段,其中 Authorization header 包含敏感数据,其它 header 包含常规数据:

global:
  registry:
    notifications:
      events:
        includereferences: true
      endpoints:
        - name: CustomListener
          url: https://mycustomlistener.com
          timeout: 500mx
          threshold: 5
          backoff: 1s
          headers:
            X-Random-Config: [plain direct]
            Authorization:
              secret: registry-authorization-header
              key: password

在该示例中,X-Random-Config header 是 regular header,它的值由 values.yaml 文件的 plaintext 或通过 --set flag 提供。然而,Authorization header 是敏感的,因此最好从 Kubernetes Secret 挂载它。有关 Secret 结构的详细信息,请参考 Secret 文档

Gitaly 配置

全局 Gitaly 设置位于 global.gitaly 下。

global:
  gitaly:
    internal:
      names:
        - default
        - default2
    external:
      - name: node1
        hostname: node1.example.com
        port: 8075
    authToken:
      secret: gitaly-secret
      key: token
    tls:
      enabled: true
      secretName: gitlab-gitaly-tls

Gitaly hosts

Gitaly 是一项提供对 Git 仓库的高级 RPC 访问的服务,该服务处理极狐GitLab 发出的所有 Git 调用。

管理员可以通过以下方式选择使用 Gitaly 节点:

有关管理新项目要使用的节点的详细信息,查看 仓库存储路径文档

如果提供了 gitaly.hostgitaly.internalgitaly.external 属性会被 忽略。 查看 废弃的 Gitaly 配置

此时所有 Gitaly 服务,无论内部或外部,Gitaly 身份验证令牌都是相同的,确保它们对齐。

Internal

internal 下目前只有一个键,即 names,它是一个由 chart 管理的 存储名称 列表。对于每个列出的名称,按逻辑顺序,将生成一个名为 ${releaseName}-gitaly-${ordinal} 的 pod,其中 ordinalnames 列表中的索引。如果启用了动态配置,会匹配 PersistentVolumeClaim

该列表默认为 ['default'],它提供了与一个 存储路径 相关的 1 个 pod。

Manual scaling of this item is required, by adding or removing entries in 在 gitaly.internal.names 中添加或删除条目,可以在需要时扩缩容。当缩容时,任何还未移动到另一节点的仓库都将不可用。由于 chart 是一个 StatefulSet,动态配置的磁盘 不会 被回收,意味着数据磁盘将持久化,当重新添加节点到 names 列表中并再次扩容时,上面的数据仍然可以访问。

您可以在示例文件夹中找到多个内部节点的配置示例

External

external 为集群外部的 Gitaly 节点提供配置。这个列表的每一项都有 3 个键:key provides a configuration for Gitaly nodes external to the cluster. Each item of this list has 3 keys:

  • name存储的名称,需要带有 name: default 的条目。
  • hostname:Gitaly 服务的主机。
  • port:(可选)到达主机的端口号。默认为 8075
  • tlsEnabled:(可选)为特定条目覆盖 global.gitaly.tls.enabled 的值。

我们为使用外部 Gitaly 服务 提供高级配置指南

您可以使用外部 Praefect 提供高可用的 Gitaly 服务。两者配置可以互换,从使用者角度看,没有区别。

Mixed

支持同时使用 internal 和 external Gitaly 节点,请注意:

  • 必须始终具有名称为 default 的 Internal 默认节点。
  • 先对外暴露 External 节点,然后是 Internal 节点。

可以在示例文件夹中,找到混合 internal 和 external 节点的实例配置

authToken

Gitaly 的 authToken 属性有两个子键:

  • secret 定义要拉取的 Kubernetes Secret 的名称。
  • key 定义 Secret 中包含 authToken 的 键的名称。

所有 Gitaly 节点必须共享相同的 authentication token。

废弃的 Gitaly 设置

名称 类型 默认值 说明
host (deprecated) String   Gitaly 服务器使用的主机名。可以省略,使用 serviceName 进行代替。如果设置该值,将覆盖 internalexternal 的任何值。
port (deprecated) Integer 8075 连接 Gitaly 服务器使用的端口。
serviceName (deprecated) String   运行 Gitaly 服务器的 service 名称。 果该配置存在,且 host 的值不存在 , 则 chart 将服务的主机名(当前为 .Release.Name)替换 host 的值。这样使用 Gitaly 作为整个 chart 一部分时很方便。

TLS 设置

查看 Gitaly chart 文档,获取如何配置通过 TLS 使用 Gitaly 的详细信息。

Praefect 配置

全局 Praefect 配置位于 global.praefect 键下。

默认情况下禁用 Praefect。启用时如果无额外配置,将创建 3 个 Gitaly 副本,并且需要在 PostgreSQL 实例上手动创建 Praefect 数据库。

启用 Praefect

要使用默认设置启用 Praefect,请设置 global.praefect.enabled=true

Praefect 全局设置

global:
  praefect:
    enabled: false
    virtualStorages:
    - name: default
      gitalyReplicas: 3
      maxUnavailable: 1
    dbSecret: {}
    psql: {}
名称 类型 默认值 说明
enabled Boolean false 是否启用 Praefect
virtualStorages List 所需的虚拟存储列表(每个都由 Gitaly StatefulSet 支持)
dbSecret.secret String   用于数据库认证的 Secret 名称
dbSecret.key String   dbSecret.secret 中,要使用的键的名称
psql.host String   要使用的数据库服务器的主机名(使用外部数据库时)
psql.port String   数据库服务器的端口(使用外部数据库时)
psql.user String praefect 要使用的数据库用户
psql.dbName String praefect 要使用的数据库的名称

MinIO 配置

全局 MinIO 配置位于 global.minio 键下。查看 MinIO chart 文档,获取更多相关配置信息。

global:
  minio:
    enabled: true
    credentials: {}

appConfig 配置

WebserviceSidekiqGitaly chart 共享 global.appConfig 键下的多个配置。

global:
  appConfig:
    contentSecurityPolicy:
      enabled: false
      report_only: true
      # directives: {}
    enableUsagePing: true
    enableSeatLink: true
    enableImpersonation: true
    applicationSettingsCacheSeconds: 60
    defaultCanCreateGroup: true
    usernameChangingEnabled: true
    issueClosingPattern:
    defaultTheme:
    defaultProjectsFeatures:
      issues: true
      mergeRequests: true
      wiki: true
      snippets: true
      builds: true
      containerRegistry: true
    webhookTimeout:
    gravatar:
      plainUrl:
      sslUrl:
    extra:
      googleAnalyticsId:
      matomoUrl:
      matomoSiteId:
      matomoDisableCookies:
      oneTrustId:
      googleTagManagerNonceId:
    object_store:
      enabled: false
      proxy_download: true
      storage_options: {}
      connection: {}
    lfs:
      enabled: true
      proxy_download: true
      bucket: git-lfs
      connection: {}
    artifacts:
      enabled: true
      proxy_download: true
      bucket: gitlab-artifacts
      connection: {}
    uploads:
      enabled: true
      proxy_download: true
      bucket: gitlab-uploads
      connection: {}
    packages:
      enabled: true
      proxy_download: true
      bucket: gitlab-packages
      connection: {}
    externalDiffs:
      enabled:
      when:
      proxy_download: true
      bucket: gitlab-mr-diffs
      connection: {}
    terraformState:
      enabled: false
      bucket: gitlab-terraform-state
      connection: {}
    dependencyProxy:
      enabled: false
      bucket: gitlab-dependency-proxy
      connection: {}
    backups:
      bucket: gitlab-backups
    incomingEmail:
      enabled: false
      address: ""
      host: "imap.gmail.com"
      port: 993
      ssl: true
      startTls: false
      user: ""
      password:
        secret:
        key: password
      mailbox: inbox
      idleTimeout: 60
      inboxMethod: "imap"
      clientSecret:
        key: secret
      pollInterval: 60

    serviceDeskEmail:
      enabled: false
      address: ""
      host: "imap.gmail.com"
      port: 993
      ssl: true
      startTls: false
      user: ""
      password:
        secret:
        key: password
      mailbox: inbox
      idleTimeout: 60
      inboxMethod: "imap"
      clientSecret:
        key: secret
      pollInterval: 60

    pseudonymizer:
      configMap:
      bucket: gitlab-pseudo
      connection: {}
    cron_jobs: {}
    sentry:
      enabled: false
      dsn:
      clientside_dsn:
      environment:
    smartcard:
      enabled: false
      CASecret:
      clientCertificateRequiredHost:
    sidekiq:
      routingRules: []

一般应用程序设置

可用于调整 Rails 应用程序常规属性的 appConfig 设置如下表所述:

名称 类型 默认值 说明
contentSecurityPolicy Struct   查看下方的文档
enableUsagePing Boolean true 是否启用 usage ping support。
enableSeatLink Boolean true 是否启用 seat link support。
enableImpersonation   nil 是否启用管理员模拟用户。
applicationSettingsCacheSeconds Integer 60 应用程序设置缓存无效的间隔值(以秒为单位)
defaultCanCreateGroup Boolean true 是否允许用户创建群组。
usernameChangingEnabled Boolean true 是否允许用户修改用户名。
issueClosingPattern String (empty) 自动关闭议题的模式。
defaultTheme Integer   实例的默认主题的数字 ID。使用一个数字表示主题的 ID。
defaultProjectsFeatures.*feature* Boolean true 查看下方的文档.
webHookTimeout Integer   hook 被认为失败之前的等待时间。

Content Security Policy

设置 Content Security Policy(CSP)可以帮助组织 JavaScript 跨站点脚本(XSS)攻击。查看Content Security Policy 文档,获取有关配置详细信息。

请注意,在启用后必须配置 directives。示例配置如下:

global:
  appConfig:
    contentSecurityPolicy:
      enabled: true
      report_only: false
      directives:
        default_src: "'self'"
        script_src: "'self' 'unsafe-inline' 'unsafe-eval' https://www.recaptcha.net https://apis.google.com"
        frame_ancestor: "'self'"
        frame_src: "'self' https://www.recaptcha.net/ https://content.googleapis.com https://content-compute.googleapis.com https://content-cloudbilling.googleapis.com https://content-cloudresourcemanager.googleapis.com"
        img_src: "* data: blob:"
        style_src: "'self' 'unsafe-inline'"

不正确地配置 CSP 规则可能会阻止 GitLab 组件正常工作。在实施策略之前,您可能还需要将 report_only 更改为 true,以测试配置。

defaultProjectsFeatures

用于决定创建新项目时,是否使用相应功能的标记。所有标记的默认值为 true

defaultProjectsFeatures:
  issues: true
  mergeRequests: true
  wiki: true
  snippets: true
  builds: true
  containerRegistry: true

Gravatar/Libravatar 设置

默认情况下,chart 使用 gravatar.com 上的 Gravatar 头像服务。 但是如果需要,也可以使用自定义的 Libravatar 服务:

名称 类型 默认值 说明
gravatar.plainURL String (empty) 指向 Libravatar 实例的 HTTP URL(而不是使用 gravatar.com)。
gravatar.sslUrl String (empty) 指向 Libravatar 实例的 HTTPS URL(而不是使用 gravatar.com)。

整合对象存储

除了以下描述如何为对象存储进行单独设置的部分之外,我们还添加了一个统一对象存储配置,以简化这些项目的共享配置的使用。使用 object_store,你您以配置一个 connection,它将用于没有单独配置 connection 属性的对象存储中,任何或所有支持的功能。

  enabled: true
  proxy_download: true
  storage_options:
  connection:
    secret:
    key:
名称 类型 默认值 说明
enabled Boolean false 启用统一对象存储的使用。
proxy_download Boolean true 通过 GitLab 启用所有下载的代理,而不是从 bucket 直接下载。
storage_options String {} 查看下方文档
connection String {} 查看下方文档

属性结构是共享的,这里的所有属性都可以被下面的单个配置项覆盖。 connection 属性结构是相同的。

注意: 如果您希望偏离默认值,bucketenabledproxy_download 属性是唯一必须在每个配置项级别(global.appConfig.artifacts.bucket,…)配置的属性。

当将 AWS 提供程序用于 connection(这是任何与 S3 兼容的提供商,例如包含的 MinIO)时,GitLab Workhorse 可以卸载所有与存储相关的上传。 使用统一配置时,自动为您启用。

指定存储桶

每个对象类型应存储在不同的桶中。默认情况下,不同的对象类型使用如下存储桶名称:

对象类型 存储桶名称
CI artifacts gitlab-artifacts
Git LFS git-lfs
Packages gitlab-packages
Uploads gitlab-uploads
External merge request diffs gitlab-mr-diffs
Terraform State gitlab-terraform-state
Dependency Proxy gitlab-dependency-proxy
Pages gitlab-pages

您可以使用这些默认值或自行配置存储桶名称:

--set global.appConfig.artifacts.bucket=<BUCKET NAME> \
--set global.appConfig.lfs.bucket=<BUCKET NAME> \
--set global.appConfig.packages.bucket=<BUCKET NAME> \
--set global.appConfig.uploads.bucket=<BUCKET NAME> \
--set global.appConfig.externalDiffs.bucket=<BUCKET NAME> \
--set global.appConfig.terraformState.bucket=<BUCKET NAME> \
--set global.appConfig.dependencyProxy.bucket=<BUCKET NAME>

storage_options

storage_options 用于配置 S3 服务器端加密。

启用加密的最简单方法是在 S3 存储桶上设置默认加密,但您可能需要设置存储桶策略以确保只上传加密对象。 为此,您必须在 storage_options 区域设置发送正确的加密 header:

设置 说明
server_side_encryption 加密模式(AES256aws:kms
server_side_encryption_kms_key_id Amazon 资源名称,只有当 server_side_encryptionaws:kms 时需要设置,查看 使用 KMS 加密的 Amazon 文档

示例如下:

  enabled: true
  proxy_download: true
  connection:
    secret: gitlab-rails-storage
    key: connection
  storage_options:
    server_side_encryption: aws:kms
    server_side_encryption_kms_key_id: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

LFS, Artifacts, Uploads, Packages, External MR diffs, and Dependency Proxy

这些设置的详细信息如下。文档不会单独重复,因为除了 bucket 属性的默认值之外,它们在结构上是相同的。

  enabled: true
  proxy_download: true
  bucket:
  connection:
    secret:
    key:
名称 类型 默认值 说明
enabled Boolean 对于 LFS, artifacts, uploads, and packages,默认为 true 通过对象存储启用这些功能。
proxy_download Boolean true 通过 GitLab 启用所有下载的代理,而不是从bucket 直接下载。
bucket String 多种 要从对象存储 provisioner 使用的存储桶的名称。 默认将是git-lfsgitlab-artifactsgitlab-uploadsgitlab-packages,具体取决于服务。
connection String {} 查看下方文档

connection

connection 属性已转换为 Kubernetes Secret。这个 secret 的内容应该是一个 YAML 格式的文件。 默认为 {},如果 global.minio.enabledtrue,则将被忽略。

这个属性有两个子键:secretkey

  • secret 是 Kubernetes Secret 的名称. 使用外部对象存储需要此值。
  • key 是包含 YAML 块的键的名称。 默认为 connection

AWSGoogle 提供商的示例 可以在 examples/objectstorage 中找到。

创建包含 connection 内容的 YAML 文件后,使用此文件在 Kubernetes 中创建 secret。

kubectl create secret generic gitlab-rails-storage \
    --from-file=connection=rails.yaml

when (仅限 External MR Diffs)

externalDiffs 设置有一个额外的键 when 有条件地存储对象存储上的特定差异。 默认情况下,此设置在 Charts 中保留为空,用于由 Rails 代码分配的默认值。

接收电子邮件设置

命令行选项页面 中解释了接收电子邮件设置。

KAS 设置

自定义 secret

可以选择自定义 KAS secret 名称和 key,也可以使用 Helm 的 --set variable 选项:

--set global.appConfig.gitlab_kas.secret=custom-secret-name \
--set global.appConfig.gitlab_kas.key=custom-secret-key \

或配置您的 values.yaml

global:
  appConfig:
    gitlab_kas:
      secret: "custom-secret-name"
      key: "custom-secret-key"

如果您想要自定义 secret 值,参考 secrets 文档

自定义 URLs

可以使用 Helm 的 --set variable 选项自定义后端使用的 KAS 的 URL。

--set global.appConfig.gitlab_kas.externalUrl="wss://custom-kas-url.example.com" \
--set global.appConfig.gitlab_kas.internalUrl="grpc://custom-internal-url" \

或配置您的 values.yaml

global:
  appConfig:
    gitlab_kas:
      externalUrl: "wss://custom-kas-url.example.com"
      internalUrl: "grpc://custom-internal-url"

外部 KAS

通过配置启用并配置所需的 URL,使后端可以识别外部的 KAS 服务器(即不由 chart 管理)。您可以使用 Helm 的 --set variable 选项:

--set global.appConfig.gitlab_kas.enabled=true \
--set global.appConfig.gitlab_kas.externalUrl="wss://custom-kas-url.example.com" \
--set global.appConfig.gitlab_kas.internalUrl="grpc://custom-internal-url" \

或配置您的 values.yaml

global:
  appConfig:
    gitlab_kas:
      enabled: true
      externalUrl: "wss://custom-kas-url.example.com"
      internalUrl: "grpc://custom-internal-url"

LDAP

ldap.servers 下,允许配置 LDAP 用户认证。 它以 map 映射形式诚信啊,可以转化成 gitlab.yml (与从源安装时相同)中的 LDAP 服务器配置,

可以通过提供保存密码的 secret 来配置密码。然后密码将在运行时注入极狐GitLab 配置中。

示例配置片段如下:

ldap:
  preventSignin: false
  servers:
    # 'main' is the GitLab 'provider ID' of this LDAP server
    main:
      label: 'LDAP'
      host: '_your_ldap_server'
      port: 636
      uid: 'sAMAccountName'
      bind_dn: 'cn=administrator,cn=Users,dc=domain,dc=net'
      base: 'dc=domain,dc=net'
      password:
        secret: my-ldap-password-secret
        key: the-key-containing-the-password

当使用 global chart 时,--set 配置项示例:

--set global.appConfig.ldap.servers.main.label='LDAP' \
--set global.appConfig.ldap.servers.main.host='your_ldap_server' \
--set global.appConfig.ldap.servers.main.port='636' \
--set global.appConfig.ldap.servers.main.uid='sAMAccountName' \
--set global.appConfig.ldap.servers.main.bind_dn='cn=administrator\,cn=Users\,dc=domain\,dc=net' \
--set global.appConfig.ldap.servers.main.base='dc=domain\,dc=net' \
--set global.appConfig.ldap.servers.main.password.secret='my-ldap-password-secret' \
--set global.appConfig.ldap.servers.main.password.key='the-key-containing-the-password'
note在 Helm --set 中,逗号被视为特殊字符,确保在诸如 bind_dn 之类的值中转义逗号: --set global.appConfig.ldap.servers.main.bind_dn='cn=administrator\,cn=Users\,dc=domain\,dc=net'

禁用 LDAP web 登录

当首选 SAML 等替代方法时,阻止通过 Web UI 使用 LDAP 凭据会很有用。这样允许 LDAP 用于组同步,同时还允许您的 SAML 身份提供商进行额外的检查,例如自定义 2FA。

当禁用 LDAP web 登录时,用户将不会在登录页面上看到 LDAP 选项卡。这样不会禁用使用 LDAP 凭据进行 Git 访问

要禁用 LDAP web 登录,设置 global.appConfig.ldap.preventSignin: true

使用自定义 CA 或自签名 LDAP 证书

如果 LDAP 服务器使用自定义 CA 或自签名 LDAP 证书,您必须:

  1. 确保将自定义 CA/自签名证书创建为集群/命名空间中的 Secret:

    kubectl -n gitlab create secret generic my-custom-ca --from-file=my-custom-ca.pem
    
  2. 然后进行以下配置:

    --set global.certificates.customCAs[0].secret=my-custom-ca.pem
    --set global.appConfig.ldap.servers.main.ca_file=/etc/ssl/certs/ca-cert-my-custom-ca.pem
    

这将确保 CA 安装在 /etc/ssl/certs/ca-cert-my-custom-ca.pem 下的相关 pod 中,并指定其在 LDAP 配置中的使用。

Pseudonymizer 配置

以下是 Pseudonymizer service 配置示例:

global:
  appConfig:
    pseudonymizer:
      configMap:
      bucket: gitlab-pseudo
      connection: {}
名称 类型 默认值 说明
bucket String gitlab-pseudo 要使用的来自对象存储提供商的存储桶名称。
configMap String   查看下方文档
connnection   {} 查看下方文档

configMap

包含自定义清单文件的 configMap 的名称。默认为空。

极狐GitLab 附带一个 Pseudonymizer 的默认清单文件。 用户可以提供自定义的 configMap:

  1. 首先,创建一个 configMap:

    kubectl create configmap <name of the configmap> --from-file=pseudonymizer.yml=<path to pseudonymizer_config.yml>
    

    确保在上面的命令中,用于创建 configMap 的键是 pseudonymizer.yml。它用于将服务指向正确的位置,不正确的键将导致 Pseudonymizer 无法工作。

  2. 然后,将参数 --set global.appConfig.pseudonymizer.configMap=<name of the configmap> 传递给 helm install 命令,指示极狐GitLab 使用该清单而不是默认清单。

connection

包含与对象存储提供商的 connection 信息的 Kubernetes secret 的详情。Secret 的内容应该是一个 YAML 格式的文件。

默认为 {},如果 global.minio.enabledtrue,则将被忽略。

该属性有两个子键:secretkey

  • secret 是 Kubernetes Secret 的名称。该值要求使用外部对象存储。
  • key 是包含 YAML 块的 Secret 下的 key 的名称。默认为 connection

获取 AWS (s3)Google (GCS) 的示例,请查看 examples/objectstorage

当创建了包含 connection 内容的 YAML 文件时,在 Kubernetes 中创建 Secret:

kubectl create secret generic gitlab-rails-storage \
    --from-file=connection=rails.yaml

Cron jobs 关联设置

Sidekiq 包括可配置为使用 cron 样式计划定期运行的维护作业。下面提供了示例。有关更多工作示例,请查看 gitlab.yml

该设置在 Sidekiq、Webservice(用于在 UI 中显示工具提示)和 Toolbox(用于调试目的)的 pods 之间共享。

global:
  appConfig:
    cron_jobs:
      stuck_ci_jobs_worker:
        cron: "0 * * * *"
      pipeline_schedule_worker:
        cron: "19 * * * *"
      expire_build_artifacts_worker:
        cron: "*/7 * * * *"

Sentry 设置

使用以下设置启用 Sentry 错误报告

global:
  appConfig:
    sentry:
      enabled:
      dsn:
      clientside_dsn:
      environment:
名称 类型 默认值 说明
enabled Boolean false 启用或禁用集成
dsn String   后端错误的 Sentry DSN
clientside_dsn String   前端错误的 Sentry DSN
environment String   查看 Sentry 环境文档

Smartcard Authentication 设置

global:
  appConfig:
    smartcard:
      enabled: false
      CASecret:
      clientCertificateRequiredHost:
      sanExtensions: false
      requiredForGitAccess: false
名称 类型 默认值 说明
enabled Boolean false 启用或禁用 smartcard authentication
CASecret String   包含 CA 证书的 Secret 的名称
clientCertificateRequiredHost String   用于 smartcard authentication 的主机名。默认情况下,使用提供的或计算的 smartcard 主机名。
sanExtensions Boolean false 启用 SAN 扩展以将用户与证书匹配
requiredForGitAccess Boolean false 要求使用 smartcard 登录的浏览器会话才能访问 Git。

Sidekiq 路由规则设置

支持在计划之前,将作业从 worker 路由到所需的队列。 Sidkiq 客户端将作业与配置的路由规则列表进行匹配。规则从头到尾进行匹配,只要找到匹配的 worker,就会停止这个 worker 的进程(首次匹配优先)。如果 worker 不匹配任何规则,它会回退到由 worker 名称生成的队列名称。

默认情况下,路由规则没有配置(或空数组),所有作业都被路由到从 worker 名称生成的队列中。

路由规则列表是一个有序的查询元组数组和对应的队列:

  • 查询遵循 worker 匹配查询语法。
  • <queue_name> 必须是有效的 Sidekiq 队列名称。如果队列名称是 nil 或空字符串,worker 被路由到由 worker 名称生成的队列。

查询支持通配符匹配 *,它匹配所有的 worker。在这种情况下,通配符查询必须留在列表的末尾,否则后面的规则会被忽略:

global:
  appConfig:
    sidekiq:
      routingRules:
      - ["resource_boundary=cpu", "cpu_boundary"]
      - ["feature_category=pages", null]
      - ["feature_category=search", "search"]
      - ["feature_category=memory|resource_boundary=memory", "memory-bound"]
      - ["*", "default"]

Rails 配置

极狐GitLab 套件的很大一部分基于 Rails。因此,该项目中的许多容器都使用此堆栈运行。这些设置适用于所有容器,并提供一种简单的访问方法来全局设置,而不是单独设置。

global:
  rails:
    bootsnap:
      enabled: true

Workhorse 配置

极狐GitLab 套件的几个组件通过 GitLab Workhorse 与 API 通信。这是 Webservice chart 的一部分。所有需要与 GitLab Workhorse 通信的 chart 都会使用这些设置,并提供一种简单的访问方法来全局设置,而不是单独设置。

global:
  workhorse:
    serviceName: webservice-default
    host: api.example.com
    port: 8181
名称 类型   默认值 说明
serviceName String webservice-default 将内部 API 流量定向到的 service 的名称。不要包含发布名称,因为它将被模板化。应当与 gitlab.webservice.deployments 中的条目匹配。查看 gitlab/webservice chart 文档  
scheme String http API 端点 Scheme  
host String   API 端点的完全限定主机名或 IP 地址。覆盖 serviceName  
port Integer 8181 关联的 API 服务器端口  

Bootsnap Cache

Rails 代码库使用了 Shopify’s Bootsnap Gem。

bootsnap.enabled 控制是否激活该特性。默认为 true

测试表明,启用 Bootsnap 可提高整体应用程序性能。当预编译缓存可用时,一些应用程序容器的提升会超过 33%。 目前,极狐GitLab 并未随容器一起提供此预编译缓存,因此“仅”获得 14% 左右的提升。 在没有预编译缓存的情况下,这种提升是有代价的,会导致每个 Pod 初始启动时小型 IO 的强烈峰值。 因此,我们公开了一种在可能会出现问题的环境中禁用 Bootsnap 的方法。

如果可能,我们建议启用此功能。

GitLab Shell 配置

以下是 GitLab Shell chart 全局配置示例:

global:
  shell:
    port:
    authToken: {}
    hostKeys: {}
    tcp:
      proxyProtocol: false
名称 类型 默认值 说明
port Integer 22 查看下面的 port 文档。
authToken     查看 GitLab Shell chart 文档中的 authToken 部分。
hostKeys     查看 GitLab Shell chart 文档中的 hostKeys 部分。
tcp.proxyProtocol Boolean false 查看下面的 TCP proxy protocol 文档。

Port

您可以控制 Ingress 用于传递 SSH 流量的端口,以及极狐GitLab 通过 global.shell.port 提供的 SSH URL 中使用的端口。 这会反映在服务侦听的端口,以及项目 UI 中提供的 SSH 克隆 URL。

global:
  shell:
    port: 32022

您可以结合 global.shell.portnginx-ingress.controller.service.type=NodePort,为 NGINX controller Service 对象设置一个 NodePort。请注意,如果设置了 nginx-ingress.controller.service.nodePorts.gitlab-shell,当为 NGINX 设置 NodePort 时,将覆盖 global.shell.port

global:
  shell:
    port: 32022

nginx-ingress:
  controller:
    service:
      type: NodePort

TCP 代理协议

您可以在 SSH Ingress 上启用 代理协议,以正确处理来自添加了代理协议 header 的上游代理的连接。这样,将阻止 SSH 接收额外的 header 并且不会破坏 SSH。

global:
  shell:
    tcp:
      proxyProtocol: true # default false

GitLab Pages 配置

被其它 chart 使用的全局 GitLab Pages 设置位于 global.pages 键下:

global:
  pages:
    enabled:
    accessControl:
    path:
    host:
    port:
    https:
    externalHttp:
    externalHttps:
    artifactsServer:
    objectStore:
      enabled:
      bucket:
      proxy_download: true
      connection: {}
        secret:
        key:
    localStore:
      enabled: false
      path:
    apiSecret: {}
      secret:
      key:
名称 类型 默认值 说明
enabled Boolean False 决定是否在集群中安装 GitLab Pages chart
accessControl Boolean False 启用 GitLab Pages 访问控制
path String /srv/gitlab/shared/pages Pages deployment 关联文件的存储路径。注意:因为使用了对象存储,默认情况下未使用。
host String   Pages 根域名
port String   用于在 UI 中构建 Pages URL 的端口。 如果不设置,则根据 Pages 的 HTTPS 配置情况设置默认值 80 或 443。
https Boolean True UI 是否应显示 Pages 的 HTTPS URL,优先于global.hosts.pages.httpsglobal.hosts.https。默认设置为 True。
externalHttp List [] HTTP 请求到达 Pages daemon 的 IP 地址列表。用于支持自定义域名。
externalHttps List [] HTTPS 请求到达 Pages daemon 的 IP 地址列表。用于支持自定义域名。
artifactsServer Boolean True 在 GitLab Pages 中启用 viewing artifacts。
objectStore.enabled Boolean True 为 Pages 启用对象存储。
objectStore.bucket String gitlab-pages 用于存储与 Pages 相关内容的存储桶。
objectStore.connection.secret String   包含对象存储连接详细信息的 Secret。
objectStore.connection.key String   存储连接详细信息的 Secret 中的键。
localStore.enabled Boolean False 启用对与 Pages 相关的内容使用本地存储(而不是 objectStore)
localStore.path String /srv/gitlab/shared/pages Pages 文件将被存储的路径; 仅在 localStore 设置为 true 时使用。
apiSecret.secret String   包含 Base64 编码形式的 32 位 API 密钥的 Secret。
apiSecret.key String   存储 API key 的 Secret 中的键。

Webservice 配置

全局 Webservice 设置(也被其它 chart 使用)位于 global.webservice 键下。

global:
  webservice:
    workerTimeout: 60

workerTimeout

配置请求超时(以秒为单位),在此之后 Webservice worker 进程会被 Webservice master 进程终止默认值为 60 秒。

自定义证书颁发机构

note这些设置不会通过 requirements.yaml 影响仓库外部的 chart。

某些用户可能需要添加自定义证书颁发机构,例如在为 TLS 服务使用内部颁发的 SSL 证书时。为了提供此功能,我们提供了一种机制,通过 Secret 将自定义根证书颁发机构注入应用程序。

global:
  certificates:
    customCAs:
      - secret: internal-cas
      - secret: other-custom-cas

用户可以提供任意数量的 Secret,每个 Secret 都包含任意数量的持有 PEM 编码 CA 证书的键。这些应被配置为global.certificates.customCAs 下的条目。Secret 中的所有键都会被挂载,因此所有 Secret 中的所有键必须是唯一的。这些 Secret 可以以任何方式命名,但它们不得包含冲突的密钥名称。

创建一个 secret:

kubectl create secret generic custom-ca --from-file=unique_name=/path/to/cert

配置 secret:

helm install gitlab gitlab/gitlab \
  --set global.certificates.customCAs[0].secret=custom-ca

Application 资源

极狐GitLab 可以选择包含一个 Application 资源,可以创建它来识别集群中的 GitLab 应用程序,需要已在集群中部署 v1beta1 版本的 Application CRD

设置 global.application.createtrue,可以启用:

global:
  application:
    create: true

某些环境(例如 Google GKE Marketplace)不允许创建 ClusterRole 资源。设置以下值以禁用应用程序自定义资源定义中的 ClusterRole 组件,以及相关 chart 打包到 Cloud Native GitLab。

global:
  application:
    allowClusterRoles: false
  operator:
     enabled: false
nginx:
  controller:
    scope:
      enabled: true
gitlab-runner:
  rbac:
    clusterWideAccess: false
certmanager:
  install: false

Busybox 镜像

默认情况下,GitLab Helm charts 使用 busybox:latest 来启动各种 initContainers。由以下设置控制:

global:
  busybox:
    image:
      repository: busybox
      tag: latest

许多 chart 还在本地提供了 init.image.repositoryinit.image.tag 设置,可用于覆盖特定 chart 的全局设置。

Service Accounts

GitLab Helm chart 允许使用自定义 Service Accounts 运行 pod。 在 global.serviceAccount 进行如下配置:

global:
  serviceAccount:
    enabled: false
    create: true
    annotations: {}
    ## Name to be used for serviceAccount, otherwise defaults to chart fullname
    # name:
  • global.serviceAccount.enabled 设置为 true,将为每个 deployment 创建自定义的 service account。
  • global.serviceAccount.create 设置为 false 将禁用 service account 的自动创建。
  • 设置 global.serviceAccount.name,将在 deployment 中,为自动生成或手动创建的 service account 使用该名称。

Annotations

自定义 annotations 适用于 Deployment、Service 和 Ingress 对象。

global:
  deployment:
    annotations:
      environment: production

  service:
    annotations:
      environment: production

  ingress:
    annotations:
      environment: production

Node Selector

自定义的 nodeSelector 适用于全局的所有组件,也可以在每个子 chart 上,单独覆盖任何全局默认值。

global:
  nodeSelector:
    disktype: ssd

Note: 外部维护的 chart 不遵循 global.nodeSelector,可能需要根据可用 chart 值单独配置。包括 Prometheus、cert-manager 和 Redis 等。

Labels

Common Labels

通过使用 common.labels,标签可以适用于几乎所有由各种对象创建的对象。可以在 global 键下,或在特定 chart 的配置下使用。示例如下:

global:
  common:
    labels:
      environment: production
gitlab:
  gitlab-shell:
    common:
      labels:
        foo: bar

在上面的示例配置中,几乎所有由 Helm chart 部署的组件都将具有 environment: production 标签集。所有 GitLab shell chart 的组件将具有 foo: bar 标签集。某些 chart 允许额外的嵌套。例如 Sidekiq 和 Webservices chart 允许根据您的配置需求进行额外的部署:

gitlab:
  sidekiq:
    pods:
      - name: pod-0
        common:
          labels:
            baz: bat

在上面的示例中,与 pod-0 Sidekiq 部署相关的所有组件也将收到标签集 baz: bat。有关其他详细信息,请参阅 Sidekiq 和 Webservice chart。

我们依赖的一些 chart 被排除在此标签配置之外。只有 GitLab 组件子 chart 会收到这些额外的标签。

Pod

自定义标签可应用于各种 Deployments 和 Jobs。这些标签是对有 Helm chart 构建的现有或预配置标签的补充。这些补充标签不会用于 matchSelectors

global:
  pod:
    labels:
      environment: production

Service

自定义标签可以应用于 services。这些标签是对有 Helm chart 构建的现有或预配置标签的补充。

global:
  service:
    labels:
      environment: production

Tracing

GitLab Helm chart 支持 tracing,配置示例如下:

global:
  tracing:
    connection:
      string: 'opentracing://jaeger?http_endpoint=http%3A%2F%2Fjaeger.example.com%3A14268%2Fapi%2Ftraces&sampler=const&sampler_param=1'
    urlTemplate: 'http://jaeger-ui.example.com/search?service={{ service }}&tags=%7B"correlation_id"%3A"{{ correlation_id }}"%7D'
  • global.tracing.connection.string 用于配置 tracing spans 的发送位置。
  • global.tracing.urlTemplate 用于配置 GitLab 性能栏中,tracing info URL 渲染的模板。

extraEnv

extraEnv 允许您在通过 GitLab chart 部署的 pod 的所有容器中,暴露额外的环境变量。设置在全局级别的环境变量将合并到 chart 级别的环境变量,chart 级别的环境变量优先级高。

使用 extraEnv 的示例如下:

global:
  extraEnv:
    SOME_KEY: some_value
    SOME_OTHER_KEY: some_other_value

OAuth 配置

OAuth 集成对于支持它的服务来说是开箱即用的。global.oauth 中指定的服务在部署期间会自动注册为极狐GitLab 中的 OAuth 客户端应用程序。默认情况下,如果启用了访问控制。包含 GitLab Pages。

global:
  oauth:
    gitlab-pages: {}
    # secret
    # appid
    # appsecret
    # redirectUri
名称 类型 默认值 说明
secret String   带有 OAuth 凭证的 Secret 的名称。
appIdKey String   Secret 中存储服务的 App ID 的键。默认值为 appid
appSecretKey String   Secret 中存储服务的 App Secret 的键。默认值为 appsecret
redirectUri String   成功授权后,将用户重定向到的 URI。

查看 secrets 文档,获取更多详细信息。

Outgoing email

通过 global.smtp.*global.email.*,可进行 Outgoing email 配置。

global:
  email:
    display_name: 'GitLab'
    from: 'gitlab@example.com'
    reply_to: 'noreply@example.com'
  smtp:
    enabled: true
    address: 'smtp.example.com'
    tls: true
    authentication: 'plain'
    user_name: 'example'
    password:
      secret: 'smtp-password'
      key: 'password'

查看 outgoing email 文档获取配置项的更多信息。

查看 Omnibus SMTP 设置文档,可查看更多详细案例。

Platform

platform 键是为特定平台(如 GKE 或 EKS)的特定功能保留的。