version 1.1, 2007/01/05 19:46:56
|
version 1.4, 2008/12/16 18:55:33
|
|
|
<title>OpenPegasus 2.6 README</title> | <title>OpenPegasus 2.6 README</title> |
<link rel="stylesheet" | <link rel="stylesheet" |
href="http://www.opengroup.org/stylesheets/info1+margins.css"> | 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> | </head> |
<body> | <body> |
<hr> | <hr> |
<p><b>Abstract:</b> Installation, build, and operation | <p><b>Abstract:</b> Installation, build, and operation |
information on | information on |
the OpenPegasus Version 2.6.0 |
the OpenPegasus Version 2.8.0 |
Release. Note that if this readme | Release. Note that if this readme |
conflicts with the documentation in the release notes or interface | conflicts with the documentation in the release notes or interface |
definition documents for a particular release, those documents should | definition documents for a particular release, those documents should |
be considered authoritative. This is a simplified | be considered authoritative. This is a simplified |
overview to act as an | overview to act as an |
introduction to OpenPegasus.</p> | introduction to OpenPegasus.</p> |
|
|
<hr> | <hr> |
<p align="center"><b><font size="5">OpenPegasus - A Manageability | <p align="center"><b><font size="5">OpenPegasus - A Manageability |
Services Broker for the DMTF CIM/WBEM Standards | Services Broker for the DMTF CIM/WBEM Standards |
|
|
<br> | <br> |
<span class="norm"></span>OpenPegasus includes components for: <br> | <span class="norm"></span>OpenPegasus includes components for: <br> |
</div> | </div> |
|
<blockquote> |
<ol style="margin-left: 40px;"> | <ol style="margin-left: 40px;"> |
<li>A DMTF compliant CIM Server that processes CIM operations, CIM | <li>A DMTF compliant CIM Server that processes CIM operations, CIM |
Indications, and | Indications, and |
|
|
and administrative | and administrative |
functions.</li> | functions.</li> |
<li>More complete information on the exact functions | <li>More complete information on the exact functions |
and their functional state is available from the release notes for each |
and their functional state is available from the Release Notes |
OpenPegasus release, and at the OpenPegasus <a |
(pegasus/ReleaseNotes.htm) and the OpenPegasus |
|
<a |
href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">Feature | href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">Feature |
Status Page</a>.</li> | Status Page</a>.</li> |
</ol> | </ol> |
|
</blockquote> |
<div style="margin-left: 40px;">OpenPegasus is open source and is | <div style="margin-left: 40px;">OpenPegasus is open source and is |
covered under the MIT open-source | covered under the MIT open-source |
license. | license. |
|
|
<p style="margin-left: 40px;">Note | <p style="margin-left: 40px;">Note |
that all references in this readme to files in the OpenPegasus source | that all references in this readme to files in the OpenPegasus source |
tree are of the form pegasus/..., where "pegasus" is the top-level | 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> | </p> |
<h2><a name="avail_of_peg">Availability</a></h2> | <h2><a name="avail_of_peg">Availability</a></h2> |
<div style="margin-left: 40px;">OpenPegasus is distributed as open | <div style="margin-left: 40px;">OpenPegasus is distributed as open |
|
|
development group. The results of the nightly tests can be found | development group. The results of the nightly tests can be found |
here on our <a | here on our <a |
href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly | href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly |
Build and Test Status</a> page. The Release Notes provide |
Build and Test Status</a> page. The Release Notes |
additional details |
(pegasus/ReleaseNotes.htm) provide additional details |
regarding the platforms. |
regarding the platforms for the current release.<br> |
PEP 287 contains the Release Notes for the 2.6.0 release.<br> |
|
</p> | </p> |
<h2><a name="peg_dep">Dependencies</a></h2> | <h2><a name="peg_dep">Dependencies</a></h2> |
<p style="margin-left: 40px;"> | <p style="margin-left: 40px;"> |
|
|
have standardized on a set of build tools including: GNUMAKE. We are | have standardized on a set of build tools including: GNUMAKE. We are |
using GNUMAKE 3.79.1 successfully both in Windows and Linux | 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>. | 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 |
<li><b>FLEX </b>and<b> BISON</b> - These tools were used to develop |
<a href="http://www.openpegasus.org/pb/protected/index.tpl?CALLER=index.tpl"> |
the |
tools page</a>.</li> |
MOF |
<li><b>FLEX</b> and <b>BISON</b> - These tools were used to develop the MOF |
compiler and WQL |
compiler and WQL and CQL parsers. These tools are required <b>ONLY</b> for |
parser. <font style="color: rgb(0, 0, 0);">These tools are |
development of the parsers, not for building OpenPegasus. Bison |
required only for |
version 2.3 or later and flex version 2.5.4 or later are required.</li> |
development of the parsers, not for building OpenPegasus.</font></li> |
<li><b>Doxygen </b>- The OpenPegasus documentation is taken from a combination |
<li><b>DOC++ </b>- The OpenPegasus documentation is taken from a |
of text files and header files themselves. This documentation is formatted |
combination of text files |
with Doxygen and GAWK. This is required <b>ONLY</b> if you want to |
and header files themselves. This documentation is |
build documentation from the source tree. <span class="norm"></span><font |
formatted with DOC++ and GAWK. <span class="norm"></span><font |
|
style="color: rgb(0, 0, 0);">These tools are required to build the | style="color: rgb(0, 0, 0);">These tools are required to build the |
interface documentation set.</font> </li> | interface documentation set.</font> </li> |
<li><b>ICU Internationalization libraries</b> - These libraries are | <li><b>ICU Internationalization libraries</b> - These libraries are |
|
|
internationalization. See the ICU website | internationalization. See the ICU website |
(<a href="http://icu.sourceforge.net/">http://icu.sourceforge.net</a>) | (<a href="http://icu.sourceforge.net/">http://icu.sourceforge.net</a>) |
for more information on these | 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> |
<li><span style="font-weight: bold;"></span><b>OpenSSL </b>- If it | <li><span style="font-weight: bold;"></span><b>OpenSSL </b>- If it |
is intended to use SSL on the | is intended to use SSL on the |
|
|
OpenSLP as your choice of SLP implementations, then it will need to be | OpenSLP as your choice of SLP implementations, then it will need to be |
installed and available to OpenPegasus. Refer to the | installed and available to OpenPegasus. Refer to the |
PEGASUS_USE_OPENSLP and PEGASUS_OPENSLP_HOME build variables in PEP | PEGASUS_USE_OPENSLP and PEGASUS_OPENSLP_HOME build variables in PEP |
277, and the OpenSLP web site (<a href="http://www.openslp.org">http://www.openslp.org</a>).</li> |
292, and the OpenSLP web site (<a href="http://www.openslp.org">http://www.openslp.org</a>).</li> |
<li><span style="font-weight: bold;">zlib</span> - If you choose to | <li><span style="font-weight: bold;">zlib</span> - If you choose to |
enable the compressed repository feature with the | enable the compressed repository feature with the |
PEGASUS_ENABLE_COMPRESSED_REPOSITORY build variable, you will need to | PEGASUS_ENABLE_COMPRESSED_REPOSITORY build variable, you will need to |
|
|
</p> | </p> |
<h2><a name="cmnd">Commands</a></h2> | <h2><a name="cmnd">Commands</a></h2> |
<p style="margin-left: 40px;"> | <p style="margin-left: 40px;"> |
|
Pegasus includes the server which can be controlled from the command line and a |
|
set of clients that provide adminstrative functions</p> |
|
<p style="margin-left: 40px;"> |
The manpages for each of the commands are in the pegasus/rpm/manLinux/ | The manpages for each of the commands are in the pegasus/rpm/manLinux/ |
directory (from CVS). </p> | directory (from CVS). </p> |
<p style="margin-left: 40px;">To see simple help for each command, | <p style="margin-left: 40px;">To see simple help for each command, |
|
|
<li>cimserver traceLevel=4 traceComponents=ALL (Starts server | <li>cimserver traceLevel=4 traceComponents=ALL (Starts server |
with | with |
config flags)</li> | config flags)</li> |
|
</ul> |
|
<ul> |
<li>cimprovider -l -s (Lists providers and their status)</li> | <li>cimprovider -l -s (Lists providers and their status)</li> |
<li>cimprovider -e -m OperatingSystemModule (Enables the | <li>cimprovider -e -m OperatingSystemModule (Enables the |
OperatingSystem provider)</li> | 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>cimuser -l (Lists the users )</li> |
<li>cimconfig -l -c (Lists the | <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> | </ul> |
</ul> | </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> | <br> |
</div> | </div> |
|
<blockquote> |
<ol style="margin-left: 40px;"> | <ol style="margin-left: 40px;"> |
<li>Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf | <li>Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf |
for | for |
|
|
explains the | explains the |
exact format of the start and stop options.</li> | exact format of the start and stop options.</li> |
<li>The cimuser command is used to manage OpenPegasus users only when | <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 |
277 for more information.<span style="color: rgb(204, 51, 204);"></span><br> |
<a href="http://www.openpegasus.org/pp/uploads/40/16781/PEP308_RecommendedReleaseOptions.htm"> |
</li> |
PEP 308</a> for more information on these configuration options.<br></li> |
</ol> | </ol> |
|
</blockquote> |
<font><font color="RED"><span style="color: rgb(0, 0, 0);"></span></font></font><span | <font><font color="RED"><span style="color: rgb(0, 0, 0);"></span></font></font><span |
style="font-family: monospace;"></span> | style="font-family: monospace;"></span> |
<h2><a name="docs">Documentation</a></h2> | <h2><a name="docs">Documentation</a></h2> |
|
|
source tree, see pegasus/doc/apidoc) and other miscellaneous | source tree, see pegasus/doc/apidoc) and other miscellaneous |
documentation | documentation |
in the doc directory. Also, there is a set of Release Notes for each | 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> | 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 | href="http://www.openpegasus.org/">OpenPegasus web |
site</a> will be the source | site</a> will be the source |
of most | of most |
|
|
Variables</strong></a></h2> | Variables</strong></a></h2> |
<p style="margin-left: 40px;">Before building, installing, or running | <p style="margin-left: 40px;">Before building, installing, or running |
OpenPegasus, some environment variables may | OpenPegasus, some environment variables may |
have to be defined or updated. See PEP 277 for the full list of |
have to be defined or updated. See PEP 292 for the full list of |
environment variables and configuration options for OpenPegasus. The | environment variables and configuration options for OpenPegasus. The |
minimum set is:<br> | minimum set is:<br> |
</p> | </p> |
<ul> | <ul> |
<ul> | <ul> |
<li>PEGASUS_ROOT -- The directory | <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 | <li>PEGASUS_HOME -- The directory |
that will contain all output from building and running OpenPegasus, it | that will contain all output from building and running OpenPegasus, it |
can be the same as PEGASUS_ROOT if desired.</li> | can be the same as PEGASUS_ROOT if desired.</li> |
|
|
<h2><a name="bld_peg"></a>Build the Executables<br> | <h2><a name="bld_peg"></a>Build the Executables<br> |
</h2> | </h2> |
<div style="margin-left: 40px;">OpenPegasus | <div style="margin-left: 40px;">OpenPegasus |
is compiled and linked using a make structure that recurses through the |
is compiled and linked using a make structure that recurses through the |
source tree.<br> |
OpenPegasus source tree.<br> |
<font><font color="RED"><span | <font><font color="RED"><span |
style="color: rgb(0, 0, 0); font-weight: bold;"><br> | style="color: rgb(0, 0, 0); font-weight: bold;"><br> |
Makefile commands | Makefile commands |
|
|
repository (if one exists).</span><br> | repository (if one exists).</span><br> |
</li> | </li> |
<li>Generates the default | <li>Generates the default |
CIM Schema (currently v2.9) |
CIM Schema (defined in pegasus/mak/config.mak) |
in the repository (skeleton of CIM | in the repository (skeleton of CIM |
objects). Refer to |
objects). Refer to PEGASUS_CIM_SCHEMA environment variable in |
PEGASUS_CIM_SCHEMA in PEP 277 for alternate versions.<br> |
Pegasus PEP 308 to set alternate schema versions.<br> |
</li> | </li> |
<li>Loads | <li>Loads |
schema for CIM Server functions (shutdown, add users, etc) and | schema for CIM Server functions (shutdown, add users, etc) and |
|
|
environment | environment |
variables set (eg. PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM). | variables set (eg. PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM). |
For | 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> | </p> |
<h2><a name="bld_peg_win">Notes | <h2><a name="bld_peg_win">Notes |
about Building on Windows </a></h2> | about Building on Windows </a></h2> |
|
|
directory so OpenPegasus can find them. If that's not | directory so OpenPegasus can find them. If that's not |
the case, set the environment variable OPENSSL_HOME= to point where | the case, set the environment variable OPENSSL_HOME= to point where |
your OpenSSL | your OpenSSL |
installation is (refer to PEP 277 |
installation is (refer to PEP 292 |
for more details on build variables).<br> | for more details on build variables).<br> |
</p> | </p> |
<p style="margin-left: 40px;">You | <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 | build |
OpenPegasus, it | OpenPegasus, it |
will include the SSL support. | will include the SSL support. |
|
|
directory). Unit tests are executed with the CIM Server shutdown and | directory). Unit tests are executed with the CIM Server shutdown and |
normally do not require the existence of class definitions in the | normally do not require the existence of class definitions in the |
repository. </li> | 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 |
a | a |
set of operatio<span | set of operatio<span |
style="color: rgb(255, 0, 0); text-decoration: line-through;"></span>n | style="color: rgb(255, 0, 0); text-decoration: line-through;"></span>n |
|
|
tests and compares the results against predefined results.</li> | tests and compares the results against predefined results.</li> |
</ul> | </ul> |
</ul> | </ul> |
|
<p> Once OpenPegasus is |
|
successfully built, the tests can be executed through the root Makefile |
|
with targets such as:</p> |
|
<blockquote> |
|
<blockquote> |
|
<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> |
|
</blockquote> |
<h2><a name="test_icu">Testing with ICU enabled</a></h2> | <h2><a name="test_icu">Testing with ICU enabled</a></h2> |
<p style="margin-left: 40px;">ICU (International Components for | <p style="margin-left: 40px;">ICU (International Components for |
Unicode) refers to the set of | Unicode) refers to the set of |