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

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

version 1.11.2.3, 2006/07/12 19:53:48

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

Version: <span

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

Created: 24 June

2004

Authors: Warren

Grunbok, Mike Harris

Status:  draft

Title: OpenPegasus

Release 2.5.1 and subsequent 2.5 minor releases Readme file

Version:

1.3

Created: 20th March 2006

Authors: Martin Kirk

Status:  Draft

Version History:

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

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

<tbody>

<tr>

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

Line 32

Line 39

</tr>

<tr>

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

<td align="center">Warren Grunbok

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

</td>

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

<td>Initial draft

numbers and typos</td>

</td>

</tr>

<tr>

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

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

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

</td>

<td align="center">Warren Grunbok

Draft for ballot incorporating draft 1.0

</td>

comments.</td>

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

</tr>

</td>

<tr>

</tr>

<tr>

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

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

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

</td>

<td style="vertical-align: top;">Draft for Steering Committee approval.

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

Approved</td>

</td>

</tr>

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

<tr>

</td>

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

review.  Removed /Directory structure section and placed

July 12th 2006</td>

into  seperate document.

Karl Schopmeyer</td>

</td>

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

</tr>

that it applies to subsequent 2.5 minor releases.

<tr>

(Note Approved)</td>

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

</tr>

</td>

<tr>

<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 Pegasus Platform Version 2.4.0 Release. Note that if this readme

the OpenPegasus Version 2.5.1 Release and subsequent minor releases. Note that if this readme

conflicts with the documentation in the release notes or interface

definition documents for a particular release, those documents should

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

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

introduction to Pegasus.

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

Services Broker for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

DMTF CIM objects written in C++

and supported by The Open Group

and hosted by The Open Group

STATUS: Revised Sept 2004 for  Pegasus release version

STATUS: Revised July 2006 for  Pegasus release version 2.5.1 and

2.4.0 

subsequent releases  - Draft (Change to Architecture

- Approved

Team Approved)

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <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>

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

<a href="#peg_dir_struc">The Pegasus Directory Structure</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="#part">Participate</a>

<a href="#part">How to 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>

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

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

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

certifications</a>

</blockquote>

<a href="#bld_peg_win">Building

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

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

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

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

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

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

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

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

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

<a href="#note_bld_peg_ssl">Building Pegasus with SSL</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="#pop_peg_rep">Populate the Pegasus repository</a>

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

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

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

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

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

<a href="#sec0">Security Considerations</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):

OpenPegasus (also referred to as Pegasus):

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

written

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

interfaces, an implemenation of the CIMOperations over HTTP operations

interfaces, an implementation of the CIMOperations over HTTP operations

and their cimxml HTTP encodings, and Interface libraries

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for 

exceptions

noted in the documentation.

noted in the documentation.

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

OpenPegasus includes components for:

license.

<ol>

Pegasus is being developed and maintained under the auspices of The

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

Open

Indications, and

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

includes class and instance repositories and interfaces for creating

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

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

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

Line 419

Line 227

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

and

design documentation.

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

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

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

Contributors

and

are welcome to participate in the OpenPegasus development effort. Join

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

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

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

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

Mailing Lists.

for the website.

<h1>

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

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

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

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>

Pegasus can be obtained via any of the following:

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

<li>Set environment variables. </li>

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

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

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

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

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

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

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

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

the required software</a>

Refer to the section <a href="#peg_dep">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>

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

CVS, for 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.

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>

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

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

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

a unique identifier with the following form:

The following values are tested for the OpenPegasus release:

<ul>

<li>AIX_RS_IBMCXX </li>

<li>HPUX_PARISC_ACC </li>

<li>LINUX_IA64_GNU </li>

<li>LINUX_IX86_GNU </li>

<li>LINUX_PPC_GNU </li>

<li>LINUX_ZSERIES_GNU </li>

<li>NSK_NONSTOP_NMCPLUS </li>

<li>SOLARIS_SPARC_CC </li>

<li>SOLARIS_SPARC_GNU </li>

<li>TRU64_ALPHA_DECCXX </li>

<li>ZOS_ZSERIES_IBM </li>

</ul>

</dd>

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

</dl>

Additional configuration:

<ul>

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

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

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.

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

the Pegasus distribution:

<ol>

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

<li>Released tarballs (see

This builds all of Pegasus.

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

</li>

tarballs link</a>)</li>

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

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

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

code repository</a> for

To create the additional namespaces that represent the test support you

more information.)</li>

can also execute "make testrepository".

<li>Linux RPMs. See

</li>

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

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

link</a> for

This executes all the tests included with the Pegasus

more information

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

)</li>

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>

</ol>

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>

Generally the build commands are as follows:

<ol>

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

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

"make world".  This will build

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

Client/Server tests. </li>

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

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

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

enter/leave directory messages. </li>

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

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>

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

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

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

<ol>

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

skeleton of the object. </li>

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

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

</ol>

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

The providers included with Pegasus are automatically entered into the

repository

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

The distribution is available via CVS and snapshot images in

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

tar and zip file formats on the web site.

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

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

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

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

CVS

write accounts are managed by Martin Kirk of The Open Group

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

<ul>

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

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

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

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

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

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

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

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

</ul>

<h2>

<a name="reg_prov">Registering

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

Pegasus registers providers with a set of provider registration

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

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

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

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

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

status.

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

registration classes that represent the porvider module, providers,

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

registration today is to copy from one of the existing registration

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

several registration instance implementations that do work with Pegasus

today.

<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

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

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

</ul>

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

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

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

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

packages and tools. Currently Pegasus has the following dependencies:

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

1. GNUMAKE - To simplify the building of Pegasus across

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

multiple platforms we

number>.rpm</tt>.

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

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

GNUMAKE is available from :

Note: After you install using the install using the

PRM, you must crate and populate teh repository manually.

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

MOF

compiler and WQL

parser.  These tools are required only for

development of the parsers, not for building Pegasus.

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

combination of text files

and the Pegasus header files themselves. This documentation is

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

interface documentation set.

4. ICU Internationalization libraries - These libraries are

used as the basis for message catalogs for message

internationalization. See the ICU website

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

libraries

5. OpenSSL - If it

is intended to use SSL on the

communication protocol, the OpenSSL libraries are required.

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

NOTE: A set of the required

it to work yet).

tools for windows platforms is available on the openpegasus web

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

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

Variables</a></h4>

Before installing or running OpenPegasus, environment variables may

have to be defined or updated.

PEP 237 contains the list of environment variables and setup necessary

to use OpenPegasus.

At a minimum, the following need to be set:

PEGASUS_ROOT=<location of your pegasus source tree>

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

PEGASUS_PLATFORM=<your platform>

</blockquote>

For a list of valid

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

source tree.

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

<div>

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

<div>

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

<div>

make build</div>

<div>

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

all</div>

<div>

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

to</div>

<div>

run the CIM Server.</div>

<div>

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

make alltests</div>

Building

<div>

Pegasus on Linux </a></h2>

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

in</div>

Pegasus supports many distributions of Linux. Refer to <a

<div>

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

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

for more information.

and 2.5.2),

compile</div>

<div>

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

<div>

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

suite</div>

<div>

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

<div>

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

and</div>

<div>

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

on</div>

<div>

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

</div>

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

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

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

variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For

32 bit linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU.

LINUX_IX86_GNU).

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

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

</a></h4>

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

C++ </a></h2>

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

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

standard

directory so OpenPegasus 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=true variable set. Then just run 'make'

in Pegasus

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

SSL

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

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

using OpenPegasus with SSL.

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

Visual

C++ </a></h4>

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

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

regularly tested on both Windows 2000 and Windows XP using the

Microsoft compilers.

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

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

contained

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

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

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

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

href="#mu_utility">mu.exe </a>utility compiled and available

before trying to compile OpenPegasus on the normal windows platform.

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

The

following is the basic setup steps for the environment.

Setup the environment variables and path for the Micrososft Visual C

Line 701

Line 419

For Windows, try the following for an example environment:

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

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>

<h6>

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

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

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

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

contains

many

commands. For example:

Line 732

Line 450

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

available as part

of the distribution of Pegasus.

of the distribution of OpenPegasus.

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

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

Building Pegasus with SSL

directory.

</a></h2>

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

distribution

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

before you initiate the OpenPegasus make.

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

WEB site.

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

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

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

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

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

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

you

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

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

your OpenSSL

<ol>

installation is.

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

skeleton of the object. </li>

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

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

</ol>

The providers included with Pegasus are automatically entered into the

repository

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

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

in Pegasus

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

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>

<ul>

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

<li> Removes the existing repository if one

The PEGASUS_ROOT and PEGASUS_HOME have to be set to your respective

exists.</li>

installation and source directory.

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

Set the sslKeyFilePath to

objects).  </li>

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

<li>Loads

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

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

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

CIM indications

(SNMP, Events, Alert, Threshold, etc)

<pre

internal to the Pegasus. </li>

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>

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

Note:  key.pem is

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

sslKeyFilePath. cert.pem is sslCertificateFilePath

src/Providers)  </li>

</ul>

<h1>

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

<a name="reg_prov">Registering

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

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

Pegasus registers providers with a set of provider registration

enviroment, including:

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

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

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

Interop

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

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

status.

Registration

is performed by creating instances of the

registration classes that represent the provider module, providers,

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

registration today is to copy from one of the existing registration

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

several registration instance implementations that do work with

OpenPegasus

today.

<h1>

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

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

CVS

environment, including:

<ul>

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

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

built specifically to test OpenPegasus, or parts of OpenPegasus,

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

including

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

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

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

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

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

"make testrepository" functions including test namespaces and extra

classes and instances in those namespaces and additional providers from

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

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

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

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

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

providers/testProviders directory </li>

pegasus/Providers/TestProviders directory </li>

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

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

for

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

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

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

Line 799

Line 556

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

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

</ul>

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

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

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

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

libraries that

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

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

libraries are used

load messages in different languages, format currency and numbers

according to

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

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

Pegasus

OpenPegasus

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

must be

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

Line 825

Line 572

directory for details.

When users run "make poststarttests"

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

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

are

run that

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

specific

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

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

hardcoded default messages within Pegasus. These hardcoded default

hardcoded default messages within OpenPegasus. These hardcoded default

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

successfully. If the ICU enabled server is started without

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

Line 846

Line 594

"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

PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined,

OpenPegasus

will not be able to load messages

using ICU resource bundles.

Line 855

Line 604

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.

for PEGASUS_MSG_HOME.

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

<h1>

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

Some of the steps of installing and running Pegasus have

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

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

VERITAS Software Corporation

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

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

Pegasus, see the developer's security guidance.

</pointer>

<hr>

L.P.; IBM Corp.;

EMC Corporation; Symantec Corporation; The Open Group.

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

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

deal in the Software without restriction, including without limitation the

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

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

furnished to do so, subject to the following conditions:

Permission is hereby granted, free of charge, to any

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

person obtaining a copy  of this software and associated

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

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

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

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

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

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

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

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

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

to do so, subject to the following conditions:

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

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

<hr>

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE

<big><big>End of Document

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>

</body></html>

Legend:

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

No CVS admin address has been configured