dcloud ci runner-pools create

Create a runner pool

IAM ci:CreateRunnerPoolChanges state

Creates a launch template and an auto scaling group named runner-pool-<name> in your organization (also needs autoscaling:CreateLaunchTemplate, autoscaling:CreateAutoScalingGroup and ec2:RunInstances). A job whose runs-on labels are all among the pool’s goes to it, with or without self-hosted in the file: give a pool ubuntu-latest and ubuntu-24.04 to move hosted jobs onto per-job machines. Idle machines stay until shortly before their paid hour ends.

Synopsis

dcloud ci runner-pools create --name name --labels labels --size size --max-size maxSize [flags]

Flags

  • --nameRequired

    string

    Name of the pool, lower-case letters, digits and -, up to 40, unique in the organization (409); its group and template are named runner-pool-<name>

    Constraints: /^[a-z0-9][a-z0-9-]{0,39}$/

  • --labelsRequired

    array of string

    Jobs whose runs-on labels are all among these go here, e.g. ubuntu-latest, ubuntu-24.04 (hosted jobs) or hetzner-16; 1 to 20, each up to 50 characters; a macOS label is refused (400)

    Constraints: /^[a-z0-9][a-z0-9._-]{0,49}$/

  • --sizeRequired

    enum

    Machine size: s-2 (2 vCPU / 4 GiB), s-4 (4 / 8), s-8 (8 / 16), s-16 (16 / 32), d-2, d-8 (dedicated), a-2, a-4, a-8, a-16 (ARM, for ubuntu-24.04-arm jobs); the smallest machine of your provider that fits

    One of: s-2, s-4, s-8, s-16, m-4, d-2, d-8, a-2, a-4, a-8, a-16

  • --min-sizeOptional

    number

    Machines always on (the base), 0 to 200, not above maxSize (400); 0 when omitted

    Constraints: integer, 0-200

  • --max-sizeRequired

    number

    Most machines at once, 1 to 200

    Constraints: integer, 1-200

  • --spareOptional

    number

    Idle machines kept above demand, 0 to 50; 0 when omitted

    Constraints: integer, 0-50

  • --clean-machine-per-jobOptional

    boolean (--clean-machine-per-job / --no-clean-machine-per-job)

    Destroy every machine after its job instead of reusing it within its paid hour; off when omitted

  • --share-trusted-machinesOptional

    boolean (--share-trusted-machines / --no-share-trusted-machines)

    Let trusted jobs (default branch, tags, dispatch, schedules) of every repository share machines; pull request jobs never do; off when omitted

  • --prebuilt-imageOptional

    boolean (--prebuilt-image / --no-prebuilt-image)

    Start machines from the organization's pre-built runner image once it is built (first job about a minute sooner); default true; false: stock Ubuntu, installed at every boot

  • --placementOptional

    enum

    own-hosts-first (default): each machine runs on the platform's own CI hosts when one has room, in the cloud otherwise, and each job says where and why; cloud-only: always at your organization's provider

    One of: own-hosts-first, cloud-only

  • --runner-group-idOptional

    string

    A runner group whose repository and ref rules decide which runs reach the pool

    Constraints: uuid

Example

dcloud ci runner-pools create --name example --labels '["example"]' --size s-2 --max-size 1

Generated from the API description, the same one the API checks requests against and the CLI is built from.