From 712dd5e6a18421f6e8191eb2e7bf423f87cdffe3 Mon Sep 17 00:00:00 2001
From: Volker Theile <vtheile@suse.com>
Date: Mon, 28 Oct 2024 11:05:47 +0100
Subject: [PATCH] Add troubleshooting issue when VM does not show an IP

Related to: https://github.com/harvester/harvester/issues/6644

Signed-off-by: Volker Theile <vtheile@suse.com>
---
 docs/troubleshooting/vm.md                    | 34 +++++++++++++++++++
 .../version-v1.3/troubleshooting/vm.md        | 34 +++++++++++++++++++
 2 files changed, 68 insertions(+)

diff --git a/docs/troubleshooting/vm.md b/docs/troubleshooting/vm.md
index 149b5c15a37..4dccba03335 100644
--- a/docs/troubleshooting/vm.md
+++ b/docs/troubleshooting/vm.md
@@ -414,3 +414,37 @@ Node level operation, node by node:
 https://github.com/harvester/harvester/issues/5109
 
 https://github.com/longhorn/longhorn/issues/8009
+
+## VM does not show an IP address
+
+### Issue Description
+
+The VM does not show an IP address on the **Virtual Machines** page on the Harvester UI. This issue might apply to newly created or imported VMs.
+
+### Issue Analysis
+
+If no IP address is displayed for a VM, this is usually because the **qemu-guest-agent** package is not installed in the VM.
+
+You can check this by looking at the status of the **VirtualMachineInstance** object.
+
+```shell
+$ kubectl get vmi -n <NAMESPACE> <NAME> -ojsonpath='{.status.interfaces[0].infoSource}'
+```
+
+If no **qemu-guest-agent** package is installed, then the output will not contain the string **guest-agent**.
+
+### Workaround
+
+To solve the problem, you can select the **Install guest agent** checkbox in the VM settings under **Advanced Options**.
+
+The problem with this is that cloud-init is only executed once when the VM is started for the first time. To apply the settings specified under **Cloud Configuration** again when the VM is restarted the next time, the cloud-init directory in the VM must be deleted with the command
+
+```shell
+$ sudo rm -rf /var/lib/cloud/*
+```
+
+The VM must then be restarted so that cloud-init is executed again and the **qemu-guest-agent** package is installed.
+
+### Related Issue
+
+https://github.com/harvester/harvester/issues/6644
diff --git a/versioned_docs/version-v1.3/troubleshooting/vm.md b/versioned_docs/version-v1.3/troubleshooting/vm.md
index 149b5c15a37..4dccba03335 100644
--- a/versioned_docs/version-v1.3/troubleshooting/vm.md
+++ b/versioned_docs/version-v1.3/troubleshooting/vm.md
@@ -414,3 +414,37 @@ Node level operation, node by node:
 https://github.com/harvester/harvester/issues/5109
 
 https://github.com/longhorn/longhorn/issues/8009
+
+## VM does not show an IP address
+
+### Issue Description
+
+The VM does not show an IP address on the **Virtual Machines** page on the Harvester UI. This issue might apply to newly created or imported VMs.
+
+### Issue Analysis
+
+If no IP address is displayed for a VM, this is usually because the **qemu-guest-agent** package is not installed in the VM.
+
+You can check this by looking at the status of the **VirtualMachineInstance** object.
+
+```shell
+$ kubectl get vmi -n <NAMESPACE> <NAME> -ojsonpath='{.status.interfaces[0].infoSource}'
+```
+
+If no **qemu-guest-agent** package is installed, then the output will not contain the string **guest-agent**.
+
+### Workaround
+
+To solve the problem, you can select the **Install guest agent** checkbox in the VM settings under **Advanced Options**.
+
+The problem with this is that cloud-init is only executed once when the VM is started for the first time. To apply the settings specified under **Cloud Configuration** again when the VM is restarted the next time, the cloud-init directory in the VM must be deleted with the command
+
+```shell
+$ sudo rm -rf /var/lib/cloud/*
+```
+
+The VM must then be restarted so that cloud-init is executed again and the **qemu-guest-agent** package is installed.
+
+### Related Issue
+
+https://github.com/harvester/harvester/issues/6644