pegasus/README.html - diff

Return to README.html CVS log

Up to [Pegasus] / pegasus

Diff for /pegasus/README.html between version 1.2 and 1.3

version 1.2, 2007/10/03 19:56:07

version 1.3, 2008/07/17 15:48:13

Line 9

<title>OpenPegasus 2.6 README</title>

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

<style>

<!--

table.MsoNormalTable

{mso-style-parent:"";

font-size:10.0pt;

font-family:"Times New Roman"}

-->

</style>

</head>

<body>

<hr>

<p><b>Abstract:</b>  Installation, build, and operation

information on

the OpenPegasus Version 2.7.0

the OpenPegasus Version 2.8.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 authoritative. This is a simplified

overview to act as an

introduction to OpenPegasus.</p>

<hr>

<p align="center"><b><font size="5">OpenPegasus - A Manageability

Services Broker for the DMTF CIM/WBEM Standards

Line 77

Line 86

<br>

<span class="norm"></span>OpenPegasus includes components for: <br>

</div>

<li>A DMTF compliant CIM Server that processes CIM operations, CIM

Indications, and

Line 94

Line 104

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

(pegasus/ReleaseNotes.htm) and the OpenPegasus

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

Status Page</a>.</li>

</ol>

</blockquote>

<div style="margin-left: 40px;">OpenPegasus is open source and is

covered under the MIT open-source

license.

Line 128

Line 140

<p style="margin-left: 40px;">Note

that all references in this readme to files in the OpenPegasus source

tree are of the form pegasus/..., where "pegasus" is the top-level

directory and also the name of the OpenPegasus module in CVS.<br>

directory and also the name of the OpenPegasus module in the Pegasus CVS

repository. There are also  other CVS modules for the OpenPegasus Java client (pegasus-JavaCIMClient)

and for unsupported components and utilities for Pegasus that may be checked out

separately.  You can use

<a href="http://cvs.opengroup.org/cgi-bin/viewcvs.cgi/">viewCVS</a> to view the

Pegasus CVS tree<br>

</p>

<h2><a name="avail_of_peg">Availability</a></h2>

<div style="margin-left: 40px;">OpenPegasus is distributed as open

Line 167

Line 184

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

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

(pegasus/ReleaseNotes.htm) provide additional details

regarding the platforms.<br>

regarding the platforms for the current release.<br>

</p>

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

Line 182

Line 199

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

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

</li>

The windows version  of GNUMAKE is available on the Pegasus web site

tools page</a>.</li>

<li><b>FLEX</b> and <b>BISON</b> - These tools were used to develop the MOF

compiler and WQL parser.  These tools are required only for

compiler and WQL and CQL parsers.  These tools are required <b>ONLY</b> for

development of the parsers, not for building OpenPegasus.  Bison

version 2.3 or later and flex version 2.5.4 or later are required.</li>

<li><b>DOC++ </b>- The OpenPegasus documentation is taken from a

<li><b>Doxygen </b>- The OpenPegasus documentation is taken from a combination

combination of text files

of text files and header files themselves. This documentation is formatted

and header files themselves. This documentation is

with Doxygen and GAWK.  This is required <b>ONLY</b> if you want to

formatted with DOC++ and GAWK.   <span class="norm"></span><font

build documentation from the source tree.  <span class="norm"></span><font

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

interface documentation set.</font> </li>

<li><b>ICU Internationalization libraries</b> - These libraries are

Line 198

Line 217

internationalization. See the ICU website

(<a href="http://icu.sourceforge.net/">http://icu.sourceforge.net</a>)

for more information on these

libraries.<span style="color: rgb(255, 0, 0);"></span><br>

libraries.<span style="color: rgb(255, 0, 0);"> These libraries are use ONLY if

you set the requisite environment variable ( PEGASUS_HAS_ICU) to use ICU</span><br>

</li>

<li><span style="font-weight: bold;"></span><b>OpenSSL </b>- If it

is intended to use SSL on the

Line 228

Line 248

</p>

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

Pegasus includes the server which can be controlled from the command line and a

set of clients that provide adminstrative functions</p>

The manpages for each of the commands are in the pegasus/rpm/manLinux/

directory (from CVS). </p>

<p style="margin-left: 40px;">To see simple help for each command,

Line 249

Line 272

<li>cimserver traceLevel=4 traceComponents=ALL  (Starts server

with

config flags)</li>

</ul>

<ul>

<li>cimprovider -l -s  (Lists providers and their status)</li>

<li>cimprovider -e -m OperatingSystemModule  (Enables the

OperatingSystem provider)</li>

<li>cimuser -a -u guest _w <ThePassword> (Adds the user <span

<li>cimuser -a -u guest _w <ThePassword> (Adds the user

style="font-style: italic;">guest</span> with specified password)<br>

<span

</li>

style="font-style: italic;">guest</span> with specified password)<br></li>

<li>cimuser -l  (Lists the users )</li>

<li>cimconfig -l -c (Lists the

current config options and their current values)<br>

current config options and their current values)<br></li>

</li>

</ul>

<div style="margin-left: 40px;"><span style="font-weight: bold;">NOTE</span>:

<div style="margin-left: 40px;"><span style="font-weight: bold;">NOTES</span>:

<br>

</div>

<li>Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf

for

Line 281

Line 306

explains the

exact format of the start and stop options.</li>

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

the CIM Server is compiled without the PEGASUS_PAM_AUTHENTICATION

the CIM Server is compiled without the PEGASUS_PAM_AUTHENTICATION environment

environment variable defined. See PEP

variable defined. See

292 for more information.<br>

</li>

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

</ol>

</blockquote>

<font><font color="RED"><span style="color: rgb(0, 0, 0);"></span></font></font><span

style="font-family: monospace;"></span>

<h2><a name="docs">Documentation</a></h2>

Line 307

Line 333

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

documentation

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

release in the pegasus root

release in the OpenPegasus root

source directory of CVS.</p>

<p style="margin-left: 40px;">Note that the <a

<p style="margin-left: 40px;">The <a

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

site</a> will be the source

of most

Line 355

Line 381

<ul>

<li>PEGASUS_ROOT -- The directory

containing the pegasus root directory from CVS.</li>

containing the OpenPegasus root directory from CVS.</li>

<li>PEGASUS_HOME -- The directory

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

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

Line 367

Line 393

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

</h2>

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

is compiled and linked using a make structure that recurses through the

source tree.<br>

OpenPegasus source tree.<br>

<font><font color="RED"><span

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

Makefile commands

Line 436

Line 462

repository (if one exists).</span><br>

</li>

<li>Generates the default

CIM Schema (currently v2.13.1)

CIM Schema (defined in pegasus/mak/config.mak)

in the repository (skeleton of CIM

objects).  Refer to

objects).  Refer to PEGASUS_CIM_SCHEMA environment variable  in 

PEGASUS_CIM_SCHEMA in PEP 292 for alternate versions.<br>

Pegasus PEP 308  to set  alternate schema versions.<br>

</li>

<li>Loads

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

Line 480

Line 506

environment

variables set (eg. PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM). 

For

32 bit linux, the definition of PEGASUS_PLATFORM is normally

32 bit Linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU. Use the g++

LINUX_IX86_GNU.   For 64 bit IX86  Linux the definition of

compiler to compile and link the executables.<br>

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 pegasus/mak as  make files with the definition

platform_<operatingSystem>_<architecture>_<compiler>. The <operatingSystem>_<architecture>_<compiler>

component is what forms the PEGASUS_PLATFORM environment variable so that the

appropriate platform make file can be found during the build process.<br>

</p>

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

about Building on Windows </a></h2>

Line 574

Line 605

for more details on build variables).<br>

</p>

<p style="margin-left: 40px;">You

must also have the PEGASUS_HAS_SSL variable defined. Then when you

must also have the PEGASUS_HAS_SSL environment variable defined. Then when you

build

OpenPegasus, it

will include the SSL support.

Line 627

Line 658

directory). Unit tests are executed with the CIM Server shutdown and

normally do not require the existence of class definitions in the

repository. </li>

<li><b>An end-to-end Test Suite</b> - the directory "test" contains

<li><b>End-to-end Test Suite</b> - the directory "test" contains

set of operatio<span

style="color: rgb(255, 0, 0); text-decoration: line-through;"></span>n

Line 638

Line 669

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

</ul>

<p>          Once OpenPegasus is

successfully built, the  tests can be executed through the root Makefile

with targets such as:</p>

<ul>

<li><b>make unittests </b>- Execute the unit tests. These do not depend

on having a running server or repository installed.  They test

components of the OpenPegasus code. These tests run to completion if

successful but normally stop on the first error found by a test

program.</li>

<li><b>make servertests</b> - Executes the OpenPegasus end-to-end test

suite against a running OpenPegasus server starting and stopping the

server as required to modify configuration parameters. The

repository must be installed for these tests to execute and they are

tested against the default repository as part of regular OpenPegasus

development and release testing. These tests will run to successful

completion if there are not errors detected but will normally stop

on the first error.  There is a subset of these tests that can

be run in an environment that does not have root privileges but root

privileges are required to run the complete suite.</li>

<li><b>make alltests</b> - execute both the unit and end-to-end tests.</li>

</ul>

</blockquote>

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

<p style="margin-left: 40px;">ICU (International Components for

Unicode) refers to the set of

Legend:

Removed from v.1.2
changed lines
	Added in v.1.3

No CVS admin address has been configured