Rookrunner

Install / v0.1.10

Install the preview.

The v0.1.10 release includes a pure-Python wheel and source distribution. Rookrunner requires Python 3.11 or newer and PyYAML 6.0.3; installing the wheel resolves that dependency.

Download and verify

Download the files from the v0.1.10 preview release. The release includes the following SHA-256 checksums:

FileSHA-256
execution_core-0.1.10-py3-none-any.whl8e46025f7c6dc192f2b10eadc1e879b0238a71bca0a8a8f3f4c5bf23400faf1b
execution_core-0.1.10.tar.gz0e1cd93ec8ca1ba1a61545928a4653ca1729d5d6672b6f72ed28b6d1ce4df523

On Linux, verify a downloaded file with sha256sum -c SHA256SUMS. On macOS, use shasum -a 256 -c SHA256SUMS. Keep the downloaded artifact and SHA256SUMS in the same directory.

Install the Python package

Install the wheel into a new virtual environment:

uv venv
uv pip install https://github.com/moonbase2090/rookrunner/releases/download/v0.1.10/execution_core-0.1.10-py3-none-any.whl
.venv/bin/python -m execution_core --help

With pip, create the environment with python3 -m venv .venv and install the same wheel URL with .venv/bin/pip. In PowerShell, use .venv\Scripts\python -m execution_core --help. The source distribution can also be installed with pip install using its release URL.

Linux worker The worker executes jobs in Docker containers. Use a Linux host with Docker Engine for workflow execution. The CLI package can be installed elsewhere for local inspection, but the worker runtime is designed for Linux.

Prepare a Linux worker

Choose a dedicated service account and directories writable only by that account for state and the repository clone. The state directory is created with mode 0700; the worker socket uses mode 0600.

Install the wheel in a virtual environment for the service account, then create a dedicated clone:

sudo install -d -o "$USER" -g "$USER" -m 0755 /srv/rookrunner /srv/rookrunner/clone
sudo install -d -o "$USER" -g "$USER" -m 0700 /srv/rookrunner/state
python3 -m venv /srv/rookrunner/venv
/srv/rookrunner/venv/bin/python -m pip install https://github.com/moonbase2090/rookrunner/releases/download/v0.1.10/execution_core-0.1.10-py3-none-any.whl
git clone https://github.com/OWNER/REPOSITORY.git /srv/rookrunner/clone

Replace OWNER/REPOSITORY with the repository to run. Keep credentials out of the clone URL. The release repository includes a hardened systemd user-unit template for a source-tree install. Its Python path and directories assume that layout. For a wheel install, point the unit at the virtual environment instead:

[Service]
Type=simple
ExecStart=/srv/rookrunner/venv/bin/python -m execution_core --state /srv/rookrunner/state worker --repository /srv/rookrunner/clone
Restart=always
NoNewPrivileges=yes
PrivateTmp=yes
ProtectSystem=strict
ProtectHome=yes
ReadWritePaths=/srv/rookrunner/state /srv/rookrunner/clone
UMask=0077

The worker defaults to --network none. If workflows need network access, add --network bridge to the worker command. The template does not set an image digest, secret option, application key, Docker socket, or listening port. Add --runner-image only after building and pinning an image for jobs that use runs-on: ubuntu-latest.

Start the service

Copy the adapted unit into the service account's user-unit directory, then enable it with systemctl --user enable --now rookrunner-worker.service. If it must keep running after that account logs out, an administrator can enable user lingering with sudo loginctl enable-linger "$USER".

Return to the overview for the release scope and current preview status.