Skip to content

Specifying Standby Runners

Jump to bottom
vzakaznikov edited this page Jan 24, 2024 · 2 revisions

You can define standby runner groups to always be ready to pick up your jobs using a custom configuration file.

✋ Note: Standby runner groups can only be defined using a configuration file. See Using a Configuration File for more details.

Standby runners are always active and allow jobs to be picked up immediately.

More than one standby runner group can be specified in the standby_runners. Each group is defined using the standby_runner object that has labels, count, and replenish_immediately attributes.

schema: 
"standby_runners": {
    "type": "array",
    "items": {
        "type": "object",
        "properties": {
            "labels": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            },
            "count": {
                "type": "integer"
            },
            "replenish_immediately": {
                "type": "boolean"
            }
        }
    }
}

where,

  • labels specifies an array of labels with which standby runners in this group should be created
  • count specifies the count of how many runners should be created for the group
  • replenish_immediately specifies if the sandby runners should be replenished as soon as they become busy after picking up a job; default: true

For example,

config.yaml: 
config:
   standby_runners:
      - labels:
         - type-cx21
        count: 2
        replenish_immediately: true

Developed and maintained by the TestFlows team.

Clone this wiki locally