From 944932bd43f4a80dfaa9aa467f43605c3c12dd64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Date: Wed, 20 Nov 2019 14:05:50 +0000 Subject: [PATCH] docs: convert kbase/locking.html.in to RST MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is a semi-automated conversion. The first conversion is done using "pandoc -f html -t rst". The result is then editted manually to apply the desired heading markup, and fix a few things that pandoc gets wrong. Reviewed-by: Michal Privoznik Signed-off-by: Daniel P. Berrangé --- docs/kbase/locking.html.in | 48 -------------------------------------- docs/kbase/locking.rst | 33 ++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 48 deletions(-) delete mode 100644 docs/kbase/locking.html.in create mode 100644 docs/kbase/locking.rst diff --git a/docs/kbase/locking.html.in b/docs/kbase/locking.html.in deleted file mode 100644 index 4532dbddf9..0000000000 --- a/docs/kbase/locking.html.in +++ /dev/null @@ -1,48 +0,0 @@ - - - - -

Virtual machine lock manager

- -
    - -

    - Libvirt includes a framework for ensuring mutual exclusion - between virtual machines using host resources. Typically - this is used to prevent two VM processes from having concurrent - write access to the same disk image, as this would result in - data corruption if the guest was not using a cluster - aware filesystem. -

    - -

    Lock manager plugins

    - -

    - The lock manager framework has a pluggable architecture, - to allow different locking technologies to be used. -

    - -
    -
    nop
    -
    This is a "no op" implementation which does absolutely - nothing. This can be used if mutual exclusion between - virtual machines is not required, or if it is being - solved at another level in the management stack.
    -
    lockd
    -
    This is the current preferred implementation shipped - with libvirt. It uses the virtlockd daemon - to manage locks using the POSIX fcntl() advisory locking - capability. As such it requires a shared filesystem of - some kind be accessible to all hosts which share the - same image storage.
    -
    sanlock
    -
    This is an alternative implementation preferred by - the oVirt project. It uses a disk paxos algorithm for - maintaining continuously renewed leases. In the default - setup it requires some shared filesystem, but it is - possible to use it in a manual mode where the management - application creates leases in SAN storage volumes. -
    -
    - - diff --git a/docs/kbase/locking.rst b/docs/kbase/locking.rst new file mode 100644 index 0000000000..c0d5e39b2d --- /dev/null +++ b/docs/kbase/locking.rst @@ -0,0 +1,33 @@ +============================ +Virtual machine lock manager +============================ + +Libvirt includes a framework for ensuring mutual exclusion between +virtual machines using host resources. Typically this is used to prevent +two VM processes from having concurrent write access to the same disk +image, as this would result in data corruption if the guest was not +using a cluster aware filesystem. + +Lock manager plugins +==================== + +The lock manager framework has a pluggable architecture, to allow +different locking technologies to be used. + +nop + This is a "no op" implementation which does absolutely nothing. This + can be used if mutual exclusion between virtual machines is not + required, or if it is being solved at another level in the management + stack. +`lockd `__ + This is the current preferred implementation shipped with libvirt. It + uses the ``virtlockd`` daemon to manage locks using the POSIX fcntl() + advisory locking capability. As such it requires a shared filesystem + of some kind be accessible to all hosts which share the same image + storage. +`sanlock `__ + This is an alternative implementation preferred by the oVirt project. + It uses a disk paxos algorithm for maintaining continuously renewed + leases. In the default setup it requires some shared filesystem, but + it is possible to use it in a manual mode where the management + application creates leases in SAN storage volumes.