Skip to content

Deployment

All components are deployed to ZAD (RIG/Quattro/rijksapps) via GitHub Actions. Docker images are pushed to GitHub Container Registry (GHCR).

How deployment works

On pull request

When a PR is opened or updated:

  1. Changed components are detected automatically
  2. Docker images are built and pushed to ghcr.io/minbzk/regelrecht-{component}:sha-{commit}
  3. A preview deployment named pr{N} is created on ZAD
  4. The PR gets a comment with preview URLs

Only changed components are rebuilt. The editor is always built (it is the primary interface).

On merge to main

When a PR merges to main, production deployment runs:

  1. All changed components are rebuilt with the merge commit SHA
  2. Components are deployed to the regelrecht deployment on ZAD
  3. Production URLs update within minutes

On PR close

The preview deployment and its GHCR images are cleaned up automatically.

Deployed components

ComponentImageProduction URL
Editorregelrecht-editoreditor.regelrecht.rijks.app
Adminregelrecht-adminharvester-admin.regelrecht.rijks.app
Harvester Workerregelrecht-harvester-worker(no web UI)
Enrich Workerregelrecht-enrich-worker(no web UI)
Lawmakingregelrecht-lawmakinglawmaking.regelrecht.rijks.app
Landingregelrecht-landingregelrecht.rijks.app
Docsregelrecht-docsdocs.regelrecht.rijks.app
Grafanaregelrecht-grafanagrafana.regelrecht.rijks.app

ZAD CLI

Use zad-cli to manage deployments directly:

bash
# Install
uv tool install git+https://github.com/RijksICTGilde/zad-cli.git

# List deployments
zad deployment list

# Get logs
zad logs --deployment regelrecht --lines 50

# Add a new component
zad component add landing \
    --image ghcr.io/minbzk/regelrecht-landing:latest \
    --deployment regelrecht \
    --port 8000 \
    --service publish-on-web

Configure ZAD_API_KEY and ZAD_PROJECT_ID in .env.

Required secrets

  • RIG_API_KEY - API key for ZAD Operations Manager (configured in GitHub repository secrets)
  • GITHUB_TOKEN - used for GHCR image pushes (provided automatically by GitHub Actions)

Further reading

  • CI/CD Pipeline - the continuous integration checks that run before deployment
  • Contributing - the PR workflow that triggers deployment