Toolbox

极狐GitLab Toolbox Pod 用于在极狐GitLab 应用程序中执行周期性的维护任务。这些任务包括备份、Sidekiq 维护和 Rake 任务。

配置#

以下配置设置是 Toolbox chart 提供的默认设置：

yaml
1gitlab:
2  ## doc/charts/gitlab/toolbox
3  toolbox:
4    enabled: true
5    replicas: 1
6    backups:
7      cron:
8        enabled: false
9        concurrencyPolicy: Replace
10        failedJobsHistoryLimit: 1
11        schedule: "0 1 * * *"
12        successfulJobsHistoryLimit: 3
13        suspend: false
14        backoffLimit: 6
15        safeToEvict: false
16        restartPolicy: "OnFailure"
17        resources:
18          requests:
19            cpu: 50m
20            memory: 350M
21        persistence:
22          enabled: false
23          accessMode: ReadWriteOnce
24          useGenericEphemeralVolume: false
25          size: 10Gi
26      objectStorage:
27        backend: s3
28        config: {}
29    persistence:
30      enabled: false
31      accessMode: 'ReadWriteOnce'
32      size: '10Gi'
33    resources:
34      requests:
35        cpu: '50m'
36        memory: '350M'
37    securityContext:
38      fsGroup: '1000'
39      runAsUser: '1000'
40      runAsGroup: '1000'
41    containerSecurityContext:
42      runAsUser: '1000'
43    affinity: {}

配置备份#

有关配置备份的信息，请参阅备份和恢复文档。有关备份执行的技术实现的更多信息，请参阅备份和恢复架构文档。

持久化配置#

备份和恢复的持久化存储是单独配置的。请在配置极狐GitLab 的备份和恢复操作时查看以下注意事项。

备份使用 backups.cron.persistence.* 属性，恢复使用 persistence.* 属性。有关持久化存储配置的进一步描述将仅使用最终的属性键（例如 .enabled 或 .size），需要添加适当的前缀。

持久化存储默认是禁用的，因此需要将 .enabled 设置为 true 才能对任何显著大小的备份或恢复进行操作。此外，要么需要为 PersistentVolume 指定 .storageClass，以便由 Kubernetes 创建 PersistentVolume，要么需要手动创建 PersistentVolume。如果 .storageClass 指定为 '-'，则 PersistentVolume 将使用 Kubernetes 集群中指定的默认存储类创建。

如果手动创建 PersistentVolume，则可以使用 .volumeName 属性或选择器 .matchLables / .matchExpressions 属性来指定卷。

在大多数情况下，默认的 .accessMode 值将为 Toolbox 访问 PersistentVolumes 提供足够的控制。请查阅安装在 Kubernetes 集群中的 CSI 驱动程序的文档，以确保设置正确。

备份注意事项#

备份操作需要一定数量的磁盘空间来存放备份前的各个组件，然后再将其写入备份对象存储。磁盘空间的数量取决于以下因素：

• 项目的数量以及每个项目下存储的数据量
• PostgresSQL 数据库的大小（议题、MR 等）
• 每个对象存储后端的大小

一旦确定了大致大小，就可以设置 backups.cron.persistence.size 属性，以便开始备份。

恢复注意事项#

在备份恢复期间，需要将备份提取到磁盘，然后再将文件替换到运行的实例上。此恢复磁盘空间的大小由 persistence.size 属性控制。请注意，随着极狐GitLab 安装的增长，恢复磁盘空间的大小也需要相应增长。在大多数情况下，恢复磁盘空间的大小应与备份磁盘空间的大小相同。

Toolbox 包含的工具#

Toolbox 容器包含有用的极狐GitLab 工具，如 Rails 控制台、Rake 任务等。这些命令允许检查数据库迁移的状态，执行管理任务的 Rake 任务，交互使用 Rails 控制台：

shell
1# 定位 Toolbox pod
2kubectl get pods -lapp=toolbox
3
4# 在 pod 内启动 shell
5kubectl exec -it <Toolbox pod name> -- bash
6
7# 打开 Rails 控制台
8gitlab-rails console -e production
9
10# 执行 Rake 任务
11gitlab-rake gitlab:env:info

亲和性#

有关更多信息，请参阅 affinity。