mendersoftware/create-artifact-worker

Artifact Creation Worker 镜像文档

镜像概述

Artifact Creation Worker 是一个轻量级制品创建工作器镜像，旨在自动化处理各类制品（如软件包、容器镜像、文档、归档文件等）的创建流程。该镜像可无缝集成到CI/CD管道、自动化构建系统或批量处理任务中，通过配置化参数控制制品构建行为，简化从源码到成品的转换过程，提升制品管理效率。

核心功能与特性

主要功能

• 多类型制品支持：兼容常见制品类型，包括tar/zip归档文件、RPM/DEB软件包、Docker容器镜像、静态文档（HTML/PDF）等。
• 自动化流程控制：内置标准化构建流程，支持从源码拉取、编译（如需）、打包到输出的全自动化处理，减少人工干预。
• 灵活配置能力：通过环境变量或配置文件自定义构建参数（如制品版本、输出格式、依赖管理策略等），适配不同场景需求。
• 日志与监控：提供详细的构建过程日志输出，支持集成外部监控工具（如Prometheus），便于追踪任务状态与问题排查。
• 轻量级设计：基于Alpine基础镜像构建，镜像体积小（通常<100MB），资源占用低，适合在资源受限环境中部署。

使用场景与适用范围

典型应用场景

• CI/CD流程集成：作为CI/CD管道（如Jenkins、GitLab CI、GitHub Actions）中的关键环节，负责代码构建完成后的制品打包与输出。
• 自动化打包系统：用于定期或触发式批量生成制品，如 nightly 构建、版本发布前的预打包等。
• 开发/测试环境：在开发或测试阶段，快速生成临时制品供本地测试或团队共享。
• 制品管理平台：与制品仓库（如Nexus、Artifactory）配合，实现制品的自动创建与上传一体化流程。

使用方法与配置说明

基本使用（Docker Run）

通过 docker run 命令启动工作器，指定必要参数：

bash
docker run -d \
  --name artifact-worker \
  -e ARTIFACT_TYPE="tar" \          # 制品类型（必填）
  -e SOURCE_PATH="/app/source" \    # 源文件在容器内的路径（必填）
  -e OUTPUT_PATH="/app/output" \    # 制品输出路径（必填）
  -e ARTIFACT_VERSION="1.0.0" \     # 制品版本号（可选）
  -v /host/source:/app/source \     # 挂载宿主机源文件目录
  -v /host/output:/app/output \     # 挂载宿主机输出目录
  artifact-creation-worker:latest

环境变量配置

配置文件使用（可选）

如需复杂配置，可通过挂载外部配置文件（支持JSON或YAML格式）覆盖默认行为。配置文件示例（config.yaml）：

yaml
artifact:
  type: "docker"          # 制品类型
  version: "2.1.0"        # 制品版本
  source:
    path: "/app/source"   # 源文件路径
    exclude: ["tmp/*", "*.log"]  # 排除文件/目录
  output:
    path: "/app/output"   # 输出路径
    filename: "app-image-{{version}}.tar"  # 自定义文件名（支持变量{{version}}）
  options:                # 制品类型特定选项（以docker为例）
    build-arg: ["HTTP_PROXY=http://proxy:8080", "VERSION={{version}}"]
    dockerfile: "Dockerfile.prod"
logging:
  level: "debug"          # 日志级别
  file: "/app/logs/worker.log"  # 日志文件路径（需挂载日志目录）

启动命令（挂载配置文件）：

bash
docker run -d \
  --name artifact-worker \
  -v /host/source:/app/source \
  -v /host/output:/app/output \
  -v /host/config/config.yaml:/app/config/config.yaml \  # 挂载配置文件
  -v /host/logs:/app/logs \  # 挂载日志目录
  -e CONFIG_FILE="/app/config/config.yaml" \  # 指定配置文件路径
  artifact-creation-worker:latest

集成CI/CD示例（GitLab CI）

在 .gitlab-ci.yml 中使用该镜像进行制品构建：

yaml
stages:
  - build
  - package

build:
  stage: build
  script:
    - # 编译源码等前置步骤
    - mkdir -p source output

package:
  stage: package
  image: artifact-creation-worker:latest
  variables:
    ARTIFACT_TYPE: "rpm"
    ARTIFACT_VERSION: "$CI_COMMIT_TAG"  # 使用GitLab标签作为版本号
    SOURCE_PATH: "/app/source"
    OUTPUT_PATH: "/app/output"
  script:
    - # 工作器自动执行制品创建
  artifacts:
    paths:
      - output/  # 收集输出的制品
  only:
    - tags  # 仅在打标签时触发

注意事项

• 确保挂载的源文件目录和输出目录具有读写权限（可通过 -u $(id -u):$(id -g) 指定用户ID避免权限问题）。
• 对于容器镜像类制品，需确保工作器所在环境可访问Docker引擎（可挂载 /var/run/docker.sock）。
• 复杂制品类型（如RPM/DEB）可能需要额外依赖，可通过自定义镜像构建（基于本镜像）添加必要工具。