Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.deployment.rollout_status ​

Report current rollout state of a Deployment (single read; not a watcher)

Reads the rollout status of a Deployment in the cluster. This is a single read — it does not watch or wait for rollout completion.

If the Deployment exists, the status fields (generation, observed_generation, replicas, updated_replicas, ready_replicas, available_replicas, unavailable_replicas, and conditions) are returned alongside exists=True. Any status field absent from the server response is returned as null.

If the Deployment is not found (404), returns exists=False and all status fields as null — no exception is raised.

Inputs:

  • connection_uuid: UUID of the cloud connection (required)
  • namespace: Namespace the Deployment lives in (required)
  • name: Deployment name (required)

Outputs:

  • exists: bool — True when the Deployment was found
  • generation: int — metadata.generation
  • observed_generation: int — status.observed_generation
  • replicas: int — status.replicas
  • updated_replicas: int — status.updated_replicas
  • ready_replicas: int — status.ready_replicas
  • available_replicas: int — status.available_replicas
  • unavailable_replicas: int — status.unavailable_replicas
  • conditions: JSON — list of {type, status, reason, message, last_transition_time}, or null

Plugin required: context.get_plugin("connection").kubernetes_runner_clients(connection_uuid, organization_uuid) must expose apps_v1 with read_namespaced_deployment_status.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namespacestringYes——
namestringYes——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
namespacestringNo——
namestringNo——
existsbooleanNo——
generationintegerNo——
observed_generationintegerNo——
replicasintegerNo——
updated_replicasintegerNo——
ready_replicasintegerNo——
available_replicasintegerNo——
unavailable_replicasintegerNo——
conditionsjsonNo——
readybooleanNo——
messagestringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

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