KVM: show live migration progress on the instance page and add transfer details to VM.MIGRATE events

Open
#14,531 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
java

Research direction

Start by tracing the KVM agent’s libvirt migration job information, the management server’s migrate work job and updateAsyncJobStatus(), the VM response API, and the instance page and VM.MIGRATE event handling. The issue describes the expected progress fields, display, and event summaries, but names no files or tests; first map the migration flow across these components. Done means progress is polled and exposed during migration, shown in the UI, and summarized in completion and error events.

Written by the indexing model from the issue text.

Description

component:api component:kvm component:UI
The required feature described as a wish
SUMMARY

During a live migration the UI only shows the instance as Migrating, so admins have to run virsh domjobinfo on the source host to see how far along it is or whether it has stalled.

This proposes showing migration progress for KVM first. The API field is hypervisor-neutral, so VMware, XenServer and others can add it later from their own task progress.

PROPOSAL
  • KVM agent: new command that returns the libvirt domain job info (disk and memory processed / remaining / total).
  • Management server: poll the source host every few seconds while the migrate work job runs, and store the result on the job with updateAsyncJobStatus().
  • API: admin-only migrationprogress on the VM response while the state is Migrating, read from the pending vm_work_job. Percent is always set and the byte/rate figures are optional, since other hypervisors only report a percentage.
  • UI: progress bar under Status on the instance page with percentage, "x of y complete", estimated time remaining and transfer rate in MB/s. When volumes migrate with the VM, disks and memory get separate bars; libvirt already splits them in the same job info (file* / mem*). Mock-up attached.
  • Events: append a summary to the VM.MIGRATE Completed event description (data transferred, duration, average rate), and on Error - a record of how far it got and a short reason (e.g. timed out and not converging, destination unreachable). Sizes, rates and reason category only. I wouldn't include host or storage names, since the event can be visible to the VM owner.

Happy to work on a PR if this approach is acceptable.

Mock-up of the UI change below:
Progress in an instance:
Image

Event - Successful:
Image

Event - Failed:
Image

Dominant language
Java
Stars
3.1k
Forks
1.4k
Avg merge
7d 4h
Merged PRs (30d)
13

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/cloudstack

All issues in apache/cloudstack

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.