Appearance
runner.scaling-kubernetes ​
Scale Kubernetes runner Deployment replicas
Scale a Kubernetes Deployment to match desired runner 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 this action operates on, 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. |
previous_desired_count | integer | No | — | Previous desired replica count |
new_desired_count | integer | Yes | — | Target replica count |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this action operated on, echoed from the input, picked from the organization's list of runner groups. |
organization_uuid | uuid | No | — | UUID of the caller's organization, echoed from the input; injected server-side from the authenticated request. |
previous_desired_count | integer | No | — | — |
new_desired_count | integer | No | — | — |
registration_token | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | refresh_token | — |
patching | No | No | — | complete | — |
refreshing_token | No | No | — | patch_replicas | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | refresh_token | refreshing_token | — |
refreshing_token | patch_replicas | patching | — |
patching | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.scaling-kubernetes",
"initial_data": {
"runner_group_uuid": "value",
"organization_uuid": "value",
"new_desired_count": 123
}
}