[Libvirt-cim] [PATCH] Add some starter web content
Dan Smith
danms at us.ibm.com
Thu Nov 1 02:30:09 UTC 2007
# HG changeset patch
# User Dan Smith <danms at us.ibm.com>
# Date 1193884206 25200
# Node ID b698e473b09ff77c24ff87db74ef112cd726a177
# Parent d349e62b888f0dda3577ff0e55f4dbe7681a5d57
Add some starter web content
I have added a couple of new content sections since last time. I also
trimmed and tweaked site.xsl a bit. I think this is probably close to
"good enough" for a project announcement.
Signed-off-by: Dan Smith <danms at us.ibm.com>
diff -r d349e62b888f -r b698e473b09f Makefile.am
--- a/Makefile.am Wed Oct 31 17:04:17 2007 -0700
+++ b/Makefile.am Wed Oct 31 19:30:06 2007 -0700
@@ -1,5 +1,5 @@
# Copyright IBM Corp. 2007
-SUBDIRS = libxkutil src
+SUBDIRS = libxkutil src doc
MOFS = \
schema/ComputerSystem.mof \
diff -r d349e62b888f -r b698e473b09f configure.ac
--- a/configure.ac Wed Oct 31 17:04:17 2007 -0700
+++ b/configure.ac Wed Oct 31 19:30:06 2007 -0700
@@ -67,6 +67,7 @@ AC_CONFIG_FILES([
libxkutil/tests/Makefile
src/Makefile
src/tests/Makefile
+ doc/Makefile
Makefile
])
diff -r d349e62b888f -r b698e473b09f doc/Makefile.am
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/Makefile.am Wed Oct 31 19:30:06 2007 -0700
@@ -0,0 +1,9 @@
+XSLTPROC = /usr/bin/xsltproc
+
+WEB_PAGES = index.html
+
+$(WEB_PAGES): libvirt-cim.html site.xsl
+ $(XSLTPROC) --nonet --html $(top_srcdir)/doc/site.xsl $(top_srcdir)/doc/libvirt-cim.html > index.html
+
+all: $(WEB_PAGES)
+
diff -r d349e62b888f -r b698e473b09f doc/libvirt-cim.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libvirt-cim.html Wed Oct 31 19:30:06 2007 -0700
@@ -0,0 +1,172 @@
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="">
+ <title>Libvirt-CIM: The CIM provider for libvirt</title>
+</head>
+
+<body bgcolor="#ffffff">
+<h1 align="center">Libvirt-CIM: The CIM provider for libvirt</h1>
+
+<h1>Note: this is the flat content of the <a href="index.html">web site</a></h1>
+
+<h1 style="text-align: center">libvirt-cim</h1>
+
+<h3>What is <span class="style1">libvirt-cim?</span></h3>
+
+<p>Libvirt-CIM is a CIM provider for managing linux virtualization
+ platforms using libvirt. It is written in C and should work in any
+ CIMOM that supports CMPI 2.0 providers. The intent is to implement
+ the SVPC virtualization class model currently available in the DMTF
+ Experimental 2.16 schema.
+</p>
+
+<h2><a name="News">Releases</a></h2>
+
+<p>There have been no releases to date</p>
+
+<h2><a name="Introducti">Introduction</a></h2>
+
+<p>Libvirt-CIM is a CIM provider for managing linux virtualization
+ platforms using libvirt. It is written in C and should work in any
+ CIMOM that supports CMPI 2.0 providers. The intent is to implement
+ the SVPC virtualization class model currently available in the DMTF
+ Experimental 2.16 schema.
+</p>
+
+<p>The providers are currently under heavy development. Focus is on
+ Xen support right now, which means some of the providers have some
+ "shortcuts" hard-coded to Xen right now. The long-term goal is to
+ support all of the platforms that libvirt supports with minimal
+ differences.
+</p>
+
+<h2><a name="Downloads">Downloads</a></h2>
+
+<p>The libvirt-cim development tree can be found in the
+ <a href="http://libvirt.org/hg">libvirt.org/hg</a> repository.
+</p>
+
+<p>To get a copy of the development tree, use
+ <a href="http://www.selenic.com/mercurial/wiki/">mercurial</a>'s
+ clone feature:
+</p>
+
+<p><code>$ hg clone http://libvirt.org/hg/libvirt-cim</code></p>
+
+<p>Alternatively, you can grab a
+ <a href="http://libvirt.org/hg/libvirt-cim/archive/tip.tar.gz">tarball</a> or
+ <a href="http://libvirt.org/hg/libvirt-cim/archive/tip.zip">zip</a>
+ file snapshot of the repository.
+</p>
+
+<h2><a name="Schema">Schema</a></h2>
+
+<p>The libvirt-cim provider depends on an installed
+ <a href="http://www.dmtf.org/standards/cim/cim_schema_v216/">DMTF
+ CIM v2.16</a> Experimental schema. The package can be obtained
+<a href="http://www.dmtf.org/standards/cim/cim_schema_v216/cimv216Experimental-MOFs.zip">here</a>.</p>
+
+<h4>To install the schema in Pegasus:</h4>
+
+<p><code>
+ $ PEGASUS_REPO=/var/lib/Pegasus # adjust this as needed<br/>
+ $ mkdir cim216<br/>
+ $ cd cim216<br/>
+ $ unzip $PATH_TO_ZIPFILE<br/>
+ $ sudo cimmofl -uc -aEV -R$PEGASUS_REPO -n /root/ibmsd cimv216.mof<br/>
+ $ sudo cimmofl -uc -aEV -R$PEGASUS_REPO -n /root/ibmsd qualifiers.mof<br/>
+ $ sudo cimmofl -uc -aEV -R$PEGASUS_REPO -n /root/ibmsd qualifiers_optional.mof<br/>
+</code></p>
+
+<h4>To install the schema in SFCB:</h4>
+
+<p><code>
+ $ SFCB_CIM=/usr/local/share/sfcb/CIM # adjust this as needed<br/>
+ $ mkdir cim216<br/>
+ $ cd cim216<br/>
+ $ unzip $PATH_TO_ZIPFILE<br/>
+ $ mv cimv216.mof CIM_Schema.mof<br/>
+ $ sudo cp * $SFCB_CIM<br/>
+ $ sudo sfcbrepos<br/>
+</code></p>
+
+<p><strong>Note:</strong> in both cases, the CIM v2.16 schema seems to have a
+ few classes that don't register correctly. You may need to
+ disable installation of classes with something like the
+ following:
+</p>
+
+<p><code>
+--- CIM_Schema.mof 2007-10-15 00:15:44.000000000 -0700<br/>
++++ cimv216.mof 2007-10-22 10:11:19.000000000 -0700<br/>
+@@ -507,3 +507,3 @@<br/>
+ #pragma include ("Policy/CIM_SharedSecretAuthentication.mof")<br/>
+-#pragma include ("Security/CIM_SecurityIndication.mof")<br/>
++//#pragma include ("Security/CIM_SecurityIndication.mof")<br/>
+ #pragma include ("Support/PRS_Activity.mof")<br/>
+@@ -728,4 +728,4 @@<br/>
+ #pragma include ("Policy/CIM_PolicyConditionInPolicyRule.mof")<br/>
+-#pragma include ("Security/CIM_IPNetworkSecurityIndication.mof")<br/>
+-#pragma include ("Security/CIM_IPPacketFilterIndication.mof")<br/>
++//#pragma include ("Security/CIM_IPNetworkSecurityIndication.mof")<br/>
++//#pragma include ("Security/CIM_IPPacketFilterIndication.mof")<br/>
+ #pragma include ("Support/PRS_ActivityContact.mof")<br/>
+</code></p>
+
+<h2><a name="Platforms">Platform Support</a></h2>
+
+<p>Currently, libvirt-cim is targetting Xen as its primary support
+ platform because is has the largest installed user base. The
+ long-term plan is to support many others (hopefully any that libvirt
+ supports). This includes KVM and containers.
+</p>
+
+<p>The code base currently has many Xen-specific "shortcuts" that need
+ to be resolved and generalized in order to support other platforms.
+ A short list of these may include:</p>
+<ul>
+ <li>The XML generation and parsing code and the related device
+ modeling code.</li>
+ <li>The libvirt connection logic. Right now, (in most places) we
+ detect the current hypervisor in use and connect to libvirt
+ appropriately. This may or may not be the correct behavior in a
+ situation where you could need to support containers and QEMU
+ virtual machines.</li>
+ <li>Some lingering hard-coded "Xen_Foo" class names.</li>
+</ul>
+
+<p>Further, supporting new platforms have some registration and
+ modeling implications:</p>
+<ul>
+ <li>Additions to the MOF and registration files for "branded"
+ classes (Xen_Foo, KVM_Foo, etc)</li>
+ <li>Modifications to some of the association providers that register
+ separate CMPI provider structures for each class type they handle
+ (to avoid duplicate results in the general case)</li>
+</ul>
+
+<h2><a name="architecture">Architecture</a></h2>
+
+<p>The libvirt-cim provider consists of two major parts:</p>
+
+<ul>
+ <li>The provider classes themselves (<tt>src/</tt>)</li>
+ <li>A helper library of common components (<tt>libxkutil/</tt>)</li>
+</ul>
+
+<p>The provider classes implement the actual CIM class model. Some of
+ the provider libraries implement one CIM class and one providier.
+ However, many of them perform more than one task. For example,
+ the <tt>Virt_Device</tt> and <tt>Virt_DevicePool</tt> providers
+ implement the device and device pool classes for each of the major
+ device types: Memory, Processor, Network, and Disk.
+</p>
+
+<p>The helper library contains common routines that almost all of the
+ providers use, such as libvirt connection type detection and device
+ and system XML parsing.
+</p>
+
+</body>
+
+</html>
diff -r d349e62b888f -r b698e473b09f doc/site.xsl
--- a/doc/site.xsl Wed Oct 31 17:04:17 2007 -0700
+++ b/doc/site.xsl Wed Oct 31 19:30:06 2007 -0700
@@ -19,7 +19,7 @@
<xsl:text>docs.html</xsl:text>
</xsl:when>
<xsl:when test="$name = '#Reporting'">
- <xsl:text>bugs.html</xsl:text>
+ <xsl:text>development.html</xsl:text>
</xsl:when>
<xsl:when test="$name = '#help'">
<xsl:text>help.html</xsl:text>
@@ -37,28 +37,19 @@
<xsl:text>news.html</xsl:text>
</xsl:when>
<xsl:when test="$name = '#Contributi'">
- <xsl:text>contribs.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#Format'">
- <xsl:text>format.html</xsl:text>
+ <xsl:text>development.html</xsl:text>
</xsl:when>
<xsl:when test="$name = '#architecture'">
<xsl:text>architecture.html</xsl:text>
</xsl:when>
- <xsl:when test="$name = '#Python'">
- <xsl:text>python.html</xsl:text>
- </xsl:when>
<xsl:when test="$name = '#FAQ'">
<xsl:text>FAQ.html</xsl:text>
</xsl:when>
- <xsl:when test="$name = '#Remote'">
- <xsl:text>remote.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#uri'">
- <xsl:text>uri.html</xsl:text>
- </xsl:when>
- <xsl:when test="$name = '#HVSupport'">
- <xsl:text>hvsupport.html</xsl:text>
+ <xsl:when test="$name = '#Platforms'">
+ <xsl:text>platforms.html</xsl:text>
+ </xsl:when>
+ <xsl:when test="$name = '#Schema'">
+ <xsl:text>schema.html</xsl:text>
</xsl:when>
<xsl:when test="$name = ''">
<xsl:text>unknown.html</xsl:text>
@@ -77,11 +68,11 @@
the main menu box
-->
<xsl:template name="linkList">
- <div class="linkList">
- <div class="llinks">
- <h3 class="links"><span>main menu</span></h3>
+ <div class="linkList2">
+ <div class="llinks2">
+ <h3 class="links2"><span>main menu</span></h3>
<ul>
- <li>Home</li>
+ <li><a href="{$href_base}index.html">Home</a></li>
<xsl:for-each select="/html/body/h2">
<xsl:variable name="filename">
<xsl:call-template name="filename">
@@ -102,156 +93,20 @@
</li>
</xsl:if>
</xsl:for-each>
- <li><a href="{$href_base}html/index.html">API Menu</a></li>
- <li><a href="{$href_base}examples/index.html">C code examples</a></li>
- <li><a href="{$href_base}ChangeLog.html">Recent Changes</a></li>
-
- </ul>
- </div>
- <div class="llinks">
- <h3 class="links"><span>related links</span></h3>
- <ul>
- <li> <a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li>
- <li> <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li>
- <li> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></li>
- <li> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li>
- <li> <a href="http://et.redhat.com/~rjones/ocaml-libvirt/">OCaml bindings</a></li>
- <li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li>
- <li><form action="{$href_base}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="{$href_base}Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li>
- </ul>
- <p class='credits'>Graphics and design by <a href="mail:dfong at redhat.com">Diana Fong</a></p>
- </div>
- </div>
- </xsl:template>
- <xsl:template name="linkList2">
- <div class="linkList2">
- <div class="llinks2">
- <h3 class="links2"><span>main menu</span></h3>
- <ul>
- <li><a href="{$href_base}index.html">Home</a></li>
- <xsl:for-each select="/html/body/h2">
- <xsl:variable name="filename">
- <xsl:call-template name="filename">
- <xsl:with-param name="name" select="concat('#', string(a[1]/@name))"/>
- </xsl:call-template>
- </xsl:variable>
- <xsl:if test="$filename != ''">
- <li>
- <xsl:element name="a">
- <xsl:attribute name="href">
- <xsl:value-of select="$filename"/>
- </xsl:attribute>
- <xsl:if test="$filename = 'docs.html'">
- <xsl:attribute name="style">font-weight:bold</xsl:attribute>
- </xsl:if>
- <xsl:value-of select="."/>
- </xsl:element>
- </li>
- </xsl:if>
- </xsl:for-each>
- <li><a href="{$href_base}html/index.html">API Menu</a></li>
- <li><a href="{$href_base}examples/index.html">C code examples</a></li>
- <li><a href="{$href_base}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="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li>
- <li> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></li>
- <li> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li>
- <li> <a href="http://et.redhat.com/~rjones/ocaml-libvirt/">OCaml bindings</a></li>
- <li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li>
- <li><form action="{$href_base}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="{$href_base}Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li>
+ <li> <a href="https://www.redhat.com/mailman/listinfo/libvirt-cim/">Mailing list</a></li>
+ <li> <a href="http://libvirt.org/">libvirt</a></li>
+ <li><a href="http://xmlsoft.org/"> <img src="http://libvirt.org/Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li>
</ul>
<p class='credits'>Graphics and design by <a href="mail:dfong at redhat.com">Diana Fong</a></p>
</div>
</div>
</xsl:template>
-<!--
- the main menu box
- -->
- <xsl:template name="develtoc">
- <div class="left">
- <form action="{$href_base}search.php"
- enctype="application/x-www-form-urlencoded" method="get">
- <input name="query" type="text" size="20" value=""/>
- <input name="submit" type="submit" value="Search ..."/>
- </form>
- <div class="box">
- <h2 class="box_title">API menu</h2>
- </div>
- <p><a href="{$href_base}index.html">Main menu</a></p>
- <p><a href="{$href_base}/html/index.html">API menu</a></p>
- <p><a href="{$href_base}ChangeLog.html">ChangeLog</a></p>
- <div class="box">
- <h2 class="box_title">API Indexes</h2>
- </div>
- <p><a href="{$href_base}APIchunk0.html">Alphabetic</a></p>
- <p><a href="{$href_base}APIconstructors.html">Constructors</a></p>
- <p><a href="{$href_base}APIfunctions.html">Functions/Types</a></p>
- <p><a href="{$href_base}APIfiles.html">Modules</a></p>
- <p><a href="{$href_base}APIsymbols.html">Symbols</a></p>
- <div class="box">
- <h2 class="box_title">related links</h2>
- </div>
- <p><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></p>
- <p> <a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></p>
- <p> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></p>
- <p> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></p>
- <p> <a href="http://et.redhat.com/~rjones/ocaml-libvirt/">OCaml bindings</a></p>
- <p><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></p>
- <a href="http://xmlsoft.org/"><img src="{$href_base}Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo"/></a>
- </div>
- <div class="linkList2">
- <div class="llinks2">
- <h3 class="links2"><span>API menu</span></h3>
- <ul>
- <li><a href="{$href_base}index.html">Main menu</a></li>
- <li><a href="{$href_base}/html/index.html">API menu</a></li>
- <li><a href="{$href_base}ChangeLog.html">ChangeLog</a></li>
- </ul>
- </div>
- <div class="llinks2">
- <h3 class="links2"><span>API indexes</span></h3>
- <ul>
- <li><a href="{$href_base}APIchunk0.html">Alphabetic</a></li>
- <li><a href="{$href_base}APIconstructors.html">Constructors</a></li>
- <li><a href="{$href_base}APIfunctions.html">Functions/Types</a></li>
- <li><a href="{$href_base}APIfiles.html">Modules</a></li>
- <li><a href="{$href_base}APIsymbols.html">Symbols</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="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li>
- <li> <a href="http://virt-manager.et.redhat.com/">virt-manager</a></li>
- <li> <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li>
- <li> <a href="http://et.redhat.com/~rjones/ocaml-libvirt/">OCaml bindings</a></li>
- <li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li>
- <li><form action="{$href_base}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>
- </xsl:template>
-
-<!--
- the menu box for developper's pages
- -->
<!--
the page title
-->
@@ -265,7 +120,7 @@
- Write the styles in the head
-->
<xsl:template name="style">
- <link rel="stylesheet" type="text/css" href="{$href_base}libvirt.css" />
+ <link rel="stylesheet" type="text/css" href="http://libvirt.org/libvirt.css" />
<link rel="SHORTCUT ICON" href="/32favicon.png" />
</xsl:template>
@@ -332,7 +187,7 @@
<xsl:apply-templates mode="subfile" select="$header/following-sibling::*[preceding-sibling::h2[1] = $header and name() != 'h2' ]"/>
</div>
</div>
- <xsl:call-template name="linkList2"/>
+ <xsl:call-template name="linkList"/>
<xsl:call-template name="bottom"/>
</div>
</body>
More information about the Libvirt-cim
mailing list