Help us learn about your current experience with the documentation. Take the survey.

作业产物管理

Tier: Free, Premium, Ultimate
Offering: GitLab Self-Managed

这是管理文档。要了解如何在 GitLab CI/CD 流水线中使用作业产物，请参阅作业产物配置文档。

产物是作业完成后附加到作业的文件和目录列表。此功能在所有 GitLab 安装中默认启用。

禁用作业产物

要在全站范围内禁用产物：

编辑 /etc/gitlab/gitlab.rb：

gitlab_rails['artifacts_enabled'] = false

保存文件并重新配置 GitLab：
```
sudo gitlab-ctl reconfigure
```

导出 Helm 值：

helm get values gitlab > gitlab_values.yaml

编辑 gitlab_values.yaml：

global:
  appConfig:
    artifacts:
      enabled: false

保存文件并应用新值：

helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab

编辑 docker-compose.yml：

version: "3.6"
services:
  gitlab:
    environment:
      GITLAB_OMNIBUS_CONFIG: |
        gitlab_rails['artifacts_enabled'] = false

保存文件并重启 GitLab：
```
docker compose up -d
```

编辑 /home/git/gitlab/config/gitlab.yml：

production: &base
  artifacts:
    enabled: false

保存文件并重启 GitLab：

# 对于运行 systemd 的系统
sudo systemctl restart gitlab.target

# 对于运行 SysV init 的系统
sudo service gitlab restart

存储作业产物

GitLab Runner 可以将包含作业产物的存档上传到 GitLab。默认情况下，这是在作业成功时完成的，但也可以在失败时或始终使用 artifacts:when 参数来完成。

大多数产物在发送到协调器之前会被 GitLab Runner 压缩。例外情况是报告产物，它们在上传后被压缩。

使用本地存储

如果您使用的是 Linux 包或自行编译的安装，可以更改产物在本地存储的位置。

对于 Docker 安装，您可以更改数据挂载的路径。对于 Helm chart，请使用对象存储。

产物默认存储在 /var/opt/gitlab/gitlab-rails/shared/artifacts。

要更改存储路径，例如更改为 /mnt/storage/artifacts，请编辑 /etc/gitlab/gitlab.rb 并添加以下行：
```
gitlab_rails['artifacts_path'] = "/mnt/storage/artifacts"
```
保存文件并重新配置 GitLab：
```
sudo gitlab-ctl reconfigure
```

产物默认存储在 /home/git/gitlab/shared/artifacts。

要更改存储路径，例如更改为 /mnt/storage/artifacts，请编辑 /home/git/gitlab/config/gitlab.yml 并添加或修改以下行：
```
production: &base
  artifacts:
    enabled: true
    path: /mnt/storage/artifacts
```

保存文件并重启 GitLab：

# 对于运行 systemd 的系统
sudo systemctl restart gitlab.target

# 对于运行 SysV init 的系统
sudo service gitlab restart

使用对象存储

如果您不想使用安装 GitLab 的本地磁盘来存储产物，可以使用像 AWS S3 这样的对象存储。

如果您将 GitLab 配置为在对象存储上存储产物，您可能还希望消除作业日志的本地磁盘使用。在这两种情况下，作业日志在完成后都会被归档并移动到对象存储。

在多服务器设置中，您必须使用以下选项之一来消除作业日志的本地磁盘使用，否则作业日志可能会丢失。

您应该使用统一的对象存储设置。

迁移到对象存储

您可以将作业产物从本地存储迁移到对象存储。处理过程在后台工作程序中完成，无需停机。

配置对象存储。

迁移产物：

sudo gitlab-rake gitlab:artifacts:migrate

sudo docker exec -t <container name> gitlab-rake gitlab:artifacts:migrate

sudo -u git -H bundle exec rake gitlab:artifacts:migrate RAILS_ENV=production

可选。使用 PostgreSQL 控制台跟踪进度并验证所有作业产物是否已成功迁移。

打开 PostgreSQL 控制台：

sudo gitlab-psql

sudo docker exec -it <container_name> /bin/bash
gitlab-psql

sudo -u git -H psql -d gitlabhq_production

使用以下 SQL 查询验证所有产物是否已迁移到对象存储。objectstg 的数量应与 total 相同：

gitlabhq_production=# SELECT count(*) AS total, sum(case when file_store = '1' then 1 else 0 end) AS filesystem, sum(case when file_store = '2' then 1 else 0 end) AS objectstg FROM ci_job_artifacts;

total | filesystem | objectstg
------+------------+-----------
   19 |          0 |        19

验证 artifacts 目录中没有磁盘上的文件：

sudo find /var/opt/gitlab/gitlab-rails/shared/artifacts -type f | grep -v tmp | wc -l

假设您将 /var/opt/gitlab 挂载到 /srv/gitlab：

sudo find /srv/gitlab/gitlab-rails/shared/artifacts -type f | grep -v tmp | wc -l

sudo find /home/git/gitlab/shared/artifacts -type f | grep -v tmp | wc -l

如果启用了 Geo，请重新验证所有作业产物。

在某些情况下，您需要运行孤立产物文件清理 Rake 任务来清理孤立的产物。

从对象存储迁移到本地存储

要将产物迁移回本地存储：

运行 gitlab-rake gitlab:artifacts:migrate_to_local。
在 gitlab.rb 中选择性地禁用产物的存储。
重新配置 GitLab。

产物过期

如果使用 artifacts:expire_in 设置产物的过期时间，它们会在该日期过去后立即被标记为删除。否则，它们将根据默认产物过期设置过期。

产物由 expire_build_artifacts_worker cron 作业删除，Sidekiq 每 7 分钟运行一次（Cron 语法中的 */7 * * * *）。

要更改删除过期产物的默认计划：

编辑 /etc/gitlab/gitlab.rb 并添加以下行（如果已存在且被注释掉，则取消注释），用 cron 语法替换您的计划：
```
gitlab_rails['expire_build_artifacts_worker_cron'] = "*/7 * * * *"
```
保存文件并重新配置 GitLab：
```
sudo gitlab-ctl reconfigure
```

导出 Helm 值：

helm get values gitlab > gitlab_values.yaml

编辑 gitlab_values.yaml：

global:
  appConfig:
    cron_jobs:
      expire_build_artifacts_worker:
        cron: "*/7 * * * *"

保存文件并应用新值：

helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab

编辑 docker-compose.yml：

version: "3.6"
services:
  gitlab:
    environment:
      GITLAB_OMNIBUS_CONFIG: |
        gitlab_rails['expire_build_artifacts_worker_cron'] = "*/7 * * * *"

保存文件并重启 GitLab：
```
docker compose up -d
```

编辑 /home/git/gitlab/config/gitlab.yml：

production: &base
  cron_jobs:
    expire_build_artifacts_worker:
      cron: "*/7 * * * *"

保存文件并重启 GitLab：

# 对于运行 systemd 的系统
sudo systemctl restart gitlab.target

# 对于运行 SysV init 的系统
sudo service gitlab restart

设置产物的最大文件大小

如果启用了产物，您可以通过管理员区域设置更改产物的最大文件大小。

存储统计

您可以在以下位置查看组和项目用于作业产物的总存储空间：

管理员区域
组和项目API

实现细节

当 GitLab 接收到产物存档时，GitLab Workhorse 也会生成一个存档元数据文件。此元数据文件描述了位于产物存档本身中的所有条目。元数据文件采用二进制格式，并附加了 Gzip 压缩。

GitLab 不会提取产物存档以节省空间、内存和磁盘 I/O。它改为检查包含所有相关信息的元数据文件。当有大量产物或存档是非常大的文件时，这一点尤其重要。

当选择特定文件时，GitLab Workhorse 会从存档中提取它，然后开始下载。这种实现节省了空间、内存和磁盘 I/O。