Apidog Runner 是一个命令行工具,用于在服务器环境中执行计划的 API 测试和自动化任务。本参考指南概述了在生产或 CI/CD 环境中部署 Runner 所需的硬件、运行时和网络要求。了解这些要求可确保在大规模运行自动化 API 测试时获得最佳性能和可靠性。硬件要求#
推荐服务器配置#
| 组件 | 最低要 求 | 推荐配置 | 用途 |
|---|
| CPU | 2 核 | 4+ 核 | Runner 并发执行计划任务,需要足够的处理能力 |
| 内存 | 4GB RAM | 8GB+ RAM | Runner 在计划任务期间会加载并生成大量数据;较大的团队需要更多内存 |
| 磁盘空间 | 30GB | 50GB+ | 用于存储日志和测试产物 |
对于较大的团队或高频率的测试执行,请将 内存增加到 8GB 或更多,以防止性能下降。
运行时参数#
| 参数名称 | 描述 | 示例值 |
|---|
TZ | 配置 Runner 执行的时区。计划任务将按照设置的时区和时间运行。请参考 TZ identifier 进行配置。 | America/Los_Angeles |
容器运行时用户和 runAsNonRoot#
从 Runner 版本 2.2.5 开始,镜像包含一个非 root 用户 runner,其固定 UID/GID 为 10001:10001,以支持更安全的非 root 运行时模式。使用默认启动方式时,容器首先以 root 身份运行 entrypoint 脚本,为 /opt/runner 目录准备权限,然后降权为 runner 用户运行主进程。这与历史卷权限兼容,并可防止日志和变量文件等运行时数据写入失败。如果部署平台强制使用 runAsNonRoot,请按如下方式配置容器安全上下文:启用后,entrypoint 脚本将无法再执行 mkdir 或 chown。因此,任何挂载到 /opt/runner 的 hostPath、PVC 或其他卷都必须提前为 UID/GID 10001 授予写入权限。Runner 会将运行时数据写入 /opt/runner/logs 和 /opt/runner/variables 等目录。如果权限不足,任务执行可能会失败,或日志可能无法写入。使用 hostPath 时,可以提前在主机上运行以下命令:如果没有强制启用 runAsNonRoot 的要求,我们建议保留默认启动方式。网络环境#
服务器通信要求#
Runner 需要与 Apidog 服务器通信。请确保执行 Runner 的服务器网络环境能够访问 Apidog 服务器,并支持 WebSocket 协议。确保你的防火墙允许通过端口 443(HTTPS)到 Apidog 服务器的出站连接,以及用于实时通信的 WebSocket 连接。
自动化测试要求#
对于自动化测试的计划任务,服务器的网络环境必须能够访问所有被请求的 URL,以便正常发起请求。运行自动化测试后,将上传测试报告——请确保服务器网络环境能够访问 AWS 域名。数据导入要求#
对于导入数据的计划任务,请确保服务器的网络环境 能够访问要导入的数据源 URL。