Pegasus Enhancement Proposal (PEP)

PEP #: 103

Title: OpenPegasus Version 2.3 Release Readme file

Version: 1.1

Created: 12 November 2003

Authors: Karl Schopmeyer, Konrad Rzeszutek

Status:  draft

Version History:

Version Date Author Change Description
1.0 12 November 2003 Karl Schopmeyer Update from 2.2 Release notes. Converted to HTML
1.1 March 10 2004 Konrad Rzeszutek Added sections describing SSL and PAM configuration
       

Abstract:  Installation, build, operation information on the Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with the documentation in the release notes or interface definition documents for a particular release, those documents should be considered authorative. This is a simplified overview to act as an introduction to Pegasus.


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

Tagline: OpenPegasus is an object manager for DMTF CIM objects written in C++ and supported by The Open Group

STATUS: Revised November 2003 for  Pegasus release version 2.3.0  

Table of Contents

 Overview

Availability of Pegasus

Pegasus Major Components

Pegasus Supported Platforms

Pegasus Dependencies

The Pegasus Directory Structure

Installation

Building Pegasus

Populate the Repository

Registering Providers

The MU Utility

Notes about Building Pegasus on Linux

Notes on building Pegasus with SSL

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

Installing the Pegasus HTML Test Client

Development with Pegasus and Pegasus Tools

Commands

Creating SSL certifications

Configuring Pegasus to use SSL

Configuring Pegasus to use PAM

Testing with ICU enabled

Documentation

Participate

Overview

OpenPegasus (also referred to as Pegasus): Pegasus is an open-source CIM Server for DMTF CIM objects. It is written in C++ and includes the Object manager (CIMOM), a set of defined interfaces, an implemenation of the CIMOperations over HTTP operations and their cimxml HTTP encodings, and Interface libraries for both client and providers. It is maintained consistent with the DMTF CIM and WBEM specifications except for  exceptions noted in the documentation.

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

Pegasus is being developed and maintained under the auspices of The Open Group. Pegasus is maintained under the license defined in the doc directory (LICENSE) of this release. This licensing is intended to support as wide a distribution as possible with minimal demands on the users.

More information on this project, access to the CVS, and documentation on Pegasus are available from the OpenGroup WEB site.

    http://www.openpegaus.org

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

The release notes are available on the WEB site as Pegasus PEP documents and in the CVS for each release.

Release Release Notes PEP
2.0 None
2.1 None
2.2 PEP 57
2.3 PEP 98

Availability of Pegasus

Pegasus is distributed as open source under the MIT open-source license. The distribution is available via CVS and snapshot images in tar and zip file formats on the web site. 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". The source tree is in the directory pegasus. To check out the complete Pegasus source tree just type:

    cvs co pegasus

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:

    cvs update -d

Active contributors to Pegasus have write access to the CVS repository. If you are interested in contributing back to the Pegasus project, (i.e. write (checkin) access to CVS) please request access from either Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer (k.schopmeyer@opengroup.org).

Pegasus Major Components

The major components of Pegasus are:

Pegasus Supported Platforms

Pegasus is regularly tested against a variety of platforms by the development group.  The set of platforms and exact set of compilers for any given release is documented in the Release notes for that release (see the CVS source tree root directory or the Pegasus PEP defining the ReleaseNotes for any particular release).

Generally Pegasus is supported on the following Platforms and Compilers.

Platform and OS Compilers
AIX VisualAge C++ Version
HP-UX HP aC++
Linux Itanium gcc
Linux IA-32 gcc (versions 2.9x and 3.xx)
Windows 2000 Microsoft Visual C++ Ver 6 and Microsoft .Net compiler Version 7
Windows XP Microsoft Visual C++ Ver. 6 and Microsoft .Net compiler Version 7

Pegasus Dependencies

We have worked to minimize the dependence of Pegasus on other software packages and tools. Currently Pegasus has the following dependencies:

1. GNUMAKE - To simplify the building of Pegasus across multiple platforms we have standardized on a set of build tools including: GNUMAKE. We are using GNUMAKE 3.79.1 successfully both in Windows and Linux environments.

GNUMAKE is available from :

        http://www.gnu.org

       NOTE: A set of the required tools for windows platforms is available on the openpegasus web site.

2. MU.EXE - To minimize the difference between Linux and Windows for GNUMAKE, we have created a utility called MU.exe. This utility is required for Pegasus make with ONLY Windows environment. It is provided as an alternative to requiring a number of UNIX utilities (SH, RM, etc.) on the windows platform and effectively provides the functions of these utilities that GNUMAKE needs. MU is not required on UNIX or LINUX platforms.

NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory. You must build it separately. MU source code is part of the distribution in the directory src/utils/MU with its own make file. You must compile MU before you initiate the Pegausu make.

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

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

3. FLEX and BISON - These tools were used to develop the MOF compiler and WQL parser. Anybody intending to recompile the compiler or parser from scratch will be required to have these tools. They are only required if changes need to be made to the files for parsing and compiling.

4. DOC++ - The Pegasus documentation is taken from a combination of text files and the Pegasus header files themselves. This documentation is formatted with DOC++ and GAWK. These tools are required if the documentation is to be recreated but we expect that only the core team will be recreating documentation.

5. ICU Internationalization libraries - These libraries are used as the basis for message catalogs for message internationalization. See the ICU website (http://oss.software.ibm.com/icu/) for more information on these libraries

6. OpenSSL - If it is intended to use SSL on the communication protocol, the OpenSSL libraries are required.

The Pegasus Directory Structure

Pegasus is distributed as a complete source directory structure that should be installed either from one of the snapshots or from CVS.

This structure is generally as follows:

Pegasus Source Structure

Pegasus Root directory (PEGASUS_ROOT environment variable)

Pegasus Run Time directory structure (PEGASUS_HOME environment variable). Home directory for runtime. All compiler, linker documentation creation, etc. are put here.

Pegasus Installation

Pegasus today is provided only as a source distribution.  Note that there is code for a Linux RPM distribution but the project is not yet releasing binaies.

To install Pegasus, you must check it out using CVS (Common Version System) or download a snapshot. You download, compile, and use it.

For the snapshot, the installation of Pegasus involves expanding the snapshot distribution files, building the runtime, the test files and test clients, and building the repository.

Building Pegasus

1. Check that you have requisite programs (listed in Pegasus Dependencies). These include GNU Make, MU.EXE (if using Windows), Flex, and Bison (Flex and Bison only required if changes will be made to the MOF compiler or WQL parser).

Be sure these are on the path.

2. Define the following three environment variables:

This identifier has the following form:

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

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

For a complete list of platforms supported and platform support keywords, refer to the platform make files found in directory  pegasus/mak

Note: if you plan on doing parallel builds, you might consider setting PEGASUS_HOME to something like this:

    $HOME/pegasus_home_LINUX_IX86_GNU

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

3. Now place $PEGASUS_HOME/bin on your path

         and

    Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only). For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib

4. Change to the root of the Pegasus distribution and type "make" (where make refers to GNU make).

5. Then create the repository, which is needed to serve data. "make repository". Note that to create the additional namespaces, etc. that represent the test support you can also execute "make testrepository:

6. To test the build type "make tests". The following make targets are supported:

The Pegasus Client server tests are executed separately from the above because they require the initiation of separate process for the Pegasus server and Pegasus client. To execute these tests please refer to the scripts in pegasus/mak/BuildMakefile - refer to the prestarttests and poststarttests.

For information on particular installation characteristics, tools, etc. for each platform see the appropriate sections below:

Generally the build commands are as follows:

  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.
  2. 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.
  3. 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.
  4. "make clean" removes all object and library files from the structure.
  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"

Populating the Pegasus Repository

Before using Pegasus you must populate the repository.. The makefile does it all for you, but in case you are wondering what it does or how to do it manually:

  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.
This is done automatically for the providers included in Pegasus by doing: make repository.

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_Indications (SNMP, Events, Alert, Threshold, etc) -PG_ManagedSystem Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, ) in Pegasus (which are located in src/Providers)

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

Testing a Pegasus Installation

Pegasus includes an extensive set of test facilities  as part of the CVS enviromentthat can be executed including:

Registering Providers in the Pegasus Environment

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.

The MU Utility

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:

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

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

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

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

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

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

Notes about Building Pegasus on Linux

No problem. Just make sure you have the environment variables set (PEASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For 32 bit linux, the defintion of PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

Notes about Building Pegasus with SSL

To build with SSL you need the OpenSSL libraries and header files. They are NOT distributed with Pegasus. Make sure you have them in a standard directory so Pegasus can find them. If that's not the case, set the environment variable OPENSSL_HOME= to point where your OpenSSL installation is.

Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make' in Pegasus directory and you will have Pegasus with SSL enabled. See section "Creating SSL certificates" for more information of how to use SSL.

Building Pegasus on Windows 2k or Windows XP with Microsoft Visual C++

Use of Windows 2000 SP3 or later is recommended.  Pegasus is regularly tested on both Windows 2000 and Windows XP using the Microsoft compilers.

Today we build Pegasus on Windows using a set of make files contained in the source distribution, the Microsoft compilers (DevStudio 5.x is not supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE make utility.  Note that you MUST have the Pegasus mu.exe 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:

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 

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

Development with Pegasus and Pegasus Tools

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

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)

Creating SSL certifications

Please follow section Notes on 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/ssl.cnf \
> $PEGASUS_HOME/ssl.cnf
chmod 644 $PEGASUS_HOME/ssl.cnf
chown bin $PEGASUS_HOME/ssl.cnf
chgrp bin $PEGASUS_HOME/ssl.cnf

/usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \
-nodes -config $PEGASUS_HOME/ssl.cnf \
-keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem 

cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem
rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem
cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem

Configuring Pegasus to use SSL

Please follow section Notes on building Pegasus with SSL and Creating SSL certifications before embarking on this endeavour.

To configure Pegasus to take advantage of SSL, configure CIMServer to have the following configuration options set to:

	sslTrustFilePath=client.pem
	sslCertificateFilePath=server.pem
	sslKeyFilePath=file.pem
	httpsPort=5989
	enableHttpsConnection=true
using the cimconfig utility:
	cimconfig -p -s 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 configuration to include:
	enableHttpConnection=false
using cimconfig.

Configuring Pegasus to use PAM

In order to use PAM Authentication you have to compile Pegasus with one extra enviroment flags:

	PEGASUS_PAM_AUTHENTICATION=1
You can also set the PEGASUS_ALWAYS_USE_PAM=1 flag to disable Pegasus password authentication using a flag text-file (recommended).
After compiling (refer to section Building Pegasus for details), follow these two important steps:
The user is authenticated using HTTP Basic method, thererfore it is strongly suggested you use SSL connection instead of normal HTTP connection. Refer to section Configuring Pegasus to use SSL for more details on creating and using SSL keys.

Testing with ICU enabled

ICU (International Components for Unicode) refers to the set of libraries that Pegasus uses to run globalized. For example: these libraries are used to load messages in different languages, format currency and numbers according to a specific locale etc. In order to enable globalization in Pegasus, Pegasus must be built with ICU enabled, ie. the right environment variables must be set prior to running "make". Refer to the GlobalizationHOWTO.htm in the docs directory for details. That said, when users run "make poststarttests" to verify the integrity of a Pegasus download, a series of tests are run that require the cimserver to be running. These tests currently depend on specific messages returned from the server. When ICU is enabled, all messages come from the resource bundles and these usually do not match the hardcoded default messages within Pegasus. These hardcoded default messages are what the various test programs expect in order to complete successfully. If the ICU enabled server is started without disabling message loading from the bundles, "make poststartests" will fail. 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.

Pegasus Documentation

The documentation is currently in preparation.  Much of Pegasus is documented in the PEGASUS PEPs which are the basis for approval of Pegasus functionality, changes, plans, etc.  These documents are openly available on the PEGASUS web site.  The preliminary documentation is not provided with this release. The current documentation is maintained both as a manual created under the tool DOC++ in the runtime subdirectory manual/html (see doc/devManual to create), as an api document also creatable from the source tree (see doc/apidoc) and as other miscellaneous documentation in the doc directory. Also there is a set of release notes. Normally the release notes for the current release are available in the root source directory of CVS.

Note that the Pegasus WEB site at The Open Group will be the source of most documentation in the future and today is the source of most discussion and design documentation.

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.