使用自托管运行器自动缩放

您可以自动扩展自托管运行器以响应 web 挂钩事件。

本文内容

Note

GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。 可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。

关于自动缩放

您可以自动增加或减少环境中自托管运行器的数量，以响应您收到的带特定标签的 web 挂钩事件。 例如，可创建自动化，在每次收到带有 queued 活动的 workflow_job webhook 事件时添加一个新的自托管运行器，通知你有一个新的作业已准备好进行处理。 Web 挂钩有效负载包含标签数据，因此您可以识别作业请求的运行器类型。 作业完成后，可创建自动化，以响应 workflow_job completed 活动删除运行器。

支持的自动缩放解决方案

actions/actions-runner-controller (ARC) 项目是基于 Kubernetes 的运行器自动缩放程序。 GitHub 如果部署 ARC 的团队具有专业的 Kubernetes 知识和经验，则建议使用 ARC。

有关详细信息，请参阅 关于 Actions Runner Controller 和 关于对 Actions Runner Controller 的支持。

使用临时运行器进行自动缩放

GitHub 建议使用临时的自托管运行器实现自动缩放；不建议使用持久的自托管运行器进行自动缩放。 在某些情况下， GitHub 无法保证作业在关闭时不会分配给持久性运行器。 对于临时运行器，这可以得到保证，因为 GitHub 只将一个作业分配给运行器。

这种方法允许您将运行器作为临时系统进行管理，因为您可以使用自动化为每个作业提供干净的环境。 这有助于限制以前工作中任何敏感资源的暴露，也有助于降低受损运行器获得新作业的风险。

Warning

临时运行器的运行器应用程序日志文件必须转发到外部日志存储解决方案，以便进行故障排除和诊断。 虽然不需要部署临时运行器，但 GitHub 建议在生产环境中部署临时运行器自动缩放解决方案之前，确保在外部转发和保留运行器日志。 有关详细信息，请参阅“对自托管运行程序进行监视和故障排除”。

要将临时运行器添加到环境，请在使用 config.sh 注册运行器时包含 --ephemeral 参数。 例如：

./config.sh --url https://github.com/octo-org --token example-token --ephemeral

然后，GitHub Actions 服务将在处理完一个作业后自动取消注册运行器。 然后，您可以创建自己的自动化，在取消注册后擦除运行器。

Note

如果作业被标记为需要某种类型的运行器，但没有与之匹配的运行器，则作业在排队时不会立即失败。 相反，作业将保持排队状态，直到 24 小时超时期限到期。

或者，可以使用 REST API 创建临时的实时运行器。 有关详细信息，请参阅“自托管运行器的 REST API 终结点”。

控制自托管运行器上的运行器软件更新

默认情况下，每当有新版本的运行器软件可用时，自托管运行器将自动执行软件更新。 如果在容器中使用临时运行器，则当发布新的运行器版本时，这可能会导致重复的软件更新。 关闭自动更新允许你按照自己的计划直接更新容器映像上的运行器版本。

要关闭自动软件更新并自行安装软件更新，请在使用 config.sh 注册运行器时指定 --disableupdate 标志。 例如：

./config.sh --url https://github.com/YOUR-ORGANIZATION --token EXAMPLE-TOKEN --disableupdate

如果禁用自动更新，您仍必须定期更新运行器版本。 GitHub Actions 中的新功能需要同时更改 GitHub Actions 服务和运行器软件。 在没有软件更新的情况下，运行器可能无法正确处理利用 GitHub Actions 新功能的作业。

如果禁用自动更新，则需要在新版本可用后的 30 天内更新运行器版本。 你可能想要订阅actions/runner存储库中关于版本的通知。 有关详细信息，请参阅“配置通知”。

若要了解如何安装最新的运行器版本，请参阅最新版本的安装说明。

Warning

为软件发布的任何更新（包括主要版本、次要版本或修补程序版本）都被视为可用更新。 注意：如果未在 30 天内执行软件更新，GitHub Actions 服务将不会将工作排队到运行器。 此外，如果需要关键安全更新，GitHub Actions 服务在更新之前不会将作业排队到运行器。

使用 web 挂钩进行自动缩放

可使用从 workflow_job Webhook 接收的有效负载自行创建自动缩放环境。 此 Webhook 在存储库、组织和企业级别可用，并且此事件的有效负载包含一个 action 键，该键对应于工作流作业生命周期的各个阶段；例如，当作业是 queued、in_progress 和 completed 时。 然后，您必须创建自己的缩放自动化以响应这些 web 挂钩有效负载。

身份验证要求

可使用 API 注册和删除存储库和组织自托管运行器。 若要向 API 进行身份验证，自动缩放实现可以使用访问令牌或 GitHub 应用。

访问令牌将需要以下作用域：

要使用 GitHub 应用进行身份验证，必须为其分配以下权限：

  • 对于存储库，请分配 administration 权限。
  • 对于组织，请分配 organization_self_hosted_runners 权限。

可使用 API 注册和删除企业自托管运行器。 要向 API 进行身份验证，自动缩放实现可以使用访问令牌。

访问令牌将需要 manage_runners:enterprise 范围。