softserve's Introduction

Softserve

Softserve is a web based service which enables users to self-provision virtual machines for a fixed duration. These virtual instances can be used to debug issues arising in various topics within the Gluster project. The provisioned VMs will get automatically removed after a fixed number of hours (at present this is set to 4 hrs)

The Gluster Infrastructure Project offers an instance of this service. To deploy this service outside of the Infrastructure, please follow the instruction set below.

Installation

Before you start installation make sure you have a working installation of python2
Create and activate virtualenv
In your virtualenv run pip install -r dev-requirements.txt
Now you are all ready with the installation and development

Goals

Launch the VMs as per the need of the user.
Tear down automatically after a specific number of hours(4 hours). This is a requirement so that the machine time is used judicially and tied down to a specific bug
Allow only those users who are in the Gluster organization on Github to request VMs.
Users should be able to upload their SSH public key and they will get access to the machines when it is created.
Maximum allowance of 5 VMs at a time across all the user.
Send the notification to the user half an hour before terminating the VM ( when meeting the deadline of the 4 hours)

Usage

Run migrations and setup database flask db upgrade
To run the softserve app on localhost run flask run
Create application.cfg and add DEBUG=True to it so as to enable debug mode for your flask app
By default this application reads and writes the data into sqlite but it can be overriden in your application.cfg