1 karl 1.1 <html>
2
3 <head>
4 <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
5 <meta name="ProgId" content="FrontPage.Editor.Document">
6 <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
7 <title>OpenPegasus</title>
8 </head>
9
10 <body>
11
12 <p align="center"><b><font size="4">Pegasus Enhancement Proposal (PEP)</font></b></p>
13 <p style="margin-top: 0; margin-bottom: 0"><b>PEP #:</b> 103</p>
14 <p style="margin-top: 0; margin-bottom: 0"><b>Title: </b>OpenPegasus Version 2.3
15 Release Readme file</p>
16 <p style="margin-top: 0; margin-bottom: 0"><b>Version: </b>1.0</p>
17 <p style="margin-top: 0; margin-bottom: 0"><b>Created:</b> 12 November 2003</p>
18 <p style="margin-top: 0; margin-bottom: 0"><b>Authors: </b>Karl Schopmeyer</p>
19 <p style="margin-top: 0; margin-bottom: 0"><b>Status: </b>draft</p>
20 <p style="margin-top: 0; margin-bottom: 0"><b>Version History:</b></p>
21 <table border="1" cellspacing="1" bordercolordark="#666666"
22 karl 1.1 bordercolorlight="#CCCCCC" width=100%
23 style='font-size=10.0pt;font-family:Arial'>
24 <tr>
25 <th bgcolor="#CAE6CA">Version</th>
26 <th bgcolor="#CAE6CA">Date</th>
27 <th bgcolor="#CAE6CA">Author</th>
28 <th bgcolor="#CAE6CA">Change Description</th>
29 </tr>
30 <tr>
31 <td align="center">1.0</td>
|
32 karl 1.2 <td align="center">12 November 2003</td>
|
33 karl 1.1 <td align="center">Karl Schopmeyer</td>
34 <td>Update from 2.2 Release notes. Converted to HTML</td>
35 </tr>
36 <tr>
37 <td align="center"> </td>
38 <td align="center"> </td>
39 <td align="center"> </td>
40 <td> </td>
41 </tr>
42 </table>
43 <hr>
44 <p><b>Abstract:</b> Installation, build, operation information on the
45 Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with
|
46 karl 1.2 the documentation in the release notes or interface definition documents for a
|
47 karl 1.1 particular release, those documents should be considered authorative. This is a
48 simplified overview to act as an introduction to Pegasus.</p>
49 <hr>
50
51 <p align="Center"><b><font size="5">OpenPegasus - A Manageability Services Broker
52 for the DMTF CIM/WBEM Standards
53 </font>
54 </b>
55
56 <p align="left">
57 <b>Tagline:</b> OpenPegasus is an object manager for DMTF CIM objects written in C++
58 and supported by The Open Group </p>
59
60 <p align="left">
61
|
62 karl 1.2 <b>STATUS:</b> Revised November 2003 for Pegasus release version 2.3.0
|
63 karl 1.1 </p>
64
65 <p align="center">
66 <b><font size="4">Table of Contents</font></b><p align="left" style="margin-top: 0; margin-bottom: 0">
67 <a href="#Overview"> Overview</a>
68
69 <p align="left" style="margin-top: 0; margin-bottom: 0">
70 <a href="#Availability of Pegasus">Availability of Pegasus</a><p align="left" style="margin-top: 0; margin-bottom: 0">
71 <a href="#Pegasus Major Components">Pegasus Major Components</a><p align="left" style="margin-top: 0; margin-bottom: 0">
72 <a href="#Pegasus Supported Platforms">Pegasus Supported Platforms</a><p align="left" style="margin-top: 0; margin-bottom: 0">
73 <a href="#Pegasus Dependencies">Pegasus Dependencies </a>
74
75 <p align="left" style="margin-top: 0; margin-bottom: 0">
76 <a href="#The Pegasus Directory Structure">The Pegasus Directory Structure</a>
77
78 <p align="left" style="margin-top: 0; margin-bottom: 0">
79 <a href="#Pegasus Installation">Installation</a>
80
81 <p align="left" style="margin-top: 0; margin-bottom: 0">
82 <a href="#Building Pegasus">Building Pegasus </a>
83
84 karl 1.1 <p align="left" style="margin-top: 0; margin-bottom: 0">
85 <a href="#Populate the Repository">Populate the Repository</a>
86
87 <p align="left" style="margin-top: 0; margin-bottom: 0">
88 <a href="#Registering Providers in the Pegasus Environment">Registering
89 Providers</a><p align="left" style="margin-top: 0; margin-bottom: 0">
90 <a href="#The MU Utility">The MU Utility</a>
91
92
93 <p align="left" style="margin-top: 0; margin-bottom: 0">
94 <a href="#Notes about Building Pegasus on Linux">Notes about Building Pegasus on Linux</a>
95
96 <p align="left" style="margin-top: 0; margin-bottom: 0">
97 <a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a>
98
99 <p align="left" style="margin-top: 0; margin-bottom: 0">
100 <a href="#Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++">Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a><p align="left" style="margin-top: 0; margin-bottom: 0">
101 <a href="#Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client
102 </a>
103
104 <p align="left" style="margin-top: 0; margin-bottom: 0">
105 karl 1.1 <a href="#Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a>
106
107 <p align="left" style="margin-top: 0; margin-bottom: 0">
108 <a href="#Commands">Commands</a>
109
110 <p align="left" style="margin-top: 0; margin-bottom: 0">
111 <a href="#Creating SSL certifications">Creating SSL certifications</a>.
112
113 <p align="left" style="margin-top: 0; margin-bottom: 0">
114 <a href="#Testing with ICU enabled">Testing with ICU enabled </a>
115
116 <p align="left" style="margin-top: 0; margin-bottom: 0">
117 <a href="#Pegasus Documentation">Documentation</a>
118
119 <p align="left" style="margin-top: 0; margin-bottom: 0">
120 <a href="#Participate!">Participate</a>
121
122 <h1><a name="Overview">Overview</a> </h1>
123
|
124 karl 1.2 <p><b>OpenPegasus (also referred to as Pegasus):</b>
|
125 karl 1.1
|
126 karl 1.2 Pegasus is an open-source CIM Server for DMTF CIM objects. It is written
127 in C++ and includes the Object manager (CIMOM), a set of defined interfaces, an
128 implemenation of the CIMOperations over HTTP operations and their cimxml HTTP
129 encodings, and
|
130 karl 1.1 Interface libraries
131 for both client and providers. It is maintained
132 consistent with the DMTF CIM and WBEM specifications except for exceptions
133 noted in the documentation.
134 <P>
|
135 karl 1.2 Pegasus is open source and is covered under the MIT open-source license.<P>
|
136 karl 1.1 Pegasus is being developed and maintained under the auspices of The Open
137 Group. Pegasus is maintained under the license defined in the doc directory
138 (LICENSE) of this release. This licensing is intended to support as wide a
139 distribution as possible with minimal demands on the users.
140 <P>
141 More information on this project, access to the CVS, and documentation on
142 Pegasus are available from the OpenGroup WEB site.
143 <P>
144 <a href="http://www.opengroup.org">http://www.openpegaus.org</a><p>
|
145 karl 1.2 There are a number of separate documents representing the status and each
146 release of Pegasus
|
147 karl 1.1 <ul>
|
148 karl 1.2 <li>What's new for this release - See the PEPs (Pegasus Enhancement Procedures)
149 release notes on the Pegasus web site and duplicated in the source top level
150 directory<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and
151 the web site as a Pegasus PEP.</ul>
|
152 karl 1.1
153
154 <p>The release notes are available on the WEB site as Pegasus PEP documents and
155 in the CVS for each release.</p>
156 <table border="1" cellspacing="1" width="31%" id="AutoNumber3">
157 <tr>
|
158 karl 1.2 <td width="42%"><b>Release</b></td>
159 <td width="58%"><b>Release Notes PEP</b></td>
|
160 karl 1.1 </tr>
161 <tr>
162 <td width="42%">2.0</td>
163 <td width="58%">None</td>
164 </tr>
165 <tr>
166 <td width="42%">2.1</td>
167 <td width="58%">None</td>
168 </tr>
169 <tr>
170 <td width="42%">2.2</td>
171 <td width="58%">PEP 57</td>
172 </tr>
173 <tr>
174 <td width="42%">2.3</td>
175 <td width="58%">PEP 98</td>
176 </tr>
177 </table>
178
179
180 <h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1>
181 karl 1.1
182 <p>Pegasus is distributed as open source under the MIT open-source license. The distribution is available via
|
183 karl 1.2 CVS and snapshot images in tar and zip file formats on the web site.
|
184 karl 1.1 The source code from CVS can be found at the following Open Group CVS server;
185 <p>
186 <font face="Courier New">
187 cvs.opengroup.org:/cvs/MSB </font>
188 <p>
189 using the password authenticating server option (pserve).
190 <p>
191 Anonymous access for read is with the name and password "anon" as follows:
192 <blockquote>
193 <p style="margin-top: 0; margin-bottom: 0">
194 <font face="Courier New">%export CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB
195 </font>
196 <p style="margin-top: 0; margin-bottom: 0"><font face="Courier New">%cvs login
197 </font>
198 </blockquote>
199 <p>
200 When requested, enter the password "anon".
201 The source tree is in the directory pegasus. To check out the complete Pegasus
202 source tree just type:
203 <p>
204 <font face="Courier New">
205 karl 1.1 cvs co pegasus </font>
206 <p>
207 A Pegasus directory will be created under the current directory and populated
208 with the complete source tree and documentation. To get the latest updates
209 after a checkout just type this from Pegasus root:
210 <p>
211 <font face="Courier New">
212 cvs update -d </font>
213
214 <p>
215 Active contributors to Pegasus have write access to the CVS repository.
216 If you are interested in contributing back to the Pegasus project,
217 (i.e. write (checkin) access to CVS) please request access from either
218 Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer
219 <a href="mailto:(k.schopmeyer@opengroup.org">(k.schopmeyer@opengroup.org</a>).
220
221 <h1>
222 <a name="Pegasus Major Components">Pegasus Major Components</a></h1>
223
224 <p>The major components of Pegasus are:
225 <ul>
226 karl 1.1 <li><b>Pegasus Server</b> - WBEM/CIM Server with interfaces for providers and clients
227 </li>
228 <li><b>Pegasus Repositories</b> - Today Pegasus provides a defined class repository
229 interface and a simple file based class repository. It also includes
230 an instance repository. Note that these repository were created for
231 functionality, not efficieny. It is expected that they will be replaced
232 with other implementations of the respository function as the need arises.
233 </li>
234 <li><b>Pegasus Client Library</b> - Tools for building Pegasus clients based on the Pegasus
235 C++ interfaces and using the WBEM HTTP/XML protocols or directly
236 interfacing with Pegasus.
237 </li>
238 <li><b>Pegasus Test Clients</b> - Simple test clients being developed as part of the
|
239 karl 1.2 Pegasus development process. These can be seen in the src/Clients directory and
240 its subdirectories
|
241 karl 1.1 </li>
242 <li><b>Pegasus HTML Test Client</b> - To aid in testing we created a test client for
243 Pegasus that uses a WEB server (ex. Apache) with a set of CGI modules and
244 HTML to allow the entry of Pegasus operations from a WEB browser as forms
245 and the receipt of the response as WEB pages. This has proven useful as a
246 test tool and can be used for a wide variety of demonstrations.
247 </li>
248 <li><b>Pegasus Provider Library</b> - Tools for building Pegasus providers using the Pegasus
249 C++ interfaces.
250 </li>
251 <li><b>Pegasus Providers</b> - Providers to illustrate the use of Pegasus services
252 including providers for test and demonstration.
253 </li>
254 <li><b>Pegasus Control Providers</b> - Common services for use by other Pegasus
255 components to extend Pegasus capabilites.
256 </li>
257 <li><b>Pegasus MOF Compiler </b>- There standalone compiler (cimmofl) for MOF files that can be used
258 to install MOF into the Pegasus schema repository and also to check syntax.
259 There is also a compiler that operates as a Pegasus client(cimmof)
260 There is also a tool to extract the MOF from the repository.
261
262 karl 1.1 </li>
263 </ul>
264
265 <h1>
266 <a name="Pegasus Supported Platforms">Pegasus Supported Platforms</a></h1>
267
268 <p>
269 Pegasus is regularly tested against a variety of platforms by the development
270 group. The set of platforms and exact set of compilers for any given
271 release is documented in the Release notes for that release (see the CVS source
272 tree root directory or the Pegasus PEP defining the ReleaseNotes for any
273 particular release).</p>
274
275 <p>
276 Generally Pegasus is supported on the following Platforms and Compilers.</p>
277 <table border="1" cellspacing="1" id="AutoNumber2" width="728">
278 <tr>
279 <td width="169" bgcolor="#99FF99"><b>Platform and OS</b></td>
280 <td width="556" bgcolor="#99FF99"><b>Compilers</b></td>
281 </tr>
282 <tr>
283 karl 1.1 <td width="169">AIX</td>
284 <td width="556">VisualAge C++ Version</td>
285 </tr>
286 <tr>
287 <td width="169">HP-UX</td>
288 <td width="556">HP aC++ </td>
289 </tr>
290 <tr>
291 <td width="169">Linux Itanium</td>
292 <td width="556">gcc</td>
293 </tr>
294 <tr>
295 <td width="169">Linux IA-32</td>
296 <td width="556">gcc (versions 2.9x and 3.xx)</td>
297 </tr>
298 <tr>
299 <td width="169">Windows 2000</td>
300 <td width="556">Microsoft Visual C++ Ver 6 and Microsoft .Net compiler
301 Version <font color="#FF0000">7</font></td>
302 </tr>
303 <tr>
304 karl 1.1 <td width="169">Windows XP</td>
305 <td width="556">Microsoft Visual C++ Ver. 6 and Microsoft .Net compiler
306 Version <font color="#FF0000">7</font></td>
307 </tr>
308 </table>
309
310 <h1>
311 <a name="Pegasus Dependencies">Pegasus Dependencies </a></h1>
312
313 <p>
314 We have worked to minimize the dependence of Pegasus on other software
315 packages and tools. Currently Pegasus has the following dependencies:
316 <p>
317 <b>1. GNUMAKE</b> - To simplify the building of Pegasus across multiple platforms we
318
319 have standardized on a set of build tools including: GNUMAKE. We are using
320 GNUMAKE 3.79.1 successfully both in Windows and Linux environments.
321 <p>
322 GNUMAKE is available from :<p>
323 <a href="http://www.gnu.org">http://www.gnu.org</a>
324
325 karl 1.1 <p>
326 NOTE: A set of the required tools for
327 windows platforms is available on the openpegasus web site.<p>
328 <b>2. MU.EXE </b>- To minimize the difference between Linux and Windows for GNUMAKE,
329 we have created a utility called MU.exe. This utility is required for
330 Pegasus make with ONLY Windows environment. It is provided as an alternative to
331 requiring a number of UNIX utilities (SH, RM, etc.) on the windows platform
332 and effectively provides the functions of these utilities that GNUMAKE
333 needs. MU is not required on UNIX or LINUX platforms.
334 <p>
335 NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory.
336 You must build it separately. MU source code is part of the distribution
337 in the directory src/utils/MU with its own make file. You must compile MU
338 before you initiate the Pegausu make.
339 <p>
340 NOTE: A copy of the binary is made available as a zip file on the Pegasus
341 WEB site.
342 <p>
343 Again, MU is used ONLY if you are using Windows.
344
345 <p>
346 karl 1.1 <b>3. FLEX and BISON</b> - These tools were used to develop the MOF compiler and WQL
347 parser. Anybody intending to recompile the compiler or parser from scratch
348 will be required to have these tools. They are only required if changes need
349 to be made to the files for parsing and compiling.
350 <p><b>4. DOC++ </b>- The Pegasus documentation is taken from a combination of text files
351 and the Pegasus header files themselves. This documentation is formatted
352 with DOC++ and GAWK. These tools are required if the documentation is to
353 be recreated but we expect that only the core team will be recreating
354 documentation.
355
356 <p><b>5. ICU Internationalization libraries</b> - These libraries are used as
357 the basis for message catalogs for message internationalization. See the ICU
358 website (http://oss.software.ibm.com/icu/) for more information on these
359 libraries<p>6. <b>OpenSSL </b>- If it is intended to use SSL on the
360 communication protocol, the OpenSSL libraries are required.<h1>
361 <a name="The Pegasus Directory Structure">The Pegasus Directory Structure</a></h1>
362 <p>
363 Pegasus is distributed as a complete source directory structure that should be
364 installed either from one of the snapshots or from CVS.
365 <p>
366 This structure is generally as follows:<p>
367 karl 1.1 <font face="Courier New">Pegasus Source Structure</font><p>
368 <font face="Courier New">Pegasus Root directory (PEGASUS_ROOT environment
369 variable)</font><ul>
370 <li><font face="Courier New"><b>cgi</b> Source for the Pegasus WEB Based Test client
371 </font>
372 <ul>
373 <li><font face="Courier New">cgi-bin CGI Directories for WEB demonstration.
374 This directory is normally empty but can
375 be populated from the runtime with the make
376 from cgi.
377 </font></li>
378 <li><font face="Courier New">htdocs HTML Pages for Pegasus WEB demonstration
379 </font></li>
380 </ul>
381 </li>
382 <li><font face="Courier New"><b>doc</b> Miscellaneous Pegasus Documents.
383 </font>
384 <ul>
385 <li><font face="Courier New">apidoc - Source for the public api
386 documentation.</font></li>
387 <li><font face="Courier New">DevManual Source and build files for developers' manual
388 karl 1.1 mak General make files (used by other makes)</font></li>
389 </ul>
390 </li>
391 <li><font face="Courier New"><b>mak</b> - Common make files for Pegasus
392 compilation</font></li>
393 <li><font face="Courier New"><b>Dummy</b> -</font></li>
394 <li><font face="Courier New"><b>InterfaceArchive</b> -</font></li>
395 <li><font face="Courier New"><b>rpm</b> - files for rpm installation for Linux</font></li>
396 <li><font face="Courier New"><b>Schemas</b> - Schemas used in the installation
397 of Pegasus. This includes currently released versions of the DMTF schemas in
398 subdirectories (ex. CIM27) and Pegasus local Schemas (ex. </font></li>
399 <li><font face="Courier New"><b>src</b> All Pegasus Source Files
400 </font>
401 <ul>
402 <li><font face="Courier New"><b>ACEExample</b> Test directrory with examples of the use of ACE (obsolete).
403 </font></li>
404 <li><font face="Courier New"><b>Clients</b> Source for various test
405 clients and demonstration clients.</font></li>
406 <li><font face="Courier New"><b>CGICLIENT</b> Pegasus test client that uses a WEB browser
407 JAVA Java Client support modules
408 </font></li>
409 karl 1.1 <li><font face="Courier New"><b>Pegasus</b> - Core pegasus modules.
410 </font>
411 <ul>
412 <li><font face="Courier New"><b>Client</b> Pegasus Client API Tests
413 depends tests </font></li>
414 <li><font face="Courier New"><b>Common</b> Pegasus Common Functions (C++ source and headers
415 tests Test programs for the common functions</font></li>
416 <li><font face="Courier New"><b>Compiler</b> Pegasus MOF compiler
417 </font></li>
418 <li><font face="Courier New"><b>Config</b> Pegasus Configuration
419 functions</font></li>
|
420 karl 1.2 <li><font face="Courier New"><b>Consumer</b> Indication Consumer class
421 header</font></li>
|
422 karl 1.1 <li><font face="Courier New"><b>ControlProviders</b> Implementation of Pegasus internal providers
423 </font></li>
|
424 karl 1.2 <li><font face="Courier New"><b>ExportClient</b> Client connect code
425 for export of indications</font></li>
426 <li><font face="Courier New"><b>ExportServer</b> Server code for
427 import of indications</font></li>
428 <li><font face="Courier New"><b>Handler</b> Indication handlers. Today
429 this includes cimxml, SNMP and email handlers</font></li>
430 <li><font face="Courier New"><b>HandlerService</b> Common code for
431 indication handler service</font></li>
432 <li><font face="Courier New"><b>IndicationService</b> Common service
433 functions for indication subscription processing</font></li>
434 <li><font face="Courier New"><b>Listener</b> Common code that allows
435 CIM Listeners to be created and connected.</font></li>
|
436 karl 1.1 <li><font face="Courier New"><b>Protocol</b> Pegasus Client HTTP/XML Protocol Modules
437 depends </font></li>
438 <li><font face="Courier New"><b>Provider</b> Pegasus Provider interface functions
439 </font></li>
440 <li><font face="Courier New"><b>ProviderManager</b> Provider Manager service that manages providers
441 </font></li>
442 <li><font face="Courier New"><b>ProviderManager2</b> Pluggable Provider Manager service.
443 Today this is not enabled by default It will become the Pegasus
444 standard provider manager at some time in the future but for now, see
445 the release notes if you want to enable it.</font></li>
446 <li><font face="Courier New"><b>Repository</b> Pegasus Repository
447 Interfaces and Simple Repository tests </font>
448 <ul>
449 <li><font face="Courier New">Tests for Repository Functions </font>
450 </li>
451 </ul>
452 </li>
|
453 karl 1.2 <li><font face="Courier New"><b>Security</b> Authentication and user
454 support functions.</font></li>
|
455 karl 1.1 <li><font face="Courier New"><b>Server</b> Pegasus Server Modules
456 </font></li>
|
457 karl 1.2 <li><font face="Courier New"><b>WQL</b> the WQL query language
458 interpreter.</font></li>
|
459 karl 1.1 </ul>
460 </li>
461 </ul>
462 </li>
463 <li><font face="Courier New"><b>Providers</b> Pegasus test and required providers
464 </font>
465 <ul>
|
466 karl 1.2 <li><font face="Courier New"><b>generic</b> A number of
467 cross-platform providers
|
468 karl 1.1 </font></li>
|
469 karl 1.2 <li><font face="Courier New">IndicationConsumer - Provider that
470 consumes indications</font></li>
471 <li><font face="Courier New"><b>Linux</b> - A number of linux
472 providers</font></li>
|
473 karl 1.1 <li><font face="Courier New"><b>ManagedSystem</b> Providers
474 associated with managing the Pegasus System</font></li>
|
475 karl 1.2 <li><font face="Courier New"><b>slp</b> - Provider for slp
476 service agent support</font></li>
|
477 karl 1.1 <li><font face="Courier New"><b>statistic</b> - Providers for
478 Pegasus statistics.</font></li>
479 <li><font face="Courier New"><b>sample</b> Sample providers for the
480 major provider types.</font></li>
481 <li><font face="Courier New"><b>testproviders</b> </font></li>
482 </ul>
483 </li>
484 <li><font face="Courier New"><b>Server</b> Pegasus executable build
485 </font></li>
|
486 karl 1.2 <li><font face="Courier New"><b>slp</b> - </font></li>
487 <li><font face="Courier New"><b>Standard Includes</b> - </font></li>
|
488 karl 1.1 <li><font face="Courier New"><b>test</b> - Directory of end-end
489 tests that are regularly conducted on Pegasus</font></li>
490 <li><font face="Courier New"><b>tools</b> MU and other utilities written for Pegasus support
491 </font></li>
492 <li><font face="Courier New"><b>Unsupported</b> Code that is made available but is not supported or included
493 in the normal make. </font></li>
|
494 karl 1.2 <li><font face="Courier New"><b>WMIMapper</b> Pegasus implementation that
495 provides mapping to Microsoft WMI objects.
|
496 karl 1.1
497 </font></li>
498 </ul>
499 <p>
500 <font face="Courier New">Pegasus Run Time directory structure (PEGASUS_HOME
501 environment variable). Home directory for runtime. All compiler, linker
502 documentation creation, etc. are put here.
503 </font>
504 <ul>
505 <li><font face="Courier New"><b>bin</b> - Destination for executable and DLL modules from
506 Pegasus build. This directory should be make public so that the test functions,
507 clients, and cimserver can be executed with minimum effort.</font></li>
508 <li><font face="Courier New"><b>DevManualHTML</b> - HTML output of the Pegasus Manual.
509 This is only created when the make file for this manual is
510 executed (doc/DevManual) and then contains the html representing
511 the document.</font></li>
512 <li><font face="Courier New"><b>apidochtml</b> - HTML output of
513 the creation of the public API document. This only exists
514 when the make file for the api document is executed (see doc/apidoc/Makefile)</font></li>
515 <li><font face="Courier New"><b>lib</b> - Destination for Pegasus LIB modules
516 </font></li>
517 karl 1.1 <li><font face="Courier New"><b>log</b> - Standard location for
518 Pegasus Logs</font></li>
519 <li><font face="Courier New"><b>obj</b> - Destination for object
520 modules. Note that today, the trace file is located in the
521 PEGASUS_HOME directory, not in the log directory if Pegasus
522 internal tracing is enabled.</font></li>
523 <li><font face="Courier New"><b>repository</b> - This Directory
524 contains the created repository </font></li>
525 </ul>
526
527 <h1>
528 <a name="Pegasus Installation">Pegasus Installation</a> </h1>
529 <p>
|
530 karl 1.2 Pegasus today is provided only as a source distribution. Note that there
531 is code for a Linux RPM distribution but the project is not yet releasing
532 binaies.<p>
|
533 karl 1.1 To install Pegasus, you must check it out using CVS (Common Version System)
534 or download a snapshot. You download, compile, and use it.
535 <p>
536 For the snapshot, the installation of Pegasus involves expanding the snapshot
537 distribution files, building the runtime, the test files and test clients, and
538 building the repository.
539 <h1>
540
541 <a name="Building Pegasus">Building Pegasus </a>
542
543 </h1>
544
545 <p>
546 1. Check that you have requisite programs (listed in Pegasus Dependencies).
547
548 These include GNU Make, MU.EXE (if using Windows), Flex, and Bison (Flex
549 and Bison only required if changes will be made to the MOF compiler or WQL
550 parser).
551 <p>
552 Be sure these are on the path.
553
554 karl 1.1 <p>
555 2. Define the following three environment variables:
556 <ul>
557 <li><b>PEGASUS_ROOT</b> - this should be the "pegasus" directory you've pulled from CVS
558 </li>
559 <li><b>PEGASUS_HOME</b> - to point to a directory to contain output binary files
560 (e.g., set it to $HOME/pegasus_home). Then the output will go into
561 $HOME/pegasus_home/bin and $HOME/pegasus_home/lib
562 </li>
|
563 karl 1.2 <li><b>PEGASUS_PLATFORM</b> - this must be set to a supported
564 platform identifier.</li>
|
565 karl 1.1 </ul>
566 <blockquote>
567 <p>
568 This identifier has the following form:
569 <p>
570 <font face="Courier New">
571 <Operating-System>_<Architecture>_<Compiler> </font>
572 <p>
573 For example (Linux on IA32 platform using the GNU Compiler):
574 LINUX_IX86_GNU
575 <p>
|
576 karl 1.2 For a complete list of platforms supported and platform support keywords, refer to the platform make files found in directory
|
577 karl 1.1 <font face="Courier New">pegasus/mak</font>
578
579 </blockquote>
580
581 <p>
582 Note: if you plan on doing parallel builds, you might consider setting
583 PEGASUS_HOME to something like this:
584 <p>
585 <font face="Courier New">
586 $HOME/pegasus_home_LINUX_IX86_GNU </font>
587 <p>
588 That way, the output of each build will be placed in its own directory.
589 <p>
590 3. Now place $PEGASUS_HOME/bin on your path
591 <p> and
592 <p>
593
594 Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only).
595 For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib
596 <p>
|
597 karl 1.2 4. Change to the root of the Pegasus distribution and type "make"
|
598 karl 1.1 (where make refers to GNU make).
599 <p>
600 5. Then create the repository, which is needed to serve data.
601 "make repository". Note that to create the additional namespaces, etc.
602 that represent the test support you can also execute "make testrepository:<p>
603 6. To test the build type "make tests".
604 The following make targets are supported:
605 <UL>
606 <li><default> - Build everything.
607 <li>clean - Clean out all objects, libs, and executables.
608 <li>depend - Create the dependencies.
609 <li>repository - Create the repository in $PEGASUS_HOME/repository
610 <li>tests - Execute all tests (except client server tests).
611 <li>rebuild - clean, depend, <default>
612 <li>world - depend, <default>
613 </UL>
614 The Pegasus Client server tests are executed separately from the above because
615 they require the initiation of separate process for the Pegasus server and
616 Pegasus client. To execute these tests please refer to the scripts in
617 pegasus/mak/BuildMakefile - refer to the prestarttests and poststarttests.
618 <p>
619 karl 1.1 For information on particular installation characteristics, tools, etc. for
620 each platform see the appropriate sections below:
621 <p>
622 Generally the build commands are as follows:
623 <ol>
624 <li>There is a Makefile in the Pegasus root directory. Simply executing
625 make in the Pegasus root directory will make everything. "make rebuild"
626 will clean and rebuild everything. The "make rebuild" will also populate
627 the repository with the current CIM Schemas.
628 </li>
629 <li>To test a fresh release, go to the pegasus root and type
630 "<font face="Courier New">make world</font>".
631 This will build dependencies, build binaries, and then run all
632 tests except the Client/Server tests.
633 </li>
634 <li>To execute the basic test suite that is shipped with pegasus type
635 "make tests". This also reinstalls the repository.
636 Running "make -s tests" suppresses extraneous output such as the
637 enter/leave directory messages.
638 </li>
639 <li>"make clean" removes all object and library files from the structure.
640 karl 1.1
641 </li>
642 <li>A new build system has been added to Pegasus where a new CVS checkout is
643 done,
644 built, and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild"
645
646 </li>
647 </ol>
648
649 <h1>
650 <a name="Populate the Repository">Populating the Pegasus Repository</a> </h1>
651
652 <p>
653 Before using Pegasus you must populate the repository.. The makefile
654 does it all for you, but in case you are wondering what it does or how to do it
655
656 manually:
657 <ol>
658 <LI>Register the MOF (Managed Object Format) file describing the skeleton of the
659 object.
660 <li>Register a second MOF which only points out which lib*.so file to be loaded
661 karl 1.1 when a
662 specific object is activated.
663 </ol>
664 This is done automatically for the providers included in Pegasus by doing:
665 make repository.
666 <p>
667 The 'make repository' in pegasus/Schemas does three things
668 Runs MOF compiler (cimmofl) on:
669 -Schema v2.7
670 Generates the CIM Schema v2.7 in the repository (skeleton of CIM objects)
671 -PG_InterOp
672 Internal to Pegasus schema for operating (shutdown, add users, etc)
673 CIM_Indication’s (SNMP, Events, Alert, Threshold, etc)
674 -PG_ManagedSystem
675 Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, … )
676 in Pegasus (which are located in src/Providers)
677 <p>
678 For more information about using the MOF compiler, refer to user's manual on the
679
680 openpegasus.org.
681
682 karl 1.1 <h1>
683 <a name="Testing a Pegasus Installation">Testing a Pegasus Installation</a></h1>
684 <p>
685 Pegasus includes an extensive set of test facilities as part of the CVS
686 enviromentthat can be executed including:<ul>
687 <li><b>Test Clients</b> - There are several clients that have been built
688 specifically to test Pegasus or parts of Pegasus including TestClient, Client,
689 CLI, ipinfo, osinfo, WbemEsec, etc. See the src/Clients directory for more
690 information. These programs require a server complete with repository to be
691 running. Note that some of these tests use classes and instances that
692 are only installed with the "make testrepository" functions including test
693 namespaces and extra classes and instances in those namespaces and additional
694 providers from the providers/sample and proviers/testproviders directories.</li>
695 <li><b>Sample and test providers</b> - Test providers exist for the
696 major provider types in the providers/sample directories and the providers/testProviders
697 directory</li>
698 <li><b>Unit Tests</b> - Most Pegasus functions include unit tests for the
699 functions. These are normally executed with the "make tests" command
700 which can be executed at many different levels of the source tree from the top
701 level to execute all of the unit tests to individual directories.
702 Usually the unit test functions can be found in test directories immediately
703 karl 1.1 below their corresponding source code (i.e common/tests is the unit test
704 functions for the common directory). Unit tests are executed without the
705 server being operational and normally do not require the existence of a Class
706 repository.</li>
707 <li><b>An end-to-end Test Suite</b> - the directory "test" contains a set of
708 operations tests that cover the major CIM operations. See the make file
709 TestMakefile in the PEGASUS_ROOT directory to execute these tests. This
710 set of tests executes an extensive set of fixed tests and compares the results
711 against predefined results.</li>
712 </ul>
713
714 <h1>
715 <a name="Registering Providers in the Pegasus Environment">Registering Providers
716 in the Pegasus Environment</a></h1>
717
718 <p>
719 Pegasus registers providers with a set of provider registration classes, not
720 using the provider qualifier as is done in most DMTF CIM CIMOM implementations
721 today. This set of classes is close to but not exactly the same as the current
722 DMTF definition (See the DMTF Interop schema, experimental versions starting
723 with 2.6). This will be harmonized in the future when the DMTF scheme is moved
724 karl 1.1 to final status. </p>
725
726 <p>
727 Registration is performed by defining a MOF for the instances of the
728 registration classes that represent the porvider module, providers, classes,
729 etc. to be registered. The easiest way to create a new registration today
730 is to copy from one of the existing registration MOFs. See the
731 providers/sample/load directory for examples of several registration instance
732 implementations that do work with Pegasus today.</p>
733
734 <h1>
735 <a name="The MU Utility">The MU Utility </a></h1>
736
737 <p>
738 In order to provide a consistent build structure across multiple platforms, we
739 developed a small utility to provide a consistent set of small utilities
740 across these platforms. The MU utilityis a simple utility that contains many
741 commands. For example:
742
743 <p>
744 <font face="Courier New">
745 karl 1.1 C:\> mu rm myfile.cpp yourfile.cpp </font>
746
747 <p>
748 You may type "mu" to get a list of valid commands. Here are some
749 of them:
750
751 <p>
752
753 rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare depend
754
755 <p>
756 The MU utility supports globing (expansion of wildcards) so
757 you can do things like this:
758 <p>
759
760 <font face="Courier New">
761
762 C:\> mu rm *.obj *.exe </font>
763 <p>
764 MU is required to build under the Windows environment. MU is available as part
765 of the distribution of Pegasus.
766 karl 1.1
767 <h1>
768 <a name="Notes about Building Pegasus on Linux">Notes about Building Pegasus on
769 Linux </a></h1>
770 <p>
771 No problem. Just make sure you have the environment variables set (PEASUS_HOME,
772 PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the defintion of
773 PEGASUS_PLATFORM is normally LINUX_IX86_GNU.
774
775 <h1><a name="Notes about Building Pegasus with SSL">Notes about Building Pegasus with SSL
776 </a></h1>
777 <p>
778 To build with SSL you need the OpenSSL libraries and header files. They are NOT
779 distributed with Pegasus. Make sure
780 you have them in a standard directory so Pegasus can find them. If that's not
781
782 the case, set the environment variable OPENSSL_HOME= to point where your
783 OpenSSL
784 installation is.
785 <p>
786 Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make' in Pegasus
787 karl 1.1 directory and you will have Pegasus with SSL enabled. See section "Creating SSL
788
789 certificates" for more information of how to use SSL.
790
791 <h1>
792 <a name="Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++">
793 Building Pegasus on Windows 2k or Windows XP with Microsoft Visual C++ </a></h1>
794
795 <p>
796 Use of Windows 2000 SP3 or later is recommended. Pegasus is regularly
797 tested on both Windows 2000 and Windows XP using the Microsoft compilers.<p>
798 Today we build Pegasus on Windows using a set of make files contained
799 in the source distribution, the Microsoft compilers (DevStudio 5.x is not
800 supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE make utility.
801 Note that you MUST have the Pegasus <a href="#The MU Utility">mu.exe </a>utility
802 compiled and available before trying to compile Pegasus on the normal windows
803 platform. The
804
805 following is the basic setup steps for the environment.
806 <p>
807
808 karl 1.1 Setup the environment variables and path for the Micrososft Visual C compiler.
809
810 Typically this can be done by running the VCVARS32.BAT file supplied with
811 Microsoft Visual C++. (contained in the same directory as cl.exe).
812 <p>
813 For Windows, try the following for an example environment:
814 <blockquote>
815 <pre>REM call the standard Microsoft .bat for VC 6 setup.
816 call 'C:/Program Files/Microsoft Visual Studio/VC98/Bin/Vcvars32.bat'
817 REM Set debug to something if you want compile in debug mode
818 set PEGASUS_DEBUG=true
819 REM set PEGASUS_ROOT to top of source tree
820 set PEGASUS_ROOT=C:/cimom/pegasus
821 REM set PEGASUS_HOME to where you want repository and executables
822 set PEGASUS_HOME=%PEGASUS_ROOT%
823 REM setup the path to the runtime files.
824 set path=%path%;%PEGASUS_HOME%/bin
825 </pre>
826 </blockquote><h1><a name="Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client</a></h1><p>
827 This is a separate test tool that allows Pegasus requests to be initiated from
828 any WEB browser and that uses a WEB browser, CGI scripts and HTML pages for
829 karl 1.1 the formatting and connections. It requires a WEB server, etc. The
830 instructions for setting up this environment are maintained in a separate readme in the CGI directory. <h1><a name="Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a></h1><p>
|
831 karl 1.2 ATTN: This section needs to be completed. It should reference the more complete
832 documentation.<h1><a name="Commands">Commands</a></h1><p>
|
833 karl 1.1 The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on
834 CVS) <p>
835 To see simple help for each of the commands, use the "-h" flag. <blockquote><pre>Examples:
836 bin/cimserver –s (Shuts it down)
837 bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags)
838 bin/cimprovider –l –s (lists providers and their status)
839 bin/cimprovider –e –m OperatingSystemModule (enables the OperatingSystem provider)
840 bin/cimuser –a –u guest –w ThePassword
841 bin/cimuser –l (lists the users)
842 bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type)
843 </pre>
844 </blockquote><h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1><p>
845 Type these commands in your shell to create the SSL certifications. The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective installation and source
846 directory. <blockquote><pre>CN="Common Name"
847 EMAIL="test@email.address"
848 HOSTNAME=`uname -n`
849 sed -e "s/$CN/$HOSTNAME/" \
850 -e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \
851 > $PEGASUS_HOME/ssl.cnf
852 chmod 644 $PEGASUS_HOME/ssl.cnf
853 chown bin $PEGASUS_HOME/ssl.cnf
854 karl 1.1 chgrp bin $PEGASUS_HOME/ssl.cnf
855
856 /usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \
857 -nodes -config $PEGASUS_HOME/ssl.cnf \
858 -keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem
859
860 cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem
861 rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem
862 cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem
863 </pre></blockquote><h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1><p>
864 ICU (International Components for Unicode) refers to the set of libraries that
865 Pegasus uses to run globalized. For example: these libraries are used to
866 load messages in different languages, format currency and numbers according to
867 a specific locale etc. In order to enable globalization in Pegasus, Pegasus
868 must be built with ICU enabled, ie. the right environment variables must be
869 set prior to running "make". Refer to the GlobalizationHOWTO.htm in the docs
870 directory for details. That said, when users run "make poststarttests"
871 to verify the integrity of a Pegasus download, a series of tests are run that
872
873 require the cimserver to be running. These tests currently depend on specific
874
875 karl 1.1 messages returned from the server. When ICU is enabled, all messages come
876 from the resource bundles and these usually do not match the hardcoded default messages within Pegasus. These hardcoded default messages
877 are what the various test programs expect in order to complete
878 successfully. If the ICU enabled server is started without
879 disabling message loading from the bundles, "make poststartests" will fail.
880 In order to run "make poststarttests" successfully with ICU enabled, an
881 environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist prior to
882 starting the server. Once this is defined, when the cimserver starts, all
883 messages generated will be the default hardcoded messages. This will enable
884 "make poststarttests" to complete successfully. Once "make poststarttests" is
885 complete, you should stop the cimserver and then undefine PEGASUS_USE_DEFAULT_MESSAGES.
886 If this variable is left defined, Pegasus will not be able to load messages
887 using ICU resource bundles. <h1><a name="Pegasus Documentation">Pegasus Documentation</a></h1><p>
888 The documentation is currently in preparation. Much of Pegasus is
889 documented in the PEGASUS PEPs which are the basis for approval of Pegasus
|
890 karl 1.2 functionality, changes, plans, etc. These documents are openly available
|
891 karl 1.1 on the PEGASUS web site. The preliminary documentation
892 is not provided with this release. The current documentation is maintained both as a manual created
893 under the tool DOC++ in the runtime subdirectory manual/html (see doc/devManual
894 to create), as an api document also creatable from the source tree (see doc/apidoc)
895 and as other miscellaneous documentation in the doc directory. Also there is a
896 set of release notes. Normally the release notes for the current release are
897 available in the root source directory of CVS.<p>
898 Note that the Pegasus WEB site at The Open Group will be the source of most
899 documentation in the future and today is the source of most discussion and
900 design documentation. <h1><a name="Participate!">Participate!</a></h1><p>
901 We are looking for people who want to join the Pegasus work group and
902 contribute to effort of getting this Pegasus off the ground. Please join
903 the mailing list by visiting www.openpegasus.org, and click on Mailing Lists.
904 </p>
905
906 </body>
907
908 </html>
|
Return to
readme.html
CVS log
Up to [Pegasus] / pegasus