known vm-import-controller issues (#685)

* known vm-import-controller issues

Signed-off-by: Gaurav Mehta <[email protected]>

* Apply suggestions from code review

include feedback from Jillian.

Co-authored-by: Jillian <[email protected]>
Signed-off-by: Gaurav Mehta <[email protected]>

* Several improvements

Signed-off-by: Volker Theile <[email protected]>
Signed-off-by: Gaurav Mehta <[email protected]>

* Address review comments

Signed-off-by: Volker Theile <[email protected]>
Signed-off-by: Gaurav Mehta <[email protected]>

---------

Signed-off-by: Gaurav Mehta <[email protected]>
Signed-off-by: Volker Theile <[email protected]>
Co-authored-by: Jillian <[email protected]>
Co-authored-by: Volker Theile <[email protected]>

Author: 3 people

docs/advanced/addons/vmimport.md

@@ -128,6 +128,7 @@ metadata:
   namespace: default
 spec: 
   virtualMachineName: "alpine-export-test"
+  folder: "Discovered VM"
   networkMapping:
   - sourceNetwork: "dvSwitch 1"
     destinationNetwork: "default/vlan1"
@@ -145,6 +146,8 @@ This will trigger the controller to export the VM named "alpine-export-test" on
 
 This can take a while based on the size of the virtual machine, but users should see `VirtualMachineImages` created for each disk in the defined virtual machine.
 
+If the source virtual machine is placed in a folder, you can specify the folder name in the optional `folder` field.
+
 The list of items in `networkMapping` will define how the source network interfaces are mapped to the Harvester Networks.
 
 If a match is not found, each unmatched network interface is attached to the default `managementNetwork`.
@@ -185,4 +188,7 @@ spec:
 
 :::note 
 OpenStack allows users to have multiple instances with the same name. In such a scenario, users are advised to use the Instance ID. The reconciliation logic tries to perform a name-to-ID lookup when a name is used.
-:::
+:::
+
+#### Known issues
+* **Source virtual machine name is not RFC1123 compliant**: When creating a virtual machine object, the vm-import-controller add-on uses the name of the source virtual machine, which may not meet the Kubernetes object [naming criteria](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names). You may need to rename the source virtual machine to allow successful completion of the import.

versioned_docs/version-v1.3/advanced/addons/vmimport.md

@@ -128,6 +128,7 @@ metadata:
   namespace: default
 spec: 
   virtualMachineName: "alpine-export-test"
+  folder: "Discovered VM"
   networkMapping:
   - sourceNetwork: "dvSwitch 1"
     destinationNetwork: "default/vlan1"
@@ -145,6 +146,8 @@ This will trigger the controller to export the VM named "alpine-export-test" on
 
 This can take a while based on the size of the virtual machine, but users should see `VirtualMachineImages` created for each disk in the defined virtual machine.
 
+If the source virtual machine is placed in a folder, you can specify the folder name in the optional `folder` field.
+
 The list of items in `networkMapping` will define how the source network interfaces are mapped to the Harvester Networks.
 
 If a match is not found, each unmatched network interface is attached to the default `managementNetwork`.
@@ -185,4 +188,14 @@ spec:
 
 :::note 
 OpenStack allows users to have multiple instances with the same name. In such a scenario, users are advised to use the Instance ID. The reconciliation logic tries to perform a name-to-ID lookup when a name is used.
-:::
+:::
+
+#### Known issues
+* **Source virtual machine name is not RFC1123 compliant**: When creating a virtual machine object, the vm-import-controller add-on uses the name of the source virtual machine, which may not meet the Kubernetes object [naming criteria](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names). You may need to rename the source virtual machine to allow successful completion of the import.
+
+* **Virtual machine image name is too long**: The vm-import-controller add-on labels each imported disk using the format `vm-import-$VMname-$DiskName`. If a label exceeds 63 characters, you will see the following error message in the vm-import-controller logs:
+    ```shell
+    harvester-vm-import-controller-5698cd57c4-zw9l5 time="2024-08-30T19:20:34Z" level=error msg="error syncing 'default/mike-mr-tumbleweed-test': handler virtualmachine-import-job-change: error creating vmi: VirtualMachineImage.harvesterhci.io \"image-z
+    nqsp\" is invalid: metadata.labels: Invalid value: \"vm-import-mike-mr-tumbleweed-test-mike-mr-tumbleweed-test-default-disk-0.img\": must be no more than 63 characters, requeuing"      
+    ```
+    You may need to rename the source virtual machine to allow successful completion of the import.

versioned_docs/version-v1.4/advanced/addons/vmimport.md

@@ -128,6 +128,7 @@ metadata:
   namespace: default
 spec: 
   virtualMachineName: "alpine-export-test"
+  folder: "Discovered VM"  
   networkMapping:
   - sourceNetwork: "dvSwitch 1"
     destinationNetwork: "default/vlan1"
@@ -144,6 +145,8 @@ This will trigger the controller to export the VM named "alpine-export-test" on
 
 This can take a while based on the size of the virtual machine, but users should see `VirtualMachineImages` created for each disk in the defined virtual machine.
 
+If the source virtual machine is placed in a folder, you can specify the folder name in the optional `folder` field.
+
 The list of items in `networkMapping` will define how the source network interfaces are mapped to the Harvester Networks.
 
 If a match is not found, each unmatched network interface is attached to the default `managementNetwork`.
@@ -185,4 +188,14 @@ spec:
 
 :::note 
 OpenStack allows users to have multiple instances with the same name. In such a scenario, users are advised to use the Instance ID. The reconciliation logic tries to perform a name-to-ID lookup when a name is used.
-:::
+:::
+
+#### Known issues
+* **Source virtual machine name is not RFC1123 compliant**: When creating a virtual machine object, the vm-import-controller add-on uses the name of the source virtual machine, which may not meet the Kubernetes object [naming criteria](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names). You may need to rename the source virtual machine to allow successful completion of the import.
+
+* **Virtual machine image name is too long**: The vm-import-controller add-on labels each imported disk using the format `vm-import-$VMname-$DiskName`. If a label exceeds 63 characters, you will see the following error message in the vm-import-controller logs:
+    ```shell
+    harvester-vm-import-controller-5698cd57c4-zw9l5 time="2024-08-30T19:20:34Z" level=error msg="error syncing 'default/mike-mr-tumbleweed-test': handler virtualmachine-import-job-change: error creating vmi: VirtualMachineImage.harvesterhci.io \"image-z
+    nqsp\" is invalid: metadata.labels: Invalid value: \"vm-import-mike-mr-tumbleweed-test-mike-mr-tumbleweed-test-default-disk-0.img\": must be no more than 63 characters, requeuing"      
+    ```
+    You may need to rename the source virtual machine to allow successful completion of the import.