cluster.status

Return normalized provider and Kubernetes status for a logical cluster.

Overview

Property	Value
Workflow type	Atomic
Library	App-clusters
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID for tenant isolation.
cluster_uuid	uuid	No	—	Logical cluster UUID to inspect.
provider	string	No	—	Provider key when cluster_uuid is not supplied.
cluster_kind	string	No	—	eks, gke, aws-vm, gcp-vm, mgc-kubernetes, or imported Kubernetes kinds such as generic-kubernetes/k3s.
provider_connection_uuid	uuid	No	—	Provider CloudConnection UUID.
provider_cluster_ref	string	No	—	Provider-side cluster identifier.
region	string	No	—	Primary provider region or location.
provider_config	json	No	—	Provider-specific status inputs for supported provider workflows.
node_config	json	No	—	Provider-specific node pool or nodegroup identifiers.
connection_uuid	uuid	No	—	Kubernetes CloudConnection UUID.
include_kubernetes_probe	boolean	No	—	Whether to run Kubernetes version and identity probes.
actor	string	No	—	Caller initiating status read.
timeout_seconds	integer	No	—	Provider status timeout.

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	No	—	Organization UUID echoed from input.
cluster_uuid	uuid	No	—	Logical cluster UUID.
provider	string	No	—	Provider key.
cluster_kind	string	No	—	Cluster kind.
provider_connection_uuid	uuid	No	—	Provider CloudConnection UUID.
provider_cluster_ref	string	No	—	Provider-side cluster identifier.
region	string	No	—	Primary provider region or location.
provider_config	json	No	—	Provider-specific status inputs.
node_config	json	No	—	Provider-specific node pool or nodegroup identifiers.
connection_uuid	uuid	No	—	Kubernetes CloudConnection UUID.
include_kubernetes_probe	boolean	No	—	Whether to run Kubernetes version and identity probes.
actor	string	No	—	Caller initiating status read.
timeout_seconds	integer	No	—	Provider status timeout.
cluster	json	No	—	Output from data.cluster.get when cluster_uuid was supplied.
provider_status	json	No	—	Output from the selected provider status workflow, or a skip marker when Kubernetes is the status source.
cluster_version	json	No	—	Output from kubernetes.cluster.version.
identity	json	No	—	Output from kubernetes.connection.identity.
status	string	No	—	Normalized status.
phase	string	No	—	Provider-specific phase or Kubernetes reachability phase.
reachable	boolean	No	—	True when Kubernetes probe succeeds.
server_version	string	No	—	Kubernetes API server version.
checked_at	string	No	—	ISO timestamp for status check.
failure_reason	string	No	—	Human-readable failure reason.
failure_type	string	No	—	Failure category.
failed_action	string	No	—	Action that failed.
failed_step	json	No	—	Failed logical step or child workflow.
failed_layer	json	No	—	Engine failed layer when applicable.
failed_at_state	string	No	—	State where failure occurred.
error	string	No	—	Error message.
error_type	string	No	—	Error class.
failed_at	string	No	—	ISO failure timestamp.

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	load_cluster	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	load_cluster	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "cluster.status",
  "initial_data": {
    "organization_uuid": "value"
  }
}