1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
\r
5 <meta name="GENERATOR" content="Microsoft FrontPage 3.0">
\r
6 <meta name="ProgId" content="FrontPage.Editor.Document">
\r
7 <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
\r
8 <title>OpenPegasus</title>
\r
13 <p align="center"><b><font size="4">Pegasus Enhancement Proposal (PEP)</font></b></p>
\r
15 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>PEP #:</b> 175</p>
\r
17 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Title: </b>OpenPegasus Version 2.4
\r
18 Release Readme file</p>
\r
20 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version: </b><span
\r
21 style="color: rgb(0, 0, 0);">1.4</span></p>
\r
23 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Created:</b> 24 June 2004</p>
\r
25 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Authors: </b>Warren Grunbok, Mike
\r
29 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Status: </b>draft</p>
\r
31 <p style="margin-top: 0pt; margin-bottom: 0pt;"><b>Version History:</b></p>
\r
33 <table bordercolordark="#666666" bordercolorlight="#cccccc" style="font-family: Arial;"
\r
34 border="1" cellspacing="1" width="100%">
\r
37 <th bgcolor="#cae6ca">Version</th>
\r
38 <th bgcolor="#cae6ca">Date</th>
\r
39 <th bgcolor="#cae6ca">Author</th>
\r
40 <th bgcolor="#cae6ca">Change Description</th>
\r
43 <td align="center">1.0</td>
\r
44 <td align="center">24, June 2004</td>
\r
45 <td align="center">Warren Grunbok<br>
\r
47 <td>Initial draft<br>
\r
51 <td align="center"> 1.1</td>
\r
52 <td align="center">24,August 2004 <br>
\r
54 <td align="center">Warren Grunbok <br>
\r
56 <td>Mostly spelling changes, adds to very last paragraph <br>
\r
60 <td style="vertical-align: top;">1.2<br>
\r
62 <td style="vertical-align: top;">31, August 2004<br>
\r
64 <td style="vertical-align: top;">Warren Grunbok<br>
\r
66 <td style="vertical-align: top;">Changes based on architecture review. Removed
\r
67 /Directory structure section and placed into seperate document.<br>
\r
72 <td style="vertical-align: top;">1.3<br>
\r
74 <td style="vertical-align: top;">???<br>
\r
76 <td style="vertical-align: top;">Warren Grunbok<br>
\r
78 <td style="vertical-align: top;">Removed Pegasus Directory structure and placed in PEP
\r
79 191, Added Copyright and End of Doc marker.<br>
\r
83 <td style="vertical-align: top; color: rgb(0, 0, 0);">1.4<br>
\r
85 <td style="vertical-align: top; color: rgb(0, 0, 0);">27, Sept 2004<br>
\r
87 <td style="vertical-align: top; color: rgb(0, 0, 0);">Warren Grunbok<br>
\r
89 <td style="vertical-align: top; color: rgb(0, 0, 0);">Corrected Security changes as per
\r
98 <p><b>Abstract:</b> Installation, build, operation information on the Pegasus
\r
99 Platform Version 2.4.0 Release. Note that if this readme conflicts with the documentation
\r
100 in the release notes or interface definition documents for a particular release, those
\r
101 documents should be considered authorative. This is a simplified overview to act as an
\r
102 introduction to Pegasus.</p>
\r
106 <p align="center"><b><font size="5">OpenPegasus - A Manageability Services Broker for the
\r
107 DMTF CIM/WBEM Standards </font></b></p>
\r
109 <p align="left"><b>Tagline:</b> OpenPegasus is an object manager for DMTF CIM objects
\r
110 written in C++ and supported by The Open Group </p>
\r
112 <p align="left"><b>STATUS:</b> Revised Sept 2004 for Pegasus release version
\r
113 2.4.0 - Approved<br>
\r
115 <a href="#Overview">
\r
117 <p>Overview</a> </p>
\r
119 <blockquote style="margin-top: 0pt; margin-bottom: 0pt;">
\r
120 <a href="#avail_of_peg"><p>Availability of Pegasus</a><br>
\r
121 <a href="#peg_maj_comp">Pegasus Major Components</a><br>
\r
122 <a href="#avail_of_peg">Availability of Pegasus</a><br>
\r
123 <a href="#peg_sup_plat">Pegasus Supported Platforms</a><br>
\r
124 <a href="#peg_dep">Pegasus Dependencies</a><br>
\r
125 <a href="#peg_dir_struc">The Pegasus Directory Structure</a><br>
\r
126 <a href="#dev_with_peg">Development with Pegasus and Pegasus Tools</a><br>
\r
127 <a href="#cmnd">Commands</a><br>
\r
128 <a href="#docs">Documentation</a><br>
\r
129 <a href="#part">Participate</a><br>
\r
132 <a href="#inst_peg">
\r
134 <p>Install Pegasus</a> </p>
\r
136 <blockquote style="margin-top: 0pt; margin-bottom: 0pt;">
\r
137 <a href="#download"><p>Download or checkout Pegasus</a><br>
\r
138 <a href="#vfy_req_sw">Verify that you have the required software</a><br>
\r
139 <a href="#set_envt_var">Set the environment variables</a><br>
\r
140 <a href="#bld">Build the Pegasus runtime, test files, test clients, and repository</a><br>
\r
141 <a href="#pop_peg_rep">Populate the Pegasus repository</a><br>
\r
142 <a href="#reg_prov">Register providers in the Pegasus environment</a><br>
\r
143 <a href="#bld_rpms">Build an RPM for Pegasus</a><br>
\r
144 <a href="#note_bld_peg_lnx">Notes about Building Pegasus on Linux</a><br>
\r
145 <a href="#note_bld_peg_mac">Notes about Building Pegasus on Mac OS X</a><br>
\r
146 <a href="#note_bld_peg_ssl">Notes on building Pegasus with SSL</a><br>
\r
147 <a href="#crt_ssl_cert">Creating SSL certifications</a><br>
\r
148 <a href="#bld_peg_win">Building Pegasus on Windows 2000 or Windows XP With Microsoft
\r
150 <a href="#mu_utility">The MU Utility</a><br>
\r
155 <p>Test the Pegasus installation</a><br>
\r
158 <blockquote style="margin-top: 0pt; margin-bottom: 0pt;">
\r
159 <a href="#inst_peg_html"><p>Installing the Pegasus HTML Test Client</a><br>
\r
160 <a href="#test_icu">Testing with ICU enabled</a><br>
\r
166 <h1><a name="Overview">Overview</a> </h1>
\r
168 <p><b>OpenPegasus (also referred to as Pegasus):</b> Pegasus is an open-source CIM Server
\r
169 for DMTF CIM objects. It is written in C++ and includes the Object manager (CIMOM), a set
\r
170 of defined interfaces, an implemenation of the CIMOperations over HTTP operations and
\r
171 their cimxml HTTP encodings, and Interface libraries for both client and providers. It is
\r
172 maintained consistent with the DMTF CIM and WBEM specifications except for
\r
173 exceptions noted in the documentation. </p>
\r
175 <p>Pegasus is open source and is covered under the MIT open-source license.</p>
\r
177 <p>Pegasus is being developed and maintained under the auspices of The Open Group. Pegasus
\r
178 is maintained under the license defined in the doc directory (LICENSE) of this release.
\r
179 This licensing is intended to support as wide a distribution as possible with minimal
\r
180 demands on the users. </p>
\r
182 <p>More information on this project, access to the CVS, and documentation on Pegasus are
\r
183 available from the OpenGroup WEB site. </p>
\r
185 <p> <a target="blank" href="http://www.openpegasus.org">http://www.openpegasus.org</a></p>
\r
187 <p>There are a number of separate documents representing the status and each release of
\r
191 <li>What's new for this release - See the PEPs (Pegasus Enhancement Procedures) release
\r
192 notes on the Pegasus web site and duplicated in the source top level directory </li>
\r
193 <li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and the web site
\r
194 as a Pegasus PEP.</li>
\r
197 <p>The release notes are available on the WEB site as Pegasus PEP documents and in the CVS
\r
198 for each release.</p>
\r
200 <table id="AutoNumber3" border="1" cellspacing="1" width="31%">
\r
203 <td width="42%"><b>Release</b></td>
\r
204 <td width="58%"><b>Release Notes PEP</b></td>
\r
207 <td width="42%">2.0</td>
\r
208 <td width="58%">None</td>
\r
211 <td width="42%">2.1</td>
\r
212 <td width="58%">None</td>
\r
215 <td width="42%">2.2</td>
\r
216 <td width="58%">PEP 57</td>
\r
219 <td width="42%">2.3</td>
\r
220 <td width="58%">PEP 98</td>
\r
223 <td style="vertical-align: top;">2.4<br>
\r
225 <td style="vertical-align: top;">PEP 185<br>
\r
231 <h2><a name="avail_of_peg">Availability of Pegasus</a></h2>
\r
233 <p>Pegasus is distributed as open source under the MIT open-source license. The
\r
234 distribution is available via CVS and snapshot images in tar and zip file formats on the
\r
235 web site. The source code from CVS can be found at the following Open Group CVS server; </p>
\r
237 <p><font face="Courier New"> cvs.opengroup.org:/cvs/MSB </font></p>
\r
239 <p>using the password authenticating server option (pserve). </p>
\r
241 <p>Anonymous access for read is with the name and password "anon" as follows: </p>
\r
244 <p style="margin-top: 0pt; margin-bottom: 0pt;"><font face="Courier New">%export
\r
245 CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB </font></p>
\r
246 <p style="margin-top: 0pt; margin-bottom: 0pt;"><font face="Courier New">%cvs login </font></p>
\r
249 <p>When requested, enter the password "anon". The source tree is in the
\r
250 directory pegasus. To check out the complete Pegasus source tree just type: </p>
\r
252 <p><font face="Courier New"> cvs co pegasus </font></p>
\r
254 <p>A Pegasus directory will be created under the current directory and populated with the
\r
255 complete source tree and documentation. To get the latest updates after a checkout just
\r
256 type this from Pegasus root: </p>
\r
258 <p><font face="Courier New"> cvs update -d </font></p>
\r
260 <p>Active contributors to Pegasus have write access to the CVS repository. If you are
\r
261 interested in contributing back to the Pegasus project, (i.e. write (checkin) access to
\r
262 CVS) please request access from either Martin Kirk (<a
\r
263 href="mailto:(k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>) or Karl Schopmeyer <a
\r
264 href="mailto:(k.schopmeyer@opengroup.org">k.schopmeyer@opengroup.org</a>. </p>
\r
266 <h2><a name="peg_maj_comp">Pegasus Major Components</a></h2>
\r
268 <p>The major components of Pegasus are:
\r
271 <li><b>Pegasus Server</b> - WBEM/CIM Server with interfaces for providers and clients </li>
\r
272 <li><b>Pegasus Repositories</b> - Today Pegasus provides a defined class repository
\r
273 interface and a simple file based class repository. It also includes an instance
\r
274 repository. Note that these repository were created for functionality, not efficieny. It
\r
275 is expected that they will be replaced with other implementations of the respository
\r
276 function as the need arises. </li>
\r
277 <li><b>Pegasus Client Library</b> - Tools for building Pegasus clients based on the Pegasus
\r
278 C++ interfaces and using the WBEM HTTP/XML protocols or directly interfacing with Pegasus.
\r
280 <li><b>Pegasus Test Clients</b> - Simple test clients being developed as part of the Pegasus
\r
281 development process. These can be seen in the src/Clients directory and its subdirectories
\r
283 <li><b>Pegasus HTML Test Client</b> - To aid in testing we created a test client for Pegasus
\r
284 that uses a WEB server (ex. Apache) with a set of CGI modules and HTML to allow the entry
\r
285 of Pegasus operations from a WEB browser as forms and the receipt of the response as WEB
\r
286 pages. This has proven useful as a test tool and can be used for a wide variety of
\r
287 demonstrations. </li>
\r
288 <li><b>Pegasus Provider Library</b> - Tools for building Pegasus providers using the Pegasus
\r
289 C++ interfaces. </li>
\r
290 <li><b>Pegasus Providers</b> - Providers to illustrate the use of Pegasus services including
\r
291 providers for test and demonstration. </li>
\r
292 <li><b>Pegasus Control Providers</b> - Common services for use by other Pegasus components
\r
293 to extend Pegasus capabilites. </li>
\r
294 <li><b>Pegasus MOF Compiler </b>- There standalone compiler (cimmofl) for MOF files
\r
295 that can be used to install MOF into the Pegasus schema repository and also to check
\r
296 syntax. There is also a compiler that operates as a Pegasus client(cimmof) There is also a
\r
297 tool to extract the MOF from the repository. </li>
\r
300 <h2><a name="peg_sup_plat">Pegasus Supported Platforms</a></h2>
\r
302 <p>Pegasus is regularly tested against a variety of platforms by the development
\r
303 group. The set of platforms and exact set of compilers for any given release is
\r
304 documented in the Release notes for that release (see the CVS source tree root directory
\r
305 or the Pegasus PEP defining the ReleaseNotes for any particular release).</p>
\r
307 <p>Pegasus is supported on a variety of platforms. The list of platforms can be
\r
308 found in the release notes associated with this release.<br>
\r
314 <h2><a name="peg_dep">Pegasus Dependencies</a></h2>
\r
316 <p>We have worked to minimize the dependence of Pegasus on other software packages and
\r
317 tools. Currently Pegasus has the following dependencies: </p>
\r
319 <p><b>1. GNUMAKE</b> - To simplify the building of Pegasus across multiple platforms we
\r
320 have standardized on a set of build tools including: GNUMAKE. We are using GNUMAKE 3.79.1
\r
321 successfully both in Windows and Linux environments. </p>
\r
323 <p>GNUMAKE is available from :</p>
\r
325 <p> <a target="blank" href="http://www.gnu.org">http://www.gnu.org</a>
\r
328 <p> NOTE: A set of the required tools for windows
\r
329 platforms is available on the openpegasus web site. <a href="www.openpegasus.org">www.openpegasus.org</a><br>
\r
332 <p><b>2. MU.EXE </b>- To minimize the difference between Linux and Windows for GNUMAKE, we
\r
333 have created a utility called MU.exe. This utility is required for Pegasus make with ONLY
\r
334 Windows environment. It is provided as an alternative to requiring a number of UNIX
\r
335 utilities (SH, RM, etc.) on the windows platform and effectively provides the functions of
\r
336 these utilities that GNUMAKE needs. MU is not required on UNIX or LINUX platforms. </p>
\r
338 <p>NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory. You must
\r
339 build it separately. MU source code is part of the distribution in the directory
\r
340 src/utils/MU with its own make file. You must compile MU before you initiate the Pegausu
\r
343 <p>NOTE: A copy of the binary is made available as a zip file on the Pegasus WEB site. </p>
\r
345 <p>Again, MU is used ONLY if you are using Windows. </p>
\r
347 <p><b>3. FLEX and BISON</b> - These tools were used to develop the MOF compiler and WQL
\r
348 parser. Anybody intending to recompile the compiler or parser from scratch will be
\r
349 required to have these tools. They are only required if changes need to be made to the
\r
350 files for parsing and compiling. </p>
\r
353 <p>4. DLCOMPAT - </b>dlcompat is a dlopen(3) et.al. compatibility library for Mac OS
\r
356 <strong>NOTE</strong>: The dlcompat is not distributed with pegasus source.<br>
\r
357 dlcomapt is avilable from <br>
\r
359 <a href="http://www.opendarwin.org/projects/dlcompat/">http://www.opendarwin.org/projects/dlcompat/
\r
362 Again, dlcomapt needs to be installed ONLY if you are using Mac OS X/Darwin.</p>
\r
364 <p><b>5. DOC++ </b>- The Pegasus documentation is taken from a combination of text files
\r
365 and the Pegasus header files themselves. This documentation is formatted with DOC++ and
\r
366 GAWK. These tools are required if the documentation is to be recreated but we expect that
\r
367 only the core team will be recreating documentation. </p>
\r
369 <p><b>6. ICU Internationalization libraries</b> - These libraries are used as the basis
\r
370 for message catalogs for message internationalization. See the ICU website
\r
371 (http://oss.software.ibm.com/icu/) for more information on these libraries</p>
\r
373 <p><strong>7.</strong> <b>OpenSSL </b>- If it is intended to use SSL on the communication
\r
374 protocol, the OpenSSL libraries are required.</p>
\r
376 <h1><a name="peg_dir_struc">The Pegasus Directory Structure</a></h1>
\r
378 <p>Pegasus is distributed as a complete source directory structure that should be
\r
379 installed either from one of the snapshots or from CVS. </p>
\r
381 <p>The Pegasus Directory is documented in<span style="color: rgb(51, 255, 51);"> <span
\r
382 style="color: rgb(0, 0, 0);">PEP 191</span> </span>and listed in the Pegasus /doc
\r
386 <h1><a name="dev_with_peg">Development with Pegasus and Pegasus Tools</a></h1>
\r
388 <p>ATTN: This section needs to be completed. It should reference the more complete
\r
389 documentation. </p>
\r
391 <h1><a name="cmnd">Commands</a></h1>
\r
393 <p>The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on CVS) </p>
\r
395 <p>To see simple help for each of the commands, use the "-h" flag. </p>
\r
399 bin/cimserver –s (Shuts it down)
\r
400 bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags)
\r
401 bin/cimprovider –l –s (lists providers and their status)
\r
402 bin/cimprovider –e –m OperatingSystemModule (enables the OperatingSystem provider)
\r
403 bin/cimuser –a –u guest –w ThePassword
\r
404 bin/cimuser –l (lists the users)
\r
405 bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type)
\r
409 <h1><a name="docs">Pegasus Documentation</a></h1>
\r
411 <p>The documentation is currently in preparation. Much of Pegasus is documented in
\r
412 the PEGASUS PEPs which are the basis for approval of Pegasus functionality, changes,
\r
413 plans, etc. These documents are openly available on the PEGASUS web site. The
\r
414 preliminary documentation is not provided with this release. The current documentation is
\r
415 maintained both as a manual created under the tool DOC++ in the runtime subdirectory
\r
416 manual/html (see doc/devManual to create), as an api document also creatable from the
\r
417 source tree (see doc/apidoc) and as other miscellaneous documentation in the doc
\r
418 directory. Also there is a set of release notes. Normally the release notes for the
\r
419 current release are available in the root source directory of CVS.</p>
\r
421 <p>Note that the Pegasus WEB site at The Open Group will be the source of most
\r
422 documentation in the future and today is the source of most discussion and design
\r
423 documentation. </p>
\r
425 <h1><a name="part">Participate!</a></h1>
\r
427 <p>We are looking for people who want to join the Pegasus work group and contribute to
\r
428 effort of getting this Pegasus off the ground. Please join the mailing list by visiting
\r
429 www.openpegasus.org, and click on Mailing Lists. </p>
\r
431 <h1><a name="inst_peg">Install Pegasus</a> </h1>
\r
433 <p>You can install and run Pegasus on any of the supported platforms. The installation
\r
434 process includes the following steps:
\r
437 <li>Download or checkout Pegasus. </li>
\r
438 <li>Verify that you have the required software. </li>
\r
439 <li>Set environment variables. </li>
\r
440 <li>Build the Pegasus runtime, test files, test clients and repository. </li>
\r
443 <p><a name="download"><strong>Step 1: Download or checkout Pegasus</strong></a></p>
\r
445 <p>Pegasus is freely available from the open group's Pegasus home page: <a target="blank"
\r
446 href="http://www.openpegasus.org">http://www.openpegasus.org</a>. To obtain Pegasus, you
\r
447 can either check it out using CVS or download a snapshot image of the soruce distribution.
\r
448 For more information about checking out Pegasus using CVS, see: <a href="#avail_of_peg">Availability
\r
449 of Pegasus</a>. </p>
\r
451 <p>Pegasus is not currently releasing binaries, but you can create RPMs using a script
\r
452 included with the source distribution. See <a href="#bld_rpms">Building RPMs for Pegasus</a>
\r
453 for more information. </p>
\r
455 <p><a name="vfy_req_sw"><strong>Step 2: Verify that you have the required software</strong></a></p>
\r
457 <p>Refer to the section <a href="#peg_dep">Pegasus Dependencies</a> and verify that you
\r
458 have the software required for your Operating System and planned usage of Pegasus. </p>
\r
460 <p><a name="set_envt_var"><strong>Step 3: Set the environment variables</strong></a></p>
\r
462 <p>Before installing or running Pegasus, ensure that the following environment variables
\r
463 have been defined or updated:
\r
466 <dt>PEGASUS_ROOT </dt>
\r
467 <dd>Defines the path to the "pegasus" directory you've pulled from CVS, for
\r
468 example: <tt>/opt/pegasus/pegasus-2.3.2</tt> <br>
\r
470 <dt>PEGASUS_HOME </dt>
\r
471 <dd>Defines the directory that will contain the output binary files. For example, if you set
\r
472 this to <tt>$HOME/pegasus_home</tt>, then the output will go into <tt>$HOME/pegasus_home/bin</tt>
\r
473 and <tt>$HOME/pegasus_home/lib.</tt> <br>
\r
474 If you plan on doing parallel builds, you may want to define a unique PEGASUS_HOME value
\r
475 for each build you need, that way the output of each build will be placed in its own
\r
476 directory, for example: <tt>$HOME/pegasus_home_LINUX_IX86_GNU.</tt> <br>
\r
478 <dt>PEGASUS_PLATFORM </dt>
\r
479 <dd>Identifies the platform to be built. Each supported platform has a unique identifier
\r
480 with the following form: <br>
\r
481 <tt><Operating-System>_<Architecture>_<Compiler></tt> <p>The following
\r
482 values are tested for the OpenPegasus release:<br>
\r
484 <li>AIX_RS_IBMCXX </li>
\r
485 <li>HPUX_IA64_ACC </li>
\r
486 <li>HPUX_PARISC_ACC </li>
\r
487 <li>LINUX_IA64_GNU </li>
\r
488 <li>LINUX_IX86_GNU </li>
\r
489 <li>LINUX_PPC_GNU </li>
\r
490 <li>LINUX_ZSERIES_GNU </li>
\r
491 <li>NSK_NONSTOP_NMCPLUS </li>
\r
492 <li>SOLARIS_SPARC_CC </li>
\r
493 <li>SOLARIS_SPARC_GNU </li>
\r
494 <li>TRU64_ALPHA_DECCXX </li>
\r
495 <li>WIN32_IX86_MSVC</li>
\r
496 <li>ZOS_ZSERIES_IBM</li>
\r
497 <li>DARWIN_PPC_GNU </li>
\r
501 <dd>Add $PEGASUS_HOME/bin to your path.</dd>
\r
504 <p>Additional configuration:
\r
507 <li>For Unix builds, place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH. </li>
\r
508 <li>For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib.</li>
\r
511 <p><a name="bld"><strong>Step 4: Build the Pegasus runtime, test files, test clients and
\r
512 repository</strong></a></p>
\r
514 <p>Pegasus includes several make files that enable you to quickly build or refresh the
\r
515 Pegasus runtime, test files, test client and the repository. To use these make files, type
\r
516 "make" followed by one of the supplied targets. </p>
\r
518 <p>To build Pegasus, run the following commands from the root directory of the Pegasus
\r
522 <li>Enter <tt>make</tt> <p>This builds all of Pegasus. </p>
\r
524 <li>Enter <tt>make repository</tt> <p>This creates the repository, which is needed to serve
\r
525 data. To create the additional namespaces that represent the test support you can also
\r
526 execute "make testrepository". </p>
\r
528 <li>Enter <tt>make tests</tt> <p>This executes all the tests included with the Pegasus
\r
529 distribution, except the client/server tests. The client/server tests are executed
\r
530 separately from the above because they require the initiation of separate process for the
\r
531 Pegasus server and Pegasus client. To execute these tests, refer to the scripts in
\r
532 pegasus/mak/BuildMakefile. Refer to the prestarttests and poststarttests in this file. </p>
\r
536 <p>The following make targets are supported:
\r
539 <li><default> - Build everything. </li>
\r
540 <li>clean - Clean out all objects, libs, and executables. </li>
\r
541 <li>depend - Create the dependencies. </li>
\r
542 <li>repository - Create the repository in $PEGASUS_HOME/repository </li>
\r
543 <li>tests - Execute all tests (except client server tests). </li>
\r
544 <li>rebuild - clean, depend, <default> </li>
\r
545 <li>world - depend, <default> </li>
\r
548 <p>Generally the build commands are as follows:
\r
551 <li>There is a Makefile in the Pegasus root directory. Simply executing make in the Pegasus
\r
552 root directory will make everything. "make rebuild" will clean and rebuild
\r
553 everything. The "make rebuild" will also populate the repository with the
\r
554 current CIM Schemas. </li>
\r
555 <li>To test a fresh release, go to the pegasus root and type "<font face="Courier New">make
\r
556 world</font>". This will build dependencies, build binaries, and then run all
\r
557 tests except the Client/Server tests. </li>
\r
558 <li>To execute the basic test suite that is shipped with pegasus type "make
\r
559 tests". This also reinstalls the repository. Running "make -s tests"
\r
560 suppresses extraneous output such as the enter/leave directory messages. </li>
\r
561 <li>"make clean" removes all object and library files from the structure. </li>
\r
562 <li>A new build system has been added to Pegasus where a new CVS checkout is done, built,
\r
563 and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild" </li>
\r
566 <h2><a name="pop_peg_rep">Populate the Pegasus repository</a> </h2>
\r
568 <p>Before using Pegasus you must populate the repository. Typically, this is done during
\r
569 the buld process when you run the makefile. However, you can also do it manually after the
\r
570 Pegasus has been built.
\r
573 <li>Register the MOF (Managed Object Format) file describing the skeleton of the object. </li>
\r
574 <li>Register a second MOF which only points out which lib*.so file to be loaded when a
\r
575 specific object is activated. </li>
\r
578 <p>The providers included with Pegasus are automatically entered into the repository by
\r
579 running the following command: <tt>make repository</tt> </p>
\r
581 <p>The 'make repository' in pegasus/Schemas does three things:
\r
584 <li>Generates the CIM Schema v2.8 in the repository (skeleton of CIM objects). To do this,
\r
585 it runs the MOF compiler on the CIM schema: <tt>cimmofl -Schema v2.8</tt> </li>
\r
586 <li>Sets up operations (shutdown, add users, etc) and CIM indications (SNMP, Events, Alert,
\r
587 Threshold, etc) internal to the Pegasus schema by running the following command: <tt>cimmofl
\r
588 -PG_InterOp</tt> </li>
\r
589 <li>Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, … ) in
\r
590 Pegasus (which are located in src/Providers) by running: <tt>cimmofl -PG_ManagedSystem</tt>
\r
594 <h2><a name="reg_prov">Registering Providers in the Pegasus Environment</a></h2>
\r
596 <p>Pegasus registers providers with a set of provider registration classes, not using the
\r
597 provider qualifier as is done in most DMTF CIM CIMOM implementations today. This set of
\r
598 classes is close to but not exactly the same as the current DMTF definition (See the DMTF
\r
599 Interop schema, experimental versions starting with 2.6). This will be harmonized in the
\r
600 future when the DMTF scheme is moved to final status. </p>
\r
602 <p>Registration is performed by defining a MOF for the instances of the registration
\r
603 classes that represent the porvider module, providers, classes, etc. to be
\r
604 registered. The easiest way to create a new registration today is to copy from one
\r
605 of the existing registration MOFs. See the providers/sample/load directory for
\r
606 examples of several registration instance implementations that do work with Pegasus today.</p>
\r
608 <h2><a name="bld_rpms">Building RPMs for Pegasus</a> </h2>
\r
610 <p>The source distribution includes a script you can use to create an RPM for Pegasus. To
\r
611 do this, your environment must meet the following requirements:
\r
614 <li>The root directory for Pegasus must be "/Pegasus-1.0" </li>
\r
615 <li>Your environment variables must be set, as described in <a href="#set_envt_var">Set
\r
616 evironment variables</a>. </li>
\r
617 <li>You must be logged in as the root user.</li>
\r
620 <p>To create the RPMs, run the script <tt>rpmBuild</tt> from the root directory of the
\r
621 source distribution. For example: <tt>. /usr/source/pegasus-1.0/rpmBuild</tt> </p>
\r
623 <p>This will result in and RPM file names <tt>pegasus<version number>.rpm</tt>. </p>
\r
625 <p><strong>Note</strong>: After you install using the install using the PRM, you must
\r
626 crate and populate teh repository manually. </p>
\r
629 <p>Question: I'm still working on this procedure (I haven't gotten it to work yet).<br>
\r
633 <h2><a name="note_bld_peg_lnx">Notes about Building Pegasus on Linux </a></h2>
\r
635 <p>Pegasus supports many distributions of Linux. Refer to <a href="#peg_sup_plat">Pegasus
\r
636 Supported Platforms</a> for more information. </p>
\r
638 <p>To build Pegasus on Linux, ensure that you you have the environment variables set
\r
639 (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the definition of
\r
640 PEGASUS_PLATFORM is normally LINUX_IX86_GNU. </p>
\r
645 <h2><a name="bld_peg_win">Notes on building Pegasus on Windows 2k or Windows XP with
\r
646 Microsoft Visual C++ </a></h2>
\r
648 <p>Use of Windows 2000 SP3 or later is recommended. Pegasus is regularly tested on
\r
649 both Windows 2000 and Windows XP using the Microsoft compilers.</p>
\r
651 <p>Today we build Pegasus on Windows using a set of make files contained in the source
\r
652 distribution, the Microsoft compilers (DevStudio 5.x is not supported, Visual Studio 6.0,
\r
653 SP5 is supported) and the GNUMAKE make utility. Note that you MUST have the Pegasus <a
\r
654 href="#mu_utility">mu.exe </a>utility compiled and available before trying to compile
\r
655 Pegasus on the normal windows platform. The following is the basic setup steps for the
\r
658 <p>Setup the environment variables and path for the Micrososft Visual C compiler.
\r
659 Typically this can be done by running the VCVARS32.BAT file supplied with Microsoft Visual
\r
660 C++. (contained in the same directory as cl.exe). </p>
\r
662 <p>For Windows, try the following for an example environment: </p>
\r
665 <pre>REM call the standard Microsoft .bat for VC 6 setup.
\r
666 call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat'
\r
667 REM Set debug to something if you want compile in debug mode
\r
668 set PEGASUS_DEBUG=true
\r
669 REM set PEGASUS_ROOT to top of source tree
\r
670 set PEGASUS_ROOT=C:/cimom/pegasus (Note: <span
\r
671 class="norm">The '/' characters are intentional and required by the Pegasus build system)</span>
\r
672 REM set PEGASUS_HOME to where you want repository and executables
\r
673 set PEGASUS_HOME=%PEGASUS_ROOT%
\r
674 REM setup the path to the runtime files.
\r
675 set path=%path%;%PEGASUS_HOME%\bin
\r
679 <h3><a name="mu_utility">The MU Utility </a></h3>
\r
681 <p>In order to provide a consistent build structure across multiple platforms, we
\r
682 developed a small utility to provide a consistent set of small utilities across these
\r
683 platforms. The MU utilityis a simple utility that contains many commands. For example: </p>
\r
685 <p><font face="Courier New"> C:\> mu rm myfile.cpp yourfile.cpp </font></p>
\r
687 <p>You may type "mu" to get a list of valid commands. Here are some of them: </p>
\r
689 <p> rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare
\r
692 <p>The MU utility supports globing (expansion of wildcards) so you can do things like
\r
695 <p><font face="Courier New"> C:\> mu rm *.obj *.exe </font></p>
\r
697 <p>MU is required to build under the Windows environment. MU is available as part of the
\r
698 distribution of Pegasus.<br>
\r
701 <h2><a name="note_bld_peg_mac">Notes about Building Pegasus on Mac OS X </a></h2>
\r
703 <p>No problem. Just make sure you have the environment variables set (PEASUS_HOME,
\r
704 PEGASUS_ROOT, PEGASUS_PLATFORM. For Mac OS X/Darwin, the defination of PEGASUS_PLATFORM is
\r
705 DARWIN_PPC_GNU.</p>
\r
708 <a name="note_bld_peg_ssl">Notes about Building Pegasus with SSL </a></h2>
\r
710 <p>To build with SSL you need the OpenSSL libraries and header files. They are NOT
\r
711 distributed with Pegasus. Make sure you have them in a standard directory so Pegasus can
\r
712 find them. If that's not the case, set the environment variable OPENSSL_HOME= to point
\r
713 where your OpenSSL installation is. </p>
\r
715 <p>Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make' in Pegasus
\r
716 directory and you will have Pegasus with SSL enabled. See "Creating SSL
\r
717 certificates" below for more information on how to use SSL. </p>
\r
719 <h3><a name="crt_ssl_cert">Creating SSL certifications </a></h3>
\r
721 <p>Type these commands in your shell to create the SSL certifications. The PEGASUS_ROOT
\r
722 and PEGASUS_HOME have to be set to your respective installation and source directory.<br>
\r
723 <span style="color: rgb(0, 0, 0);">Set the sslKeyFilePath to key.pem. Set the
\r
724 sslCertificateFilePath to cert.pem. To create a client truststore to validate the
\r
725 server against, copy the server's certificate into the client truststore, client.pem.</span><br>
\r
729 style="font-style: italic; font-family: courier new,courier,monospace; margin-left: 40px;"><small>CN="Common Name"
\r
730 EMAIL="test@email.address"
\r
731 HOSTNAME=`uname -n`
\r
732 sed -e "s/$CN/$HOSTNAME/" \
\r
733 -e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \
\r
734 > $PEGASUS_HOME/ssl.cnf
\r
735 chmod 644 $PEGASUS_HOME/ssl.cnf
\r
736 chown bin $PEGASUS_HOME/ssl.cnf
\r
737 chgrp bin $PEGASUS_HOME/ssl.cnf
\r
739 /usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \
\r
740 -nodes -config $PEGASUS_HOME/ssl.cnf \
\r
741 -keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem
\r
743 cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem</small></pre>
\r
745 <p style="color: rgb(0, 0, 0);">Note: key.pem is sslKeyFilePath. cert.pem is
\r
746 sslCertificateFilePath</p>
\r
748 <h1><a name="test">Testing a Pegasus Installation</a></h1>
\r
750 <p>Pegasus includes an extensive set of test facilities as part of the CVS enviroment,
\r
754 <li><b>Test Clients</b> - There are several clients that have been built specifically to
\r
755 test Pegasus, or parts of Pegasus, including TestClient, Client, CLI, ipinfo, osinfo,
\r
756 WbemEsec, etc. See the src/Clients directory for more information. These programs require
\r
757 a server complete with repository to be running. Note that some of these tests use
\r
758 classes and instances that are only installed with the "make testrepository"
\r
759 functions including test namespaces and extra classes and instances in those namespaces
\r
760 and additional providers from the providers/sample and proviers/testproviders directories.
\r
762 <li><b>Sample and test providers</b> - Test providers exist for the major provider
\r
763 types in the providers/sample directories and the providers/testProviders directory </li>
\r
764 <li><b>Unit Tests</b> - Most Pegasus functions include unit tests for the functions.
\r
765 These are normally executed with the "make tests" command which can be executed
\r
766 at many different levels of the source tree from the top level to execute all of the unit
\r
767 tests to individual directories. Usually the unit test functions can be found in
\r
768 test directories immediately below their corresponding source code (i.e common/tests
\r
769 is the unit test functions for the common directory). Unit tests are executed without the
\r
770 server being operational and normally do not require the existence of a Class repository. </li>
\r
771 <li><b>An end-to-end Test Suite</b> - the directory "test" contains a set of
\r
772 operations tests that cover the major CIM operations. See the make file TestMakefile
\r
773 in the PEGASUS_ROOT directory to execute these tests. This set of tests executes an
\r
774 extensive set of fixed tests and compares the results against predefined results.</li>
\r
777 <h2><a name="inst_peg_html">Installing the Pegasus HTML Test Client</a></h2>
\r
779 <p>This is a separate test tool that allows Pegasus requests to be initiated from any WEB
\r
780 browser and that uses a WEB browser, CGI scripts and HTML pages for the formatting and
\r
781 connections. It requires a WEB server, etc. The instructions for setting up this
\r
782 environment are maintained in a separate readme in the CGI directory. </p>
\r
784 <h2><a name="test_icu">Testing with ICU enabled</a></h2>
\r
786 <p>ICU (International Components for Unicode) refers to the set of libraries that Pegasus
\r
787 uses to run globalized. For example: these libraries are used to load messages in
\r
788 different languages, format currency and numbers according to a specific locale etc. In
\r
789 order to enable globalization in Pegasus, Pegasus must be built with ICU enabled, ie. the
\r
790 right environment variables must be set prior to running "make". Refer to the
\r
791 GlobalizationHOWTO.htm in the docs directory for details.<br>
\r
794 <p> When users run "make poststarttests" to verify the integrity of a
\r
795 Pegasus download, a series of tests are run that require the cimserver to be running.
\r
796 These tests currently depend on specific messages returned from the server. When ICU is
\r
797 enabled, all messages come from the resource bundles and these usually do not match the
\r
798 hardcoded default messages within Pegasus. These hardcoded default messages are what the
\r
799 various test programs expect in order to complete successfully. If the ICU enabled server
\r
800 is started without disabling message loading from the bundles, "make
\r
801 poststartests" will fail. In order to run "make poststarttests"
\r
802 successfully with ICU enabled, an environment variable called PEGASUS_USE_DEFAULT_MESSAGES
\r
803 must exist prior to starting the server. Once this is defined, when the cimserver starts,
\r
804 all messages generated will be the default hardcoded messages. This will enable "make
\r
805 poststarttests" to complete successfully. Once "make poststarttests" is
\r
806 complete, you should stop the cimserver and then undefine PEGASUS_USE_DEFAULT_MESSAGES. If
\r
807 this variable is left defined, Pegasus will not be able to load messages using ICU
\r
808 resource bundles.<br>
\r
811 <p><span class="norm"></span><font style="color: rgb(0, 0, 0);">When running the make
\r
812 tests command with ICU enabled, the PEGASUS_MSG_HOME environment variable must be set to
\r
813 the home directory where the ICU resource bundles are built. By default the resource
\r
814 bundles are built into directories below PEGASUS_HOME/msg, so that should be the setting
\r
815 for PEGASUS_MSG_HOME.<br>
\r
818 <p><font style="color: rgb(0, 0, 0);">-------------------------------------------------------------------------------------------------------------------------------------<br>
\r
821 <p><i><font size="2">Copyright (c) 2004 EMC Corporation; Hewlett-Packard Development
\r
822 Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation</font><br>
\r
824 <font size="1">Permission is hereby granted, free of charge, to any person obtaining a
\r
825 copy of this software and associated documentation files (the "Software"),
\r
826 to deal in the Software without restriction, including without limitation the rights to
\r
827 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
\r
828 Software, and to permit persons to whom the Software is furnished to do so, subject to the
\r
829 following conditions:</font><br>
\r
830 <font size="2"><br>
\r
831 </font><font size="1">THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE
\r
832 INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS
\r
833 PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
\r
834 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
\r
835 PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
\r
836 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
\r
837 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
\r
838 DEALINGS IN THE SOFTWARE.<br>
\r
841 <p><i><font size="1"><br style="font-family: arial;">
\r
842 <big><big><span style="font-family: arial;">------------------------End of
\r
843 Document-------------------------<br>
\r
844 </span></big></big></font></i></p>
\r
git.samba.org / tpot / pegasus / .git / blob