From f2fec34604f13d60495edf54f5d1f99b80e314bb Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Fri, 10 Feb 2006 08:43:31 +0000 Subject: [PATCH] * NEWS docs/*: regenerated and updated the docs post 0.0.3 release Daniel --- ChangeLog | 4 ++ NEWS | 6 +++ docs/FAQ.html | 38 +++++++++--------- docs/architecture.html | 8 ++-- docs/bugs.html | 6 +-- docs/downloads.html | 10 ++--- docs/index.html | 4 +- docs/intro.html | 18 ++++----- docs/libvir.html | 89 +++++++++++++++++++++++------------------- docs/libvirt.css | 4 +- docs/news.html | 9 +++-- 11 files changed, 108 insertions(+), 88 deletions(-) diff --git a/ChangeLog b/ChangeLog index e94d7054b8..f8902c9058 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Fri Feb 10 09:42:45 CET 2006 Daniel Veillard + + * NEWS docs/*: regenerated and updated the docs post 0.0.3 release + Fri Feb 10 09:39:23 CET 2006 Daniel Veillard * autogen.sh configure.in: fixed snapshot autogeneration, had to diff --git a/NEWS b/NEWS index f78f802c5f..74ebdcbcfb 100644 --- a/NEWS +++ b/NEWS @@ -5,6 +5,12 @@ http://libvirt.org/news.html Releases +0.0.3: Feb 9 2006: + - Switch name from from 'libvir' to libvirt + - Starting infrastructure to add code examples + - Update of python bindings for completeness + + 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 diff --git a/docs/FAQ.html b/docs/FAQ.html index cf62bc002b..b959fba840 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -4,30 +4,30 @@
  • Installation
  • Compilation
  • Developer corner
    • -

    License(s)

    1. Licensing Terms for libvir -

      libvir is released under the GNU Lesser +

      License(s)

      1. Licensing Terms for libvirt +

        libvirt is released under the GNU Lesser General Public License, see the file COPYING.LIB in the distribution - for the precise wording. The only library that libvir depends upon is the + for the precise wording. The only library that libvirt depends upon is the Xen store access library which is also licenced under the LGPL.

        2. -
      2. Can I embed libvir in a proprietary application ? -

        Yes. The LGPL allows you to embed libvir into a proprietary +

      3. Can I embed libvirt in a proprietary application ? +

        Yes. The LGPL allows you to embed libvirt into a proprietary application. It would be graceful to send-back bug fixes and improvements as patches for possible incorporation in the main development tree. It will decrease your maintainance costs anyway if you do so.

        4. -

      Installation

      1. Where can I get libvir ? -

        The original distribution comes from ftp://libvir.org/libvir/.

        +

      Installation

      1. Where can I get libvirt ? +

        The original distribution comes from ftp://libvirt.org/libvirt/.

        2. -
      2. I can't install the libvir/libvir-devel RPM packages due to failed +
      3. I can't install the libvirt/libvirt-devel RPM packages due to failed dependencies

        The most generic solution is to re-fetch the latest src.rpm , and rebuild it locally with

        -

        rpm --rebuild libvir-xxx.src.rpm.

        +

        rpm --rebuild libvirt-xxx.src.rpm.

        If everything goes well it will generate two binary rpm packages (one providing the shared libs and virsh, and the other one, the -devel package, providing includes, static libraries and scripts needed to build - applications with libvir that you can install locally.

        + applications with libvirt that you can install locally.

        One can also rebuild the RPMs from a tarball:

        rpmbuild -ta libdir-xxx.tar.gz

        Or from a configured tree with:

        @@ -49,10 +49,10 @@ following command run as root:

        service xend restart

        4. -

      Compilation

      1. What is the process to compile libvir ? -

        As most UNIX libraries libvir follows the "standard":

        -

        gunzip -c libvir-xxx.tar.gz | tar xvf -

        -

        cd libvir-xxxx

        +

      Compilation

      1. What is the process to compile libvirt ? +

        As most UNIX libraries libvirt follows the "standard":

        +

        gunzip -c libvirt-xxx.tar.gz | tar xvf -

        +

        cd libvirt-xxxx

        ./configure --help

        to see the options, then the compilation/installation proper

        ./configure [possible options]

        @@ -61,7 +61,7 @@

        At that point you may have to rerun ldconfig or a similar utility to update your list of installed shared libs.

        2. -
      2. What other libraries are needed to compile/install libvir ? +
      3. What other libraries are needed to compile/install libvirt ?

        Libvir requires libxenstore, which is usually provided by the xen packages as well as the public headers to compile against libxenstore.

        4. @@ -71,10 +71,10 @@ like:

        ./autogen.sh --prefix=/usr --disable-shared

        -

      Developer corner

      1. Troubles compiling or linking programs using libvir -

        To simplify the process of reusing the library, libvir comes with +

      Developer corner

      1. Troubles compiling or linking programs using libvirt +

        To simplify the process of reusing the library, libvirt comes with pkgconfig support, which can be used directly from autoconf support or via the pkg-config command line tool, like:

        -

        pkg-config libvir --libs

        +

        pkg-config libvirt --libs

        2. -

      main menu

      related links

      Graphics and design by Diana Fong

      +

    main menu

    related links

    Graphics and design by Diana Fong

    diff --git a/docs/architecture.html b/docs/architecture.html index cd275aba95..b1bd83a5f3 100644 --- a/docs/architecture.html +++ b/docs/architecture.html @@ -1,7 +1,7 @@ -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 +libvirt architecture

    libvirt architecture

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

    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 domains. It also runs the Xen Store, a database of informations shared by the @@ -18,10 +18,10 @@ the Xen infrastructure:

    • a connection to the Xen Daemon though an HTTP

    The library will usually interract with the Xen daemon for any operation 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 +least when possible (i.e. when the running program using libvirt has root 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/bugs.html b/docs/bugs.html index 5dfcfc524d..3776e9fbfe 100644 --- a/docs/bugs.html +++ b/docs/bugs.html @@ -1,10 +1,10 @@ -Reporting bugs and getting help

    Reporting bugs and getting help

    There is a mailing-list libvir-list@redhat.com for libvir, +Reporting bugs and getting help

    Reporting bugs and getting help

    There is a mailing-list libvir-list@redhat.com for libvirt, with an on-line archive. Please subscribe to this list before posting by visiting the associated Web page and follow the instructions. Patches with explanations and provided as attachments are really appreciated and will be discussed on the mailing list. If possible generate the patches by using cvs diff -u in a CVS checkout.

    We expect to use Red Hat -Bugzilla to track bugs for libvir, though there isn't a libvir software -module defined yet, in the meantime use the mailing-list, thanks !.

    main menu

    related links

    Graphics and design by Diana Fong

    +Bugzilla to track bugs for libvirt, though there isn't a libvirt software +module defined yet, in the meantime use the mailing-list, thanks !.

    main menu

    related links

    Graphics and design by Diana Fong

    diff --git a/docs/downloads.html b/docs/downloads.html index 0578481575..5cc1c5947e 100644 --- a/docs/downloads.html +++ b/docs/downloads.html @@ -1,9 +1,9 @@ -Downloads

    Downloads

    The latest versions of libvir can be found on the libvir.org server ( HTTP, FTP). You will find there the released -versions as well as snapshot +Downloads

    Downloads

    The latest versions of libvirt can be found on the libvirt.org server ( HTTP, FTP). You will find there the released +versions as well as snapshot tarballs updated from CVS head every hour

    Anonymous CVS is also -available, first register onto the server:

    cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs login

    it will request a password, enter anoncvs. Then you can -checkout the development tree with:

    cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs co libvir

    Use ./autogen.sh to configure the local checkout, then make +available, first register onto the server:

    cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login

    it will request a password, enter anoncvs. Then you can +checkout the development tree with:

    cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co libvirt

    Use ./autogen.sh to configure the local checkout, then make and make install, as usual. All normal cvs commands are now -available except commiting to the base.

    main menu

    related links

    Graphics and design by Diana Fong

    +available except commiting to the base.

    main menu

    related links

    Graphics and design by Diana Fong

    diff --git a/docs/index.html b/docs/index.html index a5b7db46a1..4e83ed98db 100644 --- a/docs/index.html +++ b/docs/index.html @@ -14,7 +14,7 @@

    -

    what is libvir?

    +

    what is libvirt?

    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 @@ -41,7 +41,7 @@ mechanisms if needed.

    Introduction
  • - libvir architecture + libvirt architecture
  • Downloads diff --git a/docs/intro.html b/docs/intro.html index 13b72c11c8..dd9db02e36 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -1,30 +1,30 @@ 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 +recent versions of Linux (and other OSes), but libvirt 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
      • +some of the specific concepts used in libvirt 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 provided by the hypervisor
        • -

      Hypervisor and domains running on a node

      Now we can define the goal of libvir: to provide the lowest possible +

    Hypervisor and domains running on a node

    Now we can define the goal of libvirt: 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 specific capabilities which are not generic enough may not be provided as - libvir APIs
      • + libvirt 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
      • -
    • stability of the API is a big concern, libvir should isolate + libvirt
      • +
    • stability of the API is a big concern, libvirt 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 and +

    So libvirt 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 added at the libvirt level). Where possible libvirt 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 accesses.

    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 b6c795c697..0d177fabb6 100644 --- a/docs/libvir.html +++ b/docs/libvir.html @@ -10,9 +10,9 @@

    Note: this is the flat content of the web site

    -

    libvir

    +

    libvirt

    -

    what is libvir?

    +

    what is libvirt?

    Libvir is a C toolkit to interract with the virtualization capabilities of recent versions of Linux (and other OSes). It is free software available @@ -29,10 +29,17 @@ mechanisms if needed.

    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.3: Feb 9 2006

    +
      +
    • Switch name from from 'libvir' to libvirt
      • +
    • Starting infrastructure to add code examples
      • +
    • Update of python bindings for completeness
      • +
    +

    0.0.2: Jan 29 2006

    • Update of the documentation, web site redesign (Diana Fong)
      • @@ -54,11 +61,11 @@ and check the ChangeLog to gauge progresses.

      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 +recent versions of Linux (and other OSes), but libvirt 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:

      +some of the specific concepts used in libvirt documentation:

      • a node is a single physical machine
      • an hypervisor is a layer of software allowing to @@ -71,7 +78,7 @@ some of the specific concepts used in libvir documentation:

        Hypervisor and domains running on a node

        -

        Now we can define the goal of libvir: to provide the lowest possible +

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

        This implies the following:

        @@ -79,30 +86,30 @@ generic and stable layer to manage domains on a node.

      • 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
        • + libvirt 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
        • -
      • stability of the API is a big concern, libvir should isolate + libvirt
        • +
      • stability of the API is a big concern, libvirt 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 and +

      So libvirt 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 added at the libvirt level). Where possible libvirt 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 accesses.

      -

      libvir architecture

      +

      libvirt 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 +

      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 domains. It also runs the Xen Store, a database of informations shared by the @@ -126,7 +133,7 @@ the Xen infrastructure:

      The library will usually interract with the Xen daemon for any operation 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 +least when possible (i.e. when the running program using libvirt has root priviledge access).

      If it runs without root access virConnectOpenReadOnly() should be used to @@ -138,23 +145,23 @@ of APIs available and slowing down information gathering about domains.

      Downloads

      -

      The latest versions of libvir can be found on the libvir.org server ( HTTP, FTP). You will find there the released +

      The latest versions of libvirt can be found on the libvirt.org server ( HTTP, FTP). You will find there the released versions as well as snapshot +href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshot tarballs updated from CVS head every hour

      Anonymous CVS is also available, first register onto the server:

      -

      cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs login

      +

      cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login

      it will request a password, enter anoncvs. Then you can checkout the development tree with:

      -

      cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs co libvir

      +

      cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co libvirt

      Use ./autogen.sh to configure the local checkout, then make and make install, as usual. All normal cvs commands are now @@ -172,15 +179,15 @@ available except commiting to the base.

      License(s)

        -
      1. Licensing Terms for libvir -

        libvir is released under the Licensing Terms for libvirt +

        libvirt is released under the GNU Lesser General Public License, see the file COPYING.LIB in the distribution - for the precise wording. The only library that libvir depends upon is the + for the precise wording. The only library that libvirt depends upon is the Xen store access library which is also licenced under the LGPL.

        2. -
      2. Can I embed libvir in a proprietary application ? -

        Yes. The LGPL allows you to embed libvir into a proprietary +

      3. Can I embed libvirt in a proprietary application ? +

        Yes. The LGPL allows you to embed libvirt into a proprietary application. It would be graceful to send-back bug fixes and improvements as patches for possible incorporation in the main development tree. It will decrease your maintainance costs anyway if you do so.

        @@ -189,19 +196,19 @@ available except commiting to the base.

        Installation

          -
        1. Where can I get libvir ? +
        2. Where can I get libvirt ?

          The original distribution comes from ftp://libvir.org/libvir/.

          + href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/.

          3. -
        3. I can't install the libvir/libvir-devel RPM packages due to failed +
        4. I can't install the libvirt/libvirt-devel RPM packages due to failed dependencies

          The most generic solution is to re-fetch the latest src.rpm , and rebuild it locally with

          -

          rpm --rebuild libvir-xxx.src.rpm.

          +

          rpm --rebuild libvirt-xxx.src.rpm.

          If everything goes well it will generate two binary rpm packages (one providing the shared libs and virsh, and the other one, the -devel package, providing includes, static libraries and scripts needed to build - applications with libvir that you can install locally.

          + applications with libvirt that you can install locally.

          One can also rebuild the RPMs from a tarball:

          rpmbuild -ta libdir-xxx.tar.gz

          Or from a configured tree with:

          @@ -227,10 +234,10 @@ available except commiting to the base.

          Compilation

            -
          1. What is the process to compile libvir ? -

            As most UNIX libraries libvir follows the "standard":

            -

            gunzip -c libvir-xxx.tar.gz | tar xvf -

            -

            cd libvir-xxxx

            +
          2. What is the process to compile libvirt ? +

            As most UNIX libraries libvirt follows the "standard":

            +

            gunzip -c libvirt-xxx.tar.gz | tar xvf -

            +

            cd libvirt-xxxx

            ./configure --help

            to see the options, then the compilation/installation proper

            ./configure [possible options]

            @@ -239,7 +246,7 @@ available except commiting to the base.

            At that point you may have to rerun ldconfig or a similar utility to update your list of installed shared libs.

            3. -
          3. What other libraries are needed to compile/install libvir ? +
          4. What other libraries are needed to compile/install libvirt ?

            Libvir requires libxenstore, which is usually provided by the xen packages as well as the public headers to compile against libxenstore.

            5. @@ -253,18 +260,18 @@ available except commiting to the base.

            Developer corner

              -
            1. Troubles compiling or linking programs using libvir -

              To simplify the process of reusing the library, libvir comes with +

            2. Troubles compiling or linking programs using libvirt +

              To simplify the process of reusing the library, libvirt comes with pkgconfig support, which can be used directly from autoconf support or via the pkg-config command line tool, like:

              -

              pkg-config libvir --libs

              +

              pkg-config libvirt --libs

            Reporting bugs and getting help

            There is a mailing-list libvir-list@redhat.com for libvir, +href="mailto:libvir-list@redhat.com">libvir-list@redhat.com for libvirt, with an on-line archive. Please subscribe to this list before posting by visiting the associated Web @@ -273,7 +280,7 @@ attachments are really appreciated and will be discussed on the mailing list. If possible generate the patches by using cvs diff -u in a CVS checkout.

            We expect to use Red Hat -Bugzilla to track bugs for libvir, though there isn't a libvir software +Bugzilla to track bugs for libvirt, though there isn't a libvirt software module defined yet, in the meantime use the mailing-list, thanks !.

            diff --git a/docs/libvirt.css b/docs/libvirt.css index 8115e531a2..757f2ed874 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -38,7 +38,7 @@ img #pageHeader { position: absolute; - background: url(libvirHeader.png) center no-repeat; + background: url(libvirtHeader.png) center no-repeat; top: 30px; height: 76px; width: 766px; @@ -70,7 +70,7 @@ img { font-size: 11px; height: 300px; - background: url(libvirLogo.png) center no-repeat; + background: url(libvirtLogo.png) center no-repeat; margin: 0; width: 766px; } diff --git a/docs/news.html b/docs/news.html index 4eb88b0b10..53d0b03a81 100644 --- a/docs/news.html +++ b/docs/news.html @@ -1,8 +1,11 @@ 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.2: Jan 29 2006

            • Update of the documentation, web site redesign (Diana Fong)
              • +development of libvirt, 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.3: Feb 9 2006

              • Switch name from from 'libvir' to libvirt
                • +
              • Starting infrastructure to add code examples
                • +
              • Update of python bindings for completeness
                • +

              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
                • @@ -12,4 +15,4 @@ and check the ChangeLog to gauge progresses.

                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

            +

    main menu

    related links

    Graphics and design by Diana Fong