delete_cluster
PERMANENTLY delete (deprovision) an Ankra-provisioned self-managed cluster: terminates every VM and cloud resource and removes the cluster from the platform. Configuration, workloads, and data are all destroyed; this cannot be undone. As a guardrail you MUST pass confirm_name exactly equal to the cluster's name - any mismatch refuses the deletion. Always have the user type or explicitly confirm the exact cluster name first. The delete also deletes the cluster's persistent volumes (the cloud volumes its CSI driver provisioned) and the data on them, unless the cluster's retention_policy keeps them. When the cluster has such volumes, or Ankra cannot read its volume inventory, the delete is refused unless accept_volume_data_loss is true: the refusal names the volumes, so show them to the user, ask whether they accept that the volumes and their data are deleted with the cluster, and call delete_cluster again with accept_volume_data_loss true only after the user has explicitly agreed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cluster_id | No | UUID of the target cluster. Optional when a cluster is selected. | |
| cluster_name | No | Exact name of the target cluster. Optional when a cluster is selected. | |
| confirm_name | Yes | The exact name of the cluster being deleted, echoed back as the deletion guardrail. | |
| accept_volume_data_loss | No | The user's explicit consent that the cluster's persistent volumes, and the data on them, are deleted with the cluster. On a cluster with such volumes, or whose volume inventory Ankra cannot read, the delete is refused without it and the refusal names the volumes. Set it to true ONLY after you have shown the user those volumes and the user has explicitly agreed to lose that data - never on your own judgement, never pre-emptively, and not because the user asked to delete the cluster. Defaults to false. |