OpenClovis Product Documentation

Latest revision as of 19:06, 24 October 2011

[edit] Preface

OpenClovis SAFplus Platform Web Director (AWD) User Guide provides information about the usage of OpenClovis Web Director, a web-based cluster and chassis management system from OpenClovis Inc. that complements the OpenClovis SAFplus Platform (Application Service Platform). This guide helps you to utilise the OpenClovis Web Director in your own environment.

OpenClovis SAFplus Platform Web Director is designed to simplify and accelerate the development of Telecom application software over OpenClovis platform. It provides a simple and powerful mechanism to examine and modify an online SAFplus Platform cluster, to share critical chassis resources, install and manage new applications, and dynamically modify the SAFplus Platform Information Model.

The OpenClovis SAFplus Platform Web Director is also a "living" case study for customers to use when creating a web-based EMS (element management system) or network management glue layer. It can be easily rebranded to provide essentially an off-the-shelf EMS for SAFplus Platform deployments, customized to provide enhanced EMS functionality, or used as a reference when integrating OpenClovis SAFplus Platform into an existing EMS framework.

[edit] Audience

OpenClovis SAFplus Platform Web Director (AWD) User Guide is designed for system integrators, designers, and system architects. To use this OpenClovis product, you must be aware of the fundamentals of operation, management, and configuration of telecommunication and networking domains. You must also be familiar with Python programming, the OpenClovis SAFplus Platform product, and have a basic knowledge of Linux.

[edit] Documentation Conventions

This guide uses different fonts and symbols to differentiate between document elements and types of information. These conventions are summarized in the following table:

Code

This indicates the presence of notes or annotations, related to the context of the document.
This indicates that certain precautionary measures must be taken before performing a particular task.
This indicates that additional information is provided to you.

[edit] Related Documentation

For additional information about OpenClovis products, refer to the following guides:

• OpenClovis Release Notes provides information about the software and the hardware required to install OpenClovis Application Service Platform (SAFplus Platform) and Integrated Development Environment (IDE). It contains the additional features and enhancements of the product since the previous release. It also summarizes the issues and limitations of the product and provides workarounds wherever applicable.
• OpenClovis SA Forum Compliance describes the level of compliance of OpenClovis SAFplus Platform and its Application Programming Interface (API) with the relevant Service Availability Forum Specifications.
• OpenClovis Installation Guide provides the system requirements, installation procedure for OpenClovis SAFplus Platform, IDE, and the Evaluation System.
• OpenClovis Sample Application Tutorial provides the steps to create and build a sample model using OpenClovis IDE and OpenClovis SAFplus Platform. It also provides troubleshooting information for this process. This provides the logical first step in understanding the OpenClovis offering.
• OpenClovis Evaluation System User Guide provides all the required information to configure and run the sample models packaged within the Evaluation System. This document also provides good understanding of OpenClovis SAFplus Platform's functionality. This is the natural follow on to the OpenClovis Sample Application Tutorial as it builds on the example created in that document.
• OpenClovis SDK User Guide provides information about OpenClovis Application Service Platform (SAFplus Platform) architecture, various OpenClovis SAFplus Platform components, and their interactions. This guide helps you to configure the OpenClovis SAFplus Platform components, compile, and execute the OpenClovis SAFplus Platform code to build your custom application.
• OpenClovis Log Tool User Guide provides information about the usage of OpenClovis Log Tool. OpenClovis Log Tool is an interactive utility that allows you to view binary log files in a readable format and hence monitor system errors, warnings, and other log information. Log Tool allows you to format the .log files and filter them to view the required entries.
• OpenClovis API Reference Guide is provided for each component. It describes the Application Programming Interface (API), Service Model, and Management Information Model of the various OpenClovis Application Service Platform (SAFplus Platform) services. It helps the developer to understand the capabilities of the SAFplus Platform services and the APIs provided by these services.
• OpenClovis SAFplus Platform Console Reference Guide provides details about managing applications built on OpenClovis SAFplus Platform using the SAFplus Platform runtime debug console commands. SAFplus Platform Console commands can be used to manage, monitor, and test your application.

For additional information about TurboGears, the web application mega-framework used by the OpenClovis SAFplus Platform Web Director please refer to:

• Turbogears web site at http://www.turbogears.org.

[edit] OpenClovis Online Technical Support

OpenClovis customers and partners can register on our Web site and receive personalized services and information. If you need any support or assistance while working on OpenClovis products, you can access the following: URL: http://www.openclovis.com. Send your queries to: support@openclovis.com. Open source community support is available at: http://www.openclovis.org/forum.

[edit] Documentation Feedback

We are interested in hearing from our customers on the documentation provided with the product. Let us know your comments and suggestions on improving the documentation at OpenClovis Inc. Send your comments to: support@openclovis.com. Post your feedback on documentation at: http://www.openclovis.org/forum.