Skip to content
Proud to collaborate with Microsoft for Startups

runner.environment-provision-kubernetes ​

Provision Kubernetes runner workloads for a runner group

Provision Secret + Deployment on a customer Kubernetes cluster (BYO).

Overview ​

PropertyValue
Workflow typeDag
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.
registry_account_uuiduuidNo—UUID of the container registry account this runner group resolves images against, picked from the organization's registry accounts. Optional — falls back to default/unauthenticated image resolution when absent.
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—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_uuiduuidNo—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_uuiduuidNo—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_uuidstringNo—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.
statusstringNo——
outcomestringNo——
initiated_atstringNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
errorstringNo——
error_typestringNo——
actor_uuiduuidNo—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.
reasonstringNo——
workflow_run_uuidstringNo—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_countintegerNo——
retried_fromstringNo——
failed_stepjsonNo——
failed_layerjsonNo——
failed_at_statejsonNo——
compensation_triggerjsonNo——
comp_current_layerjsonNo——
comp_queuejsonNo——
comp_retry_countjsonNo——
validate_kubernetes_environmentjsonNo——
provision_kubernetes_workloadsjsonNo——
finalize_kubernetes_environmentjsonNo——

DAG Layers ​

#LayerStepsCompensation
1validaterunner.validate_kubernetes_environment—
2provisionrunner.provision_kubernetes_workloads—
3finalizerunner.finalize_kubernetes_environment—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
runner.validate_kubernetes_environmentvalidate_kubernetes_environment
runner.provision_kubernetes_workloadsprovision_kubernetes_workloads
runner.finalize_kubernetes_environmentfinalize_kubernetes_environment

API Usage ​

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

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