From 29a03671bc0d2082382c5b089397d4b393478adc Mon Sep 17 00:00:00 2001 From: liusheng Date: Wed, 15 Feb 2017 11:23:03 +0800 Subject: [PATCH] Update the doc about manually installation This change also clean the valueless "storage" doc. Change-Id: I042ed4c4a2188ee4c6f115e9af6eabf707cd877a --- doc/source/install/index.rst | 1 - doc/source/install/manual.rst | 35 ++++++++++++++++++---------------- doc/source/install/storage.rst | 6 ------ 3 files changed, 19 insertions(+), 23 deletions(-) delete mode 100644 doc/source/install/storage.rst diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 315e16dbd..4e4009d17 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -24,6 +24,5 @@ development manual - storage mod_wsgi uwsgi diff --git a/doc/source/install/manual.rst b/doc/source/install/manual.rst index 8d431d838..a2fb179ca 100644 --- a/doc/source/install/manual.rst +++ b/doc/source/install/manual.rst @@ -16,27 +16,30 @@ .. _installing_manually: -===================== - Installing Manually -===================== +=================== +Installing Manually +=================== +Installing the API Server +========================= +There are two recommended ways to start api server: + 1. Starting API server through mod_wsgi_; + 2. Starting API server through: uwsgi_. -Storage Backend Installation -============================ +Not recommended, for testing purpose, we can also start api server by +aodh-api binary:: -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 -Aodh data. + aodh-api --port 8042 -- --config-file /etc/aodh/aodh.conf +Database configuration +====================== -The recommended Aodh storage backend is any SQLAlchemy-supported database -(`PostgreSQL` or `MySQL`). You need to create a `aodh` database first and then -initialise it by running:: - - aodh-dbsync - +You can use any SQLAlchemy-supported DB such as `PostgreSQL` or `MySQL`. To use MySQL as the storage backend, change the 'database' section in aodh.conf as follows:: - [database] - connection = mysql+pymysql://username:password@host/aodh?charset=utf8 + [database] + connection = mysql+pymysql://username:password@host/aodh?charset=utf8 + +.. _mod_wsgi: ../install/mod_wsgi.html +.. _uwsgi: ../install/uwsgi.html diff --git a/doc/source/install/storage.rst b/doc/source/install/storage.rst deleted file mode 100644 index d35a03f56..000000000 --- a/doc/source/install/storage.rst +++ /dev/null @@ -1,6 +0,0 @@ -================= - Storage Drivers -================= - -.. list-plugins:: aodh.storage - :detailed: