|
||
---|---|---|
.github/workflows | ||
datadog | ||
doc | ||
examples | ||
scripts | ||
src | ||
tests | ||
.gitignore | ||
bootstrap | ||
configure.ac | ||
COPYING | ||
default.nix | ||
flake.lock | ||
flake.nix | ||
hydra-api.yaml | ||
hydra-module.nix | ||
INSTALL | ||
Makefile.am | ||
Procfile | ||
README.md | ||
run-hydra.nix | ||
shell.nix | ||
version |
Hydra
Hydra is a Continuous Integration service for Nix based projects.
Installation And Setup
Note: The instructions provided below are intended to enable new users to get a simple, local installation up and running. They are by no means sufficient for running a production server, let alone a public instance.
Enabling The Service
Running Hydra is currently only supported on NixOS. The hydra module allows for an easy setup. The following configuration can be used for a simple setup that performs all builds on localhost (Please refer to the Options page for all available options):
{
services.hydra = {
enable = true;
hydraURL = "http://localhost:3000";
notificationSender = "hydra@localhost";
buildMachinesFiles = [];
useSubstitutes = true;
};
}
Creating An Admin User
Once the Hydra service has been configured as above and activate you should already be able to access the UI interface at the specified URL. However some actions require an admin user which has to be created first:
$ su - hydra
$ hydra-create-user <USER> --full-name '<NAME>' \
--email-address '<EMAIL>' --password <PASSWORD> --role admin
Afterwards you should be able to log by clicking on "Sign In" on the top right of the web interface using the credentials specified by hydra-crate-user
. Once you are logged in you can click "Admin -> Create Project" to configure your first project.
Creating A Simple Project And Jobset
In order to evaluate and build anything you need to crate projects that contain jobsets. Hydra supports imperative and declarative projects and many different configurations. The steps below will guide you through the required steps to creating a minimal imperative project configuration.
Creating A Project
Log in as adminstrator, click "Admin" and select "Create project". Fill the form as follows:
- Identifier:
hello
- Display name:
hello
- Description:
hello project
Click "Create project".
Creating A Jobset
After creating a project you are forwarded to the project page. Click "Actions" and choose "Create jobset". Fill the form with the following values:
- Identifier:
hello
- Nix expression:
examples/hello.nix
inhydra
- Check interval: 60
- Scheduling shares: 1
We have to add two inputs for this jobset. One for nixpkgs and one for hydra (which we are referrencing in the Nix expression above):
-
Input name:
nixpkgs
-
Type:
Git checkout
-
Value:
https://github.com/nixos/nixpkgs-channels nixos-20.03
-
Input name:
hydra
-
Type:
Git checkout
-
Value:
https://github.com/nixos/hydra
Make sure State at the top of the page is set to "Enabled" and click on "Create jobset". This concludes the creation of a jobset that evaluates ./examples/hello.nix once a minute. Clicking "Evaluations" should list the first evaluation of the newly created jobset after a brief delay.
Building And Developing
Building Hydra
You can build Hydra via nix-build
using the provided default.nix:
$ nix-build
Development Environment
You can use the provided shell.nix to get a working development environment:
$ nix-shell
$ ./bootstrap
$ configurePhase # NOTE: not ./configure
$ make
Development Workflow
When working on new features or bug fixes you want to be able to run Hydra from your working copy. There are two ways to do this. One is better for interactive development and provides faster feedback cycles, the other is more convenient for a single test run of Hydra from the working copy (suiteable for PR reviews).
Using runHydra
Hydra can be built and executed using the runHydra
shell:
$ nix-shell default.nix -A runHydra
This will spawn a shell that starts hydra-server, hydra-queue-runner, hydra-evaluator and postgres using foreman. In order to not collide with potentially existing installations running on default ports hydra and postgres are running on custom ports:
- hydra-server: 63333
- postgresql: 64444
Note: In some cases you may want to skip test execution. You can do so by passing doCheck false
:
$ nix-shell default.nix -A runHydra --arg doCheck false
Using foreman
When you are actively working on the code, you need fast feedback cycles and thus want incremental builds. Instead of using
runHydra
you can just run foreman start
directly in the normal nix-shell
environment:
$ nix-shell
$ # hack hack
$ make
$ foreman start
JSON API
You can also interface with Hydra through a JSON API. The API is defined in hydra-api.yaml and you can test and explore via the swagger editor
Additional Resources
- Hydra User's Guide
- Hydra on the NixOS Wiki
- hydra-cli
- Peter Simons - Hydra: Setting up your own build farm (NixOS)
License
Hydra is licensed under GPL-3.0
Icons provided free by EmojiOne.