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.6 and 1.11.2.2

version 1.6, 2004/05/13 14:39:29

version 1.11.2.2, 2006/03/28 20:36:25

Line 1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

<head>

content="text/html; charset=windows-1252">

<title>OpenPegasus</title>

</head>

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 103

PEP #: 251

Title: OpenPegasus

Version 2.3 Release Readme file

Release 2.5.1 Readme file

Version: 1.1

Created: 12

Version:

November 2003

1.

Authors: Karl

Schopmeyer, Konrad Rzeszutek

Created: 20th March 2006

Status: draft

Authors: Martin Kirk

Status:  Draft

Version History:

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

bordercolorlight="#CCCCCC" width="100%" style="font-family: Arial;">

<tbody>

<tr>

<th bgcolor="#cae6ca">Version</th>

Line 30

Line 37

</tr>

<tr>

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

<td align="center">March 20th 2006</td>

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

<td align="center">Martin Kirk</td>

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

<td>First draft, basically unchanged from 2.5 ReadMe except for version

numbers and typos</td>

</tr>

<tr>

<td style="vertical-align: top; text-align: center;">March 23rd 2006</td>

<td style="vertical-align: top; text-align: center;">Martin Kirk</td>

Draft for ballot incorporating draft 1.0

comments.</td>

</tr>

<tr>

<td style="vertical-align: top;" align="center">March 26th 2006</td>

<td style="vertical-align: top;" align="center">Martin Kirk</td>

<td style="vertical-align: top;">Draft for Steering Committee approval.</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>

</tr>

</tbody>

</table>

<hr>

Abstract: Installation, build, operation information on the

Abstract:  Installation, build, operation information on

Pegasus Platform Version 2.3 Release. Note that if this readme conflicts

the OpenPegasus Version 2.5.1 Release. Note that if this readme

with the documentation in the release notes or interface definition

conflicts with the documentation in the release notes or interface

documents for a particular release, those documents should be

definition documents for a particular release, those documents should

considered authorative. This is a simplified overview to act as an

be considered authoritative. This is a simplified overview to act as an

introduction to Pegasus.

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

Services Broker for the DMTF CIM/WBEM Standards

Services Broker for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

DMTF CIM objects written in C++ and supported by The Open Group

DMTF CIM objects written in C++

STATUS: Revised November 2003 for Pegasus

and hosted by The Open Group

release version 2.3.0

Table of Contents

STATUS: Revised March 2006 for  Pegasus release version

<a

2.5.1 

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

- Draft

<a

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

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

<a

href="#Pegasus%20Major%20Components">Pegasus Major Components</a>

<a href="#peg_sup_plat">Pegasus Supported Platforms</a>

<a

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

href="#Pegasus%20Supported%20Platforms">Pegasus Supported Platforms</a>

<a href="#docs">Documentation</a>

<a

<a href="#part">How to Participate</a>

href="#Pegasus%20Dependencies">Pegasus Dependencies </a>

</blockquote>

<a

<a href="#inst_peg">Installing Pegasus</a>

href="#The%20Pegasus%20Directory%20Structure">The Pegasus Directory

Structure</a>

Obtain Pegasus in Source Code or Binary Executable Format</a>

<a

<a href="#peg_dep">Verify Dependencies</a>

href="#Pegasus%20Installation">Installation</a>

<a href="#set_envt_var">Set the environment variables</a></blockquote>

<a

<a href="#build_peg">Building Pegasus</a><blockquote style="margin-top: 0pt; margin-bottom: 0pt;">

href="#Building%20Pegasus">Building Pegasus </a>

<a href="#note_bld_peg_lnx">Building Pegasus on Linux</a>

<a

<a href="#note_bld_peg_ssl">Building Pegasus with SSL</a>

href="#Populate%20the%20Repository">Populate the Repository</a>

<a href="#bld_peg_win">Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a>

<a

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a href="#mu_utility">The MU Utility</a>

href="#Registering%20Providers%20in%20the%20Pegasus%20Environment">Registering

</blockquote>

Providers</a>

</blockquote>

<a

<a href="#pop_peg_rep">Populate the Pegasus repository</a>

href="#The%20MU%20Utility">The MU Utility</a>

<a href="#reg_prov">Register providers in the Pegasus environment</a>

<a

<a href="#test">Test the Pegasus installation</a>

href="#Notes%20about%20Building%20Pegasus%20on%20Linux">Notes about

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a href="#test_icu">Testing with ICU enabled</a></blockquote>

Building Pegasus on Linux</a>

<a href="#sec0">Security Considerations</a>

<a

<hr>

href="#Notes%20about%20Building%20Pegasus%20on%20Mac%20OS%20X/Darwin">Notes

about Building Pegasus on Mac OS X/Darwin</a>

<a

href="#Notes%20about%20Building%20Pegasus%20with%20SSL">Notes on

building Pegasus with SSL</a>

<a

href="#Building%20Pegasus%20on%20Windows%202000%20or%20Windows%20XP%20With%20Microsoft%20Visual%20C++">Building

Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a>

<a

href="#Installing%20the%20Pegasus%20HTML%20Test%20Client">Installing

the Pegasus HTML Test Client </a>

<a

href="#Development%20with%20Pegasus%20and%20Pegasus%20Tools">Development

with Pegasus and Pegasus Tools</a>

<a

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

<a

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

<a

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

<a

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

<a

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

<a

href="#Pegasus%20Documentation">Documentation</a>

<a

href="#Participate%21">Participate</a>

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

OpenPegasus (also referred to as Pegasus): Pegasus is an

OpenPegasus (also referred to as Pegasus):

open-source CIM Server for DMTF CIM objects. It is written in C++ and

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

includes the Object manager (CIMOM), a set of defined interfaces, an

written

implemenation of the CIMOperations over HTTP operations and their cimxml

in C++ and includes the Object manager (CIMOM), a set of defined

HTTP encodings, and Interface libraries for both client and providers.

interfaces, an implementation of the CIMOperations over HTTP operations

It is maintained consistent with the DMTF CIM and WBEM specifications

and their cimxml HTTP encodings, and Interface libraries

except for exceptions noted in the documentation.

for both client and providers. It is maintained

Pegasus is open source and is covered under the MIT open-source

consistent with the DMTF CIM and WBEM specifications except for 

license.

exceptions

Pegasus is being developed and maintained under the auspices of The

noted in the documentation.

Open Group. Pegasus is maintained under the license defined in the doc

directory (LICENSE) of this release. This licensing is intended to

OpenPegasus includes components for:

support as wide a distribution as possible with minimal demands on the

<ol>

users.

<li>DMTF compliant CIMServer that processes CIM operations, CIM

More information on this project, access to the CVS, and

Indications, and

documentation on Pegasus are available from the OpenGroup WEB site.

includes class and instance repositories and interfaces for creating

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

CIM

There are a number of separate documents representing the status and

Providers and CIM Clients.</li>

each release of Pegasus

<li>Provider interfaces so that providers may be developed in multiple

<ul>

languages (i.e.

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

C++, C, Java).</li>

Procedures) release notes on the Pegasus web site and duplicated in

<li>A number of CIM clients and providers for basic instrumentation.</li>

the source top level directory</li>

<li>A number of CIM server administration commands.</li>

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

<li>A MOF compiler.</li>

the CVS and the web site as a Pegasus PEP.</li>

<li>A number of sample CIM clients and providers to provide usage examples,</li>

</ul>

<li>CIM server test functions providing both unit tests and end-to-end

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

system tests.</li>

documents and in the CVS for each release.

<li>More complete information on the exact functions

and their functional state is available from the release notes for each

<tbody>

OpenPegasus release.</li>

<tr>

</ol>

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

OpenPegasus is open source and is covered under the MIT open-source

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

license.

</tr>

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

<tr>

Group.  OpenPegasus is maintained under the license defined in pegasus/doc/license.txt.

This licensing is intended to support as

wide a

</tr>

distribution as possible with minimal demands on the users.

<tr>

More information on this project, access to the CVS, and

documentation on

</tr>

Pegasus are available from the OpenGroup WEB site -     <a target="blank" href="http://www.openpegasus.org/">http://www.openpegasus.org</a>

<tr>

<h4><a name="peg_sup_plat">Pegasus Supported Platforms</a></h4>

Pegasus is regularly tested against a variety of platforms by the

</tr>

development group.  The results of the nightly tests can be found

<tr>

here: <a href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly

test status</a> .  The Release notes provides additional details

regarding the platforms. 

</tr>

PEP 249 is the Release Notes PEP for 2.5.1.

</tbody>

</table>

<h4><a name="cmnd">Commands</a></h4>

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

The manpages for each of the commands can be found in the Pegasus source

Pegasus is distributed as open source under the MIT open-source

tree in the pegasus/rpm/manLinux/ directory.

license. The distribution is available via CVS and snapshot images in

To see simple help for a command, invoke it with the "--help" option.

tar and zip file formats on the web site. The source code from CVS can

Here is a list of useful

be found at the following Open Group CVS server;

commands:

cvs.opengroup.org:/cvs/MSB

Some of

using the password authenticating server option (pserve).

the basic commands:

Anonymous access for read is with the name and password "anon" as

follows:

NOTE: Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf

for

<font

more information about administering the Pegasus CIMServer.

face="Courier New">%export

<ul>

CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB

<li>cimserver daemon=true  (Start the server

<font

cimserver)</li>

face="Courier New">%cvs login

<li>cimserver -s  (Shuts down the cimserver)</li>

</blockquote>

<li>cimserver traceLevel=4 traceComponents=ALL  (Starts server

When requested, enter the password "anon". The source tree is in the

with

directory pegasus. To check out the complete Pegasus source tree just

config flags)</li>

type:

<li>cimprovider -l -s  (Lists providers and their status)</li>

cvs co pegasus

<li>cimprovider -e -m OperatingSystemModule  (Enables the

A Pegasus directory will be created under the current directory and

OperatingSystem provider)</li>

populated with the complete source tree and documentation. To get the

<li>cimuser -a -u guest -w <ThePassword> (Adds the user guest with specified password)

latest updates after a checkout just type this from Pegasus root:

</li>

cvs update -d

<li>cimuser -l  (Lists the users )

Active contributors to Pegasus have write access to the CVS

</li>

repository. If you are interested in contributing back to the Pegasus

project, (i.e. write (checkin) access to CVS) please request access from

either Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer <a

href="mailto:%28k.schopmeyer@opengroup.org">(k.schopmeyer@opengroup.org</a>).

<h1><a name="Pegasus Major Components">Pegasus Major Components</a></h1>

The major components of Pegasus are:

<ul>

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

providers and clients </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 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 interfacing with Pegasus. </li>

<li>Pegasus Test Clients - Simple test clients being developed

as part of the 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 HTML to allow the entry of Pegasus operations

from a WEB browser as forms 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 C++ interfaces. </li>

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

Pegasus services including providers for test and demonstration. </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>

</ul>

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

Note:  there are some differences between windows and other

Pegasus is regularly tested against a variety of platforms by the

platforms in

development group. The set of platforms and exact set of compilers for

starting the server as a daemon/service. Whereas most supported

any given release is documented in the Release notes for that release

platforms use

(see the CVS source tree root directory or the Pegasus PEP defining the

the configuration option daemon to start the server as a service, on

ReleaseNotes for any particular release).

windows it

Generally Pegasus is supported on the following Platforms and

must be specifically installed as a service (ex. cimserver -install)

Compilers.

and then

started as a service (cimserver -start). The cimserver --help option

<tbody>

explains the

<tr>

exact format of the start and stop options.<h4><a name="docs">Pegasus Documentation</a></h4>

<td width="169" bgcolor="#99ff99">Platform and OS</td>

Much of Pegasus

<td width="556" bgcolor="#99ff99">Compilers</td>

is documented in the PEGASUS PEPs which are the basis for approval of

</tr>

Pegasus functionality, changes, plans, etc.  These documents are

<tr>

openly available on the PEGASUS web site. The current documentation is

maintained both as a manual created

<td width="556">VisualAge C++ Version</td>

under the tool DOC++ in the runtime subdirectory manual/html (see

</tr>

doc/devManual to create), as an api document also creatable from the

<tr>

source tree (see doc/apidoc) and as other miscellaneous documentation

in the doc directory. Also there is a set of release notes. Normally

the release notes for the current release are available in the root

</tr>

source directory of CVS.

<tr>

Note that the Pegasus WEB site at The Open Group will be the source

<td width="169">Linux Itanium</td>

of most

documentation in the future and today is the source of most discussion

</tr>

and

<tr>

design documentation.

<td width="169">Linux IA-32</td>

<h4><a name="part">How to Participate</a></h4>

<td width="556">gcc (versions 2.9x and 3.xx)</td>

Contributors

</tr>

are welcome to participate in the OpenPegasus development effort. Join

<tr>

the mailing list by visiting <a href="http://www.openpegasus.org/">http://www.openpegasus.org</a> and clicking on

<td width="169">Windows 2000</td>

Mailing Lists. Joining the pegasus-l mailing list will provide a login/password

<td width="556">Microsoft Visual C++ Ver 6 and Microsoft .Net

for the website.

compiler Version 7</td>

<h1>

</tr>

<a name="inst_peg">Installing Pegasus</a> </h1>

<tr>

<h4><a name="download">Obtain Pegasus in Source Code or Binary Executable Format</a></h4>

<td width="169">Windows XP</td>

<td width="556">Microsoft Visual C++ Ver. 6 and Microsoft .Net

compiler Version 7</td>

<ol>

</tr>

Pegasus can be obtained via any of the following:

<tr>

<ol>

<td width="169">Mac OS X/Darwin PPC</td>

<li>Released tarballs (see

<td width="556">gcc (version 3.3)</td>

<a href="http://www.openpegasus.org/page.tpl?ggid=392">Release

</tr>

tarballs link</a>)</li>

</tbody>

<li>CVS (See <a href="http://www.openpegasus.org/page.tpl?ggid=667">CVS

</table>

code repository</a> for

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

more information.)</li>

We have worked to minimize the dependence of Pegasus on other

<li>Linux RPMs. See

software packages and tools. Currently Pegasus has the following

(<a href="http://www.openpegasus.org/pr">RPM

dependencies:

link</a> for

more information

)</li>

</ol>

NOTE: Linux RPMs are only available for a limited set of releases.

The distribution is available via CVS and snapshot images in

tar and zip file formats on the web site.

The source code from CVS can be found at the Open Group CVS server -

cvs.opengroup.org. The source can be checked out anonymously using the

instructions at <a href="http://www.openpegasus.org/protected/page.tpl?ggid=667">

http://www.openpegasus.org/page.tpl?ggid=667</a>

CVS

write accounts are managed by Martin Kirk of The Open Group

(<a href="mailto:%28k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>)

RPM installation instructions can be found here: <a href="http://www.openpegasus.org/pr/">http://www.openpegasus.org/pr</a>

<h4><a name="peg_dep">Verify Dependencies</a></h4>

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

packages and tools. Currently Pegasus has the following dependencies:

1. GNUMAKE - To simplify the building of Pegasus across

multiple platforms we have standardized on a set of build tools

multiple platforms we

including: GNUMAKE. We are using GNUMAKE 3.79.1 successfully both in

have standardized on a set of build tools including: GNUMAKE. We are

Windows and Linux environments.

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

GNUMAKE is available from :

NOTE: A set of the required tools for windows platforms is

available on the openpegasus web site.

2. FLEX and BISON - These tools were used to develop the

2. MU.EXE - To minimize the difference between Linux and

MOF

Windows for GNUMAKE, we have created a utility called MU.exe. This

compiler and WQL

utility is required for Pegasus make with ONLY Windows environment. It

parser.  These tools are required only for

is provided as an alternative to requiring a number of UNIX utilities

development of the parsers, not for building Pegasus.

(SH, RM, etc.) on the windows platform and effectively provides the

3. DOC++ - The Pegasus documentation is taken from a

functions of these utilities that GNUMAKE needs. MU is not required on

combination of text files

UNIX or LINUX platforms.

and the Pegasus header files themselves. This documentation is

NOTE: The binary for MU.EXE is not distributed in the Pegasus bin

formatted with DOC++ and GAWK.   These tools are required to build the

directory. You must build it separately. MU source code is part of the

interface documentation set.

distribution in the directory src/utils/MU with its own make file. You

must compile MU before you initiate the Pegausu make.

4. ICU Internationalization libraries - These libraries are

NOTE: A copy of the binary is made available as a zip file on the

used as the basis for message catalogs for message

Pegasus WEB site.

internationalization. See the ICU website

Again, MU is used ONLY if you are using Windows.

(http://oss.software.ibm.com/icu/) for more information on these

3. FLEX and BISON - These tools were used to develop the MOF

libraries

compiler and WQL parser. Anybody intending to recompile the compiler or

5. OpenSSL - If it

parser from scratch will be required to have these tools. They are only

is intended to use SSL on the

required if changes need to be made to the files for parsing and

communication protocol, the OpenSSL libraries are required.

compiling.

4. DLCOMPAT - dlcompat is a dlopen(3) et.al. compatibility

NOTE: A set of the required

library for Mac OS X/Darwin.

tools for windows platforms is available on the openpegasus web

site.  <a href="http://www.openpegasus.org/pp/uploads/40/Pegasus24/www.openpegasus.org">www.openpegasus.org</a>

<h4><a name="set_envt_var">Set the Environment

Variables</a></h4>

Before installing or running OpenPegasus, environment variables may

have to be defined or updated.

PEP 237 contains the list of environment variables and setup necessary

to use OpenPegasus.

At a minimum, the following need to be set:

PEGASUS_ROOT=<location of your pegasus source tree>

NOTE: The dlcompat is not distributed with pegasus

PEGASUS_HOME=<location for the built executables, repository, etc>

source.

dlcomapt is available from :

PEGASUS_PLATFORM=<your platform>

</blockquote>

For a list of valid

platforms, enter "make listplatforms" from the root of the Pegasus

source tree.

<h1><a name="build_peg">Building Pegasus</a></h1>

<div>

To accept the default build options and get started quickly, use the</div>

<div>

following commands from the root of the Pegasus source tree:</div>

<a href="http://www.opendarwin.org/projects/dlcompat/">http://www.opendarwin.org/projects/dlcompat/</a>

<div>

make build</div>

<div>

      This will build the dependencies, any utilities that are needed,

all</div>

<div>

      the Pegasus and test executable code, and do any necessary setup

to</div>

<div>

run the CIM Server.</div>

Again, dlcomapt needs to be installed ONLY if you are using Mac OS

<div>

X/Darwin.

make alltests</div>

5. DOC++ - The Pegasus documentation is taken from a

<div>

combination of text files and the Pegasus header files themselves. This

      This will run the unit tests, create the repository by compiling

documentation is formatted with DOC++ and GAWK. These tools are required

in</div>

if the documentation is to be recreated but we expect that only the

<div>

core team will be recreating documentation.

      the MOF for the default CIM Schema (2.9 for Pegasus 2.5.1),

6. ICU Internationalization libraries - These libraries are

compile</div>

used as the basis for message catalogs for message internationalization.

<div>

See the ICU website (http://oss.software.ibm.com/icu/) for more

in the MOF for all Pegasus test cases, do any other configuration</div>

information on these libraries

<div>

7. OpenSSL - If it is intended to use SSL

      necessary to run the tests, and then run a large automated test

on the communication protocol, the OpenSSL libraries are required.

suite</div>

<h1><a name="The Pegasus Directory Structure">The Pegasus Directory

<div>

Structure</a></h1>

to verify Pegasus CIM Server functionality.` </div>

Pegasus is distributed as a complete source directory structure that

<div>

should be installed either from one of the snapshots or from CVS.

There are many variations possible. Refer to PEP 237 for possible build

This structure is generally as follows:

and</div>

Pegasus Source Structure

<div>

Pegasus Root directory (PEGASUS_ROOT

run-time configuration options. Enter "make usage" for more information

environment variable)

on</div>

<ul>

<div>

<li>cgi Source for the Pegasus WEB

make targets that are available for building and testing Pegasus.</div>

Based Test client

</div>

<ul>

<h4><a name="note_bld_peg_lnx">Building OpenPegasus on Linux </a></h4>

<li>cgi-bin CGI Directories for WEB

demonstration. This directory is normally empty but can be

To build OpenPegasus on Linux, ensure that you you have the environment

populated from the runtime with the make from cgi. </li>

variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For

<li>htdocs HTML Pages for Pegasus WEB

32 bit linux, the definition of PEGASUS_PLATFORM is normally

demonstration </li>

LINUX_IX86_GNU).

</ul>

</li>

<h4><a name="note_bld_peg_ssl">Building OpenPegasus with SSL

<li>doc Miscellaneous Pegasus

</a></h4>

Documents.

<ul>

To build with SSL you need the OpenSSL libraries and header files. They

<li>apidoc - Source for the public api

are NOT distributed with OpenPegasus. Make sure you have them in a

documentation.</li>

standard

<li>DevManual Source and build files for

directory so OpenPegasus can find them. If that's not

developers' manual mak General make files (used by other makes)</li>

the case, set the environment variable OPENSSL_HOME= to point where

</ul>

your OpenSSL

</li>

installation is.

<li>mak - Common make files for

Pegasus compilation</li>

Also have the PEGASUS_HAS_SSL=true variable set. Then just run 'make'

<li>Dummy -</li>

in Pegasus

<li>InterfaceArchive -</li>

directory and you will have OpenPegasus with SSL enabled. See "Creating

<li>rpm - files for rpm installation

SSL

for Linux</li>

certificates" below for more information on how to use SSL.

<li>Schemas - Schemas used in the

installation of Pegasus. This includes currently released versions

Refer to the OpenPegasus SSL Guidelines guide found in the doc directory for details on

of the DMTF schemas in subdirectories (ex. CIM27) and Pegasus local

using OpenPegasus with SSL.

Schemas (ex. </li>

<h4><a name="bld_peg_win">Building OpenPegasus on Windows 2k or Windows XP with Microsoft

<li>src All Pegasus Source Files

Visual

<ul>

C++ </a></h4>

<li>ACEExample Test directrory

with examples of the use of ACE (obsolete). </li>

Use of Windows 2000 SP3 or later is recommended.  OpenPegasus is

<li>Clients Source for various

regularly tested on both Windows 2000 and Windows XP using the

test clients and demonstration clients.</li>

Microsoft compilers.

<li>CGICLIENT Pegasus test client

Today we build OpenPegasus on Windows using a set of make files

that uses a WEB browser JAVA Java Client support modules </li>

contained

<li>Pegasus - Core pegasus

in the source distribution, the Microsoft compilers (DevStudio 5.x is

modules.

not supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE

<ul>

make utility.  Note that you MUST have the OpenPegasus <a href="#mu_utility">mu.exe </a>utility compiled and available

<li>Client Pegasus Client API

before trying to compile OpenPegasus on the normal windows platform.

Tests depends tests </li>

The

<li>Common Pegasus Common

following is the basic setup steps for the environment.

Functions (C++ source and headers tests Test programs for

the common functions</li>

Setup the environment variables and path for the Micrososft Visual C

<li>Compiler Pegasus MOF

compiler.

compiler </li>

Typically this can be done by running the VCVARS32.BAT file supplied

<li>Config Pegasus

with Microsoft Visual C++. (contained in the same directory as cl.exe).

Configuration functions</li>

<li>Consumer Indication

For Windows, try the following for an example environment:

Consumer class header</li>

<li>ControlProviders

Implementation of Pegasus internal providers </li>

<li>ExportClient Client

connect code for export of indications</li>

<li>ExportServer Server code

for import of indications</li>

<li>Handler Indication

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

<li>HandlerService Common code

for indication handler service</li>

<li>IndicationService Common

service 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 </li>

<li>ProviderManager Provider

Manager service that manages providers </li>

<li>ProviderManager2 Pluggable

Provider Manager service. Today this is not enabled by

default It will become the Pegasus standard provider manager

at some time in the future but for now, see the release notes if you

want to enable it.</li>

<li>Repository Pegasus

Repository Interfaces and Simple Repository tests

<ul>

<li>Tests for Repository

Functions </li>

</ul>

</li>

<li>Security Authentication

and user support functions.</li>

<li>Server Pegasus Server

Modules </li>

<li>WQL the WQL query language

interpreter.</li>

</ul>

</li>

</ul>

</li>

<li>Providers Pegasus test and

required providers

<ul>

<li>generic A number of

cross-platform providers </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 major provider types.</li>

<li>testproviders </li>

</ul>

</li>

<li>Server Pegasus executable build </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 provides mapping to Microsoft WMI objects. </li>

</ul>

Pegasus Run Time directory structure

(PEGASUS_HOME environment variable). Home directory for runtime. All

compiler, linker documentation creation, etc. are put here.

<ul>

<li>bin - Destination for executable

and DLL modules from Pegasus build. This directory should be make

public so that the test functions, clients, and cimserver can be

executed with minimum effort.</li>

<li>DevManualHTML - HTML output of the

Pegasus Manual. This is only created when the make file for this

manual is executed (doc/DevManual) and then contains the html

representing the document.</li>

<li>apidochtml - HTML output of the

creation of the public API document. This only exists when the make

file for the api document is executed (see doc/apidoc/Makefile)</li>

<li>lib - Destination for Pegasus LIB

modules </li>

<li>log - Standard location for

Pegasus Logs</li>

<li>obj - Destination for object

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

contains the created repository </li>

</ul>

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

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.

For the snapshot, the installation of Pegasus involves expanding the

snapshot distribution files, building the runtime, the test files and

test clients, and building the repository.

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

1. Check that you have requisite programs (listed in Pegasus

Dependencies). These include GNU Make, MU.EXE (if using Windows), Flex,

and Bison (Flex and Bison only required if changes will be made to the

MOF compiler or WQL parser).

Be sure these are on the path.

2. Define the following three environment variables:

<ul>

<li>PEGASUS_ROOT - this should be the "pegasus" directory

you've pulled from CVS </li>

<li>PEGASUS_HOME - to point to a directory to contain output

binary files (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>

</ul>

This identifier has the following form:

<pre>REM call the standard Microsoft .bat for VC 6 setup. call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat' REM Set debug to something if you want compile in debug mode set PEGASUS_DEBUG=true REM set PEGASUS_ROOT to top of source tree set PEGASUS_ROOT=C:/cimom/pegasus (Note: The '/' characters are intentional and required by the OpenPegasus build system) REM set PEGASUS_HOME to where you want repository and executables set PEGASUS_HOME=%PEGASUS_ROOT% REM setup the path to the runtime files. set path=%path%;%PEGASUS_HOME%\bin </pre>

<Operating-System>_<Architecture>_<Compiler>

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

face="Courier New">pegasus/mak

</blockquote>

Note: if you plan on doing parallel builds, you might consider

<h6>

setting PEGASUS_HOME to something like this:

<a name="mu_utility">The MU Utility </a></h6>

$HOME/pegasus_home_LINUX_IX86_GNU

That way, the output of each build will be placed in its own

In order to provide a consistent build structure across multiple

directory.

platforms, we

3. Now place $PEGASUS_HOME/bin on your path

developed a small utility to provide a consistent set of small

and

utilities

Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only).

across these platforms. The MU utility is a simple utility that

For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib

contains

4. Change to the root of the Pegasus distribution and type "make"

many

(where make refers to GNU make).

commands. For example:

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

repository". Note that to create the additional namespaces, etc. that

represent the test support you can also execute "make testrepository:

C:\> mu rm myfile.cpp yourfile.cpp

6. To test the build type "make tests". The following make targets

are supported:

You may type "mu" to get a list of valid commands. Here are some

<ul>

of them:

<li><default> - Build everything. </li>

<li>clean - Clean out all objects, libs, and executables. </li>

<li>depend - Create the dependencies. </li>

rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare depend

<li>repository - Create the repository in $PEGASUS_HOME/repository </li>

<li>tests - Execute all tests (except client server tests). </li>

The MU utility supports globing (expansion of wildcards) so

<li>rebuild - clean, depend, <default> </li>

you can do things like this:

<li>world - depend, <default> </li>

</ul>

The Pegasus Client server tests are executed separately from the

C:\> mu rm *.obj *.exe

above because they require the initiation of separate process for the

Pegasus server and Pegasus client. To execute these tests please refer

MU is required to build under the Windows environment. MU is

to the scripts in pegasus/mak/BuildMakefile - refer to the prestarttests

available as part

and poststarttests.

of the distribution of OpenPegasus.

For information on particular installation characteristics, tools,

etc. for each platform see the appropriate sections below:

NOTE: The binary for MU.EXE is not distributed in the OpenPegasus bin

Generally the build commands are as follows:

directory.

<ol>

You must build it separately. MU source code is part of the

<li>There is a Makefile in the Pegasus root directory. Simply

distribution

executing make in the Pegasus root directory will make everything.

in the directory src/utils/MU with its own make file. You must compile

"make rebuild" will clean and rebuild everything. The "make rebuild"

will also populate the repository with the current CIM Schemas. </li>

before you initiate the OpenPegasus make.

<li>To test a fresh release, go to the pegasus root and type "<font

A copy of the binary is made available as a zip file on the OpenPegasus

face="Courier New">make world". This will build

WEB site.

dependencies, build binaries, and then run all tests except the

Client/Server tests. </li>

<h1><a name="pop_peg_rep">Populate the Pegasus Repository</a> </h1>

<li>To execute the basic test suite that is shipped with pegasus

type "make tests". This also reinstalls the repository. Running

Before using Pegasus you must populate the repository. Typically, this

"make -s tests" suppresses extraneous output such as the enter/leave

is done during the build process when you run the makefile. However,

directory messages. </li>

you

<li>"make clean" removes all object and library files from the

can also do it manually after the Pegasus has been built.

structure. </li>

<li>A new build system has been added to Pegasus where a new CVS

checkout is done, built, and tests are run. Do it by: "make -f

mak/BuildMakefile cleanbuild" </li>

</ol>

<h1><a name="Populate the Repository">Populating the Pegasus Repository</a> </h1>

Before using Pegasus you must populate the repository.. The makefile

does it all for you, but in case you are wondering what it does or how

to do it manually:

<ol>

<li>Register the MOF (Managed Object Format) file describing the

skeleton of the object. </li>

<li>Register a second MOF which only points out which lib*.so file to

be loaded when a specific object is activated. </li>

</ol>

This is done automatically for the providers included in Pegasus by

doing: make repository.

The 'make repository' in pegasus/Schemas does three things Runs MOF

The providers included with Pegasus are automatically entered into the

compiler (cimmofl) on: -Schema v2.7 Generates the CIM Schema v2.7 in the

repository

repository (skeleton of CIM objects) -PG_InterOp Internal to Pegasus

by running the following command: <tt>make repository</tt>

schema for operating (shutdown, add users, etc) CIM_Indication’s (SNMP,

Events, Alert, Threshold, etc) -PG_ManagedSystem Registers included CIM

Providers (libOSProvider.so, libDNSProvider.so, … ) in Pegasus (which

The 'make repository' in the  pegasus directory does three things:

are located in src/Providers)

For more information about using the MOF compiler, refer to user's

<ul>

manual on the openpegasus.org.

<li> Removes the existing repository if one

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

exists.</li>

Installation</a></h1>

<li>Generates the CIM Schema v2.9 in the repository (skeleton of CIM

Pegasus includes an extensive set of test facilities as part of the

objects).  </li>

CVS enviromentthat can be executed including:

<li>Loads

schema for CIM Server functions (shutdown, add users, etc) and

CIM indications

(SNMP, Events, Alert, Threshold, etc)

internal to the Pegasus. </li>

<li>Registers included CIM Providers (libOSProvider.so,

libDNSProvider.so, … ) in Pegasus (which are located in

src/Providers)  </li>

</ul>

<h1>

<a name="reg_prov">Registering

Providers in the Pegasus Environment</a></h1>

Pegasus registers providers with a set of provider registration

classes, not using the provider qualifier as is done in most DMTF CIM

CIMOM implementations today. This set of classes is close to but not

exactly the same as the experimental DMTF definition (See the DMTF

Interop

schema, experimental versions starting with 2.6). This will be

harmonized in the future when the DMTF scheme is moved to final

status.

Registration

is performed by creating instances of the

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 implementations that do work with

OpenPegasus

today.

<h1>

<a name="test">Testing an OpenPegasus Installation</a></h1>

OpenPegasus includes an extensive set of test facilities as part of the

CVS

environment, including:

<ul>

<li>Test Clients - There are several clients that have been

built specifically to test Pegasus or parts of Pegasus including

built specifically to test OpenPegasus, or parts of OpenPegasus,

TestClient, Client, CLI, ipinfo, osinfo, WbemEsec, etc. See the

including

src/Clients directory for more information. These programs require a

TestClient, Client, CLI, ipinfo, osinfo, wbemexec, etc. See the

server complete with repository to be running. Note that some of these

pegasus/src/Clients directory for more information. These programs require a

tests use classes and instances that are only installed with the

server complete with repository to be running.  Note that some of

these tests use classes and instances that are only installed with the

"make testrepository" functions including test namespaces and extra

classes and instances in those namespaces and additional providers

classes and instances in those namespaces and additional providers from

from the providers/sample and proviers/testproviders directories.</li>

the pegasus/Providers/sample and pegasus/Providers/TestProviders directories. </li>

<li>Sample and test providers - Test providers exist for the

<li>Sample and test providers -  Test providers exist for

major provider types in the providers/sample directories and the

the major provider types in the pegasus/Providers/sample directories and the

providers/testProviders directory</li>

pegasus/Providers/TestProviders directory </li>

<li>Unit Tests - Most Pegasus functions include unit tests for

<li>Unit Tests - Most OpenPegasus functions include unit tests

the functions. These are normally executed with the "make tests"

for

the functions.  These are normally executed with the "make tests"

command which can be executed at many different levels of the source

tree from the top level to execute all of the unit tests to

tree from the top level to execute all of the unit tests to individual

individual directories. Usually the unit test functions can be found in

directories.  Usually the unit test functions can be found in test

test directories immediately below their corresponding source code

directories immediately below their corresponding source code

(i.e common/tests is the unit test functions for the common

(i.e  common/tests is the unit test functions for the common

directory). Unit tests are executed without the server being

operational and normally do not require the existence of a Class

repository.</li>

<li>An end-to-end Test Suite - the directory "test" contains a

set of operations tests that cover the major CIM operations. See

set of operations tests that cover the major CIM operations.  See

the make file TestMakefile in the PEGASUS_ROOT directory to execute

these tests. This set of tests executes an extensive set of fixed

these tests.  This set of tests executes an extensive set of fixed

tests and compares the results against predefined results.</li>

</ul>

<h1><a name="Registering Providers in the Pegasus Environment">Registering

<h4><a name="test_icu">Testing with ICU enabled</a></h4>

Providers in the Pegasus Environment</a></h1>

Pegasus registers providers with a set of provider registration

classes, not using the provider qualifier as is done in most DMTF CIM

CIMOM implementations today. This set of classes is close to but not

exactly the same as the current DMTF definition (See the DMTF Interop

schema, experimental versions starting with 2.6). This will be

harmonized in the future when the DMTF scheme is moved to final status.

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

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 implementations that do work with Pegasus today.

<h1><a name="The MU Utility">The MU Utility </a></h1>

In order to provide a consistent build structure across multiple

platforms, we developed a small utility to provide a consistent set of

small utilities across these platforms. The MU utilityis a simple

utility that contains many commands. For example:

C:\> mu rm myfile.cpp yourfile.cpp

You may type "mu" to get a list of valid commands. Here are some of

them:

rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare

depend

The MU utility supports globing (expansion of wildcards) so you can

do things like this:

C:\> mu rm *.obj *.exe

MU is required to build under the Windows environment. MU is

available as part of the distribution of Pegasus.

<h1><a name="Notes about Building Pegasus on Linux">Notes about

Building Pegasus on Linux </a></h1>

No problem. Just make sure you have the environment variables set

(PEASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the

defintion of PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

<h1><a name="Notes about Building Pegasus on Mac OS X/Darwin">Notes

about Building Pegasus on Mac OS X/Darwin</a><a

name="Notes about Building Pegasus on Linux"> </a></h1>

No problem. Just make sure you have the environment variables set

(PEASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For Mac OS X/Darwin, the

defination of PEGASUS_PLATFORM is

DARWIN_PPC_GNU.

<h1><a name="Notes about Building Pegasus with SSL">Notes about

Building Pegasus with SSL </a></h1>

To build with SSL you need the OpenSSL libraries and header files.

They are NOT distributed with Pegasus. Make sure you have them in a

standard directory so Pegasus can find them. If that's not the case, set

the environment variable OPENSSL_HOME= to point where your OpenSSL

installation is.

Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make'

in Pegasus directory and you will have Pegasus with SSL enabled. See

section "Creating SSL certificates" for more information of how to use

SSL.

<h1><a

name="Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++">Building

Pegasus on Windows 2k or Windows XP with Microsoft Visual C++ </a></h1>

Use of Windows 2000 SP3 or later is recommended. Pegasus is

regularly tested on both Windows 2000 and Windows XP using the Microsoft

compilers.

Today we build Pegasus on Windows using a set of make files

contained in the source distribution, the Microsoft compilers (DevStudio

5.x is not supported, Visual Studio 6.0, SP5 is supported) and the

GNUMAKE make utility. Note that you MUST have the Pegasus <a

href="#The%20MU%20Utility">mu.exe </a>utility compiled and available

before trying to compile Pegasus on the normal windows platform. The

following is the basic setup steps for the environment.

Setup the environment variables and path for the Micrososft Visual C

compiler. Typically this can be done by running the VCVARS32.BAT file

supplied with Microsoft Visual C++. (contained in the same directory as

cl.exe).

For Windows, try the following for an example environment:

<pre>REM call the standard Microsoft .bat for VC 6 setup. call 'C:/Program Files/Microsoft Visual Studio/VC98/Bin/Vcvars32.bat' REM Set debug to something if you want compile in debug mode set PEGASUS_DEBUG=true REM set PEGASUS_ROOT to top of source tree set PEGASUS_ROOT=C:/cimom/pegasus REM set PEGASUS_HOME to where you want repository and executables set PEGASUS_HOME=%PEGASUS_ROOT% REM setup the path to the runtime files. set path=%path%;%PEGASUS_HOME%/bin </pre>

</blockquote>

<h1><a name="Installing the Pegasus HTML Test Client">Installing the

Pegasus HTML Test Client</a></h1>

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>

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