This document gives examples of how to use the live migration support in Cloud Hypervisor:
- local migration - migrating a VM from one Cloud Hypervisor instance to another on the same machine;
- remote migration - migrating a VM between two machines;
⚠️ These examples place sockets in /tmp. This is done for simplicity and should not be done in production.
Launch the source VM (on the host machine):
$ target/release/cloud-hypervisor
--kernel ~/workloads/vmlinux \
--disk path=~/workloads/focal.raw \
--cpus boot=1 --memory size=1G,shared=on \
--cmdline "root=/dev/vda1 console=ttyS0" \
--serial tty --console off --api-socket=/tmp/api1Launch the destination VM from the same directory (on the host machine):
$ target/release/cloud-hypervisor --api-socket=/tmp/api2Get ready for receiving migration for the destination VM (on the host machine):
$ target/release/ch-remote --api-socket=/tmp/api2 receive-migration unix:/tmp/sockStart to send migration for the source VM (on the host machine):
$ target/release/ch-remote --api-socket=/tmp/api1 send-migration --local unix:/tmp/sockWhen the above commands completed, the source VM should be successfully migrated to the destination VM. Now the destination VM is running while the source VM is terminated gracefully.
In this example, we will migrate a VM from one machine (src) to
another (dst) across the network. To keep it simple, we will use a
minimal VM setup without storage.
Make sure that src and dst can reach each other via the
network. You should be able to ping each machine. Also each machine
should have an open TCP port.
You will need a kernel and initramfs for a minimal Linux system. For this example, we will use the Debian netboot image.
Place the kernel and initramfs into the same directory on both
machines. This is important for the migration to succeed. We will use
/var/images:
src $ export DEBIAN=https://ftp.debian.org/debian/dists/stable/main/installer-amd64/current/images/netboot/debian-installer/amd64
src $ mkdir -p /var/images
src $ curl $DEBIAN/linux > /var/images/linux
src $ curl $DEBIAN/initrd.gz > /var/images/initrdRepeat the above steps on the destination host.
If Unix socket is selected for migration, we can tunnel traffic through "socat".
On the receiver side, we prepare an empty VM:
dst $ cloud-hypervisor --api-socket /tmp/apiIn a different terminal, configure the VM as a migration target:
dst $ ch-remote --api-socket=/tmp/api receive-migration unix:/tmp/sockIn yet another terminal, forward TCP connections to the Unix domain socket:
dst $ socat TCP-LISTEN:{port},reuseaddr UNIX-CLIENT:/tmp/sockLet's start the VM on the source machine:
src $ cloud-hypervisor \
--serial tty --console off \
--cpus boot=2 --memory size=4G \
--kernel /var/images/linux \
--initramfs /var/images/initrd \
--cmdline "console=ttyS0" \
--api-socket /tmp/apiAfter a few seconds the VM should be up and you can interact with it.
First, we start socat:
src $ socat UNIX-LISTEN:/tmp/sock,reuseaddr TCP:{dst}:{port}Replace {dst}:{port} with the actual IP address and port of your destination host.
Then we kick-off the migration itself:
src $ ch-remote --api-socket=/tmp/api send-migration unix:/tmp/sockWhen the above commands completed, the VM should be successfully migrated to the destination machine without interrupting the workload.
If TCP socket is selected for migration, we need to consider migrating in a trusted network.
On the receiver side, we prepare an empty VM:
dst $ cloud-hypervisor --api-socket /tmp/apiIn a different terminal, prepare to receive the migration:
dst $ ch-remote --api-socket=/tmp/api receive-migration tcp:0.0.0.0:{port}Let's start the VM on the source machine:
src $ cloud-hypervisor \
--serial tty --console off \
--cpus boot=2 --memory size=4G \
--kernel /var/images/linux \
--initramfs /var/images/initrd \
--cmdline "console=ttyS0" \
--api-socket /tmp/apiAfter a few seconds the VM should be up and you can interact with it.
Initiate the Migration over TCP:
src $ ch-remote --api-socket=/tmp/api send-migration tcp:{dst}:{port}Replace {dst}:{port} with the actual IP address and port of your destination host.
After completing the above commands, the source VM will be migrated to the destination host and continue running there. The source VM instance will terminate normally. All ongoing processes and connections within the VM should remain intact after the migration.