runner.instance-terminate-gce
Terminate one GCE runner instance — deregister from GitHub (best-effort), delete the Compute Engine VM via LTIP across the group's configured zones (best-effort), and mark the RunnerInstance row TERMINATED with a reason. Counterpart to runner.instance-terminate-ec2-vm.
Terminate a single RunnerInstance: deregister from GH + delete GCE VM + DB mark.
Overview
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-runners-gcp |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_instance_uuid | uuid | Yes | — | UUID of the RunnerInstance (GCE VM) to terminate. |
reason | string | No | — | Free-text reason recorded on the instance row. |
Output Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_instance_uuid | uuid | No | — | UUID of the RunnerInstance this workflow terminated, picked from the group's list of instances; echoed on output alongside terminal/error payloads. |
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup owning the terminated instance, picked from the organization's list of runner groups. |
cloud_instance_ref | string | No | — | — |
zone | string | No | — | — |
github_deregistered | boolean | No | — | — |
vm_deleted | boolean | No | — | — |
termination_reason | string | No | — | — |
reason | string | No | — | Caller-supplied reason (input echo; also recorded as termination_reason) |
outcome | string | No | — | — |
status | 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 |
|---|---|---|---|---|---|
pending | Yes | No | — | terminate | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | terminate | completed | — |
* (any state) | fail | failed | — |
API Usage
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.instance-terminate-gce",
"initial_data": {
"runner_instance_uuid": "value"
}
}