pegasus/Attic/readme.html - diff

Return to readme.html CVS log

Up to [Pegasus] / pegasus / Attic

Diff for /pegasus/Attic/readme.html between version 1.2.2.1 and 1.7

version 1.2.2.1, 2003/11/19 23:46:46

version 1.7, 2004/10/18 18:20:06

Line 1

<!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 #: 175

Title: OpenPegasus Version 2.3

Title: OpenPegasus

Release Readme file

Version 2.4 Release Readme file

Version: 1.0

Version: <span

Created: 12 November 2003

style="color: rgb(0, 0, 0);">1.4

Authors: Karl Schopmeyer

Created: 24 June

Status:  draft

2004

Version History:

Authors: Warren

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

Grunbok, Mike Harris

bordercolorlight="#CCCCCC" width=100%

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

Status:  draft

<tr>

Version History:

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

<table bordercolordark="#666666" bordercolorlight="#cccccc"

style="font-family: Arial;" border="1" cellspacing="1" width="100%">

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

<tbody>

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

<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">Karl Schopmeyer</td>

<td align="center">Warren Grunbok

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

</td>

</tr>

<td>Initial draft

<tr>

</td>

</tr>

<tr>

<td align="center">24,August 2004

</td>

<td align="center">Warren Grunbok

</td>

<td>Mostly spelling changes, adds to very last paragraph

</td>

</tr>

<tr>

<td style="vertical-align: top;">1.2

</td>

<td style="vertical-align: top;">31, August 2004

</td>

<td style="vertical-align: top;">Warren Grunbok

</td>

<td style="vertical-align: top;">Changes based on architecture

review.  Removed /Directory structure section and placed

into  seperate document.

</td>

</tr>

<tr>

<td style="vertical-align: top;">1.3

</td>

<td style="vertical-align: top;">???

</td>

<td style="vertical-align: top;">Warren Grunbok

</td>

<td style="vertical-align: top;">Removed Pegasus Directory

structure and placed in PEP 191, Added Copyright and End of Doc marker.

</td>

</tr>

<tr>

<td style="vertical-align: top; color: rgb(0, 0, 0);">1.4

</td>

<td style="vertical-align: top; color: rgb(0, 0, 0);">27,

Sept 2004

</td>

<td style="vertical-align: top; color: rgb(0, 0, 0);">Warren

Grunbok

</td>

<td style="vertical-align: top; color: rgb(0, 0, 0);">Corrected

Security changes as per Sterling.

</td>

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

the Pegasus Platform Version 2.4.0 Release. Note that if this readme

the documentation in the release notes or interface definition documents for a

conflicts with the documentation in the release notes or interface

particular release, those documents should be considered authorative. This is a

definition documents for a particular release, those documents should

simplified overview to act as an introduction to Pegasus.

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

introduction to Pegasus.

<hr>

OpenPegasus - A Manageability

OpenPegasus - A Manageability Services Broker

Services Broker for the DMTF CIM/WBEM Standards

for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

DMTF CIM objects written in C++

Tagline: OpenPegasus is an object manager for DMTF CIM objects written in C++

and supported by The Open Group

STATUS: Revised Sept 2004 for  Pegasus release version

STATUS: Revised November 2003 for  Pegasus release version 2.3.0

2.4.0 

- Approved

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

Table of Contents

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</blockquote>

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

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"><a

href="#download">Download or checkout Pegasus</a>

<a href="#vfy_req_sw">Verify that you have the required

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

software</a>

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

<a href="#bld">Build the Pegasus runtime, test files, test clients,

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

and repository</a>

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

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

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

<a href="#bld_rpms">Build an RPM for Pegasus</a>

Providers</a>

<a href="#note_bld_peg_lnx">Notes

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

about Building Pegasus on Linux</a>

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

href="#crt_ssl_cert">Creating SSL

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

certifications</a>

</blockquote>

<a href="#bld_peg_win">Building

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

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

href="#mu_utility">The MU Utility</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>

</blockquote>

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

</blockquote>

</a>

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

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

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

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

</blockquote>

<hr>

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

<a href="#Creating SSL certifications">Creating SSL certifications</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

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

written

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

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

implemenation of the CIMOperations over HTTP operations and their cimxml HTTP

interfaces, an implemenation of the CIMOperations over HTTP operations

encodings, and

and their cimxml HTTP encodings, and Interface libraries

Interface libraries

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for  exceptions

consistent with the DMTF CIM and WBEM specifications except for 

exceptions

noted in the documentation.

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

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

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

license.

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

Pegasus is being developed and maintained under the auspices of The

(LICENSE) of this release. This licensing is intended to support as wide a

Open

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

more complete documentation.

<h1><a name="cmnd">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.

<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="docs">Pegasus Documentation</a></h1>

The documentation is currently in preparation.  Much of Pegasus

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

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

openly available on the PEGASUS web site.  The preliminary

documentation

is not provided with this release. The current documentation is

maintained both as a manual created

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

doc/devManual 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.

<h1><a name="part">Participate!</a></h1>

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

and

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="inst_peg">Install Pegasus</a> </h1>

This structure is generally as follows:

You can install and run Pegasus on any of the supported platforms. The

Pegasus Source Structure

installation process includes the following steps:

Pegasus Root directory (PEGASUS_ROOT environment

variable)<ul>

<ol>

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

<li>Download or checkout Pegasus. </li>

<li>Verify that you have the required software. </li>

<ul>

<li>Set environment variables. </li>

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

<li>Build the Pegasus runtime, test files, test clients and

This directory is normally empty but can

repository. </li>

be populated from the runtime with the make

</ol>

from cgi.

</li>

<a name="download">Step 1: Download or checkout Pegasus</a>

<li>htdocs HTML Pages for Pegasus WEB demonstration

</li>

Pegasus is freely available from the open group's Pegasus home page: <a

</ul>

target="blank" href="http://www.openpegasus.org">http://www.openpegasus.org</a>.

</li>

<li>doc Miscellaneous Pegasus Documents.

obtain Pegasus, you can either check it out using CVS or download a

snapshot image of the soruce distribution. For more information about

<ul>

checking out Pegasus using CVS, see: <a href="#avail_of_peg">Availability

<li>apidoc - Source for the public api

of Pegasus</a>.

documentation.</li>

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

Pegasus is not currently releasing binaries, but you can create RPMs

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

using a script included with the source distribution. See <a

</ul>

href="#bld_rpms">Building RPMs for Pegasus</a> for more information.

</li>

<li>mak - Common make files for Pegasus

<a name="vfy_req_sw">Step 2: Verify that you have

compilation</li>

the required software</a>

<li>Dummy -</li>

<li>InterfaceArchive -</li>

Refer to the section <a href="#peg_dep">Pegasus

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

Dependencies</a> and verify that you have the software required for

<li>Schemas - Schemas used in the installation

your Operating System and planned usage of Pegasus.

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

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

<a name="set_envt_var">Step 3: Set the environment

<li>src All Pegasus Source Files

variables</a>

Before installing or running Pegasus, ensure that the following

<ul>

environment variables have been defined or updated:

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

<dl>

</li>

<dt>PEGASUS_ROOT </dt>

<li>Clients Source for various test

<dd>Defines the path to the "pegasus" directory you've pulled from

clients and demonstration clients.</li>

CVS, for example: <tt>/opt/pegasus/pegasus-2.3.2</tt>

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

</dd>

JAVA Java Client support modules

<dt>PEGASUS_HOME </dt>

</li>

<dd>Defines the directory that will contain the output binary files.

<li>Pegasus - Core pegasus modules.

For example, if you set this to <tt>$HOME/pegasus_home</tt>, then the

output will go into <tt>$HOME/pegasus_home/bin</tt> and <tt>$HOME/pegasus_home/lib.</tt>

<ul>

<li>Client Pegasus Client API Tests

If you plan on doing parallel builds, you may want to define a unique

depends tests </li>

PEGASUS_HOME value for each build you need, that way the output of each

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

build will be placed in its own directory, for example: <tt>$HOME/pegasus_home_LINUX_IX86_GNU.</tt>

tests Test programs for the common functions</li>

<li>Compiler Pegasus MOF compiler

</dd>

</li>

<dt>PEGASUS_PLATFORM </dt>

<li>Config Pegasus Configuration

<dd>Identifies the platform to be built. Each supported platform has

functions</li>

a unique identifier with the following form:

<li>Consumer Indication Consumer class

header</li>

The following values are tested for the OpenPegasus release:

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

</li>

</ul>

<li>HPUX_PARISC_ACC </li>

</li>

<li>LINUX_IA64_GNU </li>

<li>Security Authentication and user

<li>LINUX_IX86_GNU </li>

support functions.</li>

<li>LINUX_PPC_GNU </li>

<li>Server Pegasus Server Modules

<li>LINUX_ZSERIES_GNU </li>

</li>

<li>NSK_NONSTOP_NMCPLUS </li>

<li>WQL the WQL query language

<li>SOLARIS_SPARC_CC </li>

interpreter.</li>

<li>SOLARIS_SPARC_GNU </li>

</ul>

<li>TRU64_ALPHA_DECCXX </li>

</li>

</ul>

<li>ZOS_ZSERIES_IBM </li>

</li>

</ul>

<li>Providers Pegasus test and required providers

</dd>

<dd>Add $PEGASUS_HOME/bin to your path.</dd>

</dl>

Additional configuration:

<ul>

<li>generic A number of

<li>For Unix builds, place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH.

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>For RedHat/SuSE/UL, edit /etc/ld.so.conf and add

</li>

$PEGASUS_HOME/lib.</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>

<a name="bld">Step 4: Build the Pegasus runtime, test

files, test clients and repository</a>

Pegasus includes several make files that enable you to quickly build or

refresh the Pegasus runtime, test files, test client and the

repository. To use these make files, type "make" followed by one of the

supplied targets.

Pegasus Run Time directory structure (PEGASUS_HOME

To build Pegasus, run the following commands from the root directory of

environment variable). Home directory for runtime. All compiler, linker

the Pegasus distribution:

documentation creation, etc. are put here.

<ol>

<li>Enter <tt>make</tt>

<ul>

This builds all of Pegasus.

<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

<li>Enter <tt>make repository</tt>

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

This creates the repository, which is needed to serve data.

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

To create the additional namespaces that represent the test support you

can also execute "make testrepository".

</li>

<li> Enter <tt>make tests</tt>

This executes all the tests included with the Pegasus

distribution, except the client/server tests. The 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, refer to the scripts in

pegasus/mak/BuildMakefile. Refer to the prestarttests and

poststarttests in this file.

</li>

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

</ol>

platform identifier.</li>

The following make targets are supported:

<ul>

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

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

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

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

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

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

<li>world - depend, <default> </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>

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

PEGASUS_HOME to something like this:

$HOME/pegasus_home_LINUX_IX86_GNU

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

3. Now place $PEGASUS_HOME/bin on your path

and

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

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

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

(where make refers to GNU make).

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

Generally the build commands are as follows:

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>There is a Makefile in the Pegasus root directory. Simply

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

executing make in the Pegasus root directory will make everything.

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

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

the repository with the current CIM Schemas.

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

</li>

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

"make world".

"make world".  This will build

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

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

tests except the Client/Server tests.

Client/Server tests. </li>

</li>

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

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

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

"make tests". This also reinstalls the repository. 

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

enter/leave directory messages. </li>

enter/leave directory messages.

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

</li>

structure. </li>

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

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

checkout is done,

</li>

built, and tests are run. Do it by: "make -f mak/BuildMakefile

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

cleanbuild" </li>

done,

built, and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild"

</li>

</ol>

<h2>

<h1>

<a name="pop_peg_rep">Populate the Pegasus repository</a> </h2>

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

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

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

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

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

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

manually:

<ol>

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

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

object.

skeleton of the object. </li>

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

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

when a

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

specific object is activated.

</ol>

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

make repository.

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

The providers included with Pegasus are automatically entered into the

Runs MOF compiler (cimmofl) on:

repository

-Schema v2.7

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

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

-PG_InterOp

Internal to Pegasus 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 are located in src/Providers)

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

openpegasus.org.

<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

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

enviromentthat can be executed including:<ul>

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

<ul>

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

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

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

objects). To do this, it runs the MOF compiler on the CIM schema: <tt>cimmofl

information. These programs require a server complete with repository to be

-Schema v2.8</tt> </li>

running.  Note that some of these tests use classes and instances that

<li>Sets up operations (shutdown, add users, etc) and CIM indications

are only installed with the "make testrepository" functions including test

(SNMP, Events, Alert, Threshold, etc)

namespaces and extra classes and instances in those namespaces and additional

internal to the Pegasus schema by running the following command: <tt>cimmofl

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

-PG_InterOp</tt> </li>

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

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

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

libDNSProvider.so, � ) in Pegasus (which are located in src/Providers)

directory</li>

by running: <tt>cimmofl -PG_ManagedSystem</tt> </li>

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

</ul>

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

<h2>

which can be executed at many different levels of the source tree from the top

<a name="reg_prov">Registering

level to execute all of the unit tests to individual directories. 

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

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

Pegasus registers providers with a set of provider registration

functions for the common directory). Unit tests are executed without the

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

server being operational and normally do not require the existence of a Class

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

repository.</li>

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

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

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

operations tests that cover the major CIM operations.  See the make file

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

TestMakefile in the PEGASUS_ROOT directory to execute these tests.  This

status.

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

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,

registration classes that represent the porvider module, providers,

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

classes, etc. to be registered.  The easiest way to create a new

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

registration today is to copy from one of the existing registration

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

MOFs.  See the providers/sample/load directory for examples of

implementations that do work with Pegasus today.

several registration instance implementations that do work with Pegasus

today.

<h1>

<h2>

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

<a name="bld_rpms">Building RPMs for Pegasus</a>

</h2>

The source distribution includes a script you can use to create an RPM

for Pegasus. To do this, your environment must meet the following

requirements:

<ul>

<li>The root directory for Pegasus must be "/Pegasus-1.0" </li>

<li>Your environment variables must be set, as described in <a

href="#set_envt_var">Set evironment variables</a>. </li>

<li>You must be logged in as the root user.</li>

</ul>

To create the RPMs, run the script <tt>rpmBuild</tt> from the root

directory of the source distribution. For example: <tt>.

/usr/source/pegasus-1.0/rpmBuild</tt>

This will result in and RPM file names <tt>pegasus<version

number>.rpm</tt>.

Note: After you install using the install using the

PRM, you must crate and populate teh repository manually.

Question: I'm still working on this procedure (I haven't gotten

it to work yet).

<h2><a name="note_bld_peg_lnx">Notes about

Building

Pegasus on Linux </a></h2>

Pegasus supports many distributions of Linux. Refer to <a

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

for more information.

To build Pegasus 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.

<h2><a name="bld_peg_win">Notes

on building Pegasus on Windows 2k or Windows XP with Microsoft Visual

C++ </a></h2>

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="#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.

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

class="norm">The '/' characters are intentional and required by the Pegasus 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>

<h3>

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

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

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

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

of the distribution of Pegasus.

available as part

of the distribution of Pegasus.

<h1>

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

<h2><a name="note_bld_peg_ssl">Notes about

Linux </a></h1>

Building Pegasus with SSL

</a></h2>

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

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

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

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

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

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

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

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

</a></h1>

your OpenSSL

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

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

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

in Pegasus

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

certificates" for more information of how to use SSL.

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

<h1>

<h3><a name="crt_ssl_cert">Creating SSL certifications </a></h3>

Type these commands in your shell to create the SSL certifications.

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

The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective

installation and source directory.

Set the sslKeyFilePath to

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

key.pem.  Set the sslCertificateFilePath to cert.pem.  To

tested on both Windows 2000 and Windows XP using the Microsoft compilers.

create a client truststore to validate the server against, copy the

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

server's certificate into the client truststore, client.pem.

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. 

<pre

Note that you MUST have the Pegasus <a href="#The MU Utility">mu.exe </a>utility

style="font-style: italic; font-family: courier new,courier,monospace; margin-left: 40px;">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 cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem</pre>

compiled and available before trying to compile Pegasus on the normal windows

Note:  key.pem is

platform. The

sslKeyFilePath. cert.pem is sslCertificateFilePath

following is the basic setup steps for the environment.

<h1>

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

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

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

enviroment, including:

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

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

<ul>

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

For Windows, try the following for an example environment:

built specifically to test Pegasus, or parts of Pegasus, including

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

<pre>REM call the standard Microsoft .bat for VC 6 setup.

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

call 'C:/Program Files/Microsoft Visual Studio/VC98/Bin/Vcvars32.bat'

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

REM Set debug to something if you want compile in debug mode

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

set PEGASUS_DEBUG=true

"make testrepository" functions including test namespaces and extra

REM set PEGASUS_ROOT to top of source tree

classes and instances in those namespaces and additional providers from

set PEGASUS_ROOT=C:/cimom/pegasus

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

REM set PEGASUS_HOME to where you want repository and executables

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

set PEGASUS_HOME=%PEGASUS_ROOT%

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

REM setup the path to the runtime files.

providers/testProviders directory </li>

set path=%path%;%PEGASUS_HOME%/bin

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

</pre>

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

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

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

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

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

any WEB browser and that uses a WEB browser, CGI scripts and HTML pages for

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>

<h2><a name="inst_peg_html">Installing the

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

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

initiated from

any WEB browser and that uses a WEB browser, CGI scripts and HTML pages

for

the formatting and connections. It requires a WEB server, etc. The

instructions for setting up this environment are maintained in a separate readme in the CGI directory. <h1><a name="Development with Pegasus and Pegasus Tools">Development with Pegasus and Pegasus Tools</a></h1>

instructions for setting up this environment are maintained in a

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

separate readme in the CGI directory.

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

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

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

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

CVS)

libraries that

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

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

bin/cimserver �s (Shuts it down)

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

load messages in different languages, format currency and numbers

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

according to

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

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

bin/cimuser �a �u guest �w ThePassword

Pegasus

bin/cimuser �l (lists the users)

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

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

must be

</pre>

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

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

docs

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 for details.

directory. <blockquote><pre>CN="Common Name"

EMAIL="test@email.address"

When users run "make poststarttests"

HOSTNAME=`uname -n`

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

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

run that

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

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

> $PEGASUS_HOME/ssl.cnf

specific

chmod 644 $PEGASUS_HOME/ssl.cnf

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

chown bin $PEGASUS_HOME/ssl.cnf

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

chgrp bin $PEGASUS_HOME/ssl.cnf

hardcoded default messages within Pegasus. These hardcoded default

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

/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="Testing with ICU enabled">Testing with ICU enabled</a></h1>

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

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

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

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

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. That said, when users run "make poststarttests"

to verify the integrity of a Pegasus 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 Pegasus. 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, Pegasus

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

will not be able to load messages

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

using ICU resource bundles.

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

When

set of release notes. Normally the release notes for the current release are

running the make tests command with ICU enabled, the PEGASUS_MSG_HOME

available in the root source directory of CVS.

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

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

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

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

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

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

for PEGASUS_MSG_HOME.

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

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.

Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group;

VERITAS Software Corporation

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.

<big><big>------------------------End

Document-------------------------

</big></big>

</body>

</html>

Legend:

Removed from v.1.2.2.1
changed lines
	Added in v.1.7

No CVS admin address has been configured