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