Skip to content
Proud to collaborate with Microsoft for Startups

cluster.status-gke ​

Describe GKE provider status and optionally verify Kubernetes access.

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-clusters-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID for tenant/audit context.
gcp_connection_uuiduuidYes—GCP CloudConnection UUID used for provider API calls.
kubernetes_connection_uuiduuidNo—Registered Kubernetes CloudConnection UUID to verify.
project_idstringYes—GCP project ID.
locationstringYes—GKE region or zone.
cluster_namestringYes—GKE cluster name.
include_kubernetes_verifybooleanNo—Run common Kubernetes connection verification when a connection UUID is supplied.
include_snapshotbooleanNo—Ask common verify to include a lightweight cluster snapshot when supported.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Echoed organization UUID.
gcp_connection_uuiduuidNo—GCP CloudConnection UUID used.
kubernetes_connection_uuiduuidNo—Kubernetes CloudConnection UUID checked.
project_idstringNo—GCP project ID.
locationstringNo—GKE region or zone.
cluster_namestringNo—GKE cluster name.
include_kubernetes_verifybooleanNo—Run common Kubernetes connection verification when a connection UUID is supplied.
include_snapshotbooleanNo—Ask common verify to include a lightweight cluster snapshot when supported.
workflow_run_uuidstringNo—Engine DAG run UUID for child step state.
retried_fromstringNo—Previous terminal state restored by engine retry.
retry_countintegerNo—Number of retry attempts recorded by the engine.
statusstringNo—Provider cluster status.
endpointstringNo—Kubernetes API endpoint.
kubernetes_versionstringNo—Current control-plane version.
node_poolsjsonNo—Provider node-pool summary.
conditionsjsonNo—Provider cluster conditions.
cluster_describejsonNo—Output from gcp.gke.cluster.describe.
verify_connectionjsonNo—Output from cluster.verify-kubernetes-connection.
compensation_triggerjsonNo—DAG compensation trigger.
comp_current_layerjsonNo—Current compensation layer.
comp_queuejsonNo—Remaining compensation queue.
comp_retry_countjsonNo—Current compensation retry count.
failure_reasonstringNo—Engine failure reason.
failed_stepjsonNo—Failed DAG step.
failed_layerjsonNo—Failed DAG layer.
failed_at_statejsonNo—Failed state metadata.
errorstringNo—Error message.
error_typestringNo—Error class.

DAG Layers ​

#LayerStepsCompensation
1describegcp.gke.cluster.describe—
2verifycluster.verify-kubernetes-connection—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
gcp.gke.cluster.describecluster_describe
cluster.verify-kubernetes-connectionverify_connection

API Usage ​

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

{
  "workflow_type": "cluster.status-gke",
  "initial_data": {
    "gcp_connection_uuid": "value",
    "project_id": "value",
    "location": "value",
    "cluster_name": "value"
  }
}