Skip to content
Proud to collaborate with Microsoft for Startups

runner.health-check-kubernetes ​

Sync runner group status from Kubernetes Deployment or ephemeral executions

Project group health from its Kubernetes execution model.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups.
organization_uuiduuidYes—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup this action operated on, echoed back from the input on output.
organization_uuiduuidNo—UUID of the caller's organization, echoed back from the input on output.
ready_replicasintegerNo——
active_executionsintegerNo——
health_sourcestringNo——
completed_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—sync—
syncingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedsyncsyncing—
syncingcompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "runner.health-check-kubernetes",
  "initial_data": {
    "runner_group_uuid": "value",
    "organization_uuid": "value"
  }
}