Skip to content
Proud to collaborate with Microsoft for Startups

cluster.delete ​

Provider-neutral Kubernetes cluster deletion orchestration.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation.
cluster_uuiduuidNo—Logical cluster UUID to delete.
providerstringNo—Provider key when cluster_uuid is not supplied.
cluster_kindstringNo—eks, gke, aws-vm, gcp-vm, or mgc-kubernetes.
provider_connection_uuiduuidNo—Provider CloudConnection UUID.
provider_cluster_refstringNo—Provider-side cluster identifier.
regionstringNo—Primary provider region or location.
provider_configjsonNo—Provider-specific delete/status inputs for supported provider workflows.
node_configjsonNo—Provider-specific node pool or nodegroup identifiers.
connection_uuiduuidNo—Kubernetes CloudConnection UUID associated with the cluster.
delete_connectionbooleanNo—Whether to soft-delete the Kubernetes CloudConnection.
forcebooleanNo—Continue best-effort cleanup when provider reports not found.
actorstringNo—Caller initiating deletion.
timeout_secondsintegerNo—Provider deletion timeout.
poll_intervalintegerNo—Provider deletion polling interval.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
cluster_uuiduuidNo—Logical cluster UUID.
providerstringNo—Provider key.
cluster_kindstringNo—Cluster kind.
provider_connection_uuiduuidNo—Provider CloudConnection UUID.
provider_cluster_refstringNo—Provider-side cluster identifier.
regionstringNo—Primary provider region or location.
provider_configjsonNo—Provider-specific delete/status inputs.
node_configjsonNo—Provider-specific node pool or nodegroup identifiers.
connection_uuiduuidNo—Associated Kubernetes CloudConnection UUID.
delete_connectionbooleanNo—Whether to soft-delete the Kubernetes CloudConnection.
forcebooleanNo—Continue best-effort cleanup when provider reports not found.
actorstringNo—Caller initiating deletion.
timeout_secondsintegerNo—Provider deletion timeout.
poll_intervalintegerNo—Provider deletion polling interval.
clusterjsonNo—Output from data.cluster.get when cluster_uuid was supplied.
provider_delete_workflowstringNo—Provider delete workflow type.
provider_delete_inputjsonNo—Input sent to the provider delete workflow.
provider_delete_child_workflow_idstringNo—Workflow id for the provider delete child.
provider_deletejsonNo—Output from the selected provider delete workflow.
statusstringNo—Normalized deletion status.
deletedbooleanNo—True when provider deletion completed or object was absent under force.
connection_deletedbooleanNo—True when the Kubernetes CloudConnection was soft-deleted.
deleted_atstringNo—ISO deletion timestamp.
completed_atstringNo—ISO completion timestamp.
failure_reasonstringNo—Human-readable failure reason.
failure_typestringNo—Failure category.
failed_actionstringNo—Action that failed.
failed_stepjsonNo—Failed logical step or child workflow.
failed_layerjsonNo—Engine failed layer when applicable.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—load_cluster—
deleting_providerNoNo———
loading_clusterNoNo—dispatch_provider_delete—
marking_deletedNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingload_clusterloading_cluster—
loading_clusterdispatch_provider_deletedeleting_provider—
deleting_providerchild_donemarking_deleted—
deleting_providerchild_failedfailed—
marking_deletedcompletecompleted—
* (any state)failfailed—

API Usage ​

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

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