View source for Hydra/de

<languages />
Hydra ist ein Werkzeug für kontinuierliche Integrationstests und Softwarefreigabe, das eine rein funktionale Sprache zur Beschreibung von Build-Jobs und deren Abhängigkeiten verwendet. Kontinuierliche Integration ist eine einfache Technik zur Verbesserung der Qualität des Softwareentwicklungsprozesses. Ein automatisiertes System prüft kontinuierlich oder periodisch den Quellcode eines Projekts, baut ihn, führt Tests durch und erstellt Berichte für die Entwickler. Auf diese Weise werden verschiedene Fehler, die versehentlich in die Codebasis aufgenommen werden könnten, automatisch erkannt.

Die offiziellen Hydra-Server bieten vorgefertigte Binärpakete an, um die Aktualisierungszeit für Nixpgs zu verkürzen: Die Benutzer müssen sie nicht auf ihren eigenen Computern kompilieren.

Das [https://nixos.org/hydra/manual/ Hydra Handbuch] bietet eine Übersicht der Funktionalität und Funktionen von Hydra sowohl als auch eine aktuelle Installationsanleitung. 

<div lang="en" dir="ltr" class="mw-content-ltr">
== Installation ==
</div>

Eine vollständige Installation kann wie folgt konfiguriert werden:

<syntaxHighlight lang=nix>
  services.hydra = {
    enable = true;
    hydraURL = "http://localhost:3000"; # externally visible URL
    notificationSender = "hydra@localhost"; # e-mail of Hydra service
    # a standalone Hydra will require you to unset the buildMachinesFiles list to avoid using a nonexistant /etc/nix/machines
    buildMachinesFiles = [];
    # you will probably also want, otherwise *everything* will be built from scratch
    useSubstitutes = true;
  };
</syntaxHighlight>

Dieses Modul aktiviert PostgreSQL automatisch,
außer die <code>services.hydra.dbi</code> wird geändert. Das Datenbanklayout wird automatisch erstellt vom Hydra-Service. Allerdings ist anzumerken, das zusätzliche Daten in der Datenbank gespeichert werden, was eine vollständige deklarative Konfiguration unmöglich macht. Daher sind Backups erforderlich.

* Siehe <code>nixos-option</code> oder die  [https://search.nixos.org/options?query=services.hydra Nixos Optionsseite] für eine Liste aller Optionen.

<span id="Web_Configuration"></span>
=== Webserverkonfiguration ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Hydra will provide the web interface [http://localhost:3000/ at localhost] port 3000. However you need to create a new admin user (as UNIX user <code>hydra</code>) before being able to perform any changes:
</div>

<syntaxHighlight lang=bash>
# su - hydra
$ hydra-create-user alice --full-name 'Alice Q. User' \
    --email-address 'alice@example.org' --password-prompt --role admin
</syntaxHighlight>

<span id="Virtual_machine"></span>
=== Virtuelle Maschinen ===

Hydra benutzt localhost als Standardbuildmaschine,
wenn nichts anderes konfiguriert ist.
Standardmäßig sind die Systemfunktionen <code>kvm> und <code>nixos-test</code> in Nix,
zum benutzen von Virtuellen Maschinen nicht aktiviert. Jobs, die dies Funktionen benötigen werden daraufhin auf unbestimmte Zeit in die Warteschlange gestellt. Die folgenden Optionen aktieren diese Systemfeature:

<syntaxHighlight lang=nix>
{
  nix.buildMachines = [
    { hostName = "localhost";
      system = "x86_64-linux";
      supportedFeatures = ["kvm" "nixos-test" "big-parallel" "benchmark"];
      maxJobs = 8;
    }
  ];
}
</syntaxHighlight>

Diese Konfiguration erzeugt die Datei
/etc/nix/machines. 
Falls die Hydra-option <code>buildMachinesFiles</code> immer noch auf eine leere Liste gesetzt ist, wird diese Einstellung ignoriert. Deswegen muss diese Option wieder entfernt werden oder <code>/etc/nix/machines</code> hinzugefügt werden.

<span id="Flake_jobset"></span>
== Flake-Jobset ==

Ein Jobset kann wie folgt konfiguriert werden.

* Type: Flake

<div lang="en" dir="ltr" class="mw-content-ltr">
* Flake URI: an URI to a repo containing a Flake like git+https://git.myserver.net/user/repo.git
</div>

Der Flake-Output sollte das Attribut <code>hydraJobs</code> enthalten. <code>hydraJobs</code> ist ein Attributset, das verschachtelt sein kann und auf Derivations verweist.

Ein Beispiel für ein Flake-Output, das Hydra veranlasst, alle Pakete zu bauen, könnte wie folgt aussehen:

<syntaxHighlight lang=nix>
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
  };
  outputs = { self, nixpkgs, ... }: {
    packages.x86_64-linux = {
      ...
    };

    hydraJobs = {
      inherit (self)
        packages;
    };
  };
}
</syntaxHighlight>

<span id="Restricted_Mode"></span>
=== Eingeschränkter Modus (Restricted mode) ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Hydra evaluates flakes in [https://nixos.org/manual/nix/stable/command-ref/conf-file.html#conf-restrict-eval restricted mode]. This prevents access to files outside of the nix store, including those fetched as flake inputs. Update your <code>nix.settings.allowed-uris</code> to include URI prefixes from which you expect flake inputs to be fetched:
</div>

<syntaxHighlight lang=nix>
nix.settings.allowed-uris = [
  "github:"
  "git+https://github.com/"
  "git+ssh://github.com/"
];
</syntaxHighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Build a single Package from nixpkgs ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Right now it is not possible to build a single package from nixpkgs with just that input. You will need to provide a supplementary repository which defines what to build. For examples you can check the [https://github.com/makefu/hydra-example hydra-example by makefu] and in the [https://nixos.org/hydra/manual/#idm140737315920320 Hydra Manual].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Imperative Building ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
These steps are required to build the <code>hello</code> package.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# log into Hydra after creating a user with <code>hydra-create-user</code>
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# create new project
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* identifier: example-hello
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* display name: example-hello
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# Actions -> Create jobset
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* identifier: hello
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* Nix expression: <code>release.nix</code> in <code>hydra-example</code> -> will evaluate the file release.nix in the given input
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* check interval: 60
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* scheduling shares: 1
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* Inputs:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{| class="wikitable"
|-
! Input Name !! Type !! Value !! Note
|-
| nixpkgs || git checkout || https://github.com/nixos/nixpkgs nixos-21.11 || will check out branch nixos-21.11, will be made available to the nix expression via <code><nixpkgs></code>.
|-
| hydra-example || git checkout || https://github.com/makefu/hydra-example || hydra-example is used by the jobset as input, <code>release.nix</code> is in the root directory
|}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
After creation, the jobset should be in the '''evaluation phase''' where inputs will be fetched. This phase may take some time as the complete <code>nixpkgs</code> repository needs to be downloaded before continuing. The result of the evaluation should be a single job which will get built.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Declarative Building ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Since 2016, Hydra supports declarative creation of jobsets. Check out the [https://github.com/shlevy/declarative-hydra-example example repository and description by Shea Levy].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Hydra Internals ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Definitions ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
This subsection provides an overview of the Hydra-specific definitions and how to configure them.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Project ====
</div> 

<div lang="en" dir="ltr" class="mw-content-ltr">
A cluster of Jobs which are all coming from a single input (like a git checkout), the first thing you will need to create. Every Job should be able to be built independently from another. Most of the time the project maps to a single repository like <code>nixpkgs</code>. It is comparable to the project definition in Jenkins.
</div>

<span id="Jobsets"></span>
==== Jobset ====

Eine Liste von Jobs, die ausgeführt werden sollen. Oft passt ein Jobset zu einem bestimmten Branch (master, staging, stable). Ein Jobset wird durch seine Eingaben definiert und wird ausgelöst, wenn sich diese Eingaben ändern, z.B. wenn ein neuer Commit zu einem Branch hinzugefügt wird. Jobsets können voneinander abhängen.

==== Job ====

Ein Closure, welches als Teil eines Jobsatzes erstellt wird (wie ein einzelnes Paket, ISO-Image oder Tarball).

==== Release Set ====

Definiert alle Jobs, die in Ihrem Release beschrieben sind. Konventionell wird eine Datei namens <code>release.nix</code> verwendet. Eine ausführliche Beschreibung der Struktur finden Sie im [https://nixos.org/hydra/manual/#idm140737315920320 Hydra Handbuch für Build Recipes].

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Evaluation ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The process of interpreting nix code into a list of <code>.drv files</code>. These files are the build recipes for all related outputs. You can introspect these files by running <code>nix show-derivation nixpkgs.hello</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Build ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Instantiation of a Job which is being triggered by being part of the release set.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Known Issues ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* hydra-queue-runner sometimes gets stuck even with builds are in the queue, and the builds are not scheduled. The issue is being tracked [https://github.com/NixOS/hydra/issues/366 here]. In the meantime, a workaround is to add a cron job that regularly restarts the hydra-queue-runner systemd service. Possible fix: [https://github.com/NixOS/hydra/commit/73ca325d1c0f7914640a63764c9a6d448fde5bd0]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* If you see <code>error: unexpected end-of-file</code> it can mean multiple things, some of them are:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# You have a miss-match between nix versions on the Hydra server and the builder
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# It can also mean that <code>hydra-queue-runner</code> needs privileges on the build server. Reference: [https://github.com/NixOS/nix/issues/2789]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* The default timeout for git operations is 600 seconds [https://github.com/NixOS/hydra/issues/1181], which might cause fetches of large repositories like [https://github.com/NixOS/nixpkgs nixos/nixpkgs] to fail: <code>error fetching latest change from git repo at `https://github.com/nixos/nixpkgs': timeout</code>. The timeout can be increased with the following configuration.nix snippet:
</div>

<syntaxHighlight lang=nix>
{
  services.hydra.extraConfig = ''
    <git-input>
      timeout = 3600
    </git-input>
  '';
}
</syntaxHighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Hydra for NixOS releases ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Hydra is used for managing official Nix project releases. The project Hydra server: https://hydra.nixos.org/
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Some Hydra trackers for Nix projects:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://hydra.nixos.org/project/nixpkgs Nixpkgs]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://hydra.nixos.org/project/nixos NixOS]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Resources ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://www.youtube.com/watch?v=RXV0Y5Bn-QQ Video: Setting up a Hydra Build Farm by Peter Simons (2016)]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://gist.github.com/joepie91/c26f01a787af87a96f967219234a8723 Hydra Caveats by Joepie91]
</div>


[[Category:Pedias]]
[[Category:Hydra]]
[[Category:Nix]]
[[Category:Incomplete]]
[[Category:Software]]
[[Category:Server]]