Skip to content
Proud to collaborate with Microsoft for Startups

runner.environment-update-kubernetes ​

Update Kubernetes runner workloads for a runner group

Re-apply Secret + Deployment after group config changes.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners
Version1.0

Input Schema ​

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

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup this update applied to, echoed from the input.
organization_uuiduuidNo—UUID of the caller's organization, echoed from the input.
initiated_atstringNo——
namespacestringNo——
deployment_namestringNo——
registration_secret_namestringNo——
cloud_connection_uuidstringNo—UUID of the CloudConnection backing this runner group's Kubernetes cluster, picked from the organization's connections. Output-only echo derived from the runner group; type kept as STRING (not UUID) to match the existing field declaration.
desired_countintegerNo——
agent_runner_groupbooleanNo——
backend_typestringNo——
workflow_run_idstringNo——
statusstringNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—prepare—
preparingNoNo—provision—
provisioningNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingprovisionprovisioning—
provisioningcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.environment-update-kubernetes",
  "initial_data": {
    "organization_uuid": "value",
    "runner_group_uuid": "value"
  }
}