Actions Runner Controller 项目安装与使用教程

Actions Runner Controller 项目安装与使用教程

actions-runner-controller Kubernetes controller for GitHub Actions self-hosted runners 项目地址: https://gitcode.com/gh_mirrors/ac/actions-runner-controller

1. 项目的目录结构及介绍

actions-runner-controller 项目是一个开源项目，用于管理 GitHub Actions 的自托管运行器。以下是项目的目录结构及其简要介绍：

actions-runner-controller/
├── charts/           # 存放 Helm 图表文件
├── contrib/          # 贡献者相关的文档和示例代码
├── docs/             # 项目文档
├── images/           # 存储项目的 Docker 镜像文件
├── pkg/              # 包含项目的核心代码和库
├── scripts/          # 包含各种脚本，如构建、测试和部署脚本
├── test/             # 测试代码和测试数据
├── tools/            # 辅助工具，如代码生成器
├──Makefile           # Makefile 文件，用于构建项目
└──main.go            # 主程序入口文件

2. 项目的启动文件介绍

项目的启动文件是 main.go。该文件定义了应用程序的入口点，并负责初始化和启动服务。以下是 main.go 文件的关键部分：

package main

import (
    "fmt"
    "os"
    "github.com/actions/actions-runner-controller/pkg/controller"
)

func main() {
    // 初始化控制器
    c, err := controller.New()
    if err != nil {
        fmt.Fprintf(os.Stderr, "failed to create controller: %v\n", err)
        os.Exit(1)
    }

    // 启动控制器
    if err := c.Start(); err != nil {
        fmt.Fprintf(os.Stderr, "failed to start controller: %v\n", err)
        os.Exit(1)
    }
}

在这个文件中，首先引入必要的包，然后定义 main 函数。在 main 函数中，创建一个新的控制器实例，并启动该控制器。

3. 项目的配置文件介绍

项目的配置文件位于项目根目录下的 config 文件夹中。主要的配置文件是 config.yaml，该文件用于定义项目的配置信息。以下是一个示例配置文件的内容：

controller:
  # 控制器服务的地址
  address: 0.0.0.0:8080
  # GitHub Actions 的工作流程文件路径
  workflows: workflows/
  # GitHub Actions 运行器的配置文件路径
  runners: runners/
  # GitHub Actions 令牌
  github_token: your_github_token
  # GitHub Actions 组织或仓库
  org: your_github_org
  # GitHub Actions 仓库的所有运行器是否可用
  all_runners: true
  # 日志级别
  log_level: info

在 config.yaml 文件中，可以配置控制器的基本设置，如服务地址、工作流程文件路径、运行器配置文件路径、GitHub 令牌、组织或仓库信息等。这些配置信息将影响控制器的行为和功能。

通过以上介绍，您应该能够对 actions-runner-controller 项目的目录结构、启动文件和配置文件有一个基本的了解。

actions-runner-controller Kubernetes controller for GitHub Actions self-hosted runners 项目地址: https://gitcode.com/gh_mirrors/ac/actions-runner-controller