* doc/*: started to augment and update the documentation

Daniel

ChangeLog

@@ -1,3 +1,7 @@
+Sun Jan 22 17:26:20 CET 2006 Daniel Veillard <veillard@redhat.com>
+
+	* doc/*: started to augment and update the documentation
+
 Sat Jan 21 23:33:46 GMT 2006 Daniel Veillard <veillard@redhat.com>
 
 	* doc//*: mostly finished the revamp in the plane, starts to look good

docs/architecture.html

@@ -8,14 +8,15 @@ kernels, the drivers and the xen daemon. Xend, the xen daemon, also runs in
 Domain0 and supervise the control and execution of the sets of domains. The
 hypervisor, drivers, kernels and daemons communicate though a shared system
 bus implemented in the hypervisor. The figure below tries to provide a view
-of this environment: </p><img src="architecture.gif" alt="The Xen architecture" /><p>The library can be initialized in 2 ways depending on the level of
+of this environment:</p><img src="architecture.gif" alt="The Xen architecture" /><p>The library can be initialized in 2 ways depending on the level of
 priviledge of the embedding program. If it runs with root access,
-virConnectOpen() can be used, it will use a read/write connection to the Xen
+virConnectOpen() can be used, it will use three different ways to connect to
-Store and use Xen Hypervisor calls when possible. If it runs without root
+the Xen infrastructure:</p><ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li>
-access virConnectOpenReadOnly() should be used, it will try to open the
+  <li>a read/write connection to the Xen Store</li>
-read-only socket <code>/var/run/xenstored/socket_ro</code> to connect to the
+  <li>use Xen Hypervisor calls</li>
-Xen Store. In this case use of hypervisor calls and write to the Xen Store
+</ul><p> If it runs without root access virConnectOpenReadOnly() should be used,
-will not be possible, restraining the amount of APIs available and slowing
+it will try to open the read-only socket
-down information gathering about domains. We expect libvir will also conmnect
+<code>/var/run/xenstored/socket_ro</code> to connect to the Xen Store and
-to the Xend daemon for some of the domain control operations, though this is
+also try to use the RPC to the Xen daemon. In this case use of hypervisor
-not the case in the 0.0.1 initial version.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+calls and write to the Xen Store will not be possible, restraining the amount
+of APIs available and slowing down information gathering about domains. </p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>

docs/index.html

@@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
+  <head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
     <link rel="stylesheet" type="text/css" href="libvir.css" />
     <title>the virtualization API</title>
   </head>

docs/intro.html

@@ -1,3 +1,24 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvir.css" /><title>Introduction</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Introduction</h1><p></p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvir.css" /><title>Introduction</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Introduction</h1><p>Libvir won't try to provide all possible interfaces for interacting with
+the virtualization features of a set of Linux (or other OS) system.</p><p>To avoid ambiguity about the terms used here here are the definitions for
+soem of the specific terms used in libvir documentation:</p><ul><li>a <strong>node</strong> is a single physical machine</li>
+  <li>an <strong>hypervisor</strong> is a layer of software allowing to
+    virtualize a node in a set of virtual machines with possibly different
+    configurations than the node itself</li>
+  <li>a <strong>domain</strong> is an instance of an operating system running
+    on a virtualized machine</li>
+</ul><p>Now we can define the goal of libvir: to provide the lowest possible
+generic layer to manage domains on a node.</p><p>This implies the following:</p><ul><li>the API should not be targetted to a single virtualization environment
+    though Xen is the current default, which also means that some very
+    specific capabilities which are not generic enough may not be provided as
+    libvir APIs</li>
+  <li>the API should allow to do efficiently and cleanly all the operations
+    needed to manage domains on a node</li>
+  <li>the API will not try to provide hight level multi-nodes management
+    features like load balancing, though they could be implemented on top of
+    libvir</li>
+</ul><p>So libvir should be a building block for higher level management tools or
+for applications focusing on virtualization on a single node (the only
+exception being domain migration between node capabilities which may need to
+be added at the libvir level)</p><p> </p><p></p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>

docs/libvir.html

@@ -13,6 +13,7 @@ site</a></h1>
 <h1 style="text-align: center">libvir</h1>
 
 <h3>what is <span class="style1">libvir?</span></h3>
+
 <p>Libvir is a C toolkit to interract with the virtualization capabilities of
 recent versions of Linux (and other OSes). It is free software available
 under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
@@ -27,12 +28,10 @@ virtualization mechanisms if needed.</p>
 
 <h2><a name="News">Releases</a></h2>
 
-<p>There is no official release yet, just CVS state and snapshot, contact the
+<p>Here is the list of official releases, however since it is early on in the
-mailing list and check the <a href="ChangeLog.html">ChangeLog</a> to gauge
+development of libvir, it is preferable when possible to just use the <a
-progresses.</p>
+href="download.html">CVS version or snapshot</a>, contact the mailing list
-<ul>
+and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progresses.</p>
-  <li>Extending the API</li>
-</ul>
 
 <h3>0.0.1: Dec 19 2005</h3>
 <ul>
@@ -43,6 +42,43 @@ progresses.</p>
 
 <h2><a name="Introducti">Introduction</a></h2>
 
+<p>Libvir won't try to provide all possible interfaces for interacting with
+the virtualization features of a set of Linux (or other OS) system.</p>
+
+<p>To avoid ambiguity about the terms used here here are the definitions for
+soem of the specific terms used in libvir documentation:</p>
+<ul>
+  <li>a <strong>node</strong> is a single physical machine</li>
+  <li>an <strong>hypervisor</strong> is a layer of software allowing to
+    virtualize a node in a set of virtual machines with possibly different
+    configurations than the node itself</li>
+  <li>a <strong>domain</strong> is an instance of an operating system running
+    on a virtualized machine</li>
+</ul>
+
+<p>Now we can define the goal of libvir: to provide the lowest possible
+generic layer to manage domains on a node.</p>
+
+<p>This implies the following:</p>
+<ul>
+  <li>the API should not be targetted to a single virtualization environment
+    though Xen is the current default, which also means that some very
+    specific capabilities which are not generic enough may not be provided as
+    libvir APIs</li>
+  <li>the API should allow to do efficiently and cleanly all the operations
+    needed to manage domains on a node</li>
+  <li>the API will not try to provide hight level multi-nodes management
+    features like load balancing, though they could be implemented on top of
+    libvir</li>
+</ul>
+
+<p>So libvir should be a building block for higher level management tools or
+for applications focusing on virtualization on a single node (the only
+exception being domain migration between node capabilities which may need to
+be added at the libvir level)</p>
+
+<p> </p>
+
 <p></p>
 
 <h2><a name="architecture">libvir architecture</a></h2>
@@ -55,20 +91,25 @@ kernels, the drivers and the xen daemon. Xend, the xen daemon, also runs in
 Domain0 and supervise the control and execution of the sets of domains. The
 hypervisor, drivers, kernels and daemons communicate though a shared system
 bus implemented in the hypervisor. The figure below tries to provide a view
-of this environment: </p>
+of this environment:</p>
 <img src="architecture.gif" alt="The Xen architecture">
 
 <p>The library can be initialized in 2 ways depending on the level of
 priviledge of the embedding program. If it runs with root access,
-virConnectOpen() can be used, it will use a read/write connection to the Xen
+virConnectOpen() can be used, it will use three different ways to connect to
-Store and use Xen Hypervisor calls when possible. If it runs without root
+the Xen infrastructure:</p>
-access virConnectOpenReadOnly() should be used, it will try to open the
+<ul>
-read-only socket <code>/var/run/xenstored/socket_ro</code> to connect to the
+  <li>a connection to the Xen Daemon though an HTTP RPC layer</li>
-Xen Store. In this case use of hypervisor calls and write to the Xen Store
+  <li>a read/write connection to the Xen Store</li>
-will not be possible, restraining the amount of APIs available and slowing
+  <li>use Xen Hypervisor calls</li>
-down information gathering about domains. We expect libvir will also conmnect
+</ul>
-to the Xend daemon for some of the domain control operations, though this is
+
-not the case in the 0.0.1 initial version.</p>
+<p> If it runs without root access virConnectOpenReadOnly() should be used,
+it will try to open the read-only socket
+<code>/var/run/xenstored/socket_ro</code> to connect to the Xen Store and
+also try to use the RPC to the Xen daemon. In this case use of hypervisor
+calls and write to the Xen Store will not be possible, restraining the amount
+of APIs available and slowing down information gathering about domains. </p>
 
 <h2><a name="Downloads">Downloads</a></h2>
 

docs/news.html

@@ -1,9 +1,8 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvir.css" /><title>Releases</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Releases</h1><p>There is no official release yet, just CVS state and snapshot, contact the
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvir.css" /><title>Releases</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Releases</h1><p>Here is the list of official releases, however since it is early on in the
-mailing list and check the <a href="ChangeLog.html">ChangeLog</a> to gauge
+development of libvir, it is preferable when possible to just use the <a href="download.html">CVS version or snapshot</a>, contact the mailing list
-progresses.</p><ul><li>Extending the API</li>
+and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progresses.</p><h3>0.0.1: Dec 19 2005</h3><ul><li>First release</li>
-</ul><h3>0.0.1: Dec 19 2005</h3><ul><li>First release</li>
   <li>Basic management of existing Xen domains</li>
   <li>Minimal autogenerated Python bindings</li>
 </ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvir architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a style="font-weight:bold" href="html/index.html">API Menu</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>