Appearance
runner.execution-launch-kubernetes ​
Launch one ephemeral GitHub Actions runner execution as a Kubernetes Job
Launch one ephemeral GitHub Actions runner as a Kubernetes Job.
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. |
runner_execution_uuid | uuid | No | — | UUID of an existing RunnerExecution to reuse instead of creating a new one, picked from the group's executions. Optional — a new execution is created when absent. |
environment | dict | No | — | Extra environment variables to pass to the runner container |
runner_image | string | No | — | Optional container image override for this execution; defaults to the group's config.container_image. |
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 | — | — |
namespace | string | No | — | — |
job_name | string | No | — | — |
job_uid | string | No | — | — |
task_arn | string | No | — | — |
container_image | string | No | — | — |
last_status | string | No | — | — |
runtime_env | dict | No | — | — |
environment | dict | No | — | — |
command | list | No | — | — |
registration_token | string | No | — | — |
runner_name | string | No | — | — |
start_command | list | No | — | — |
runner_image | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | prepare | — |
building_start_command | No | No | — | launch_job | — |
getting_registration_token | No | No | — | build_start_command | — |
launching_job | No | No | — | complete | — |
preparing | No | No | — | get_registration_token | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | prepare | preparing | — |
preparing | get_registration_token | getting_registration_token | — |
getting_registration_token | build_start_command | building_start_command | — |
building_start_command | launch_job | launching_job | — |
launching_job | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.execution-launch-kubernetes",
"initial_data": {
"runner_group_uuid": "value",
"organization_uuid": "value"
}
}