CHAMPREP Code runner
The CHAMPREP Code runner (champrep-code-runner) is a small program you install
on a machine you control. It connects to CHAMPREP Code, picks up the CI/CD jobs
of your pipelines, runs them, and sends back the log, the status and any
artifacts. Your code and your build tools stay on your machine.
Runner or CLI?
Section titled “Runner or CLI?”CHAMPREP has two command-line programs. They are separate downloads with separate commands:
| CHAMPREP Code runner | CHAMPREP CLI | |
|---|---|---|
| Command | champrep-code-runner | champrep |
| Who uses it | A build machine, server or VM | You, at your terminal |
| What it does | Runs CI/CD jobs for CHAMPREP Code pipelines | Works with CHAMPREP services, including Code, from a terminal |
| Install from | code-downloads.champrep.com | cli.champrep.com |
| Docs | This section | CLI reference |
If you want pipelines to run on your own machines, you need the runner. If you want to work with CHAMPREP from a terminal, you need the CLI. Many teams use both.
How it works
Section titled “How it works”- You create a runner in CHAMPREP Code (a project, group or instance runner) and choose which jobs it takes: its tags, whether it runs untagged jobs, and whether it runs only protected branches and tags.
- You install
champrep-code-runneron a machine and register it with the runner’s authentication token. - You run it, in a terminal or as a service that starts at boot.
- The runner asks CHAMPREP Code for jobs over outbound HTTPS, runs each one with its executor (shell, Docker or Kubernetes), and reports back.
The runner only makes outbound connections. You do not need to open any inbound port.
Executors
Section titled “Executors”| Executor | Runs each job | Use it for |
|---|---|---|
shell | Directly on the host, as the runner’s user | Trusted projects that need the host’s tools |
docker | In a fresh container from the job’s image | Isolated, reproducible builds |
kubernetes | In a pod in your cluster | Scaling builds on a cluster you already run |
The shell executor has no isolation between jobs and the host. Use it only for projects you trust.
Get started
Section titled “Get started”- Install the runner.
- Register it with a runner token.
- Start it and keep it running with the runner commands.
If something does not work, see Troubleshooting.