diff --git a/doc/source/install/dbreco.rst b/doc/source/install/dbreco.rst new file mode 100644 index 000000000..effe9934b --- /dev/null +++ b/doc/source/install/dbreco.rst @@ -0,0 +1,48 @@ +.. + Copyright 2013 Nicolas Barcet for eNovance + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +============================= + Choosing a database backend +============================= + +Selecting a database backend for Ceilometer should not be done lightly for +numerous reasons: + +1. Not all backend drivers are equally implemented and tested. To help you + make your choice, the below indications will give you some idea of the + status of each of the drivers available in trunk. Note that we do welcome + patches to improve completeness and quality of drivers. + +2. It may not be a good idea to use the same host as another database as + Ceilometer can generate a LOT OF WRITES. For this reason it is generally + recommended, if the deployement is targeting going into production, to use + a dedicated host, or at least a VM which will be migratable to another + physical host if needed. The following spreadsheet can help you get an + idea of the volumes that ceilometer can generate: + `Google spreadsheet `_ + +3. If you are relying on this backend to bill customers, you will note that + its reliability is very much linked to your capacity to generate revenue, + which seems to be a factor dear to many managers. + +The following is a table indicating the status of each database drivers: + +================== ============= ================= ============== +Driver API Complete Storage Complete Production Use +================== ============= ================= ============== +MongoDB Yes Yes Multiple +mysql, postgresql No Yes None known +HBASE No Yes None known +================== ============= ================= ============== diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index b7379f620..5dac236c2 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -22,6 +22,7 @@ .. toctree:: :maxdepth: 2 + dbreco development manual mod_wsgi