pegasus/README.html - diff

Return to README.html CVS log

Up to [Pegasus] / pegasus

Diff for /pegasus/README.html between version 1.6 and 1.6.8.1

version 1.6, 2009/01/13 18:27:33

version 1.6.8.1, 2011/10/11 18:17:08

Line 1

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

<head>

content="text/html; charset=windows-1252">

<title>OpenPegasus 2.6 README</title>

href="http://www.opengroup.org/stylesheets/info1+margins.css">

<style>

<!--

table.MsoNormalTable

Line 37

Line 40

DMTF CIM objects written in C++

and hosted by The Open Group

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a href="#avail_of_peg">Availability</a>

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

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

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

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

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

Line 45

Line 49

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

</blockquote>

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"><a href="#download">Download or Checkout</a>

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

href="#download">Download or Checkout</a>

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

<a href="#set_envt_var">Set the Environment Variables</a>

<a href="#bld_peg">Build the Executables</a>

Line 62

Line 67

Building with SSL</a>

</blockquote>

<a href="#test">Testing an OpenPegasus installation</a>

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

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

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

</blockquote>

<hr>

<h1><a name="Overview">OpenPegasus Overview</a>

Line 107

Line 113

functions.</li>

<li>More complete information on the exact functions

and their functional state is available from the Release Notes

(pegasus/ReleaseNotes.htm) and the OpenPegasus <a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">Feature

(pegasus/ReleaseNotes.htm) and the OpenPegasus <a

href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">Feature

Status Page</a>.</li>

</ol>

</blockquote>

Line 124

Line 131

Group.  OpenPegasus is maintained under the license defined in

the

doc

directory of this release.  The specific file is: pegasus/doc/license.txt.

directory of this release.  The specific file is: <font

style="color: rgb(0, 0, 0);">pegasus/doc/license.txt.

This licensing is intended to support as

wide a

distribution as possible with minimal demands on the users.

Line 132

Line 140

More information on this

project, access

to the CVS, and

documentation

documentation<span

style="text-decoration: line-through;">

is available

from the OpenPegasus

from the Ope<span

style="text-decoration: line-through;">nPegasus

web

site.

Line 167

Line 177

OpenPegasus can be obtained via any of the following:

<ol>

<li>Released tarballs (see <a href="http://www.openpegasus.org/page.tpl?CALLER=page.tpl&ggid=392">ZIP/GZ/EXE

<li>Released tarballs (see <a

href="http://www.openpegasus.org/page.tpl?CALLER=page.tpl&ggid=392">ZIP/GZ/EXE

link for this release</a>)</li>

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

<li>CVS (See <a

href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">CVS

code repository</a> for

more information)</li>

<li>Linux RPMs

(see <a href="http://www.openpegasus.org/page.tpl?CALLER=page.tpl&ggid=392">RPM

(see <a

href="http://www.openpegasus.org/page.tpl?CALLER=page.tpl&ggid=392">RPM

link for this release</a>)</li>

</ol>

CVS

<font

style="color: rgb(0, 0, 0);">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>)

Line 187

Line 201

variety of platforms by the

development group.  The results of the nightly tests can be

found

here on our <a href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly

here on our <a

Build and Test Status</a> page.  The Release Notes

href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly

Build and Test Status</a> page.  The Release Notes for each

release 

(pegasus/ReleaseNotes.htm) provide additional details

regarding the platforms for the current release.

regarding the platforms, compilers, etc. for the current release.

<h2><a name="peg_dep">Dependencies</a></h2>

Line 209

Line 225

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments. It is available from <a href="http://www.gnu.org">http://www.gnu.org</a>.

The windows version  of GNUMAKE is available on the Pegasus

web site <a href="http://www.openpegasus.org/pb/protected/index.tpl?CALLER=index.tpl">

web site <a

href="http://www.openpegasus.org/pb/protected/index.tpl?CALLER=index.tpl">

tools page</a>.</li>

<li>FLEX and BISON -

These tools were used to develop the MOF

Line 222

Line 239

is taken from a combination of text files and header files themselves.

This documentation is formatted with Doxygen and GAWK.  This

is required ONLY if you want to build documentation

from the source tree.  These tools are required to

from the source tree.  <font

style="color: rgb(0, 0, 0);">These tools are required to

build the

interface documentation set. </li>

<li>ICU Internationalization libraries -

Line 238

Line 256

<li>OpenSSL

- If it

is intended to use SSL on the

communication protocol, the OpenSSL libraries are required (<a href="http://www.openssl.org">http://www.openssl.org</a>).</li>

communication protocol, the OpenSSL libraries are required (<a

href="http://www.openssl.org">http://www.openssl.org</a>).</li>

<li>OpenSLP

- If you choose

to use

OpenSLP as your choice of SLP implementations, then it will need to be

installed and available to OpenPegasus. Refer to the

PEGASUS_USE_OPENSLP and PEGASUS_OPENSLP_HOME build variables in the

doc/BuildAndReleaseOptions.html file, and the OpenSLP web site (<a href="http://www.openslp.org">http://www.openslp.org</a>).</li>

doc/BuildAndReleaseOptions.html file, and the OpenSLP web site (<a

href="http://www.openslp.org">http://www.openslp.org</a>).</li>

<li>zlib

- If you choose to

enable the compressed repository feature with the

PEGASUS_ENABLE_COMPRESSED_REPOSITORY build variable, you will need to

install the gzip (GNU zip) compression utility. Refer to

readme.compressed_repository in OpenPegasus source tree, and the gzip

web site (<a style="color: rgb(204, 51, 204);" href="http://www.gzip.org">http://www.gzip.org</a>).</li>

web site (<a style="color: rgb(204, 51, 204);"

href="http://www.gzip.org">http://www.gzip.org</a>).</li>

<li>sqlite

- If you choose to enable the use of sqlite for the repository, refer

to the doc/BuildAndReleaseOptions.html file for the defintion of the

build variables and the sqlite implementation which may be obtained

either as part of a standard distribution or from <a href="http://www.sqlite.org">http://www.sqlite.org</a>.</li>

either as part of a standard distribution or from <a

href="http://www.sqlite.org">http://www.sqlite.org</a>.</li>

</ol>

NOTE:

A set of the required

tools for building on the Windows platform is available on the

OpenPegasus <a href="http://www.openpegasus.org/pb/index.tpl?CALLER=index.tpl">Tools</a>

OpenPegasus <a

href="http://www.openpegasus.org/pb/index.tpl?CALLER=index.tpl">Tools</a>

web page.

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

Line 277

Line 300

command,

invoke it with the "--help" option.

<div style="margin-left: 40px;">Some of

<div style="margin-left: 40px;">Some

the basic commands:

</div>

Line 339

Line 363

<li>The cimuser command is used to manage OpenPegasus users

only when

the CIM Server is compiled without the PEGASUS_PAM_AUTHENTICATION

environment variable defined. See <a href="http://www.openpegasus.org/pp/uploads/40/16781/PEP308_RecommendedReleaseOptions.htm">

environment variable defined. See <a

href="http://www.openpegasus.org/pp/uploads/40/16781/PEP308_RecommendedReleaseOptions.htm">

PEP 308</a> for more information on these configuration options.

</li>

</ol>

Line 348

Line 373

Much

OpenPegasus

is documented in the <a href="http://www.openpegasus.org/pp/index.tpl?CALLER=index.tpl">Pegasus

is documented in the <a

href="http://www.openpegasus.org/pp/index.tpl?CALLER=index.tpl">Pegasus

Enhancement Process (PEPs)</a> which are the basis for approval

OpenPegasus functionality, changes, plans, etc.  The approved

PEPs

are publicly available on the OpenPegasus web site.

are publicly available on the OpenPegasus web site.<span

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

Other

documentation available

Line 361

Line 388

from the

source tree, see pegasus/doc/apidoc) and other miscellaneous

documentation

in the doc directory. Also, there is a set of Release Notes for each

in the CVS doc directory and the pegasus CVS root as readme files.

Also, there is a set of Release Notes for each

release in the OpenPegasus root

source directory of CVS.

source directory of CVS and as a Pegasus PEP.

The <a href="http://www.openpegasus.org/">OpenPegasus web

site</a> will be the source

of most

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

and

design documentation.

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

Contributors

are welcome to participate in the OpenPegasus development effort. Join

the mailing list by going to the <a href="http://www.openpegasus.org/mailinglists.tpl?CALLER=index.tpl">Mailing

the mailing list by going to the <a

href="http://www.openpegasus.org/mailinglists.tpl?CALLER=index.tpl">Mailing

Lists</a> web page from the OpenPegasus site.

<h1>

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

Line 383

Line 406

If you want to install

pre-built Pegasus

executables instead of building from source code, then refer to the <a href="http://www.openpegasus.org/pr/">RPM installation

executables instead of building from source code, then refer to the <a

href="http://www.openpegasus.org/pr/">RPM installation

instructions</a>.

<h2><a name="vfy_req_sw"></a>Verify

Dependencies</h2>

Dependencies<span

Before

style="font-weight: normal;"></h2>

<span

style="font-weight: normal;">Before

you build, install, or run OpenPegasus, be sure you have the proper set

of software

it depends on.  Refer to the section <a href="#peg_dep">Dependencies</a>

Line 415

Line 441

that will contain all output from building and running OpenPegasus, it

can be the same as PEGASUS_ROOT if desired.</li>

<li>PEGASUS_PLATFORM -- The

platform on which OpenPegasus is being built.

platform on which OpenPegasus is being built.</li>

</li>

</ul>

<div style="margin-left: 40px;">There are a significant number of

environment variables that control the compile and test of features in

the OpenPegasus package in addition to the 3 variables described above.

These variables are documented in the Pegasus documentation in CVS (see

the pegasus/doc directory).</div>

<h2><a name="bld_peg"></a>Build the Executables

</h2>

<div style="margin-left: 40px;">OpenPegasus

is compiled and linked using a make structure that recurses through

the  OpenPegasus source tree.

<span

style="color: rgb(0, 0, 0); font-weight: bold;">

Makefile commands

Line 451

Line 482

<li>alltests - Builds the

repository entries and other resources required by the tests, and then

executes all automated tests.</li>

<li>world - Builds the complete environment and runs the test suite.</li>

</ul>

For a comprehensive

list of  the

make targets, refer to <big>pegasus/Makefile</big>

make targets, refer to <big><span

style="font-family: Courier New,Courier,monospace;">pegasus/Makefile</big>

at the top of the OpenPegasus source directory.

</div>

<ul>

Line 471

Line 504

cimmof compiler.

The 'make repository' target

in the makefile <big>pegasus/Makefile</big>

in the makefile <big><span

style="font-family: Courier New,Courier,monospace;">pegasus/Makefile</big>

performs several functions including:

<ul>

Line 492

Line 526

(SNMP, Events, Alert, Threshold, etc)

internal to Pegasus. </li>

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

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

libDNSProvider.so, … ) in OpenPegasus (which are located in

src/Providers)

</li>

</ul>

Line 501

Line 535

OpenPegasus registers

Providers using a

set of provider registration classes

encoded in MOF. This set of classes is close

encoded in MOF. This classes are proprietary to OpenPegasus

to, but not

today.

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 schema is moved to final

status.

Registration

is performed by creating instances of the

registration classes that represent the provider module, providers,

capabilities, 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 <big>pegasus/src/Providers/sample/Load</big>

MOFs.  See the <big><span

style="font-family: Courier New,Courier,monospace;">pegasus/src/Providers/sample/Load</big>

directory for examples of

several registration instance implementations that do work with

OpenPegasus

today.

Registration may be performed by creating

compiling the registration mof with either the on-line or off-line

Pegasus mof compiler.  It is recommended that providers be

registered with the on-line compiler because this allows pegasus to

validate the registration information.

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

Building on Linux </a></h2>

Line 534

Line 569

PEGASUS_PLATFORM is normally LINUX_IX86_64_GNU.  Use the g++

compiler to compile and link the executables. All of the supported

platform

definitions are defined in <big>pegasus/mak</big>

definitions are defined in <big><span

style="font-family: Courier New,Courier,monospace;">pegasus/mak</big>

as  make files with the

definition:

<span

style="font-family: monospace;">   

platform_<operatingSystem>_<architecture>_<compiler>

The

Line 550

Line 587

Use of Windows 2000 SP3 or later is recommended.  OpenPegasus

regularly tested on both Windows 2000 and Windows XP using the

regularly tested on mulitple windows platforms.

Microsoft Visual C++ compilers.

We build OpenPegasus

Today we build OpenPegasus

on Windows

using a set of Makefiles

contained

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

not supported, Visual Studio 6.0 (SP5) or later is supported) and the

GNUMAKE

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

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

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

available

before trying to compile OpenPegasus on the normal windows platform.

before trying to compile OpenPegasus on the normal windows platform

(This utility allows use of unix command line semantics for certain

operations in windows).

The

following is the basic setup steps for the environment.

Line 576

Line 615

following for an

example environment:

<pre style="margin-left: 40px;">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 to compile in debug mode set PEGASUS_DEBUG=true REM set PEGASUS_ROOT to top of source tree set PEGASUS_ROOT=C:/cimom/pegasus REM (Note: The '/' characters are intentional and required by the OpenPegasus build system). REM Also the disk designator (C:) is required for at least some newer versions of the Microsoft REM  compilers to avoid confusion between options and paths REM set PEGASUS_HOME to where you want repository and executables, it can be the same as PEGASUS_ROOT set PEGASUS_HOME=%PEGASUS_ROOT% REM set PEGASUS_PLATFORM for Windows set PEGASUS_PLATFORM=WIN32_IX86_MSVC REM setup the path to the runtime files. set path=%path%;%PEGASUS_HOME%\bin </pre>

<pre style="margin-left: 40px;">REM call the standard Microsoft .bat for VC 6 setup. <br

style="font-family: monospace;">call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat' <br

style="font-family: monospace;">REM Set debug to something if you want to compile in debug mode <br

style="font-family: monospace;">set PEGASUS_DEBUG=true <br

style="font-family: monospace;">REM set PEGASUS_ROOT to top of source tree <br

style="font-family: monospace;">set PEGASUS_ROOT=C:/cimom/pegasus <br

style="font-family: monospace;">REM (Note: <span

style="font-family: monospace;" class="norm">The '/' characters are intentional and required by the OpenPegasus build system). REM Also the disk designator (C:) is required for at least some newer versions of the Microsoft REM  compilers to avoid confusion between options and paths <span

style="font-family: monospace;">REM set PEGASUS_HOME to where you want repository and executables, it can be the same as PEGASUS_ROOT<br

style="font-family: monospace;">set PEGASUS_HOME=%PEGASUS_ROOT% <br

style="font-family: monospace;">REM set PEGASUS_PLATFORM for Windows<br

style="color: rgb(255, 0, 0); font-family: monospace;"><span

style="font-family: monospace;">set PEGASUS_PLATFORM=WIN32_IX86_MSVC<br

style="font-family: monospace;">REM setup the path to the runtime files. <br

style="font-family: monospace;">set path=%path%;%PEGASUS_HOME%\bin </pre>

</blockquote>

<h3>

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

Line 605

Line 658

(expansion of wildcards) so

you can do things like this:

<span

style="font-family: monospace;">

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

MU is required to build

under the Windows

Line 613

Line 667

available as part

of the distribution of OpenPegasus.

<div style="margin-left: 40px;">NOTE: The binary for

<div style="margin-left: 40px;">NOTE:

The binary for

MU.EXE is not

distributed in the OpenPegasus bin

directory.

Line 622

Line 677

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 <a href="http://www.openpegasus.org/pb/index.tpl?CALLER=index.tpl">Tools</a>

available as a zip file on the OpenPegasus <a

href="http://www.openpegasus.org/pb/index.tpl?CALLER=index.tpl">Tools</a>

web page.

</div>

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

Line 759

Line 815

<li>make alltests - execute both the

unit and end-to-end tests.</li>

</ul>

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

ICU (International

Components for

Line 852

Line 907

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<hr>

</body></html>

</body>

</html>

Legend:

Removed from v.1.6
changed lines
	Added in v.1.6.8.1

No CVS admin address has been configured