version 1.1, 2003/11/13 16:02:37
|
version 1.8, 2004/12/01 09:51:58
|
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
<html> | <html> |
| |
<head> | <head> |
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
<meta name="GENERATOR" content="Microsoft FrontPage 3.0"> |
<meta name="ProgId" content="FrontPage.Editor.Document"> | <meta name="ProgId" content="FrontPage.Editor.Document"> |
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> | <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> |
<title>OpenPegasus</title> | <title>OpenPegasus</title> |
|
|
<body> | <body> |
| |
<p align="center"><b><font size="4">Pegasus Enhancement Proposal (PEP)</font></b></p> | <p align="center"><b><font size="4">Pegasus Enhancement Proposal (PEP)</font></b></p> |
<p style="margin-top: 0; margin-bottom: 0"><b>PEP #:</b> 103</p> |
|
<p style="margin-top: 0; margin-bottom: 0"><b>Title: </b>OpenPegasus Version 2.3 |
|
Release Readme file</p> |
|
<p style="margin-top: 0; margin-bottom: 0"><b>Version: </b>1.0</p> |
|
<p style="margin-top: 0; margin-bottom: 0"><b>Created:</b> 12 November 2003</p> |
|
<p style="margin-top: 0; margin-bottom: 0"><b>Authors: </b>Karl Schopmeyer</p> |
|
<p style="margin-top: 0; margin-bottom: 0"><b>Status: </b>draft</p> |
|
<p style="margin-top: 0; margin-bottom: 0"><b>Version History:</b></p> |
|
<table border="1" cellspacing="1" bordercolordark="#666666" |
|
bordercolorlight="#CCCCCC" width=100% |
|
style='font-size=10.0pt;font-family:Arial'> |
|
<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">12 Novemberl 2003</td> |
|
<td align="center">Karl Schopmeyer</td> |
|
<td>Update from 2.2 Release notes. Converted to HTML</td> |
|
</tr> |
|
<tr> |
|
<td align="center"> </td> |
|
<td align="center"> </td> |
|
<td align="center"> </td> |
|
<td> </td> |
|
</tr> |
|
</table> |
|
<hr> |
|
<p><b>Abstract:</b> Installation, build, operation information on the |
|
Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with |
|
the documentation in the release notes or interface defintion documents for a |
|
particular release, those documents should be considered authorative. This is a |
|
simplified overview to act as an introduction to Pegasus.</p> |
|
<hr> |
|
| |
<p align="Center"><b><font size="5">OpenPegasus - A Manageability Services Broker |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>PEP #:</b> 175</p> |
for the DMTF CIM/WBEM Standards |
|
</font> |
|
</b> |
|
| |
<p align="left"> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Title: </b>OpenPegasus Version 2.4 |
<b>Tagline:</b> OpenPegasus is an object manager for DMTF CIM objects written in C++ |
Release Readme file</p> |
and supported by The Open Group </p> |
|
| |
<p align="left"> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version: </b><span |
|
style="color: rgb(0, 0, 0);">1.4</span></p> |
| |
<b>STATUS:</b> Revised October 2003 for Pegasus release version 2.3. |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Created:</b> 24 June 2004</p> |
</p> |
|
| |
<p align="center"> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Authors: </b>Warren Grunbok, Mike |
<b><font size="4">Table of Contents</font></b><p align="left" style="margin-top: 0; margin-bottom: 0"> |
Harris<br> |
<a href="#Overview"> Overview</a> |
</p> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Status: </b>draft</p> |
<a href="#Availability of Pegasus">Availability of Pegasus</a><p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
<a href="#Pegasus Major Components">Pegasus Major Components</a><p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
<a href="#Pegasus Supported Platforms">Pegasus Supported Platforms</a><p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
<a href="#Pegasus Dependencies">Pegasus Dependencies </a> |
|
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version History:</b></p> |
<a href="#The Pegasus Directory Structure">The Pegasus Directory Structure</a> |
|
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<table bordercolordark="#666666" bordercolorlight="#cccccc" style="font-family: Arial;" |
<a href="#Pegasus Installation">Installation</a> |
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">24, June 2004</td> |
|
<td align="center">Warren Grunbok<br> |
|
</td> |
|
<td>Initial draft<br> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td align="center"> 1.1</td> |
|
<td align="center">24,August 2004 <br> |
|
</td> |
|
<td align="center">Warren Grunbok <br> |
|
</td> |
|
<td>Mostly spelling changes, adds to very last paragraph <br> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td style="vertical-align: top;">1.2<br> |
|
</td> |
|
<td style="vertical-align: top;">31, August 2004<br> |
|
</td> |
|
<td style="vertical-align: top;">Warren Grunbok<br> |
|
</td> |
|
<td style="vertical-align: top;">Changes based on architecture review. Removed |
|
/Directory structure section and placed into seperate document.<br> |
|
<br> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td style="vertical-align: top;">1.3<br> |
|
</td> |
|
<td style="vertical-align: top;">???<br> |
|
</td> |
|
<td style="vertical-align: top;">Warren Grunbok<br> |
|
</td> |
|
<td style="vertical-align: top;">Removed Pegasus Directory structure and placed in PEP |
|
191, Added Copyright and End of Doc marker.<br> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td style="vertical-align: top; color: rgb(0, 0, 0);">1.4<br> |
|
</td> |
|
<td style="vertical-align: top; color: rgb(0, 0, 0);">27, Sept 2004<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);">Corrected Security changes as per |
|
Sterling.<br> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<hr> |
<a href="#Building Pegasus">Building Pegasus </a> |
|
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p><b>Abstract:</b> Installation, build, operation information on the Pegasus |
<a href="#Populate the Repository">Populate the Repository</a> |
Platform Version 2.4.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 Pegasus.</p> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<hr> |
<a href="#Registering Providers in the Pegasus Environment">Registering |
|
Providers</a><p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
<a href="#The MU Utility">The MU Utility</a> |
|
| |
|
<p align="center"><b><font size="5">OpenPegasus - A Manageability Services Broker for the |
|
DMTF CIM/WBEM Standards </font></b></p> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p align="left"><b>Tagline:</b> OpenPegasus is an object manager for DMTF CIM objects |
<a href="#Notes about Building Pegasus on Linux">Notes about Building Pegasus on Linux</a> |
written in C++ and supported by The Open Group </p> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p align="left"><b>STATUS:</b> Revised Sept 2004 for Pegasus release version |
<a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a> |
2.4.0 - Approved<br> |
|
</p> |
|
<a href="#Overview"> |
|
|
|
<p>Overview</a> </p> |
|
|
|
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> |
|
<a href="#avail_of_peg"><p>Availability of Pegasus</a><br> |
|
<a href="#peg_maj_comp">Pegasus Major Components</a><br> |
|
<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">The Pegasus Directory Structure</a><br> |
|
<a href="#dev_with_peg">Development with Pegasus and Pegasus Tools</a><br> |
|
<a href="#cmnd">Commands</a><br> |
|
<a href="#docs">Documentation</a><br> |
|
<a href="#part">Participate</a><br> |
|
</p> |
|
</blockquote> |
|
<a href="#inst_peg"> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p>Install Pegasus</a> </p> |
<a href="#Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++">Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a><p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
<a href="#Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client |
|
</a> |
|
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> |
<a href="#Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a> |
<a href="#download"><p>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="#bld_rpms">Build an RPM for Pegasus</a><br> |
|
<a href="#note_bld_peg_lnx">Notes about Building Pegasus on Linux</a><br> |
|
<a href="#note_bld_peg_mac">Notes about Building Pegasus on Mac OS X</a><br> |
|
<a href="#note_bld_peg_ssl">Notes on building Pegasus with SSL</a><br> |
|
<a href="#crt_ssl_cert">Creating SSL certifications</a><br> |
|
<a href="#bld_peg_win">Building Pegasus on Windows 2000 or Windows XP With Microsoft |
|
Visual C++</a><br> |
|
<a href="#mu_utility">The MU Utility</a><br> |
|
</p> |
|
</blockquote> |
|
<a href="#test"> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p>Test the Pegasus installation</a><br> |
<a href="#Commands">Commands</a> |
</p> |
|
|
|
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> |
|
<a href="#inst_peg_html"><p>Installing the Pegasus HTML Test Client</a><br> |
|
<a href="#test_icu">Testing with ICU enabled</a><br> |
|
</p> |
|
</blockquote> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<hr> |
<a href="#Creating SSL certifications">Creating SSL certifications</a>. |
|
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<h1><a name="Overview">Overview</a> </h1> |
<a href="#Testing with ICU enabled">Testing with ICU enabled </a> |
|
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p><b>OpenPegasus (also referred to as Pegasus):</b> Pegasus is an open-source CIM Server |
<a href="#Pegasus Documentation">Documentation</a> |
for DMTF CIM objects. It is written in C++ and includes the Object manager (CIMOM), a set |
|
of defined interfaces, an implemenation 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. </p> |
|
|
|
<p>Pegasus is open source and is covered under the MIT open-source license.</p> |
|
|
|
<p>Pegasus is being developed and maintained under the auspices of The Open Group. Pegasus |
|
is maintained under the license defined in the doc directory (LICENSE) of this release. |
|
This licensing is intended to support as wide a distribution as possible with minimal |
|
demands on the users. </p> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<p>More information on this project, access to the CVS, and documentation on Pegasus are |
<a href="#Participate!">Participate</a> |
available from the OpenGroup WEB site. </p> |
| |
<h1><a name="Overview">Overview</a> </h1> |
<p> <a target="blank" href="http://www.openpegasus.org">http://www.openpegasus.org</a></p> |
| |
<p>OpenPegasus (also referred to as Pegasus): |
<p>There are a number of separate documents representing the status and each release of |
|
Pegasus |
| |
Pegasus is an open-source object manager (CIMOM) for DMTF CIM objects. It is written |
|
in C++ and includes the Object manager, a set of defined interfaces, 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. |
|
<P> |
|
Pegasus is open source and is covered under the MIT open-source license. |
|
<P> |
|
Pegasus is being developed and maintained under the auspices of The Open |
|
Group. Pegasus is maintained under the license defined in the doc directory |
|
(LICENSE) of this release. This licensing is intended to support as wide a |
|
distribution as possible with minimal demands on the users. |
|
<P> |
|
More information on this project, access to the CVS, and documentation on |
|
Pegasus are available from the OpenGroup WEB site. |
|
<P> |
|
<a href="http://www.opengroup.org">http://www.openpegaus.org</a><p> |
|
There are separate documents |
|
<ul> | <ul> |
<li>What's new for this release - WHATSNEW and the release notes for each |
<li>What's new for this release - See the PEPs (Pegasus Enhancement Procedures) release |
release.<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and |
notes on the Pegasus web site and duplicated in the source top level directory </li> |
the web site as a Pegasus PEP.<li>Release Notes for each released version</ul> |
<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and the web site |
|
as a Pegasus PEP.</li> |
|
</ul> |
| |
|
<p>The release notes are available on the WEB site as Pegasus PEP documents and in the CVS |
|
for each release.</p> |
| |
<p>The release notes are available on the WEB site as Pegasus PEP documents and |
<table id="AutoNumber3" border="1" cellspacing="1" width="31%"> |
in the CVS for each release.</p> |
<tbody> |
<table border="1" cellspacing="1" width="31%" id="AutoNumber3"> |
|
<tr> | <tr> |
<td width="42%">Release</td> |
<td width="42%"><b>Release</b></td> |
<td width="58%">Release Notes PEP</td> |
<td width="58%"><b>Release Notes PEP</b></td> |
</tr> | </tr> |
<tr> | <tr> |
<td width="42%">2.0</td> | <td width="42%">2.0</td> |
|
|
<td width="42%">2.3</td> | <td width="42%">2.3</td> |
<td width="58%">PEP 98</td> | <td width="58%">PEP 98</td> |
</tr> | </tr> |
|
<tr> |
|
<td style="vertical-align: top;">2.4<br> |
|
</td> |
|
<td style="vertical-align: top;">PEP 185<br> |
|
</td> |
|
</tr> |
|
</tbody> |
</table> | </table> |
| |
|
<h2><a name="avail_of_peg">Availability of Pegasus</a></h2> |
| |
<h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1> |
<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><font face="Courier New"> cvs.opengroup.org:/cvs/MSB </font></p> |
|
|
|
<p>using the password authenticating server option (pserve). </p> |
|
|
|
<p>Anonymous access for read is with the name and password "anon" as follows: </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. |
|
The source code from CVS can be found at the following Open Group CVS server; |
|
<p> |
|
<font face="Courier New"> |
|
cvs.opengroup.org:/cvs/MSB </font> |
|
<p> |
|
using the password authenticating server option (pserve). |
|
<p> |
|
Anonymous access for read is with the name and password "anon" as follows: |
|
<blockquote> | <blockquote> |
<p style="margin-top: 0; margin-bottom: 0"> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><font face="Courier New">%export |
<font face="Courier New">%export CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB |
CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB </font></p> |
</font> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><font face="Courier New">%cvs login </font></p> |
<p style="margin-top: 0; margin-bottom: 0"><font face="Courier New">%cvs login |
|
</font> |
|
</blockquote> | </blockquote> |
<p> |
|
When requested, enter the password "anon". |
|
The source tree is in the directory pegasus. To check out the complete Pegasus |
|
source tree just type: |
|
<p> |
|
<font face="Courier New"> |
|
cvs co pegasus </font> |
|
<p> |
|
A Pegasus directory will be created under the current directory and populated |
|
with the complete source tree and documentation. To get the latest updates |
|
after a checkout just type this from Pegasus root: |
|
<p> |
|
<font face="Courier New"> |
|
cvs update -d </font> |
|
|
|
<p> |
|
Active contributors to Pegasus have write access to the CVS repository. |
|
If you are interested in contributing back to the Pegasus project, |
|
(i.e. write (checkin) access to CVS) please request access from either |
|
Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer |
|
<a href="mailto:(k.schopmeyer@opengroup.org">(k.schopmeyer@opengroup.org</a>). |
|
| |
<h1> |
<p>When requested, enter the password "anon". The source tree is in the |
<a name="Pegasus Major Components">Pegasus Major Components</a></h1> |
directory pegasus. To check out the complete Pegasus source tree just type: </p> |
|
|
|
<p><font face="Courier New"> cvs co pegasus </font></p> |
|
|
|
<p>A Pegasus directory will be created under the current directory and populated with the |
|
complete source tree and documentation. To get the latest updates after a checkout just |
|
type this from Pegasus root: </p> |
|
|
|
<p><font face="Courier New"> cvs update -d </font></p> |
|
|
|
<p>Active contributors to Pegasus have write access to the CVS repository. If you are |
|
interested in contributing back to the Pegasus project, (i.e. write (checkin) access to |
|
CVS) please request access from either Martin Kirk (<a |
|
href="mailto:(k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>) or Karl Schopmeyer <a |
|
href="mailto:(k.schopmeyer@opengroup.org">k.schopmeyer@opengroup.org</a>. </p> |
|
|
|
<h2><a name="peg_maj_comp">Pegasus Major Components</a></h2> |
| |
<p>The major components of Pegasus are: | <p>The major components of Pegasus are: |
|
|
<ul> | <ul> |
<li><b>Pegasus Server</b> - WBEM/CIM Server with interfaces for providers and clients |
<li><b>Pegasus Server</b> - WBEM/CIM Server with interfaces for providers and clients </li> |
</li> |
|
<li><b>Pegasus Repositories</b> - Today Pegasus provides a defined class repository | <li><b>Pegasus Repositories</b> - Today Pegasus provides a defined class repository |
interface and a simple file based class repository. It also includes |
interface and a simple file based class repository. It also includes an instance |
an instance repository. Note that these repository were created for |
repository. Note that these repository were created for functionality, not efficieny. It |
functionality, not efficieny. It is expected that they will be replaced |
is expected that they will be replaced with other implementations of the respository |
with other implementations of the respository function as the need arises. |
function as the need arises. </li> |
</li> |
|
<li><b>Pegasus Client Library</b> - Tools for building Pegasus clients based on the Pegasus | <li><b>Pegasus Client Library</b> - Tools for building Pegasus clients based on the Pegasus |
C++ interfaces and using the WBEM HTTP/XML protocols or directly |
C++ interfaces and using the WBEM HTTP/XML protocols or directly interfacing with Pegasus. |
interfacing with Pegasus. |
|
</li> |
|
<li><b>Pegasus Test Clients</b> - Simple test clients being developed as part of the |
|
Pegasus development process |
|
</li> | </li> |
<li><b>Pegasus HTML Test Client</b> - To aid in testing we created a test client for |
<li><b>Pegasus Test Clients</b> - Simple test clients being developed as part of the Pegasus |
Pegasus that uses a WEB server (ex. Apache) with a set of CGI modules and |
development process. These can be seen in the src/Clients directory and its subdirectories |
HTML to allow the entry of Pegasus operations from a WEB browser as forms |
|
and the receipt of the response as WEB pages. This has proven useful as a |
|
test tool and can be used for a wide variety of demonstrations. |
|
</li> | </li> |
|
<li><b>Pegasus HTML Test Client</b> - To aid in testing we created a test client for Pegasus |
|
that uses a WEB server (ex. Apache) with a set of CGI modules and HTML to allow the entry |
|
of Pegasus operations from a WEB browser as forms and the receipt of the response as WEB |
|
pages. This has proven useful as a test tool and can be used for a wide variety of |
|
demonstrations. </li> |
<li><b>Pegasus Provider Library</b> - Tools for building Pegasus providers using the Pegasus | <li><b>Pegasus Provider Library</b> - Tools for building Pegasus providers using the Pegasus |
C++ interfaces. |
C++ interfaces. </li> |
</li> |
<li><b>Pegasus Providers</b> - Providers to illustrate the use of Pegasus services including |
<li><b>Pegasus Providers</b> - Providers to illustrate the use of Pegasus services |
providers for test and demonstration. </li> |
including providers for test and demonstration. |
<li><b>Pegasus Control Providers</b> - Common services for use by other Pegasus components |
</li> |
to extend Pegasus capabilites. </li> |
<li><b>Pegasus Control Providers</b> - Common services for use by other Pegasus |
<li><b>Pegasus MOF Compiler </b>- There standalone compiler (cimmofl) for MOF files |
components to extend Pegasus capabilites. |
that can be used to install MOF into the Pegasus schema repository and also to check |
</li> |
syntax. There is also a compiler that operates as a Pegasus client(cimmof) There is also a |
<li><b>Pegasus MOF Compiler </b>- There standalone compiler (cimmofl) for MOF files that can be used |
tool to extract the MOF from the repository. </li> |
to install MOF into the Pegasus schema repository and also to check syntax. |
|
There is also a compiler that operates as a Pegasus client(cimmof) |
|
There is also a tool to extract the MOF from the repository. |
|
|
|
</li> |
|
</ul> | </ul> |
| |
<h1> |
<h2><a name="peg_sup_plat">Pegasus Supported Platforms</a></h2> |
<a name="Pegasus Supported Platforms">Pegasus Supported Platforms</a></h1> |
|
| |
<p> |
<p>Pegasus is regularly tested against a variety of platforms by the development |
Pegasus is regularly tested against a variety of platforms by the development |
group. The set of platforms and exact set of compilers for any given release is |
group. The set of platforms and exact set of compilers for any given |
documented in the Release notes for that release (see the CVS source tree root directory |
release is documented in the Release notes for that release (see the CVS source |
or the Pegasus PEP defining the ReleaseNotes for any particular release).</p> |
tree root directory or the Pegasus PEP defining the ReleaseNotes for any |
|
particular release).</p> |
|
| |
<p> |
<p>Pegasus is supported on a variety of platforms. The list of platforms can be |
Generally Pegasus is supported on the following Platforms and Compilers.</p> |
found in the release notes associated with this release.<br> |
<table border="1" cellspacing="1" id="AutoNumber2" width="728"> |
</p> |
<tr> |
|
<td width="169" bgcolor="#99FF99"><b>Platform and OS</b></td> |
|
<td width="556" bgcolor="#99FF99"><b>Compilers</b></td> |
|
</tr> |
|
<tr> |
|
<td width="169">AIX</td> |
|
<td width="556">VisualAge C++ Version</td> |
|
</tr> |
|
<tr> |
|
<td width="169">HP-UX</td> |
|
<td width="556">HP aC++ </td> |
|
</tr> |
|
<tr> |
|
<td width="169">Linux Itanium</td> |
|
<td width="556">gcc</td> |
|
</tr> |
|
<tr> |
|
<td width="169">Linux IA-32</td> |
|
<td width="556">gcc (versions 2.9x and 3.xx)</td> |
|
</tr> |
|
<tr> |
|
<td width="169">Windows 2000</td> |
|
<td width="556">Microsoft Visual C++ Ver 6 and Microsoft .Net compiler |
|
Version <font color="#FF0000">7</font></td> |
|
</tr> |
|
<tr> |
|
<td width="169">Windows XP</td> |
|
<td width="556">Microsoft Visual C++ Ver. 6 and Microsoft .Net compiler |
|
Version <font color="#FF0000">7</font></td> |
|
</tr> |
|
</table> |
|
| |
<h1> |
<p><br> |
<a name="Pegasus Dependencies">Pegasus Dependencies </a></h1> |
</p> |
| |
<p> |
<h2><a name="peg_dep">Pegasus Dependencies</a></h2> |
We have worked to minimize the dependence of Pegasus on other software |
|
packages and tools. Currently Pegasus has the following dependencies: |
<p>We have worked to minimize the dependence of Pegasus on other software packages and |
<p> |
tools. Currently Pegasus has the following dependencies: </p> |
<b>1. GNUMAKE</b> - To simplify the building of Pegasus across multiple platforms we |
|
|
<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 |
have standardized on a set of build tools including: GNUMAKE. We are using GNUMAKE 3.79.1 |
GNUMAKE 3.79.1 successfully both in Windows and Linux environments. |
successfully both in Windows and Linux environments. </p> |
<p> |
|
GNUMAKE is available from :<p> |
<p>GNUMAKE is available from :</p> |
<a href="http://www.gnu.org">http://www.gnu.org</a> |
|
|
<p> <a target="blank" href="http://www.gnu.org">http://www.gnu.org</a> |
<p> |
</p> |
NOTE: A set of the required tools for |
|
windows platforms is available on the openpegasus web site.<p> |
<p> NOTE: A set of the required tools for windows |
<b>2. MU.EXE </b>- To minimize the difference between Linux and Windows for GNUMAKE, |
platforms is available on the openpegasus web site. <a href="www.openpegasus.org">www.openpegasus.org</a><br> |
we have created a utility called MU.exe. This utility is required for |
</p> |
Pegasus make with ONLY Windows environment. It is provided as an alternative to |
|
requiring a number of UNIX utilities (SH, RM, etc.) on the windows platform |
<p><b>2. MU.EXE </b>- To minimize the difference between Linux and Windows for GNUMAKE, we |
and effectively provides the functions of these utilities that GNUMAKE |
have created a utility called MU.exe. This utility is required for Pegasus make with ONLY |
needs. MU is not required on UNIX or LINUX platforms. |
Windows environment. It is provided as an alternative to requiring a number of UNIX |
<p> |
utilities (SH, RM, etc.) on the windows platform and effectively provides the functions of |
NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory. |
these utilities that GNUMAKE needs. MU is not required on UNIX or LINUX platforms. </p> |
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 |
<p>NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory. You must |
before you initiate the Pegausu make. |
build it separately. MU source code is part of the distribution in the directory |
<p> |
src/utils/MU with its own make file. You must compile MU before you initiate the Pegausu |
NOTE: A copy of the binary is made available as a zip file on the Pegasus |
make. </p> |
WEB site. |
|
<p> |
<p>NOTE: A copy of the binary is made available as a zip file on the Pegasus WEB site. </p> |
Again, MU is used ONLY if you are using Windows. |
|
|
<p>Again, MU is used ONLY if you are using Windows. </p> |
<p> |
|
<b>3. FLEX and BISON</b> - These tools were used to develop the MOF compiler and WQL |
<p><b>3. FLEX and BISON</b> - These tools were used to develop the MOF compiler and WQL |
parser. Anybody intending to recompile the compiler or parser from scratch |
parser. Anybody intending to recompile the compiler or parser from scratch will be |
will be required to have these tools. They are only required if changes need |
required to have these tools. They are only required if changes need to be made to the |
to be made to the files for parsing and compiling. |
files for parsing and compiling. </p> |
<p><b>4. DOC++ </b>- The Pegasus documentation is taken from a combination of text files |
<b> |
and the Pegasus header files themselves. This documentation is formatted |
|
with DOC++ and GAWK. These tools are required if the documentation is to |
<p>4. DLCOMPAT - </b>dlcompat is a dlopen(3) et.al. compatibility library for Mac OS |
be recreated but we expect that only the core team will be recreating |
X/Darwin.<br> |
documentation. |
<br> |
|
<strong>NOTE</strong>: The dlcompat is not distributed with pegasus source.<br> |
<p><b>5. ICU Internationalization libraries</b> - These libraries are used as |
dlcomapt is avilable from <br> |
the basis for message catalogs for message internationalization. See the ICU |
<br> |
website (http://oss.software.ibm.com/icu/) for more information on these |
<a href="http://www.opendarwin.org/projects/dlcompat/">http://www.opendarwin.org/projects/dlcompat/ |
libraries<p>6. <b>OpenSSL </b>- If it is intended to use SSL on the |
</a><br> |
communication protocol, the OpenSSL libraries are required.<h1> |
<br> |
<a name="The Pegasus Directory Structure">The Pegasus Directory Structure</a></h1> |
Again, dlcomapt needs to be installed ONLY if you are using Mac OS X/Darwin.</p> |
<p> |
|
Pegasus is distributed as a complete source directory structure that should be |
<p><b>5. DOC++ </b>- The Pegasus documentation is taken from a combination of text files |
installed either from one of the snapshots or from CVS. |
and the Pegasus header files themselves. This documentation is formatted with DOC++ and |
<p> |
GAWK. These tools are required if the documentation is to be recreated but we expect that |
This structure is generally as follows:<p> |
only the core team will be recreating documentation. </p> |
<font face="Courier New">Pegasus Source Structure</font><p> |
|
<font face="Courier New">Pegasus Root directory (PEGASUS_ROOT environment |
<p><b>6. ICU Internationalization libraries</b> - These libraries are used as the basis |
variable)</font><ul> |
for message catalogs for message internationalization. See the ICU website |
<li><font face="Courier New"><b>cgi</b> Source for the Pegasus WEB Based Test client |
(http://oss.software.ibm.com/icu/) for more information on these libraries</p> |
</font> |
|
<ul> |
<p><strong>7.</strong> <b>OpenSSL </b>- If it is intended to use SSL on the communication |
<li><font face="Courier New">cgi-bin CGI Directories for WEB demonstration. |
protocol, the OpenSSL libraries are required.</p> |
This directory is normally empty but can |
|
be populated from the runtime with the make |
<h1><a name="peg_dir_struc">The Pegasus Directory Structure</a></h1> |
from cgi. |
|
</font></li> |
<p>Pegasus is distributed as a complete source directory structure that should be |
<li><font face="Courier New">htdocs HTML Pages for Pegasus WEB demonstration |
installed either from one of the snapshots or from CVS. </p> |
</font></li> |
|
</ul> |
<p>The Pegasus Directory is documented in<span style="color: rgb(51, 255, 51);"> <span |
</li> |
style="color: rgb(0, 0, 0);">PEP 191</span> </span>and listed in the Pegasus /doc |
<li><font face="Courier New"><b>doc</b> Miscellaneous Pegasus Documents. |
directory.<br> |
</font> |
</p> |
<ul> |
|
<li><font face="Courier New">apidoc - Source for the public api |
<h1><a name="dev_with_peg">Development with Pegasus and Pegasus Tools</a></h1> |
documentation.</font></li> |
|
<li><font face="Courier New">DevManual Source and build files for developers' manual |
<p>ATTN: This section needs to be completed. It should reference the more complete |
mak General make files (used by other makes)</font></li> |
documentation. </p> |
</ul> |
|
</li> |
<h1><a name="cmnd">Commands</a></h1> |
<li><font face="Courier New"><b>mak</b> - Common make files for Pegasus |
|
compilation</font></li> |
<p>The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on CVS) </p> |
<li><font face="Courier New"><b>Dummy</b> -</font></li> |
|
<li><font face="Courier New"><b>InterfaceArchive</b> -</font></li> |
<p>To see simple help for each of the commands, use the "-h" flag. </p> |
<li><font face="Courier New"><b>rpm</b> - files for rpm installation for Linux</font></li> |
|
<li><font face="Courier New"><b>Schemas</b> - Schemas used in the installation |
<blockquote> |
of Pegasus. This includes currently released versions of the DMTF schemas in |
<pre>Examples: |
subdirectories (ex. CIM27) and Pegasus local Schemas (ex. </font></li> |
bin/cimserver –s (Shuts it down) |
<li><font face="Courier New"><b>src</b> All Pegasus Source Files |
bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags) |
</font> |
bin/cimprovider –l –s (lists providers and their status) |
<ul> |
bin/cimprovider –e –m OperatingSystemModule (enables the OperatingSystem provider) |
<li><font face="Courier New"><b>ACEExample</b> Test directrory with examples of the use of ACE (obsolete). |
bin/cimuser –a –u guest –w ThePassword |
</font></li> |
bin/cimuser –l (lists the users) |
<li><font face="Courier New"><b>Clients</b> Source for various test |
bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type) |
clients and demonstration clients.</font></li> |
</pre> |
<li><font face="Courier New"><b>CGICLIENT</b> Pegasus test client that uses a WEB browser |
</blockquote> |
JAVA Java Client support modules |
|
</font></li> |
<h1><a name="docs">Pegasus Documentation</a></h1> |
<li><font face="Courier New"><b>Pegasus</b> - Core pegasus modules. |
|
</font> |
<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">Participate!</a></h1> |
|
|
|
<p>We are looking for people who want to join the Pegasus work group and contribute to |
|
effort of getting this Pegasus off the ground. Please join the mailing list by visiting |
|
www.openpegasus.org, and click on Mailing Lists. </p> |
|
|
|
<h1><a name="inst_peg">Install Pegasus</a> </h1> |
|
|
|
<p>You can install and run Pegasus on any of the supported platforms. The installation |
|
process includes the following steps: |
|
|
|
<ol> |
|
<li>Download or checkout Pegasus. </li> |
|
<li>Verify that you have the required software. </li> |
|
<li>Set environment variables. </li> |
|
<li>Build the Pegasus runtime, test files, test clients and repository. </li> |
|
</ol> |
|
|
|
<p><a name="download"><strong>Step 1: Download or checkout Pegasus</strong></a></p> |
|
|
|
<p>Pegasus is freely available from the open group's Pegasus home page: <a target="blank" |
|
href="http://www.openpegasus.org">http://www.openpegasus.org</a>. To obtain Pegasus, you |
|
can either check it out using CVS or download a snapshot image of the soruce distribution. |
|
For more information about checking out Pegasus using CVS, see: <a href="#avail_of_peg">Availability |
|
of Pegasus</a>. </p> |
|
|
|
<p>Pegasus is not currently releasing binaries, but you can create RPMs using a script |
|
included with the source distribution. See <a href="#bld_rpms">Building RPMs for Pegasus</a> |
|
for more information. </p> |
|
|
|
<p><a name="vfy_req_sw"><strong>Step 2: Verify that you have the required software</strong></a></p> |
|
|
|
<p>Refer to the section <a href="#peg_dep">Pegasus Dependencies</a> and verify that you |
|
have the software required for your Operating System and planned usage of Pegasus. </p> |
|
|
|
<p><a name="set_envt_var"><strong>Step 3: Set the environment variables</strong></a></p> |
|
|
|
<p>Before installing or running Pegasus, ensure that the following environment variables |
|
have been defined or updated: |
|
|
|
<dl> |
|
<dt>PEGASUS_ROOT </dt> |
|
<dd>Defines the path to the "pegasus" directory you've pulled from CVS, for |
|
example: <tt>/opt/pegasus/pegasus-2.3.2</tt> <br> |
|
</dd> |
|
<dt>PEGASUS_HOME </dt> |
|
<dd>Defines the directory that will contain the output binary files. For example, if you set |
|
this to <tt>$HOME/pegasus_home</tt>, then the output will go into <tt>$HOME/pegasus_home/bin</tt> |
|
and <tt>$HOME/pegasus_home/lib.</tt> <br> |
|
If you plan on doing parallel builds, you may want to define a unique PEGASUS_HOME value |
|
for each build you need, that way the output of each build will be placed in its own |
|
directory, for example: <tt>$HOME/pegasus_home_LINUX_IX86_GNU.</tt> <br> |
|
</dd> |
|
<dt>PEGASUS_PLATFORM </dt> |
|
<dd>Identifies the platform to be built. Each supported platform has a unique identifier |
|
with the following form: <br> |
|
<tt><Operating-System>_<Architecture>_<Compiler></tt> <p>The following |
|
values are tested for the OpenPegasus release:<br> |
<ul> | <ul> |
<li><font face="Courier New"><b>Client</b> Pegasus Client API Tests |
<li>AIX_RS_IBMCXX </li> |
depends tests </font></li> |
<li>HPUX_IA64_ACC </li> |
<li><font face="Courier New"><b>Common</b> Pegasus Common Functions (C++ source and headers |
<li>HPUX_PARISC_ACC </li> |
tests Test programs for the common functions</font></li> |
<li>LINUX_IA64_GNU </li> |
<li><font face="Courier New"><b>Compiler</b> Pegasus MOF compiler |
<li>LINUX_IX86_GNU </li> |
</font></li> |
<li>LINUX_PPC_GNU </li> |
<li><font face="Courier New"><b>Config</b> Pegasus Configuration |
<li>LINUX_ZSERIES_GNU </li> |
functions</font></li> |
<li>NSK_NONSTOP_NMCPLUS </li> |
<li><font face="Courier New"><b>Consumer</b> TBD </font></li> |
<li>SOLARIS_SPARC_CC </li> |
<li><font face="Courier New"><b>ControlProviders</b> Implementation of Pegasus internal providers |
<li>SOLARIS_SPARC_GNU </li> |
</font></li> |
<li>TRU64_ALPHA_DECCXX </li> |
<li><font face="Courier New"><b>ExportClient</b> TBD |
<li>WIN32_IX86_MSVC</li> |
</font></li> |
<li>ZOS_ZSERIES_IBM</li> |
<li><font face="Courier New"><b>ExportServer</b> TBD |
<li>DARWIN_PPC_GNU </li> |
</font></li> |
</ul> |
<li><font face="Courier New"><b>Handler</b> TBD </font></li> |
</dd> |
<li><font face="Courier New"><b>HandlerService</b> TBD |
<dt>PATH </dt> |
</font></li> |
<dd>Add $PEGASUS_HOME/bin to your path.</dd> |
<li><font face="Courier New"><b>IndicationService</b> TBD |
</dl> |
</font></li> |
|
<li><font face="Courier New"><b>Listener</b> TBD </font></li> |
<p>Additional configuration: |
<li><font face="Courier New"><b>Protocol</b> Pegasus Client HTTP/XML Protocol Modules |
|
depends </font></li> |
|
<li><font face="Courier New"><b>Provider</b> Pegasus Provider interface functions |
|
</font></li> |
|
<li><font face="Courier New"><b>ProviderManager</b> Provider Manager service that manages providers |
|
</font></li> |
|
<li><font face="Courier New"><b>ProviderManager2</b> Pluggable Provider Manager service. |
|
Today this is not enabled by default It will become the Pegasus |
|
standard provider manager at some time in the future but for now, see |
|
the release notes if you want to enable it.</font></li> |
|
<li><font face="Courier New"><b>Repository</b> Pegasus Repository |
|
Interfaces and Simple Repository tests </font> |
|
<ul> | <ul> |
<li><font face="Courier New">Tests for Repository Functions </font> |
<li>For Unix builds, place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH. </li> |
</li> |
<li>For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib.</li> |
</ul> |
|
</li> |
|
<li><font face="Courier New"><b>Security</b> TBD </font></li> |
|
<li><font face="Courier New"><b>Server</b> Pegasus Server Modules |
|
</font></li> |
|
<li><font face="Courier New"><b>WQL</b> TBD |
|
</font></li> |
|
</ul> | </ul> |
|
|
|
<p><a name="bld"><strong>Step 4: Build the Pegasus runtime, test files, test clients and |
|
repository</strong></a></p> |
|
|
|
<p>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. </p> |
|
|
|
<p>To build Pegasus, run the following commands from the root directory of the Pegasus |
|
distribution: |
|
|
|
<ol> |
|
<li>Enter <tt>make</tt> <p>This builds all of Pegasus. </p> |
</li> | </li> |
</ul> |
<li>Enter <tt>make repository</tt> <p>This creates the repository, which is needed to serve |
|
data. To create the additional namespaces that represent the test support you can also |
|
execute "make testrepository". </p> |
|
</li> |
|
<li>Enter <tt>make tests</tt> <p>This executes all the tests included with the Pegasus |
|
distribution, except the client/server tests. The client/server tests are executed |
|
separately from the above because they require the initiation of separate process for the |
|
Pegasus server and Pegasus client. To execute these tests, refer to the scripts in |
|
pegasus/mak/BuildMakefile. Refer to the prestarttests and poststarttests in this file. </p> |
</li> | </li> |
<li><font face="Courier New"><b>Providers</b> Pegasus test and required providers |
</ol> |
</font> |
|
|
<p>The following make targets are supported: |
|
|
<ul> | <ul> |
<li><font face="Courier New"><b>generic</b> TBD this and following IndicationConsumer |
<li><default> - Build everything. </li> |
</font></li> |
<li>clean - Clean out all objects, libs, and executables. </li> |
<li><font face="Courier New"><b>Linux</b> </font></li> |
<li>depend - Create the dependencies. </li> |
<li><font face="Courier New"><b>ManagedSystem</b> Providers |
<li>repository - Create the repository in $PEGASUS_HOME/repository </li> |
associated with managing the Pegasus System</font></li> |
<li>tests - Execute all tests (except client server tests). </li> |
<li><font face="Courier New"><b>slp</b> - </font></li> |
<li>rebuild - clean, depend, <default> </li> |
<li><font face="Courier New"><b>statistic</b> - Providers for |
<li>world - depend, <default> </li> |
Pegasus statistics.</font></li> |
|
<li><font face="Courier New"><b>sample</b> Sample providers for the |
|
major provider types.</font></li> |
|
<li><font face="Courier New"><b>testproviders</b> </font></li> |
|
</ul> | </ul> |
</li> |
|
<li><font face="Courier New"><b>Server</b> Pegasus executable build |
|
</font></li> |
|
<li><font face="Courier New"><b>slp</b> - TBD</font></li> |
|
<li><font face="Courier New"><b>Standard Includes</b> - TBD</font></li> |
|
<li><font face="Courier New"><b>test</b> - Directory of end-end |
|
tests that are regularly conducted on Pegasus</font></li> |
|
<li><font face="Courier New"><b>tools</b> MU and other utilities written for Pegasus support |
|
</font></li> |
|
<li><font face="Courier New"><b>Unsupported</b> Code that is made available but is not supported or included |
|
in the normal make. </font></li> |
|
<li><font face="Courier New"><b>WMIMapper</b> Pegasus implementation that implements mapping to Microsoft |
|
WMI objects. |
|
| |
</font></li> |
<p>Generally the build commands are as follows: |
</ul> |
|
<p> |
<ol> |
<font face="Courier New">Pegasus Run Time directory structure (PEGASUS_HOME |
<li>There is a Makefile in the Pegasus root directory. Simply executing make in the Pegasus |
environment variable). Home directory for runtime. All compiler, linker |
root directory will make everything. "make rebuild" will clean and rebuild |
documentation creation, etc. are put here. |
everything. The "make rebuild" will also populate the repository with the |
</font> |
current CIM Schemas. </li> |
|
<li>To test a fresh release, go to the pegasus root and type "<font face="Courier New">make |
|
world</font>". This will build dependencies, build binaries, and then run all |
|
tests except the Client/Server tests. </li> |
|
<li>To execute the basic test suite that is shipped with pegasus type "make |
|
tests". This also reinstalls the repository. Running "make -s tests" |
|
suppresses extraneous output such as the enter/leave directory messages. </li> |
|
<li>"make clean" removes all object and library files from the structure. </li> |
|
<li>A new build system has been added to Pegasus where a new CVS checkout is done, built, |
|
and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild" </li> |
|
</ol> |
|
|
|
<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 buld process when you run the makefile. However, you can also do it manually after the |
|
Pegasus has been built. |
|
|
|
<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>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 pegasus/Schemas does three things: |
|
|
<ul> | <ul> |
<li><font face="Courier New"><b>bin</b> - Destination for executable and DLL modules from |
<li>Generates the CIM Schema v2.8 in the repository (skeleton of CIM objects). To do this, |
Pegasus build. This directory should be make public so that the test functions, |
it runs the MOF compiler on the CIM schema: <tt>cimmofl -Schema v2.8</tt> </li> |
clients, and cimserver can be executed with minimum effort.</font></li> |
<li>Sets up operations (shutdown, add users, etc) and CIM indications (SNMP, Events, Alert, |
<li><font face="Courier New"><b>DevManualHTML</b> - HTML output of the Pegasus Manual. |
Threshold, etc) internal to the Pegasus schema by running the following command: <tt>cimmofl |
This is only created when the make file for this manual is |
-PG_InterOp</tt> </li> |
executed (doc/DevManual) and then contains the html representing |
<li>Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, … ) in |
the document.</font></li> |
Pegasus (which are located in src/Providers) by running: <tt>cimmofl -PG_ManagedSystem</tt> |
<li><font face="Courier New"><b>apidochtml</b> - HTML output of |
</li> |
the creation of the public API document. This only exists |
|
when the make file for the api document is executed (see doc/apidoc/Makefile)</font></li> |
|
<li><font face="Courier New"><b>lib</b> - Destination for Pegasus LIB modules |
|
</font></li> |
|
<li><font face="Courier New"><b>log</b> - Standard location for |
|
Pegasus Logs</font></li> |
|
<li><font face="Courier New"><b>obj</b> - Destination for object |
|
modules. Note that today, the trace file is located in the |
|
PEGASUS_HOME directory, not in the log directory if Pegasus |
|
internal tracing is enabled.</font></li> |
|
<li><font face="Courier New"><b>repository</b> - This Directory |
|
contains the created repository </font></li> |
|
</ul> | </ul> |
| |
<h1> |
<h2><a name="reg_prov">Registering Providers in the Pegasus Environment</a></h2> |
<a name="Pegasus Installation">Pegasus Installation</a> </h1> |
|
<p> |
<p>Pegasus registers providers with a set of provider registration classes, not using the |
Pegasus today is provided only as a source distribution. |
provider qualifier as is done in most DMTF CIM CIMOM implementations today. This set of |
<p> |
classes is close to but not exactly the same as the current DMTF definition (See the DMTF |
To install Pegasus, you must check it out using CVS (Common Version System) |
Interop schema, experimental versions starting with 2.6). This will be harmonized in the |
or download a snapshot. You download, compile, and use it. |
future when the DMTF scheme is moved to final status. </p> |
<p> |
|
For the snapshot, the installation of Pegasus involves expanding the snapshot |
<p>Registration is performed by defining a MOF for the instances of the registration |
distribution files, building the runtime, the test files and test clients, and |
classes that represent the porvider module, providers, classes, etc. to be |
building the repository. |
registered. The easiest way to create a new registration today is to copy from one |
<h1> |
of the existing registration MOFs. See the providers/sample/load directory for |
|
examples of several registration instance implementations that do work with Pegasus today.</p> |
<a name="Building Pegasus">Building Pegasus </a> |
|
|
<h2><a name="bld_rpms">Building RPMs for Pegasus</a> </h2> |
</h1> |
|
|
<p>The source distribution includes a script you can use to create an RPM for Pegasus. To |
<p> |
do this, your environment must meet the following requirements: |
1. Check that you have requisite programs (listed in Pegasus Dependencies). |
|
|
|
These include GNU Make, MU.EXE (if using Windows), Flex, and Bison (Flex |
|
and Bison only required if changes will be made to the MOF compiler or WQL |
|
parser). |
|
<p> |
|
Be sure these are on the path. |
|
| |
<p> |
|
2. Define the following three environment variables: |
|
<ul> | <ul> |
<li><b>PEGASUS_ROOT</b> - this should be the "pegasus" directory you've pulled from CVS |
<li>The root directory for Pegasus must be "/Pegasus-1.0" </li> |
</li> |
<li>Your environment variables must be set, as described in <a href="#set_envt_var">Set |
<li><b>PEGASUS_HOME</b> - to point to a directory to contain output binary files |
evironment variables</a>. </li> |
(e.g., set it to $HOME/pegasus_home). Then the output will go into |
<li>You must be logged in as the root user.</li> |
$HOME/pegasus_home/bin and $HOME/pegasus_home/lib |
|
</li> |
|
<li><b>PEGASUS_PLATFORM</b> - this must be set to a supported platform identifier. |
|
</li> |
|
</ul> | </ul> |
<blockquote> |
|
<p> |
|
This identifier has the following form: |
|
<p> |
|
<font face="Courier New"> |
|
<Operating-System>_<Architecture>_<Compiler> </font> |
|
<p> |
|
For example (Linux on IA32 platform using the GNU Compiler): |
|
LINUX_IX86_GNU |
|
<p> |
|
For a complete list of platforms supported and platform support keywords, refer to the platform_ make files found in directory |
|
<font face="Courier New">pegasus/mak</font> |
|
| |
</blockquote> |
<p>To create the RPMs, run the script <tt>rpmBuild</tt> from the root directory of the |
|
source distribution. For example: <tt>. /usr/source/pegasus-1.0/rpmBuild</tt> </p> |
| |
<p> |
<p>This will result in and RPM file names <tt>pegasus<version number>.rpm</tt>. </p> |
Note: if you plan on doing parallel builds, you might consider setting |
|
PEGASUS_HOME to something like this: |
|
<p> |
|
<font face="Courier New"> |
|
$HOME/pegasus_home_LINUX_IX86_GNU </font> |
|
<p> |
|
That way, the output of each build will be placed in its own directory. |
|
<p> |
|
3. Now place $PEGASUS_HOME/bin on your path |
|
<p> and |
|
<p> |
|
|
|
Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only). |
|
For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib |
|
<p> |
|
4. Change to the root of the Pegasus distrubution and type "make" |
|
(where make refers to GNU make). |
|
<p> |
|
5. Then create the repository, which is needed to serve data. |
|
"make repository". Note that to create the additional namespaces, etc. |
|
that represent the test support you can also execute "make testrepository:<p> |
|
6. To test the build type "make tests". |
|
The following make targets are supported: |
|
<UL> |
|
<li><default> - Build everything. |
|
<li>clean - Clean out all objects, libs, and executables. |
|
<li>depend - Create the dependencies. |
|
<li>repository - Create the repository in $PEGASUS_HOME/repository |
|
<li>tests - Execute all tests (except client server tests). |
|
<li>rebuild - clean, depend, <default> |
|
<li>world - depend, <default> |
|
</UL> |
|
The Pegasus Client server tests are executed separately from the above because |
|
they require the initiation of separate process for the Pegasus server and |
|
Pegasus client. To execute these tests please refer to the scripts in |
|
pegasus/mak/BuildMakefile - refer to the prestarttests and poststarttests. |
|
<p> |
|
For information on particular installation characteristics, tools, etc. for |
|
each platform see the appropriate sections below: |
|
<p> |
|
Generally the build commands are as follows: |
|
<ol> |
|
<li>There is a Makefile in the Pegasus root directory. Simply executing |
|
make in the Pegasus root directory will make everything. "make rebuild" |
|
will clean and rebuild everything. The "make rebuild" will also populate |
|
the repository with the current CIM Schemas. |
|
</li> |
|
<li>To test a fresh release, go to the pegasus root and type |
|
"<font face="Courier New">make world</font>". |
|
This will build dependencies, build binaries, and then run all |
|
tests except the Client/Server tests. |
|
</li> |
|
<li>To execute the basic test suite that is shipped with pegasus type |
|
"make tests". This also reinstalls the repository. |
|
Running "make -s tests" suppresses extraneous output such as the |
|
enter/leave directory messages. |
|
</li> |
|
<li>"make clean" removes all object and library files from the structure. |
|
| |
</li> |
<p><strong>Note</strong>: After you install using the install using the PRM, you must |
<li>A new build system has been added to Pegasus where a new CVS checkout is |
crate and populate teh repository manually. </p> |
done, |
<strong> |
built, and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild" |
|
| |
</li> |
<p>Question: I'm still working on this procedure (I haven't gotten it to work yet).<br> |
</ol> |
<br> |
|
</strong></p> |
| |
<h1> |
<h2><a name="note_bld_peg_lnx">Notes about Building Pegasus on Linux </a></h2> |
<a name="Populate the Repository">Populating the Pegasus Repository</a> </h1> |
|
| |
<p> |
<p>Pegasus supports many distributions of Linux. Refer to <a href="#peg_sup_plat">Pegasus |
Before using Pegasus you must populate the repository.. The makefile |
Supported Platforms</a> for more information. </p> |
does it all for you, but in case you are wondering what it does or how to do it |
|
| |
manually: |
<p>To build Pegasus on Linux, ensure that you you have the environment variables set |
<ol> |
(PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the definition of |
<LI>Register the MOF (Managed Object Format) file describing the skeleton of the |
PEGASUS_PLATFORM is normally LINUX_IX86_GNU. </p> |
object. |
|
<li>Register a second MOF which only points out which lib*.so file to be loaded |
<p><br> |
when a |
</p> |
specific object is activated. |
|
</ol> |
<h2><a name="bld_peg_win">Notes on building Pegasus on Windows 2k or Windows XP with |
This is done automatically for the providers included in Pegasus by doing: |
Microsoft Visual C++ </a></h2> |
make repository. |
|
<p> |
<p>Use of Windows 2000 SP3 or later is recommended. Pegasus is regularly tested on |
The 'make repository' in pegasus/Schemas does three things |
both Windows 2000 and Windows XP using the Microsoft compilers.</p> |
Runs MOF compiler (cimmofl) on: |
|
-Schema v2.7 |
<p>Today we build Pegasus on Windows using a set of make files contained in the source |
Generates the CIM Schema v2.7 in the repository (skeleton of CIM objects) |
distribution, the Microsoft compilers (DevStudio 5.x is not supported, Visual Studio 6.0, |
-PG_InterOp |
SP5 is supported) and the GNUMAKE make utility. Note that you MUST have the Pegasus <a |
Internal to Pegasus schema for operating (shutdown, add users, etc) |
href="#mu_utility">mu.exe </a>utility compiled and available before trying to compile |
CIM_Indication’s (SNMP, Events, Alert, Threshold, etc) |
Pegasus on the normal windows platform. The following is the basic setup steps for the |
-PG_ManagedSystem |
environment. </p> |
Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, … ) |
|
in Pegasus (which are located in src/Providers) |
<p>Setup the environment variables and path for the Micrososft Visual C compiler. |
<p> |
Typically this can be done by running the VCVARS32.BAT file supplied with Microsoft Visual |
For more information about using the MOF compiler, refer to user's manual on the |
C++. (contained in the same directory as cl.exe). </p> |
|
|
openpegasus.org. |
<p>For Windows, try the following for an example environment: </p> |
|
|
<h1> |
|
<a name="Testing a Pegasus Installation">Testing a Pegasus Installation</a></h1> |
|
<p> |
|
Pegasus includes an extensive set of test facilities as part of the CVS |
|
enviromentthat can be executed including:<ul> |
|
<li><b>Test Clients</b> - There are several clients that have been built |
|
specifically to test Pegasus or parts of Pegasus 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 proviers/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 Pegasus 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> |
|
| |
<h1> |
|
<a name="Registering Providers in the Pegasus Environment">Registering Providers |
|
in the Pegasus Environment</a></h1> |
|
|
|
<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 current |
|
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> |
|
Registration is performed by defining a MOF for the instances of the |
|
registration classes that represent the porvider 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 Pegasus today.</p> |
|
|
|
<h1> |
|
<a name="The MU Utility">The MU Utility </a></h1> |
|
|
|
<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 utilityis a simple utility that contains many |
|
commands. For example: |
|
|
|
<p> |
|
<font face="Courier New"> |
|
C:\> mu rm myfile.cpp yourfile.cpp </font> |
|
|
|
<p> |
|
You may type "mu" to get a list of valid commands. Here are some |
|
of them: |
|
|
|
<p> |
|
|
|
rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare depend |
|
|
|
<p> |
|
The MU utility supports globing (expansion of wildcards) so |
|
you can do things like this: |
|
<p> |
|
|
|
<font face="Courier New"> |
|
|
|
C:\> mu rm *.obj *.exe </font> |
|
<p> |
|
MU is required to build under the Windows environment. MU is available as part |
|
of the distribution of Pegasus. |
|
|
|
<h1> |
|
<a name="Notes about Building Pegasus on Linux">Notes about Building Pegasus on |
|
Linux </a></h1> |
|
<p> |
|
No problem. Just make sure you have the environment variables set (PEASUS_HOME, |
|
PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the defintion of |
|
PEGASUS_PLATFORM is normally LINUX_IX86_GNU. |
|
|
|
<h1><a name="Notes about Building Pegasus with SSL">Notes about Building Pegasus with SSL |
|
</a></h1> |
|
<p> |
|
To build with SSL you need the OpenSSL libraries and header files. They are NOT |
|
distributed with Pegasus. Make sure |
|
you have them in a standard directory so Pegasus can find them. If that's not |
|
|
|
the case, set the environment variable OPENSSL_HOME= to point where your |
|
OpenSSL |
|
installation is. |
|
<p> |
|
Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make' in Pegasus |
|
directory and you will have Pegasus with SSL enabled. See section "Creating SSL |
|
|
|
certificates" for more information of how to use SSL. |
|
|
|
<h1> |
|
<a name="Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++"> |
|
Building Pegasus on Windows 2k or Windows XP with Microsoft Visual C++ </a></h1> |
|
|
|
<p> |
|
Use of Windows 2000 SP3 or later is recommended. Pegasus is regularly |
|
tested on both Windows 2000 and Windows XP using the Microsoft compilers.<p> |
|
Today we build Pegasus 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 Pegasus <a href="#The MU Utility">mu.exe </a>utility |
|
compiled and available before trying to compile Pegasus on the normal windows |
|
platform. The |
|
|
|
following is the basic setup steps for the environment. |
|
<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> |
|
For Windows, try the following for an example environment: |
|
<blockquote> | <blockquote> |
<pre>REM call the standard Microsoft .bat for VC 6 setup. | <pre>REM call the standard Microsoft .bat for VC 6 setup. |
call 'C:/Program Files/Microsoft Visual Studio/VC98/Bin/Vcvars32.bat' |
call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat' |
REM Set debug to something if you want compile in debug mode | REM Set debug to something if you want compile in debug mode |
set PEGASUS_DEBUG=true | set PEGASUS_DEBUG=true |
REM set PEGASUS_ROOT to top of source tree | REM set PEGASUS_ROOT to top of source tree |
set PEGASUS_ROOT=C:/cimom/pegasus |
set PEGASUS_ROOT=C:/cimom/pegasus (Note: <span |
|
class="norm">The '/' characters are intentional and required by the Pegasus build system)</span> |
REM set PEGASUS_HOME to where you want repository and executables | REM set PEGASUS_HOME to where you want repository and executables |
set PEGASUS_HOME=%PEGASUS_ROOT% | set PEGASUS_HOME=%PEGASUS_ROOT% |
REM setup the path to the runtime files. | REM setup the path to the runtime files. |
set path=%path%;%PEGASUS_HOME%/bin |
set path=%path%;%PEGASUS_HOME%\bin |
</pre> | </pre> |
</blockquote><h1><a name="Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client</a></h1><p> |
</blockquote> |
This is a separate test tool that allows Pegasus requests to be initiated from |
|
any WEB browser and that uses a WEB browser, CGI scripts and HTML pages for |
<h3><a name="mu_utility">The MU Utility </a></h3> |
the formatting and connections. It requires a WEB server, etc. The |
|
instructions for setting up this environment are maintained in a separate readme in the CGI directory. <h1><a name="Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a></h1><p> |
<p>In order to provide a consistent build structure across multiple platforms, we |
ATTN: This section needs to be completed. It should reference the more |
developed a small utility to provide a consistent set of small utilities across these |
complete documentation |
platforms. The MU utilityis a simple utility that contains many commands. For example: </p> |
ATTN: Write about providers? <h1><a name="Commands">Commands</a></h1><p> |
|
The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on |
<p><font face="Courier New"> C:\> mu rm myfile.cpp yourfile.cpp </font></p> |
CVS) <p> |
|
To see simple help for each of the commands, use the "-h" flag. <blockquote><pre>Examples: |
<p>You may type "mu" to get a list of valid commands. Here are some of them: </p> |
bin/cimserver –s (Shuts it down) |
|
bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags) |
<p> rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare |
bin/cimprovider –l –s (lists providers and their status) |
depend </p> |
bin/cimprovider –e –m OperatingSystemModule (enables the OperatingSystem provider) |
|
bin/cimuser –a –u guest –w ThePassword |
<p>The MU utility supports globing (expansion of wildcards) so you can do things like |
bin/cimuser –l (lists the users) |
this: </p> |
bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type) |
|
</pre> |
<p><font face="Courier New"> C:\> mu rm *.obj *.exe </font></p> |
</blockquote><h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1><p> |
|
Type these commands in your shell to create the SSL certifications. The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective installation and source |
<p>MU is required to build under the Windows environment. MU is available as part of the |
directory. <blockquote><pre>CN="Common Name" |
distribution of Pegasus.<br> |
|
</p> |
|
|
|
<h2><a name="note_bld_peg_mac">Notes about Building Pegasus on Mac OS X </a></h2> |
|
|
|
<p>No problem. Just make sure you have the environment variables set (PEASUS_HOME, |
|
PEGASUS_ROOT, PEGASUS_PLATFORM. For Mac OS X/Darwin, the defination of PEGASUS_PLATFORM is |
|
DARWIN_PPC_GNU.</p> |
|
|
|
<h2><br> |
|
<a name="note_bld_peg_ssl">Notes about Building Pegasus with SSL </a></h2> |
|
|
|
<p>To build with SSL you need the OpenSSL libraries and header files. They are NOT |
|
distributed with Pegasus. Make sure you have them in a standard directory so Pegasus 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 Pegasus with SSL enabled. See "Creating SSL |
|
certificates" below for more information on how to use SSL. </p> |
|
|
|
<h3><a name="crt_ssl_cert">Creating SSL certifications </a></h3> |
|
|
|
<p>Type these commands in your shell to create the SSL certifications. The PEGASUS_ROOT |
|
and PEGASUS_HOME have to be set to your respective installation and source directory.<br> |
|
<span style="color: rgb(0, 0, 0);">Set the sslKeyFilePath to key.pem. Set the |
|
sslCertificateFilePath to cert.pem. To create a client truststore to validate the |
|
server against, copy the server's certificate into the client truststore, client.pem.</span><br> |
|
</p> |
|
|
|
<pre |
|
style="font-style: italic; font-family: courier new,courier,monospace; margin-left: 40px;"><small>CN="Common Name" |
EMAIL="test@email.address" | EMAIL="test@email.address" |
HOSTNAME=`uname -n` | HOSTNAME=`uname -n` |
sed -e "s/$CN/$HOSTNAME/" \ | sed -e "s/$CN/$HOSTNAME/" \ |
|
|
-nodes -config $PEGASUS_HOME/ssl.cnf \ | -nodes -config $PEGASUS_HOME/ssl.cnf \ |
-keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem | -keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem |
| |
cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem |
cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem</small></pre> |
rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem |
|
cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem |
|
</pre></blockquote><h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1><p> |
|
ICU (International Components for Unicode) refers to the set of libraries that |
|
Pegasus 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 Pegasus, Pegasus |
|
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. That said, when users run "make poststarttests" |
|
to verify the integrity of a Pegasus 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 Pegasus. 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, Pegasus will not be able to load messages |
|
using ICU resource bundles. <h1><a name="Pegasus Documentation">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 |
|
functioanlity, 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> |
|
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. <h1><a name="Participate!">Participate!</a></h1><p> |
|
We are looking for people who want to join the Pegasus work group and |
|
contribute to effort of getting this Pegasus off the ground. Please join |
|
the mailing list by visiting www.openpegasus.org, and click on Mailing Lists. |
|
</p> |
|
| |
</body> |
<p style="color: rgb(0, 0, 0);">Note: key.pem is sslKeyFilePath. cert.pem is |
|
sslCertificateFilePath</p> |
| |
|
<h1><a name="test">Testing a Pegasus Installation</a></h1> |
|
|
|
<p>Pegasus includes an extensive set of test facilities as part of the CVS enviroment, |
|
including: |
|
|
|
<ul> |
|
<li><b>Test Clients</b> - There are several clients that have been built specifically to |
|
test Pegasus, or parts of Pegasus, 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 proviers/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 Pegasus 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> |
|
|
|
<h2><a name="inst_peg_html">Installing the Pegasus HTML Test Client</a></h2> |
|
|
|
<p>This is a separate test tool that allows Pegasus requests to be initiated from any WEB |
|
browser and that uses a WEB browser, CGI scripts and HTML pages for the formatting and |
|
connections. It requires a WEB server, etc. The instructions for setting up this |
|
environment are maintained in a separate readme in the CGI directory. </p> |
|
|
|
<h2><a name="test_icu">Testing with ICU enabled</a></h2> |
|
|
|
<p>ICU (International Components for Unicode) refers to the set of libraries that Pegasus |
|
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 Pegasus, Pegasus 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 |
|
Pegasus 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 Pegasus. 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, Pegasus 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) 2004 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> |
|
</body> |
</html> | </html> |