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