version 1.1, 2003/11/13 16:02:37
|
version 1.3, 2004/03/09 21:38:27
|
|
|
</tr> | </tr> |
<tr> | <tr> |
<td align="center">1.0</td> | <td align="center">1.0</td> |
<td align="center">12 Novemberl 2003</td> |
<td align="center">12 November 2003</td> |
<td align="center">Karl Schopmeyer</td> | <td align="center">Karl Schopmeyer</td> |
<td>Update from 2.2 Release notes. Converted to HTML</td> | <td>Update from 2.2 Release notes. Converted to HTML</td> |
</tr> | </tr> |
|
|
<hr> | <hr> |
<p><b>Abstract:</b> Installation, build, operation information on the | <p><b>Abstract:</b> Installation, build, operation information on the |
Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with | Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with |
the documentation in the release notes or interface defintion documents for a |
the documentation in the release notes or interface definition documents for a |
particular release, those documents should be considered authorative. This is a | particular release, those documents should be considered authorative. This is a |
simplified overview to act as an introduction to Pegasus.</p> | simplified overview to act as an introduction to Pegasus.</p> |
<hr> | <hr> |
|
|
| |
<p align="left"> | <p align="left"> |
| |
<b>STATUS:</b> Revised October 2003 for Pegasus release version 2.3. |
<b>STATUS:</b> Revised November 2003 for Pegasus release version 2.3.0 |
</p> | </p> |
| |
<p align="center"> | <p align="center"> |
|
|
<a href="#Creating SSL certifications">Creating SSL certifications</a>. | <a href="#Creating SSL certifications">Creating SSL certifications</a>. |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> | <p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
<a href="#Configuring SSL">Configuring Pegasus to use SSL</a>. |
|
|
|
<p align="left" style="margin-top: 0; margin-bottom: 0"> |
<a href="#Testing with ICU enabled">Testing with ICU enabled </a> | <a href="#Testing with ICU enabled">Testing with ICU enabled </a> |
| |
<p align="left" style="margin-top: 0; margin-bottom: 0"> | <p align="left" style="margin-top: 0; margin-bottom: 0"> |
|
|
| |
<h1><a name="Overview">Overview</a> </h1> | <h1><a name="Overview">Overview</a> </h1> |
| |
<p>OpenPegasus (also referred to as Pegasus): |
<p><b>OpenPegasus (also referred to as Pegasus):</b> |
| |
Pegasus is an open-source object manager (CIMOM) for DMTF CIM objects. It is written |
Pegasus is an open-source CIM Server for DMTF CIM objects. It is written |
in C++ and includes the Object manager, a set of defined interfaces, and |
in C++ and includes the Object manager (CIMOM), a set of defined interfaces, an |
|
implemenation of the CIMOperations over HTTP operations and their cimxml HTTP |
|
encodings, and |
Interface libraries | Interface libraries |
for both client and providers. It is maintained | for both client and providers. It is maintained |
consistent with the DMTF CIM and WBEM specifications except for exceptions | consistent with the DMTF CIM and WBEM specifications except for exceptions |
noted in the documentation. | noted in the documentation. |
<P> | <P> |
Pegasus is open source and is covered under the MIT open-source license. |
Pegasus is open source and is covered under the MIT open-source license.<P> |
<P> |
|
Pegasus is being developed and maintained under the auspices of The Open | Pegasus is being developed and maintained under the auspices of The Open |
Group. Pegasus is maintained under the license defined in the doc directory | Group. Pegasus is maintained under the license defined in the doc directory |
(LICENSE) of this release. This licensing is intended to support as wide a | (LICENSE) of this release. This licensing is intended to support as wide a |
|
|
Pegasus are available from the OpenGroup WEB site. | Pegasus are available from the OpenGroup WEB site. |
<P> | <P> |
<a href="http://www.opengroup.org">http://www.openpegaus.org</a><p> | <a href="http://www.opengroup.org">http://www.openpegaus.org</a><p> |
There are separate documents |
There are a number of separate documents representing the status and each |
|
release of Pegasus |
<ul> | <ul> |
<li>What's new for this release - WHATSNEW and the release notes for each |
<li>What's new for this release - See the PEPs (Pegasus Enhancement Procedures) |
release.<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and |
release notes on the Pegasus web site and duplicated in the source top level |
the web site as a Pegasus PEP.<li>Release Notes for each released version</ul> |
directory<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and |
|
the web site as a Pegasus PEP.</ul> |
| |
| |
<p>The release notes are available on the WEB site as Pegasus PEP documents and | <p>The release notes are available on the WEB site as Pegasus PEP documents and |
in the CVS for each release.</p> | in the CVS for each release.</p> |
<table border="1" cellspacing="1" width="31%" id="AutoNumber3"> | <table border="1" cellspacing="1" width="31%" id="AutoNumber3"> |
<tr> | <tr> |
<td width="42%">Release</td> |
<td width="42%"><b>Release</b></td> |
<td width="58%">Release Notes PEP</td> |
<td width="58%"><b>Release Notes PEP</b></td> |
</tr> | </tr> |
<tr> | <tr> |
<td width="42%">2.0</td> | <td width="42%">2.0</td> |
|
|
<h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1> | <h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1> |
| |
<p>Pegasus is distributed as open source under the MIT open-source license. The distribution is available via | <p>Pegasus is distributed as open source under the MIT open-source license. The distribution is available via |
CVS and snapshot images in tar and zip file formats. |
CVS and snapshot images in tar and zip file formats on the web site. |
The source code from CVS can be found at the following Open Group CVS server; | The source code from CVS can be found at the following Open Group CVS server; |
<p> | <p> |
<font face="Courier New"> | <font face="Courier New"> |
|
|
interfacing with Pegasus. | interfacing with Pegasus. |
</li> | </li> |
<li><b>Pegasus Test Clients</b> - Simple test clients being developed as part of the | <li><b>Pegasus Test Clients</b> - Simple test clients being developed as part of the |
Pegasus development process |
Pegasus development process. These can be seen in the src/Clients directory and |
|
its subdirectories |
</li> | </li> |
<li><b>Pegasus HTML Test Client</b> - To aid in testing we created a test client for | <li><b>Pegasus HTML Test Client</b> - To aid in testing we created a test client for |
Pegasus that uses a WEB server (ex. Apache) with a set of CGI modules and | Pegasus that uses a WEB server (ex. Apache) with a set of CGI modules and |
|
|
</font></li> | </font></li> |
<li><font face="Courier New"><b>Config</b> Pegasus Configuration | <li><font face="Courier New"><b>Config</b> Pegasus Configuration |
functions</font></li> | functions</font></li> |
<li><font face="Courier New"><b>Consumer</b> TBD </font></li> |
<li><font face="Courier New"><b>Consumer</b> Indication Consumer class |
|
header</font></li> |
<li><font face="Courier New"><b>ControlProviders</b> Implementation of Pegasus internal providers | <li><font face="Courier New"><b>ControlProviders</b> Implementation of Pegasus internal providers |
</font></li> | </font></li> |
<li><font face="Courier New"><b>ExportClient</b> TBD |
<li><font face="Courier New"><b>ExportClient</b> Client connect code |
</font></li> |
for export of indications</font></li> |
<li><font face="Courier New"><b>ExportServer</b> TBD |
<li><font face="Courier New"><b>ExportServer</b> Server code for |
</font></li> |
import of indications</font></li> |
<li><font face="Courier New"><b>Handler</b> TBD </font></li> |
<li><font face="Courier New"><b>Handler</b> Indication handlers. Today |
<li><font face="Courier New"><b>HandlerService</b> TBD |
this includes cimxml, SNMP and email handlers</font></li> |
</font></li> |
<li><font face="Courier New"><b>HandlerService</b> Common code for |
<li><font face="Courier New"><b>IndicationService</b> TBD |
indication handler service</font></li> |
</font></li> |
<li><font face="Courier New"><b>IndicationService</b> Common service |
<li><font face="Courier New"><b>Listener</b> TBD </font></li> |
functions for indication subscription processing</font></li> |
|
<li><font face="Courier New"><b>Listener</b> Common code that allows |
|
CIM Listeners to be created and connected.</font></li> |
<li><font face="Courier New"><b>Protocol</b> Pegasus Client HTTP/XML Protocol Modules | <li><font face="Courier New"><b>Protocol</b> Pegasus Client HTTP/XML Protocol Modules |
depends </font></li> | depends </font></li> |
<li><font face="Courier New"><b>Provider</b> Pegasus Provider interface functions | <li><font face="Courier New"><b>Provider</b> Pegasus Provider interface functions |
|
|
</li> | </li> |
</ul> | </ul> |
</li> | </li> |
<li><font face="Courier New"><b>Security</b> TBD </font></li> |
<li><font face="Courier New"><b>Security</b> Authentication and user |
|
support functions.</font></li> |
<li><font face="Courier New"><b>Server</b> Pegasus Server Modules | <li><font face="Courier New"><b>Server</b> Pegasus Server Modules |
</font></li> | </font></li> |
<li><font face="Courier New"><b>WQL</b> TBD |
<li><font face="Courier New"><b>WQL</b> the WQL query language |
</font></li> |
interpreter.</font></li> |
</ul> | </ul> |
</li> | </li> |
</ul> | </ul> |
|
|
<li><font face="Courier New"><b>Providers</b> Pegasus test and required providers | <li><font face="Courier New"><b>Providers</b> Pegasus test and required providers |
</font> | </font> |
<ul> | <ul> |
<li><font face="Courier New"><b>generic</b> TBD this and following IndicationConsumer |
<li><font face="Courier New"><b>generic</b> A number of |
|
cross-platform providers |
</font></li> | </font></li> |
<li><font face="Courier New"><b>Linux</b> </font></li> |
<li><font face="Courier New">IndicationConsumer - Provider that |
|
consumes indications</font></li> |
|
<li><font face="Courier New"><b>Linux</b> - A number of linux |
|
providers</font></li> |
<li><font face="Courier New"><b>ManagedSystem</b> Providers | <li><font face="Courier New"><b>ManagedSystem</b> Providers |
associated with managing the Pegasus System</font></li> | associated with managing the Pegasus System</font></li> |
<li><font face="Courier New"><b>slp</b> - </font></li> |
<li><font face="Courier New"><b>slp</b> - Provider for slp |
|
service agent support</font></li> |
<li><font face="Courier New"><b>statistic</b> - Providers for | <li><font face="Courier New"><b>statistic</b> - Providers for |
Pegasus statistics.</font></li> | Pegasus statistics.</font></li> |
<li><font face="Courier New"><b>sample</b> Sample providers for the | <li><font face="Courier New"><b>sample</b> Sample providers for the |
|
|
</li> | </li> |
<li><font face="Courier New"><b>Server</b> Pegasus executable build | <li><font face="Courier New"><b>Server</b> Pegasus executable build |
</font></li> | </font></li> |
<li><font face="Courier New"><b>slp</b> - TBD</font></li> |
<li><font face="Courier New"><b>slp</b> - </font></li> |
<li><font face="Courier New"><b>Standard Includes</b> - TBD</font></li> |
<li><font face="Courier New"><b>Standard Includes</b> - </font></li> |
<li><font face="Courier New"><b>test</b> - Directory of end-end | <li><font face="Courier New"><b>test</b> - Directory of end-end |
tests that are regularly conducted on Pegasus</font></li> | tests that are regularly conducted on Pegasus</font></li> |
<li><font face="Courier New"><b>tools</b> MU and other utilities written for Pegasus support | <li><font face="Courier New"><b>tools</b> MU and other utilities written for Pegasus support |
</font></li> | </font></li> |
<li><font face="Courier New"><b>Unsupported</b> Code that is made available but is not supported or included | <li><font face="Courier New"><b>Unsupported</b> Code that is made available but is not supported or included |
in the normal make. </font></li> | in the normal make. </font></li> |
<li><font face="Courier New"><b>WMIMapper</b> Pegasus implementation that implements mapping to Microsoft |
<li><font face="Courier New"><b>WMIMapper</b> Pegasus implementation that |
WMI objects. |
provides mapping to Microsoft WMI objects. |
| |
</font></li> | </font></li> |
</ul> | </ul> |
|
|
<h1> | <h1> |
<a name="Pegasus Installation">Pegasus Installation</a> </h1> | <a name="Pegasus Installation">Pegasus Installation</a> </h1> |
<p> | <p> |
Pegasus today is provided only as a source distribution. |
Pegasus today is provided only as a source distribution. Note that there |
<p> |
is code for a Linux RPM distribution but the project is not yet releasing |
|
binaies.<p> |
To install Pegasus, you must check it out using CVS (Common Version System) | To install Pegasus, you must check it out using CVS (Common Version System) |
or download a snapshot. You download, compile, and use it. | or download a snapshot. You download, compile, and use it. |
<p> | <p> |
|
|
(e.g., set it to $HOME/pegasus_home). Then the output will go into | (e.g., set it to $HOME/pegasus_home). Then the output will go into |
$HOME/pegasus_home/bin and $HOME/pegasus_home/lib | $HOME/pegasus_home/bin and $HOME/pegasus_home/lib |
</li> | </li> |
<li><b>PEGASUS_PLATFORM</b> - this must be set to a supported platform identifier. |
<li><b>PEGASUS_PLATFORM</b> - this must be set to a supported |
</li> |
platform identifier.</li> |
</ul> | </ul> |
<blockquote> | <blockquote> |
<p> | <p> |
|
|
For example (Linux on IA32 platform using the GNU Compiler): | For example (Linux on IA32 platform using the GNU Compiler): |
LINUX_IX86_GNU | LINUX_IX86_GNU |
<p> | <p> |
For a complete list of platforms supported and platform support keywords, refer to the platform_ make files found in directory |
For a complete list of platforms supported and platform support keywords, refer to the platform make files found in directory |
<font face="Courier New">pegasus/mak</font> | <font face="Courier New">pegasus/mak</font> |
| |
</blockquote> | </blockquote> |
|
|
Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only). | Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only). |
For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib | For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib |
<p> | <p> |
4. Change to the root of the Pegasus distrubution and type "make" |
4. Change to the root of the Pegasus distribution and type "make" |
(where make refers to GNU make). | (where make refers to GNU make). |
<p> | <p> |
5. Then create the repository, which is needed to serve data. | 5. Then create the repository, which is needed to serve data. |
|
|
any WEB browser and that uses a WEB browser, CGI scripts and HTML pages for | any WEB browser and that uses a WEB browser, CGI scripts and HTML pages for |
the formatting and connections. It requires a WEB server, etc. The | the formatting and connections. It requires a WEB server, etc. The |
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> | 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> |
ATTN: This section needs to be completed. It should reference the more |
ATTN: This section needs to be completed. It should reference the more complete |
complete documentation |
documentation.<h1><a name="Commands">Commands</a></h1><p> |
ATTN: Write about providers? <h1><a name="Commands">Commands</a></h1><p> |
|
The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on | The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on |
CVS) <p> | CVS) <p> |
To see simple help for each of the commands, use the "-h" flag. <blockquote><pre>Examples: | To see simple help for each of the commands, use the "-h" flag. <blockquote><pre>Examples: |
|
|
bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type) | bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type) |
</pre> | </pre> |
</blockquote><h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1><p> | </blockquote><h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1><p> |
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 |
Please follow section <a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a> before embarking on this endeavour. |
directory. <blockquote><pre>CN="Common Name" |
<br><br> |
|
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 directory. |
|
|
|
<blockquote><pre>CN="Common Name" |
EMAIL="test@email.address" | EMAIL="test@email.address" |
HOSTNAME=`uname -n` | HOSTNAME=`uname -n` |
sed -e "s/$CN/$HOSTNAME/" \ | sed -e "s/$CN/$HOSTNAME/" \ |
|
|
cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem | cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem |
rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem | rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem |
cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem | cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem |
|
|
|
</pre></blockquote> |
|
<h1><a name="Configuring SSL">Configuring Pegasus to use SSL</a></h1><p> |
|
|
|
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> |
|
before embarking on this endeavour.<br><br> |
|
|
|
To configure Pegasus to take advantage of SSL, configure |
|
cimserver_planned.conf to have: |
|
<blockquote><pre> |
|
sslTrustFilePath=client.pem |
|
sslCertificateFilePath=server.pem |
|
sslKeyFilePath=file.pem |
|
httpsPort=5989 |
|
enableHttpsConnection=true |
|
</pre></blockquote> |
|
(The client.pem and server.pem are the certifications |
|
files created per the steps in the earlier section). |
|
|
|
For good riddance you might consider closing down |
|
the cleartext 5988 port. Modify your cimserver_planned.conf |
|
to include: |
|
<blockquote><pre> |
|
enableHttpConnection=false |
</pre></blockquote><h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1><p> | </pre></blockquote><h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1><p> |
ICU (International Components for Unicode) refers to the set of libraries that | ICU (International Components for Unicode) refers to the set of libraries that |
Pegasus uses to run globalized. For example: these libraries are used to | Pegasus uses to run globalized. For example: these libraries are used to |
|
|
using ICU resource bundles. <h1><a name="Pegasus Documentation">Pegasus Documentation</a></h1><p> | using ICU resource bundles. <h1><a name="Pegasus Documentation">Pegasus Documentation</a></h1><p> |
The documentation is currently in preparation. Much of Pegasus is | The documentation is currently in preparation. Much of Pegasus is |
documented in the PEGASUS PEPs which are the basis for approval of Pegasus | documented in the PEGASUS PEPs which are the basis for approval of Pegasus |
functioanlity, changes, plans, etc. These documents are openly available |
functionality, changes, plans, etc. These documents are openly available |
on the PEGASUS web site. The preliminary documentation | on the PEGASUS web site. The preliminary documentation |
is not provided with this release. The current documentation is maintained both as a manual created | is not provided with this release. The current documentation is maintained both as a manual created |
under the tool DOC++ in the runtime subdirectory manual/html (see doc/devManual | under the tool DOC++ in the runtime subdirectory manual/html (see doc/devManual |