-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Explain how to setup a new runner for the project
- Loading branch information
Showing
1 changed file
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
This explains how to install a cardano runner for the Hydra project. | ||
|
||
This runner is used by our smoke-tests and allows us to keep on disk | ||
an, as up to date as possible, cardano-node database. | ||
|
||
# prepare pre-requisites | ||
|
||
Install the following pre-requisites: | ||
* git | ||
|
||
For instance on Debian: | ||
```bash | ||
sudo apt install git | ||
``` | ||
|
||
Prepare the common directory for cardano database: | ||
```bash | ||
sudo mkdir -p /srv/var/cardano | ||
sudo chown "$(whoami)" /srv/var/cardano | ||
``` | ||
|
||
# Add the server as a github runner | ||
|
||
In the project settings, go to Actions/Runners and click on [New self-hosted runner](https://github.com/input-output-hk/hydra/settings/actions/runners/new) and follow the procedure. | ||
|
||
:warning: When asked, add the following label to this runner: `cardano` | ||
|
||
# Customize github runner for nix | ||
|
||
So that the jobs can find nix later, you should customize the runner settings by adding some | ||
variables to the `.env` file: | ||
|
||
```bash | ||
cat <<EOF >>$HOME/actions-runner/.env | ||
PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/usr/local/bin:/usr/bin:/bin | ||
NIX_PROFILES="/nix/var/nix/profiles/default $HOME/.nix-profile" | ||
NIX_SSL_CERT_FILE="/etc/ssl/certs/ca-certificates.crt" | ||
EOF | ||
``` | ||
|
||
# Install github runner as a systemd unit | ||
|
||
|
||
So that github runner runs as a daemon on the machine, [install it](https://docs.github.com/en/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service): | ||
|
||
|
||
```bash | ||
sudo ./svc.sh install | ||
``` | ||
|
||
You can now start the service: | ||
|
||
```bash | ||
sudo ./svc.sh start | ||
``` |