Configuring Runners

Runners are responsible for executing the actual inference tasks in Helix. Here’s how to configure them:

Local Runner Configuration

For a local runner, ensure the following in your .env file:

RUNNER_ENABLED=true
RUNNER_NAME=local-runner
RUNNER_GPU_ENABLED=true

Start the runner with:

./runner.sh

Remote Runner Configuration

To attach a remote runner to your control plane:

  1. On the control plane, generate a runner token:

    docker exec helix-controlplane helixctl generate-runner-token
    
  2. On the runner machine, configure the .env file:

    CONTROLPLANE_URL=https://helix.yourdomain.com
    RUNNER_TOKEN=generated_token
    
  3. Start the remote runner:

    ./runner.sh
    

Runner Scaling

For production deployments, you can scale runners horizontally:

# docker-compose.yml
services:
  runner-1:
    # runner configuration
  runner-2:
    # runner configuration
  runner-3:
    # runner configuration

Monitor runner status through the Helix UI or API to ensure optimal performance.