stop_cluster
Stop an Ankra-provisioned self-managed cluster (Hetzner, OVH, UpCloud, DigitalOcean, Scaleway, AWS, Proxmox VE, or HPE Morpheus). On Hetzner, OVH, UpCloud, DigitalOcean, Proxmox VE and Morpheus a stop TERMINATES every VM of the cluster at the provider (control planes, workers, bastion/gateway); on Scaleway and AWS the servers are instead powered off and kept with their volumes (etcd and the cluster's state survive; retained storage, gateway and IPs remain billable). On the terminating providers the platform first captures the cluster's state - an encrypted etcd snapshot uploaded to the organisation's backup vault - and tears the VMs down only once it is stored (k3s and kubeadm clusters on Hetzner, OVH, UpCloud, DigitalOcean, Proxmox VE and Morpheus); start_cluster then restores it so Secrets, ConfigMaps, custom resources and PersistentVolume/Claim bindings come back and StatefulSets reattach their existing cloud disks. preserve_state=false skips the capture (data on the VMs' disks is then destroyed; only the cluster's Ankra configuration is preserved and start_cluster re-provisions from it); preserve_state=true refuses a stop whose state cannot be captured. Cloud block volumes are never deleted by a stop. mode 'pause' (k3s on Hetzner, UpCloud and DigitalOcean) instead powers the servers off and keeps them with their disks, exactly like a Scaleway or AWS stop: etcd, local data and the nodes' identities survive and start_cluster powers them back on, at the price of compute and storage still billing while paused - offer it when the user wants a short stop with everything intact, and the default teardown when they want to stop paying for the VMs. Use before change_control_plane on a single-controller cluster (a 3-controller cluster resizes live without stopping). Confirm with the user before calling.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | How the stop leaves the VMs. 'delete_resources' (default): terminate them (state snapshot first where supported). 'pause': power the servers off and keep them with their disks - etcd, local data and node identities survive and start_cluster powers them back on, but compute and storage keep billing while paused. Available for k3s clusters on Hetzner, UpCloud and DigitalOcean; on AWS and Scaleway a stop always pauses. Cannot be combined with force. | |
| 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. | |
| preserve_state | No | Default (omitted): capture the cluster state first whenever the provider and distribution support it, otherwise stop without it and say so. true: require the capture (refuse otherwise). false: tear down immediately without a snapshot. Does not apply to mode 'pause'. |