Re: [PATCH v1 25/25] docs/kbase: introduce migrationinternals.rst

This document describes briefly how Libvirt migration internals works, complementing the info available in migration.html.in. Signed-off-by: Daniel Henrique Barboza <danielhb413(a)gmail.com&gt; --- docs/kbase/migrationinternals.rst | 174 ++++++++++++++++++++++++++++++ 1 file changed, 174 insertions(+) create mode 100644 docs/kbase/migrationinternals.rst diff --git a/docs/kbase/migrationinternals.rst b/docs/kbase/migrationinternals.rst new file mode 100644 index 0000000000..869ee99bd7 --- /dev/null +++ b/docs/kbase/migrationinternals.rst @@ -0,0 +1,174 @@ +=========================== +Libvirt migration internals +=========================== + +.. contents:: + +Migration is a multi-step operation with at least two distinct actors, +the source and the destination libvirtd daemons, and a lot of failure +points. This document describes the basic migration workflow in the +code level, as a way to complement `the base migration docs <migration.html>`_ +and help developers to get up to speed quicker with the code. + +In this document, unless stated otherwise, these conventions are followed: + +* 'user' refers to any entity that initiates a migration, regardless of being + an human using 'virsh' or a program consuming the Libvirt API; + +* 'source' refers to the source host of the migration, where the guest currently + exists; + +* 'destination' refers to the destination host of the migration. As of + Libvirt 6.5.0 local migration isn't supported, thus source and destination + refers to different hosts;