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.2.8.4 and 1.3

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

version 1.3, 2004/03/09 21:38:27

Line 13

PEP #: 103

Title: OpenPegasus Version 2.3

Release Readme file

Version: 1.2

Version: 1.0

Created: 12 November 2003

Authors: Karl Schopmeyer, Konrad Rzeszutek

Authors: Karl Schopmeyer

Status:  draft

Version History:

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

Line 34

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

Line 65

Line 59

STATUS: Revised April 2004 for  Pegasus release version 2.3.2

STATUS: Revised November 2003 for  Pegasus release version 2.3.0

Table of Contents

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

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

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

Line 111

Line 105

<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 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 137

Line 126

OpenPegasus (also referred to as Pegasus):

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

Pegasus is an open-source CIM Server for DMTF CIM objects. It is written

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

Line 162

Line 150

<ul>

<li>What's new for this release - See the PEPs (Pegasus Enhancement Procedures)

release notes on the Pegasus web site and duplicated in the source top level

directory.<li>What's Broken and what was fixed - BUGS - See the ReleaseNotes for

directory<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and

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

the web site as a Pegasus PEP.</ul>

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

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

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

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

in the CVS for each release.

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

<tr>

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

Line 191

Line 177

</tr>

<tr>

</tr>

</table>

Line 244

Line 226

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

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

</li>

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 efficiency. It is expected that they will be replaced

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

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

with other implementations of the respository 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

Line 269

Line 248

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 Managers - Pegasus incorporates the concept of pluggable

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

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 CMPI Provider Interface Library - Interfaces for building

Pegasus providers using the CMPI defined C interfaces.

</li>

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

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

including providers for test and demonstration.

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

</li>

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

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

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

components to extend Pegasus capabilites.

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

</li>

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

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

including configuration information, the DMTF interop classes ( Including

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

namespace management). 

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

</li>

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

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

</li>

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

</ul>

production.

<h1>

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

Line 360

Line 315

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

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

packages and tools. Currently Pegasus has the following dependencies:

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

Line 531

Line 486

</li>

<li>Server Pegasus executable build

</li>

<li>slp - SLP agent libraries and

test tools.</li>

<li>Standard Includes - </li>

<li>test - Directory of end-end

tests that are regularly conducted on Pegasus</li>

Line 569

Line 523

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>

Line 774

Line 728

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

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

registration classes that represent the porvider 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 876

Line 830

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

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>

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

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

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

documentation.<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 943

Line 875

before embarking on this endeavour.

To configure Pegasus to take advantage of SSL, configure

CIMServer to have the following configuration options set to:

cimserver_planned.conf to have:

<blockquote><pre> sslTrustFilePath=client.pem

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

the cleartext 5988 port. Modify your cimserver_planned.conf

to include:

<blockquote><pre> enableHttpConnection=false

</pre></blockquote>

enableHttpConnection=false

using cimconfig.

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

<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

Legend:

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

No CVS admin address has been configured