openstack/aodh
Code Issues Proposed changes

Describe storage backends in the collector installation guide

Browse Source 
Move information about the storage backends to the collector
section and add info about their usage.

Change-Id: I979a458c91f5dee486799f201b8f4d75a4163782
This commit is contained in:
Dina Belova
2014-04-21 22:06:05 +04:00
parent 3d0e7552dd
commit 9881d0989a
2 changed files with 125 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
doc/source/configuration.rst
View File

@@ -107,67 +107,42 @@ sqlite_synchronous True If passed, use
HBase HBase
=================== ===================
To configure HBase as your database backend: This storage implementation uses Thrift HBase interface. The default Thrift's
connection settings should be changed to support using ConnectionPool in HBase.
To ensure proper configuration, please add the following lines to the
`hbase-site.xml` configuration file::
1. To install an HBase server, for pure development purpose, you can just <property>
download the HBase image from Cloudera and get it up and running. Then the <name>hbase.thrift.minWorkerThreads</name>
quickest way to check it is to run the ``HBase shell`` and try a ``list`` <value>200</value>
command which would return the list of the tables in your HBase server: </property>
:: For pure development purposes, you can use HBase from Apache_ or some other
vendors like Cloudera or Hortonworks. To verify your installation, you can use
the `list` command in `HBase shell`, to list the tables in your
HBase server, as follows::
$ ${HBASE_HOME}/bin/hbase shell $ ${HBASE_HOME}/bin/hbase shell
hbase> list hbase> list
.. note:: .. note::
This driver has been tested against HBase 0.92.1/CDH 4.1.1, This driver has been tested against HBase 0.94.2/CDH 4.2.0,
HBase 0.94.2/CDH 4.2.0, HBase 0.94.4/HDP 1.2 and HBase 0.94.5/Apache. HBase 0.94.4/HDP 1.2, HBase 0.94.18/Apache, HBase 0.94.5/Apache,
HBase 0.96.2/Apache and HBase 0.98.0/Apache.
Versions earlier than 0.92.1 are not supported due to feature incompatibility. Versions earlier than 0.92.1 are not supported due to feature incompatibility.
2. A few HBase tables are expected by Ceilometer. To find out more about supported storage backends please take a look on the
To create them, run the following: :doc:`install/manual/` guide.
::
$ ${HBASE_HOME}/bin/hbase shell
hbase> create 'project', {NAME=>'f'}
hbase> create 'user', {NAME=>'f'}
hbase> create 'resource', {NAME=>'f'}
hbase> create 'meter', {NAME=>'f'}
3. This driver is implemented to use HBase Thrift interface so it's necessary
to have the HBase Thrift server installed and started. When you have HBase
installed, normally, HBase thrift server is turned on by default. If it's not,
turn it on by running command ``hbase thrift start``. The implementation uses
`HappyBase`_ which is a wrapper library used to interact with HBase via Thrift
protocol, you can verify the thrift connection by running a quick test from a
client:
.. _HappyBase: http://happybase.readthedocs.org/en/latest/index.html#
::
import happybase
conn = happybase.Connection(host=$hbase-thrift-server, port=9090, table_prefix=None)
print conn.tables() # this returns a list of HBase tables in your HBase server
4. The parameter "database_connection" needs to be configured to point to
the Hbase Thrift server.
=========================== ==================================== ==============================================================
Parameter Value Note
=========================== ==================================== ==============================================================
database_connection hbase://$hbase-thrift-server:9090 Database connection string
=========================== ==================================== ==============================================================
.. note:: .. note::
If you are changing the configuration on the fly, you will need to restart If you are changing the configuration on the fly to use HBase, as a storage
the Ceilometer services that use the database to allow the changes to take backend, you will need to restart the Ceilometer services that use the
affect, i.e. the collector and API services. database to allow the changes to take affect, i.e. the collector and API
services.
.. _Apache: https://hbase.apache.org/book/quickstart.html
Event Conversion Event Conversion
================ ================

135
doc/source/install/manual.rst
View File

@@ -20,6 +20,102 @@
Installing Manually Installing Manually
===================== =====================
Storage Backend Installation
============================
This step is a prerequisite for the collector, notification agent and API
services. You may use one of the listed database backends below to store
Ceilometer data.
.. note::
Please notice, MongoDB (and some other backends like DB2 and HBase)
require pymongo_ to be installed on the system. The required minimum
version of pymongo is 2.4.
..
MongoDB
-------
The recommended Ceilometer storage backend is `MongoDB`. Follow the
instructions to install the MongoDB_ package for your operating system, then
start the service. The required minimum version of MongoDB is 2.4.
To use MongoDB as the storage backend, change the 'database' section in
ceilometer.conf as follows::
[database]
connection = mongodb://username:password@host:27017/ceilometer
SQLalchemy-supported DBs
------------------------
You may alternatively use `MySQL` (or any other SQLAlchemy-supported DB
like `PostgreSQL`).
In case of SQL-based database backends, you need to create a `ceilometer`
database first and then initialise it by running::
ceilometer-dbsync
To use MySQL as the storage backend, change the 'database' section in
ceilometer.conf as follows::
[database]
connection = mysql://username:password@host/ceilometer?charset=utf8
HBase
-----
HBase backend is implemented to use HBase Thrift interface, therefore it is
mandatory to have the HBase Thrift server installed and running. To start
the Thrift server, please run the following command::
${HBASE_HOME}/bin/hbase thrift start
The implementation uses `HappyBase`_, which is a wrapper library used to
interact with HBase via Thrift protocol. You can verify the thrift
connection by running a quick test from a client::
import happybase
conn = happybase.Connection(host=$hbase-thrift-server, port=9090, table_prefix=None)
print conn.tables() # this returns a list of HBase tables in your HBase server
.. note::
HappyBase version 0.5 or greater is required. Additionally, version 0.7
is not currently supported.
..
In case of HBase, the needed database tables (`project`, `user`, `resource`,
`meter`, `alarm`, `alarm_h`) should be created manually with `f` column
family for each one.
To use HBase as the storage backend, change the 'database' section in
ceilometer.conf as follows::
[database]
connection = hbase://hbase-thrift-host:9090
DB2
---
DB2 installation should follow fresh IBM DB2 NoSQL installation docs.
To use DB2 as the storage backend, change the 'database' section in
ceilometer.conf as follows::
[database]
connection = db2://username:password@host:27017/ceilometer
.. _HappyBase: http://happybase.readthedocs.org/en/latest/index.html#
.. _MongoDB: http://www.mongodb.org/
.. _pymongo: https://pypi.python.org/pypi/pymongo/
Installing the notification agent Installing the notification agent
====================================== ======================================
.. index:: .. index::
@@ -145,23 +241,20 @@ Installing the collector
.. index:: .. index::
double: installing; collector double: installing; collector
1. Install MongoDB. .. _storage_backends:
Follow the instructions to install the MongoDB_ package for your 1. Clone the ceilometer git repository to the management server::
operating system, then start the service.
2. Clone the ceilometer git repository to the management server::
$ cd /opt/stack $ cd /opt/stack
$ git clone https://git.openstack.org/openstack/ceilometer.git $ git clone https://git.openstack.org/openstack/ceilometer.git
3. As a user with ``root`` permissions or ``sudo`` privileges, run the 2. As a user with ``root`` permissions or ``sudo`` privileges, run the
ceilometer installer:: ceilometer installer::
$ cd ceilometer $ cd ceilometer
$ sudo python setup.py install $ sudo python setup.py install
4. Copy the sample configuration files from the source tree 3. Copy the sample configuration files from the source tree
to their final location. to their final location.
:: ::
@@ -171,7 +264,7 @@ Installing the collector
$ cp etc/ceilometer/*.yaml /etc/ceilometer $ cp etc/ceilometer/*.yaml /etc/ceilometer
$ cp etc/ceilometer/ceilometer.conf.sample /etc/ceilometer/ceilometer.conf $ cp etc/ceilometer/ceilometer.conf.sample /etc/ceilometer/ceilometer.conf
5. Edit ``/etc/ceilometer/ceilometer.conf`` 4. Edit ``/etc/ceilometer/ceilometer.conf``
1. Configure RPC 1. Configure RPC
@@ -200,7 +293,7 @@ Installing the collector
Refer to :doc:`/configuration` for details about any other options Refer to :doc:`/configuration` for details about any other options
you might want to modify before starting the service. you might want to modify before starting the service.
6. Start the collector. 5. Start the collector.
:: ::
@@ -213,8 +306,6 @@ Installing the collector
or other tool for maintaining a long-running program in the or other tool for maintaining a long-running program in the
background. background.
.. _MongoDB: http://www.mongodb.org/
Installing the Compute Agent Installing the Compute Agent
============================ ============================
@@ -544,25 +635,3 @@ one can configure the line like the following::
With above configuration, no dispatcher is used by the Ceilometer collector With above configuration, no dispatcher is used by the Ceilometer collector
service, all metering data received by Ceilometer collector will be dropped. service, all metering data received by Ceilometer collector will be dropped.
Using other databases
=========================
.. index::
double: installing; database, hbase, mysql, db2
Ceilometer by default uses mongodb as its backend data repository.
A deployment can choose to use other databases, currently the supported
databases are mongodb, hbase, mysql (or sqlalchemy-enabled databases) and
db2. To use a database other than MongoDB, edit the database section in
ceilometer.conf:
To use db2 as the data repository, make the section look like this::
[database]
connection = db2://username:password@host:27017/ceilometer
To use mongodb as the data repository, make the section look like this::
[database]
connection = mongodb://username:password@host:27017/ceilometer