Skip to content

Add documentation for the skipPreflightChecks field in VirtualMachineImport #805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for the skipPreflightChecks field in VirtualMachineImport #805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/advanced/addons/vmimport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ spec:
destinationNetwork: "default/vlan1"
- sourceNetwork: "dvSwitch 2"
destinationNetwork: "default/vlan2"
skipPreflightChecks: false
storageClass: "my-storage-class"
sourceCluster:
name: vcsim
Expand All @@ -144,7 +145,10 @@ spec:

This will trigger the controller to export the VM named "alpine-export-test" on the VMware source cluster to be exported, processed and recreated into the Harvester cluster.

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.
Before the import process starts, the configuration will be verified. If any configuration errors are detected, such as unknown storage class or networks, the import process is aborted.
These preflight checks can be skipped with the `skipPreflightChecks` field.

The import process 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.
Comment on lines +148 to +151
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Before the import process starts, the configuration will be verified. If any configuration errors are detected, such as unknown storage class or networks, the import process is aborted.
These preflight checks can be skipped with the `skipPreflightChecks` field.
The import process 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.
The controller checks the configuration before starting the import process, and cancels the import when it detects errors such as unknown StorageClasses or networks. These checks are enabled by default, but can be disabled by setting `skipPreflightChecks` to `true`.
The duration of the import process depends on the size of the virtual machine. While the import process may take some time, you 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.

Expand Down
Loading