michaelcoll/github-runner

GitHub自托管Runner Docker镜像与Kubernetes配置

镜像概述和主要用途

本镜像用于运行自托管GitHub runner，包含构建镜像的Dockerfile和部署到Kubernetes集群的示例配置文件。您可以自行构建镜像，或直接使用https://hub.docker.com/repository/docker/sanderknape/github-runner/general%E4%B8%8A%E7%9A%84%E7%8E%B0%E6%88%90%E9%95%9C%E5%83%8F%E3%80%82

核心功能和特性

• 支持组织级runner部署
• 可配置runner标签
• 支持优雅关闭

使用场景和适用范围

适用于需要自托管GitHub Actions runner的组织，尤其是希望将runner部署到容器环境或Kubernetes集群的场景，可满足自定义runner配置和资源管理需求。

使用方法和配置说明

构建容器镜像

bash
docker build -t github-runner .

部署到Kubernetes

1. 在组织设置中获取runner令牌：组织设置 -> Actions -> 添加runner
2. 修改deployment.yml文件，配置仓库目标和组织令牌：

yaml
data:
    # 令牌的Base64编码值
    TOKEN: <Base64编码的令牌>
[...]
env:
    - name: ORG_NAME
      value: <您的组织名称>

3. 创建部署：

bash
kubectl apply -f deployment.yml

Docker运行示例

创建组织级runner

bash
docker run --name github-runner \
    -e ORG_NAME=organization \
    -e TOKEN=[令牌] \
    michaelcoll/github-runner:latest

为runner设置标签

bash
docker run --name github-runner \
    -e ORG_NAME=organization \
    -e TOKEN=[令牌] \
    -e RUNNER_LABELS=comma,separated,labels \
    michaelcoll/github-runner:latest

环境变量说明

• ORG_NAME: 组织名称（必填）
• TOKEN: 从GitHub获取的runner注册令牌（必填）
• RUNNER_LABELS: 逗号分隔的runner标签（可选）