cloudstore-developers
Changes
deployment-scripts/README.md 72(+49 -23)
Details
deployment-scripts/README.md 72(+49 -23)
diff --git a/deployment-scripts/README.md b/deployment-scripts/README.md
index 1b51a7a..f8f06e3 100644
--- a/deployment-scripts/README.md
+++ b/deployment-scripts/README.md
@@ -1,42 +1,32 @@
##Introduction
-In this folder you will find deployment scripts for showcase for Cloudscale project.
+Here you can find a Django app for deploying the showcase for CloudScale project on different cloud providers.
-Scripts are organized in three layers according to cloud environment (infrastructure, platform, software). The ```install.sh``` script encapsulate everything together, but you can execute every script seperatelly.
+Scripts are organized in three layers according to cloud environment (infrastructure, platform, software). You can find the scripts in ```scripts/``` directory.
##Requirements
-You can install these requirements with `pip` or `easy_install`:
-
-* paramiko
-* boto
-
-
-
-
+All requirements are in **requirements.txt** file, and you can install them with **pip**:
+```
+$ pip install -r requirements.txt
+```
##Usage
-We provided scripts for deploying showcase on Amazon Web Services (AWS) and OpenStack. On AWS the showcase is deployed into autiscalability group. On OpenStack is deployed in cluster of 4 machines.
+This application support deployment of showcase on Amazon Web Services (AWS) and OpenStack. You can deploy showcase on AWS using RDS and with or without autoscalability enabled. On Openstack you can deploy showcase using MySQL cluster or MongoDB sharding.
-**Warning**: At the moment we may not provide scripts for OpenStack.
-
-Every script takes at least one argument, that is a path to `config.ini` file. If you run script without parameters the usage message for script will be displayed.
-
-Before you run scripts please examine the `config.ini` file (see Configuration section). For AWS you need to provide your [AWS credentials](http://aws.amazon.com/iam/) and [key-pair](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) name and path.
-
-You can also use `install.sh` script which encapsulates running the scripts in one file. Run it with command:
+To run Django app, you first need to generate the database:
```
-$ install.sh aws /path/to/config.ini
+$ python manage.py syncdb
```
-if you want to deploy showcase on Amazon Web Services, or:
+Before you can use and run app, you must configure the app in ```scripts/config.ini``` file.
+
+Now run the Django app and access to it on http://localhost:8000/form URL.
```
-$ install.sh openstack
+$ python manage.py runserver
```
-if you want to deploy showcase on OpenStack.
-
##Configuration
**Notice**: If you find `[infrastructure]`, `[software]` or `[platform]` sections in `config.ini`,
please ignore them. These sections are created internally with our scripts and all
@@ -49,6 +39,7 @@ configs will be overwritten.
Main configurations are in `config.ini` file and their meaning is described below:
+### Amazon Web Services
Configuration properties for AWS:
* `aws_access_key_id` - Your AWS access key
@@ -77,3 +68,38 @@ Configuration properties for RDS:
* `num_replicas` - Number of replicas.
* `driver` - Driver to use with replication.
+### Openstack
+
+OpenStack configurations
+
+* `username` - OpenStack username
+* `password` - OpenStack password
+* `tenant_name` - OpenStack tenant/group name
+* `auth_url` - OpenStack authentication url
+* `image_name` - Name of the image to use for instances
+* `instance_type` - OpenStack flavor for frontend instances
+* `key_name` - Name of the key pair on OpenStack
+* `key_pair` - Local path to the key pair
+* `image_username` - Username of the user to ssh on instance
+* `database_type` - Database type (mysql or mongo)
+
+MySQL configurations:
+
+* `generate_type` - Currently only possible value is *dump*
+* `generate_dump_path` - Path to MySQL dump. You can get it on [cloudscale.xlab.si](cloudscale.xlab.si/github/rds-tpcw-dump-latest.sql)
+* `instance_type` - OpenStack flavor for MySQL instances
+* `database_name` - Database name for MySQL
+* `database_user` - Database username for MySQL
+* `database_pass` - Database password for MySQL
+* `num_replicas` - Number of MySQL replica instances
+* `driver` - MySQL driver
+
+MongoDB configurations:
+
+* `generate_type` - Currently only possible value is *dump*
+* `generate_dump_path` - Path to MongoDB dump. You can get it on [cloudscale.xlab.si](cloudscale.xlab.si/github/mongo-dump-tpcw-latest.tar.gz)
+* `instance_type` - OpenStack flavor for MongoDB instances
+* `database_name` - MongoDB database name
+* `database_user` - MongoDB database username
+* `database_pass` - MongoDB database password
+* `num_replicas` - Number of MongoDB shards