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

version 1.5, 2004/03/10 19:24:13

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

Line 1

<html>

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

<head>

<title>OpenPegasus</title>

</head>

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 103

PEP #: 251

Title: OpenPegasus Version 2.3

Release Readme file

Version: 1.1

Title: OpenPegasus

Created: 12 November 2003

Release 2.5.1 Readme file

Authors: Karl Schopmeyer, Konrad Rzeszutek

Status:  draft

Version:

Version History:

1.

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

bordercolorlight="#CCCCCC" width=100%

Created: 20th March 2006

style='font-size=10.0pt;font-family:Arial'>

<tr>

Authors: Martin Kirk

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

<th bgcolor="#CAE6CA">Author</th>

Status:  Draft

<th bgcolor="#CAE6CA">Change Description</th>

Version History:

<tbody>

<tr>

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

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

<th bgcolor="#cae6ca">Change Description</th>

</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 align="center">March 10 2004</td>

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

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

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

<td>Added sections describing SSL and PAM configuration</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>

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

OpenPegasus - A Manageability 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

STATUS: Revised November 2003 for  Pegasus release version 2.3.0

Table of Contents

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

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

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

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

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

<a href="#The Pegasus Directory Structure">The Pegasus Directory Structure</a>

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

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

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

<a href="#Registering Providers in the Pegasus Environment">Registering

Providers</a>

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

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

<a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a>

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

<a href="#Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client

</a>

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

<a href="#Commands">Commands</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>

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

<a href="#Participate!">Participate</a>

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

OpenPegasus (also referred to as Pegasus):

Pegasus is an open-source CIM Server for DMTF CIM objects. 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 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

distribution as possible with minimal demands on the users.

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

Pegasus are available from the OpenGroup WEB site.

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

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

release of Pegasus

<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 - BUGS - See the ReleaseNotes for this release in the CVS and

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

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

in the CVS for each release.

<tr>

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

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

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

<tr>

</tr>

</tbody>

</table>

<hr>

Abstract:  Installation, build, operation information on

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

the OpenPegasus Version 2.5.1 Release. Note that if this readme

conflicts with the documentation in the release notes or interface

Pegasus is distributed as open source under the MIT open-source license. The distribution is available via

definition documents for a particular release, those documents should

CVS and snapshot images in tar and zip file formats on the web site.

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

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

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

cvs.opengroup.org:/cvs/MSB

Services Broker for the DMTF CIM/WBEM Standards

using the password authenticating server option (pserve).

Tagline: OpenPegasus is an object manager for

DMTF CIM objects written in C++

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

and hosted by The Open Group

STATUS: Revised March 2006 for  Pegasus release version

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

2.5.1 

- Draft

%cvs login

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

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

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

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

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

</blockquote>

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

When requested, enter the password "anon".

The source tree is in the directory pegasus. To check out the complete Pegasus

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

source tree just type:

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

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

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

cvs co pegasus

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

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

A Pegasus directory will be created under the current directory and populated

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

with the complete source tree and documentation. To get the latest updates

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

after a checkout just type this from Pegasus root:

cvs update -d

Active contributors to Pegasus have write access to the CVS 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:(k.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>

Pegasus is regularly tested against a variety of platforms by the development

group.  The set of platforms and exact set of compilers for any given

release is documented in the Release notes for that release (see the CVS source

tree root directory or the Pegasus PEP defining the ReleaseNotes for any

particular release).

Generally Pegasus is supported on the following Platforms and Compilers.

<tr>

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

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

</tr>

<tr>

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

</tr>

<tr>

</tr>

<tr>

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

</tr>

<tr>

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

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

</tr>

<tr>

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

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

Version 7</td>

</tr>

<tr>

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

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

Version 7</td>

</tr>

</table>

<h1>

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

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 including: GNUMAKE. We are 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. MU.EXE - To minimize the difference between Linux and Windows for GNUMAKE,

we have created a utility called MU.exe. This utility is required for

Pegasus make with ONLY Windows environment. It is provided as an alternative to

requiring a number of UNIX utilities (SH, RM, etc.) on the windows platform

and effectively provides the functions of these utilities that GNUMAKE

needs. MU is not required on UNIX or LINUX platforms.

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

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

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

before you initiate the Pegausu make.

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

WEB site.

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

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

parser. Anybody intending to recompile the compiler or parser from scratch

will be required to have these tools. They are only required if changes need

to be made to the files for parsing and compiling.

4. DOC++ - The Pegasus documentation is taken from a combination of text files

and the Pegasus header files themselves. This documentation is formatted

with DOC++ and GAWK. These tools are required if the documentation is to

be recreated but we expect that only the core team will be recreating

documentation.

5. ICU Internationalization libraries - These libraries are used as

the basis for message catalogs for message internationalization. See the ICU

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

libraries6. OpenSSL - If it is intended to use SSL on the

communication protocol, the OpenSSL libraries are required.<h1>

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

Pegasus is distributed as a complete source directory structure that should be

installed either from one of the snapshots or from CVS.

This structure is generally as follows:

Pegasus Source Structure

Pegasus Root directory (PEGASUS_ROOT environment

variable)<ul>

<li>cgi Source for the Pegasus WEB Based Test client

<ul>

<li>cgi-bin CGI Directories for WEB demonstration.

This directory is normally empty but can

be populated from the runtime with the make

from cgi.

</li>

<li>htdocs HTML Pages for Pegasus WEB demonstration

</li>

</ul>

</li>

<li>doc Miscellaneous Pegasus Documents.

<ul>

<li>apidoc - Source for the public api

documentation.</li>

<li>DevManual Source and build files for developers' manual

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

</ul>

</li>

<li>mak - Common make files for Pegasus

compilation</li>

<li>Dummy -</li>

<li>InterfaceArchive -</li>

<li>rpm - files for rpm installation for Linux</li>

<li>Schemas - Schemas used in the installation

of Pegasus. This includes currently released versions of the DMTF schemas in

subdirectories (ex. CIM27) and Pegasus local Schemas (ex. </li>

<li>src All Pegasus Source Files

<ul>

<li>ACEExample Test directrory with examples of the use of ACE (obsolete).

</li>

<li>Clients Source for various test

clients and demonstration clients.</li>

<li>CGICLIENT Pegasus test client that uses a WEB browser

JAVA Java Client support modules

</li>

<li>Pegasus - Core pegasus modules.

<ul>

<li>Client Pegasus Client API Tests

depends tests </li>

<li>Common Pegasus Common Functions (C++ source and headers

tests Test programs for the common functions</li>

<li>Compiler Pegasus MOF compiler

</li>

<li>Config Pegasus Configuration

functions</li>

<li>Consumer Indication 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:

<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 

pegasus/mak

</blockquote>

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

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

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

PEGASUS_HOME to something like this:

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

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

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

$HOME/pegasus_home_LINUX_IX86_GNU

<hr>

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

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

OpenPegasus (also referred to as Pegasus):

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

3. Now place $PEGASUS_HOME/bin on your path

written

and

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

interfaces, an implementation of the CIMOperations over HTTP operations

and their cimxml HTTP encodings, and Interface libraries

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

for both client and providers. It is maintained

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

consistent with the DMTF CIM and WBEM specifications except for 

exceptions

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

noted in the documentation.

(where make refers to GNU make).

OpenPegasus includes components for:

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:

6. To test the build type "make tests".

The following make targets are supported:

<UL>

<li><default> - Build everything.

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

<li>depend - Create the dependencies.

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

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

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

<li>world - depend, <default>

</UL>

The Pegasus Client server tests are executed separately from the above because

they require the initiation of separate process for the Pegasus server and

Pegasus client. To execute these tests please refer to the scripts in

pegasus/mak/BuildMakefile - refer to the prestarttests and poststarttests.

For information on particular installation characteristics, tools, etc. for

each platform see the appropriate sections below:

Generally the build commands are as follows:

<ol>

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

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

make in the Pegasus root directory will make everything. "make rebuild"

Indications, and

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

includes class and instance repositories and interfaces for creating

the repository with the current CIM Schemas.

CIM

</li>

Providers and CIM Clients.</li>

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

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

"make world".

languages (i.e.

This will build dependencies, build binaries, and then run all

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

tests except the Client/Server tests.

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

</li>

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

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

<li>A MOF compiler.</li>

"make tests". This also reinstalls the repository. 

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

Running "make -s tests" suppresses extraneous output such as the

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

enter/leave directory messages.

system tests.</li>

</li>

<li>More complete information on the exact functions

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

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

OpenPegasus release.</li>

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

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

<h1>

license.

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

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

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

This licensing is intended to support as

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

wide a

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

distribution as possible with minimal demands on the users.

manually:

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

documentation on

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

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

Pegasus is regularly tested against a variety of platforms by the

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

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. 

PEP 249 is the Release Notes PEP for 2.5.1.

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

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

tree in the pegasus/rpm/manLinux/ directory.

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

Here is a list of useful

commands:

Some of

the basic commands:

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

for

more information about administering the Pegasus CIMServer.

<ul>

<li>cimserver daemon=true  (Start the server

cimserver)</li>

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

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

with

config flags)</li>

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

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

OperatingSystem provider)</li>

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

</li>

<li>cimuser -l  (Lists the users )

</li>

</ul>

Note:  there are some differences between windows and other

platforms in

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

platforms use

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

windows it

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

and then

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

explains the

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

Much of Pegasus

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

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

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

maintained both as a manual created

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

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

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

source directory of CVS.

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

of most

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

and

design documentation.

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

Contributors

are welcome to participate in the OpenPegasus development effort. Join

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

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

for the website.

<h1>

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

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

<ol>

Pegasus can be obtained via any of the following:

<ol>

<LI>Register the MOF (Managed Object Format) file describing the skeleton of the

<li>Released tarballs (see

object.

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

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

tarballs link</a>)</li>

when a

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

specific object is activated.

code repository</a> for

more information.)</li>

<li>Linux RPMs. See

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

link</a> for

more information

)</li>

</ol>

This is done automatically for the providers included in Pegasus by doing:

</ol>

make repository.

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

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

The distribution is available via CVS and snapshot images in

Runs MOF compiler (cimmofl) on:

tar and zip file formats on the web site.

-Schema v2.7

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

Generates the CIM Schema v2.7 in the repository (skeleton of CIM objects)

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

-PG_InterOp

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

Internal to Pegasus schema for operating (shutdown, add users, etc)

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

CIM_Indication�s (SNMP, Events, Alert, Threshold, etc)

CVS

-PG_ManagedSystem

write accounts are managed by Martin Kirk of The Open Group

Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, � )

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

in Pegasus (which are located in src/Providers)

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

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

openpegasus.org.

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

<h1>

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

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

enviromentthat can be executed including:<ul>

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

specifically to test Pegasus or parts of Pegasus including TestClient, Client,

CLI, ipinfo, osinfo, WbemEsec, etc. See the src/Clients directory for more

information. These programs require a 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 from the providers/sample and proviers/testproviders directories.</li>

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

major provider types in the providers/sample directories and the providers/testProviders

directory</li>

<li>Unit Tests - Most Pegasus functions include unit 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 individual directories. 

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

below their corresponding source code (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 the make file

TestMakefile in the PEGASUS_ROOT directory to execute 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 Providers

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

Pegasus registers providers with a set of provider registration classes, not

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

using the provider qualifier as is done in most DMTF CIM CIMOM implementations

packages and tools. Currently Pegasus has the following dependencies:

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

1. GNUMAKE - To simplify the building of Pegasus across

with 2.6). This will be harmonized in the future when the DMTF scheme is moved

multiple platforms we

to final status.

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

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

GNUMAKE is available from :

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

MOF

compiler and WQL

parser.  These tools are required only for

development of the parsers, not for building Pegasus.

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

combination of text files

and the Pegasus header files themselves. This documentation is

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

interface documentation set.

4. ICU Internationalization libraries - These libraries are

used as the basis for message catalogs for message

internationalization. See the ICU website

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

libraries

5. OpenSSL - If it

is intended to use SSL on the

communication protocol, the OpenSSL libraries are required.

NOTE: A set of the required

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>

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

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>

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

<div>

make alltests</div>

<div>

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

in</div>

<div>

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

compile</div>

<div>

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

<div>

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

suite</div>

<div>

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

<div>

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

and</div>

<div>

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

on</div>

<div>

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

</div>

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

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

variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For

32 bit linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU).

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

</a></h4>

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

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

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

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

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

standard

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

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

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

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

implementations that do work with Pegasus today.

your OpenSSL

installation is.

<h1>

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

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

in Pegasus

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

SSL

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

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

using OpenPegasus with SSL.

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

Visual

C++ </a></h4>

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

regularly tested on both Windows 2000 and Windows XP using the

Microsoft compilers.

Today we build OpenPegasus 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 OpenPegasus <a href="#mu_utility">mu.exe </a>utility compiled and available

before trying to compile OpenPegasus 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 (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>

</blockquote>

<h6>

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

In order to provide a consistent build structure across multiple platforms, we

In order to provide a consistent build structure across multiple

developed a small utility to provide a consistent set of small utilities

platforms, we

across these platforms. The MU utilityis a simple utility that contains many

developed a small utility to provide a consistent set of small

utilities

across these platforms. The MU utility is 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

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

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

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

directory.

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

distribution

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

before you initiate the OpenPegasus make.

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

WEB site.

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

MU is required to build under the Windows environment. MU is available as part

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

of the distribution of Pegasus.

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

you

<h1>

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

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

<ol>

Linux </a></h1>

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

skeleton of the object. </li>

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

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

PEGASUS_ROOT, PEGASUS_PLATFORM.  For 32 bit linux, the defintion of

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

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

</ol>

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

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 MU Utility">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.

The providers included with Pegasus are automatically entered into the

Setup the environment variables and path for the Micrososft Visual C compiler.

repository

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

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:

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

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

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

bin/cimserver �s (Shuts it down)

bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags)

bin/cimprovider �l �s (lists providers and their status)

bin/cimprovider �e �m OperatingSystemModule (enables the OperatingSystem provider)

bin/cimuser �a �u guest �w ThePassword

bin/cimuser �l (lists the users)

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>

Please follow section <a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a> before embarking on this endeavour.

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/" \

-e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \

> $PEGASUS_HOME/ssl.cnf

chmod 644 $PEGASUS_HOME/ssl.cnf

chown bin $PEGASUS_HOME/ssl.cnf

chgrp bin $PEGASUS_HOME/ssl.cnf

/usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \

-nodes -config $PEGASUS_HOME/ssl.cnf \

-keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem

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="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:

sslTrustFilePath=client.pem

sslCertificateFilePath=server.pem

sslKeyFilePath=file.pem

httpsPort=5989

enableHttpsConnection=true

</pre></blockquote>

using the cimconfig utility:

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:

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:

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.

<li> Removes the existing repository if one

This notifies PAM what kind of libraries to use when authenticating

exists.</li>

Pegasus.</uL>

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

objects).  </li>

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

b). Modify CIMServer configuration options:

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

built specifically to test OpenPegasus, or parts of OpenPegasus,

usePAMAuthentication=true

including

enableAuthentication=true

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

</blockquote></pre>

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

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

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

enableRemotePrivilegedUserAccess=true

classes and instances in those namespaces and additional providers from

</blockquote></pre>

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

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

using the cimconfig utility, such as:

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

pegasus/Providers/TestProviders directory </li>

cimconfig -p -s usePAMAuthentication=true

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

</pre></blockquote>

for

</ul>

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

</ul>

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

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

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

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

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

Refer to section

directories immediately below their corresponding source code

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

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

directory). Unit tests are executed without the server being

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

operational and normally do not require the existence of a Class

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

repository. </li>

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

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

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

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

a specific locale etc. In order to enable globalization in Pegasus, Pegasus

the make file TestMakefile in the PEGASUS_ROOT directory to execute

must be built with ICU enabled, ie. the right environment variables must be

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

set prior to running "make". Refer to the GlobalizationHOWTO.htm in the docs

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

directory for details. That said, when users run "make poststarttests"

</ul>

to verify the integrity of a Pegasus download, a series of tests are run that

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

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

require the cimserver to be running. These tests currently depend on specific

libraries that OpenPegasus uses to run globalized. For example: these

libraries are used

messages returned from the server. When ICU is enabled, all messages come

from the resource bundles and these usually do not match the hardcoded default messages within Pegasus. These hardcoded default messages

load messages in different languages, format currency and numbers

are what the various test programs expect in order to complete

according to

a specific locale etc. In order to enable globalization in OpenPegasus,

OpenPegasus

must be built with ICU enabled, ie. the right environment variables

must be

set prior to running "make". Refer to the GlobalizationHOWTO.htm in the

docs

directory for details.

When users run "make poststarttests"

to verify the integrity of a OpenPegasus download, a series of tests

are

run that

require the cimserver to be running. These tests currently depend on

specific

messages returned from the server. When ICU is enabled, all messages

come from the resource bundles and these usually do not match the

hardcoded default messages within OpenPegasus. These hardcoded default

messages are what the various test programs expect in order to complete

successfully. If the ICU enabled server is started without

disabling message loading from the bundles, "make poststartests" will fail.

disabling message loading from the bundles, "make poststartests" will

In order to run "make poststarttests" successfully with ICU enabled, an

fail.

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist prior to

In order to run "make poststarttests" successfully with ICU enabled, an

starting the server. Once this is defined, when the cimserver starts, all

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist

messages generated will be the default hardcoded messages. This will enable

prior to

"make poststarttests" to complete successfully. Once "make poststarttests" is

starting the server. Once this is defined, when the cimserver starts,

complete, you should stop the cimserver and then undefine PEGASUS_USE_DEFAULT_MESSAGES.

all

If this variable is left defined, Pegasus will not be able to load messages

messages generated will be the default hardcoded messages. This will

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

enable

The documentation is currently in preparation.  Much of Pegasus is

"make poststarttests" to complete successfully. Once "make

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

poststarttests" is

functionality, changes, plans, etc.  These documents are openly available

complete, you should stop the cimserver and then undefine

on the PEGASUS web site.  The preliminary documentation

PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined,

is not provided with this release. The current documentation is maintained both as a manual created

OpenPegasus

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

will not be able to load messages

to create), as an api document also creatable from the source tree (see doc/apidoc)

using ICU resource bundles.

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

When

available in the root source directory of CVS.

running the make tests command with ICU enabled, the PEGASUS_MSG_HOME

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

environment variable must be set to the home directory where the ICU

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

resource bundles are built. By default the resource bundles are built

design documentation. <h1><a name="Participate!">Participate!</a></h1>

into directories below PEGASUS_HOME/msg, so that should be the setting

We are looking for people who want to join the Pegasus work group and

for PEGASUS_MSG_HOME.

contribute to effort of getting this Pegasus off the ground. Please join

the mailing list by visiting www.openpegasus.org, and click on Mailing Lists.

<h1>

<a name="sec0">Security Considerations</a></h1>

Some of the steps of installing and running Pegasus have

</body>

security properties that you should be aware of. If you plan to administer a

Pegasus server, see the 'security considerations' section of the administrators

guide <pointer>. If you plan to write clients or providers for integration into

Pegasus, see the developer's security guidance.

</pointer>

<hr>

L.P.; IBM Corp.;

EMC Corporation; Symantec Corporation; The Open Group.

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to

deal in the Software without restriction, including without limitation the

rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

sell copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<hr>

<big><big>End of Document

</big></big>

</html>

</body></html>

Legend:

Removed from v.1.5
changed lines
	Added in v.1.11.2.2

No CVS admin address has been configured