Stackalytics/HowToRun

Prerequistics
Stackalytics depends on the following applications: * Python-pip Python Package Index * libpython2.7-dev - development C headers for Python * libssl-dev - SSL development libraries, header files and documentation * Git - used to retrieve project repos and get their log * Memcached - used to store commits * Nginx - scalable web server * Uwsgi, uwsgi-plugin-python - application container for Nginx and plugin for Python

Web dashboard is made on Flask framework. Typical deployment of Flask application uses nginx as front-end server and uwsgi as app container. For development purposes Stackalytics may be run on DevStack. The project doesn't require any libraries not listed in OpenStack requirements project.

Installation
Stackalytics deployment is verified on both Ubuntu and CentOS, however the first option is preferable since it has all necessary components as system packages.

1. Install necessary applications

Particular command depends on linux distribution. Here is example for Debian based system: sudo apt-get install libpython2.7-dev libssl-dev python-pip git memcached nginx uwsgi uwsgi-plugin-python

2. Configure memcached

Add two options to startup script: -M Disable automatic removal of items from the cache when out of memory. Additions will not be possible until adequate space is freed up. -m 1024 Use MB memory max to use for object storage; the default is 64 megabytes.

Note: On Debian/Ubuntu systems using the memcached package, this configuration is stored in /etc/memcached.conf

3. Create a stackalytics user and group

sudo useradd -U stackalytics

4. Create folders needed for Stackalytics mkdir /opt/stack/ chown stackalytics.stackalytics /opt/stack mkdir /var/local/stackalytics chown stackalytics.stackalytics /var/local/stackalytics

The last folder is a place where all repos are checked out. 'stackalytics' is an account that will be used for Git and Gerrit polling.

5. Check out Stackalytics code cd /opt/stack/ git clone https://github.com/openstack/stackalytics.git

6. Install Stackalytics: cd /opt/stack/stackalytics sudo pip install.

This will install Stackalytics and all needed libraries into the system.

''Note: On Debian/Ubuntu systems the dependencies for package cffi require installing the distro package libffi-dev, and package cryptography requires installing distro package libssl-dev. Without these, the pip install command will fail."

7. Configure OpenStack gerrit access

StackAlytics requires an account to access the Gerrit review system. Refer to the documentation at the Developer's Guide for details on setting up an account.

The private key and SSH username used to authenticate with Gerrit are configured in the file /opt/stack/stackalytics/etc/stackalytics.conf with the following parameters:


 * 1) SSH key for gerrit review system access
 * 2) ssh_key_filename = /home/user/.ssh/id_rsa
 * 1) SSH username for gerrit review system access
 * 2) ssh_username = user

8. Process all registered repos: stackalytics-processor

This command checks out all repos and parses them. Debugging may be enabled by passing --debug parameter (--verbose for error debugging)

If customized configuration options are used, be sure to specify the configuration file on the command line, as in: stackalytics-processor --config-file /opt/stack/stackalytics/etc/stackalytics.conf

9. Run dashboard in development mode: stackalytics-dashboard

This command starts dashboard to listen on port 8080 of the localhost. The port may be changed by --listen-port parameter.

Production deployment
Production deployment is done with help of uwsgi and nginx.

uwsgi config:

/tmp/stackalytics.sock /opt/stack/stackalytics/dashboard/ web:app python27 STACKALYTICS_CONF=/usr/local/etc/stackalytics/stackalytics.conf

Note: On Debian/Ubuntu systems using the native uwsgi package installation, this configuration should be written to /etc/uwsgi/apps-enabled/stackalytics.xml. Then uwsgi needs to be restarted with 'sudo service uwsgi restart'

nginx config: server { listen  80; location / { uwsgi_pass unix:///tmp/stackalytics.sock; include    uwsgi_params; }	location /static/ { alias /opt/stack/stackalytics/stackalytics/dashboard/static/; } }

Note: On Debian/Ubuntu systems using the native nginx package installation, this configuration should be written to /etc/nginx/sites-available/default, or a separate config file in /etc/nginx/sites-available/  Then nginx needs to be restarted with 'sudo service nginx restart'