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.7 and 1.8

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

version 1.8, 2004/12/01 09:51:58

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

Title: OpenPegasus

Version 2.4 Release Readme file

Title: OpenPegasus Version 2.4

Release Readme file

Version: <span

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

Created: 24 June

2004

Created: 24 June 2004

Authors: Warren

Grunbok, Mike Harris

Authors: Warren Grunbok, Mike

Harris

Status:  draft

Version History:

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

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

<table bordercolordark="#666666" bordercolorlight="#cccccc" style="font-family: Arial;"

border="1" cellspacing="1" width="100%">

<tbody>

<tr>

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

Line 54

Line 63

</td>

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

</td>

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

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

review.  Removed /Directory structure section and placed

/Directory structure section and placed into  seperate document.

into  seperate document.

</td>

</tr>

Line 67

Line 75

</td>

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

</td>

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

<td style="vertical-align: top;">Removed Pegasus Directory structure and placed in PEP

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

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,

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

Sept 2004

</td>

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

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

Grunbok

</td>

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

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

Security changes as per Sterling.

Sterling.

</td>

</tr>

</tbody>

</table>

<hr>

Abstract:  Installation, build, operation information on

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

Abstract:  Installation, build, operation information on the Pegasus

conflicts with the documentation in the release notes or interface

Platform Version 2.4.0 Release. Note that if this readme conflicts with the documentation

definition documents for a particular release, those documents should

in the release notes or interface definition documents for a particular release, those

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

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

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

and supported by The Open Group

written in C++ and supported by The Open Group

STATUS: Revised Sept 2004 for  Pegasus release version

STATUS: Revised Sept 2004 for  Pegasus release version

2.4.0 

2.4.0  - Approved

- Approved

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

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

Overview</a>

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

<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="#peg_sup_plat">Pegasus Supported Platforms</a>

Line 117

Line 127

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

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

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

</blockquote>

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

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

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

Install Pegasus</a>

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

software</a>

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

<a href="#vfy_req_sw">Verify that you have the required 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="#bld">Build the Pegasus runtime, test files, test clients, and 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="#bld_rpms">Build an RPM for Pegasus</a>

<a href="#note_bld_peg_lnx">Notes

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

about Building Pegasus on Linux</a>

<a href="#note_bld_peg_mac">Notes about Building Pegasus on Mac OS X</a>

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

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

<a href="#crt_ssl_cert">Creating SSL certifications</a>

href="#crt_ssl_cert">Creating SSL

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

certifications</a>

Visual C++</a>

</blockquote>

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

<a href="#bld_peg_win">Building

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>

</blockquote>

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

Test the Pegasus installation</a>

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

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

</blockquote>

<hr>

<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

OpenPegasus (also referred to as Pegasus): Pegasus is an open-source CIM Server

written

for DMTF CIM objects. It is written in C++ and includes the Object manager (CIMOM), a set

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

of defined interfaces, an implemenation of the CIMOperations over HTTP operations and

interfaces, an implemenation of the CIMOperations over HTTP operations

their cimxml HTTP encodings, and Interface libraries for both client and providers. It is

and their cimxml HTTP encodings, and Interface libraries

maintained consistent with the DMTF CIM and WBEM specifications except for 

for both client and providers. It is maintained

exceptions noted in the documentation.

consistent with the DMTF CIM and WBEM specifications except for 

exceptions

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

noted in the documentation.

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

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

is maintained under the license defined in the doc directory (LICENSE) of this release.

license.

This licensing is intended to support as wide a distribution as possible with minimal

Pegasus is being developed and maintained under the auspices of The

demands on the users.

Open

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

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

more complete documentation.

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

documentation.

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

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

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

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>

<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

The documentation is currently in preparation.  Much of Pegasus is documented in

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

the PEGASUS PEPs which are the basis for approval of Pegasus functionality, changes,

openly available on the PEGASUS web site.  The preliminary

plans, etc.  These documents are openly available on the PEGASUS web site.  The

documentation

preliminary documentation is not provided with this release. The current documentation is

is not provided with this release. The current documentation is

maintained both as a manual created under the tool DOC++ in the runtime subdirectory

maintained both as a manual created

manual/html (see doc/devManual to create), as an api document also creatable from the

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

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

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

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

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

current release are available in the root source directory of CVS.

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

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

source directory of CVS.

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

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

documentation.

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

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

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

effort of getting this Pegasus off the ground. Please join the mailing list by visiting

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

www.openpegasus.org, and click on Mailing Lists.

Mailing Lists.

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

<h1>

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

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

process includes the following steps:

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

installation process includes the following steps:

<ol>

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

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

<li>Set environment variables. </li>

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

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

repository. </li>

</ol>

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

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

Pegasus is freely available from the open group's Pegasus home page: <a target="blank"

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

href="http://www.openpegasus.org">http://www.openpegasus.org</a>. To obtain Pegasus, you

can either check it out using CVS or download a snapshot image of the soruce distribution.

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

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

snapshot image of the soruce distribution. For more information about

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

of Pegasus</a>.

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

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

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

included with the source distribution. See <a href="#bld_rpms">Building RPMs for Pegasus</a>

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

for more information.

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

<a name="vfy_req_sw">Step 2: Verify that you have the required software</a>

the required software</a>

Refer to the section <a href="#peg_dep">Pegasus Dependencies</a> and verify that you

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

have the software required for your Operating System and planned usage of Pegasus.

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

your Operating System and planned usage of Pegasus.

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

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

Before installing or running Pegasus, ensure that the following environment variables

variables</a>

have been defined or updated:

Before installing or running Pegasus, ensure that the following

environment variables have been defined or updated:

<dl>

<dt>PEGASUS_ROOT </dt>

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

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

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

example: <tt>/opt/pegasus/pegasus-2.3.2</tt>

</dd>

<dt>PEGASUS_HOME </dt>

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

<dd>Defines the directory that will contain the output binary files. For example, if you set

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

this to <tt>$HOME/pegasus_home</tt>, then the output will go into <tt>$HOME/pegasus_home/bin</tt>

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

and <tt>$HOME/pegasus_home/lib.</tt>

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

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

for each build you need, that way the output of each build will be placed in its own

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

directory, for example: <tt>$HOME/pegasus_home_LINUX_IX86_GNU.</tt>

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

</dd>

<dt>PEGASUS_PLATFORM </dt>

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

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

a unique identifier with the following form:

with the following form:

<tt><Operating-System>_<Architecture>_<Compiler></tt> The following

The following values are tested for the OpenPegasus release:

values are tested for the OpenPegasus release:

<ul>

<li>AIX_RS_IBMCXX </li>

Line 500

Line 494

<li>TRU64_ALPHA_DECCXX </li>

<li>ZOS_ZSERIES_IBM </li>

<li>DARWIN_PPC_GNU </li>

</ul>

</dd>

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

</dl>

Additional configuration:

Additional configuration:

<ul>

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

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

</li>

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

<li>For RedHat/SuSE/UL, edit /etc/ld.so.conf and add

$PEGASUS_HOME/lib.</li>

</ul>

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

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

files, test clients and repository</a>

repository</a>

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

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

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

Pegasus runtime, test files, test client and the repository. To use these make files, type

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

"make" followed by one of the supplied targets.

supplied targets.

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

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

distribution:

the Pegasus distribution:

<ol>

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

<li>Enter <tt>make</tt> This builds all of Pegasus.

This builds all of Pegasus.

</li>

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

<li>Enter <tt>make repository</tt> This creates the repository, which is needed to serve

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

data. To create the additional namespaces that represent the test support you can also

To create the additional namespaces that represent the test support you

execute "make testrepository".

can also execute "make testrepository".

</li>

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

<li>Enter <tt>make tests</tt> This executes all the tests included with the Pegasus

This executes all the tests included with the Pegasus

distribution, except the client/server tests. The client/server tests are executed

distribution, except the client/server tests. The client/server tests

separately from the above because they require the initiation of separate process for the

are executed separately from the above because

Pegasus server and Pegasus client. To execute these tests, refer to the scripts in

they require the initiation of separate process for the Pegasus server

pegasus/mak/BuildMakefile. Refer to the prestarttests and poststarttests in this file.

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>

</ol>

The following make targets are supported:

<ul>

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

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

Line 557

Line 544

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

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

</ul>

Generally the build commands are as follows:

Generally the build commands are as follows:

<ol>

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

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

executing make in the Pegasus root directory will make everything.

root directory will make everything. "make rebuild" will clean and rebuild

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

everything. The "make rebuild" will also populate the repository with the

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

current CIM Schemas. </li>

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

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

"make world".  This will build

world".  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. </li>

Client/Server tests. </li>

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

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

tests". This also reinstalls the repository.  Running "make -s tests"

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

suppresses extraneous output such as the enter/leave directory messages. </li>

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

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

enter/leave directory messages. </li>

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

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

and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild" </li>

structure. </li>

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

checkout is done,

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

cleanbuild" </li>

</ol>

<h2>

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

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

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

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

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

the buld process when you run the makefile. However, you can also do it manually after the

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

Pegasus has been built.

<ol>

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

<li>Register the MOF (Managed Object Format) file describing the skeleton of the object. </li>

skeleton of the object. </li>

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

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

specific object is activated. </li>

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

</ol>

The providers included with Pegasus are automatically entered into the repository by

The providers included with Pegasus are automatically entered into the

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

repository

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

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

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

<ul>

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

<li>Generates the CIM Schema v2.8 in the repository (skeleton of CIM objects). To do this,

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

it runs the MOF compiler on the CIM schema: <tt>cimmofl -Schema v2.8</tt> </li>

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

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

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

Threshold, etc) internal to the Pegasus schema by running the following command: <tt>cimmofl

(SNMP, Events, Alert, Threshold, etc)

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

-PG_InterOp</tt> </li>

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

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

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

Pegasus (which are located in src/Providers) by running: <tt>cimmofl -PG_ManagedSystem</tt>

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

</li>

</ul>

<h2>

<a name="reg_prov">Registering

<h2><a name="reg_prov">Registering Providers in the Pegasus Environment</a></h2>

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

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

Pegasus registers providers with a set of provider registration

provider qualifier as is done in most DMTF CIM CIMOM implementations today. This set of

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

classes is close to but not exactly the same as the current DMTF definition (See the DMTF

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

Interop schema, experimental versions starting with 2.6). This will be harmonized in the

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

future when the DMTF scheme is moved to final status.

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

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

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

status.

classes that represent the porvider module, providers, classes, etc. to be

registered.  The easiest way to create a new registration today is to copy from one

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

of the existing registration MOFs.  See the providers/sample/load directory for

registration classes that represent the porvider module, providers,

examples of several registration instance implementations that do work with Pegasus today.

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

registration today is to copy from one of the existing registration

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

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

several registration instance implementations that do work with Pegasus

The source distribution includes a script you can use to create an RPM for Pegasus. To

today.

do this, your environment must meet the following requirements:

<h2>

<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

<li>Your environment variables must be set, as described in <a href="#set_envt_var">Set

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

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

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

source distribution. For example: <tt>. /usr/source/pegasus-1.0/rpmBuild</tt>

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

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

crate and populate teh repository manually.

number>.rpm</tt>.

Question: I'm still working on this procedure (I haven't gotten it to work yet).

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>

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

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

Pegasus supports many distributions of Linux. Refer to <a href="#peg_sup_plat">Pegasus

regularly tested on both Windows 2000 and Windows XP using the

Supported Platforms</a> for more information.

Microsoft compilers.

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

To build Pegasus on Linux, ensure that you you have the environment variables set

contained

(PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For 32 bit linux, the definition of

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

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

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.

<h2><a name="bld_peg_win">Notes on building Pegasus on Windows 2k or Windows XP with

Microsoft Visual C++ </a></h2>

Setup the environment variables and path for the Micrososft Visual C

compiler.

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

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

both Windows 2000 and Windows XP using the Microsoft compilers.

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

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

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

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>

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>

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

In order to provide a consistent build structure across multiple

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

platforms, we

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

developed a small utility to provide a consistent set of small

platforms. The MU utilityis a simple utility that contains many commands. For example:

utilities

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

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

many

commands. For example:

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

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

depend

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

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

of them:

this:

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

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

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

The MU utility supports globing (expansion of wildcards) so

distribution of Pegasus.

you can do things like this:

<h2><a name="note_bld_peg_mac">Notes about Building Pegasus on Mac OS X </a></h2>

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

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

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

PEGASUS_ROOT, PEGASUS_PLATFORM. For Mac OS X/Darwin, the defination of PEGASUS_PLATFORM is

available as part

DARWIN_PPC_GNU.

of the distribution of Pegasus.

<h2>

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

<a name="note_bld_peg_ssl">Notes about Building Pegasus with SSL </a></h2>

Building Pegasus with SSL

</a></h2>

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

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

find them. If that's not the case, set the environment variable OPENSSL_HOME= to point

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

where your OpenSSL installation is.

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

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

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

your OpenSSL

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

installation is.

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

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 "Creating SSL

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

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

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

The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective

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

installation and source directory.

and PEGASUS_HOME have to be set to your respective installation and source directory.

Set the sslKeyFilePath to

Set the sslKeyFilePath to key.pem.  Set the

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

sslCertificateFilePath to cert.pem.  To create a client truststore to validate the

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

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

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

<pre

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>

style="font-style: italic; font-family: courier new,courier,monospace; margin-left: 40px;">CN="Common Name"

Note:  key.pem is

EMAIL="test@email.address"

sslKeyFilePath. cert.pem is sslCertificateFilePath

HOSTNAME=`uname -n`

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

<h1>

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

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

> $PEGASUS_HOME/ssl.cnf

chmod 644 $PEGASUS_HOME/ssl.cnf

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

chown bin $PEGASUS_HOME/ssl.cnf

enviroment, including:

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>

Note:  key.pem is sslKeyFilePath. cert.pem is

sslCertificateFilePath

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

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

including:

<ul>

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

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

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

test Pegasus, or parts of Pegasus, including TestClient, Client, CLI, ipinfo, osinfo,

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

WbemEsec, etc. See the src/Clients directory for more information. These programs require

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

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

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

classes and instances that are only installed with the "make testrepository"

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

functions including test namespaces and extra classes and instances in those namespaces

"make testrepository" functions including test namespaces and extra

and additional providers from the providers/sample and proviers/testproviders directories.

classes and instances in those namespaces and additional providers from

</li>

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

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

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

types in the providers/sample directories and the providers/testProviders directory </li>

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

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

providers/testProviders directory </li>

These are normally executed with the "make tests" command which can be executed

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

at many different levels of the source tree from the top level to execute all of the unit

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

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

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

test directories immediately below their corresponding source code (i.e  common/tests

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

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

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

server being operational and normally do not require the existence of a Class repository. </li>

directories immediately below their corresponding source code

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

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

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

directory). Unit tests are executed without the server being

in the PEGASUS_ROOT directory to execute these tests.  This set of tests executes an

operational and normally do not require the existence of a Class

extensive set of fixed tests and compares the results against predefined results.</li>

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

<h2><a name="inst_peg_html">Installing the Pegasus HTML Test Client</a></h2>

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

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

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

initiated from

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

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

connections. It requires a WEB server, etc. The instructions for setting up this

for

environment are maintained in a separate readme in the CGI directory.

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.

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

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

libraries that

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

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

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

load messages in different languages, format currency and numbers

order to enable globalization in Pegasus, Pegasus must be built with ICU enabled, ie. the

according to

right environment variables must be set prior to running "make". Refer to the

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

GlobalizationHOWTO.htm in the docs directory for details.

Pegasus

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

must be

When users run "make poststarttests" to verify the integrity of a

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

Pegasus download, a series of tests are run that require the cimserver to be running.

docs

These tests currently depend on specific messages returned from the server. When ICU is

directory for details.

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

When users run "make poststarttests"

various test programs expect in order to complete successfully. If the ICU enabled server

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

is started without disabling message loading from the bundles, "make

run that

poststartests" will fail. In order to run "make poststarttests"

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

successfully with ICU enabled, an environment variable called PEGASUS_USE_DEFAULT_MESSAGES

specific

must exist prior to starting the server. Once this is defined, when the cimserver starts,

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

all messages generated will be the default hardcoded messages. This will enable "make

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

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

hardcoded default messages within Pegasus. These hardcoded default

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

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

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

successfully. If the ICU enabled server is started without

resource bundles.

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

fail.

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

When running the make

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist

tests command with ICU enabled, the PEGASUS_MSG_HOME environment variable must be set to

prior to

the home directory where the ICU resource bundles are built. By default the resource

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

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

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.

When

running the make tests command with ICU enabled, the PEGASUS_MSG_HOME

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

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

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

for PEGASUS_MSG_HOME.

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

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

VERITAS Software Corporation

Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation

Permission is hereby granted, free of charge, to any

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

person obtaining a copy  of this software and associated

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

documentation files (the "Software"), to deal in the Software without

to deal in the Software without restriction, including without limitation the rights to

restriction, including without limitation the rights to use, copy,

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the

modify, merge, publish, distribute, sublicense, and/or sell copies of

Software, and to permit persons to whom the Software is furnished to do so, subject to the

the Software, and to permit persons to whom the Software is furnished

following conditions:

to do so, subject to the following conditions:

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE

INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS

SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE

PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,

SOFTWARE. THE SOFTWARE IS PROVIDED  "AS IS", WITHOUT WARRANTY OF

INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE

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

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

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

DEALINGS IN THE SOFTWARE.

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

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

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

</big></big>

</body>

</html>

Legend:

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

No CVS admin address has been configured