From 4e42ff6b7e1b5dc2911075a3eb7b86cd2075cfd3 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Wed, 26 Jul 2017 15:52:42 +0100 Subject: [PATCH] docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on 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 --- docs/acl.html.in | 6 +- docs/aclpolkit.html.in | 32 ++--- docs/api.html.in | 8 +- docs/api_extension.html.in | 12 +- docs/apps.html.in | 30 ++--- docs/architecture.html.in | 6 +- docs/auditlog.html.in | 38 +++--- docs/auth.html.in | 14 +- docs/bugs.html.in | 10 +- docs/cgroups.html.in | 24 ++-- docs/compiling.html.in | 6 +- docs/contact.html.in | 6 +- docs/contribute.html.in | 10 +- docs/csharp.html.in | 18 +-- docs/downloads.html.in | 12 +- docs/drivers.html.in | 4 +- docs/drvbhyve.html.in | 20 +-- docs/drvesx.html.in | 44 +++--- docs/drvhyperv.html.in | 10 +- docs/drvlxc.html.in | 52 ++++---- docs/drvnodedev.html.in | 8 +- docs/drvopenvz.html.in | 12 +- docs/drvphyp.html.in | 6 +- docs/drvqemu.html.in | 32 ++--- docs/drvuml.html.in | 2 +- docs/drvvbox.html.in | 4 +- docs/drvvirtuozzo.html.in | 6 +- docs/drvvmware.html.in | 4 +- docs/drvxen.html.in | 14 +- docs/firewall.html.in | 6 +- docs/formatcaps.html.in | 8 +- docs/formatdomain.html.in | 192 +++++++++++++-------------- docs/formatdomaincaps.html.in | 24 ++-- docs/formatnetwork.html.in | 32 ++--- docs/formatnode.html.in | 4 +- docs/formatnwfilter.html.in | 68 +++++----- docs/formatsecret.html.in | 10 +- docs/formatsnapshot.html.in | 4 +- docs/formatstorage.html.in | 28 ++-- docs/formatstorageencryption.html.in | 10 +- docs/governance.html.in | 12 +- docs/hacking.html.in | 40 +++--- docs/hooks.html.in | 30 ++--- docs/internals/command.html.in | 32 ++--- docs/internals/eventloop.html.in | 6 +- docs/internals/locking.html.in | 16 +-- docs/internals/oomtesting.html.in | 8 +- docs/internals/rpc.html.in | 42 +++--- docs/locking-lockd.html.in | 8 +- docs/locking-sanlock.html.in | 10 +- docs/locking.html.in | 2 +- docs/logging.html.in | 14 +- docs/migration.html.in | 36 ++--- docs/nss.html.in | 10 +- docs/page.xsl | 14 +- docs/remote.html.in | 28 ++-- docs/secureusage.html.in | 14 +- docs/securityprocess.html.in | 12 +- docs/storage.html.in | 26 ++-- docs/uri.html.in | 28 ++-- docs/virshcmdref.html.in | 8 +- docs/windows.html.in | 18 +-- 62 files changed, 624 insertions(+), 626 deletions(-) diff --git a/docs/acl.html.in b/docs/acl.html.in index 6d280c194d..5936c6d20b 100644 --- a/docs/acl.html.in +++ b/docs/acl.html.in @@ -12,7 +12,7 @@
    -

    Access control introduction

    +

    Access control introduction

    In a default configuration, the libvirtd daemon has three levels @@ -42,7 +42,7 @@ getattr permission.

    -

    Access control drivers

    +

    Access control drivers

    The access control framework is designed as a pluggable @@ -83,7 +83,7 @@ the libvirtd daemon be restarted.

    -

    Objects and permissions

    +

    Objects and permissions

    Libvirt applies access control to all the main object diff --git a/docs/aclpolkit.html.in b/docs/aclpolkit.html.in index 7967a0f3d4..d1f327c703 100644 --- a/docs/aclpolkit.html.in +++ b/docs/aclpolkit.html.in @@ -14,7 +14,7 @@

      -

      Introduction

      +

      Introduction

      A default install of libvirt will typically use @@ -27,7 +27,7 @@ object.

      -

      Permission names

      +

      Permission names

      The libvirt object names and permission names @@ -53,7 +53,7 @@ permissions default to deny access.

      -

      Object identity attributes

      +

      Object identity attributes

      To allow polkit authorization rules to be written to match @@ -63,7 +63,7 @@ of object being checked

      -

      virConnectPtr

      +

      virConnectPtr

      @@ -79,7 +79,7 @@
      -

      virDomainPtr

      +

      virDomainPtr

      @@ -103,7 +103,7 @@
      -

      virInterfacePtr

      +

      virInterfacePtr

      @@ -127,7 +127,7 @@
      -

      virNetworkPtr

      +

      virNetworkPtr

      @@ -151,7 +151,7 @@
      -

      virNodeDevicePtr

      +

      virNodeDevicePtr

      @@ -171,7 +171,7 @@
      -

      virNWFilterPtr

      +

      virNWFilterPtr

      @@ -195,7 +195,7 @@
      -

      virSecretPtr

      +

      virSecretPtr

      @@ -231,7 +231,7 @@
      -

      virStoragePoolPtr

      +

      virStoragePoolPtr

      @@ -255,7 +255,7 @@
      -

      virStorageVolPtr

      +

      virStorageVolPtr

      @@ -288,7 +288,7 @@
      -

      User identity attributes

      +

      User identity attributes

      At this point in time, the only attribute provided by @@ -307,7 +307,7 @@

      -

      Writing access control policies

      +

      Writing access control policies

      If using versions of polkit prior to 0.106 then it is only @@ -358,7 +358,7 @@ polkit.addRule(function(action, subject) { for a more complex example.

      -

      Example: restricting ability to connect to drivers

      +

      Example: restricting ability to connect to drivers

      Consider a local user berrange @@ -386,7 +386,7 @@ polkit.addRule(function(action, subject) { }); -

      Example: restricting access to a single domain

      +

      Example: restricting access to a single domain

      Consider a local user berrange diff --git a/docs/api.html.in b/docs/api.html.in index c38bed28c5..1cd166364b 100644 --- a/docs/api.html.in +++ b/docs/api.html.in @@ -9,7 +9,7 @@

        -

        Objects Exposed

        +

        Objects Exposed

        As defined in the goals section, the libvirt API is designed to expose all the resources needed to manage the virtualization support of recent operating systems. The first object @@ -121,7 +121,7 @@ set of nodes.

        -

        Functions and Naming Conventions

        +

        Functions and Naming Conventions

        The naming of the functions present in the library is usually composed by a prefix describing the object associated to the function and a verb describing the action on that object.

        @@ -297,7 +297,7 @@

        For more in-depth details of the storage related APIs see the storage management page.

        -

        The libvirt Drivers

        +

        The libvirt Drivers

        Drivers are the basic building block for libvirt functionality to support the capability to handle specific hypervisor driver calls. Drivers are discovered and registered during connection processing as @@ -325,7 +325,7 @@ the various functions and support found in each driver by the version support was added into libvirt.

        -

        Daemon and Remote Access

        +

        Daemon and Remote Access

        Access to libvirt drivers is primarily handled by the libvirtd daemon through the remote driver via an RPC. Some hypervisors do support diff --git a/docs/api_extension.html.in b/docs/api_extension.html.in index ac7097b918..fdc7eb2963 100644 --- a/docs/api_extension.html.in +++ b/docs/api_extension.html.in @@ -273,7 +273,7 @@

      • unlocks the remote driver.
      • -

        Implement the server side dispatcher

        +

        Implement the server side dispatcher

        Implementing the server side of the remote function call is simply a @@ -300,7 +300,7 @@

        See 0005-implement-the-remote-protocol.patch

        -

        Use the new API internally

        +

        Use the new API internally

        Sometimes, a new API serves as a superset of existing API, by @@ -314,7 +314,7 @@

        See 0006-make-old-API-trivially-wrap-to-new-API.patch

        -

        Expose the new API in virsh

        +

        Expose the new API in virsh

        All new API should be manageable from the virsh command line @@ -345,7 +345,7 @@

        See 0007-add-virsh-support.patch

        -

        Implement the driver methods

        +

        Implement the driver methods

        So, after all that, we get to the fun part. All functionality in @@ -356,7 +356,7 @@ adding.

        -

        Implement common handling

        +

        Implement common handling

        If the new API is applicable to more than one driver, it may @@ -373,7 +373,7 @@

        See 0008-support-new-xml.patch

        -

        Implement driver handling

        +

        Implement driver handling

        The remaining patches should only touch one driver at a time. diff --git a/docs/apps.html.in b/docs/apps.html.in index 44e5b644fa..760004715c 100644 --- a/docs/apps.html.in +++ b/docs/apps.html.in @@ -11,7 +11,7 @@

          -

          Add an application

          +

          Add an application

          To add an application not listed on this page, send a message @@ -30,7 +30,7 @@ libvirt powered

          -

          Client/Server applications

          +

          Client/Server applications

          Archipel
          @@ -50,7 +50,7 @@
          -

          Command line tools

          +

          Command line tools

          guestfish
          @@ -121,7 +121,7 @@
          -

          Configuration Management

          +

          Configuration Management

          LCFG
          @@ -139,7 +139,7 @@
          -

          Continuous Integration

          +

          Continuous Integration

          BuildBot
          @@ -163,7 +163,7 @@
          -

          Conversion

          +

          Conversion

          virt-p2v
          @@ -194,7 +194,7 @@
          -

          Desktop applications

          +

          Desktop applications

          virt-manager
          @@ -224,7 +224,7 @@
          -

          Infrastructure as a Service (IaaS)

          +

          Infrastructure as a Service (IaaS)

          Cracow Cloud One
          @@ -288,7 +288,7 @@
          -

          Libraries

          +

          Libraries

          libguestfs
          @@ -321,7 +321,7 @@
          -

          LiveCD / Appliances

          +

          LiveCD / Appliances

          virt-p2v
          @@ -334,7 +334,7 @@
          -

          Monitoring

          +

          Monitoring

          collectd
          @@ -381,7 +381,7 @@
          -

          Provisioning

          +

          Provisioning

          Tivoli Provisioning Manager
          @@ -415,7 +415,7 @@
          -

          Web applications

          +

          Web applications

          AbiCloud
          @@ -468,7 +468,7 @@
          -

          Mobile applications

          +

          Mobile applications

          VM Manager
          @@ -479,7 +479,7 @@
          -

          Other

          +

          Other

          Cuckoo Sandbox
          diff --git a/docs/architecture.html.in b/docs/architecture.html.in index 5d3d441ba3..33a4ccb97d 100644 --- a/docs/architecture.html.in +++ b/docs/architecture.html.in @@ -13,7 +13,7 @@
            -

            Xen support

            +

            Xen support

            When running in a Xen environment, programs using libvirt have to execute in "Domain 0", which is the primary Linux OS loaded on the machine. That OS @@ -46,7 +46,7 @@ connect to initialize the library. It will then fork a libvirt_proxy program running as root and providing read_only access to the API, this is then only useful for reporting and monitoring.

            -

            QEmu and KVM support

            +

            QEmu and KVM support

            The model for QEmu and KVM is completely similar, basically KVM is based on QEmu for the process controlling a new domain, only small details differs @@ -60,7 +60,7 @@ domain, by specifying the architecture and machine type targeted.

            The code controlling the QEmu process is available in the qemud/ directory.

            -

            Driver based architecture

            +

            Driver based architecture

            As the previous section explains, libvirt can communicate using different channels with the current hypervisor, and should also be able to use diff --git a/docs/auditlog.html.in b/docs/auditlog.html.in index 0c778aafeb..54da12b5c7 100644 --- a/docs/auditlog.html.in +++ b/docs/auditlog.html.in @@ -6,7 +6,7 @@

              -

              Introduction

              +

              Introduction

              A number of the libvirt virtualization drivers (QEMU/KVM and LXC) include @@ -17,7 +17,7 @@ the logs will usually end up in /var/log/audit/audit.log

              -

              Configuration

              +

              Configuration

              The libvirt audit integration is enabled by default on any host which has @@ -48,7 +48,7 @@ mentioned above.

              -

              Message types

              +

              Message types

              Libvirt defines three core audit message types each of which will @@ -90,7 +90,7 @@

              Result of the action, either success or failed
              -

              VIRT_CONTROL

              +

              VIRT_CONTROL

              Reports change in the lifecycle state of a virtual machine. The msg @@ -110,7 +110,7 @@

              Namespace ID of the init process in a container. Only if op=init and virt=lxc
              -

              VIRT_MACHINE_ID

              +

              VIRT_MACHINE_ID

              Reports the association of a security context with a guest. The msg @@ -126,7 +126,7 @@

              Security context for the guest disk images and other assigned host resources
              -

              VIRT_RESOURCE

              +

              VIRT_RESOURCE

              Reports the usage of a host resource by a guest. The fields include will @@ -137,7 +137,7 @@ be generated.

              -

              Virtual CPU

              +

              Virtual CPU

              The msg field will include the following sub-fields @@ -155,7 +155,7 @@ -

              Memory

              +

              Memory

              The msg field will include the following sub-fields @@ -172,7 +172,7 @@

              Updated memory size in bytes
              -

              Disk

              +

              Disk

              The msg field will include the following sub-fields

              @@ -188,7 +188,7 @@
              Updated host file or device path acting as the disk backing file
              -

              Network interface

              +

              Network interface

              The msg field will include the following sub-fields @@ -221,7 +221,7 @@

              Name of the host network interface
              -

              Filesystem

              +

              Filesystem

              The msg field will include the following sub-fields

              @@ -237,7 +237,7 @@
              Updated host directory, file or device path backing the filesystem
              -

              Host device

              +

              Host device

              The msg field will include the following sub-fields

              @@ -255,7 +255,7 @@
              The path of the character device assigned to the guest, if resrc=hostdev
              -

              TPM

              +

              TPM

              The msg field will include the following sub-fields

              @@ -269,7 +269,7 @@
              The path of the host TPM device assigned to the guest
              -

              RNG

              +

              RNG

              The msg field will include the following sub-fields

              @@ -285,7 +285,7 @@
              Updated path of the host entropy source for the RNG
              -

              console/serial/parallel/channel

              +

              console/serial/parallel/channel

              The msg field will include the following sub-fields

              @@ -301,7 +301,7 @@
              Updated path of the backing character device for given emulated device
              -

              smartcard

              +

              smartcard

              The msg field will include the following sub-fields

              @@ -321,7 +321,7 @@ -

              Redirected device

              +

              Redirected device

              The msg field will include the following sub-fields

              @@ -337,7 +337,7 @@
              The device type, only USB redir allowed
              -

              Control group

              +

              Control group

              The msg field will include the following sub-fields @@ -353,7 +353,7 @@ -

              Shared memory

              +

              Shared memory

              The msg field will include the following sub-fields

              diff --git a/docs/auth.html.in b/docs/auth.html.in index f75454416f..9c9afe7b46 100644 --- a/docs/auth.html.in +++ b/docs/auth.html.in @@ -14,7 +14,7 @@
                -

                Client configuration

                +

                Client configuration

                When connecting to a remote hypervisor which requires authentication, @@ -142,7 +142,7 @@ credentials=defgrp to storage VNC or SPICE login credentials

                -

                Server configuration

                +

                Server configuration

                The libvirt daemon allows the administrator to choose the authentication mechanisms used for client connections on each network socket independently. @@ -153,7 +153,7 @@ currently a choice of none, polkit, and sasl -

                UNIX socket permissions/group

                +

                UNIX socket permissions/group

                If libvirt does not contain support for PolicyKit, then access control for the UNIX domain socket is done using traditional file user/group ownership @@ -170,7 +170,7 @@ parameter. For example, setting the former to mode 0770 and the latter wheel would let any user in the wheel group connect to the libvirt daemon.

                -

                UNIX socket PolicyKit auth

                +

                UNIX socket PolicyKit auth

                If libvirt contains support for PolicyKit, then access control options are more advanced. The auth_unix_rw parameter will default to @@ -204,7 +204,7 @@ ResultActive=yes Further examples of PolicyKit setup can be found on the wiki page.

                -

                SASL pluggable authentication

                +

                SASL pluggable authentication

                Libvirt integrates with the cyrus-sasl library to provide a pluggable authentication @@ -255,7 +255,7 @@ GSSAPI plugin is considered acceptably secure by modern standards: TLS or UNIX socket listeners.

                -

                Username/password auth

                +

                Username/password auth

                As noted above, the DIGEST-MD5 mechanism is considered obsolete and should not be used anymore. To provide a simple username/password auth scheme on @@ -297,7 +297,7 @@ again:

                 # saslpasswd2 -a libvirt -d fred
                 
                -

                GSSAPI/Kerberos auth

                +

                GSSAPI/Kerberos auth

                The plain TCP listener of the libvirt daemon defaults to using SASL for authentication. The libvirt SASL config also defaults to GSSAPI, so there is no need to edit the diff --git a/docs/bugs.html.in b/docs/bugs.html.in index 55ceb60079..7ba8dd6a45 100644 --- a/docs/bugs.html.in +++ b/docs/bugs.html.in @@ -7,7 +7,7 @@

                  -

                  Security Issues

                  +

                  Security Issues

                  If you think that an issue with libvirt may have security @@ -19,7 +19,7 @@ security process instead.

                  -

                  Bug Tracking

                  +

                  Bug Tracking

                  If you are using libvirt binaries from a Linux distribution @@ -27,7 +27,7 @@ first.

                  -

                  General libvirt bug reports

                  +

                  General libvirt bug reports

                  The Red Hat Bugzilla Server @@ -69,7 +69,7 @@

                • New libvirt ticket
                • -

                  Linux Distribution specific bug reports

                  +

                  Linux Distribution specific bug reports

                  • If you are using binaries from Fedora, enter @@ -107,7 +107,7 @@
                  -

                  How to file high quality bug reports

                  +

                  How to file high quality bug reports

                  To increase the likelihood of your bug report being addressed it is diff --git a/docs/cgroups.html.in b/docs/cgroups.html.in index 60b47da1fc..ac6390960c 100644 --- a/docs/cgroups.html.in +++ b/docs/cgroups.html.in @@ -11,7 +11,7 @@ for applying resource management to their virtual machines and containers.

                  -

                  Required controllers

                  +

                  Required controllers

                  The control groups filesystem supports multiple "controllers". By default @@ -42,7 +42,7 @@ which use them will cease to operate.

                  -

                  Current cgroups layout

                  +

                  Current cgroups layout

                  As of libvirt 1.0.5 or later, the cgroups layout created by libvirt has been @@ -63,14 +63,14 @@ in two, one describing systemd hosts and the other non-systemd hosts.

                  -

                  Systemd cgroups integration

                  +

                  Systemd cgroups integration

                  On hosts which use systemd, each consumer maps to a systemd scope unit, while partitions map to a system slice unit.

                  -

                  Systemd scope naming

                  +

                  Systemd scope naming

                  The systemd convention is for the scope name of virtual machines / containers @@ -83,7 +83,7 @@ The scope names map directly to the cgroup directory names.

                  -

                  Systemd slice naming

                  +

                  Systemd slice naming

                  The systemd convention for slice naming is that a slice should include the @@ -96,7 +96,7 @@ by libvirt will be associated with machine.slice by default.

                  -

                  Systemd cgroup layout

                  +

                  Systemd cgroup layout

                  Given this, a possible systemd cgroups layout involving 3 qemu guests, @@ -145,7 +145,7 @@ $ROOT +- machine-lxc\x2dcontainer3.scope -

                  Non-systemd cgroups layout

                  +

                  Non-systemd cgroups layout

                  On hosts which do not use systemd, each consumer has a corresponding cgroup @@ -206,7 +206,7 @@ $ROOT +- container3.libvirt-lxc -

                  Using custom partitions

                  +

                  Using custom partitions

                  If there is a need to apply resource constraints to groups of @@ -255,7 +255,7 @@ $ROOT later in this document did not support customization per guest.

                  -

                  Creating custom partitions (systemd)

                  +

                  Creating custom partitions (systemd)

                  Given the XML config above, the admin on a systemd based host would @@ -272,7 +272,7 @@ EOF # systemctl start machine-testing.slice -

                  Creating custom partitions (non-systemd)

                  +

                  Creating custom partitions (non-systemd)

                  Given the XML config above, the admin on a non-systemd based host @@ -291,7 +291,7 @@ EOF done -

                  Resource management APIs/commands

                  +

                  Resource management APIs/commands

                  Since libvirt aims to provide an API which is portable across @@ -354,7 +354,7 @@ swap_hard_limit: unlimited network interfaces.

                  -

                  Legacy cgroups layout

                  +

                  Legacy cgroups layout

                  Prior to libvirt 1.0.5, the cgroups layout created by libvirt was different diff --git a/docs/compiling.html.in b/docs/compiling.html.in index 3a0c7fdd1b..af22199efc 100644 --- a/docs/compiling.html.in +++ b/docs/compiling.html.in @@ -2,11 +2,11 @@ -

                  libvirt Installation

                  +

                  libvirt Installation

                    -

                    Compiling a release tarball

                    +

                    Compiling a release tarball

                    libvirt uses the standard configure/make/install steps: @@ -58,7 +58,7 @@ $ sudo make install to update your list of installed shared libs.

                    -

                    Building from a GIT checkout

                    +

                    Building from a GIT checkout

                    The libvirt build process uses GNU autotools, so after obtaining a diff --git a/docs/contact.html.in b/docs/contact.html.in index 9ea16748a2..1f84527b2c 100644 --- a/docs/contact.html.in +++ b/docs/contact.html.in @@ -6,7 +6,7 @@

                      -

                      Security Issues

                      +

                      Security Issues

                      If you think that an issue with libvirt may have security @@ -18,7 +18,7 @@ security process instead.

                      -

                      Mailing lists

                      +

                      Mailing lists

                      There are three mailing-lists: @@ -95,7 +95,7 @@ page.

                      -

                      IRC discussion

                      +

                      IRC discussion

                      Some of the libvirt developers may be found on IRC on the OFTC IRC diff --git a/docs/contribute.html.in b/docs/contribute.html.in index 32935b1fa2..c169b6700e 100644 --- a/docs/contribute.html.in +++ b/docs/contribute.html.in @@ -11,7 +11,7 @@

                        -

                        Contributions required

                        +

                        Contributions required

                        The libvirt project is always looking for new contributors to @@ -97,7 +97,7 @@ these help forums. -

                        Communication

                        +

                        Communication

                        For full details on contacting other project contributors @@ -106,7 +106,7 @@ between contributors:

                        -

                        Mailing lists

                        +

                        Mailing lists

                        The project has a number of @@ -118,7 +118,7 @@ to follow the traffic.

                        -

                        Instant messaging / chat

                        +

                        Instant messaging / chat

                        Contributors to libvirt are encouraged to join the @@ -127,7 +127,7 @@ with others members.

                        -

                        Student / outreach coding programs

                        +

                        Student / outreach coding programs

                        Since 2016, the libvirt project directly participates as an diff --git a/docs/csharp.html.in b/docs/csharp.html.in index 4c35c871d2..e1c0fefba8 100644 --- a/docs/csharp.html.in +++ b/docs/csharp.html.in @@ -6,7 +6,7 @@

                          -

                          Description

                          +

                          Description

                          The C# libvirt bindings are a class library. They use a Microsoft @@ -21,7 +21,7 @@

                           

                          -

                          Requirements

                          +

                          Requirements

                          These bindings depend upon the libvirt libraries being installed. @@ -34,7 +34,7 @@

                           

                          -

                          GIT source repository

                          +

                          GIT source repository

                          The C# bindings source code is maintained in a git repository available on @@ -67,7 +67,7 @@ git clone git://libvirt.org/libvirt-csharp.git

                           

                          -

                          Usage

                          +

                          Usage

                          The libvirt C# bindings class library exposes the Libvirt @@ -118,7 +118,7 @@ git clone git://libvirt.org/libvirt-csharp.git

                           

                          -

                          Authors

                          +

                          Authors

                          The C# bindings are the work of Arnaud Champion @@ -128,7 +128,7 @@ git clone git://libvirt.org/libvirt-csharp.git

                           

                          -

                          Test Configuration

                          +

                          Test Configuration

                          Testing is performed using the following configurations: @@ -141,7 +141,7 @@ git clone git://libvirt.org/libvirt-csharp.git

                           

                          -

                          Type Coverage

                          +

                          Type Coverage

                          Coverage of the libvirt types is: @@ -219,7 +219,7 @@ git clone git://libvirt.org/libvirt-csharp.git

                           

                          -

                          Function Coverage

                          +

                          Function Coverage

                          Coverage of the libvirt functions is: diff --git a/docs/downloads.html.in b/docs/downloads.html.in index 0306945493..21d79df4e8 100644 --- a/docs/downloads.html.in +++ b/docs/downloads.html.in @@ -6,7 +6,7 @@

                            -

                            Project modules

                            +

                            Project modules

                            The libvirt project maintains a number of inter-related modules beyond @@ -435,7 +435,7 @@

                          • libvirt.org HTTPS server
                          • -

                            Hourly development snapshots

                            +

                            Hourly development snapshots

                            Once an hour, an automated snapshot is made from the git server @@ -450,7 +450,7 @@

                          • libvirt.org HTTP server
                          • -

                            Primary release schedule

                            +

                            Primary release schedule

                            The core libvirt module follows a time based plan, with releases made @@ -462,7 +462,7 @@ independant ad-hoc releases with no fixed time schedle.

                            -

                            Release numbering

                            +

                            Release numbering

                            Since libvirt 2.0.0, a time based version numbering rule @@ -497,7 +497,7 @@ digits.

                            -

                            Maintenance releases

                            +

                            Maintenance releases

                            In the git repository are several stable maintenance branches for the core library, matching the @@ -525,7 +525,7 @@ wiki page.

                            -

                            GIT source repository

                            +

                            GIT source repository

                            All modules maintained by the libvirt project have their primary diff --git a/docs/drivers.html.in b/docs/drivers.html.in index 61993861ee..79b204d1a5 100644 --- a/docs/drivers.html.in +++ b/docs/drivers.html.in @@ -18,7 +18,7 @@ network and storage driver active.

                            -

                            Hypervisor drivers

                            +

                            Hypervisor drivers

                            The hypervisor drivers currently supported by libvirt are: @@ -40,7 +40,7 @@

                          • Bhyve - The BSD Hypervisor
                          • -

                            Storage drivers

                            +

                            Storage drivers

                            -

                            Connection problems

                            +

                            Connection problems

                            There are also other causes for connection problems than the HTTPS certificate related ones. @@ -303,7 +303,7 @@ error: invalid argument in libvirt was built without the 'esx' driver -

                            Questions blocking tasks

                            +

                            Questions blocking tasks

                            Some methods of the VI API start tasks, for example PowerOnVM_Task(). Such tasks may be blocked by questions @@ -322,12 +322,12 @@ error: invalid argument in libvirt was built without the 'esx' driver

                            -

                            Specialties in the domain XML config

                            +

                            Specialties in the domain XML config

                            There are several specialties in the domain XML config for ESX domains.

                            -

                            Restrictions

                            +

                            Restrictions

                            There are some restrictions for some values of the domain XML config. The driver will complain if this restrictions are violated. @@ -347,7 +347,7 @@ error: invalid argument in libvirt was built without the 'esx' driver -

                            Datastore references

                            +

                            Datastore references

                            Storage is managed in datastores. VMware uses a special path format to reference files in a datastore. Basically, the datastore name is put @@ -366,7 +366,7 @@ error: invalid argument in libvirt was built without the 'esx' driver

                            -

                            MAC addresses

                            +

                            MAC addresses

                            VMware has registered two MAC address prefixes for domains: 00:0c:29 and 00:50:56. These prefixes are @@ -427,7 +427,7 @@ ethernet0.checkMACAddress = "false" -

                            Available hardware

                            +

                            Available hardware

                            VMware ESX supports different models of SCSI controllers and network cards. @@ -523,14 +523,14 @@ ethernet0.checkMACAddress = "false" -

                            Import and export of domain XML configs

                            +

                            Import and export of domain XML configs

                            The ESX driver currently supports a native config format known as vmware-vmx to handle VMware VMX configs.

                            -

                            Converting from VMware VMX config to domain XML config

                            +

                            Converting from VMware VMX config to domain XML config

                            The virsh domxml-from-native provides a way to convert an existing VMware VMX config into a domain XML config that can then be @@ -621,7 +621,7 @@ Enter root password for example.com: -

                            Converting from domain XML config to VMware VMX config

                            +

                            Converting from domain XML config to VMware VMX config

                            The virsh domxml-to-native provides a way to convert a domain XML config into a VMware VMX config. @@ -675,7 +675,7 @@ ethernet0.address = "00:50:56:25:48:C7" -

                            Example domain XML configs

                            +

                            Example domain XML configs

                            Fedora11 on x86_64

                            @@ -704,7 +704,7 @@ ethernet0.address = "00:50:56:25:48:C7"
                             
                            -

                            Migration

                            +

                            Migration

                            A migration cannot be initiated on an ESX server directly, a VMware vCenter is necessary for this. The vcenter query @@ -749,7 +749,7 @@ Enter administrator password for example-vcenter.com: -

                            Scheduler configuration

                            +

                            Scheduler configuration

                            The driver exposes the ESX CPU scheduler. The parameters listed below are available to control the scheduler. @@ -780,7 +780,7 @@ Enter administrator password for example-vcenter.com: -

                            VMware tools

                            +

                            VMware tools

                            Some actions require installed VMware tools. If the VMware tools are not installed in the guest and one of the actions below is to be @@ -796,7 +796,7 @@ Enter administrator password for example-vcenter.com: -

                            Links

                            +

                            Links

                            -

                            Device nodes

                            +

                            Device nodes

                            The container init process will be started with CAP_MKNOD @@ -178,7 +178,7 @@ Further block or character devices will be made available to containers depending on their configuration.

                            -

                            Security considerations

                            +

                            Security considerations

                            The libvirt LXC driver is fairly flexible in how it can be configured, @@ -190,7 +190,7 @@ isolation between a container and the host must ensure that they are writing a suitable configuration.

                            -

                            Network isolation

                            +

                            Network isolation

                            If the guest configuration does not list any network interfaces, @@ -205,7 +205,7 @@ namespace is not wanted, then applications should set the <features>....</features> element.

                            -

                            Filesystem isolation

                            +

                            Filesystem isolation

                            If the guest configuration does not list any filesystems, then @@ -250,7 +250,7 @@ a bind mount to hide them. This is particularly important for the

                            -

                            User and group isolation

                            +

                            User and group isolation

                            If the guest configuration does not list any ID mapping, then the @@ -281,7 +281,7 @@ causes libvirt to activate the user namespace feature.

                            -

                            Systemd Socket Activation Integration

                            +

                            Systemd Socket Activation Integration

                            The libvirt LXC driver provides the ability to pass across pre-opened file @@ -477,7 +477,7 @@ configured to block read/write/mknod from all devices except those that a container is authorized to use.

                            -

                            Example configurations

                            +

                            Example configurations

                            Example config version 1

                            @@ -542,7 +542,7 @@ debootstrap, whatever) under /opt/vm-1-root: </domain> -

                            Altering the available capabilities

                            +

                            Altering the available capabilities

                            By default the libvirt LXC driver drops some capabilities among which CAP_MKNOD. @@ -590,7 +590,7 @@ Note that allowing capabilities that are normally dropped by default can serious affect the security of the container and the host.

                            -

                            Inherit namespaces

                            +

                            Inherit namespaces

                            Libvirt allows you to inherit the namespace from container/process just like lxc tools @@ -615,7 +615,7 @@ ignored. The use of namespace passthrough requires libvirt >= 1.2.19

                            -

                            Container usage / management

                            +

                            Container usage / management

                            As with any libvirt virtualization driver, LXC containers can be @@ -629,7 +629,7 @@ and LXC. For further details about usage of virsh consult its manual page.

                            -

                            Defining (saving) container configuration

                            +

                            Defining (saving) container configuration

                            The virsh define command takes an XML configuration @@ -640,7 +640,7 @@ document and loads it into libvirt, saving the configuration on disk # virsh -c lxc:/// define myguest.xml -

                            Viewing container configuration

                            +

                            Viewing container configuration

                            The virsh dumpxml command can be used to view the @@ -655,7 +655,7 @@ using the --inactive flag # virsh -c lxc:/// dumpxml myguest -

                            Starting containers

                            +

                            Starting containers

                            The virsh start command can be used to start a @@ -677,7 +677,7 @@ by libvirt, using the virsh create command. -

                            Stopping containers

                            +

                            Stopping containers

                            The virsh shutdown command can be used @@ -702,7 +702,7 @@ request, it can be forcibly stopped using the virsh destroy -

                            Rebooting a container

                            +

                            Rebooting a container

                            The virsh reboot command can be used @@ -717,7 +717,7 @@ to PID 1 inside the container. # virsh -c lxc:/// reboot myguest -

                            Undefining (deleting) a container configuration

                            +

                            Undefining (deleting) a container configuration

                            The virsh undefine command can be used to delete the @@ -729,7 +729,7 @@ running, this will turn it into a "transient" guest. # virsh -c lxc:/// undefine myguest -

                            Connecting to a container console

                            +

                            Connecting to a container console

                            The virsh console command can be used to connect @@ -752,7 +752,7 @@ as 'console0', 'console1', 'console2', etc. # virsh -c lxc:/// console myguest --devname console1 -

                            Running commands in a container

                            +

                            Running commands in a container

                            The virsh lxc-enter-namespace command can be used @@ -764,7 +764,7 @@ and then execute an arbitrary command. # virsh -c lxc:/// lxc-enter-namespace myguest -- /bin/ls -al /dev -

                            Monitoring container utilization

                            +

                            Monitoring container utilization

                            The virt-top command can be used to monitor the @@ -776,7 +776,7 @@ host # virt-top -c lxc:/// -

                            Converting LXC container configuration

                            +

                            Converting LXC container configuration

                            The virsh domxml-from-native command can be used to convert diff --git a/docs/drvnodedev.html.in b/docs/drvnodedev.html.in index 26c52dd0da..439bbe7d0e 100644 --- a/docs/drvnodedev.html.in +++ b/docs/drvnodedev.html.in @@ -98,7 +98,7 @@

                            -

                            Linux process capabilities

                            +

                            Linux process capabilities

                            The libvirt QEMU driver has a build time option allowing it to use @@ -224,7 +224,7 @@ chmod o+x /path/to/directory to changing the /etc/libvirt/qemu.conf settings.

                            -

                            SELinux basic confinement

                            +

                            SELinux basic confinement

                            The basic SELinux protection for QEMU virtual machines is intended to @@ -255,7 +255,7 @@ chmod o+x /path/to/directory SELinux boolean.

                            -

                            SELinux sVirt confinement

                            +

                            SELinux sVirt confinement

                            The SELinux sVirt protection for QEMU virtual machines builds to the @@ -305,7 +305,7 @@ chmod o+x /path/to/directory file can be used to change the setting to security_driver="none"

                            -

                            AppArmor sVirt confinement

                            +

                            AppArmor sVirt confinement

                            When using basic AppArmor protection for the libvirtd daemon and @@ -373,7 +373,7 @@ chmod o+x /path/to/directory

                            -

                            Cgroups device ACLs

                            +

                            Cgroups device ACLs

                            Recent Linux kernels have a capability known as "cgroups" which is used @@ -416,7 +416,7 @@ mount -t cgroup none /dev/cgroup -o devices /dev/cgroup/libvirt/qemu/$VMNAME/

                            -

                            Import and export of libvirt domain XML configs

                            +

                            Import and export of libvirt domain XML configs

                            The QEMU driver currently supports a single native config format known as qemu-argv. The data for this format @@ -424,7 +424,7 @@ mount -t cgroup none /dev/cgroup -o devices then the QEMu binary name, finally followed by the QEMU command line arguments

                            -

                            Converting from QEMU args to domain XML

                            +

                            Converting from QEMU args to domain XML

                            The virsh domxml-from-native provides a way to @@ -473,7 +473,7 @@ $ virsh domxml-from-native qemu-argv demo.args

                            NB, don't include the literal \ in the args, put everything on one line

                            -

                            Converting from domain XML to QEMU args

                            +

                            Converting from domain XML to QEMU args

                            The virsh domxml-to-native provides a way to convert a @@ -515,7 +515,7 @@ $ virsh domxml-to-native qemu-argv demo.xml -serial none -parallel none -usb -

                            Pass-through of arbitrary qemu +

                            Pass-through of arbitrary qemu commands

                            Libvirt provides an XML namespace and an optional @@ -582,7 +582,7 @@ $ virsh domxml-to-native qemu-argv demo.xml </domain> -

                            Example domain XML config

                            +

                            Example domain XML config

                            QEMU emulated guest on x86_64

                            diff --git a/docs/drvuml.html.in b/docs/drvuml.html.in index 03c04eff41..832592024c 100644 --- a/docs/drvuml.html.in +++ b/docs/drvuml.html.in @@ -13,7 +13,7 @@ has pre-created TAP devices.

                            -

                            Project Links

                            +

                            Project Links

                            -

                            The network filter driver +

                            The network filter driver

                            This driver provides a fully configurable network filtering capability that leverages ebtables, iptables and ip6tables. This was written by diff --git a/docs/formatcaps.html.in b/docs/formatcaps.html.in index bc4511c669..d224523efe 100644 --- a/docs/formatcaps.html.in +++ b/docs/formatcaps.html.in @@ -6,7 +6,7 @@

                              -

                              Element and attribute overview

                              +

                              Element and attribute overview

                              As new virtualization engine support gets added to libvirt, and to handle cases like QEMU supporting a variety of emulations, a query @@ -28,7 +28,7 @@ the set of architectures the host can run at the moment.

                              -

                              Host capabilities

                              +

                              Host capabilities

                              The <host/> element consists of the following child elements:

                              @@ -61,7 +61,7 @@ -

                              Guest capabilities

                              +

                              Guest capabilities

                              While the previous section aims at host capabilities, this one focuses on capabilities available to a guest @@ -138,7 +138,7 @@ -

                              Examples

                              +

                              Examples

                              For example, in the case of a 64-bit machine with hardware virtualization capabilities enabled in the chip and diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 680830fbdd..a972a56ab5 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -14,7 +14,7 @@

                              -

                              Element and attribute overview

                              +

                              Element and attribute overview

                              The root element required for all virtual machines is @@ -28,7 +28,7 @@

                              -

                              General metadata

                              +

                              General metadata

                               <domain type='xen' id='3'>
                              @@ -82,14 +82,14 @@
                                       element). Since 0.9.10
                                  
                               
                              -    

                              Operating system booting

                              +

                              Operating system booting

                              There are a number of different ways to boot virtual machines each with their own pros and cons.

                              -

                              BIOS bootloader

                              +

                              BIOS bootloader

                              Booting via the BIOS is available for hypervisors supporting @@ -229,7 +229,7 @@ -

                              Host bootloader

                              +

                              Host bootloader

                              Hypervisors employing paravirtualization do not usually emulate @@ -262,7 +262,7 @@ -

                              Direct kernel boot

                              +

                              Direct kernel boot

                              When installing a new guest OS it is often useful to boot directly @@ -315,7 +315,7 @@ Since 1.3.5 (QEMU only) -

                              Container boot

                              +

                              Container boot

                              When booting a domain using container based virtualization, instead @@ -379,7 +379,7 @@

                              -

                              SMBIOS System Information

                              +

                              SMBIOS System Information

                              Some hypervisors allow control over what system information is @@ -502,7 +502,7 @@ -

                              CPU Allocation

                              +

                              CPU Allocation

                               <domain>
                              @@ -610,7 +610,7 @@
                                     
                                   
                               
                              -    

                              IOThreads Allocation

                              +

                              IOThreads Allocation

                              IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve @@ -667,7 +667,7 @@ -

                              CPU Tuning

                              +

                              CPU Tuning

                               <domain>
                              @@ -837,7 +837,7 @@
                                   
                               
                               
                              -    

                              Memory Allocation

                              +

                              Memory Allocation

                               <domain>
                              @@ -910,7 +910,7 @@
                                   
                               
                               
                              -    

                              Memory Backing

                              +

                              Memory Backing

                               <domain>
                              @@ -980,7 +980,7 @@
                                   
                               
                               
                              -    

                              Memory Tuning

                              +

                              Memory Tuning

                               <domain>
                              @@ -1044,7 +1044,7 @@
                                   
                               
                               
                              -    

                              NUMA Node Tuning

                              +

                              NUMA Node Tuning

                               <domain>
                              @@ -1105,7 +1105,7 @@
                                   
                               
                               
                              -    

                              Block I/O Tuning

                              +

                              Block I/O Tuning

                               <domain>
                                 ...
                              @@ -1174,7 +1174,7 @@
                                     
                               
                               
                              -    

                              Resource partitioning

                              +

                              Resource partitioning

                              Hypervisors may allow for virtual machines to be placed into @@ -1203,7 +1203,7 @@ in all mounted controllers. Since 1.0.5

                              -

                              CPU model and topology

                              +

                              CPU model and topology

                              Requirements for CPU model, its features and topology can be specified @@ -1532,7 +1532,7 @@ This guest NUMA specification is currently available only for QEMU/KVM.

                              -

                              Events configuration

                              +

                              Events configuration

                              It is sometimes necessary to override the default actions taken @@ -1643,7 +1643,7 @@

                              Keep the domain running as if nothing happened.
                              -

                              Power Management

                              +

                              Power Management

                              Since 0.10.2 it is possible to @@ -1667,7 +1667,7 @@ left with its default value. -

                              Hypervisor features

                              +

                              Hypervisor features

                              Hypervisors may allow certain CPU / machine features to be @@ -1869,7 +1869,7 @@ -

                              Time keeping

                              +

                              Time keeping

                              The guest clock is typically initialized from the host clock. @@ -2037,7 +2037,7 @@ -

                              Performance monitoring events

                              +

                              Performance monitoring events

                              Some platforms allow monitoring of performance of the virtual machine and @@ -2218,7 +2218,7 @@ -

                              Devices

                              +

                              Devices

                              The final set of XML elements are all used to describe devices @@ -2245,7 +2245,7 @@ -

                              Hard drives, floppy disks, CDROMs

                              +

                              Hard drives, floppy disks, CDROMs

                              Any device that looks like a disk, be it a floppy, harddisk, @@ -3185,7 +3185,7 @@ -

                              Filesystems

                              +

                              Filesystems

                              A directory on the host that can be accessed directly from the guest. @@ -3368,7 +3368,7 @@ -

                              Device Addresses

                              +

                              Device Addresses

                              Many devices have an optional <address> @@ -3485,7 +3485,7 @@ -

                              Virtio-related options

                              +

                              Virtio-related options

                              QEMU's virtio devices have some attributes related to the virtio transport under @@ -3498,7 +3498,7 @@ Since 3.5.0

                              -

                              Controllers

                              +

                              Controllers

                              Depending on the guest architecture, some device buses can @@ -3884,7 +3884,7 @@ </devices> ...

                              -

                              Device leases

                              +

                              Device leases

                              When using a lock manager, it may be desirable to record device leases @@ -3924,9 +3924,9 @@ -

                              Host device assignment

                              +

                              Host device assignment

                              -
                              USB / PCI / SCSI devices
                              +
                              USB / PCI / SCSI devices

                              USB, PCI and SCSI devices attached to the host can be passed through @@ -4237,7 +4237,7 @@ -

                              Block / character devices
                              +
                              Block / character devices

                              Block / character devices from the host can be passed through @@ -4294,7 +4294,7 @@ -

                              Redirected devices

                              +

                              Redirected devices

                              USB device redirection through a character device is @@ -4361,7 +4361,7 @@ -

                              Smartcard devices

                              +

                              Smartcard devices

                              A virtual smartcard device can be supplied to the guest via the @@ -4454,7 +4454,7 @@ smartcard, with an address of bus=0 slot=0.

                              -

                              Network interfaces

                              +

                              Network interfaces

                               ...
                              @@ -4494,7 +4494,7 @@
                                     as documented above.
                                   

                              -
                              Virtual network
                              +
                              Virtual network

                              @@ -4600,7 +4600,7 @@ </devices> ...

                              -
                              Bridge to LAN
                              +
                              Bridge to LAN

                              @@ -4691,7 +4691,7 @@ </devices> ...

                              -
                              Userspace SLIRP stack
                              +
                              Userspace SLIRP stack

                              Provides a virtual LAN with NAT to the outside world. The virtual @@ -4714,7 +4714,7 @@ ...

                              -
                              Generic ethernet connection
                              +
                              Generic ethernet connection

                              Provides a means for the administrator to execute an arbitrary script @@ -4738,7 +4738,7 @@ </devices> ...

                              -
                              Direct attachment to physical interface
                              +
                              Direct attachment to physical interface

                              Provides direct attachment of the virtual machine's NIC to the given @@ -4883,7 +4883,7 @@

                              -
                              PCI Passthrough
                              +
                              PCI Passthrough

                              A PCI network device (specified by the <source> element) @@ -4956,7 +4956,7 @@ ...

                              -
                              Multicast tunnel
                              +
                              Multicast tunnel

                              A multicast group is setup to represent a virtual network. Any VMs @@ -4980,7 +4980,7 @@ </devices> ...

                              -
                              TCP tunnel
                              +
                              TCP tunnel

                              A TCP client/server architecture provides a virtual network. One VM @@ -5006,7 +5006,7 @@ </devices> ... -

                              UDP unicast tunnel
                              +
                              UDP unicast tunnel

                              A UDP unicast architecture provides a virtual network which enables @@ -5030,7 +5030,7 @@ </devices> ... -

                              Setting the NIC model
                              +
                              Setting the NIC model
                               ...
                              @@ -5065,7 +5065,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
                                   

                              -
                              Setting NIC driver-specific options
                              +
                              Setting NIC driver-specific options
                               ...
                              @@ -5253,7 +5253,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     
                                   
                               
                              -    
                              Setting network backend-specific options
                              +
                              Setting network backend-specific options
                               ...
                              @@ -5284,7 +5284,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     adjust the size of send buffer in the host. Since
                                     0.8.8
                                   

                              -
                              Overriding the target element
                              +
                              Overriding the target element
                               ...
                              @@ -5322,7 +5322,7 @@ qemu-kvm -net nic,model=? /dev/null
                               </devices>
                               ...
                              -
                              Specifying boot order
                              +
                              Specifying boot order
                               ...
                              @@ -5345,7 +5345,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     Since 0.8.8
                                   

                              -
                              Interface ROM BIOS configuration
                              +
                              Interface ROM BIOS configuration
                               ...
                              @@ -5374,7 +5374,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     network device.
                                     Since 0.9.10 (QEMU and KVM only).
                                   

                              -
                              Setting up a network backend in a driver domain
                              +
                              Setting up a network backend in a driver domain
                               ...
                               <devices>
                              @@ -5398,7 +5398,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     Since 1.2.13 (Xen only)
                                   

                              -
                              Quality of service
                              +
                              Quality of service
                               ...
                              @@ -5422,7 +5422,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     the Network XML.
                                   

                              -
                              Setting VLAN tag (on supported network types only)
                              +
                              Setting VLAN tag (on supported network types only)
                               ...
                              @@ -5490,7 +5490,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     traffic for that VLAN will be tagged.
                                   

                              -
                              Modifying virtual link state
                              +
                              Modifying virtual link state
                               ...
                               <devices>
                              @@ -5511,7 +5511,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     Since 0.9.5
                                   

                              -
                              MTU configuration
                              +
                              MTU configuration
                               ...
                               <devices>
                              @@ -5530,7 +5530,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     Since 3.1.0
                                   

                              -
                              Coalesce settings
                              +
                              Coalesce settings
                               ...
                               <devices>
                              @@ -5557,7 +5557,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     Since 3.3.0
                                   

                              -
                              IP configuration
                              +
                              IP configuration
                               ...
                               <devices>
                              @@ -5636,7 +5636,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     configure the guest side of the interface (described above).
                                   

                              -
                              vhost-user interface
                              +
                              vhost-user interface

                              Since 1.2.7 the vhost-user enables the @@ -5673,7 +5673,7 @@ qemu-kvm -net nic,model=? /dev/null <model> element is mandatory.

                              -
                              Traffic filtering with NWFilter
                              +
                              Traffic filtering with NWFilter

                              Since 0.8.0 an nwfilter profile @@ -5713,7 +5713,7 @@ qemu-kvm -net nic,model=? /dev/null

                              -

                              Input devices

                              +

                              Input devices

                              Input devices allow interaction with the graphical framebuffer @@ -5768,7 +5768,7 @@ qemu-kvm -net nic,model=? /dev/null set. (Since 3.5.0)

                              -

                              Hub devices

                              +

                              Hub devices

                              A hub is a device that expands a single port into several so @@ -5797,7 +5797,7 @@ qemu-kvm -net nic,model=? /dev/null above.

                              -

                              Graphical framebuffers

                              +

                              Graphical framebuffers

                              A graphics device allows for graphical interaction with the @@ -6095,7 +6095,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              Video devices

                              +

                              Video devices

                              A video device.

                              @@ -6210,7 +6210,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              Consoles, serial, parallel & channel devices

                              +

                              Consoles, serial, parallel & channel devices

                              A character device provides a way to interact with the virtual machine. @@ -6296,14 +6296,14 @@ qemu-kvm -net nic,model=? /dev/null slot.

                              -
                              Guest interface
                              +
                              Guest interface

                              A character device presents itself to the guest as one of the following types.

                              -
                              Parallel port
                              +
                              Parallel port
                               ...
                              @@ -6321,7 +6321,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     usually 0, 1 or 2 parallel ports.
                                   

                              -
                              Serial port
                              +
                              Serial port
                               ...
                              @@ -6350,7 +6350,7 @@ qemu-kvm -net nic,model=? /dev/null
                                     type='pci' to select desired location on the PCI bus.
                                   

                              -
                              Console
                              +
                              Console

                              The console element is used to represent interactive consoles. Depending @@ -6422,7 +6422,7 @@ qemu-kvm -net nic,model=? /dev/null only 1 console.

                              -
                              Channel
                              +
                              Channel

                              This represents a private communication channel between the host and the @@ -6514,14 +6514,14 @@ qemu-kvm -net nic,model=? /dev/null Since 0.8.8 -

                              Host interface
                              +
                              Host interface

                              A character device presents itself to the host as one of the following types.

                              -
                              Domain logfile
                              +
                              Domain logfile

                              This disables all input on the character device, and sends output @@ -6538,7 +6538,7 @@ qemu-kvm -net nic,model=? /dev/null ...

                              -
                              Device logfile
                              +
                              Device logfile

                              A file is opened and all data sent to the character @@ -6555,7 +6555,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              Virtual console
                              +
                              Virtual console

                              Connects the character device to the graphical framebuffer in @@ -6572,7 +6572,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              Null device
                              +
                              Null device

                              Connects the character device to the void. No data is ever @@ -6588,7 +6588,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              Pseudo TTY
                              +
                              Pseudo TTY

                              A Pseudo TTY is allocated using /dev/ptmx. A suitable client @@ -6613,7 +6613,7 @@ qemu-kvm -net nic,model=? /dev/null with existing syntax for <console> tags.

                              -
                              Host device proxy
                              +
                              Host device proxy

                              The character device is passed through to the underlying @@ -6633,7 +6633,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              Named pipe
                              +
                              Named pipe

                              The character device writes output to a named pipe. See pipe(7) for @@ -6650,7 +6650,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              TCP client/server
                              +
                              TCP client/server

                              The character device acts as a TCP client connecting to a @@ -6739,7 +6739,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              UDP network console
                              +
                              UDP network console

                              The character device acts as a UDP netconsole service, @@ -6757,7 +6757,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              UNIX domain socket client/server
                              +
                              UNIX domain socket client/server

                              The character device acts as a UNIX domain socket server, @@ -6774,7 +6774,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              Spice channel
                              +
                              Spice channel

                              The character device is accessible through spice connection @@ -6797,7 +6797,7 @@ qemu-kvm -net nic,model=? /dev/null </devices> ...

                              -
                              Nmdm device
                              +
                              Nmdm device

                              The nmdm device driver, available on FreeBSD, provides two @@ -6828,7 +6828,7 @@ qemu-kvm -net nic,model=? /dev/null to the guest console. Device is specified by a fully qualified path. -

                              Sound devices

                              +

                              Sound devices

                              A virtual sound card can be attached to the host via the @@ -6881,7 +6881,7 @@ qemu-kvm -net nic,model=? /dev/null slot, documented above.

                              -

                              Watchdog device

                              +

                              Watchdog device

                              A virtual hardware watchdog device can be added to the guest via @@ -6971,7 +6971,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              Memory balloon device

                              +

                              Memory balloon device

                              A virtual memory balloon device is added to all Xen and KVM/QEMU @@ -7056,7 +7056,7 @@ qemu-kvm -net nic,model=? /dev/null set. (Since 3.5.0) -

                              Random number generator device

                              +

                              Random number generator device

                              The virtual random number generator device allows the host to pass @@ -7150,7 +7150,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              TPM device

                              +

                              TPM device

                              The TPM device enables a QEMU guest to have access to TPM @@ -7210,7 +7210,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              NVRAM device

                              +

                              NVRAM device

                              nvram device is always added to pSeries guest on PPC64, and its address is allowed to be changed. Element nvram (only valid for @@ -7244,7 +7244,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              panic device

                              +

                              panic device

                              panic device enables libvirt to receive panic notification from a QEMU guest. @@ -7301,7 +7301,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              Shared memory device

                              +

                              Shared memory device

                              A shared memory device allows to share a memory region between @@ -7365,7 +7365,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              Memory devices

                              +

                              Memory devices

                              In addition to the initial memory assigned to the guest, memory devices @@ -7508,7 +7508,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              IOMMU devices

                              +

                              IOMMU devices

                              The iommu element can be used to add an IOMMU device. @@ -7588,7 +7588,7 @@ qemu-kvm -net nic,model=? /dev/null -

                              Security label

                              +

                              Security label

                              The seclabel element allows control over the @@ -7717,7 +7717,7 @@ qemu-kvm -net nic,model=? /dev/null being on a file system that lacks security labeling.

                              -

                              Key Wrap

                              +

                              Key Wrap

                              The content of the optional keywrap element specifies whether the guest will be allowed to perform the S390 cryptographic key @@ -7756,7 +7756,7 @@ qemu-kvm -net nic,model=? /dev/null

                              Note: DEA/TDEA is synonymous with DES/TDES.

                              -

                              Example configs

                              +

                              Example configs

                              Example configurations for each driver are provide on the diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in index 007cab62dc..5e63fb7cac 100644 --- a/docs/formatdomaincaps.html.in +++ b/docs/formatdomaincaps.html.in @@ -6,7 +6,7 @@

                                -

                                Overview

                                +

                                Overview

                                Sometimes, when a new domain is to be created it may come handy to know the capabilities of the hypervisor so the correct combination of devices and @@ -37,7 +37,7 @@ management application to choose an appropriate mode for a pass-through host device as well as which adapter to utilize.

                                -

                                Element and attribute overview

                                +

                                Element and attribute overview

                                A new query interface was added to the virConnect API's to retrieve the XML listing of the set of domain capabilities (Since @@ -79,7 +79,7 @@ -

                                CPU Allocation

                                +

                                CPU Allocation

                                Before any devices capability occurs, there might be a info on domain wide capabilities, e.g. virtual CPUs:

                                @@ -97,7 +97,7 @@
                                The maximum number of supported virtual CPUs
                                -

                                BIOS bootloader

                                +

                                BIOS bootloader

                                Sometimes users might want to tweak some BIOS knobs or use UEFI. For cases like that, -

                                CPU configuration

                                +

                                CPU configuration

                                The cpu element exposes options usable for configuring @@ -208,7 +208,7 @@ -

                                Devices

                                +

                                Devices

                                Another set of XML elements describe the supported devices and their @@ -240,7 +240,7 @@ support the values disk, cdrom, floppy, or lun.

                                -

                                Hard drives, floppy disks, CDROMs

                                +

                                Hard drives, floppy disks, CDROMs

                                Disk capabilities are exposed under the disk element. For instance:

                                @@ -283,7 +283,7 @@ -

                                Graphical framebuffers

                                +

                                Graphical framebuffers

                                Graphics device capabilities are exposed under the graphics element. For instance:

                                @@ -310,7 +310,7 @@ -

                                Video device

                                +

                                Video device

                                Video device capabilities are exposed under the video element. For instance:

                                @@ -339,7 +339,7 @@ -

                                Host device assignment

                                +

                                Host device assignment

                                Some host devices can be passed through to a guest (e.g. USB, PCI and SCSI). Well, only if the following is enabled:

                                @@ -401,7 +401,7 @@ element. -

                                Features

                                +

                                Features

                                One more set of XML elements describe the supported features and their capabilities. All features occur as children of the main @@ -431,7 +431,7 @@ the domain XML documentation.

                                -

                                GIC capabilities

                                +

                                GIC capabilities

                                GIC capabilities are exposed under the gic element.

                                diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in index b410dd64ee..e8e618e42e 100644 --- a/docs/formatnetwork.html.in +++ b/docs/formatnetwork.html.in @@ -13,7 +13,7 @@ relevant wiki page.

                                -

                                Element and attribute overview

                                +

                                Element and attribute overview

                                The root element required for all virtual networks is @@ -27,7 +27,7 @@ available since 0.3.0

                                -

                                General metadata

                                +

                                General metadata

                                The first elements provide basic metadata about the virtual @@ -83,7 +83,7 @@ override the setting in the network. -

                                Connectivity

                                +

                                Connectivity

                                The next set of elements control how a virtual network is @@ -514,7 +514,7 @@ -

                                Quality of service
                                +
                                Quality of service
                                 ...
                                @@ -634,7 +634,7 @@
                                         since 1.0.1.
                                       

                                -
                                Setting VLAN tag (on supported network types only)
                                +
                                Setting VLAN tag (on supported network types only)
                                 <network>
                                @@ -712,7 +712,7 @@
                                       or <interface>.
                                     

                                -
                                Portgroups
                                +
                                Portgroups
                                 ...
                                @@ -790,7 +790,7 @@
                                       setting in the portgroup.
                                     

                                -
                                Static Routes
                                +
                                Static Routes

                                Static route definitions are used to provide routing information to the virtualization host for networks which are not directly @@ -845,7 +845,7 @@ ...

                                -

                                Addressing

                                +

                                Addressing

                                The final set of elements define the addresses (IPv4 and/or @@ -1079,9 +1079,9 @@ -

                                Example configuration

                                +

                                Example configuration

                                -

                                NAT based network

                                +

                                NAT based network

                                This example is the so called "default" virtual network. It is @@ -1129,7 +1129,7 @@ </ip> </network>

                                -

                                Routed network config

                                +

                                Routed network config

                                This is a variant on the default network which routes traffic @@ -1211,7 +1211,7 @@ <route family="ipv6" address="2001:db8:ca2:8::" prefix="64" gateway="2001:db8:ca2:7::4"/> </network>

                                -

                                Isolated network config

                                +

                                Isolated network config

                                This variant provides a completely isolated private network @@ -1233,7 +1233,7 @@ <ip family="ipv6" address="2001:db8:ca2:3::1" prefix="64"/> </network>

                                -

                                Isolated IPv6 network config

                                +

                                Isolated IPv6 network config

                                This variation of an isolated network defines only IPv6. @@ -1259,7 +1259,7 @@ </ip> </network>

                                -

                                Using an existing host bridge

                                +

                                Using an existing host bridge

                                Since 0.9.4 @@ -1277,7 +1277,7 @@ <bridge name="br0"/> </network>

                                -

                                Using a macvtap "direct" connection

                                +

                                Using a macvtap "direct" connection

                                Since 0.9.4, QEMU and KVM only, requires @@ -1312,7 +1312,7 @@ </forward> </network>

                                -

                                Network config with no gateway addresses

                                +

                                Network config with no gateway addresses

                                A valid network definition can contain no IPv4 or IPv6 addresses. Such a definition diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in index 32451d5575..f82aecf3a8 100644 --- a/docs/formatnode.html.in +++ b/docs/formatnode.html.in @@ -6,7 +6,7 @@

                                  -

                                  Node Device XML

                                  +

                                  Node Device XML

                                  There are several libvirt functions, all with the @@ -340,7 +340,7 @@ -

                                  Examples

                                  +

                                  Examples

                                  The following are some example node device XML outputs:

                                  diff --git a/docs/formatnwfilter.html.in b/docs/formatnwfilter.html.in
                                  index 0d32893cb4..5eb60e12c5 100644
                                  --- a/docs/formatnwfilter.html.in
                                  +++ b/docs/formatnwfilter.html.in
                                  @@ -12,7 +12,7 @@
                                         their goals, concepts and XML format.
                                       

                                  -

                                  Goals and background

                                  +

                                  Goals and background

                                  The goal of the network filtering XML is to enable administrators @@ -43,7 +43,7 @@ (QEMU, KVM)

                                  -

                                  Concepts

                                  +

                                  Concepts

                                  The network traffic filtering subsystem enables configuration of network traffic filtering rules on individual network @@ -111,7 +111,7 @@

                                  -

                                  Filtering chains

                                  +

                                  Filtering chains

                                  Filtering rules are organized in filter chains. These chains can be thought of as having a tree structure with packet @@ -192,7 +192,7 @@ traverse the ARP chain.

                                  -

                                  Filtering chain priorities

                                  +

                                  Filtering chain priorities

                                  All chains are connected to the root chain. The order in which those chains are accessed is influenced by the priority of the @@ -236,7 +236,7 @@ node. The above example filter shows the default priority of -500 for arp chains.

                                  -

                                  Usage of variables in filters

                                  +

                                  Usage of variables in filters

                                  Two variables names have so far been reserved for usage by the @@ -374,7 +374,7 @@ DSTPORTS = [ 80, 8080 ] former notation always assumes the iterator with Id '0'.

                                  -

                                  Automatic IP address detection

                                  +

                                  Automatic IP address detection

                                  The detection of IP addresses used on a virtual machine's interface is automatically activated if the variable IP is referenced @@ -448,7 +448,7 @@ DSTPORTS = [ 80, 8080 ] </interface>

                                  -

                                  Reserved Variables

                                  +

                                  Reserved Variables

                                  The following table lists reserved variables in use by libvirt.

                                  @@ -485,7 +485,7 @@ DSTPORTS = [ 80, 8080 ] -

                                  Element and attribute overview

                                  +

                                  Element and attribute overview

                                  The root element required for all network filters is @@ -498,7 +498,7 @@ DSTPORTS = [ 80, 8080 ] ipv4, ipv6, arp and rarp.

                                  -

                                  References to other filters

                                  +

                                  References to other filters

                                  Any filter may hold references to other filters. Individual filters may be referenced multiple times in a filter tree but @@ -536,7 +536,7 @@ DSTPORTS = [ 80, 8080 ] attached.

                                  -

                                  Filter rules

                                  +

                                  Filter rules

                                  The following XML shows a simple example of a network traffic filter implementing a rule to drop traffic if @@ -618,7 +618,7 @@ DSTPORTS = [ 80, 8080 ] filtered.

                                  -

                                  Supported protocols

                                  +

                                  Supported protocols

                                  The following sections enumerate the list of protocols that are supported by the network filtering subsystem. The @@ -677,7 +677,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  MAC (Ethernet)
                                  +
                                  MAC (Ethernet)

                                  Protocol ID: mac
                                  @@ -729,7 +729,7 @@ DSTPORTS = [ 80, 8080 ] [...] -

                                  VLAN (802.1Q) +
                                  VLAN (802.1Q) (Since 0.9.8)

                                  @@ -784,7 +784,7 @@ DSTPORTS = [ 80, 8080 ] Valid Strings for encap-protocol are: arp, ipv4, ipv6

                                  -
                                  STP (Spanning Tree Protocol) +
                                  STP (Spanning Tree Protocol) (Since 0.9.8)

                                  @@ -926,7 +926,7 @@ DSTPORTS = [ 80, 8080 ] -

                                  ARP/RARP
                                  +
                                  ARP/RARP

                                  Protocol ID: arp or rarp
                                  @@ -1022,7 +1022,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  IPv4
                                  +
                                  IPv4

                                  Protocol ID: ip
                                  @@ -1118,7 +1118,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  IPv6
                                  +
                                  IPv6

                                  Protocol ID: ipv6
                                  @@ -1228,7 +1228,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  TCP/UDP/SCTP
                                  +
                                  TCP/UDP/SCTP

                                  Protocol ID: tcp, udp, sctp
                                  @@ -1344,7 +1344,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  ICMP
                                  +
                                  ICMP

                                  Protocol ID: icmp
                                  @@ -1458,7 +1458,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  IGMP, ESP, AH, UDPLITE, 'ALL'
                                  +
                                  IGMP, ESP, AH, UDPLITE, 'ALL'

                                  Protocol ID: igmp, esp, ah, udplite, all
                                  @@ -1563,7 +1563,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  TCP/UDP/SCTP over IPV6
                                  +
                                  TCP/UDP/SCTP over IPV6

                                  Protocol ID: tcp-ipv6, udp-ipv6, sctp-ipv6
                                  @@ -1679,7 +1679,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  ICMPv6
                                  +
                                  ICMPv6

                                  Protocol ID: icmpv6
                                  @@ -1779,7 +1779,7 @@ DSTPORTS = [ 80, 8080 ]

                                  -
                                  ESP, AH, UDPLITE, 'ALL' over IPv6
                                  +
                                  ESP, AH, UDPLITE, 'ALL' over IPv6

                                  Protocol ID: esp-ipv6, ah-ipv6, udplite-ipv6, all-ipv6
                                  @@ -1868,13 +1868,13 @@ DSTPORTS = [ 80, 8080 ]

                                  -

                                  Advanced Filter Configuration Topics

                                  +

                                  Advanced Filter Configuration Topics

                                  The following sections discuss advanced filter configuration topics.

                                  -

                                  Connection tracking

                                  +

                                  Connection tracking

                                  The network filtering subsystem (on Linux) makes use of the connection tracking support of iptables. This helps in enforcing the @@ -1908,7 +1908,7 @@ DSTPORTS = [ 80, 8080 ] which may or may not be desirable.

                                  -

                                  Limiting Number of Connections

                                  +

                                  Limiting Number of Connections

                                  To limit the number of connections a VM may establish, a rule must be provided that sets a limit of connections for a given @@ -1981,7 +1981,7 @@ echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout traffic behavior in relation to idle connections.

                                  -

                                  Command line tools

                                  +

                                  Command line tools

                                  The libvirt command line tool virsh has been extended with life-cycle support for network filters. All commands related @@ -1996,7 +1996,7 @@ echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout

                                • nwfilter-edit : edit a network filter given its name
                                • -

                                  Pre-existing network filters

                                  +

                                  Pre-existing network filters

                                  The following is a list of example network filters that are automatically installed with libvirt.

                                  @@ -2051,7 +2051,7 @@ echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout on top of the prevention of packet spoofing.

                                  -

                                  Writing your own filters

                                  +

                                  Writing your own filters

                                  Since libvirt only provides a couple of example networking filters, you @@ -2124,7 +2124,7 @@ echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout udp-ipv6 traffic filtering node.

                                  -

                                  Example custom filter

                                  +

                                  Example custom filter

                                  As an example we want to now build a filter that fulfills the following list of requirements: @@ -2227,7 +2227,7 @@ echo 3 > /proc/sys/net/netfilter/nf_conntrack_icmp_timeout </rule> -

                                  Second example custom filter

                                  +

                                  Second example custom filter

                                  In this example we now want to build a similar filter as in the example above, but extend the list of requirements with an @@ -2400,13 +2400,13 @@ modprobe ip_conntrack_ftp # if above is not available -

                                  Limitations

                                  +

                                  Limitations

                                  The following sections list (current) limitations of the network filtering subsystem.

                                  -

                                  VM Migration

                                  +

                                  VM Migration

                                  VM migration is only supported if the whole filter tree that is referenced by a virtual machine's top level filter @@ -2424,7 +2424,7 @@ modprobe ip_conntrack_ftp # if above is not available 0.8.1 or later in order not to lose the network traffic filters associated with an interface.

                                  -

                                  VLAN filtering on Linux

                                  +

                                  VLAN filtering on Linux

                                  VLAN (802.1Q) packets, if sent by a virtual machine, cannot be filtered with rules for protocol IDs arp, rarp, diff --git a/docs/formatsecret.html.in b/docs/formatsecret.html.in index 21b93397c8..86b8de5b97 100644 --- a/docs/formatsecret.html.in +++ b/docs/formatsecret.html.in @@ -6,7 +6,7 @@

                                    -

                                    Secret XML

                                    +

                                    Secret XML

                                    Secrets stored by libvirt may have attributes associated with them, using @@ -47,7 +47,7 @@ -

                                    Usage type "volume"

                                    +

                                    Usage type "volume"

                                    This secret is associated with a volume, whether the format is either @@ -120,7 +120,7 @@ Secret value set # -

                                    Usage type "ceph"

                                    +

                                    Usage type "ceph"

                                    This secret is associated with a Ceph RBD (rados block device). The <usage type='ceph'> element must contain @@ -187,7 +187,7 @@ Secret value set </auth> -

                                    Usage type "iscsi"

                                    +

                                    Usage type "iscsi"

                                    This secret is associated with an iSCSI target for CHAP authentication. @@ -272,7 +272,7 @@ Secret value set </auth> -

                                    Usage type "tls"

                                    +

                                    Usage type "tls"

                                    This secret may be used in order to provide the passphrase for the diff --git a/docs/formatsnapshot.html.in b/docs/formatsnapshot.html.in index 5e8e21c8a7..52682646b7 100644 --- a/docs/formatsnapshot.html.in +++ b/docs/formatsnapshot.html.in @@ -6,7 +6,7 @@

                                      -

                                      Snapshot XML

                                      +

                                      Snapshot XML

                                      There are several types of snapshots: @@ -243,7 +243,7 @@ -

                                      Examples

                                      +

                                      Examples

                                      Using this XML to create a disk snapshot of just vda on a qemu domain with two disks:

                                      diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 27578e8a0f..8187cb1d06 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -6,7 +6,7 @@
                                        -

                                        Storage pool XML

                                        +

                                        Storage pool XML

                                        Although all storage pool backends share the same public APIs and @@ -29,7 +29,7 @@ 3.1.0). This corresponds to the storage backend drivers listed further along in this document.

                                        -

                                        General metadata

                                        +

                                        General metadata

                                         <pool type="iscsi">
                                        @@ -66,7 +66,7 @@
                                                 pool. Since 0.4.1
                                             
                                         
                                        -    

                                        Source elements

                                        +

                                        Source elements

                                        A single source element is contained within the top level @@ -397,7 +397,7 @@ is backend specific. Since 0.8.4 -

                                        Target elements

                                        +

                                        Target elements

                                        A single target element is contained within the top level @@ -461,7 +461,7 @@ -

                                        Device extents

                                        +

                                        Device extents

                                        If a storage pool exposes information about its underlying @@ -481,7 +481,7 @@ device, measured in bytes. Since 0.4.1

                                        -

                                        Storage volume XML

                                        +

                                        Storage volume XML

                                        A storage volume will generally be either a file or a device node; since 1.2.0, an optional @@ -491,7 +491,7 @@ XML format is available since 0.4.1

                                        -

                                        General metadata

                                        +

                                        General metadata

                                         <volume type='file'>
                                        @@ -570,7 +570,7 @@
                                                 on the local host. Since 0.4.1
                                             
                                         
                                        -    

                                        Target elements

                                        +

                                        Target elements

                                        A single target element is contained within the top level @@ -686,7 +686,7 @@ -

                                        Backing store elements

                                        +

                                        Backing store elements

                                        A single backingStore element is contained within the top level @@ -732,14 +732,14 @@ -

                                        Example configuration

                                        +

                                        Example configuration

                                        Here are a couple of examples, for a more complete set demonstrating every type of storage pool, consult the storage driver page

                                        -

                                        File based storage pool

                                        +

                                        File based storage pool

                                         <pool type="dir">
                                        @@ -749,7 +749,7 @@
                                           </target>
                                         </pool>
                                        -

                                        iSCSI based storage pool

                                        +

                                        iSCSI based storage pool

                                         <pool type="iscsi">
                                        @@ -766,7 +766,7 @@
                                           </target>
                                         </pool>
                                        -

                                        Storage volume

                                        +

                                        Storage volume

                                         <volume>
                                        @@ -784,7 +784,7 @@
                                           </target>
                                         </volume>
                                        -

                                        Storage volume using LUKS

                                        +

                                        Storage volume using LUKS

                                         <volume>
                                        diff --git a/docs/formatstorageencryption.html.in b/docs/formatstorageencryption.html.in
                                        index ec09bc661f..ba19e268ac 100644
                                        --- a/docs/formatstorageencryption.html.in
                                        +++ b/docs/formatstorageencryption.html.in
                                        @@ -6,7 +6,7 @@
                                         
                                             
                                          -

                                          Storage volume encryption XML

                                          +

                                          Storage volume encryption XML

                                          Storage volumes may be encrypted, the XML snippet described below is used @@ -37,7 +37,7 @@ secret value at the time of volume creation, and store it using the specified uuid.

                                          -

                                          "default" format

                                          +

                                          "default" format

                                          <encryption format="default"/> can be specified only when creating a qcow volume. If the volume is successfully created, the @@ -47,7 +47,7 @@ in later operations with the volume, or when setting up a domain that uses the volume.

                                          -

                                          "qcow" format

                                          +

                                          "qcow" format

                                          The qcow format specifies that the built-in encryption support in qcow- or qcow2-formatted volume @@ -56,7 +56,7 @@ the secret element is not present during volume creation, a secret is automatically generated and attached to the volume.

                                          -

                                          "luks" format

                                          +

                                          "luks" format

                                          The luks format is specific to a luks encrypted volume and the secret is used in order to either encrypt during volume creation @@ -119,7 +119,7 @@ -

                                          Examples

                                          +

                                          Examples

                                          Here is a simple example, specifying use of the qcow format: diff --git a/docs/governance.html.in b/docs/governance.html.in index 2f04281307..81c093bbdc 100644 --- a/docs/governance.html.in +++ b/docs/governance.html.in @@ -14,7 +14,7 @@ influence, within the community.

                                          -

                                          Code of conduct

                                          +

                                          Code of conduct

                                          The libvirt project community covers people from a wide variety of @@ -49,7 +49,7 @@ from them. Playing a blame game doesn't help anyone. -

                                          Roles and responsibilities

                                          +

                                          Roles and responsibilities

                                          Users

                                          @@ -91,7 +91,7 @@ ways listed in the next section.

                                          -

                                          Contributors

                                          +

                                          Contributors

                                          The contributors are community members who have some concrete impact @@ -156,7 +156,7 @@ covered are found in the source repositories, or website in question.

                                          -

                                          Committers

                                          +

                                          Committers

                                          The committers are the subset of contributors who have direct access @@ -227,7 +227,7 @@ to retain their role as a committer.

                                          -

                                          Security team

                                          +

                                          Security team

                                          The security team consists of a subset of the project committers @@ -252,7 +252,7 @@ before disclosing a private issue.

                                          -

                                          Rough consensus

                                          +

                                          Rough consensus

                                          A core concept for governance of the project described above is diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 975ee69357..efd053d167 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -6,7 +6,7 @@

                                            -

                                            General tips for contributing patches

                                            +

                                            General tips for contributing patches

                                            1. Discuss any large changes on the mailing list first. Post patches @@ -336,7 +336,7 @@ Richard Jones' guide to working with open source projects.

                                              -

                                              Tooling

                                              +

                                              Tooling

                                              libvirt includes support for some useful development tools right in its @@ -356,7 +356,7 @@

                                            2. -

                                              Naming conventions

                                              +

                                              Naming conventions

                                              When reading libvirt code, a number of different naming conventions will @@ -450,7 +450,7 @@ -

                                              Code indentation

                                              +

                                              Code indentation

                                              Libvirt's C source code generally adheres to some basic code-formatting conventions. The existing code base is not totally consistent on this @@ -487,7 +487,7 @@ which will load the .lvimrc only when you edit libvirt code.

                                              -

                                              Code formatting (especially for new code)

                                              +

                                              Code formatting (especially for new code)

                                              With new code, we can be even more strict. @@ -523,7 +523,7 @@

                                              -

                                              Bracket spacing

                                              +

                                              Bracket spacing

                                              The keywords if, for, while, @@ -572,7 +572,7 @@ int foo(int wizz); // Good

                                            -

                                            Commas

                                            +

                                            Commas

                                            Commas should always be followed by a space or end of line, and @@ -609,7 +609,7 @@ };

                                            -

                                            Semicolons

                                            +

                                            Semicolons

                                            Semicolons should never have a space beforehand. Inside the @@ -638,7 +638,7 @@ }

                                            -

                                            Curly braces

                                            +

                                            Curly braces

                                            Omit the curly braces around an if, while, @@ -819,7 +819,7 @@ } -

                                            Preprocessor

                                            +

                                            Preprocessor

                                            Macros defined with an ALL_CAPS name should generally be assumed to be unsafe with regards to arguments with side-effects @@ -844,7 +844,7 @@ #endif -

                                            C types

                                            +

                                            C types

                                            Use the right type. @@ -919,7 +919,7 @@ it points to, or it is aliased to another pointer that is.

                                            -

                                            Low level memory management

                                            +

                                            Low level memory management

                                            Use of the malloc/free/realloc/calloc APIs is deprecated in the libvirt @@ -1013,7 +1013,7 @@ -

                                            File handling

                                            +

                                            File handling

                                            Usage of the fdopen(), close(), fclose() @@ -1059,7 +1059,7 @@ -

                                            String comparisons

                                            +

                                            String comparisons

                                            Do not use the strcmp, strncmp, etc functions directly. Instead use @@ -1109,7 +1109,7 @@ -

                                            String copying

                                            +

                                            String copying

                                            Do not use the strncpy function. According to the man page, it @@ -1169,7 +1169,7 @@ and usually considered a flaw.

                                            -

                                            Variable length string buffer

                                            +

                                            Variable length string buffer

                                            If there is a need for complex string concatenations, avoid using @@ -1202,7 +1202,7 @@ -

                                            Include files

                                            +

                                            Include files

                                            There are now quite a large number of include files, both libvirt @@ -1251,7 +1251,7 @@

                                            -

                                            Printf-style functions

                                            +

                                            Printf-style functions

                                            Whenever you add a new printf-style function, i.e., one with a format @@ -1280,7 +1280,7 @@ does for snprintf.

                                            -

                                            Use of goto

                                            +

                                            Use of goto

                                            The use of goto is not forbidden, and goto is widely used @@ -1363,7 +1363,7 @@ int foo() -

                                            Libvirt committer guidelines

                                            +

                                            Libvirt committer guidelines

                                            The AUTHORS files indicates the list of people with commit access right diff --git a/docs/hooks.html.in b/docs/hooks.html.in index 11073cb782..7a04ac198c 100644 --- a/docs/hooks.html.in +++ b/docs/hooks.html.in @@ -6,7 +6,7 @@

                                              -

                                              Custom event scripts

                                              +

                                              Custom event scripts

                                              Beginning with libvirt 0.8.0, specific events on a host system will trigger custom scripts.

                                              These custom hook scripts are executed when any of the following @@ -26,7 +26,7 @@ (since 1.2.2)

                                              -

                                              Script location

                                              +

                                              Script location

                                              The libvirt hook scripts are located in the directory $SYSCONFDIR/libvirt/hooks/.

                                              -

                                              iSCSI pool

                                              +

                                              iSCSI pool

                                              This provides a pool based on an iSCSI target. Volumes must be pre-allocated on the iSCSI server, and cannot be created via @@ -433,7 +433,7 @@ The iSCSI volume pool does not use the volume format type element.

                                              -

                                              SCSI pool

                                              +

                                              SCSI pool

                                              This provides a pool based on a SCSI HBA. Volumes are preexisting SCSI LUNs, and cannot be created via the libvirt APIs. Since /dev/XXX names @@ -465,7 +465,7 @@ The SCSI volume pool does not use the volume format type element.

                                              -

                                              Multipath pool

                                              +

                                              Multipath pool

                                              This provides a pool that contains all the multipath devices on the host. Therefore, only one Multipath pool may be configured per host. @@ -498,7 +498,7 @@ The Multipath volume pool does not use the volume format type element.

                                              -

                                              RBD pool

                                              +

                                              RBD pool

                                              This storage driver provides a pool which contains all RBD images in a RADOS pool. RBD (RADOS Block Device) is part @@ -571,7 +571,7 @@ The RBD pool does not use the volume format type element.

                                              -

                                              Sheepdog pool

                                              +

                                              Sheepdog pool

                                              This provides a pool based on a Sheepdog Cluster. Sheepdog is a distributed storage system for QEMU/KVM. @@ -630,7 +630,7 @@ The Sheepdog pool does not use the volume format type element.

                                              -

                                              Gluster pool

                                              +

                                              Gluster pool

                                              This provides a pool based on native Gluster access. Gluster is a distributed file system that can be exposed to the user via @@ -716,7 +716,7 @@ pool type.

                                              -

                                              ZFS pool

                                              +

                                              ZFS pool

                                              This provides a pool based on the ZFS filesystem. Initially it was developed for FreeBSD, and since 1.3.2 experimental support @@ -754,7 +754,7 @@

                                              The ZFS volume pool does not use the volume format type element.

                                              -

                                              Vstorage pool

                                              +

                                              Vstorage pool

                                              This provides a pool based on Virtuozzo storage. Virtuozzo Storage is a highly available distributed software-defined storage with built-in diff --git a/docs/uri.html.in b/docs/uri.html.in index 7702ccc6e6..defb9eec24 100644 --- a/docs/uri.html.in +++ b/docs/uri.html.in @@ -16,7 +16,7 @@ machine over the network. To this end, libvirt uses URIs as used on the Web and as defined in RFC 2396. This page documents libvirt URIs.

                                              -

                                              Specifying URIs to libvirt

                                              +

                                              Specifying URIs to libvirt

                                              The URI is passed as the name parameter to @@ -33,7 +33,7 @@ documents libvirt URIs. virConnectPtr conn = virConnectOpenReadOnly ("test:///default");

                                              - Configuring URI aliases + Configuring URI aliases

                                              @@ -61,7 +61,7 @@ uri_aliases = [ set, no alias lookup will be attempted.

                                              -

                                              Default URI choice

                                              +

                                              Default URI choice

                                              If the URI passed to virConnectOpen* is NULL, then libvirt will use the following @@ -75,7 +75,7 @@ logic to determine what URI to use.

                                              - Specifying URIs to virsh, virt-manager and virt-install + Specifying URIs to virsh, virt-manager and virt-install

                                              In virsh use the -c or --connect option: @@ -107,7 +107,7 @@ In virt-install use the --connect=URI option: virt-install --connect=test:///default [other options]

                                              - xen:/// URI + xen:/// URI

                                              This section describes a feature which is new in libvirt > @@ -118,7 +118,7 @@ To access a Xen hypervisor running on the local machine use the URI xen:///.

                                              - qemu:///... QEMU and KVM URIs + qemu:///... QEMU and KVM URIs

                                              To use QEMU support in libvirt you must be running the @@ -150,7 +150,7 @@ KVM guests in the guest XML as described here.

                                              - Remote URIs + Remote URIs

                                              Remote URIs are formed by taking ordinary local URIs and adding a @@ -213,7 +213,7 @@ remote URI reference and full documentation for libvirt remote support.

                                              - test:///... Test URIs + test:///... Test URIs

                                              The test driver is a dummy hypervisor for test purposes. @@ -227,10 +227,10 @@ a set of host definitions held in the named file.

                                              - Other & legacy URI formats + Other & legacy URI formats

                                              - NULL and empty string URIs + NULL and empty string URIs

                                              Libvirt allows you to pass a NULL pointer to @@ -254,7 +254,7 @@ application wishes to connect specifically to a Xen hypervisor, then for future proofing it should choose a full xen:/// URI.

                                              - File paths (xend-unix-server) + File paths (xend-unix-server)

                                              If XenD is running and configured in /etc/xen/xend-config.sxp: @@ -271,7 +271,7 @@ using a file URI such as: virsh -c ///var/run/xend/xend-socket

                                              - Legacy: http://... (xend-http-server) + Legacy: http://... (xend-http-server)

                                              If XenD is running and configured in /etc/xen/xend-config.sxp: @@ -307,7 +307,7 @@ Notes: documentation as "unix server" or "http server".

                                              - Legacy: "xen" + Legacy: "xen"

                                              Another legacy URI is to specify name as the string @@ -315,7 +315,7 @@ Another legacy URI is to specify name as the string hypervisor. However you should prefer a full xen:/// URI in all future code.

                                              - Legacy: Xen proxy + Legacy: Xen proxy

                                              Libvirt continues to support connections to a separately running Xen diff --git a/docs/virshcmdref.html.in b/docs/virshcmdref.html.in index 5503ca0dad..f7cc5ddae8 100644 --- a/docs/virshcmdref.html.in +++ b/docs/virshcmdref.html.in @@ -6,7 +6,7 @@

                                                -

                                                Description

                                                +

                                                Description

                                                The new Virsh Command Reference, for documenting the commands @@ -24,7 +24,7 @@

                                                 

                                                -

                                                Viewing Online

                                                +

                                                Viewing Online

                                                The latest version can be viewed directly online: @@ -41,7 +41,7 @@

                                                 

                                                -

                                                Downloading

                                                +

                                                Downloading

                                                The latest version of the Virsh Command Reference can be downloaded: @@ -68,7 +68,7 @@ -

                                                DocBook source GIT repository

                                                +

                                                DocBook source GIT repository

                                                The DocBook source is maintained in a git repository available on diff --git a/docs/windows.html.in b/docs/windows.html.in index a0fe533a3d..708bb1b186 100644 --- a/docs/windows.html.in +++ b/docs/windows.html.in @@ -12,7 +12,7 @@ as well but we either haven't tested or received reports for them.

                                                -

                                                Installation packages

                                                +

                                                Installation packages

                                                Users who need pre-built Windows DLLs of libvirt are advised @@ -29,7 +29,7 @@ against libvirt.

                                                -

                                                Connection types

                                                +

                                                Connection types

                                                These connection types are known to work: @@ -71,7 +71,7 @@ be used in security sensitive environments.

                                                -

                                                Connecting to VMware ESX/vSphere

                                                +

                                                Connecting to VMware ESX/vSphere

                                                Details on the capabilities, certificates, and connection string @@ -81,7 +81,7 @@ http://libvirt.org/drvesx.html -

                                                TLS Certificates

                                                +

                                                TLS Certificates

                                                TLS certificates need to have been created and placed in the correct @@ -141,21 +141,21 @@

                                              • C:\Users\someuser\AppData\Roaming\libvirt\pki\libvirt\private\clientkey.pem
                                              • -

                                                Feedback

                                                +

                                                Feedback

                                                Feedback and suggestions on changes to make and what else to include are desired.

                                                -

                                                Compiling yourself

                                                +

                                                Compiling yourself

                                                Libvirt can be compiled on Windows using the free MinGW compiler.

                                                -

                                                MSYS Build script

                                                +

                                                MSYS Build script

                                                The easiest way is to use the msys_setup script, developed by @@ -165,7 +165,7 @@ https://github.com/photron/msys_setup -

                                                Cross compiling

                                                +

                                                Cross compiling

                                                You can also cross-compile to a Windows target from a Fedora machine @@ -174,7 +174,7 @@ (which includes a working libvirt specfile).

                                                -

                                                By hand

                                                +

                                                By hand

                                                Use these options when following the instructions on the