关于自动缩放
您可以根据接收到的带有特定标签的 Webhook 事件,自动增加或减少环境中自托管运行器的数量。例如,您可以创建自动化操作,以便每次收到带有workflow_job
Webhook 事件和queued
活动(通知您有新作业准备处理)时,都添加一个新的自托管运行器。Webhook 负载包含标签数据,因此您可以识别作业请求的运行器类型。作业完成后,您可以创建自动化操作,根据workflow_job
completed
活动删除运行器。
支持的自动缩放解决方案
GitHub 托管运行器会根据您的需求固有地进行自动缩放。GitHub 托管运行器可以作为开发或实现自动缩放解决方案的低维护成本且经济高效的替代方案。更多信息,请参阅“关于 GitHub 托管运行器”。
actions/actions-runner-controller (ARC) 项目是一个基于 Kubernetes 的运行器自动缩放器。如果部署它的团队拥有专业的 Kubernetes 知识和经验,GitHub 建议使用 ARC。
更多信息,请参阅“关于 Actions Runner Controller”和“关于 Actions Runner Controller 的支持”。
使用临时运行器进行自动缩放
GitHub 建议使用临时自托管运行器实现自动缩放;不建议使用持久性自托管运行器进行自动缩放。在某些情况下,GitHub 无法保证在持久性运行器关闭时不会向其分配作业。使用临时运行器,可以保证这一点,因为 GitHub 只会将一个作业分配给一个运行器。
这种方法允许您将运行器管理为临时系统,因为您可以使用自动化操作为每个作业提供干净的环境。这有助于限制任何敏感资源从先前作业中暴露的风险,也有助于降低受感染的运行器接收新作业的风险。
警告
为了进行故障排除和诊断,必须将临时运行器的运行器应用程序日志文件转发到外部日志存储解决方案。虽然不需要部署临时运行器,但在生产环境中部署临时运行器自动缩放解决方案之前,GitHub 建议确保外部转发和保留运行器日志。更多信息,请参阅“监视和故障排除自托管运行器”。
要将临时运行器添加到您的环境,请在使用config.sh
注册运行器时包含--ephemeral
参数。例如
./config.sh --url https://github.com/octo-org --token example-token --ephemeral
处理一个作业后,GitHub Actions 服务将自动注销运行器。然后,您可以创建自己的自动化操作,在运行器注销后将其清除。
注意
如果作业标有某种类型的运行器,但没有匹配该类型的运行器可用,则作业在排队时不会立即失败。相反,作业将保持排队状态,直到 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
存储库中版本的通知。更多信息,请参阅“配置通知”。
有关如何安装最新运行器版本的说明,请参阅最新版本的安装说明。
警告
所有发布的软件更新(包括主要、次要或修补程序版本)都被视为可用更新。如果您未在 30 天内执行软件更新,GitHub Actions 服务将不会将作业排队到您的运行器。此外,如果需要关键的安全更新,则在更新之前,GitHub Actions 服务将不会将作业排队到您的运行器。
使用 Webhook 进行自动缩放
您可以通过使用从workflow_job
Webhook 收到的负载来创建您自己的自动缩放环境。此 Webhook 在存储库、组织和企业级别可用,此事件的负载包含一个action
键,该键对应于工作流作业生命周期的阶段;例如,作业处于queued
、in_progress
和completed
状态时。然后,您必须根据这些 Webhook 负载创建您自己的缩放自动化。
- 有关
workflow_job
Webhook 的更多信息,请参阅“Webhook 事件和负载”。 - 要了解如何使用 Webhook,请参阅“Webhook 文档”。
身份验证要求
您可以使用API注册和删除存储库和组织自托管运行器。要对 API 进行身份验证,您的自动缩放实现可以使用访问令牌或 GitHub 应用。
您的访问令牌需要以下范围
- 对于私有存储库,请使用具有
repo
范围的访问令牌。 - 对于公共存储库,请使用具有
public_repo
范围的访问令牌。 - 对于组织,请使用具有
admin:org
范围的访问令牌。
要使用 GitHub 应用进行身份验证,必须为其分配以下权限
- 对于存储库,请分配
administration
权限。 - 对于组织,请分配
organization_self_hosted_runners
权限。
您可以使用API注册和删除企业自托管运行器。要对 API 进行身份验证,您的自动缩放实现可以使用访问令牌。
您的访问令牌需要manage_runners:enterprise
范围。