From 3afad0b2f08fe043adda4ee000786c501925883a Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Sun, 29 Jan 2006 10:56:15 +0000 Subject: [PATCH] * NEWS docs/news.xsl: added stylesheet to generate NEWS file * docs/*: updated docs preparing for the release Daniel --- ChangeLog | 5 +++++ NEWS | 26 ++++++++++++++++----- docs/FAQ.html | 9 +++++++- docs/Makefile.am | 6 ++++- docs/architecture.html | 7 +++--- docs/index.html | 6 ++--- docs/intro.html | 16 ++++++------- docs/libvir.html | 51 +++++++++++++++++++++++++++++------------- docs/news.html | 9 +++++++- docs/news.xsl | 46 +++++++++++++++++++++++++++++++++++++ 10 files changed, 143 insertions(+), 38 deletions(-) create mode 100644 docs/news.xsl diff --git a/ChangeLog b/ChangeLog index 3e8f808099..53972a54b9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Sun Jan 29 11:55:13 CET 2006 Daniel Veillard + + * NEWS docs/news.xsl: added stylesheet to generate NEWS file + * docs/*: updated docs preparing for the release + Sun Jan 29 09:52:03 CET 2006 Daniel Veillard * docs/site.xsl docs/*.html: credits to Diana Fong for graphics diff --git a/NEWS b/NEWS index c674d70ed5..e548c2d721 100644 --- a/NEWS +++ b/NEWS @@ -1,8 +1,22 @@ -Mon Dec 19 2005 - - first release 0.0.1 -Thu Dec 15 2005 - - project announced publicly + NEWS file for libvir + + Note that this is automatically generated from the news webpage at: + http://libvir.org/news.html + +Releases +0.0.2: Jan 29 2006: + - Update of the documentation, web site redesign (Diana Fong) + - integration of HTTP xend RPC based on libxend by Anthony Liquori for + most operations + - Adding Save and Restore APIs + - extended the virsh command line tool (Karel Zak) + - remove xenstore transactions (Anthony Liguori) + - fix the Python bindings bug when domain and connections where freed + + +0.0.1: Dec 19 2005: + - First release + - Basic management of existing Xen domains + - Minimal autogenerated Python bindings -Wed Nov 2 2005 - - the very first work was checked in a CVS on veillard.com diff --git a/docs/FAQ.html b/docs/FAQ.html index 5f89acd018..7b3e5b98d1 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -40,7 +40,14 @@ fails to run as an user, change the mode of the xenstore read-only socket with:

chmod 666 /var/run/xenstored/socket_ro

-

and also make sure that the Xen Daemon is running correctly

+

and also make sure that the Xen Daemon is running correctly with local + HTTP server enabled, this is defined in + /etc/xen/xend-config.sxp which need the following line to be + enabled:

+

(xend-http-server yes)

+

If needed restart the xend daemon after making the change with the + following command run as root:

+

service xend restart

Compilation

  1. What is the process to compile libvir ?

    As most UNIX libraries libvir follows the "standard":

    diff --git a/docs/Makefile.am b/docs/Makefile.am index c5d7808e3c..9518dfb9f6 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -14,7 +14,7 @@ EXTRA_DIST= \ man_MANS= -all: web $(man_MANS) +all: web $(top_builddir)/NEWS $(man_MANS) api: libvir-api.xml libvir-refs.xml $(APIPAGES) $(srcdir)/html/index.html @@ -49,6 +49,10 @@ $(srcdir)/html/index.html: libvir-api.xml $(srcdir)/newapi.xsl libvir-api.xml libvir-refs.xml: apibuild.py ../include/*.h ../src/*.h ../src/*.c -(./apibuild.py) +$(top_builddir)/NEWS: $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html + -@(if [ -x $(XSLTPROC) ] ; then \ + $(XSLTPROC) --nonet $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html > $(top_builddir)/NEWS ; fi ); + clean-local: rm -f *~ *.bak *.hierarchy *.signals *-unused.txt diff --git a/docs/architecture.html b/docs/architecture.html index 6bac95c226..dc0a91aa90 100644 --- a/docs/architecture.html +++ b/docs/architecture.html @@ -1,6 +1,7 @@ -libvir architecture

    libvir architecture

    When running in a Xen environment, programs using libvir have to execute +libvir architecture

    libvir architecture

    This is Xen specific since this is the only hypervisor supported at the +moment

    When running in a Xen environment, programs using libvir 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 domains. It also runs the Xen Store, a database of informations shared by the @@ -18,9 +19,9 @@ the Xen infrastructure:

    • a connection to the Xen Daemon though an HTTP changing the state of the system, but for performance and accuracy reasons may talk directly to the hypervisor when gathering state informations at least when possible (i.e. when the running program using libvir has root -priviledge access).

      If it runs without root access virConnectOpenReadOnly() should be used to +priviledge access).

      If it runs without root access virConnectOpenReadOnly() should be used to connect to initialize the library. 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

    Graphics and design by Diana Fong

    +of APIs available and slowing down information gathering about domains.

    main menu

    related links

    Graphics and design by Diana Fong

    diff --git a/docs/index.html b/docs/index.html index 6b59d0891a..f6f8c47ab1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,9 +22,9 @@ Lesser General Public License. Virtualization of the Linux Operating System means the ability to run multiple instances of Operating Systems concurently on a single hardware system where the basic resources are driven by a Linux instance. The library aim at providing long term stable C API -primarily for the Xen -paravirtualization mechanism but should be able to integrate other -virtualization mechanisms if needed.

    +initially for the Xen +paravirtualization but should be able to integrate other virtualization +mechanisms if needed.

    diff --git a/docs/intro.html b/docs/intro.html index a51337926c..b661f651a2 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -1,14 +1,14 @@ -Introduction

    Introduction

    Libvir is a C toolkit to interract with the virtualization capabilities of -recent versions of Linux (and other OSes), but ibvir won't try to provide all -possible interfaces for interacting with the virtualization features.

    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
      • +Introduction

      Introduction

      Libvir is a C toolkit to interact with the virtualization capabilities of +recent versions of Linux (and other OSes), but libvir won't try to provide +all possible interfaces for interacting with the virtualization features.

      To avoid ambiguity about the terms used here here are the definitions for +some of the specific concepts 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
        • + on a virtualized machine provided by the hypervisor

      Hypervisor and domains running on a node

      Now we can define the goal of libvir: to provide the lowest possible generic and stable 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 @@ -22,9 +22,9 @@ generic and stable layer to manage domains on a node.

        This implies the fol

      • stability of the API is a big concern, libvir should isolate applications from the frequent changes expected at the lower level of the virtualization framework
        • -

      So libvir should be a building block for higher level management tools or -for applications focusing on virtualization on a single node (the only +

    So libvir should be a building block for higher level management tools and +for applications focusing on virtualization of a single node (the only exception being domain migration between node capabilities which may need to be added at the libvir level). Where possible libvir should be extendable to be able to provide the same API for remote nodes, however this is not the -case at the moment, the code currently handle only local node access.

    main menu

    related links

    Graphics and design by Diana Fong

    +case at the moment, the code currently handle only local node accesses.

    main menu

    related links

    Graphics and design by Diana Fong

    diff --git a/docs/libvir.html b/docs/libvir.html index fe69da8e0e..5dfee3aca3 100644 --- a/docs/libvir.html +++ b/docs/libvir.html @@ -21,10 +21,10 @@ Lesser General Public License. Virtualization of the Linux Operating System means the ability to run multiple instances of Operating Systems concurently on a single hardware system where the basic resources are driven by a Linux instance. The library aim at providing long term stable C API -primarily for the Xen -paravirtualization mechanism but should be able to integrate other -virtualization mechanisms if needed.

    +paravirtualization but should be able to integrate other virtualization +mechanisms if needed.

    Releases

    @@ -33,6 +33,17 @@ 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.2: Jan 29 2006

    +
      +
    • Update of the documentation, web site redesign (Diana Fong)
      • +
    • integration of HTTP xend RPC based on libxend by Anthony Liquori for + most operations
      • +
    • Adding Save and Restore APIs
      • +
    • extended the virsh command line tool (Karel Zak)
      • +
    • remove xenstore transactions (Anthony Liguori)
      • +
    • fix the Python bindings bug when domain and connections where freed
      • +
    +

    0.0.1: Dec 19 2005

    • First release
      • @@ -42,19 +53,19 @@ and check the ChangeLog to gauge progresses.

      Introduction

      -

      Libvir is a C toolkit to interract with the virtualization capabilities of -recent versions of Linux (and other OSes), but ibvir won't try to provide all -possible interfaces for interacting with the virtualization features.

      +

      Libvir is a C toolkit to interact with the virtualization capabilities of +recent versions of Linux (and other OSes), but libvir won't try to provide +all possible interfaces for interacting with the virtualization features.

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

      +some of the specific concepts 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
        • + on a virtualized machine provided by the hypervisor

      virtualization framework

    -

    So libvir should be a building block for higher level management tools or -for applications focusing on virtualization on a single node (the only +

    So libvir should be a building block for higher level management tools and +for applications focusing on virtualization of a single node (the only exception being domain migration between node capabilities which may need to be added at the libvir level). Where possible libvir should be extendable to be able to provide the same API for remote nodes, however this is not the -case at the moment, the code currently handle only local node access.

    +case at the moment, the code currently handle only local node accesses.

    libvir architecture

    +

    This is Xen specific since this is the only hypervisor supported at the +moment

    +

    When running in a Xen environment, programs using libvir 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 @@ -113,14 +127,14 @@ the Xen infrastructure:

    changing the state of the system, but for performance and accuracy reasons may talk directly to the hypervisor when gathering state informations at least when possible (i.e. when the running program using libvir has root -priviledge access).

    +priviledge access).

    -

    If it runs without root access virConnectOpenReadOnly() should be used to +

    If it runs without root access virConnectOpenReadOnly() should be used to connect to initialize the library. 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.

    +of APIs available and slowing down information gathering about domains.

    Downloads

    @@ -200,7 +214,14 @@ available except commiting to the base.

    fails to run as an user, change the mode of the xenstore read-only socket with:

    chmod 666 /var/run/xenstored/socket_ro

    -

    and also make sure that the Xen Daemon is running correctly

    +

    and also make sure that the Xen Daemon is running correctly with local + HTTP server enabled, this is defined in + /etc/xen/xend-config.sxp which need the following line to be + enabled:

    +

    (xend-http-server yes)

    +

    If needed restart the xend daemon after making the change with the + following command run as root:

    +

    service xend restart

diff --git a/docs/news.html b/docs/news.html index 77b3374432..0599dd9b6d 100644 --- a/docs/news.html +++ b/docs/news.html @@ -2,7 +2,14 @@ Releases

Releases

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

  • First release
    • +and check the ChangeLog to gauge progresses.

    0.0.2: Jan 29 2006

    • Update of the documentation, web site redesign (Diana Fong)
      • +
    • integration of HTTP xend RPC based on libxend by Anthony Liquori for + most operations
      • +
    • Adding Save and Restore APIs
      • +
    • extended the virsh command line tool (Karel Zak)
      • +
    • remove xenstore transactions (Anthony Liguori)
      • +
    • fix the Python bindings bug when domain and connections where freed
      • +

    0.0.1: Dec 19 2005

    • First release
    • Basic management of existing Xen domains
    • Minimal autogenerated Python bindings

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/news.xsl b/docs/news.xsl new file mode 100644 index 0000000000..071be6f445 --- /dev/null +++ b/docs/news.xsl @@ -0,0 +1,46 @@ + + + + + + + NEWS file for libvir + + Note that this is automatically generated from the news webpage at: + http://libvir.org/news.html + + + + + + + + + : + + + + + + + + + - + + + + + + + at + + + + + + + + +