This page describes the main principles and architecture choices behind the definition of the libvirt API: -
As defined in the goals section, libvirt API need to expose all the resources needed to manage the virtualization diff --git a/docs/apps.html.in b/docs/apps.html.in index 215c9b25ac..792c1457cd 100644 --- a/docs/apps.html.in +++ b/docs/apps.html.in @@ -4,19 +4,26 @@
This page provides an illustration of the wide variety of - applications using the libvirt management API. If you know - of interesting applications not listed on this page, send - a message to the mailing list - to request that it be added here. If your application uses - libvirt as its API, the following graphic is available for - your website to advertise support for libvirt: + applications using the libvirt management API. +
+ ++ To add an application not listed on this page, send a message + to the mailing list, requesting it + be added here. If your application uses libvirt as its API, + the following graphic is available for your website to advertise + support for libvirt:
Currently libvirt supports 2 kind of virtualization, and its -internal structure is based on a driver model which simplifies adding new -engines:
-+ Currently libvirt supports 2 kind of virtualization, and its + internal structure is based on a driver model which simplifies + adding new + engines: +
+ +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 kernel provides most if not all of the actual drivers used by the set of @@ -48,9 +44,9 @@ privilege access).
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. -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 between the two. In both case the libvirt API is provided by a controlling @@ -62,9 +58,9 @@ emulations models of QEmu, the selection is done when creating the new domain, by specifying the architecture and machine type targeted.
The code controlling the QEmu process is available in the
qemud/ directory.
As the previous section explains, libvirt can communicate using different channels with the current hypervisor, and should also be able to use different kind of hypervisor. To simplify the internal design, code, ease diff --git a/docs/archnetwork.html.in b/docs/archnetwork.html.in index 22e8697bc7..57b8f3dbff 100644 --- a/docs/archnetwork.html.in +++ b/docs/archnetwork.html.in @@ -1,8 +1,11 @@ +
The diagrams below illustrate some of the network configurations @@ -34,13 +37,13 @@ -
diff --git a/docs/auth.html.in b/docs/auth.html.in
index 13731eb766..2163959ef3 100644
--- a/docs/auth.html.in
+++ b/docs/auth.html.in
@@ -1,30 +1,17 @@
+
-When connecting to libvirt, some connections may require client -authentication before allowing use of the APIs. The set of possible -authentication mechanisms is administrator controlled, independent -of applications using libvirt. -
-
The libvirt daemon allows the administrator to choose the authentication
mechanisms used for client connections on each network socket independently.
@@ -35,7 +22,7 @@ currently a choice of
If libvirt does not contain support for PolicyKit, then access control for
the UNIX domain socket is done using traditional file user/group ownership
@@ -52,7 +39,7 @@ parameter. For example, setting the former to mode
If libvirt contains support for PolicyKit, then access control options are
more advanced. The
The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
@@ -123,7 +110,7 @@ again:
The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
diff --git a/docs/bugs.html.in b/docs/bugs.html.in
index fa557a8ef2..201705b452 100644
--- a/docs/bugs.html.in
+++ b/docs/bugs.html.in
@@ -4,14 +4,18 @@
The Red Hat Bugzilla Server
- should be used to report bugs and request features against libvirt.
+ should be used to report bugs and request features in libvirt.
Before submitting a ticket, check the existing tickets to see if
the bug/feature is already tracked.
If you are using official libvirt binaries from a Linux distribution
@@ -27,7 +31,7 @@
To increase the likelihood of your bug report being addressed it is
diff --git a/docs/contact.html.in b/docs/contact.html.in
index c9dceda6cb..1a9f79a46a 100644
--- a/docs/contact.html.in
+++ b/docs/contact.html.in
@@ -3,7 +3,9 @@
There are two mailing-lists:
@@ -45,7 +47,7 @@
clone.
Some of the libvirt developers may be found on IRC on the OFTC IRC
diff --git a/docs/deployment.html.in b/docs/deployment.html.in
index 94c480f9c6..8ef383b423 100644
--- a/docs/deployment.html.in
+++ b/docs/deployment.html.in
@@ -2,16 +2,18 @@
- The libvirt API is now available in all major Linux distributions
+ The libvirt API is now available in all major Linux distributions,
so the simplest deployment approach is to use your distributions'
package management software to install the
libvirt uses GNU autotools for its build system, so deployment
@@ -25,7 +27,7 @@
# make install
-
When building from GIT it is necessary to generate the autotools
diff --git a/docs/devguide.html.in b/docs/devguide.html.in
index 6c51c36f64..ba499db7d0 100644
--- a/docs/devguide.html.in
+++ b/docs/devguide.html.in
@@ -3,6 +3,8 @@
The guide is both a learning tool for developing with libvirt and an
API reference document. It is a work in progress, composed by a
@@ -16,7 +18,7 @@
contribution to the content here will do it. :)
The source is in a git repository:
diff --git a/docs/downloads.html.in b/docs/downloads.html.in
index 4b37d07b82..709bee8be1 100644
--- a/docs/downloads.html.in
+++ b/docs/downloads.html.in
@@ -3,7 +3,9 @@
The latest versions of the libvirt C library can be downloaded from:
@@ -14,7 +16,7 @@
Once an hour, an automated snapshot is made from the git server
@@ -27,7 +29,7 @@
Libvirt code source is now maintained in a git
@@ -61,7 +63,7 @@
contribution to the content here will do it. :)
PDF download is available here:
@@ -71,7 +73,7 @@
The source is also in a git repository:
@@ -89,9 +91,9 @@
libvirt uses the standard configure/make/install steps:
@@ -116,7 +118,7 @@
update your list of installed shared libs.
The libvirt build process uses GNU autotools, so after obtaining a
diff --git a/docs/drivers.html.in b/docs/drivers.html.in
index 7e31434441..b97200c872 100644
--- a/docs/drivers.html.in
+++ b/docs/drivers.html.in
@@ -2,6 +2,8 @@
The libvirt public API delegates its implementation to one or
more internal drivers, depending on the connection URI
@@ -10,21 +12,35 @@
network and storage driver active.
The hypervisor drivers currently supported by libvirt are:
none, polkit, and sasl
- UNIX socket permissions/group
+ UNIX socket permissions/group
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
unix_sock_auth parameter will default to
@@ -86,7 +73,7 @@ ResultActive=yes
Further examples of PolicyKit setup can be found on the
wiki page.
Username/password auth
+ Username/password auth
# saslpasswd2 -a libvirt -d fred
- Kerberos auth
+ Kerberos auth
Bug reporting
+
+
+
Bug Tracking
+
General libvirt bug reports
+ General libvirt bug reports
Linux Distribution specific bug reports
+ Linux Distribution specific bug reports
- How to file high quality bug reports
+ How to file high quality bug reports
Contacting the development team
- Mailing lists
+
+
+
Mailing lists
IRC discussion
+ IRC discussion
Deployment
- Pre-packaged releases
+
+
+
Pre-packaged releases
libvirt
module.
Self-built releases
+ Self-built releases
Built from GIT
+ Built from GIT
libvirt Application Development Guide
+
+
Browsable online
+ Browsable online
- GIT source repository
+ GIT source repository
Downloads
- Official Releases
+
+
+
Official Releases
Hourly development snapshots
+ Hourly development snapshots
GIT source repository
+ GIT source repository
Downloadable PDF
+ Application Development Guide PDF
GIT source repository
+ Application Development Guide source GIT repository
- libvirt Installation
+ libvirt Installation
- Compilation
+ Compiling a release tarball
Building from a source code checkout
+ Building from a GIT checkout
Internal drivers
+
+
Hypervisor drivers
+ Hypervisor drivers
-
+
+ Storage drivers
+
+