导读：GitHub Actions 是一项为快速建立持续集成和交付（CI/CD）工作流程而提供的服务。

本文字数：6029，阅读时长大约： 6分钟

https://linux.cn/article-13846-1.html
作者：Clément Verna
译者：Xingyu.Wang

docs.github.com 是一项为快速建立持续集成和交付（CI/CD）工作流程而提供的服务。这些工作流程在被称为“运行器(runner)”的主机上运行。GitHub 提供的 docs.github.com 的操作系统的选择是有限的（Windows Server、Ubuntu、MacOS）。

另一个选择是使用 docs.github.com 的运行器，这让仓库管理员对运行器有更多控制。自托管的运行程序是专门为某个存储库或组织服务的。下面的文章介绍了使用 Fedora CoreOS 配置自托管运行程序的步骤。

入门

Fedora CoreOS 是一个精简的操作系统，旨在便于大规模的部署和维护。该操作系统会自动更新，并默认提供运行容器所需的工具。由于这些原因，Fedora CoreOS 是运行 CI/CD 工作流程的一个极佳选择。

配置和配备 Fedora CoreOS 机器的第一步是生成一个 github.com 文件。 github.com 允许你使用更友好的格式（YAML）生成 Ignition 文件。

配置一个 Fedora CoreOS 运行器

要在 Fedora CoreOS 上执行 GitHub Actions，托管主机需要用于注册和运行该运行器的二进制文件和脚本。从 github.com 下载二进制文件和脚本，并部署在 /usr/local/sbin/actions-runner 下。

  1. version: "1.3.0"

  2. variant: fcos

  3. storage:

  4. directories:

  5. - path: /usr/local/sbin/actions-runner

  6. mode: 0755

  7. user:

  8. name: core

  9. group:

  10. name: core

  11. files:

  12. - path: /usr/local/sbin/actions-runner/actions-runner-linux.tar.gz

  13. overwrite: true

  14. contents:

  15. source: https://github.com/actions/runner/releases/download/v2.278.0/actions-runner-linux-x64-2.278.0.tar.gz

  16. mode: 0755

  17. user:

  18. name: core

  19. group:

  20. name: core

注册和删除令牌

为一个项目配置运行器需要一个“令牌(token)”。这可以防止在没有正确权限的情况下从项目中注册或删除自托管的运行器。GitHub 提供的令牌有一个小时的过期时间。如果运行器在这个时间之后重新启动，它将需要一个新的注册令牌。

该令牌可能出问题，特别是在 Fedora CoreOS 自动更新时。更新过程希望托管主机在收到新数据后至少每隔几周重启一次。

幸运的是，可以使用 GitHub REST API 来获取这些令牌，并在托管主机每次重启时自动配置运行器。下面的 manage-runner.sh 脚本使用 API 来获取令牌，删除任何已经配置好的运行器，并用新的令牌注册运行器。

  1. #!/bin/bash

  2. # Handles the Github Action runner configuration.

  3. # Remove and Registration token expires after 1 hour, if we want our runner

  4. # to work after a reboot (auto update) we need to refresh the tokens.

  6. # First remove the runner with a fresh remove token

  7. REMOVE_TOKEN=$(curl -u ${GITHUB_USER}:${GITHUB_TOKEN} -X POST -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/${GITHUB_USER}/${GITHUB_REPO}/actions/runners/remove-token | jq -r '.token')

  8. /usr/local/sbin/actions-runner/config.sh remove --token ${REMOVE_TOKEN}

  11. # Then register the runner with a fresh registration token

  12. REGISTRATION_TOKEN=$(curl -u ${GITHUB_USER}:${GITHUB_TOKEN} -X POST -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/${GITHUB_USER}/${GITHUB_REPO}/actions/runners/registration-token | jq -r '.token')

  13. /usr/local/sbin/actions-runner/config.sh --url https://github.com/cverna/fcos-actions-runner --token ${REGISTRATION_TOKEN} --labels fcos --unattended

上面的脚本使用了一些环境变量，包含 GitHub 用户名和用于验证 REST API 请求的 docs.github.com(Personal Access Token)。个人访问令牌需要存储库权限，以便成功检索运行器的注册和移除令牌。该令牌是安全敏感信息，所以最好将其存储在一个具有更严格权限的不同文件中。在这个例子中，这个文件是 actions-runner。

  1. GITHUB_USER=

  2. GITHUB_REPO=

  3. GITHUB_TOKEN=

以下是创建这两个文件 manage-runner.sh 和 actions-runner 的 Butane 片段。

  1. - path: /usr/local/sbin/actions-runner/manage-runner.sh

  2. contents:

  3. local: manage-runner.sh

  4. mode: 0755

  5. user:

  6. name: core

  7. group:

  8. name: core

  9. - path: /etc/actions-runner

  10. contents:

  11. local: actions-runner

  12. mode: 0700

  13. user:

  14. name: core

  15. group:

  16. name: core

在 Fedora CoreOS 上运行 Actions

最后，创建用于配置和启动运行器的 systemd 服务。在 Butane 配置文件中定义这些服务。

  1. systemd:

  2. units:

  3. - name: github-runner-configure.service

  4. enabled: true

  5. contents: |

  6. [Unit]

  7. Description=Configure the github action runner for a repository

  8. After=network-online.target boot-complete.target

  9. Requires=boot-complete.target

  10. [Service]

  11. EnvironmentFile=/etc/actions-runner

  12. Type=oneshot

  13. RemainAfterExit=yes

  14. User=core

  15. WorkingDirectory=/usr/local/sbin/actions-runner

  16. ExecStartPre=tar xvf actions-runner-linux.tar.gz --no-same-owner

  17. ExecStart=/usr/local/sbin/actions-runner/manage-runner.sh

  18. [Install]

  19. WantedBy=multi-user.target

  20. - name: github-runner.service

  21. enabled: true

  22. contents: |

  23. [Unit]

  24. Description=Run the github action runner

  25. After=github-runner-configure.service

  26. [Service]

  27. WorkingDirectory=/usr/local/sbin/actions-runner

  28. User=core

  29. ExecStart=/usr/local/sbin/actions-runner/run.sh

  30. [Install]

  31. WantedBy=multi-user.target

这将创建两个服务：github-runner-configure.service（在主机启动完成后运行一次）和 github-runner.service（运行 Actions 运行器二进制文件并等待新的 CI/CD 作业）。

现在 Butane 配置已经完成，从中生成一个 Ignition 文件并配备一个 Fedora CoreOS Actions 运行器。

  1. $ podman run -i --rm -v $PWD:/code:z --workdir /code quay.io/coreos/butane:release --pretty --strict --files-dir /code config.yaml -o config.ignition

一旦 Ignition 文件生成，它就可以用来在 docs.fedoraproject.org Fedora CoreOS 的平台上配备一个运行器。

配置一个 Action 来使用一个自托管的运行器

下面的测试 Action 工作流程将测试 FCOS 的自托管的运行器。在你的 git 存储库中创建以下文件 .github/workflows/main.yml。

  1. # This is a basic workflow to help you get started with Actions

  3. name: CI

  5. # Controls when the action will run.

  6. on:

  7. # Triggers the workflow on push or pull request events but only for the main branch

  8. push:

  9. branches: [ main ]

  10. pull_request:

  11. branches: [ main ]

  13. # Allows you to run this workflow manually from the Actions tab

  14. workflow_dispatch:

  16. # A workflow run is made up of one or more jobs that can run sequentially or in parallel

  17. jobs:

  18. # This workflow contains a single job called "build"

  19. build:

  20. # The type of runner that the job will run on

  21. runs-on: fcos

  23. # Steps represent a sequence of tasks that will be executed as part of the job

  24. steps:

  25. # Runs a single command using the runners shell

  26. - name: Run a one-line script

  27. run: podman run --rm fedora-minimal:34 echo Hello World !

请注意，runs-on 的配置被设置为使用标签为 fcos 的运行器。

本文介绍的代码可以在 github.com 中找到。

via:

作者： 选题： 译者： 校对：

本文由 原创编译， 荣誉推出

欢迎遵照 CC-BY-NC-SA 协议规定转载，

如需转载，请在文章下留言 “ 转载：公众号名称”，

我们将为您添加白名单，授权“ 转载文章时可以修改”。