This is an automated email from the ASF dual-hosted git repository.
dahn pushed a commit to branch 4.19
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/4.19 by this push:
new 3e82814 Update documentation for importing of instances (#453)
3e82814 is described below
commit 3e82814dc91474e33418b288f7334b5c9f84286e
Author: Vishesh <[email protected]>
AuthorDate: Fri Nov 29 17:53:24 2024 +0530
Update documentation for importing of instances (#453)
Co-authored-by: Suresh Kumar Anaparti <[email protected]>
Co-authored-by: Andrija Panic
<[email protected]>
---
.../import-vm-from-vmware-to-kvm-options.png | Bin 187973 -> 215056 bytes
.../images/import-vm-from-vmware-to-kvm.png | Bin 150155 -> 137293 bytes
.../importing_vmware_vms_into_kvm.rst | 83 +++++++++++++--------
3 files changed, 52 insertions(+), 31 deletions(-)
diff --git a/source/_static/images/import-vm-from-vmware-to-kvm-options.png
b/source/_static/images/import-vm-from-vmware-to-kvm-options.png
index 1149ea4..dd54249 100644
Binary files a/source/_static/images/import-vm-from-vmware-to-kvm-options.png
and b/source/_static/images/import-vm-from-vmware-to-kvm-options.png differ
diff --git a/source/_static/images/import-vm-from-vmware-to-kvm.png
b/source/_static/images/import-vm-from-vmware-to-kvm.png
index a3a9e2b..891c770 100644
Binary files a/source/_static/images/import-vm-from-vmware-to-kvm.png and
b/source/_static/images/import-vm-from-vmware-to-kvm.png differ
diff --git
a/source/adminguide/virtual_machines/importing_vmware_vms_into_kvm.rst
b/source/adminguide/virtual_machines/importing_vmware_vms_into_kvm.rst
index db37b71..c8d6b18 100644
--- a/source/adminguide/virtual_machines/importing_vmware_vms_into_kvm.rst
+++ b/source/adminguide/virtual_machines/importing_vmware_vms_into_kvm.rst
@@ -13,25 +13,21 @@
specific language governing permissions and limitations
under the License.
-.. note:: This functionality requires to install the **virt-v2v**
(https://www.libguestfs.org/virt-v2v.1.html) binary installed on destination
cluster hosts, as it is not a dependency of the CloudStack agent installed on
the hosts.
-
-As of CS 4.19, it is possible to select a VMware VM from an external or
existing VMware datacenter, convert it to a KVM Virtual Machine and importing
it into an existing KVM cluster.
+.. note:: This functionality requires **virt-v2v**
(https://www.libguestfs.org/virt-v2v.1.html) binary installed on destination
cluster hosts (needs to be installed manually as it's not a dependency of the
CloudStack agent during the agent installation).
Requirements on the KVM hosts
-----------------------------
-The CloudStack agent does not install the virt-v2v binary as a dependency, for
which this functionality is not supported by default. To enable this
functionality, the virt-v2v binary must be installed on the destination KVM
hosts where to import the Virtual Machines.
-
-In case virt-v2v is not installed on a KVM host attempting a Virtual Machine
conversion from VMware, the process fails.
+The CloudStack agent does not install the virt-v2v binary as a dependency. The
virt-v2v binary must be installed manually on KVM hosts, or the migration will
fail.
-The virt-v2v output is logged on the CloudStack agent logs to help
administrators tracking the progress on the Virtual Machines conversion
processes. The verbose mode for virt-v2v can be enabled by adding the following
line to /etc/cloudstack/agent/agent.properties and restart cloudstack-agent:
+The virt-v2v output (progress) is logged in the CloudStack agent logs, to help
administrators track the progress on the Instance conversion processes. The
verbose mode for virt-v2v can be enabled by adding the following line to
/etc/cloudstack/agent/agent.properties and restart cloudstack-agent:
::
virtv2v.verbose.enabled=true
-Installing virt-v2v on Ubuntu KVM hosts does not install nbdkit which is
required in the conversion of VMWare VCenter guests. To install it, please
execute:
+Installing virt-v2v on Ubuntu KVM hosts does not install nbdkit which is
required in the conversion of VMware VCenter guests. To install it, please
execute:
::
@@ -49,11 +45,11 @@ Linux Distribution Supported Versions
Alma Linux 8, 9
Red Hat Enterprise Linux 8, 9
Rocky Linux 8, 9
-Ubuntu 22.04 LTS
+Ubuntu 22.04 LTS, 24.04 LTS
======================== ========================
-Importing Windows guest VMs from VMware requires installing the virtio drivers
on the hypervisor hosts for the virt-v2v conversion.
+Importing Windows VMs from VMware requires installing the virtio drivers for
Windows on the hypervisor hosts for the virt-v2v conversion.
On (RH)EL hosts:
@@ -68,9 +64,9 @@ For Debian-based distributions:
::
- apt install virtio-win
+ apt install virtio-win (if the package is not available, then manual
steps will be required to install the virtio drivers for windows)
-The OVF tool (ovftool) must be installed on the destination KVM hosts if the
hosts should import VM files (OVF) from vCenter directly, if not management
server imports them.
+The OVF tool (ovftool) must be installed on the destination KVM hosts if the
hosts should export VM files (OVF) from vCenter. If not, the management server
exports them (the management server doesn't require ovftool installed).
Usage
-----
@@ -79,51 +75,76 @@ In the UI, Virtual Machines to import from VMware are
listed in *Tools > Import-
.. cssclass:: table-striped table-bordered table-hover
-==================== ========================
-Source Destination Hypervisor
-==================== ========================
-Migrate From VMware KVM
-==================== ========================
+====================================================
=================================
+Select Import-Export Source Hypervisor Action
+====================================================
=================================
+VMware Migrate existing
instances to KVM
+====================================================
=================================
|import-vm-from-vmware-to-kvm.png|
Selecting the Destination cluster
---------------------------------
-CloudStack administrators must select a KVM cluster to import the VMware
Virtual Machines (left side of the image above). Once a KVM cluster is
selected, the VMware Datacenter selection part is displayed (right side of the
image above).
+CloudStack administrators must select a KVM cluster to import the VMware
Virtual Machines (right side of the image above). Once a KVM cluster is
selected, the VMware Datacenter selection part is displayed.
Selecting the VM from a VMware Datacenter
-----------------------------------------
CloudStack administrators must select the Source VMware Datacenter:
- - Existing: The existing zones are listed, and for each zone CloudStack
will list if there is any VMware Datacenter associated to it. In case it is, it
can be selected
- - External: CloudStack allows listing Virtual Machines from a VMware
Datacenter that is not associated to any CloudStack zone. To do so, it needs
the vCenter IP address, the datacenter name, and username and password
credentials to log in the vCenter. You can use default datacenter name
(ha-datacenter or other) along with host credentials to import from standalone
VMware hosts (Only stopped VMs are supported).
+ - Existing: The existing zones are listed, and for each zone, CloudStack
will list if there is any VMware Datacenter associated with it. In case it is,
it can be selected.
+ - External: CloudStack allows listing Virtual Machines from a VMware
Datacenter that is not associated with any CloudStack zone. To do so, the
vCenter IP address, the datacenter name, and username and password credentials
are needed to log in to the vCenter. To import from a standalone VMware host,
you can use the default datacenter name (ha-datacenter or other) along with the
host credentials (Only stopped VMs are supported).
-Once the VMware Datacenter is selected, click on List VMware Instances to
display the list of Virtual Machines on the Datacenter. You must then select
the VMware Instance for import and click on Import Instance.
+Once the VMware Datacenter is selected, click on List VMware Instances to
display the list of Virtual Machines in the Datacenter. You must then choose
the VMware Instance for import and click on Import Instance.
Converting and importing a VMware VM
------------------------------------
-.. note:: CloudStack allows importing Running Linux Virtual Machines, but it
is generally recommended that the Virtual Machine to import is powered off and
has been gracefully shutdown before the process starts. In case a Linux VM is
imported while running, it will be converted in "crash consistent" state. For
Windows Virtual Machines, it is not possible to import them while running, it
is mandatory they are shut down gracefully so the filesystem is in a clean
state.
+.. note:: CloudStack allows importing Running Linux Virtual Machines, but it
is generally recommended that the Virtual Machine to import is powered off and
has been gracefully shut down before the process starts. In case a Linux VM is
imported while running, it will be converted in a "crash consistent" state. For
Windows Virtual Machines, it is not possible to import them while running, they
must be shut down gracefully so the filesystem is in a clean state.
.. note:: You can configure the parallel import of VM disk files on KVM host
and management server, using the global settings:
threads.on.kvm.host.to.import.vmware.vm.files and
threads.on.ms.to.import.vmware.vm.files respectively.
-In the UI to import instance, you can optionally select a KVM host and
temporary destination storage (Default is Secondary Storage, Only NFS pools are
supported) for the conversion. The conversion needs VM files (OVF) to be
imported to temporary destination storage, the KVM host used for conversion can
import them if the ovftool is installed in it, otherwise the management server
imports them. You can force the management server to import them by enabling
Force MS to import VM file(s), e [...]
+In the UI import wizard, you can optionally select a KVM host and temporary
destination storage (default is Secondary Storage, but if using Primary Storage
- only NFS pools are supported) for the conversion, where VM files (OVF) will
be copied to. This can be done by a random (or explicitly chosen) KVM host (if
the ovftools are installed), otherwise, the management server will export/copy
the VM files (optionally, you can force this action to be done by the
management server even the KVM [...]
|import-vm-from-vmware-to-kvm-options.png|
-When importing a Virtual Machine from VMware to KVM, CloudStack performs the
following actions:
-
- - Clones the Source Virtual Machine on the selected VMware Datacenter for
running VMs: The source Virtual Machine will be cloned in the original state
for running VMs. The recommended state is the stopped state to prevent data
inconsistencies or loss when cloning the virtual machine.
- - Imports the VM files (OVF) of the Cloned Virtual Machine for running
VMs, Source Virtual Machine for stopped VMs to a temporary storage location
(which can be selected by the administrator) from KVM host if ovftool installed
or management server (can be forced by the administrator).
- - Converts the OVF on the temporary storage location to KVM using
virt-v2v: CloudStack (or the administrator) selects a running and enabled KVM
host to perform the conversion from VMware to KVM using **virt-v2v**. If the
binary is not installed, then the host will fail the migration. In case it is
installed, it will perform the conversion into the temporary location to store
the converted QCOW2 disks of the virtual machine. The disks are then moved into
the destination storage pools [...]
-
-.. note:: Please consider not restarting the management servers while
importing as it will lead to the interruption of the process and you will need
to start again.
+When importing an instance from VMware to KVM, CloudStack performs the
following actions:
+
+ - Export the VM files (OVF) of the instance to a temporary storage location
+ (which can be selected by the administrator). The export is performed by
a
+ KVM host if ovftool is installed or management server (can be forced by
the
+ administrator, doesn't need ovftool installed on the management server).
+ The existence of ovftool on KVM host is checked using
+ ``ovftool --version`` command.
+
+ - If the instance on VMware is in **running** state, we clone the
instance on
+ VMware and use the new cloned instance to export OVF files.
+ The cloning process may take some time to complete and is used to
ensure data consistency,
+ disk consolidation, etc.
+ - If the instance on VMware is in **stopped** state, we directly use the
+ instance to export its OVF files.
+ - Converts the OVF on the temporary storage location to KVM using
+ **virt-v2v**. CloudStack (or the administrator) selects a running and
+ enabled KVM host to perform the conversion (of the previously exported
OVF files) from VMware to KVM using
+ **virt-v2v**. If the binary is not installed, then the host will fail to
convert the Instance.
+ In case it is installed, it will perform the conversion into
+ the temporary location to store the converted QCOW2 disks of the
instance.
+ The virt-v2v conversion is a long-lasting process which can be set to
+ time out by the global setting
``convert.vmware.instance.to.kvm.timeout``.
+ The conversion process takes a long time because virt-v2v creates a
+ temporary instance to inspect the source VM and generate the converted
+ disks with the correct drivers. Additionally, it needs to copy the
+ converted disks into the temporary location.
+ - The converted instance (i.e. QCOW2 files) is then imported into the
chosen KVM cluster.
+ Administrator can choose the KVM host to perform the import or let
CloudStack choose it. Only enabled
+ cluster and enabled hosts are considered.
+
+.. note:: Please do not restart the management servers while migration is in
progress as it will lead to the interruption of the process and you will need
to start again.
.. note:: As mentioned above, the migration/conversion process uses an
external tool, virt-v2v, which supports most but not all the operating systems
out there (this is true for both the host on which the virt-v2v tool is running
as well as the guest OS of the instances being migrated by the tool). Thus, the
success of the import process will, almost exclusively, depend on the success
of the virt-v2v conversion. In other words, the success will vary based on
factors such as the current O [...]
-.. note:: The resulting imported VM uses the default Guest OS: CentOS 4.5
(32-bit). After importing the VM, please Edit the Instance to change the Guest
OS Type accordingly.
+.. note:: The resulting imported VM uses the default Guest OS type: **CentOS
4.5 (32-bit)**. After importing the VM, please Edit the Instance to change the
Guest OS Type accordingly.
.. |import-vm-from-vmware-to-kvm.png| image::
/_static/images/import-vm-from-vmware-to-kvm.png
:alt: Import VMware Virtual Machines into KVM.
