Pegasus Enhancement Proposal (PEP)
PEP #: 175
Title: OpenPegasus Version 2.4 Release Readme file
Version: 1.4
Created: 24 June 2004
Authors: Warren
Grunbok, Mike Harris
Status: draft
Version History:
| Version | Date | Author | Change Description |
|---|---|---|---|
| 1.0 | 24, June 2004 | Warren Grunbok |
Initial draft |
| 1.1 | 24,August 2004 |
Warren Grunbok |
Mostly spelling changes, adds to very last paragraph |
| 1.2 |
31, August 2004 |
Warren Grunbok |
Changes based on architecture
review. Removed /Directory structure section and placed
into seperate document. |
| 1.3 |
??? |
Warren Grunbok |
Removed Pegasus Directory
structure and placed in PEP 191, Added Copyright and End of Doc marker. |
| 1.4 |
27,
Sept 2004 |
Warren
Grunbok |
Corrected
Security changes as per Sterling. |
Abstract: Installation, build, operation information on the Pegasus Platform Version 2.4.0 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 Sept 2004 for Pegasus release version
2.4.0
- Approved
Availability of PegasusInstall Pegasus
Pegasus Major Components
Availability of Pegasus
Pegasus Supported Platforms
Pegasus Dependencies
The Pegasus Directory Structure
Development with Pegasus and Pegasus Tools
Commands
Documentation
Participate
Download or checkout PegasusTest the Pegasus installation
Verify that you have the required software
Set the environment variables
Build the Pegasus runtime, test files, test clients, and repository
Populate the Pegasus repository
Register providers in the Pegasus environment
Build an RPM for Pegasus
Notes about Building Pegasus on Linux
Notes on building Pegasus with SSL
Creating SSL certificationsBuilding Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++
The MU Utility
Installing the Pegasus HTML Test Client
Testing with ICU enabled
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.
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 |
| 2.4 |
PEP 185 |
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.
The major components of Pegasus are:
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).
Pegasus is supported on a variety of platforms. The list of
platforms can be found in the release notes associated with this
release.
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 :
NOTE: A set of the required
tools for windows platforms is available on the openpegasus web
site. www.openpegasus.org
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.
Pegasus is distributed as a complete source directory structure that should be installed either from one of the snapshots or from CVS.
The Pegasus Directory is documented in PEP 191 and listed in the Pegasus /doc directory.ATTN: This section needs to be completed. It should reference the more complete documentation.
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)
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.
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.
You can install and run Pegasus on any of the supported platforms. The installation process includes the following steps:
Step 1: Download or checkout Pegasus
Pegasus is freely available from the open group's Pegasus home page: http://www.openpegasus.org. To 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: Availability of Pegasus.
Pegasus is not currently releasing binaries, but you can create RPMs using a script included with the source distribution. See Building RPMs for Pegasus for more information.
Step 2: Verify that you have the required software
Refer to the section Pegasus Dependencies and verify that you have the software required for your Operating System and planned usage of Pegasus.
Step 3: Set the environment variables
Before installing or running Pegasus, ensure that the following environment variables have been defined or updated:
The following values are tested for the OpenPegasus release:
Additional configuration:
Step 4: Build the Pegasus runtime, test files, test clients and repository
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:
This builds all of Pegasus.
This creates the repository, which is needed to serve data. To create the additional namespaces that represent the test support you can also execute "make testrepository".
This executes all the tests included with the Pegasus distribution, except the client/server tests. The client/server tests are executed separately from the above because they require the initiation of separate process for the Pegasus server and Pegasus client. To execute these tests, refer to the scripts in pegasus/mak/BuildMakefile. Refer to the prestarttests and poststarttests in this file.
The following make targets are supported:
Generally the build commands are as follows:
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.
The providers included with Pegasus are automatically entered into the repository by running the following command: make repository
The 'make repository' in pegasus/Schemas does three things:
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 source distribution includes a script you can use to create an RPM for Pegasus. To do this, your environment must meet the following requirements:
To create the RPMs, run the script rpmBuild from the root directory of the source distribution. For example: . /usr/source/pegasus-1.0/rpmBuild
This will result in and RPM file names pegasus<version number>.rpm.
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).Pegasus supports many distributions of Linux. Refer to Pegasus Supported Platforms 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.
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 (Note: 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
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.
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 "Creating SSL certificates" below for more information on how to use SSL.
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.
Set the sslKeyFilePath to
key.pem. Set the sslCertificateFilePath to cert.pem. To
create a client truststore to validate the server against, copy the
server's certificate into the client truststore, client.pem.
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
Note: key.pem is sslKeyFilePath. cert.pem is sslCertificateFilePath
Pegasus includes an extensive set of test facilities as part of the CVS enviroment, including:
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.
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.
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.
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.
-------------------------------------------------------------------------------------------------------------------------------------
Copyright (c) 2004 EMC Corporation;
Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group;
VERITAS Software Corporation
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE
SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE
SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------End
of
Document-------------------------