finwo/conductor repository overview

⁠conductor

A small CI server. Accepts triggers, schedules jobs, serves the worker API and renders the interface. One service, one image.

Source and issues: https://github.com/finwo/conductor⁠

⁠Tags

Built for linux/amd64, linux/arm64 and linux/riscv64.

Upgrade the conductor and its workers together. In 0.3.0 a job became one run of a pipeline and a task became the unit a worker runs. Workers claim from /api/v1/tasks/claim, so a 0.2.x worker will not run anything for a 0.3 or newer conductor.

⁠Quick start

docker run -d \
  --name conductor \
  -p 8080:8080 \
  -v conductor-data:/data \
  -e CONDUCTOR_PUBLIC_URL=http://localhost:8080 \
  finwo/conductor

The administrator password is printed once in the log on first start. Set CONDUCTOR_ADMIN_PASSWORD to choose it instead.

Tasks need a worker, which is a separate image: see finwo/conductor-worker⁠. A compose file running both is in the repository under deploy/.

⁠State

Everything lives in /data, so mount a volume there:

/data/conductor.db   sqlite, unless a database url is configured
/data/mirrors        one bare git mirror per project
/data/logs           the live log spool
/data/storage        artifacts and archived logs, unless S3 is configured

⁠Configuration

Every setting has a default and can come from the environment, so no configuration file is needed. Worth setting in production:

Generate the two secrets with openssl rand -hex 32.

Postgres or MySQL instead of sqlite:

-e CONDUCTOR_DATABASE_URL=postgres://conductor:secret@postgres:5432/conductor

S3 compatible storage instead of the volume:

-e CONDUCTOR_S3_ENDPOINT=http://minio:9000 \
-e CONDUCTOR_S3_BUCKET=conductor \
-e CONDUCTOR_S3_ACCESS_KEY_ID=... \
-e CONDUCTOR_S3_SECRET_ACCESS_KEY=...

Artifacts and finished logs then go to the bucket, and downloads are handed over with a presigned redirect rather than proxied.

⁠Retention

Build output is deleted on a schedule, or a busy server fills its disk with logs nobody will read. The defaults keep artifacts for 30 days or the last 10 jobs, and logs for 14 days, and a project may override any of it. Upgrading an installation that has been running for a while will delete a lot on the first sweep, so set these before starting if that matters:

-e CONDUCTOR_RETENTION_ARTIFACT_DAYS=0 \
-e CONDUCTOR_RETENTION_LOG_DAYS=0

Zero means keep forever.

⁠Documentation

• Deployment⁠
• Pipelines⁠
• Workers⁠
• HTTP API⁠