From ab09b09fbf36b523e610fcfa0ac36def61a2eaa0 Mon Sep 17 00:00:00 2001
From: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
Date: Wed, 8 Jan 2025 22:34:00 -0500
Subject: [PATCH] chore(docs): add 'stop_on_destroy' configuration to cloud
 image examples (#1705)

Added the 'stop_on_destroy' parameter to the Proxmox VM configurations in the cloud image documentation and example files for CentOS, Ubuntu, and Debian. This parameter should be set to true if the QEMU agent is not installed or enabled on the VM, enhancing clarity for users configuring their virtual machines.

Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
---
 docs/guides/cloud-image.md                              | 9 +++++++++
 examples/guides/cloud-image/centos-qcow2/main.tf        | 3 +++
 examples/guides/cloud-image/debian-from-storage/main.tf | 3 +++
 examples/guides/cloud-image/ubuntu-img/main.tf          | 3 +++
 4 files changed, 18 insertions(+)

diff --git a/docs/guides/cloud-image.md b/docs/guides/cloud-image.md
index 104ad42c..2ba46c06 100644
--- a/docs/guides/cloud-image.md
+++ b/docs/guides/cloud-image.md
@@ -19,6 +19,9 @@ resource "proxmox_virtual_environment_vm" "centos_vm" {
   name      = "test-centos"
   node_name = "pve"
 
+  # should be true if qemu agent is not installed / enabled on the VM
+  stop_on_destroy = true
+
   initialization {
     user_account {
       # do not use this in production, configure your own ssh key instead!
@@ -53,6 +56,9 @@ resource "proxmox_virtual_environment_vm" "ubuntu_vm" {
   name      = "test-ubuntu"
   node_name = "pve"
 
+  # should be true if qemu agent is not installed / enabled on the VM
+  stop_on_destroy = true
+
   initialization {
     user_account {
       # do not use this in production, configure your own ssh key instead!
@@ -90,6 +96,9 @@ resource "proxmox_virtual_environment_vm" "debian_vm" {
   name      = "test-debian"
   node_name = "pve"
 
+  # should be true if qemu agent is not installed / enabled on the VM
+  stop_on_destroy = true
+
   initialization {
     user_account {
       # do not use this in production, configure your own ssh key instead!
diff --git a/examples/guides/cloud-image/centos-qcow2/main.tf b/examples/guides/cloud-image/centos-qcow2/main.tf
index 408e64b7..f9a5ad94 100644
--- a/examples/guides/cloud-image/centos-qcow2/main.tf
+++ b/examples/guides/cloud-image/centos-qcow2/main.tf
@@ -2,6 +2,9 @@ resource "proxmox_virtual_environment_vm" "centos_vm" {
   name      = "test-centos"
   node_name = "pve"
 
+  # should be true if qemu agent is not installed / enabled on the VM
+  stop_on_destroy = true
+
   initialization {
     user_account {
       # do not use this in production, configure your own ssh key instead!
diff --git a/examples/guides/cloud-image/debian-from-storage/main.tf b/examples/guides/cloud-image/debian-from-storage/main.tf
index 3aac2598..10ef21ed 100644
--- a/examples/guides/cloud-image/debian-from-storage/main.tf
+++ b/examples/guides/cloud-image/debian-from-storage/main.tf
@@ -2,6 +2,9 @@ resource "proxmox_virtual_environment_vm" "debian_vm" {
   name      = "test-debian"
   node_name = "pve"
 
+  # should be true if qemu agent is not installed / enabled on the VM
+  stop_on_destroy = true
+
   initialization {
     user_account {
       # do not use this in production, configure your own ssh key instead!
diff --git a/examples/guides/cloud-image/ubuntu-img/main.tf b/examples/guides/cloud-image/ubuntu-img/main.tf
index ef33c3c3..9138dc08 100644
--- a/examples/guides/cloud-image/ubuntu-img/main.tf
+++ b/examples/guides/cloud-image/ubuntu-img/main.tf
@@ -2,6 +2,9 @@ resource "proxmox_virtual_environment_vm" "ubuntu_vm" {
   name      = "test-ubuntu"
   node_name = "pve"
 
+  # should be true if qemu agent is not installed / enabled on the VM
+  stop_on_destroy = true
+
   initialization {
     user_account {
       # do not use this in production, configure your own ssh key instead!