libvirt/docs/locking.html.in

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <body>
    <h1>Virtual machine lock manager</h1>

    <ul id="toc"></ul>

    <p>
      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.
    </p>

    <h2><a id="plugins">Lock manager plugins</a></h2>

    <p>
      The lock manager framework has a pluggable architecture,
      to allow different locking technologies to be used.
    </p>

    <dl>
      <dt><code>nop</code></dt>
      <dd>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.</dd>
      <dt><code><a href="locking-lockd.html">lockd</a></code></dt>
      <dd>This is the current preferred implementation shipped
        with libvirt. It uses the <code>virtlockd</code> 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.</dd>
      <dt><code><a href="locking-sanlock.html">sanlock</a></code></dt>
      <dd>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.
      </dd>
    </dl>
  </body>
</html>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2013-05-03 14:25:37 +00:00			`<?xml version="1.0" encoding="UTF-8"?>`
docs: switch to using HTML5 doctype declaration The HTML5 doctype is simply <!DOCTYPE html> no DTD is present because HTML5 is no longer defined as an extension of SGML. XSL has no way to natively output a doctype without a public or system identifier, so we have to use an <xsl:text> hack instead. See also https://dev.w3.org/html5/html-author/#doctype-declaration Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-07-26 17:01:25 +00:00			`<!DOCTYPE html>`
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2013-05-03 14:25:37 +00:00			`<html xmlns="http://www.w3.org/1999/xhtml">`
Add documentation for configuration lock managers Add a page which documents how to configure lock managers, focusing on use of sanlock with the QEMU/KVM driver * docs/locking.html.in: Docs about lock managers * docs/sitemap.html.in: Add lock manager config to the deployment section 2011-06-24 12:50:08 +00:00			`<body>`
docs: split out sanlock setup docs In preparation for adding docs about virtlockd, split out the sanlock setup docs into a separate page. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2015-02-13 17:02:44 +00:00			`<h1>Virtual machine lock manager</h1>`
Add documentation for configuration lock managers Add a page which documents how to configure lock managers, focusing on use of sanlock with the QEMU/KVM driver * docs/locking.html.in: Docs about lock managers * docs/sitemap.html.in: Add lock manager config to the deployment section 2011-06-24 12:50:08 +00:00
			`<ul id="toc"></ul>`

			`<p>`
docs: split out sanlock setup docs In preparation for adding docs about virtlockd, split out the sanlock setup docs into a separate page. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2015-02-13 17:02:44 +00:00			`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.`
Add documentation for configuration lock managers Add a page which documents how to configure lock managers, focusing on use of sanlock with the QEMU/KVM driver * docs/locking.html.in: Docs about lock managers * docs/sitemap.html.in: Add lock manager config to the deployment section 2011-06-24 12:50:08 +00:00			`</p>`

docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-07-26 14:52:42 +00:00			`<h2><a id="plugins">Lock manager plugins</a></h2>`
Add documentation for configuration lock managers Add a page which documents how to configure lock managers, focusing on use of sanlock with the QEMU/KVM driver * docs/locking.html.in: Docs about lock managers * docs/sitemap.html.in: Add lock manager config to the deployment section 2011-06-24 12:50:08 +00:00
			`<p>`
docs: split out sanlock setup docs In preparation for adding docs about virtlockd, split out the sanlock setup docs into a separate page. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2015-02-13 17:02:44 +00:00			`The lock manager framework has a pluggable architecture,`
			`to allow different locking technologies to be used.`
			`</p>`

			`<dl>`
docs: Use <code> inside <dt> for symbols Most of the time, the <dt> tag is used when providing documentation for a symbol; enclose symbols in <code> tags to style them appropriately. 2016-04-21 13:23:56 +00:00			`<dt><code>nop</code></dt>`
docs: split out sanlock setup docs In preparation for adding docs about virtlockd, split out the sanlock setup docs into a separate page. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2015-02-13 17:02:44 +00:00			`<dd>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.</dd>`
docs: Use <code> inside <dt> for symbols Most of the time, the <dt> tag is used when providing documentation for a symbol; enclose symbols in <code> tags to style them appropriately. 2016-04-21 13:23:56 +00:00			`<dt><code><a href="locking-lockd.html">lockd</a></code></dt>`
docs: split out sanlock setup docs In preparation for adding docs about virtlockd, split out the sanlock setup docs into a separate page. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2015-02-13 17:02:44 +00:00			`<dd>This is the current preferred implementation shipped`
			`with libvirt. It uses the <code>virtlockd</code> 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.</dd>`
docs: Use <code> inside <dt> for symbols Most of the time, the <dt> tag is used when providing documentation for a symbol; enclose symbols in <code> tags to style them appropriately. 2016-04-21 13:23:56 +00:00			`<dt><code><a href="locking-sanlock.html">sanlock</a></code></dt>`
docs: split out sanlock setup docs In preparation for adding docs about virtlockd, split out the sanlock setup docs into a separate page. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2015-02-13 17:02:44 +00:00			`<dd>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.`
			`</dd>`
			`</dl>`
Add documentation for configuration lock managers Add a page which documents how to configure lock managers, focusing on use of sanlock with the QEMU/KVM driver * docs/locking.html.in: Docs about lock managers * docs/sitemap.html.in: Add lock manager config to the deployment section 2011-06-24 12:50:08 +00:00			`</body>`
			`</html>`