version 1.6, 2004/05/13 14:39:29
|
version 1.13, 2006/03/28 20:23:03
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
//%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> | <html> |
<head> | <head> |
<meta name="GENERATOR" content="Microsoft FrontPage 3.0"> |
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> |
<meta name="ProgId" content="FrontPage.Editor.Document"> | <meta name="ProgId" content="FrontPage.Editor.Document"> |
<meta http-equiv="Content-Type" | <meta http-equiv="Content-Type" |
content="text/html; charset=windows-1252"> | content="text/html; charset=windows-1252"> |
|
|
</head> | </head> |
<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: 0pt; margin-bottom: 0pt;"><b>PEP #:</b> 103</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 | <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Title: </b>OpenPegasus |
Version 2.3 Release Readme file</p> |
Version 2.5 Release Readme file</p> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version: </b>1.1</p> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version: </b><span |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Created:</b> 12 |
style="color: rgb(0, 0, 0);">1.4<br> |
November 2003</p> |
</span></p> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Authors: </b>Karl |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Created:</b> 6 Sept |
Schopmeyer, Konrad Rzeszutek</p> |
2005</p> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Status: </b>draft</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> | <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version History:</b></p> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#cccccc" |
bordercolorlight="#CCCCCC" width="100%" style="font-family: Arial;"> |
style="font-family: Arial;" border="1" cellspacing="1" width="100%"> |
<tbody> | <tbody> |
<tr> | <tr> |
<th bgcolor="#cae6ca">Version</th> | <th bgcolor="#cae6ca">Version</th> |
|
|
</tr> | </tr> |
<tr> | <tr> |
<td align="center">1.0</td> | <td align="center">1.0</td> |
<td align="center">12 November 2003</td> |
<td align="center">5, Sept 2005</td> |
<td align="center">Karl Schopmeyer</td> |
<td align="center">Warren Grunbok<br> |
<td>Update from 2.2 Release notes. Converted to HTML</td> |
</td> |
</tr> |
<td>Initial draft<br> |
<tr> |
</td> |
<td align="center">1.1</td> |
</tr> |
<td align="center">March 10 2004</td> |
<tr> |
<td align="center">Konrad Rzeszutek</td> |
<td style="vertical-align: top; text-align: center;">1.1<br> |
<td>Added sections describing SSL and PAM configuration</td> |
</td> |
</tr> |
<td style="vertical-align: top; text-align: center;"> 13, |
<tr> |
Sept 2005<br> |
<td align="center"> </td> |
</td> |
<td align="center"> </td> |
<td style="vertical-align: top; text-align: center;">Warren |
<td align="center"> </td> |
Grunbok/Roger Kumpf<br> |
<td> </td> |
</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> | </tr> |
</tbody> | </tbody> |
</table> | </table> |
<hr> | <hr> |
<p><b>Abstract:</b> Installation, build, operation information on the |
<p><b>Abstract:</b> Installation, build, operation information on |
Pegasus Platform Version 2.3 Release. Note that if this readme conflicts |
the OpenPegasus Version 2.5.0 Release. Note that if this readme |
with the documentation in the release notes or interface definition |
conflicts with the documentation in the release notes or interface |
documents for a particular release, those documents should be |
definition documents for a particular release, those documents should |
considered authorative. This is a simplified overview to act as an |
be considered authorative. This is a simplified overview to act as an |
introduction to Pegasus.</p> |
introduction to OpenPegasus.</p> |
<hr> | <hr> |
<p align="center"><b><font size="5">OpenPegasus - A Manageability | <p align="center"><b><font size="5">OpenPegasus - A Manageability |
Services Broker for the DMTF CIM/WBEM Standards </font></b></p> |
Services Broker for the DMTF CIM/WBEM Standards |
|
</font></b></p> |
<p align="left"><b>Tagline:</b> OpenPegasus is an object manager for | <p align="left"><b>Tagline:</b> OpenPegasus is an object manager for |
DMTF CIM objects written in C++ and supported by The Open Group </p> |
DMTF CIM objects written in C++ |
<p align="left"><b>STATUS:</b> Revised November 2003 for Pegasus |
and hosted by The Open Group </p> |
release version 2.3.0 </p> |
<p align="left"> |
<p align="center"><b><font size="4">Table of Contents</font></b></p> |
<b>STATUS:</b> Revised Sept 2005 for Pegasus release version |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
2.5.0 |
href="#Overview"> Overview</a> </p> |
- Draft<br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
</p> |
href="#Availability%20of%20Pegasus">Availability of Pegasus</a></p> |
<a href="#Overview">Overview</a> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a |
href="#Pegasus%20Major%20Components">Pegasus Major Components</a></p> |
href="#avail_of_peg">Availability of Pegasus</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#peg_sup_plat">Pegasus Supported Platforms</a><br> |
href="#Pegasus%20Supported%20Platforms">Pegasus Supported Platforms</a></p> |
<a href="#peg_dep">Pegasus Dependencies</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#peg_dir_struc"></a><a href="#cmnd">Commands</a><br> |
href="#Pegasus%20Dependencies">Pegasus Dependencies </a></p> |
<a href="#docs">Documentation</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#part">How to Participate</a><br> |
href="#The%20Pegasus%20Directory%20Structure">The Pegasus Directory |
</blockquote> |
Structure</a> </p> |
<a href="#inst_peg">Install Pegasus</a> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"><a |
href="#Pegasus%20Installation">Installation</a> </p> |
href="#download">Download or checkout Pegasus</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#vfy_req_sw">Verify that you have the required |
href="#Building%20Pegasus">Building Pegasus </a></p> |
software</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#set_envt_var">Set the environment variables</a><br> |
href="#Populate%20the%20Repository">Populate the Repository</a> </p> |
<a href="#bld">Build the Pegasus runtime, test files, test clients, |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
and repository</a><br> |
href="#Registering%20Providers%20in%20the%20Pegasus%20Environment">Registering |
<a href="#pop_peg_rep">Populate the Pegasus repository</a><br> |
Providers</a></p> |
<a href="#reg_prov">Register providers in the Pegasus environment</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#note_bld_peg_lnx">Notes |
href="#The%20MU%20Utility">The MU Utility</a> </p> |
about Building Pegasus on Linux</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<a href="#note_bld_peg_ssl">Notes on building Pegasus with SSL</a><br> |
href="#Notes%20about%20Building%20Pegasus%20on%20Linux">Notes about |
<a href="#bld_peg_win">Building |
Building Pegasus on Linux</a> </p> |
Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a><br> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a |
href="#Notes%20about%20Building%20Pegasus%20on%20Mac%20OS%20X/Darwin">Notes |
href="#mu_utility">The MU Utility</a><br> |
about Building Pegasus on Mac OS X/Darwin</a></p> |
</blockquote> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
</blockquote> |
href="#Notes%20about%20Building%20Pegasus%20with%20SSL">Notes on |
<a href="#test">Test the Pegasus installation</a><br> |
building Pegasus with SSL</a> </p> |
<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
href="#test_icu">Testing with ICU enabled</a><br> |
href="#Building%20Pegasus%20on%20Windows%202000%20or%20Windows%20XP%20With%20Microsoft%20Visual%20C++">Building |
</blockquote> |
Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a></p> |
<hr> |
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Installing%20the%20Pegasus%20HTML%20Test%20Client">Installing |
|
the Pegasus HTML Test Client </a></p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Development%20with%20Pegasus%20and%20Pegasus%20Tools">Development |
|
with Pegasus and Pegasus Tools</a> </p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Commands">Commands</a> </p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Creating%20SSL%20certifications">Creating SSL certifications</a> </p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Configuring%20SSL">Configuring Pegasus to use SSL</a> </p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Configuring%20PAM">Configuring Pegasus to use PAM</a> </p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Testing%20with%20ICU%20enabled">Testing with ICU enabled </a></p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Pegasus%20Documentation">Documentation</a> </p> |
|
<p align="left" style="margin-top: 0pt; margin-bottom: 0pt;"><a |
|
href="#Participate%21">Participate</a> </p> |
|
<h1><a name="Overview">Overview</a> </h1> | <h1><a name="Overview">Overview</a> </h1> |
<p><b>OpenPegasus (also referred to as Pegasus):</b> Pegasus is an |
<b>OpenPegasus (also referred to as Pegasus):</b> |
open-source CIM Server for DMTF CIM objects. It is written in C++ and |
Pegasus is an open-source CIM Server for DMTF CIM objects. It is |
includes the Object manager (CIMOM), a set of defined interfaces, an |
written |
implemenation of the CIMOperations over HTTP operations and their cimxml |
in C++ and includes the Object manager (CIMOM), a set of defined |
HTTP encodings, and Interface libraries for both client and providers. |
interfaces, an implementation of the CIMOperations over HTTP operations |
It is maintained consistent with the DMTF CIM and WBEM specifications |
and their cimxml HTTP encodings, and Interface libraries |
except for exceptions noted in the documentation. </p> |
for both client and providers. It is maintained |
<p>Pegasus is open source and is covered under the MIT open-source |
consistent with the DMTF CIM and WBEM specifications except for |
license.</p> |
exceptions |
<p>Pegasus is being developed and maintained under the auspices of The |
noted in the documentation.<br> |
Open Group. Pegasus is maintained under the license defined in the doc |
<br> |
directory (LICENSE) of this release. This licensing is intended to |
<span class="norm"></span>OpenPegasus includes components for: <br> |
support as wide a distribution as possible with minimal demands on the |
<ol> |
users. </p> |
<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 | <p>More information on this project, access to the CVS, and |
documentation on Pegasus are available from the OpenGroup WEB site. </p> |
documentation on |
<p> <a href="http://www.opengroup.org">http://www.openpegaus.org</a></p> |
Pegasus are available from the OpenGroup WEB site. |
<p>There are a number of separate documents representing the status and |
</p> |
each release of Pegasus </p> |
<p> <a target="blank" |
<ul> |
href="http://www.openpegasus.org/">http://www.openpegasus.org</a></p> |
<li>What's new for this release - See the PEPs (Pegasus Enhancement |
<h2><a name="avail_of_peg">Availability of Pegasus</a></h2> |
Procedures) release notes on the Pegasus web site and duplicated in |
<h2></h2> |
the source top level directory</li> |
<h2></h2> |
<li>What's Broken - BUGS - See the ReleaseNotes for this release in |
<ol> |
the CVS and the web site as a Pegasus PEP.</li> |
Pegasus can be obtained via any of the following:<br> |
</ul> |
<ol> |
<p>The release notes are available on the WEB site as Pegasus PEP |
<li>Released tarballs (see <a |
documents and in the CVS for each release.</p> |
href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=392">Relase |
<table border="1" cellspacing="1" width="31%" id="AutoNumber3"> |
tarballs link</a>)</li> |
<tbody> |
<li>CVS (See <a |
<tr> |
href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">CVS |
<td width="42%"><b>Release</b></td> |
code repository</a> for |
<td width="58%"><b>Release Notes PEP</b></td> |
more information.)</li> |
</tr> |
<li>Linux RPMs. See |
<tr> |
(<a |
<td width="42%">2.0</td> |
href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">RPM |
<td width="58%">None</td> |
link</a> for |
</tr> |
more information |
<tr> |
)</li> |
<td width="42%">2.1</td> |
</ol> |
<td width="58%">None</td> |
</ol> |
</tr> |
<p>NOTE: The Linux RPM reference is for 2.4.1 because that is all we |
<tr> |
have. We |
<td width="42%">2.2</td> |
need a general page to get to the RPMs, not one per release. |
<td width="58%">PEP 57</td> |
</p> |
</tr> |
|
<tr> |
|
<td width="42%">2.3</td> |
|
<td width="58%">PEP 98</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
<h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1> |
|
<p>Pegasus is distributed as open source under the MIT open-source | <p>Pegasus is distributed as open source under the MIT open-source |
license. The distribution is available via CVS and snapshot images in | 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 |
tar and zip file formats on the web site. |
be found at the following Open Group CVS server; </p> |
The source code from CVS can be found at the following Open Group CVS |
<p><font face="Courier New"> cvs.opengroup.org:/cvs/MSB </font></p> |
server; |
<p>using the password authenticating server option (pserve). </p> |
</p> |
<p>Anonymous access for read is with the name and password "anon" as |
<p><span class="norm"></span><font style="color: rgb(0, 0, 0);">CVS |
follows: </p> |
write accounts are managed by Martin Kirk of The Open Group </font> |
<blockquote> |
(<a href="mailto:%28k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>) |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><font |
</p> |
face="Courier New">%export |
<br> |
CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB </font></p> |
<h2><a name="peg_sup_plat">Pegasus Supported Platforms</a></h2> |
<p style="margin-top: 0pt; margin-bottom: 0pt;"><font |
<p> |
face="Courier New">%cvs login </font></p> |
Pegasus is regularly tested against a variety of platforms by the |
</blockquote> |
development group. The results of the nightly tests can be found |
<p>When requested, enter the password "anon". The source tree is in the |
here: <a |
directory pegasus. To check out the complete Pegasus source tree just |
href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly |
type: </p> |
test status</a> . The Release notes provides additional details |
<p><font face="Courier New"> cvs co pegasus </font></p> |
regarding the platforms. <a |
<p>A Pegasus directory will be created under the current directory and |
href="http://www.openpegasus.org/pp/protected/revdoc.tpl?CALLER=revdocuments.tpl&grid=1692"> |
populated with the complete source tree and documentation. To get the |
PEP 230</a> is the release notes PEP for 2.5.<br> |
latest updates after a checkout just type this from Pegasus root: </p> |
</p> |
<p><font face="Courier New"> cvs update -d </font></p> |
<h2><a name="peg_dep">Pegasus Dependencies</a></h2> |
<p>Active contributors to Pegasus have write access to the CVS |
<p> |
repository. If you are interested in contributing back to the Pegasus |
We have worked to minimize the dependence of Pegasus on other software |
project, (i.e. write (checkin) access to CVS) please request access from |
packages and tools. Currently Pegasus has the following dependencies: |
either Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer <a |
</p> |
href="mailto:%28k.schopmeyer@opengroup.org">(k.schopmeyer@opengroup.org</a>).</p> |
|
<h1><a name="Pegasus Major Components">Pegasus Major Components</a></h1> |
|
<p>The major components of Pegasus are: </p> |
|
<ul> |
|
<li><b>Pegasus Server</b> - WBEM/CIM Server with interfaces for |
|
providers and clients </li> |
|
<li><b>Pegasus Repositories</b> - Today Pegasus provides a defined |
|
class repository interface and a simple file based class repository. |
|
It also includes an instance repository. Note that these repository |
|
were created for functionality, not efficieny. It is expected that |
|
they will be replaced with other implementations of the respository |
|
function as the need arises. </li> |
|
<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 interfacing with Pegasus. </li> |
|
<li><b>Pegasus Test Clients</b> - Simple test clients being developed |
|
as part of the Pegasus development process. These can be seen in the |
|
src/Clients directory and its subdirectories </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 C++ interfaces. </li> |
|
<li><b>Pegasus Providers</b> - Providers to illustrate the use of |
|
Pegasus services including providers for test and demonstration. </li> |
|
<li><b>Pegasus Control Providers</b> - Common services for use by |
|
other Pegasus components to extend Pegasus capabilites. </li> |
|
<li><b>Pegasus MOF Compiler </b>- There standalone compiler |
|
(cimmofl) for MOF files that can be used 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> |
|
<h1><a name="Pegasus Supported Platforms">Pegasus Supported Platforms</a></h1> |
|
<p>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 documented in the Release notes for that release |
|
(see the CVS source tree root directory or the Pegasus PEP defining the |
|
ReleaseNotes for any particular release).</p> |
|
<p>Generally Pegasus is supported on the following Platforms and |
|
Compilers.</p> |
|
<table border="1" cellspacing="1" id="AutoNumber2" width="728"> |
|
<tbody> |
|
<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> |
|
<tr> |
|
<td width="169">Mac OS X/Darwin PPC</td> |
|
<td width="556">gcc (version 3.3)</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
<h1><a name="Pegasus Dependencies">Pegasus Dependencies </a></h1> |
|
<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 | <p><b>1. GNUMAKE</b> - To simplify the building of Pegasus across |
multiple platforms we have standardized on a set of build tools |
multiple platforms we |
including: GNUMAKE. We are using GNUMAKE 3.79.1 successfully both in |
have standardized on a set of build tools including: GNUMAKE. We are |
Windows and Linux environments. </p> |
using GNUMAKE 3.79.1 successfully both in Windows and Linux |
|
environments. |
|
</p> |
<p>GNUMAKE is available from :</p> | <p>GNUMAKE is available from :</p> |
<p> <a href="http://www.gnu.org">http://www.gnu.org</a> </p> |
<p> <a target="blank" |
<p> NOTE: A set of the required tools for windows platforms is |
href="http://www.gnu.org/">http://www.gnu.org</a> |
available on the openpegasus web site.</p> |
</p> |
<p><b>2. MU.EXE </b>- To minimize the difference between Linux and |
<b>2. FLEX and BISON</b> - These tools were used to develop the |
Windows for GNUMAKE, we have created a utility called MU.exe. This |
MOF |
utility is required for Pegasus make with ONLY Windows environment. It |
compiler and WQL |
is provided as an alternative to requiring a number of UNIX utilities |
parser. <span class="norm"></span><font |
(SH, RM, etc.) on the windows platform and effectively provides the |
style="color: rgb(0, 0, 0);">These tools are required only for |
functions of these utilities that GNUMAKE needs. MU is not required on |
development of the parsers, not for building Pegasus.</font> |
UNIX or LINUX platforms. </p> |
<p><b>3. DOC++ </b>- The Pegasus documentation is taken from a |
<p>NOTE: The binary for MU.EXE is not distributed in the Pegasus bin |
combination of text files |
directory. You must build it separately. MU source code is part of the |
and the Pegasus header files themselves. This documentation is |
distribution in the directory src/utils/MU with its own make file. You |
formatted with DOC++ and GAWK. <span class="norm"></span><font |
must compile MU before you initiate the Pegausu make. </p> |
style="color: rgb(0, 0, 0);">These tools are required to build the |
<p>NOTE: A copy of the binary is made available as a zip file on the |
interface documentation set.</font> |
Pegasus WEB site. </p> |
</p> |
<p>Again, MU is used ONLY if you are using Windows. </p> |
<p><b>4. ICU Internationalization libraries</b> - These libraries are |
<p><b>3. FLEX and BISON</b> - These tools were used to develop the MOF |
used as the basis for message catalogs for message |
compiler and WQL parser. Anybody intending to recompile the compiler or |
internationalization. See the ICU website |
parser from scratch will be required to have these tools. They are only |
(http://oss.software.ibm.com/icu/) for more information on these |
required if changes need to be made to the files for parsing and |
libraries</p> |
compiling. </p> |
<p><span style="font-weight: bold;">5</span>. <b>OpenSSL </b>- If it |
<p><b>4. DLCOMPAT - </b>dlcompat is a dlopen(3) et.al. compatibility |
is intended to use SSL on the |
library for Mac OS X/Darwin.<br> |
communication protocol, the OpenSSL libraries are required.<br> |
<br> |
</p> |
<strong>NOTE</strong>: The dlcompat is not distributed with pegasus |
<p> NOTE: A set of the required |
source.<br> |
tools for windows platforms is available on the openpegasus web |
<br> |
site. <a href="../Pegasus24/www.openpegasus.org">www.openpegasus.org</a></p> |
dlcomapt is available from : <br> |
<h1><a name="cmnd">Commands</a></h1> |
<br> |
<p> |
<a href="http://www.opendarwin.org/projects/dlcompat/">http://www.opendarwin.org/projects/dlcompat/</a><br> |
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> | <br> |
Again, dlcomapt needs to be installed ONLY if you are using Mac OS |
NOTE: Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf |
X/Darwin.</p> |
for |
<p><b>5. DOC++ </b>- The Pegasus documentation is taken from a |
more information about administering the Pegasus CIMServer.<br> |
combination of text files and the Pegasus header files themselves. This |
<ul> |
documentation is formatted with DOC++ and GAWK. These tools are required |
<li>cimserver daemon=true (Start the server |
if the documentation is to be recreated but we expect that only the |
cimserver)</li> |
core team will be recreating documentation. </p> |
<li>cimserver -s (Shuts down the cimserver)</li> |
<p><b>6. ICU Internationalization libraries</b> - These libraries are |
<li>cimserver traceLevel=4 traceComponents=ALL (Starts server |
used as the basis for message catalogs for message internationalization. |
with |
See the ICU website (http://oss.software.ibm.com/icu/) for more |
config flags)</li> |
information on these libraries</p> |
<li>cimprovider -l -s (Lists providers and their status)</li> |
<p><strong>7</strong>. <b>OpenSSL </b>- If it is intended to use SSL |
<li>cimprovider -e -m OperatingSystemModule (Enables the |
on the communication protocol, the OpenSSL libraries are required.</p> |
OperatingSystem provider)</li> |
<h1><a name="The Pegasus Directory Structure">The Pegasus Directory |
<li>cimuser -a -u guest _w <ThePassword> (Adds the user <span |
Structure</a></h1> |
style="font-style: italic;">guest</span> with specified password)<br> |
<p>Pegasus is distributed as a complete source directory structure that |
|
should be installed either from one of the snapshots or from CVS. </p> |
|
<p>This structure is generally as follows:</p> |
|
<p><font face="Courier New">Pegasus Source Structure</font></p> |
|
<p><font face="Courier New">Pegasus Root directory (PEGASUS_ROOT |
|
environment variable)</font> </p> |
|
<ul> |
|
<li><font face="Courier New"><b>cgi</b> Source for the Pegasus WEB |
|
Based Test client </font> |
|
<ul> |
|
<li><font face="Courier New">cgi-bin CGI Directories for WEB |
|
demonstration. This directory is normally empty but can be |
|
populated from the runtime with the make from cgi. </font></li> |
|
<li><font face="Courier New">htdocs HTML Pages for Pegasus WEB |
|
demonstration </font></li> |
|
</ul> |
|
</li> |
|
<li><font face="Courier New"><b>doc</b> Miscellaneous Pegasus |
|
Documents. </font> |
|
<ul> |
|
<li><font face="Courier New">apidoc - Source for the public api |
|
documentation.</font></li> |
|
<li><font face="Courier New">DevManual Source and build files for |
|
developers' manual mak General make files (used by other makes)</font></li> |
|
</ul> |
|
</li> | </li> |
<li><font face="Courier New"><b>mak</b> - Common make files for |
<li>cimuser -l (Lists the users )<br> |
Pegasus compilation</font></li> |
|
<li><font face="Courier New"><b>Dummy</b> -</font></li> |
|
<li><font face="Courier New"><b>InterfaceArchive</b> -</font></li> |
|
<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 of Pegasus. This includes currently released versions |
|
of the DMTF schemas in subdirectories (ex. CIM27) and Pegasus local |
|
Schemas (ex. </font></li> |
|
<li><font face="Courier New"><b>src</b> All Pegasus Source Files </font> |
|
<ul> |
|
<li><font face="Courier New"><b>ACEExample</b> Test directrory |
|
with examples of the use of ACE (obsolete). </font></li> |
|
<li><font face="Courier New"><b>Clients</b> Source for various |
|
test clients and demonstration clients.</font></li> |
|
<li><font face="Courier New"><b>CGICLIENT</b> Pegasus test client |
|
that uses a WEB browser JAVA Java Client support modules </font></li> |
|
<li><font face="Courier New"><b>Pegasus</b> - Core pegasus |
|
modules. </font> |
|
<ul> |
|
<li><font face="Courier New"><b>Client</b> Pegasus Client API |
|
Tests depends tests </font></li> |
|
<li><font face="Courier New"><b>Common</b> Pegasus Common |
|
Functions (C++ source and headers tests Test programs for |
|
the common functions</font></li> |
|
<li><font face="Courier New"><b>Compiler</b> Pegasus MOF |
|
compiler </font></li> |
|
<li><font face="Courier New"><b>Config</b> Pegasus |
|
Configuration functions</font></li> |
|
<li><font face="Courier New"><b>Consumer</b> Indication |
|
Consumer class header</font></li> |
|
<li><font face="Courier New"><b>ControlProviders</b> |
|
Implementation of Pegasus internal providers </font></li> |
|
<li><font face="Courier New"><b>ExportClient</b> Client |
|
connect code for export of indications</font></li> |
|
<li><font face="Courier New"><b>ExportServer</b> Server code |
|
for import of indications</font></li> |
|
<li><font face="Courier New"><b>Handler</b> Indication |
|
handlers. Today this includes cimxml, SNMP and email handlers</font></li> |
|
<li><font face="Courier New"><b>HandlerService</b> Common code |
|
for indication handler service</font></li> |
|
<li><font face="Courier New"><b>IndicationService</b> Common |
|
service functions for indication subscription processing</font></li> |
|
<li><font face="Courier New"><b>Listener</b> Common code that |
|
allows CIM Listeners to be created and connected.</font></li> |
|
<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> |
|
<li><font face="Courier New">Tests for Repository |
|
Functions </font></li> |
|
</ul> |
|
</li> |
|
<li><font face="Courier New"><b>Security</b> Authentication |
|
and user support functions.</font></li> |
|
<li><font face="Courier New"><b>Server</b> Pegasus Server |
|
Modules </font></li> |
|
<li><font face="Courier New"><b>WQL</b> the WQL query language |
|
interpreter.</font></li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</li> |
|
<li><font face="Courier New"><b>Providers</b> Pegasus test and |
|
required providers </font> |
|
<ul> |
|
<li><font face="Courier New"><b>generic</b> A number of |
|
cross-platform providers </font></li> |
|
<li><font face="Courier New">IndicationConsumer - Provider that |
|
consumes indications</font></li> |
|
<li><font face="Courier New"><b>Linux</b> - A number of linux |
|
providers</font></li> |
|
<li><font face="Courier New"><b>ManagedSystem</b> Providers |
|
associated with managing the Pegasus System</font></li> |
|
<li><font face="Courier New"><b>slp</b> - Provider for slp |
|
service agent support</font></li> |
|
<li><font face="Courier New"><b>statistic</b> - Providers for |
|
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> |
|
</li> | </li> |
<li><font face="Courier New"><b>Server</b> Pegasus executable build </font></li> |
|
<li><font face="Courier New"><b>slp</b> - </font></li> |
|
<li><font face="Courier New"><b>Standard Includes</b> - </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 provides mapping to Microsoft WMI objects. </font></li> |
|
</ul> |
|
<p><font face="Courier New">Pegasus Run Time directory structure |
|
(PEGASUS_HOME environment variable). Home directory for runtime. All |
|
compiler, linker documentation creation, etc. are put here. </font> </p> |
|
<ul> |
|
<li><font face="Courier New"><b>bin</b> - Destination for executable |
|
and DLL modules from Pegasus build. This directory should be make |
|
public so that the test functions, clients, and cimserver can be |
|
executed with minimum effort.</font></li> |
|
<li><font face="Courier New"><b>DevManualHTML</b> - HTML output of the |
|
Pegasus Manual. This is only created when the make file for this |
|
manual is executed (doc/DevManual) and then contains the html |
|
representing the document.</font></li> |
|
<li><font face="Courier New"><b>apidochtml</b> - HTML output of 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><a name="Pegasus Installation">Pegasus Installation</a> </h1> |
Note: there are some differences between windows and other |
<p>Pegasus today is provided only as a source distribution. Note that |
platforms in |
there is code for a Linux RPM distribution but the project is not yet |
starting the server as a daemon/service. Whereas most supported |
releasing binaies.</p> |
platforms use |
<p>To install Pegasus, you must check it out using CVS (Common Version |
the configuration option daemon to start the server as a service, on |
System) or download a snapshot. You download, compile, and use it. </p> |
windows it |
<p>For the snapshot, the installation of Pegasus involves expanding the |
must be specifically installed as a service (ex. cimserver -install) |
snapshot distribution files, building the runtime, the test files and |
and then |
test clients, and building the repository. </p> |
started as a service (cimserver -start). The cimserver --h option |
<h1><a name="Building Pegasus">Building Pegasus </a></h1> |
explains the |
<p>1. Check that you have requisite programs (listed in Pegasus |
exact format of the start and stop options.<br |
Dependencies). These include GNU Make, MU.EXE (if using Windows), Flex, |
style="color: rgb(0, 0, 0);"> |
and Bison (Flex and Bison only required if changes will be made to the |
<font><font color="RED"><br |
MOF compiler or WQL parser). </p> |
style="color: rgb(0, 0, 0); font-weight: bold;"> |
<p>Be sure these are on the path. </p> |
<span style="color: rgb(0, 0, 0); font-weight: bold;">Makefile commands |
<p>2. Define the following three environment variables: </p> |
<br> |
<ul> |
</span></font></font>Pegasus includes several make files that enable |
<li><b>PEGASUS_ROOT</b> - this should be the "pegasus" directory |
you to quickly build or |
you've pulled from CVS </li> |
refresh the Pegasus runtime, test files, test client and the |
<li><b>PEGASUS_HOME</b> - to point to a directory to contain output |
repository. To use these make files, type "make" followed by one of the |
binary files (e.g., set it to $HOME/pegasus_home). Then the output |
supplied targets. <br> |
will go into $HOME/pegasus_home/bin and $HOME/pegasus_home/lib </li> |
The following list contains some of the make targets that are |
<li><b>PEGASUS_PLATFORM</b> - this must be set to a supported platform |
supported: |
identifier.</li> |
|
</ul> |
|
<blockquote> |
|
<p>This identifier has the following form: </p> |
|
<p><font face="Courier New"> |
|
<Operating-System>_<Architecture>_<Compiler> </font></p> |
|
<p>For example (Linux on IA32 platform using the GNU Compiler): |
|
LINUX_IX86_GNU </p> |
|
<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> </p> |
|
</blockquote> |
|
<p>Note: if you plan on doing parallel builds, you might consider |
|
setting PEGASUS_HOME to something like this: </p> |
|
<p><font face="Courier New"> $HOME/pegasus_home_LINUX_IX86_GNU </font></p> |
|
<p>That way, the output of each build will be placed in its own |
|
directory. </p> |
|
<p>3. Now place $PEGASUS_HOME/bin on your path </p> |
|
<p> and </p> |
|
<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> |
|
<p>4. Change to the root of the Pegasus distribution and type "make" |
|
(where make refers to GNU make). </p> |
|
<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> |
|
<p>6. To test the build type "make tests". The following make targets |
|
are supported: </p> |
|
<ul> | <ul> |
<li><default> - Build everything. </li> | <li><default> - Build everything. </li> |
<li>clean - Clean out all objects, libs, and executables. </li> | <li>clean - Clean out all objects, libs, and executables. </li> |
|
|
<li>rebuild - clean, depend, <default> </li> | <li>rebuild - clean, depend, <default> </li> |
<li>world - depend, <default> </li> | <li>world - depend, <default> </li> |
</ul> | </ul> |
<p>The Pegasus Client server tests are executed separately from the |
<font><font color="RED"><span |
above because they require the initiation of separate process for the |
style="color: rgb(0, 0, 0); font-weight: bold;"></span><span |
Pegasus server and Pegasus client. To execute these tests please refer |
style="color: rgb(0, 0, 0);">For a comprehensive list of the |
to the scripts in pegasus/mak/BuildMakefile - refer to the prestarttests |
make targets, refer to the make files.<br> |
and poststarttests. </p> |
</span><br style="color: rgb(0, 0, 0);"> |
<p>For information on particular installation characteristics, tools, |
<span style="color: rgb(0, 0, 0); font-weight: bold;">TestMakefile |
etc. for each platform see the appropriate sections below: </p> |
commands |
<p>Generally the build commands are as follows: </p> |
</span><br style="color: rgb(0, 0, 0);"> |
<ol> |
<span style="color: rgb(0, 0, 0);"></span></font></font><font><font |
<li>There is a Makefile in the Pegasus root directory. Simply |
color="RED"><span class="norm"></span></font></font> TestMakefile is a |
executing make in the Pegasus root directory will make everything. |
make file |
"make rebuild" will clean and rebuild everything. The "make rebuild" |
that in the top level Pegasus source directory that defines |
will also populate the repository with the current CIM Schemas. </li> |
functionality to |
<li>To test a fresh release, go to the pegasus root and type "<font |
initiate the Pegasus tests. The targets defined in this makefile allow |
face="Courier New">make world</font>". This will build |
the |
dependencies, build binaries, and then run all tests except the |
user to run the various tests and test suites that are included in the |
Client/Server tests. </li> |
Pegasus |
<li>To execute the basic test suite that is shipped with pegasus |
source package.<br> |
type "make tests". This also reinstalls the repository. Running |
<font><font color="RED"><span class="norm"></span></font></font>Example: |
"make -s tests" suppresses extraneous output such as the enter/leave |
From the $PEGASUS_ROOT directory. |
directory messages. </li> |
make -f TestMakefile [testoption]<br> |
<li>"make clean" removes all object and library files from the |
<br style="color: rgb(0, 0, 0);"> |
structure. </li> |
<font><font color="RED"><span style="color: rgb(0, 0, 0);">## rebuild - |
<li>A new build system has been added to Pegasus where a new CVS |
Rebuild |
checkout is done, built, and tests are run. Do it by: "make -f |
</span><br style="color: rgb(0, 0, 0);"> |
mak/BuildMakefile cleanbuild" </li> |
<span style="color: rgb(0, 0, 0);">## build - Build |
</ol> |
</span><br style="color: rgb(0, 0, 0);"> |
<h1><a name="Populate the Repository">Populating the Pegasus Repository</a> </h1> |
<span style="color: rgb(0, 0, 0);">## prestarttests - Execute |
<p>Before using Pegasus you must populate the repository.. The makefile |
functional tests |
does it all for you, but in case you are wondering what it does or how |
</span><br style="color: rgb(0, 0, 0);"> |
to do it manually: </p> |
<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> | <ol> |
<li>Register the MOF (Managed Object Format) file describing the | <li>Register the MOF (Managed Object Format) file describing the |
skeleton of the object. </li> | skeleton of the object. </li> |
<li>Register a second MOF which only points out which lib*.so file to | <li>Register a second MOF which only points out which lib*.so file to |
be loaded when a specific object is activated. </li> | be loaded when a specific object is activated. </li> |
</ol> | </ol> |
<p>This is done automatically for the providers included in Pegasus by |
<p></p> |
doing: make repository. </p> |
<p> |
<p>The 'make repository' in pegasus/Schemas does three things Runs MOF |
The providers included with Pegasus are automatically entered into the |
compiler (cimmofl) on: -Schema v2.7 Generates the CIM Schema v2.7 in the |
repository |
repository (skeleton of CIM objects) -PG_InterOp Internal to Pegasus |
by running the following command: <tt>make repository</tt> |
schema for operating (shutdown, add users, etc) CIM_Indication’s (SNMP, |
</p> |
Events, Alert, Threshold, etc) -PG_ManagedSystem Registers included CIM |
<p> |
Providers (libOSProvider.so, libDNSProvider.so, … ) in Pegasus (which |
The 'make repository' in the pegasus directory does three things: |
are located in src/Providers) </p> |
</p> |
<p>For more information about using the MOF compiler, refer to user's |
<ul> |
manual on the openpegasus.org. </p> |
<li><span class="norm"></span> Removes the existing repository if one |
<h1><a name="Testing a Pegasus Installation">Testing a Pegasus |
exists.</li> |
Installation</a></h1> |
<li>Generates the CIM Schema v2.9 in the repository (skeleton of CIM |
<p>Pegasus includes an extensive set of test facilities as part of the |
objects). </li> |
CVS enviromentthat can be executed including: </p> |
<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> | <ul> |
<li><b>Test Clients</b> - There are several clients that have been | <li><b>Test Clients</b> - There are several clients that have been |
built specifically to test Pegasus or parts of Pegasus including |
built specifically to test OpenPegasus, or parts of OpenPegasus, |
|
including |
TestClient, Client, CLI, ipinfo, osinfo, WbemEsec, etc. See the | TestClient, Client, CLI, ipinfo, osinfo, WbemEsec, etc. See the |
src/Clients directory for more information. These programs require a | src/Clients directory for more information. These programs require a |
server complete with repository to be running. Note that some of these |
server complete with repository to be running. Note that some of |
tests use classes and instances that are only installed with the |
these tests use classes and instances that are only installed with the |
"make testrepository" functions including test namespaces and extra | "make testrepository" functions including test namespaces and extra |
classes and instances in those namespaces and additional providers |
classes and instances in those namespaces and additional providers from |
from the providers/sample and proviers/testproviders directories.</li> |
the providers/sample and providers/testproviders directories. </li> |
<li><b>Sample and test providers</b> - Test providers exist for the |
<li><b>Sample and test providers</b> - Test providers exist for |
major provider types in the providers/sample directories and the |
the major provider types in the providers/sample directories and the |
providers/testProviders directory</li> | providers/testProviders directory</li> |
<li><b>Unit Tests</b> - Most Pegasus functions include unit tests for |
<li><b>Unit Tests</b> - Most OpenPegasus functions include unit tests |
the functions. These are normally executed with the "make tests" |
for |
|
the functions. These are normally executed with the "make tests" |
command which can be executed at many different levels of the source | 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 |
tree from the top level to execute all of the unit tests to individual |
individual directories. Usually the unit test functions can be found in |
directories. Usually the unit test functions can be found in test |
test directories immediately below their corresponding source code |
directories immediately below their corresponding source code |
(i.e common/tests is the unit test functions for the common |
(i.e common/tests is the unit test functions for the common |
directory). Unit tests are executed without the server being | directory). Unit tests are executed without the server being |
operational and normally do not require the existence of a Class | operational and normally do not require the existence of a Class |
repository.</li> | repository.</li> |
<li><b>An end-to-end Test Suite</b> - the directory "test" contains a | <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 |
set of operations tests that cover the major CIM operations. See |
the make file TestMakefile in the PEGASUS_ROOT directory to execute | the make file TestMakefile in the PEGASUS_ROOT directory to execute |
these tests. This set of tests executes an extensive set of fixed |
these tests. This set of tests executes an extensive set of fixed |
tests and compares the results against predefined results.</li> | tests and compares the results against predefined results.</li> |
</ul> | </ul> |
<h1><a name="Registering Providers in the Pegasus Environment">Registering |
<p></p> |
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> |
|
<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 Pegasus. </p> |
|
<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. </p> |
|
<p> </p> |
|
<h1><a name="Notes about Building Pegasus on Mac OS X/Darwin">Notes |
|
about Building Pegasus on Mac OS X/Darwin</a><a |
|
name="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 Mac OS X/Darwin, the |
|
defination of PEGASUS_PLATFORM is <br> |
|
DARWIN_PPC_GNU.</p> |
|
<p> </p> |
|
<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> |
|
<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. </p> |
|
<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> |
|
<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%20MU%20Utility">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> |
|
<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 <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> |
|
<h1><a name="Installing the Pegasus HTML Test Client">Installing the |
|
Pegasus HTML Test Client</a></h1> |
|
<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> |
|
<h1><a name="Development with Pegasus and Pegasus Tools">Development |
|
with Pegasus and Pegasus Tools</a></h1> |
|
<p>ATTN: This section needs to be completed. It should reference the |
|
more complete documentation.</p> |
|
<h1><a name="Commands">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 "-h" flag. </p> |
|
<blockquote> |
|
<pre>Examples:<br>bin/cimserver –s (Shuts it down)<br>bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags)<br>bin/cimprovider –l –s (lists providers and their status)<br>bin/cimprovider –e –m OperatingSystemModule (enables the OperatingSystem provider)<br>bin/cimuser –a –u guest –w ThePassword<br>bin/cimuser –l (lists the users)<br>bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type)<br></pre> |
|
</blockquote> |
|
<h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1> |
|
<p>Please follow section <a |
|
href="#Notes%20about%20Building%20Pegasus%20with%20SSL">Notes on |
|
building Pegasus with SSL</a> before embarking on this endeavour. <br> |
|
<br> | <br> |
Type these commands in your shell to create the SSL certifications. The |
<h2><a name="test_icu">Testing with ICU enabled</a></h2> |
PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective |
|
installation and source directory. </p> |
|
<blockquote> |
|
<pre>CN="Common Name"<br>EMAIL="test@email.address"<br>HOSTNAME=`uname -n`<br>sed -e "s/$CN/$HOSTNAME/" \<br>-e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \<br>> $PEGASUS_HOME/ssl.cnf<br>chmod 644 $PEGASUS_HOME/ssl.cnf<br>chown bin $PEGASUS_HOME/ssl.cnf<br>chgrp bin $PEGASUS_HOME/ssl.cnf<br><br>/usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \<br>-nodes -config $PEGASUS_HOME/ssl.cnf \<br>-keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem <br><br>cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem<br>rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem<br>cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem<br><br></pre> |
|
</blockquote> |
|
<h1><a name="Configuring SSL">Configuring Pegasus to use SSL</a></h1> |
|
<p>Please follow section <a |
|
href="#Notes%20about%20Building%20Pegasus%20with%20SSL">Notes on |
|
building Pegasus with SSL</a> and <a |
|
href="#Creating%20SSL%20certifications">Creating SSL certifications</a> |
|
before embarking on this endeavour.<br> |
|
<br> |
|
To configure Pegasus to take advantage of SSL, configure CIMServer to |
|
have the following configuration options set to: </p> |
|
<blockquote> |
|
<pre> sslTrustFilePath=client.pem<br> sslCertificateFilePath=server.pem<br> sslKeyFilePath=file.pem<br> httpsPort=5989<br> enableHttpsConnection=true<br></pre> |
|
</blockquote> |
|
<p>using the <b>cimconfig</b> utility: </p> |
|
<blockquote> |
|
<pre> cimconfig -p -s enableHttpsConnection=true<br></pre> |
|
</blockquote> |
|
<p><br> |
|
(The client.pem and server.pem are the certifications files created per |
|
the steps in the earlier section). For good riddance you might consider |
|
closing down the cleartext 5988 port. Modify your CIMServer |
|
configuration to include: </p> |
|
<blockquote> |
|
<pre> enableHttpConnection=false<br></pre> |
|
</blockquote> |
|
<p>using <b>cimconfig</b>. </p> |
|
<h1><a name="Configuring PAM">Configuring Pegasus to use PAM</a></h1> |
|
<p>In order to use PAM Authentication you have to compile Pegasus with |
|
one extra enviroment flags: </p> |
|
<blockquote> |
|
<pre> PEGASUS_PAM_AUTHENTICATION=1<br></pre> |
|
</blockquote> |
|
<p>You can also set the PEGASUS_ALWAYS_USE_PAM=1 flag to disable |
|
Pegasus password authentication using a flag text-file (recommended). <br> |
|
After compiling (refer to section <a href="#Building%20Pegasus">Building |
|
Pegasus </a>for details), follow these two important steps: <br> |
|
</p> |
|
<ul> |
|
<ul> |
|
<p>a). Copy the rpm/wbem file in-to /etc/pam.d directory. This |
|
notifies PAM what kind of libraries to use when authenticating |
|
Pegasus.</p> |
|
</ul> |
|
<ul> |
|
<p>b). Modify CIMServer configuration options: </p> |
|
<blockquote> |
|
<pre> usePAMAuthentication=true<br> enableAuthentication=true<br> </pre> |
|
</blockquote> |
|
<p>And if you want to allow 'root' to login (*not recommended*) </p> |
|
<blockquote> |
|
<pre> enableRemotePrivilegedUserAccess=true<br> </pre> |
|
</blockquote> |
|
<p>using the <b>cimconfig</b> utility, such as: </p> |
|
<blockquote> |
|
<pre> cimconfig -p -s usePAMAuthentication=true<br> </pre> |
|
</blockquote> |
|
</ul> |
|
</ul> |
|
<p>The user is authenticated using HTTP Basic method, thererfore it is |
|
strongly suggested you use SSL connection instead of normal HTTP |
|
connection. Refer to section <a href="#Configuring%20SSL">Configuring |
|
Pegasus to use SSL</a> for more details on creating and using SSL keys. </p> |
|
<h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1> |
|
<p>ICU (International Components for Unicode) refers to the set of | <p>ICU (International Components for Unicode) refers to the set of |
libraries that Pegasus uses to run globalized. For example: these |
libraries that OpenPegasus uses to run globalized. For example: these |
libraries are used to load messages in different languages, format |
libraries are used |
currency and numbers according to a specific locale etc. In order to |
to |
enable globalization in Pegasus, Pegasus must be built with ICU enabled, |
load messages in different languages, format currency and numbers |
ie. the right environment variables must be set prior to running |
according to |
"make". Refer to the GlobalizationHOWTO.htm in the docs directory for |
a specific locale etc. In order to enable globalization in OpenPegasus, |
details. That said, when users run "make poststarttests" to verify the |
OpenPegasus |
integrity of a Pegasus download, a series of tests are run that require |
must be built with ICU enabled, ie. the right environment variables |
the cimserver to be running. These tests currently depend on specific |
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 | messages returned from the server. When ICU is enabled, all messages |
come from the resource bundles and these usually do not match the | come from the resource bundles and these usually do not match the |
hardcoded default messages within Pegasus. These hardcoded default |
hardcoded default messages within OpenPegasus. These hardcoded default |
messages are what the various test programs expect in order to complete | messages are what the various test programs expect in order to complete |
successfully. If the ICU enabled server is started without disabling |
successfully. If the ICU enabled server is started without |
message loading from the bundles, "make poststartests" will fail. In |
disabling message loading from the bundles, "make poststartests" will |
order to run "make poststarttests" successfully with ICU enabled, an |
fail. |
|
In order to run "make poststarttests" successfully with ICU enabled, an |
environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist | environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist |
prior to starting the server. Once this is defined, when the cimserver |
prior to |
starts, all messages generated will be the default hardcoded messages. |
starting the server. Once this is defined, when the cimserver starts, |
This will enable "make poststarttests" to complete successfully. Once |
all |
"make poststarttests" is complete, you should stop the cimserver and |
messages generated will be the default hardcoded messages. This will |
then undefine PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left |
enable |
defined, Pegasus will not be able to load messages using ICU resource |
"make poststarttests" to complete successfully. Once "make |
bundles. </p> |
poststarttests" is |
<h1><a name="Pegasus Documentation">Pegasus Documentation</a></h1> |
complete, you should stop the cimserver and then undefine |
<p>The documentation is currently in preparation. Much of Pegasus is |
PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined, |
documented in the PEGASUS PEPs which are the basis for approval of |
OpenPegasus |
Pegasus functionality, changes, plans, etc. These documents are openly |
will not be able to load messages |
available on the PEGASUS web site. The preliminary documentation is not |
using ICU resource bundles.<br> |
provided with this release. The current documentation is maintained |
</p> |
both as a manual created under the tool DOC++ in the runtime |
<p><span class="norm"></span><font style="color: rgb(0, 0, 0);">When |
subdirectory manual/html (see doc/devManual to create), as an api |
running the make tests command with ICU enabled, the PEGASUS_MSG_HOME |
document also creatable from the source tree (see doc/apidoc) and as |
environment variable must be set to the home directory where the ICU |
other miscellaneous documentation in the doc directory. Also there is a |
resource bundles are built. By default the resource bundles are built |
set of release notes. Normally the release notes for the current release |
into directories below PEGASUS_HOME/msg, so that should be the setting |
are available in the root source directory of CVS.</p> |
for PEGASUS_MSG_HOME.<br> |
<p>Note that the Pegasus WEB site at The Open Group will be the source |
</font></p> |
of most documentation in the future and today is the source of most |
<p><font style="color: rgb(0, 0, 0);">-------------------------------------------------------------------------------------------------------------------------------------<br> |
discussion and design documentation. </p> |
</font></p> |
<h1><a name="Participate!">Participate!</a></h1> |
<p><i><font size="2">Copyright (c) 2005 EMC Corporation; |
<p>We are looking for people who want to join the Pegasus work group |
Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group; |
and contribute to effort of getting this Pegasus off the ground. Please |
VERITAS Software Corporation</font><br> |
join the mailing list by visiting www.openpegasus.org, and click on |
<br> |
Mailing Lists. </p> |
<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> | </body> |
</html> | </html> |