From 9c25d7a4ca19077d0547cfdb329ad4a641b4ba0a Mon Sep 17 00:00:00 2001 From: Erik Skultety Date: Tue, 21 Mar 2017 16:38:14 +0100 Subject: [PATCH] docs: Utilize our XSLT list generating template more Since we do have this template at hand, why not using it wherever possible (list of supported pool types and remote access section). Also, perform some stylistic micro adjustments. Signed-off-by: Erik Skultety --- docs/remote.html.in | 106 ++++++++++++------------------------------- docs/storage.html.in | 62 +++++-------------------- 2 files changed, 41 insertions(+), 127 deletions(-) diff --git a/docs/remote.html.in b/docs/remote.html.in index 443683d513..117ee3477f 100644 --- a/docs/remote.html.in +++ b/docs/remote.html.in @@ -7,57 +7,11 @@ Libvirt allows you to access hypervisors running on remote machines through authenticated and encrypted connections.

- -

+
    + +

    Basic usage -

    +

    On the remote machine, libvirtd should be running in general. See the section @@ -95,9 +49,9 @@ relating to failures in the remote transport itself.

  • Remote calls are handled synchronously, so they will be much slower than, say, direct hypervisor calls.
    • -

    +

    Transports -

    +

    Remote libvirt supports a range of transports:

    @@ -156,9 +110,9 @@ netcat is required on the remote side.

    The default transport, if no other is specified, is tls.

    -

    +

    Remote URIs -

    +

    See also: documentation on ordinary ("local") URIs.

    @@ -203,9 +157,9 @@ and use a different known_hosts file. Connect to a remote host using a ssh connection with the libssh driver and use a different known_hosts file. -

    +

    Extra parameters -

    +

    Extra parameters can be added to remote URIs as part of the query string (the part following ?). @@ -409,12 +363,12 @@ Note that parameter values must be Example: sshauth=privkey,agent -

    +

    Generating TLS certificates -

    -

    +

    +

    Public Key Infrastructure set up -

    +

    If you are unsure how to create TLS certificates, skip to the next section. @@ -517,9 +471,9 @@ next section.

  • For the root user, the global default locations will always be used.
    • -

    +

    Background to TLS certificates -

    +

    Libvirt supports TLS certificates for verifying the identity of the server and clients. There are two distinct checks involved: @@ -552,9 +506,9 @@ they have a valid certificate issued by the CA for their own IP address. You may want to change this to make it less (or more) permissive, depending on your needs.

    -

    +

    Setting up a Certificate Authority (CA) -

    +

    You will need the GnuTLS certtool program documented here. In Fedora, it is in the @@ -623,9 +577,9 @@ This is all that is required to set up your CA. Keep the CA's private key carefully as you will need it when you come to issue certificates for your clients and servers.

    -

    +

    Issuing server certificates -

    +

    For each server (libvirtd) you need to issue a certificate with the X.509 CommonName (CN) field set to the hostname @@ -706,9 +660,9 @@ which can be installed on the server as /etc/pki/libvirt/servercert.pem. -

    +

    Issuing client certificates -

    +

    For each client (ie. any program linked with libvirt, such as virt-manager) @@ -759,9 +713,9 @@ cp clientcert.pem /etc/pki/libvirt/clientcert.pem -

    +

    Troubleshooting TLS certificate problems -

    +
    failed to verify client's certificate
    @@ -777,9 +731,9 @@ tell you enough to diagnose the problem. to analyze the setup on the client or server machines, preferably as root. It will try to point out the possible problems and provide solutions to fix the set up up to a point where you have secure remote access.

    -

    +

    libvirtd configuration file -

    +

    Libvirtd (the remote daemon) is configured from a file called /etc/libvirt/libvirtd.conf, or specified on @@ -945,9 +899,9 @@ Blank lines and comments beginning with # are ignored. -

    +

    IPv6 support -

    +

    The libvirtd service and libvirt remote client driver both use the getaddrinfo() functions for name resolution and are @@ -958,9 +912,9 @@ address resolved for a service is reachable over IPv6, then an IPv6 connection will be made, otherwise IPv4 will be used. In summary it should just 'do the right thing(tm)'.

    -

    +

    Limitations -

    + -

    iSCSI volume pools

    +

    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 @@ -473,7 +433,7 @@ The iSCSI volume pool does not use the volume format type element.

    -

    SCSI volume pools

    +

    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 @@ -505,7 +465,7 @@ The SCSI volume pool does not use the volume format type element.

    -

    Multipath pools

    +

    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. @@ -538,7 +498,7 @@ The Multipath volume pool does not use the volume format type element.

    -

    RBD pools

    +

    RBD pool

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

    -

    Sheepdog pools

    +

    Sheepdog pool

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

    -

    Gluster pools

    +

    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 @@ -756,7 +716,7 @@ pool type.

    -

    ZFS pools

    +

    ZFS pool

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

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

    -

    Vstorage pools

    +

    Vstorage pool

    This provides a pool based on Virtuozzo storage. Virtuozzo Storage is a highly available distributed software-defined storage with built-in -- 2.47.2