Hydra 项目技术文档

1. 安装指南

1.1 系统要求

Hydra 目前仅支持在 NixOS 上运行。请确保您的系统是 NixOS，并且已经安装了 Nix 包管理器。

1.2 启用服务

在 NixOS 上启用 Hydra 服务非常简单。您可以通过以下配置来设置一个简单的本地安装：

{
  services.hydra = {
    enable = true;
    hydraURL = "http://localhost:3000";
    notificationSender = "hydra@localhost";
    buildMachinesFiles = [];
    useSubstitutes = true;
  };
}

将上述配置添加到您的 NixOS 配置文件中，然后重新启动系统以应用更改。

1.3 创建管理员用户

在服务启动后，您需要创建一个管理员用户。使用以下命令创建管理员用户：

$ su - hydra
$ hydra-create-user <USER> --full-name '<NAME>' \
    --email-address '<EMAIL>' --password-prompt --role admin

创建完成后，您可以使用该用户登录 Hydra 的 Web 界面。

2. 项目的使用说明

2.1 创建项目和作业集

登录 Hydra 的 Web 界面后，您可以创建项目和作业集。以下是创建一个简单项目的步骤：

2.1.1 创建项目

1. 登录后，点击 "Admin" 并选择 "Create project"。
2. 填写表单：
   • Identifier: hello-project
   • Display name: hello
   • Description: hello project
3. 点击 "Create project"。

2.1.2 创建作业集

1. 在项目页面，点击 "Actions" 并选择 "Create jobset"。
2. 将 Type 更改为 Legacy。
3. 填写表单：
   • Identifier: hello-project
   • Nix expression: examples/hello.nix in hydra
   • Check interval: 60
   • Scheduling shares: 1
4. 添加两个输入：
   • Input name: nixpkgs
     • Type: Git checkout
     • Value: https://github.com/NixOS/nixpkgs nixos-24.05
   • Input name: hydra
     • Type: Git checkout
     • Value: https://github.com/nixos/hydra
5. 确保 State 设置为 "Enabled"，然后点击 "Create jobset"。

2.2 构建和开发

2.2.1 构建 Hydra

您可以使用 nix-build 命令来构建 Hydra：

$ nix-build

2.2.2 开发环境

使用提供的 shell.nix 文件来设置开发环境：

$ nix-shell
$ autoreconfPhase
$ configurePhase # 注意：不是 ./configure
$ make

2.2.3 开发过程中运行 Hydra

在开发过程中，您可以使用 foreman 来运行 Hydra：

$ nix-shell
$ # 进行代码修改
$ make
$ foreman start

3. 项目API使用文档

Hydra 提供了一个 JSON API，您可以通过该 API 与 Hydra 进行交互。API 的定义在 hydra-api.yaml 文件中。您可以使用 swagger editor 来测试和探索 API。

4. 项目安装方式

Hydra 的安装方式主要依赖于 NixOS 的模块化配置。您可以通过在 NixOS 配置文件中添加 services.hydra 模块来启用 Hydra 服务。具体的配置示例如下：

{
  services.hydra = {
    enable = true;
    hydraURL = "http://localhost:3000";
    notificationSender = "hydra@localhost";
    buildMachinesFiles = [];
    useSubstitutes = true;
  };
}

将上述配置添加到您的 NixOS 配置文件中，然后重新启动系统以应用更改。