Add text for PR685 (vm-import-controller issues)

Signed-off-by: Jillian <[email protected]>
rancher · Jan 9, 2025 · 5cefecd · 5cefecd
1 parent e768fa0
commit 5cefecd
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/versions/v1.3/modules/en/pages/add-ons/vm-import-controller.adoc b/versions/v1.3/modules/en/pages/add-ons/vm-import-controller.adoc
@@ -131,6 +131,7 @@ metadata:
   namespace: default
 spec:
   virtualMachineName: "alpine-export-test"
+  folder: "Discovered VM" #optional folder name, in case your vm is placed in a folder
   networkMapping:
   - sourceNetwork: "dvSwitch 1"
     destinationNetwork: "default/vlan1"
@@ -189,3 +190,16 @@ spec:
 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 https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names[naming criteria]. 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 modify the assigned labels to allow successful completion of the import.
diff --git a/versions/v1.4/modules/en/pages/add-ons/vm-import-controller.adoc b/versions/v1.4/modules/en/pages/add-ons/vm-import-controller.adoc
@@ -131,6 +131,7 @@ metadata:
   namespace: default
 spec:
   virtualMachineName: "alpine-export-test"
+  folder: "Discovered VM" #optional folder name, in case your vm is placed in a folder
   networkMapping:
   - sourceNetwork: "dvSwitch 1"
     destinationNetwork: "default/vlan1"
@@ -189,3 +190,16 @@ spec:
 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 https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names[naming criteria]. 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 modify the assigned labels to allow successful completion of the import.
diff --git a/versions/v1.5/modules/en/pages/add-ons/vm-import-controller.adoc b/versions/v1.5/modules/en/pages/add-ons/vm-import-controller.adoc
@@ -131,6 +131,7 @@ metadata:
   namespace: default
 spec:
   virtualMachineName: "alpine-export-test"
+  folder: "Discovered VM" #optional folder name, in case your vm is placed in a folder
   networkMapping:
   - sourceNetwork: "dvSwitch 1"
     destinationNetwork: "default/vlan1"
@@ -189,3 +190,16 @@ spec:
 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 https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names[naming criteria]. 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 modify the assigned labels to allow successful completion of the import.