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