Code restructuration

.gitignore

@@ -1,4 +1,3 @@
-Vagrantfile
 .vagrant
 /*.ini
 !config-dist.ini
@@ -10,4 +9,5 @@ web/instance_image/*
 !web/instance_image/example.png
 web/node_modules/
 web/public
-/*.sqlite
+/*.sqlite
+*~

Dockerfile

@@ -1,20 +1,34 @@
-FROM ubuntu:14.04
+FROM ubuntu:16.04
 MAINTAINER Loïc PORTE
-RUN apt-get update && apt-get install git python python-dev\
+RUN apt-get update && apt-get install -y git python python-dev\
  python-pip mysql-client libmysqlclient-dev nodejs npm\
-  libldap2-dev libsasl2-dev libssl-dev -y
+  libldap2-dev libsasl2-dev libssl-dev nginx supervisor
 RUN ln -s /usr/bin/nodejs /usr/bin/node
-RUN npm install -g bower grunt-cli
+
+RUN rm -rf /etc/nginx/sites-available/* /etc/nginx/sites-enabled/*
+
+COPY ./ressources/nginx/nginx-server /etc/nginx/sites-available/default
+RUN ln -s /etc/nginx/sites-available/default /etc/nginx/sites-enabled/default
+RUN ln -sf /dev/stdout /var/log/nginx/access.log
+RUN ln -sf /dev/stderr /var/log/nginx/error.log
+
+
+RUN mkdir -p /etc/demoinstance/instance_image/
 RUN mkdir /opt/demoinstance 
 COPY ./ /opt/demoinstance
-WORKDIR /opt/demoinstance
-RUN pip install -r requirements.txt
-WORKDIR /opt/demoinstance/web
+
+WORKDIR /opt/demoinstance/frontend
 RUN npm install
-RUN bower install --allow-root
-RUN grunt
-WORKDIR /opt/demoinstance/
-VOLUME /opt/demoinstance/config.ini
-VOLUME /opt/demoinstance/instance_image/
-CMD python demo.py
+RUN node_modules/gulp/bin/gulp.js
+
+
+WORKDIR /opt/demoinstance/backend/
+RUN pip install --upgrade pip
+RUN pip install --upgrade setuptools
+RUN python setup.py install
+
+COPY ./ressources/supervisor/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+
+CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/supervisord.conf"]
+
 EXPOSE 8080

README.md

@@ -1,32 +1,82 @@
 # Project DemoInstance
-DemoInstance provides an interface to deploy instance of your project on an Openstack cloud. With this project your futur client can deploy an isolated instance for a defined time.
+DemoInstance is web interface offering on-demand virtual machines instances with lifetime limits.
 
 ## Interface example
 ![Image of Demoinstance](https://raw.githubusercontent.com/bewiwi/DemoInstance/gh-pages/demoinstance.gif)
 
-## Pre requisites
+## Dependencies
 
-* Python & Python devel & Python PIP
-* GCC
-* MySQL server / MySQL devel
 
-## Installation
+<img src="http://svgporn.com/logos/python.svg" alt="Python" width="64"> <img src="http://svgporn.com/logos/npm.svg" alt="Python" width="64"> <img src="http://svgporn.com/logos/gulp.svg" alt="Python" width="64">
+
+
+* Python 2.7
+* PIP
+* NodeJS & NPM
+* An underlying database system: 
+	* SQLite
+	* MySQL
+
+## Building and setting up
+
+In order to use DemoInstance, you can:
+
+* [Build](#building-and-setting-up), [configure](#configuration) and [run](#run-backend) demoinstance yourself
+* [Configure](#configuration) and [use a production docker image](#run-w-docker)
+
+### Install backend service
+
+In order to install DemoInstance backend service:
 
 ```
-# npm install -g bower
-# npm install -g grunt-cli
-$ git clone [email protected]:bewiwi/DemoInstance.git
-$ cd DemoInstance
-$ pip install -r requirement.txt
-$ cd web/
+$ git clone [email protected]:pmsipilot/demoinstance.git
+$ cd demoinstance/backend/
+$ sudo python2 ./setup.py install
+```
+
+### Prepare frontend sources
+
+In order to prepare frontend sources:
+
+```
+$ cd frontend
 $ npm install
-$ bower install
-$ grunt
-$ cd -
-$ cp config-dist.ini config.ini
-$ vim config.ini
+$ node_modules/gulp/bin/gulp.js
+```
+
+#### Set up web server
+In this example, we'll be using [the nginx webserver](http://nginx.org/):
+
+* Install nginx (according to your operating system documentation)
+* Configure nginx virtualhost
+* Restart nginx
+
+Virtualhost example:
+```
+server {
+       listen 8080;
+       root /opt/demoinstance/frontend/;
+       index index.html;
+       location /api {
+                proxy_pass http://127.0.0.1:8081;
+       }
+       location / {
+                try_files $uri $uri/ =404;
+       }
+       location /instance_image/ {
+                alias /etc/demoinstance/instance_image/;
+                try_files $uri $uri/ =404;
+       }
+}
 ```
 
+* In this example, the webserver is listening on port `8080`, frontend files are stored in `/opt/demoinstance/frontend`, and backend is listening on port `8081`.
+* All `/api` requests must be passed to demoinstance backend service 
+* `/instance_image`requests points to `/etc/demoinstance/instance_image/` in this example.
+* Other requests are fulfilled with previously prepared frontend source code files.
+
+Then, you must configure DemoInstance backend.
+
 ## Configuration
 
 DemoInstance have a single ini config file : config.ini
@@ -104,8 +154,8 @@ region=regionOne
 | password | No | openstack password |
 | tenant | No | openstack tenant |
 | url | No | openstack keystone api url |
-| region | Yes | openstak region |
-
+| region | Yes | openstack region |
+| network | Yes | openstack network id |
 ### HTTP
 ```
 [HTTP]
@@ -217,22 +267,30 @@ user_data:#cloud-config
 This is defined here : http://tools.ietf.org/html/rfc822.html on LONG HEADER FIELDS section
 
 
-## Run
+## Run Backend
 ```
-python demo.py
+/usr/local/bin/demoinstance -c /etc/demoinstance/config.ini
 ```
-Or
+
+## Run w/ Docker
+
+There is also a Docker Production-ready image: https://hub.docker.com/r/pmsipilot/demoinstance/
+
 ```
-./demo.sh start
+docker run -v /path/to/config/and/instance_image:/etc/demoinstance/ -i pmsipilot/demoinstance
 ```
 
+* `/etc/demoinstance/` must contain:
+	* `config.ini` file
+	* `instance_image` folder with instance images
+
 ## Init script
+
 ### Redhat/Centos
-Template for Centos is avaible in samples/
-Just link file to /etc/init.d and maybe add it to boot sequence
+Template for Centos is avaible in `ressources/rhel-init-demoinstance`.
+Just link file to /etc/init.d.
 ```
 ln -s /where/is/your/project /etc/init.d/demoinstance
-chkconfig demoinstance on
 ```
 Don't forget to add config file in /etc/sysconfig/demoinstance
 ```
@@ -255,11 +313,12 @@ If you want this you can do it and make me a PR
 If you want to contribute you're welcome. Just create issues or make some PR.
 
 ### Dev env
-A docker env was set to help you to dev. To start just configure a good config.ini and run
+The development environment is built w/ Docker on top of the production-ready image, with [docker-compose](https://docs.docker.com/compose/)
 ```
-fig up
+docker-compose up
 ```
-If you don't have docker you can directly install needed lib on your hosts, it works well to
+
+A supervisord process will listen for changes in frontend files, and changes to backend source code will be directly applied.
 
 ### Run test
 To run test just run this command on with an URL od demoinstance run with test/samples/config/config-fake.ini

Vagrantfile

@@ -0,0 +1,23 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box_url = "https://atlas.hashicorp.com/debian/jessie64"
+  config.vm.box = "debian/jessie64"
+
+  config.vm.provider :virtualbox do |v, override|
+    v.customize ["modifyvm", :id, "--memory", 1024]
+    v.customize ["modifyvm", :id, "--cpus", 1]
+    override.vm.synced_folder ".", "/opt/demoinstance", :id => "vagrant-root", owner: "root", group: "root", :mount_options => ["dmode=777", "fmode=777"]
+  end
+
+  config.vm.usable_port_range = (2200..2299)
+  config.vm.network "forwarded_port", guest: 8080,    host: 2280, auto_correct: true
+  config.vm.network "forwarded_port", guest: 8081,    host: 2281, auto_correct: true
+
+  config.vm.define :master do |master|
+    master.vm.provision "shell" do |sh|
+      sh.path = "ressources/vagrant_setup.sh"
+    end
+  end
+end

Demo/auth/auth_ldap.py → backend/demoinstance/auth/auth_ldap.py

@@ -29,7 +29,7 @@ def check_auth(self, user, password):
             return False
 
         if len(res) > 1:
-            raise Exception("To much user returned")
+            raise Exception("Too many users returned")
         if len(res) < 1:
             raise ldap.INVALID_CREDENTIALS
 

demo.py → backend/demoinstance/cli.py

@@ -1,12 +1,12 @@
-from Demo.demo_config import DemoConfig
-from Demo.database import DemoData
-from Demo.http import ThreadedHTTPServer, Handler
-from Demo.vacuum import Vacuum
-from Demo.pool import Pool
+from demo_config import DemoConfig
+from database import DemoData
+from http import ThreadedHTTPServer, Handler
+from vacuum import Vacuum
+from pool import Pool
 import logging
 import argparse
 
-if __name__ == '__main__':
+def cli_entrypoint():
     parser = argparse.ArgumentParser()
     parser.add_argument('-c', help='config file', default='./config.ini')
     args = parser.parse_args()
@@ -27,4 +27,5 @@
         server = ThreadedHTTPServer(('0.0.0.0', config.http_port), Handler)
         server.serve_forever()
     except (KeyboardInterrupt, SystemExit):
+        logging.info("Exit signal catched")
         vacuum.stop = True

Demo/database.py → backend/demoinstance/database.py

@@ -38,9 +38,11 @@ class Instance(Base):
     name = Column(String(255))
     image_key = Column(String(255))
     status = Column(String(255), nullable=False)
+    ip = Column(String(255), nullable=True)
     launched_at = Column(types.DATETIME)
     life_time = Column(types.Integer, nullable=False)
     token = Column(String(255), nullable=False)
+    user_alerted = Column(types.Boolean, default=False)
 
     def get_dead_time(self):
         delta = (
@@ -68,6 +70,7 @@ class User(Base):
     token = Column(String(255), primary_key=True)
     login = Column(String(255), unique=True)
     last_connection = Column(types.DATETIME)
+    slack_identifier= Column(String(255), nullable=True)
 
     def generate_token(self):
         self.token = str(uuid.uuid4())