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