Documentation update

- Add Savanna section
  - Add Ceilometer section
  - Add Heat section
  - Update Murano section

Change-Id: I01c8a9e942f74f5397f7e3c00668df7eef46d56d
This commit is contained in:
Dmitry Ilyin 2013-12-19 17:00:46 +04:00
parent 044c6dac67
commit baa19f3f2e
6 changed files with 155 additions and 1 deletions

View File

@ -13,3 +13,6 @@
.. include:: /pages/user-guide/cli.rst
.. include:: /pages/user-guide/custom-attributes.rst
.. include:: /pages/user-guide/murano.rst
.. include:: /pages/user-guide/savanna.rst
.. include:: /pages/user-guide/ceilometer.rst
.. include:: /pages/user-guide/heat.rst

View File

@ -0,0 +1,51 @@
.. raw:: pdf
PageBreak
.. index:: Ceilometer
Ceilometer deployment notes
===========================
.. contents :local:
Overview
--------
Fuel has the ability to deploy OpenStack Telemetry component *Ceilometer*.
The main aim of Ceilometer is to collect and share measurement data
gathered from all OpenStack components. This data could be used for monitoring
and capacity planning purposes as well as for an alarming service.
Ceilometer's REST API could also serve as source of data for external
monitoring software of customer's billing system.
Installation
------------
Ceilometer can be installed in Fuel by checking the appropriate check box when
configuring your environment. Ceilometer is supported by CentOS and Ubuntu.
Notes
-----
Ceilometer collects a number of metering data and performs a high volume of database writes.
It could be up to 13000 writes per hour for only 400 resources inside the cloud.
Currently in Fuel 4.0i, Ceilometer uses only common MySQL database, thus we do not recommend
to deploy standard Ceilometer for large production installations.
Also please note that Notification bus support for Ceilometer is not a part of 4.0 release,
due to a number of issues with MySQl backend [1]_ [2]_.
Implementation is planned in 4.1.
Horizon Metering Panel disabled in 4.0. This panel requires the *metadata_query*.
Ceilometer feature that is not supported by Ceilometer with MySQL driver [3]_.
A significant portion of the Metering panel is removed in the Havana release because
this part displays inconsistent data. [4]_.
* Official Ceilometer `documentation <http://docs.openstack.org/developer/ceilometer/>`_ can be found here.
* Mirantis `blog <http://www.mirantis.com/blog/openstack-metering-using-ceilometer/>`_ about monitoring and Ceilometer.
.. [1] https://bugs.launchpad.net/ceilometer/havana/+bug/1255107
.. [2] https://bugs.launchpad.net/ceilometer/+bug/1257908
.. [3] https://github.com/openstack/ceilometer/blob/stable/havana/doc/source/install/dbreco.rst
.. [4] https://review.openstack.org/#/c/60317/

55
pages/user-guide/heat.rst Normal file
View File

@ -0,0 +1,55 @@
.. raw:: pdf
PageBreak
.. index:: Heat
Heat Deployment Notes
==================================
.. contents :local:
Overview
--------
Heat is the OpenStack Orchestration service. Its main goal is to implement
a framework for managing the entire lifecycle of your infrastructure inside
the OpenStack cloud. Heat uses human-readable templates to describe the
deployment process of instances, but also supports AWS CloudFormation
template format.
Heat Components
---------------
heat-api
++++++++
This component provides a native REST API and processes API requests.
heat-api-cfn
++++++++++++
This component is similar to *heat-api*, but provides AWS CloudFormation
compatible API.
heat-engine
+++++++++++
This is the main component of the Heat framework. It does all the work
of reading templates, launching instances and providing events to the API
users.
Installation
------------
When using Fuel 4.0, Heat is now installed by default if you deploy
a CentOS or Ubuntu environment.
Notes
-----
* The official `documentation of the Heat project <https://wiki.openstack.org/wiki/Heat>`_
can be found here.
* `Development documentation <http://docs.openstack.org/developer/heat/>`_
can be found here.
* Mirantis `blog record <http://www.mirantis.com/blog/heat-things-up-with-openstack-before-your-competitors-do/>`_ about Heat.

View File

@ -67,6 +67,11 @@ Conductor is the Murano orchestration engine that transformes objects sent by
REST API service (such as Dashboard) into a series of Heat and Murano API
commands.
Metadata Repository
+++++++++++++++++++
This service stores information about deployment scenarios and workflow
making it available for other Murano services and to the user.
.. index:: Murano: Troubleshooting

View File

@ -0,0 +1,38 @@
.. raw:: pdf
PageBreak
.. index:: Savanna
Savanna deployment notes
===========================
.. contents :local:
Overview
--------
The goal of the Savanna project is to enable OpenStack users to easily
deploy Apache Hadoop clusters. Hadoop provides an implementation
of the MapReduce algorithm popular in the BigData community.
Savanna can install Hadoop clusters on demand. The user should only
provide several parameters like Hadoop version and cluster topology
and Savanna will deploy this cluster in a few minutes. It is also
capable of scaling the cluster by adding or removing nodes when needed.
Installation
------------
Savanna can be installed by selecting the Install Savanna check box either
in configuration wizard or in environment settings before deployment.
Savanna can be installed on all operating systems supported by Fuel.
Notes
-----
Savanna requires pre-built Hadoop images that are not included in Fuel
deployment.
Check the `documentation of Savanna project
<http://docs.openstack.org/developer/savanna/>`_ to find out how to
obtain these images, install them, and deploy them in your environment.

View File

@ -15,4 +15,6 @@ User Guide
.. include:: /pages/user-guide/cli.rst
.. include:: /pages/user-guide/custom-attributes.rst
.. include:: /pages/user-guide/murano.rst
.. include:: /pages/user-guide/savanna.rst
.. include:: /pages/user-guide/ceilometer.rst
.. include:: /pages/user-guide/heat.rst