From 94f654d4aecf3e7922439d7ea6deb4e1c476b155 Mon Sep 17 00:00:00 2001 From: Ken'ichi Ohmichi Date: Tue, 4 Apr 2017 14:09:29 -0700 Subject: [PATCH] Add Quickstart This patch adds the quickstart for operating Stackalytics more easily. Change-Id: Ib3044adfbcd0e03f403b3686fca6ece9e3345b02 --- README.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.rst b/README.rst index c9b6ed63f..73ea3978b 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,40 @@ development activities and displays statistics on contribution. The features are * Extract blueprint and bug ids from commit messages; * Auto-update of database. +Quickstart +---------- + +To run Stackalytics, you first need to create two kind of configuration files. +The one is default_data.json which shows which sources(git repo, ml, etc.) need +to be analyzed. Another is stackalytics.conf which shows basic configuration like +HTTP listening host and port, etc. Stackalytics repository contains the default +files of these configuration under etc/ directory. It would be useful to copy and +change them as you like. + +#. You need to install Stackalytics. This is done with pip after you check out + Stackalytics repository:: + + $ git clone http://git.openstack.org/openstack/stackalytics + $ cd stackalytics + $ sudo pip install -r requirements.txt + $ sudo python setup.py install + +#. Install and run memcached DB:: + + $ sudo apt-get install -y memcached + $ memcached -u memcache -d + +#. Analyze data which are specifed on default_data.json and store the data into memcached DB:: + + $ stackalytics-processor + +#. Start HTTP server of Stackalytics:: + + $ stackalytics-dashboard + +#. Users can access Stackalytics site on http://127.0.0.1:8080 as the default. + + Project Info -------------