Appearance
runner.scaling ​
Scales a runner group to a new desired count
Workflow for scaling a runner group to a new desired count.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | Yes | — | UUID of the RunnerGroup to scale, picked from the organization's list of runner groups. |
organization_uuid | uuid | Yes | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
desired_count | integer | Yes | — | — |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this scaling request, injected server-side from the authenticated request when available; used for audit/attribution only. Omitted for system-triggered calls with no human actor. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups; echoed on output alongside terminal/error payloads. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. Echoed on output alongside terminal/error payloads. |
runner_execution_uuid | uuid | No | — | UUID of the RunnerExecution this action operates on, picked from the organization's (optionally group-scoped) list of executions; echoed on output alongside terminal/error payloads. |
workflow_uuid | string | No | — | Engine workflow-run identifier (or, for GitHub-Actions-triggered flows, an external GitHub Actions run id) associated with this record; not a platform entity foreign key despite the name. No source is attached since there is no list/query workflow for an internal run id. |
status | string | No | — | — |
outcome | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. Optional — omitted for system or service-triggered actions with no human actor. |
reason | string | No | — | — |
workflow_run_uuid | string | No | — | Engine-stamped correlation/run id for this DAG execution (ADR-015/E1 plumbing), written into state_data by action_start; not a foreign key to any business entity. No source is attached since there is no list/query workflow for an internal run id. |
retry_count | integer | No | — | — |
retried_from | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
compensation_trigger | json | No | — | — |
comp_current_layer | json | No | — | — |
comp_queue | json | No | — | — |
comp_retry_count | json | No | — | — |
desired_count | integer | No | — | — |
previous_desired_count | integer | No | — | — |
new_desired_count | integer | No | — | — |
registration_token | string | No | — | — |
scale_action | string | No | — | Convergence strategy used: 'native_scale' for backends with a group-level autoscaler knob, 'scale_check' for per-runner backends converged via runner.scale-check-group. |
scale_dispatch | string | No | — | Dispatch outcome. 'skipped_no_manager' means desired_count was persisted but no engine was reachable to run the child; the periodic scale-check sweep converges it later. |
scale_child_workflow | string | No | — | Workflow type dispatched to converge the group. |
matched_runner_group_uuid | uuid | No | — | UUID of the RunnerGroup matched by the dispatched scale-check, echoed from the child run. |
auto_scaling_group_name | string | No | — | — |
desired_capacity | integer | No | — | — |
updated | boolean | No | — | — |
region | string | No | — | — |
active_execution_count | integer | No | — | — |
ready_to_serve | integer | No | — | — |
reconciled_executions | integer | No | — | — |
instance_counts | dict | No | — | — |
warm_pool_enabled | boolean | No | — | — |
max_count | integer | No | — | — |
min_count | integer | No | — | — |
floor_deficit | integer | No | — | — |
launched_count | integer | No | — | — |
launched_workflow_uuid | string | No | — | — |
launched_workflow_uuids | list | No | — | — |
launched_workflow_type | string | No | — | — |
launch_errors | list | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | refresh_token | — |
refreshing_token | No | No | — | update_asg | — |
updating_asg | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | refresh_token | refreshing_token | — |
refreshing_token | update_asg | updating_asg | — |
updating_asg | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.scaling",
"initial_data": {
"runner_group_uuid": "value",
"organization_uuid": "value",
"desired_count": 123
}
}