Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.deployment.wait_for_available ​

Poll a Kubernetes Deployment until rollout completes or timeout

Polls a Deployment until it finishes rolling out, fails the rollout, or the caller-supplied timeout elapses.

Inputs:

  • connection_uuid: Cloud connection UUID (required)
  • namespace: Deployment namespace (required)
  • name: Deployment name (required)
  • timeout_seconds: Total budget before this workflow gives up (default 300, cap 1800)
  • poll_interval: Seconds between apiserver reads (default 5, cap 60)

Outputs:

  • namespace, name, ready (bool), poll_count (int), last_observed_status (dict)

State data carries started_at_epoch so the deadline check survives across schedule_transition firings.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namespacestringYes——
namestringYes——
timeout_secondsintegerNo—Total wait budget in seconds (default 300, cap 1800)
poll_intervalintegerNo—Seconds between status reads (default 5, cap 60)
workflow_run_idstringNo—Engine workflow run id for DAG step execution
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
namespacestringNo——
namestringNo——
readybooleanNo——
poll_countintegerNo——
last_observed_statusjsonNo——
timeout_secondsintegerNo——
poll_intervalintegerNo——
workflow_run_idstringNo—Engine workflow run id for DAG step execution
started_at_epochintegerNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pollingYesNo———
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pollingpollpolling—
pollingfinishcompleted—
pollingtimeoutfailed—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "kubernetes.deployment.wait_for_available",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value"
  }
}