Pegasus Enhancement Proposal (PEP)

PEP #: 083

Title: Release Notes, Pegasus 2.2

Version: 1.4

Created: 6 June 2003

Authors: Karl Schopmeyer

Status:  Accepted

Version History:

Abstract: This document defines the release notes that are available with the Pegasus 2.2 release.

Availability of the Pegasus 2.2 Release

The Pegasus 2.2 release is available as a source release in both ZIP and TAR formats.  The release can be downloaded from the OpenPegaus Web site at www.openpegasus.org.

In addition, the release is available through Pegasus CVS as the branch tag RELEASE_2_2_0-branch. This defines the current released version of Pegasus 2.2 . In addition, the following tags exist for the release. RELEASE_2_2_0-root which defines the initial release point of Pegasus 2.2 and the point at which it branched from the trunk.. Other tags may exist to mark release candidate snapshots, etc.  These will be announced on the web site and the Pegasus mailing list.

The instructions for acquiring the released code are on the WEB site.  Installation instructions are part of the readme in the root of the source tree.

The OpenPegasus project is currently not providing binary releases.  However, binary releases may be available of selected ports and are documented on the OpenPegasus web site.

There may be point releases to the Pegasus 2.2 release and these will be announced on the Pegasus web site.

Functionality Level of OpenPegaus 2.2 Release

The overall level of functionality in the Pegasus environment is as follows:

CIM Server

CIM Operations

1.     Class Operations (get, delete, modify, enumerate) - Operational
2.     Instance Operations (get, delete, modify, enumerate) - Operational
3.     Association Operations (reference, referencenames, associators, associatornames - Operational NOTE: The provider interfaces are still considered experimental today and may be modified or extended for Pegasus 2.3, particularly for possible performance improvements.
4.     Methods- Operational
5.     Query operation (Not implemented)

Indications

Process indications are operational in the Server.  This includes support for subscriptions, filters, and indication handlers, the provider API for indications and the CIMXML indication handler. A second Pegasus sever can be use as an Indication client.  However, the Client indication support is incomplete and completion is planned for Pegasus 2.3.

Query Language

The query language today is based on WQL and is implemented and used for filters.  However, the executeQuery operation has not been implemented pending the availability of a standard DMTF Query language.

Class Repository

This release includes the XML based file/directory Class repository.

Instance Repository

This release includes an XML based file/directory Instance repository.  The instance repository is used as the default repository unless a flag is set disabling this repository for client operations

Security

1. Basic Security (Note that Digest based security is not implemented)
2. SSL support - SSL is implemented in Pegasus using the OpenSSL libraries. Pegasus does not provide the OpenSSL libraries but SSL can be used on any platform that supports OpenSSL

Platform Management Functions

1. Configuration through the defined configuration parameters.
2. Daemon operation on all supported platforms

Providers

There are a number of standard providers available in Pegasus release. This includes providers in the following:

Internal Providers

• __Namespace provider - Serves the __Namespace class to allow manipulation of namespaces.
• Subscription Classes Providers - These provide subscription, filter, and indication handler processing.
• Provider registration Providers - This provide registration of providers using the PG_Provider classes.
• ConfigProvider - Manages Pegasus configuraton information.
• UserAuthProvider - Manages password, etc.
• ShutdownProvider - Provides support for Pegasus shutdown.

Generic

Generic OperatingSystem provider. See the directory src/Providers/generic.

Test/Sample

See the directories src/Providers/TestProviders and src/Sample for more information about test and sample providers.

Managed System Providers

ComputerSystem, DNSAdmin, DNSService, Operating System, Process, Processor. For more information on these providers see the documentation for each provider in the directory src/Providers/ManagedSystem

CIMOM Statistics Providers

IBMStatisticalData - This is an early version of the work that became CIM_StatisticalData

        Linux Specific Providers

There are a number of providers in this category including DiskDrive, CDROMDrive, Interrupt, IOPOrt, IPROute, NetworkAdapter, Operating System, PCI Controller, PRocessor, ProviderData, ProviderSupport, SoftwareElement.  For more information about these providers see the documentation in the directory src/Providers/linux

CIM_Schema

The default CIM_Schema loaded with the Pegasus 2.2 release is the DMTF CIM 2.7 Final release.  In addition, Pegasus includes a number of local classes defined for Pegasus.  These are visible in the Schemas directory.

Pegasus MOF Compiler

Pegasus implements a MOF compiler that can operate either at the client interface (cimmof) or directly interfacing with a CIM repository (cimmofl). There were new commands implemented in the Pegasus 2.2 compiler to support class replacement.

Note that use of cimmofl to manipulate instances in the repository bypasses any provider that is registered to serve the instances and simply installs the instances in the instance repository; this may result in corruption if providers are using the repository.  Use of cimmofl to manipulate instances served by a registered providers is therefore discouraged. Use of cimmof rather that cimmofl is encouraged

Client Tools

    Pegasus CIM Server Adminstration

1. cimuser - Manage Pegasus CIM server Users
2. cimconfig - Manage the Pegasus CIM Server configuration parameters
3. cimauth - Manage the CIM Server authorization characteristics. Today this is authorizing users to namespaces.
4. cimprovider - Manage information about the providers.

    Information client tools

   These tools provide information on the objects managed by the server.

1. tomof - output Classes and/or instance information in MOF or XML format.
2. dnsinfo
3. ipinfo
4. osinfo

     Test support Tools

1. Pegasus Unit tests (available through the "tests" option on the Pegasus make files       
2. The Pegasus Test Suite (see the tests directory and the Pegasus/TestBuildMakeFile)tomof
3. TestClient - Basic client for overall platform operation testing.
4. CGICLient - This client has not been completely update to version 2.2.
5. wbemexec - Test tool that sends/receives XML from XML input.
6. CLI - Command line interface for Client commands.

Pegasus InterfaceAPIs

    The Client and Provider API are frozen and at the same level as Pegasus version 2.1. This set of interfaces is listed in PEP 40 available from the web site.   This includes the following major functions

1. Client APIs
2. Provider APIs
3. CIM Objects

The functions are documented in their respective header files and HTML documentation based on the information in the header files extracted with the doc++ tool will be available on the OpenPegasus web site.

Supported Platforms

Each Pegasus release lists as supported platforms those hardware/software platforms that have recognized ports for the Pegasus code base including a maintainer for the platform that will be willing to regularly assure that the port is maintained as the Pegasus code base is changed.  Pegasus may be operable on other platforms (ex. Windows 98) but without a group to provide the role of test and maintenance, the Pegasus project cannot assure operation. The supported platforms for Pegasus release 2.2 are:

Conformance with DMTF Specifications

Generally Pegasus tries to conform to the CIM specifications.  It is a major goal of the OpenPegasus project to both drive and utilize the specifications.  However, today there are a number of differences.  As of Pegasus 2.2, some of the differences include the following:

1. Provider Registration - Pegasus supports registration through a set of Provider registration classes and does not support the Provider Qualifier.

2. Indications. Today Pegasus supports process indications but does not include any specific support for lifecycle indications.

3. Today Pegasus provides alternatives to some of the classes in the Interop Schema including CIM_StatisticalData and Pegasus 2.2 does not include CIM_Namespace support (__Namespace is supported).

Changes in this Release

Each Pegasus release is defined through the Pegasus PEP Process and there is a specific PEP that defines the changes that go into each release.  The defining PEP for Pegasus 2.2 is PEP 15 which is viewable on the Pegasus WEB site.  In addition, each release includes Bug corrections. Generally all of the changes should be defined by either the PEPs or the bugs closed for the release.

Some of the major changes for this release include:

• Large number of bug corrections.
• Compiler extensions.
• Association operation support.
• Upgrade to CIM 2.7 including both the support of the released CIM 2.7 Schema and update of a number of classes from Pegasus (PG_) to CIM classes.
• CIMOM handle support correction and completion.
• Indication provider API completion.
• Finalize test and support of indications.
• Production oriented Logging.
• Addition of dynamic routing for indication internal routing.

In addition, the Pegasus Project implemented a number of procedures and processes to gain further control of the project.

The detailed list of enhancements is defined through the Pegasus PEPs.  Detailed information on each enhancement is available in the PEP which is available on the Pegasus WEB site. The PEPs defined for Pegasus 2.2 include (NOTE: This list includes both those implemented and those deferred or withdrawn):

PEP #	PEP Description	Actual Date	Comments
0	PEP#000-Template for Creating PEPs	Adopted
1	Pegasus Project Enhancement Proposals - Guidelines and the Approval Process	Adopted	PEP Process introduced into Pegasus 2.2 process.
2	Pegasus Bug Tracking and Bug Fix Commitment Process	Deferred	Deferred to Pegasus 2.3.
3	Platform Maintainers Process and Procedures	Deferred	Deferred to Pegasus 2.3.
4	Managing CVS Test and Build	Deferred	Deferred to Pegasus 2.3.
5	Indications Improvements	Withdrawn	Replaced by PEP 47.
6	Pegasus Architecture Process	Deferred	Deferred to Pegasus 2.3.
7	CIMMOF Improvements	Withdrawn	Replaced with PEP 43 and 45.
8	Runing CIM Server as a Service on Windows	January 25, 2003
9	CVS Branch Merge proposal for Pegasus 2.2.	Withdrawn	Replaced by PEP 46
10	N/A	Withdrawn	PEP Number Skipped.
11	Adding Support for XML Character References	Feb 11, 2003
12	Finish Association Provider Interface and Testing		Pending for Pegasus 2.2
13	Upgrading to use CIM 2.6 and 2.7 Schemas	Withdrawn	Plan to replace with a series of class specific PEPs (e.g., 42 and 52).
14	Pegasus Release Milestones	Adopted	Milestones introduced into Pegasus 2.2 release process.
15	This PEP defines Pegasus Release 2.2.	Adopted	See version history section of this PEP for status.
16	Replacement of PG_ classes with CIM_ classes for Indications	April 25, 2003
17	Merge-local: Add containers for indication subscription and delivery parameters	Feb 12, 2003
18	Merge-local: Modification of WQL classes to use CIMName	Feb 12, 2003
19	Merge-local: Support for Multiple Listen Sockets	March 11, 2003
20	Merge-local: Local Connections Using Unix Domain Sockets	March 11, 2003
21	Merge-local: Add HUP Signal Handler	March 11, 2003
22	Merge-local: Windows Time/Date Order Reversal in getCurrentASCIITime()	Feb 21, 2003
23	Merge-local: Consolidation of SSLDir Files	Feb 21, 2003
24	Merge-local: Provider Registration Consistency	March 24, 2003
25	Merge-local: Add a simple display consumer to test indications	March 28, 2003
26	Merge-local: RT_IndicationProvider Enhancement	Feb 26, 2003
27	Merge-local: Custom hash table hash and equal function objects to support case-sensitivity of namespace names.	Feb 25, 2003
28	Enhancements of osinfo to support remote connections.	March 7, 2003
29	Pegasus CIMOMHandle
30	SLP Support in Pegasus 2.2	Deferred	Deferred to Pegasus 2.3
31	Merge-local - Incorrect error message generated during Authentication failure.	March 7, 2003
32	Merge-local: HP-UX IA64 and Linux IA64 platforms to only use PAM based Authentication.	March 13, 2003
33	Enhancement to Red Hat IA32 and IA64 RPM (packaging and distribution) files	March 13, 2003
34	Enhanced support for doc++ in SDK head files	March 12, 2003
35	Add support for /dev/random in SSLContext	March 13, 2003
36	Merge-local: Add ipinfo client.	April 1, 2003
37	Indication API Support Commitment		Plan to submit SDK directories once FC has been achieved and the 2.2 API enhancements have been tested.
38	Proposal to Enhance Provider Manager in Pegasus 2.2	April 17, 2003
39	Improvements to HTTPConnection/Monitor in Pegasus 2.2	Withdrawn	Changes will be submitted through Bugzilla process.
40	Pegasus External Interface Definition		Plan to submit SDK directories once FC has been achieved and the 2.2 API enhancements have been tested.
41	Modifications for successful build on zOS USS
42	Update to CIM Schema Version 2.7	April 29, 2003	The DMTF plans to release an update, 2.7.2, to the CIM 2.7.1 Schema. Plan to move to this version as soon as it is available.
43	cimmof - Updating Class Definitions	April 29,2003
44	Logging Enhancements	March 27, 2003
45	MOF Compiler Scenarios	Deferred	Deferred to Pegasus 2.3
46	Proposal (2nd alt) to merge working branches in Pegasus Open-source CVS Repository	Adopted	Process used for mday-2-0-patches branch merge.
47	Dynamic Message Routing and Late Binding in Pegasus 2.2	May 1, 2003	One additional change, dependent on PEP 12, is still pending.
48	Merge openpegasus.org-wbem-rh32-2.2.spec into openpegasus.org-wbem-2.2.spec	March 19, 2003
49	Wbemexec enhancement to verify trust store validation result	March 19, 2003
50	MD5 Digest Authentication	Deferred	Deferred Indefinitely
51	Configuration Property Cleanup	March 25, 2003
52	Adding the CIM_Interop Classes to Pegasus	Deferred	Deferred
53	Logging Enhancements Code Points Table	April 10, 2003
54	Changing IBMStatisticalData to CIMStatisticalData Classes	Deferred	Deferred to Pegasus 2.3
55	Update Software License to reflect correct years of our copyright and list of contributors		Pending for Pegasus 2.2

Some of the work that was specifically planned for Pegasus 2.2 did not make the cut.  As shown in the table above this includes the following:

• MD5 Digest Authentication - PEP 50 - Deferred indefinitily for lack of sponsor for the work.
• SLP - This work was deferred to Pegasus 2.3
• Changing IBMStatisticalData Classes to CIMStatisticalData classes - deferred to Pegasus 2.3
• Incorporation of Interop Classes.

In addition, a number of problems were corrected in this release.  The list of problems corrected/closed includes the following:

Documentation

The following documentation is available for the Pegasus 2.2 release:

• Build and Installation - Readme in the Pegasus Root Directory
• Operation - Readme in the Pegasus Root Directory
• APIs - See the header files and the HTML documentation that is on the web site.
• Utilities - A combination of help generally available with the -h option for the command and HTML documentation for most of the tools.
• API usage documentation - The best API usage documentation is the existing utilities and test programs.  In particular the Common/tests unit tests contain extensive examples of the use of the Common APIs.

Known Problems/Limitations with this Release

There are a number of known bugs in the Pegasus 2.2 release.  The following list of known open bugs as of the CVS branch for Pegasus 2.2 is in the following table.  Note that this list will change as bugs are fixed and probably new bugs found.  To get the latest bug status for Pegasus, use the OpenPegasus bug manager (Bugzilla) which is can be found at http://cvs.rdg.opengroup.org/bugzilla/

66 bugs found.

Pegasus Maintenance

The Pegasus 2.2 release is maintained as a branch to the Pegasus CVS. The branch name is RELEASE_2_2_0-branch.  There will be bug correction work done against the branch, corrections installed in the branch, and incremental releases of the branch in parallel with the work on Pegasus 2.3.

It will be the responsibility of any developer doing bug fixes on the Pegasus 2.2 branch to document the bugs in Pegasus Bugzilla reports and also to insure that the bug is corrected in the Pegasus 2.3 release.  We will not attempt to merge any changes from Pegasus 2.2 back to 2.3 on a project basis.

Incremental releases with bot CVS tagging and snaphshots of the code will be created when the sufficient bugs have been corrected that the project and users feel that it is necessary to create the snapshot.  The list of bug fixes will be documented for each incremental release.

Reporting Problems

The Pegasus project uses Bugzilla to report bugs, define requested enhancements, and manage work on bugs.  The bug reporting system is open to anybody and it is not required to be a member of the Pegasus project to submit bugs to this system.  We sincerely hope that all Pegasus users will use this bug reporting system to report Pegasus bugs.

The Bug reporting system can be accessed via the Pegasus Web site   or directly via the Pegasus Bugzilla BugList. When reporting bugs, please be a specific as possible, reporting the pegasus version, problem definition, environment (ie. system, OS, etc.).  If a potential solution is defined for the problem, please document the solutions and provide a patch file if possible. Please be sure to note the the Pegasus version number 2.2 on any bugs submitted to Pegasus Bugzilla.

Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group

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.