refactr/runner

Sophos Factory Runner Docker镜像文档

1. 镜像概述和主要用途

1.1 镜像概述

Sophos Factory Runner 是一个预构建的 Docker 镜像，专为 Sophos Factory 自托管运行器（self-hosted runner）设计。该镜像提供了在用户自有基础设施上部署和运行 Sophos Factory 流水线任务的基础环境，支持与 Sophos Factory 平台的无缝集成。

1.2 主要用途

• 作为 Sophos Factory 自托管运行器的基础组件，在私有环境中执行流水线任务
• 支持用户在自定义基础设施上部署和管理 Sophos Factory 流水线，满足私有环境下的任务执行需求

2. 核心功能和特性

• 自托管部署支持：允许在用户自有服务器或私有云环境中部署运行器，脱离公共云依赖
• 平台集成能力：与 Sophos Factory 平台深度集成，支持接收和执行来自平台的流水线任务
• 认证与安全：通过配置文件实现与 Sophos Factory 平台的安全认证，确保通信合法性
• 轻量级容器化设计：基于 Docker 容器化技术，部署简单、资源占用低，易于维护

3. 使用场景和适用范围

3.1 适用场景

• 私有环境流水线执行：需在企业内网、隔离网络或私有数据中心运行 Sophos Factory 流水线的场景
• 数据隐私与合规要求：对任务执行过程中的数据隐私、网络传输有严格控制需求的组织（如***、***行业）
• 自定义基础设施资源：需要利用自有服务器资源（如 GPU、专用存储）执行流水线任务的场景

3.2 适用范围

• Sophos Factory 平台用户
• 具备基础 Docker 环境和私有基础设施管理能力的技术团队

4. 使用方法和配置说明

4.1 环境准备

• 已安装 Docker 引擎（推荐版本 20.10+）
• 可访问 Sophos Factory 平台并获取运行器认证信息
• 具备创建和挂载配置文件的权限

4.2 配置文件准备

运行器需通过配置文件与 Sophos Factory 平台认证，配置文件需包含认证详情。

4.2.1 创建配置文件

参考 https://github.com/sophos-factory/runner-utils#creating-a-runner-config-file%EF%BC%8C%E7%94%9F%E6%88%90%E5%8C%85%E5%90%AB%E8%AE%A4%E8%AF%81%E4%BF%A1%E6%81%AF%E7%9A%84 config.json 文件。配置文件需至少包含平台连接地址、认证令牌等核心参数。

4.2.2 配置文件路径

建议在 Docker 主机上创建目录（如 ./config），将 config.json 保存至该目录（路径示例：./config/config.json）。

4.3 容器部署

4.3.1 使用 docker run 部署

通过以下命令启动运行器容器，挂载本地配置文件至容器内指定路径：

bash
docker run --rm -it --name my-runner \
  -v $(pwd)/config/config.json:/etc/runner-agent.json \
  refactr/runner

参数说明：

• --rm：容器退出后自动删除
• -it：以交互模式运行，便于查看日志输出
• --name my-runner：指定容器名称为 my-runner（可自定义）
• -v $(pwd)/config/config.json:/etc/runner-agent.json：将主机上的配置文件挂载至容器内 /etc/runner-agent.json（运行器默认读取此路径的配置文件）

4.3.2 验证部署

容器启动后，若初始化成功并与 Sophos Factory 平台连接，日志将显示运行器开始轮询新的流水线任务（例如：Polling for new pipeline runs...）。

4.4 配置参数说明

运行器的核心配置通过挂载的 config.json 文件实现，具体配置项及格式需参考 Sophos Factory 运行器配置文档。容器内配置文件默认路径为 /etc/runner-agent.json，不可修改（需通过挂载覆盖此路径文件）。

5. 参考资源

• 完整自托管运行器文档
• https://github.com/sophos-factory/runner-utils