Appearance
cluster.delete-gcp-vm ​
Delete a GCP VM-backed cluster by deleting its VM resource.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-clusters-gcp |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
gcp_connection_uuid | uuid | Yes | — | — |
kubernetes_connection_uuid | uuid | No | — | — |
project_id | string | Yes | — | — |
zone | string | Yes | — | — |
cluster_name | string | No | — | — |
vm_name | string | Yes | — | — |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
gcp_connection_uuid | uuid | Yes | — | — |
kubernetes_connection_uuid | uuid | No | — | — |
project_id | string | Yes | — | — |
zone | string | Yes | — | — |
cluster_name | string | No | — | — |
vm_name | string | Yes | — | — |
actor | string | No | — | — |
vm_delete | json | No | — | — |
deleted | boolean | No | — | — |
existed | boolean | No | — | — |
status | string | No | — | — |
completed_at | string | No | — | — |
failure_reason | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | delete_vm | — |
deleting_vm | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | delete_vm | deleting_vm | — |
deleting_vm | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "cluster.delete-gcp-vm",
"initial_data": {
"gcp_connection_uuid": "value",
"project_id": "value",
"zone": "value",
"vm_name": "value"
}
}