Return to
readme.html
CVS log
Up to [Pegasus] / pegasus
|
Return to
readme.html
CVS log
|
Up to [Pegasus] / pegasus
|
|
File: [Pegasus] / pegasus / Attic / readme.html
(download)
/
(as text)
Revision: 1.14, Fri Jan 5 19:12:14 2007 UTC (17 years, 4 months ago) by dave.sudlik Branch: MAIN CVS Tags: TASK-PEP362_RestfulService-merged_out_from_trunk, TASK-PEP348_SCMO-merged_out_from_trunk, TASK-PEP317_pullop-merged_out_from_trunk, TASK-PEP317_pullop-merged_in_to_trunk, TASK-PEP311_WSMan-root, TASK-PEP311_WSMan-branch, HPUX_TEST, HEAD Changes since 1.13: +0 -0 lines FILE REMOVED BUG#: 5974 TITLE: CVS commit of PEP 289, version 2.6 readme DESCRIPTION: removing old readme |
//%2006////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; Symantec Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type"
content="text/html; charset=windows-1252">
<title>OpenPegasus</title>
</head>
<body>
<p align="center"><b><font size="4">Pegasus Enhancement Proposal (PEP)</font></b></p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>PEP #:</b> 235<br>
</p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Title: </b>OpenPegasus
Version 2.5 Release Readme file</p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version: </b><span
style="color: rgb(0, 0, 0);">1.4<br>
</span></p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Created:</b> 6 Sept
2005</p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Authors: </b>Warren
Grunbok<br>
</p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Status: </b>draft</p>
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version History:</b></p>
<table bordercolordark="#666666" bordercolorlight="#cccccc"
style="font-family: Arial;" border="1" cellspacing="1" width="100%">
<tbody>
<tr>
<th bgcolor="#cae6ca">Version</th>
<th bgcolor="#cae6ca">Date</th>
<th bgcolor="#cae6ca">Author</th>
<th bgcolor="#cae6ca">Change Description</th>
</tr>
<tr>
<td align="center">1.0</td>
<td align="center">5, Sept 2005</td>
<td align="center">Warren Grunbok<br>
</td>
<td>Initial draft<br>
</td>
</tr>
<tr>
<td style="vertical-align: top; text-align: center;">1.1<br>
</td>
<td style="vertical-align: top; text-align: center;"> 13,
Sept 2005<br>
</td>
<td style="vertical-align: top; text-align: center;">Warren
Grunbok/Roger Kumpf<br>
</td>
<td style="vertical-align: top; text-align: center;">Updates
based on Architecture team review<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">1.2<br>
</td>
<td style="vertical-align: top;">22, Sept 2005<br>
</td>
<td style="vertical-align: top;">Warren Grunbok<br>
</td>
<td style="vertical-align: top;">Updates from posted comments to
1.1<br>
</td>
</tr>
<tr>
<td style="vertical-align: top; color: rgb(0, 0, 0);">1.3<br>
</td>
<td style="vertical-align: top; color: rgb(0, 0, 0);">22,Sept 2005<br>
</td>
<td style="vertical-align: top; color: rgb(0, 0, 0);">Warren
Grunbok<br>
</td>
<td style="vertical-align: top; color: rgb(0, 0, 0);">changed _
to - <br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">1.4<br>
</td>
<td style="vertical-align: top;">26, Sept 2005<br>
</td>
<td style="vertical-align: top;">Warren Grunbok/Dave Sudlik<br>
</td>
<td style="vertical-align: top;">Cleanup on example lists<br>
</td>
</tr>
</tbody>
</table>
<hr>
<p><b>Abstract:</b> Installation, build, operation information on
the OpenPegasus Version 2.5.0 Release. Note that if this readme
conflicts with the documentation in the release notes or interface
definition documents for a particular release, those documents should
be considered authorative. This is a simplified overview to act as an
introduction to OpenPegasus.</p>
<hr>
<p align="center"><b><font size="5">OpenPegasus - A Manageability
Services Broker for the DMTF CIM/WBEM Standards
</font></b></p>
<p align="left"><b>Tagline:</b> OpenPegasus is an object manager for
DMTF CIM objects written in C++
and hosted by The Open Group </p>
<p align="left">
<b>STATUS:</b> Revised Sept 2005 for Pegasus release version
2.5.0
- Draft<br>
</p>
<a href="#Overview">Overview</a>
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a
href="#avail_of_peg">Availability of Pegasus</a><br>
<a href="#peg_sup_plat">Pegasus Supported Platforms</a><br>
<a href="#peg_dep">Pegasus Dependencies</a><br>
<a href="#peg_dir_struc"></a><a href="#cmnd">Commands</a><br>
<a href="#docs">Documentation</a><br>
<a href="#part">How to Participate</a><br>
</blockquote>
<a href="#inst_peg">Install Pegasus</a>
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"><a
href="#download">Download or checkout Pegasus</a><br>
<a href="#vfy_req_sw">Verify that you have the required
software</a><br>
<a href="#set_envt_var">Set the environment variables</a><br>
<a href="#bld">Build the Pegasus runtime, test files, test clients,
and repository</a><br>
<a href="#pop_peg_rep">Populate the Pegasus repository</a><br>
<a href="#reg_prov">Register providers in the Pegasus environment</a><br>
<a href="#note_bld_peg_lnx">Notes
about Building Pegasus on Linux</a><br>
<a href="#note_bld_peg_ssl">Notes on building Pegasus with SSL</a><br>
<a href="#bld_peg_win">Building
Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a><br>
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a
href="#mu_utility">The MU Utility</a><br>
</blockquote>
</blockquote>
<a href="#test">Test the Pegasus installation</a><br>
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a
href="#test_icu">Testing with ICU enabled</a><br>
</blockquote>
<hr>
<h1><a name="Overview">Overview</a> </h1>
<b>OpenPegasus (also referred to as Pegasus):</b>
Pegasus is an open-source CIM Server for DMTF CIM objects. It is
written
in C++ and includes the Object manager (CIMOM), a set of defined
interfaces, an implementation of the CIMOperations over HTTP operations
and their cimxml HTTP encodings, and Interface libraries
for both client and providers. It is maintained
consistent with the DMTF CIM and WBEM specifications except for
exceptions
noted in the documentation.<br>
<br>
<span class="norm"></span>OpenPegasus includes components for: <br>
<ol>
<li>DMTF compliant CIMServer that processes CIM operations, CIM
Indications, and
includes class and instance repositories and interfaces for creating
CIM
Providers and CIM Clients.</li>
<li>Provider interfaces so that providers may be build in multiple
languages (i.e.
C++, C, Java).</li>
<li>A number of CIM providers.</li>
<li>A mof compiler.</li>
<li>A number of CIM CLients to provide usage examples, CIMServer
test functions,
and administration functions.</li>
<li>More complete information on the exact functions
and their functional state is available from the release notes for each
OpenPegasus release.</li>
</ol>
OpenPegasus is open source and is covered under the MIT open-source
license.
<p>OpenPegasus is being developed and maintained under the auspices of
The
Open
Group. OpenPegasus is maintained under the license defined in the
doc
directory of this release. The specific file is: <font
style="color: rgb(0, 0, 0);">pegasus/doc/license.txt</font>.
This licensing is intended to support as
wide a
distribution as possible with minimal demands on the users.
</p>
<p>More information on this project, access to the CVS, and
documentation on
Pegasus are available from the OpenGroup WEB site.
</p>
<p> <a target="blank"
href="http://www.openpegasus.org/">http://www.openpegasus.org</a></p>
<h2><a name="avail_of_peg">Availability of Pegasus</a></h2>
<h2></h2>
<h2></h2>
<ol>
Pegasus can be obtained via any of the following:<br>
<ol>
<li>Released tarballs (see <a
href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=392">Relase
tarballs link</a>)</li>
<li>CVS (See <a
href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">CVS
code repository</a> for
more information.)</li>
<li>Linux RPMs. See
(<a
href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">RPM
link</a> for
more information
)</li>
</ol>
</ol>
<p>NOTE: The Linux RPM reference is for 2.4.1 because that is all we
have. We
need a general page to get to the RPMs, not one per release.
</p>
<p>Pegasus is distributed as open source under the MIT open-source
license. The distribution is available via CVS and snapshot images in
tar and zip file formats on the web site.
The source code from CVS can be found at the following Open Group CVS
server;
</p>
<p><span class="norm"></span><font style="color: rgb(0, 0, 0);">CVS
write accounts are managed by Martin Kirk of The Open Group </font>
(<a href="mailto:%28k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>)
</p>
<br>
<h2><a name="peg_sup_plat">Pegasus Supported Platforms</a></h2>
<p>
Pegasus is regularly tested against a variety of platforms by the
development group. The results of the nightly tests can be found
here: <a
href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly
test status</a> . The Release notes provides additional details
regarding the platforms. <a
href="http://www.openpegasus.org/pp/protected/revdoc.tpl?CALLER=revdocuments.tpl&grid=1692">
PEP 230</a> is the release notes PEP for 2.5.<br>
</p>
<h2><a name="peg_dep">Pegasus Dependencies</a></h2>
<p>
We have worked to minimize the dependence of Pegasus on other software
packages and tools. Currently Pegasus has the following dependencies:
</p>
<p><b>1. GNUMAKE</b> - To simplify the building of Pegasus across
multiple platforms we
have standardized on a set of build tools including: GNUMAKE. We are
using GNUMAKE 3.79.1 successfully both in Windows and Linux
environments.
</p>
<p>GNUMAKE is available from :</p>
<p> <a target="blank"
href="http://www.gnu.org/">http://www.gnu.org</a>
</p>
<b>2. FLEX and BISON</b> - These tools were used to develop the
MOF
compiler and WQL
parser. <span class="norm"></span><font
style="color: rgb(0, 0, 0);">These tools are required only for
development of the parsers, not for building Pegasus.</font>
<p><b>3. DOC++ </b>- The Pegasus documentation is taken from a
combination of text files
and the Pegasus header files themselves. This documentation is
formatted with DOC++ and GAWK. <span class="norm"></span><font
style="color: rgb(0, 0, 0);">These tools are required to build the
interface documentation set.</font>
</p>
<p><b>4. ICU Internationalization libraries</b> - These libraries are
used as the basis for message catalogs for message
internationalization. See the ICU website
(http://oss.software.ibm.com/icu/) for more information on these
libraries</p>
<p><span style="font-weight: bold;">5</span>. <b>OpenSSL </b>- If it
is intended to use SSL on the
communication protocol, the OpenSSL libraries are required.<br>
</p>
<p> NOTE: A set of the required
tools for windows platforms is available on the openpegasus web
site. <a href="../Pegasus24/www.openpegasus.org">www.openpegasus.org</a></p>
<h1><a name="cmnd">Commands</a></h1>
<p>
The manpages for each of the commands are in rpm/manLinux/man1.Z
directory (on CVS) </p>
<p>To see simple help for each of the commands, use the "--help" flag. </p>
<span style="font-family: times new roman;">Here is a list of useful
commands:<br>
<br style="font-weight: bold;">
</span><span style="font-weight: bold;" class="norm"></span><span
style="font-family: times new roman; font-weight: bold;"><span
class="norm"></span></span><span style="font-weight: bold;">Some of
the basic commands:</span>
<br>
NOTE: Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf
for
more information about administering the Pegasus CIMServer.<br>
<ul>
<li>cimserver daemon=true (Start the server
cimserver)</li>
<li>cimserver -s (Shuts down the cimserver)</li>
<li>cimserver traceLevel=4 traceComponents=ALL (Starts server
with
config flags)</li>
<li>cimprovider -l -s (Lists providers and their status)</li>
<li>cimprovider -e -m OperatingSystemModule (Enables the
OperatingSystem provider)</li>
<li>cimuser -a -u guest _w <ThePassword> (Adds the user <span
style="font-style: italic;">guest</span> with specified password)<br>
</li>
<li>cimuser -l (Lists the users )<br>
</li>
</ul>
Note: there are some differences between windows and other
platforms in
starting the server as a daemon/service. Whereas most supported
platforms use
the configuration option daemon to start the server as a service, on
windows it
must be specifically installed as a service (ex. cimserver -install)
and then
started as a service (cimserver -start). The cimserver --h option
explains the
exact format of the start and stop options.<br
style="color: rgb(0, 0, 0);">
<font><font color="RED"><br
style="color: rgb(0, 0, 0); font-weight: bold;">
<span style="color: rgb(0, 0, 0); font-weight: bold;">Makefile commands
<br>
</span></font></font>Pegasus includes several make files that enable
you to quickly build or
refresh the Pegasus runtime, test files, test client and the
repository. To use these make files, type "make" followed by one of the
supplied targets. <br>
The following list contains some of the make targets that are
supported:
<ul>
<li><default> - Build everything. </li>
<li>clean - Clean out all objects, libs, and executables. </li>
<li>depend - Create the dependencies. </li>
<li>repository - Create the repository in $PEGASUS_HOME/repository </li>
<li>tests - Execute all tests (except client server tests). </li>
<li>rebuild - clean, depend, <default> </li>
<li>world - depend, <default></li>
</ul>
<font><font color="RED"><span
style="color: rgb(0, 0, 0); font-weight: bold;"></span><span
style="color: rgb(0, 0, 0);">For a comprehensive list of the
make targets, refer to the make files.<br>
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0); font-weight: bold;">TestMakefile
commands
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"></span></font></font><font><font
color="RED"><span class="norm"></span></font></font> TestMakefile is a
make file
that in the top level Pegasus source directory that defines
functionality to
initiate the Pegasus tests. The targets defined in this makefile allow
the
user to run the various tests and test suites that are included in the
Pegasus
source package.<br>
<font><font color="RED"><span class="norm"></span></font></font>Example:
From the $PEGASUS_ROOT directory.
make -f TestMakefile [testoption]<br>
<br style="color: rgb(0, 0, 0);">
<font><font color="RED"><span style="color: rgb(0, 0, 0);">## rebuild -
Rebuild
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">## build - Build
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">## prestarttests - Execute
functional tests
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">## poststarttests - Execute
poststarttests (No security, No SSL)
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">## tests - Execute prestarttests and
poststarttests
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">## standardtests - Execute
poststarttests and a series of
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">## posstarttests using multiple
options.
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">##
</span><br style="color: rgb(0, 0, 0);">
<br>
<span style="color: rgb(0, 0, 0);">Some examples: <br>
make -f TestMakefile prestarttests
- runs the unit tests, builds
</span><span style="color: rgb(0, 0, 0);">the repositories.
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"> make -f TestMakefile poststarttests
- starts the server, </span><span style="color: rgb(0, 0, 0);">runs
the poststarttest suites
</span><span style="color: rgb(0, 0, 0);">(make poststarttests plus
more)
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">make -f TestMakefile tests -
combines prestarttests and
</span><span style="color: rgb(0, 0, 0);">poststarttests
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">make -f TestMakefile standardtests -
runs the basic poststarttests </span><span style="color: rgb(0, 0, 0);">(make
poststarttests) multiple
</span><span style="color: rgb(0, 0, 0);">times with various options.
</span><br style="color: rgb(0, 0, 0);">
<br style="color: rgb(0, 0, 0);">
<br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0); font-weight: bold;">BuildMakefile
commands </span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"></span><br>
</font></font>Some examples:<font><font color="RED"><br
style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"> make -f pegasus/mak/BuildMakefile
cleanbuild - Remove the existing pegasus </span><span
style="color: rgb(0, 0, 0);">directory, perform a CVS
</span><span style="color: rgb(0, 0, 0);">checkout of the pegasus
source,
</span><span style="color: rgb(0, 0, 0);">build, and run tests.
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">make -f pegasus/mak/BuildMakefile
removeall
- Remove the existing pegasus
</span><span style="color: rgb(0, 0, 0);">directory.
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"></span><span
style="color: rgb(0, 0, 0);"></span><span style="color: rgb(0, 0, 0);">make
-f pegasus/mak/BuildMakefile
recheckout - Remove the existing pegasus
</span><span style="color: rgb(0, 0, 0);">directory and perform a CVS
</span><span style="color: rgb(0, 0, 0);">checkout of the pegasus
source.
</span><br style="color: rgb(0, 0, 0);">
<br>
<span style="color: rgb(0, 0, 0);">The following sequence builds the
tree, the repository, the testrepository,
</span><span style="color: rgb(0, 0, 0);">starts the server and runs
the server tests suites.
</span><br style="color: rgb(0, 0, 0);">
<br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"> make world
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"> make testrepository
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);"> make -f TestMakefile poststarttests
</span><br style="color: rgb(0, 0, 0);">
<span style="color: rgb(0, 0, 0);">
</span><br>
</font></font><br>
<span style="font-family: monospace;"><br>
</span>
<h1><a name="docs">Pegasus Documentation</a></h1>
<p>The documentation is currently in preparation. Much of Pegasus
is documented in the PEGASUS PEPs which are the basis for approval of
Pegasus functionality, changes, plans, etc. These documents are
openly available on the PEGASUS web site. The preliminary
documentation
is not provided with this release. The current documentation is
maintained both as a manual created
under the tool DOC++ in the runtime subdirectory manual/html (see
doc/devManual to create), as an api document also creatable from the
source tree (see doc/apidoc) and as other miscellaneous documentation
in the doc directory. Also there is a set of release notes. Normally
the release notes for the current release are available in the root
source directory of CVS.</p>
<p>Note that the Pegasus WEB site at The Open Group will be the source
of most
documentation in the future and today is the source of most discussion
and
design documentation. </p>
<h1><a name="part">How to Participate</a></h1>
<p><span class="norm"></span><font style="color: rgb(0, 0, 0);">Contributors
are welcome to participate in the OpenPegasus development effort. Join
the mailing list by visiting www.openpegasus.org and clicking on
Mailing Lists.</font></p>
<h1>
<a name="inst_peg">Pegasus Install</a> </h1>
<p>RPM installation instructions can be found here: <a
href="http://www.openpegasus.org/pr/">http://www.openpegasus.org/pr</a><br>
</p>
<p><strong><strong>Verify Dependencies<br>
</strong></strong></p>
<p><strong><strong><span style="font-weight: bold;"></span>Be</strong></strong>fore
you install Pegasus be sure you have the proper set of software
Pegasus is dependent on. <a href="#peg_dep">See Dependencies
section.</a><br>
</p>
<strong></strong>
<p> <a name="set_envt_var"><strong>Set the environment
variables<br>
</strong></a></p>
<p>Before installing or running OpenPegasus, environment variables may
have to be defined or updated. <br>
<strong><br>
</strong></p>
<p><a
href="http://www.openpegasus.org/pp/uploads/40/8502/PEP200_RecommendedReleaseOptions.htm">PEP
200</a> contains the list of environment variables and setup necessary
to use OpenPegasus.<br>
</p>
<p></p>
<ul>
</ul>
<p></p>
<h2><a name="pop_peg_rep">Populate the Pegasus repository</a> </h2>
<p>
Before using Pegasus you must populate the repository. Typically, this
is done during the build process when you run the makefile. However,
you
can also do it manually after the Pegasus has been built. </p>
<ol>
<li>Register the MOF (Managed Object Format) file describing the
skeleton of the object. </li>
<li>Register a second MOF which only points out which lib*.so file to
be loaded when a specific object is activated. </li>
</ol>
<p></p>
<p>
The providers included with Pegasus are automatically entered into the
repository
by running the following command: <tt>make repository</tt>
</p>
<p>
The 'make repository' in the pegasus directory does three things:
</p>
<ul>
<li><span class="norm"></span> Removes the existing repository if one
exists.</li>
<li>Generates the CIM Schema v2.9 in the repository (skeleton of CIM
objects). </li>
<li><span class="norm"></span><font style="color: rgb(0, 0, 0);">Loads
schema for CIM Server functions </font>(shutdown, add users, etc) and
CIM indications
(SNMP, Events, Alert, Threshold, etc)
internal to the Pegasus. </li>
<li>Registers included CIM Providers (libOSProvider.so,
libDNSProvider.so, … ) in Pegasus (which are located in
src/Providers) </li>
</ul>
<h2>
<a name="reg_prov">Registering
Providers in the Pegasus Environment</a></h2>
<p>
Pegasus registers providers with a set of provider registration
classes, not using the provider qualifier as is done in most DMTF CIM
CIMOM implementations today. This set of classes is close to but not
exactly the same as the experimental DMTF definition (See the DMTF
Interop
schema, experimental versions starting with 2.6). This will be
harmonized in the future when the DMTF scheme is moved to final
status. </p>
<p><span class="norm"></span><font style="color: rgb(0, 0, 0);">Registration
is performed by creating instances</font> of the
registration classes that represent the provider module, providers,
classes, etc. to be registered. The easiest way to create a new
registration today is to copy from one of the existing registration
MOFs. See the providers/sample/load directory for examples of
several registration instance implementations that do work with
OpenPegasus
today.</p>
<strong><br>
</strong>
<h2><a name="note_bld_peg_lnx">Notes about
Building OpenPegasus on Linux </a></h2>
<p>
To build OpenPegasus on Linux, ensure that you you have the environment
variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For
32 bit linux, the definition of PEGASUS_PLATFORM is normally
LINUX_IX86_GNU).
</p>
<br>
<h2><a name="bld_peg_win">Notes
on building OpenPegasus on Windows 2k or Windows XP with Microsoft
Visual
C++ </a></h2>
<p>
Use of Windows 2000 SP3 or later is recommended. OpenPegasus is
regularly tested on both Windows 2000 and Windows XP using the
Microsoft compilers.</p>
<p>Today we build OpenPegasus on Windows using a set of make files
contained
in the source distribution, the Microsoft compilers (DevStudio 5.x is
not supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE
make utility. Note that you MUST have the OpenPegasus <a
href="#mu_utility">mu.exe </a>utility compiled and available
before trying to compile OpenPegasus on the normal windows platform.
The
following is the basic setup steps for the environment.
</p>
<p>Setup the environment variables and path for the Micrososft Visual C
compiler.
Typically this can be done by running the VCVARS32.BAT file supplied
with Microsoft Visual C++. (contained in the same directory as cl.exe).
</p>
<p>For Windows, try the following for an example environment: </p>
<blockquote>
<pre>REM call the standard Microsoft .bat for VC 6 setup. <br>call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat' <br>REM Set debug to something if you want compile in debug mode <br>set PEGASUS_DEBUG=true <br>REM set PEGASUS_ROOT to top of source tree <br>set PEGASUS_ROOT=C:/cimom/pegasus (Note: <span
class="norm">The '/' characters are intentional and required by the OpenPegasus build system)</span><br>REM set PEGASUS_HOME to where you want repository and executables<br>set PEGASUS_HOME=%PEGASUS_ROOT% <br>REM setup the path to the runtime files. <br>set path=%path%;%PEGASUS_HOME%\bin <br></pre>
</blockquote>
<h3>
<a name="mu_utility">The MU Utility </a></h3>
<p>
In order to provide a consistent build structure across multiple
platforms, we
developed a small utility to provide a consistent set of small
utilities
across these platforms. The MU utility is a simple utility that
contains
many
commands. For example:
</p>
<p><font face="Courier New">
C:\> mu rm myfile.cpp yourfile.cpp </font>
</p>
<p>You may type "mu" to get a list of valid commands. Here are some
of them:
</p>
<p>
rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare depend
</p>
<p>The MU utility supports globing (expansion of wildcards) so
you can do things like this:
</p>
<p><font face="Courier New">
C:\> mu rm *.obj *.exe </font>
</p>
<p>MU is required to build under the Windows environment. MU is
available as part
of the distribution of OpenPegasus.<br>
</p>
NOTE: The binary for MU.EXE is not distributed in the OpenPegasus bin
directory.
You must build it separately. MU source code is part of the
distribution
in the directory src/utils/MU with its own make file. You must compile
MU
before you initiate the OpenPegasus make.<br>
A copy of the binary is made available as a zip file on the OpenPegasus
WEB site.
<p></p>
<h2><a name="note_bld_peg_ssl">Notes about
Building OpenPegasus with SSL
</a></h2>
<p>
To build with SSL you need the OpenSSL libraries and header files. They
are NOT distributed with OpenPegasus. Make sure you have them in a
standard
directory so OpenPegasus can find them. If that's not
the case, set the environment variable OPENSSL_HOME= to point where
your OpenSSL
installation is.
</p>
<p>Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make'
in Pegasus
directory and you will have OpenPegasus with SSL enabled. See "Creating
SSL
certificates" below for more information on how to use SSL.
</p>
Refer to the SSL Admin guide found in the doc directory for details on
using OpenPegasus with SSL.<br>
<p></p>
<h1>
<a name="test">Testing a OpenPegasus Installation</a></h1>
<p>
OpenPegasus includes an extensive set of test facilities as part of the
CVS
environment, including:
</p>
<ul>
<li><b>Test Clients</b> - There are several clients that have been
built specifically to test OpenPegasus, or parts of OpenPegasus,
including
TestClient, Client, CLI, ipinfo, osinfo, WbemEsec, etc. See the
src/Clients directory for more information. These programs require a
server complete with repository to be running. Note that some of
these tests use classes and instances that are only installed with the
"make testrepository" functions including test namespaces and extra
classes and instances in those namespaces and additional providers from
the providers/sample and providers/testproviders directories. </li>
<li><b>Sample and test providers</b> - Test providers exist for
the major provider types in the providers/sample directories and the
providers/testProviders directory </li>
<li><b>Unit Tests</b> - Most OpenPegasus functions include unit tests
for
the functions. These are normally executed with the "make tests"
command which can be executed at many different levels of the source
tree from the top level to execute all of the unit tests to individual
directories. Usually the unit test functions can be found in test
directories immediately below their corresponding source code
(i.e common/tests is the unit test functions for the common
directory). Unit tests are executed without the server being
operational and normally do not require the existence of a Class
repository. </li>
<li><b>An end-to-end Test Suite</b> - the directory "test" contains a
set of operations tests that cover the major CIM operations. See
the make file TestMakefile in the PEGASUS_ROOT directory to execute
these tests. This set of tests executes an extensive set of fixed
tests and compares the results against predefined results.</li>
</ul>
<p></p>
<br>
<h2><a name="test_icu">Testing with ICU enabled</a></h2>
<p>ICU (International Components for Unicode) refers to the set of
libraries that OpenPegasus uses to run globalized. For example: these
libraries are used
to
load messages in different languages, format currency and numbers
according to
a specific locale etc. In order to enable globalization in OpenPegasus,
OpenPegasus
must be built with ICU enabled, ie. the right environment variables
must be
set prior to running "make". Refer to the GlobalizationHOWTO.htm in the
docs
directory for details.<br>
</p>
<p> When users run "make poststarttests"
to verify the integrity of a OpenPegasus download, a series of tests
are
run that
require the cimserver to be running. These tests currently depend on
specific
messages returned from the server. When ICU is enabled, all messages
come from the resource bundles and these usually do not match the
hardcoded default messages within OpenPegasus. These hardcoded default
messages are what the various test programs expect in order to complete
successfully. If the ICU enabled server is started without
disabling message loading from the bundles, "make poststartests" will
fail.
In order to run "make poststarttests" successfully with ICU enabled, an
environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist
prior to
starting the server. Once this is defined, when the cimserver starts,
all
messages generated will be the default hardcoded messages. This will
enable
"make poststarttests" to complete successfully. Once "make
poststarttests" is
complete, you should stop the cimserver and then undefine
PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined,
OpenPegasus
will not be able to load messages
using ICU resource bundles.<br>
</p>
<p><span class="norm"></span><font style="color: rgb(0, 0, 0);">When
running the make tests command with ICU enabled, the PEGASUS_MSG_HOME
environment variable must be set to the home directory where the ICU
resource bundles are built. By default the resource bundles are built
into directories below PEGASUS_HOME/msg, so that should be the setting
for PEGASUS_MSG_HOME.<br>
</font></p>
<p><font style="color: rgb(0, 0, 0);">-------------------------------------------------------------------------------------------------------------------------------------<br>
</font></p>
<p><i><font size="2">Copyright (c) 2005 EMC Corporation;
Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group;
VERITAS Software Corporation</font><br>
<br>
<font size="1">Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:</font><br>
<font size="2"><br>
</font>
<font size="1">THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE
SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE
SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<br>
</font></i></p>
<p><i><font size="1"><br style="font-family: arial;">
<big><big><span style="font-family: arial;">------------------------End
of
Document-------------------------<br>
</span></big></big></font></i></p>
<p><span style="color: rgb(0, 0, 0);"></span> </p>
</body>
</html>
| No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |