es-responder

Summary

A lightweight custom REST API for ElasticSearch queries. Once installed, just going to the top-level page will show Swagger documentation.

Configuration

This system depends on the Centralized Config system, and will use the following configurations:

• rest_services
• servers
• elasticsearch_queries

The location of the configuration system is in the config.cfg file as CONFIG_ROOT.

Deployment

After installing on the production server, take the following steps to start the system:

cd /opt/flask/es-responder
sudo systemctl start gunicorn
sudo systemctl start nginx

Development

1. Create and activate a clean Python 3 environment:

   python3 -m venv myenv
   source myenv/bin/activate
   

2. Install dependencies:

   pip3 install -r requirements.txt

3. Run tests:

   python3 test_base.py

4. Start server:

   python3 es_responder.py

5. When you're done, deactivate the virtual environment:

   deactivate