From 3333cec207a4d1738925c24ce1dd7ab913c36892 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Sun, 22 Jan 2006 16:27:09 +0000 Subject: [PATCH] * doc/*: started to augment and update the documentation Daniel --- ChangeLog | 4 +++ docs/architecture.html | 21 ++++++------ docs/index.html | 3 +- docs/intro.html | 23 ++++++++++++- docs/libvir.html | 73 +++++++++++++++++++++++++++++++++--------- docs/news.html | 7 ++-- 6 files changed, 98 insertions(+), 33 deletions(-) diff --git a/ChangeLog b/ChangeLog index 8d2b2c99d2..a331566e6f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Sun Jan 22 17:26:20 CET 2006 Daniel Veillard + + * doc/*: started to augment and update the documentation + Sat Jan 21 23:33:46 GMT 2006 Daniel Veillard * doc//*: mostly finished the revamp in the plane, starts to look good diff --git a/docs/architecture.html b/docs/architecture.html index 7941ce39c2..28ea60a37f 100644 --- a/docs/architecture.html +++ b/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:

The Xen architecture

The library can be initialized in 2 ways depending on the level of +of this environment:

The Xen architecture

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 -Store and use Xen Hypervisor calls when possible. If it runs without root -access virConnectOpenReadOnly() should be used, it will try to open the -read-only socket /var/run/xenstored/socket_ro to connect to the -Xen Store. 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. We expect libvir will also conmnect -to the Xend daemon for some of the domain control operations, though this is -not the case in the 0.0.1 initial version.

main menu

related links

+virConnectOpen() can be used, it will use three different ways to connect to +the Xen infrastructure:

  • a connection to the Xen Daemon though an HTTP RPC layer
    • +
  • a read/write connection to the Xen Store
    • +
  • use Xen Hypervisor calls
    • +

If it runs without root access virConnectOpenReadOnly() should be used, +it will try to open the read-only socket +/var/run/xenstored/socket_ro 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.

main menu

related links

diff --git a/docs/index.html b/docs/index.html index 326a9333ef..12b96b000e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,8 +1,7 @@ - - + the virtualization API diff --git a/docs/intro.html b/docs/intro.html index 2bbe316470..4b4cb8cb60 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -1,3 +1,24 @@ -Introduction +Introduction

Introduction

Libvir won't try to provide all possible interfaces for interacting with +the virtualization features of a set of Linux (or other OS) system.

To avoid ambiguity about the terms used here here are the definitions for +soem of the specific terms used in libvir documentation:

  • a node is a single physical machine
    • +
  • an hypervisor is a layer of software allowing to + virtualize a node in a set of virtual machines with possibly different + configurations than the node itself
    • +
  • a domain is an instance of an operating system running + on a virtualized machine
    • +

Now we can define the goal of libvir: to provide the lowest possible +generic layer to manage domains on a node.

This implies the following:

  • 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
    • +
  • the API should allow to do efficiently and cleanly all the operations + needed to manage domains on a node
    • +
  • 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
    • +

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)

main menu

related links

diff --git a/docs/libvir.html b/docs/libvir.html index affe5d5779..48ef00d880 100644 --- a/docs/libvir.html +++ b/docs/libvir.html @@ -13,6 +13,7 @@ site

libvir

what is libvir?

+

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 GNU @@ -27,12 +28,10 @@ virtualization mechanisms if needed.

Releases

-

There is no official release yet, just CVS state and snapshot, contact the -mailing list and check the ChangeLog to gauge -progresses.

-
    -
  • Extending the API
    • -
+

Here is the list of official releases, however since it is early on in the +development of libvir, it is preferable when possible to just use the CVS version or snapshot, contact the mailing list +and check the ChangeLog to gauge progresses.

0.0.1: Dec 19 2005

    @@ -43,6 +42,43 @@ progresses.

    Introduction

    +

    Libvir won't try to provide all possible interfaces for interacting with +the virtualization features of a set of Linux (or other OS) system.

    + +

    To avoid ambiguity about the terms used here here are the definitions for +soem of the specific terms used in libvir documentation:

    +
      +
    • a node is a single physical machine
      • +
    • an hypervisor is a layer of software allowing to + virtualize a node in a set of virtual machines with possibly different + configurations than the node itself
      • +
    • a domain is an instance of an operating system running + on a virtualized machine
      • +
    + +

    Now we can define the goal of libvir: to provide the lowest possible +generic layer to manage domains on a node.

    + +

    This implies the following:

    +
      +
    • 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
      • +
    • the API should allow to do efficiently and cleanly all the operations + needed to manage domains on a node
      • +
    • 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
      • +
    + +

    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)

    + +

    +

    libvir architecture

    @@ -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:

    +of this environment:

    The Xen architecture

    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 -Store and use Xen Hypervisor calls when possible. If it runs without root -access virConnectOpenReadOnly() should be used, it will try to open the -read-only socket /var/run/xenstored/socket_ro to connect to the -Xen Store. 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. We expect libvir will also conmnect -to the Xend daemon for some of the domain control operations, though this is -not the case in the 0.0.1 initial version.

    +virConnectOpen() can be used, it will use three different ways to connect to +the Xen infrastructure:

    +
      +
    • a connection to the Xen Daemon though an HTTP RPC layer
      • +
    • a read/write connection to the Xen Store
      • +
    • use Xen Hypervisor calls
      • +
    + +

    If it runs without root access virConnectOpenReadOnly() should be used, +it will try to open the read-only socket +/var/run/xenstored/socket_ro 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.

    Downloads

    diff --git a/docs/news.html b/docs/news.html index cc90b526d6..a532da84cb 100644 --- a/docs/news.html +++ b/docs/news.html @@ -1,9 +1,8 @@ -Releases

    Releases

    There is no official release yet, just CVS state and snapshot, contact the -mailing list and check the ChangeLog to gauge -progresses.

    • Extending the API
      • -

    0.0.1: Dec 19 2005