pegasus/Attic/readme.html - diff

Return to readme.html CVS log

Up to [Pegasus] / pegasus / Attic

Diff for /pegasus/Attic/readme.html between version 1.1 and 1.2.8.4

version 1.1, 2003/11/13 16:02:37

version 1.2.8.4, 2004/04/26 17:16:00

Line 13

PEP #: 103

Title: OpenPegasus Version 2.3

Release Readme file

Version: 1.0

Version: 1.2

Created: 12 November 2003

Authors: Karl Schopmeyer

Authors: Karl Schopmeyer, Konrad Rzeszutek

Status:  draft

Version History:

<table border="1" cellspacing="1" bordercolordark="#666666"

Line 29

</tr>

<tr>

<td align="center">12 Novemberl 2003</td>

<td align="center">12 November 2003</td>

<td align="center">Karl Schopmeyer</td>

<td>Update from 2.2 Release notes. Converted to HTML</td>

</tr>

<tr>

<td align="center">March 10 2004</td>

<td align="center">Konrad Rzeszutek</td>

<td>Added sections describing SSL and PAM configuration</td>

</tr>

<tr>

<td align="center">April 2004</td>

<td align="center">Karl Schopmeyer</td>

<td>Update for Pegasus 2.3.2</td>

</tr>

</table>

<hr>

Abstract:  Installation, build, operation information on the

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

simplified overview to act as an introduction to Pegasus.

<hr>

Line 59

Line 65

STATUS: Revised October 2003 for  Pegasus release version 2.3.

STATUS: Revised April 2004 for  Pegasus release version 2.3.2

Table of Contents

<a href="#Overview"> Overview</a>

<a href="#Overview">Overview</a>

<a href="#Availability of Pegasus">Availability of Pegasus</a>

Line 105

Line 111

<a href="#Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a>

<a href="#Client Development">Client Development</a>

<a href="#Provider Development">Provider Development</a>

<a href="#Commands">Commands</a>

<a href="#Creating SSL certifications">Creating SSL certifications</a>.

<a href="#Creating SSL certifications">Creating SSL certifications</a>

<a href="#Configuring SSL">Configuring Pegasus to use SSL</a>

<a href="#Configuring PAM">Configuring Pegasus to use PAM</a>

<a href="#Testing with ICU enabled">Testing with ICU enabled </a>

Line 121

Line 135

<h1><a name="Overview">Overview</a> </h1>

OpenPegasus (also referred to as Pegasus):

OpenPegasus (also referred to as Pegasus):

Pegasus is an open-source object manager (CIMOM) for DMTF CIM objects. It is written

Pegasus is an open-source CIM Server for based on the DMTF CIM/WBEM

in C++ and includes the Object manager, a set of defined interfaces, and

specifications. It is written

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

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for  exceptions

noted in the documentation.

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.

Pegasus is being developed and maintained under the auspices of The Open

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

Line 141

Line 157

Pegasus are available from the OpenGroup WEB site.

<a href="http://www.opengroup.org">http://www.openpegaus.org</a>

There are separate documents

There are a number of separate documents representing the status and each

release of Pegasus

<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 and what was fixed - BUGS - See the ReleaseNotes for

this release in the root directory and the web site as a Pegasus PEP and review

the bugs in the Pegasus bug list maintained in bugzilla on the Pegasus web site.</ul>

The release notes are available on the WEB site as Pegasus PEP documents and

The release notes for each release are available on the WEB site as Pegasus PEP documents and

in the CVS for each release.

in the CVS top level directory for each release. See the release notes PEP 

for a definition of what is new or different for each Pegasus release

<tr>

<td width="42%">Release</td>

<td width="42%">Release</td>

<td width="58%">Release Notes PEP</td>

<td width="58%">Release Notes PEP</td>

</tr>

<tr>

Line 171

Line 191

</tr>

<tr>

</tr>

</table>

<h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1>

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;

Line 220

Line 244

The major components of Pegasus are:

<ul>

<li>Pegasus Server - WBEM/CIM Server with interfaces for providers and clients

<li>Pegasus Server - WBEM/CIM Server with interfaces for providers and clients.

</li>

The Pegasus server handles DMTF CIM Operations, DMTF CIM Indications in

conjunction with providers.  It provides overall management of the server

iteself, the repository and providers that have been registered with the

server.</li>

<li>Pegasus Repositories - Today Pegasus provides a defined class repository

interface and a simple file based class repository. It also includes

an instance repository. Note that these repository were created for

functionality, not efficieny. It is expected that they will be replaced

functionality, not efficiency. It is expected that they will be replaced

with other implementations of the respository function as the need arises.

with other implementations of the repository function as the need arises.

</li>

<li>Pegasus Client Library - Tools for building Pegasus clients based on the Pegasus

C++ interfaces and using the WBEM HTTP/XML protocols or directly

interfacing with Pegasus.

</li>

<li>Pegasus Test Clients - 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>Pegasus HTML Test Client - 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

Line 241

Line 269

and the receipt of the response as WEB pages. This has proven useful as a

test tool and can be used for a wide variety of demonstrations.

</li>

<li>Pegasus Provider Library - Tools for building Pegasus providers using the Pegasus

<li>Pegasus Provider Managers - Pegasus incorporates the concept of pluggable

provider managers allowing multiple provider managers with different provider

interfaces.  Today Pegasus includes the C++ provider interfaces and the

CMPI C provider interface.</li>

<li>Pegasus C++ Provider  Interface Library - Interfaces for building Pegasus providers using the Pegasus

C++ interfaces.

</li>

<li>Pegasus Providers - Providers to illustrate the use of Pegasus services

<li>Pegasus CMPI Provider Interface Library - Interfaces for building

including providers for test and demonstration.

Pegasus providers using the CMPI defined C interfaces.

</li>

<li>Pegasus Control Providers - Common services for use by other Pegasus

components to extend Pegasus capabilites.

</li>

<li>Pegasus MOF Compiler - There  standalone compiler (cimmofl) for MOF files that can be used

to install MOF into the Pegasus schema repository and also to check syntax.

There is also a compiler that operates as a Pegasus client(cimmof)

There is also a tool to extract the MOF from the repository.

</li>

<li>Pegasus Providers - Providers to illustrate the use of Pegasus services

including providers for test and demonstration.  In addition to sample and

test providers, there are a number of operational providers that manage

particular DMTF defined classes such as the CIM_ComputerSystem class.</li>

<li>Pegasus Control Providers - Special providers that require direct

access back to the server for information -- these are considered Pegasus

internal providers.  There are several of this type of provider defined

including configuration information, the DMTF interop classes ( Including

namespace management). 

</li>

<li>Pegasus MOF Compiler - Pegasus includes a compiler (cimmof) that is

used to install MOF into Pegasus. This compiler operates as a Pegasus client

using the running CIM Server to install MOF definitions. This means that MOF

input may be delivered directly to the repository or to providers for classes

which are registered for providers. There is also a standalone compiler (cimmofl)

that writes directly to the repository. WARNING:

The cimmofl compiler should be used with caution because it puts all objects

defined in the MOF directly into the repository bypassing any defined provider

processing. There are several

potential problems with using cimmofl including 1) bypasses any provider

processing to put information directly into the

repository, 2) can cause repository corruption if it is executed simultaneous

with the CIM Server using the repository 3) may

put information into repository that is not available until the CIM Server is

stopped and restarted.</li>

</ul>

We strongly encourage the use of cimmof instead of cimmofl, particularly in

production.

<h1>

<a name="Pegasus Supported Platforms">Pegasus Supported Platforms</a></h1>

Line 308

Line 360

We have worked to minimize the dependence of Pegasus on other software

packages and tools. Currently Pegasus has the following dependencies:

packages and tools. Currently the Pegasus build process has the following dependencies:

1. GNUMAKE - To simplify the building of Pegasus across multiple platforms we

Line 413

Line 465

</li>

<li>Config Pegasus Configuration

functions</li>

<li>Consumer TBD </li>

<li>Consumer Indication Consumer class

header</li>

<li>ControlProviders Implementation of Pegasus internal providers

</li>

<li>ExportClient TBD

<li>ExportClient Client connect code

</li>

for export of indications</li>

<li>ExportServer TBD

<li>ExportServer Server code for

</li>

import of indications</li>

<li>Handler TBD </li>

<li>Handler Indication handlers. Today

<li>HandlerService TBD

this includes cimxml, SNMP and email handlers</li>

</li>

<li>HandlerService Common code for

<li>IndicationService TBD

indication handler service</li>

</li>

<li>IndicationService Common service

<li>Listener TBD </li>

functions for indication subscription processing</li>

<li>Listener Common code that allows

CIM Listeners to be created and connected.</li>

<li>Protocol Pegasus Client HTTP/XML Protocol Modules

depends </li>

<li>Provider Pegasus Provider interface functions

Line 443

Line 498

</li>

</ul>

</li>

<li>Security TBD </li>

<li>Security Authentication and user

support functions.</li>

<li>Server Pegasus Server Modules

</li>

<li>WQL TBD

<li>WQL the WQL query language

</li>

interpreter.</li>

</ul>

</li>

</ul>

Line 455

Line 511

<li>Providers Pegasus test and required providers

<ul>

<li>generic TBD this and following IndicationConsumer

<li>generic A number of

cross-platform providers

</li>

<li>Linux </li>

<li>IndicationConsumer - Provider that

consumes indications</li>

<li>Linux - A number of linux

providers</li>

<li>ManagedSystem Providers

associated with managing the Pegasus System</li>

<li>slp -  Provider for slp

service agent support</li>

<li>statistic - Providers for

Pegasus statistics.</li>

<li>sample Sample providers for the

Line 470

Line 531

</li>

<li>Server Pegasus executable build

</li>

<li>slp - SLP agent libraries and

<li>Standard Includes - TBD</li>

test tools.</li>

<li>Standard Includes - </li>

<li>test - Directory of end-end

tests that are regularly conducted on Pegasus</li>

<li>tools MU and other utilities written for Pegasus support

</li>

<li>Unsupported Code that is made available but is not supported or included

in the normal make. </li>

<li>WMIMapper Pegasus implementation that implements mapping to Microsoft

<li>WMIMapper Pegasus implementation that

WMI objects.

provides mapping to Microsoft WMI objects.

</li>

</ul>

Line 507

Line 569

modules. Note that today, the trace file is located in the

PEGASUS_HOME directory, not in the log directory if Pegasus

internal tracing is enabled.</li>

<li>repository - This Directory

<li>repository - This directory

contains the created repository </li>

</ul>

<h1>

<a name="Pegasus Installation">Pegasus Installation</a> </h1>

Pegasus today is provided only as a source distribution.

Pegasus today is provided only as a source distribution.  Note that there

is code for a Linux RPM distribution but the project is not yet releasing

binaies.

To install Pegasus, you must check it out using CVS (Common Version System)

or download a snapshot. You download, compile, and use it.

Line 546

Line 609

(e.g., set it to $HOME/pegasus_home). Then the output will go into

$HOME/pegasus_home/bin and $HOME/pegasus_home/lib

</li>

<li>PEGASUS_PLATFORM - this must be set to a supported platform identifier.

<li>PEGASUS_PLATFORM - this must be set to a supported

</li>

platform identifier.</li>

</ul>

Line 559

Line 622

For example (Linux on IA32 platform using the GNU Compiler):

LINUX_IX86_GNU

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 

pegasus/mak

</blockquote>

Line 580

Line 643

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

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).

5. Then create the repository, which is needed to serve data.

Line 711

Line 774

Registration is performed by defining a MOF for the instances of the

registration classes that represent the porvider module, providers, classes,

registration classes that represent the provider module, providers, classes,

etc. to be registered.  The easiest way to create a new registration today

is to copy from one of the existing registration MOFs.  See the

providers/sample/load directory for examples of several registration instance

Line 813

Line 876

This is a separate test tool that allows Pegasus requests to be initiated from

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

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>

instructions for setting up this environment are maintained in a separate readme in the

ATTN: This section needs to be completed. It should reference the more

Pegasus CGI directory. <h1><a name="Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a></h1>

complete documentation

ATTN: This section is incomplete today. For more information on

ATTN: Write about providers? <h1><a name="Commands">Commands</a></h1>

developing clients and providers for Pegasus see the Pegasus Workshop

presentations available on the Pegasus web site.<h2>

<a name="Client Development">Client Development</a></h2>

ATTN: Incomplete today.<h2>

<a name="Provider Development">Provider Development</a></h2>

ATTN: Incomplete today.<h3>

Debugging Providers</h3>

To debug providers you should be running the Pegasus CIMServer in a non-forked

mode (not as a daemon or service).  The configuration option 'daemon'

defines such behavior. You can set this by either running cimserver as:

            cimserver

daemon=false

Or use the cimconfig to turn this option on:

cimconfig -s daemon=false -p

When running in production, make sure to turn it back to true.

<h1><a name="Commands">Commands</a></h1>

The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on

CVS)

To see simple help for each of the commands, use the "-h" flag. <blockquote><pre>Examples:

Line 829

Line 913

bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type)

</pre>

</blockquote><h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1>

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"

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"

HOSTNAME=`uname -n`

sed -e "s/$CN/$HOSTNAME/" \

Line 847

Line 935

cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem

rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem

cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem

</pre></blockquote><h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1>

</pre></blockquote>

<h1><a name="Configuring SSL">Configuring Pegasus to use SSL</a></h1>

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.

To configure Pegasus to take advantage of SSL, configure

CIMServer to have the following configuration options set to:

<blockquote><pre> sslTrustFilePath=client.pem

sslCertificateFilePath=server.pem

sslKeyFilePath=file.pem

httpsPort=5989

enableHttpsConnection=true

</pre></blockquote>

using the cimconfig utility:

<blockquote><pre> cimconfig -p -s 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 configuration

to include:

<blockquote><pre> enableHttpConnection=false

</pre></blockquote>

using cimconfig.

<h1><a name="Configuring PAM">Configuring Pegasus to use PAM</a></h1>

In order to use PAM Authentication you have to compile Pegasus

with one extra enviroment flags:

<blockquote><pre> PEGASUS_PAM_AUTHENTICATION=1

</blockquote></pre>

You can also set the PEGASUS_ALWAYS_USE_PAM=1 flag to disable

Pegasus password authentication using a flag text-file (recommended).

After compiling (refer to section <a href="#Building Pegasus">Building Pegasus </a>

for details), follow these two important steps:

<ul>

<ul>a). Copy the rpm/wbem file in-to /etc/pam.d directory.

This notifies PAM what kind of libraries to use when authenticating

Pegasus.</uL>

<ul>

b). Modify CIMServer configuration options:

<blockquote><pre> usePAMAuthentication=true

enableAuthentication=true

</blockquote></pre>

And if you want to allow 'root' to login (*not recommended*)

<blockquote><pre> enableRemotePrivilegedUserAccess=true

</blockquote></pre>

using the cimconfig utility, such as:

<blockquote><pre> cimconfig -p -s usePAMAuthentication=true

</pre></blockquote>

</ul>

The user is authenticated using HTTP Basic method, thererfore it is

strongly suggested you use SSL connection instead of normal HTTP connection.

Refer to section

<a href="#Configuring SSL">Configuring Pegasus to use SSL</a> for more details on creating and using SSL keys.

<h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1>

ICU (International Components for Unicode) refers to the set of libraries that

Pegasus uses to run globalized. For example: these libraries are used to

load messages in different languages, format currency and numbers according to

Line 874

Line 1025

using ICU resource bundles. <h1><a name="Pegasus Documentation">Pegasus Documentation</a></h1>

The documentation is currently in preparation.  Much of Pegasus is

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

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

Legend:

Removed from v.1.1
changed lines
	Added in v.1.2.8.4

No CVS admin address has been configured