pegasus/Attic/readme.txt - diff

Return to readme.txt CVS log

Up to [Pegasus] / pegasus / Attic

Diff for /pegasus/Attic/readme.txt between version 1.3 and 1.17

version 1.3, 2001/01/22 15:09:29

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

Line 1

Pegasus - A Manageability Services Broker for the DMTF CIM/WBEM Standards

OpenPegasus - A Manageability Services Broker for the DMTF CIM/WBEM Standards

Author: Mike Brasher, Karl Schopmeyer

--------------------------------------------------------------------------------

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

and supported by The Open Group

STATUS: Revised October 2003 to match Pegasus release 2.3

$Log$

NOTE: Obsolete. See readme.html

Revision 1.3 2001/01/22 15:09:29 mike

Contents:

Reworking indentation and breaking width of lines below 80 columns (not finished). Also

=========

inserted comments and suggestions following "MEB:" annotations.

1. Overview

2. Availability of Pegasus

3. Pegasus major components

4. Pegasus Dependencies

5. The Pegasus Directory Structure

6. Installation

7. Building Pegasus

8. Populate the Repository

9. The MU Utility

10. Notes about Building Pegasus on Linux

11. Notes on building Pegasus with SSL

12. Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++

13. Installing the Pegasus HTML Test Client

14. Development with Pegasus and Pegasus Tools

15. Commands

16. Creating SSL certifications.

17. Configuring Pegasus to use SSL

18. Testing with ICU enabled

19. Documentation

20. Participate

Revision 1.1 2001/01/15 04:26:04 karl

added Readme

--------------------------------------------------------------------------------

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

1. Overview:

and supported buy The Open Group

============

OpenPegasus (also refered to as Pegasus):

Pegasus is an object manager for DMTF CIM objects. It is written in C++ and

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

includes the Object manager, a set of defined interfaces, and SDKs for both

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

client, providers, and services extensions. It is maintained consistent with

for both client, providers, and services extensions. It is maintained

the DMTF CIM and WBEM specifications except for any exceptions noted in the

consistent with the DMTF CIM and WBEM specifications except for any exceptions

documentation.

noted in the documentation.

This distribution represents a work in progress towards building a Pegasus

release. Pegasus is open source and is covered under the following license.

Line 34

Line 57

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

distribution as possible with minimal demands on the users.

This distribution represnts a snapshot of the current work. Currently Pegasus

This distribution represents a snapshot of the current work. Currently Pegasus

is in phase 1 of a multiphase development project. This snapshot is primarily

for developers and for evaluation of the project.

Line 50

Line 73

In addition, the roadmap for Pegasus and further information on the project is

available on The Opengroup Pegasus WEB Site.

http://www.opengroup.org/MSB

http://www.openpegasus.org

2. Availability of Pegasus:

============================

Pegasus is distributed as open source. The distribution is available via

CVS and snapshot images in tar and zip file formats.

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

cvs.opengroup.org:/cvs/MSB

using the password authenticating server option (pserve).

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

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

%cvs login

When requested, enter the password "anon"

Availability of Pegasus

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

=======================

source tree just type:

Pegasus is distributed as open source. Today the distribution is limited

cvs co pegasus

because we want to reach a predefined level of development before making the

project publically available. The move from limited to open distribution will

be a decision of the Pegasus development team and The Open Group and should

occur before March 2001.

To get on the distribution list for Pegasus today, send an email to

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

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

after a checkout just type this from Pegasus root:

m.kirk@opengroup.org

cvs update -d

k.schopmeyer@opengroup.org

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 (k.schopmeyer@opengroup.org).

Pegasus Major Components

========================

3. Pegasus Major Components:

=============================

The major components of Pegasus are:

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

Pegasus Repository - Today Pegasus provides a defined class repository

Pegasus Repositories - Today Pegasus provides a defined class repository

interface and a simple file based class repository. Future will include

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

the object [MEB: instance?] repository

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.

Pegasus Client SDK - Tools for building Pegasus clients based on the Pegasus

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

Line 90

Line 136

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 recept of the response as WEB pages. This has proven useful as a

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.

Pegasus Providers - Future (Version 1.0)

Pegasus Provider SDK - Tools for building Pegasus providers using the Pegasus

C++ interfaces.

Pegasus Service Extensions - Future (version 1.0)

Pegasus MOF Compiler - Future (Version 0.9)

Pegasus Dependencies

Pegasus Providers - Providers to illustrate the use of Pegasus services including

====================

providers for test and demonstration.

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

Pegasus Service Extensions - Common services for use by other Pegasus

packages and tools. Currently Pegasus has the following dependencies

components to extend Pegasus capabilites.

1. ACE_Wrappers communication package - The ACE Wrappers package is used for

communication and some low level functions within the MSB, the Pegasus client

SDK, and the Pegasus Provider SDK. ACE is available from the following site.

http://ace.cs.wustl.edu/cvsweb/ace-cvs.cgi/ACE_wrappers/

Pegasus MOF Compiler - FA standalone compiler for MOF files that can be used

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

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

Currently we are using version 5.1 of ACE_Wrappers both in Linux and Windows.

http://www.cs.wustl.edu/~schmidt/ACE_wrappers/ACE-5.1.tar.gz

4. Pegasus Dependencies:

=========================

COMMENTS: Pegasus only uses limited facilities from ACE. However, today we

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

demand the installation of the complete ACE library. One of the action items

packages and tools. Currently Pegasus has the following dependencies:

for the future is to provide a more limited ACE library and possibly even to

provide an environment independent of ACE. This will depend on the demands of

the users.

2. To simplify the building of Pegasus across multiple platforms we have

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

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

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

4.79.1 successfully both in Windows and Linux environments.

GNUMAKE 3.79.1 successfully both in Windows and Linux environments.

GNUMAKE is available from

http://www.gnu.org

ATTN: I think we need to make our version available on the TOG site.

COMMENT: Unless other users of Pegasus demand it, we will NOT create any build

environment for Pegasus that does not require GNUMAKE (e.g., Visual C++). We

are open to other developers who want to contribute other build structures for

particular environments.

3. MU.EXE - To minimize the difference between Linux and Windows for GUNMAKE,

we have created a utility called MU.exe. The source for this is available

with the distribution and the binary is distributed in the bin directory of

the the snapshots for now.

[MEB: the binary for MU.EXE is not distributed in the bin directory; you

have to build it at this time]

[MEB: MU.EXE is only needed on Windows]

[STOPPED]

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

documentaiton.

The Pegasus Directory Structure

5. The Pegasus Directory Structure

===============================

===================================

Pegasus is distributed as a complete directory structure that should be

installed either from one of the snapshots or from CVS.

This structure is generally as follows

Pegasus Root directory

Pegasus Pegasus Root directory

bin

build Destination for all intermediate files from build

cgi Source for the Pegasus WEB Based Test client

bin Destination for executable and DLL modules from

cgi-bin CGI Directories for WEB demonstration.

Pegasus build

This directory is normally empty but can

lib

be populated from the runtime with the make

obj

from cgi.

cgi-bin Source and make for the Pegasus WEB Based Test client software

htdocs HTML Pages for Pegasus WEB emonstration

doc Miscelaneous Pegasus Documents. Includes the DMTF XML for CIM 2.4

doc Miscellaneous Pegasus Documents.

html HTML files for the Browser test client.

DevManual Source and build files for developers' manual

mak General make files (used by the root make and other makes)

mak General make files (used by other makes)

Repository This Directory containes the created repository

src All Pegasus Source Files

ACEExamples Test directrory with examples of the use of ACE (developers)

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

Clients Source for various test clients and client SDK

CGICLIENT Pegasus test client that uses a WEB browser

JAVA Java Client support modules

Pegasus

CGI CGI files for the WEB test client

Client Pegasus Client API Tests

CGIClient

Client Pegasus Client SDK and Test client using the SDK

depends

tests

Common Pegasus Common Functions (C++ source and headers

tests Test programs for the common functions

Compiler Pegasus MOF compiler

Config TBD

Consumer TBD

ControlProvidersImplementation of Pegasus internal providers

ExportClient TBD

ExportServer TBD

Handler TBD

HandlerService TBD

IndicationService TBD

Listener TBD

Protocol Pegasus Client HTTP/XML Protocol Modules

depends

Provider Pegasus Provider interface functions

ProviderManager Provider Manager service that manages providers

ProviderManager2Pluggable Provider Manager service

Repository Pegasus Repository Interfaces and Simple Repository

tests Tests for Repository Functions

Security TBD

Server Pegasus Server Modules

depends

WQL TBD

tests

Providers Pegasus test and required providers

generic TBD this and following

Utils

IndicationConsumer

manual Pegasus User/developer manual source modules

Linux

HTML Output from the Pegasus Manual compilartion.

ManaedSystem

slp

In the near future we will add directories for:

statistic

sample

Service Extensions

testproviders

Providers

Server Pegasus executable build

slp

Installation

StandardIncludes

============

tools MU and other utilities written for Pegasus support

Unsupported Code that is made available but is not supported or included

Pegasus today is provided only as a source distribution. You download compile and use it.

in the normal make.

Pegasus currently compiles and runs under both Linux and Windows NT environments.

WMIMapper Pegasus implementation that implements mapping to Microsoft

WMI objects.

The installation of Pegasus involves expanding the snapshot distribution files, building the

runtime, the test files and test clients, and building the repository.

Runtime Directories

$PEGASUS_HOME$ Home directory for runtime. All compiler, linker

NOTE: Since the compiler integration is not complete today, the class repository is populated

documentation creation, etc. is put here.

from the XML defintions for the complete CIM schema. This process is included in the build

bin Destination for executable and DLL modules from

process so that at the end of a complete build, the class repository is completely populated

Pegasus build

from the CIM 2.4 release schema.

Manual HTML output of the Pegasus Manual

lib Destination for Pegasus LIB modules

obj Destination for object modules

Building from a Distribution --- General

repository This Directory contains the created repository

========================================

Pegasus is buildable and runnable on either Linux or WIndows Platforms today.

It uses a common build system for the two platforms based on build files and

GUNMAKE.

Generally we support four targets in our make system:

C:\> make clean

C:\> make depend

C:\> make

C:\> make tests

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. These tests can

be executed as follows:

ATTN: Add the procedure for Client/Server Test start here.

For information on particular installation characteristics, tools, etc. for each platform see

the appropriate sections below:

Generally the build commands are as follows:

1. There is a Makefile in the Pegasus root. Simply executing make in the Pegasus

root directory will make everything.

2. In order to provide a working class repository for Pegasus until the MOF compiler

6. Installation

is integrated, There is a utility to load the CIM Schema from XML into the repository.

================

This executes the LoadRepository executable which is defined in

pegasus/src/Pegasus/Repository/tests/LoadRepository

Pegasus today is provided only as a source distribution.

with the binary in pegasus/bin. This program will load the CIM XML repository

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

definitions into the class repository.

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

3. To test a fresh release, go to the pegasus root and type

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.

"make world".

7. Building Pegasus

=====================

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

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

tests except the Client/Server tests.

4. To execute the basic test suite that is shipped with pegasus type

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

"make tests"

Be sure these are on your path.

5. To run the Client/Server tests provided, simply type

"make tests"

2. Define the following three environment variables:

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

PEGASUS_ROOT - this should be the "pegasus" directory you've pulled from CVS

enter/leave directory messages.

6. "Make Clean" removes all object and library files from the

PEGASUS_HOME - to point to a directory to contain output binary files

structure.

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

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

Build Variables

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

===============

The build system depends on the following environment variables

This identifier has the following form:

PEGASUS_ACE_ROOT - required (points to ACE_wrappers directory). This must be set

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

before you initiate make

PEGASUS_BUILD - optional (points to build directory; defaults to build

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

directory under root of pegasus distribution). This must be set before you iniiate

LINUX_IX86_GNU

make

PEGASUS_OS_TYPE - optional. The is currently set to windows. If you build on Linux

For a complete list, refer to the platform_ make files found in directory

you must change this before initiating make.

pegasus/mak

COMMENTS: In the future, we will probably automate this more. However, setting these

variables today is manual.

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

PEGASUS_HOME to something like this:

The MU Utility

$HOME/pegasus_home_LINUX_IX86_GNU

==============

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

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

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:

3. Now place $PEGASUS_HOME/bin on your path

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

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

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

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

of them:

(where make refers to GNU make).

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

"make repository"

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

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

The following make targets are supported:

The MU utility supports globing (expansion of wildcards) so

<default> - Build everything.

you can do things like this:

clean - Clean out all objects, libs, and executables.

depend - Create the dependencies.

repository - Create the repository in $PEGASUS_HOME/repository

tests - Execute all tests (except client server tests).

rebuild - clean, depend, <default>

world - depend, <default>

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.

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

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

each platform see the appropriate sections below:

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

distribution of Pegasus.

Building Pegausu on Linux

=========================

1. Obtain, unpack and build the ACE_Wrappers package for Linux.

2. Define an environment variable called ACE_ROOT that points to the root of the ACE_WRAPPERS

distribution. For example

IMPORT ACE_ROOT=\local\ACE_Wrappers

Generally the build commands are as follows:

ATTN: Mike. what is a viable directory for Linux (what do you use)

3. Define an environment variable PEGASUS_ROOT that points to the

root of the Pegasus Distribution

4. Append %PEGASUS_ROOT%/bin to your path

1. There is a Makefile in the Pegasus root directory. Simply executing

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

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

the repository with the current CIM Schemas.

5. Unpack the ace distribution.

2. To test a fresh release, go to the pegasus root and type

ATTN: Unpack with what since ZIP.

"make world".

5. Build using the make commands defined in the section on General Build.

make world

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

make tests

tests except the Client/Server tests.

Building Pegasus on NT or Windows 2000 With Visual C++

3. To execute the basic test suite that is shipped with pegasus type

=======================================================

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

"make tests". This also reintalls the repository.

in the source distribution, the Microsoft compilers (tested so far with

versions 5 and 6) and the GNUMAKE make utility. The following is the basic

set up steps for the

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

enter/leave directory messages.

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

4. "make clean" removes all object and library files from the structure.

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

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

2. Define an environment variable called ACE_ROOT that points to the

root of the ACE_Wrappers distribution. For example:

C:\> set PEGASUS_ACE_ROOT=c:/ACE_wrappers

5. 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"

Now append %ACE_ROOT%/bin to the path like this:

C:\> set path=%path%;%PEGASUS_ACE_ROOT%/bin

8. Populate the Repository

===========================

3. Define an environment variable called PEGASUS_ROOT that points to

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

the root of the Pegasus distribution. For example:

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

manually:

C:\> set PEGASUS_ROOT=c:/pegasus

1. Register the MOF (Managed Object Format) file describing the skeleton of the object.

2. Register a second MOF which only points out which lib*.so file to be loaded when a

specific object is activated.

Now append %PEGASUS_ROOT%/bin to your path like this:

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

make repository.

set path=%path%;%PEGASUS_ROOT%/bin

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

Runs MOF compiler (cimmofl) on:

-Schema v2.7

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)

4. Unpack and build the ACE_Wrappers distribution for windows.

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

openpegasus.org.

As an example, we created a file called %ACE_ROOT%/ace/config.h

containing the following:

#include "ace/config-win32.h"

9. The MU Utility

===================

and then opened this DSW file in MSVC++ IDE:

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

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

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

commands. For example:

%ACE_ROOT%/ace/ace.dsw

From the build menu we picked "aced.dll". For me it built without complaint.

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

BUG: there is still one open problem that has not been resolved. With

the Visucal C++ version 6 compiler, the ace libraries default to

acemfc.dll

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

of them:

With the version 5 visual C, apparently they default to the names

ace.dll

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

aced.dll (debug verions

We will correct this in a future snapshot.

The MU utility supports globing (expansion of wildcards) so

you can do things like this:

5. Unpack the Pegasus distribution. On Windows systems, PKzip25 or WINZIP can be used.

Be certain to use the option that expands the directory tree of the files. This expansionwill

create a directory called ./pegasus

If you are using pkzip25.exe do this:

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

C:\> pkzip25 -extract -recurse -directories pegasus.zip

This will create a directory tree called ./pegasus under the

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

current directory.

of the distribution of Pegasus.

ATTN: Define for Linux also

6. Change directory to %PEGASUS_ROOT% and type "make world". See the general build section

10. Notes about Building Pegasus on Linux

for the full set of make commands.

===========================================

This builds Pegasus and all of its examples.

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

7. To verify that it built okay, run the tests

make tests

11. Notes about Building Pegasus with SSL

==========================================

Installing the Pegasus HTML Test Client

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

=======================================

you have them in a standard directory so Pegasus can find them. If that's not

the case, set the environment varialble 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.

12. Building Pegasus on Windows 2000 (SP3 or later recommended) or Windows XP

With Microsoft Visual C++

======================================================================

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 supported) and the GNUMAKE make utility.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:

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

13. Installing the Pegasus HTML Test Client:

=============================================

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

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

the formating 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.

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

and that uses a WEB browser, CGI scritps and HTML pages for the formating 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.

Development with Pegasus and Pegasus Tools

14. Development with Pegasus and Pegasus Tools:

==========================================

================================================

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

complete documentation

ATTN: Write about providers?

===================

Documentation

The documentation is currently in preperation. The preliminary documentation is not provided

with this snapshot but is avialable from the OpenGroup Pegasus WEB pages. The current

documentation is maintained both as a manual created under the tool DOC++ in the

subdirectory manual/html and as other miscelaneous documentation in the doc directory.

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.

Participate!

============

We are looking for people who want to join the effort of getting this

next release off the ground. Please send me email for details.

15. Commands:

=============

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.

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)

16. Creating SSL certifications

================================

Please follow section 11, titled "Notes about Building Pegasus with SSL"

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.

CN="Common Name"

EMAIL="test@email.address"

HOSTNAME=`uname -n`

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

-e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/src/Server/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

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

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

17. Configuring Pegasus to use SSL

================================

Please follow section 11 and 16 before reading this section.

To configure Pegasus to take advantage of SSL, configure

cimserver_planned.conf to have:

sslTrustFilePath=client.pem

sslCertificateFilePath=server.pem

sslKeyFilePath=file.pem

httpsPort=5989

enableHttpsConnection=true

(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_planned.conf

to include:

enableHttpConnection=false

18. Testing with ICU enabled:

==============================

ICU (International Compoments 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.

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

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist prior to

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

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

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

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

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

using ICU resource bundles.

19. Documentation:

===================

The documentation is currently in preperation. The preliminary documentation

is not provided with this snapshot but is avialable from the OpenGroup Pegasus

WEB pages. The current documentation is maintained both as a manual created

under the tool DOC++ in the runtime subdirectory manual/html and as other

miscelaneous documentation in the doc directory.

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.

20. Participate!

=================

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.

Legend:

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

No CVS admin address has been configured