Merge pull request #529 from CPSSD/release-1.0

Release 1.0

.travis.yml

@@ -5,10 +5,6 @@ language: rust
 rust:
     - nightly
 
-cache:
-    - cargo: true
-    - timeout: 1000
-
 addons:
     apt:
         packages:

CONTRIBUTING.md

@@ -50,6 +50,6 @@ All code must be submitted via pull requests, *not* checked straight into the re
 request will be from a single feature branch, which will not be used for any other features after
 merging. Ideally, it will be deleted after a merge.
 
-All pull requests must be reviewed by at least two people who are not the submitter. You can ask
+All pull requests must be reviewed by at least one person who is not the submitter. You can ask
 in Slack for a review, or use Github's assign feature to assign the pull request to a specific
 person.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Cerberus Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -38,17 +38,10 @@ build-docker-images: release
 	docker build -t cpssd/cerberus-master -f master/Dockerfile .
 	docker build -t cpssd/cerberus-worker -f worker/Dockerfile .
 
-
-docker-compose-up: clean-docker-images build-docker-images
-	docker-compose -f docker/docker-compose.yml -p cerberus up -d --scale worker=5 --force-recreate
-
-docker-compose-down:
-	docker-compose -f docker/docker-compose.yml -p cerberus down
-
 clean-docker-images:
 	docker rmi cpssd/cerberus-master -f
 	docker rmi cpssd/cerberus-worker -f
 
-clean-docker: docker-compose-down clean-docker-images
+clean-docker: clean-docker-images
 
 clean-all: clean-docker clean

README.md

@@ -10,7 +10,6 @@ CA4019 Project
 #### Development
 - Rust Nightly
 - Protobuf Compiler
-- net-tools (if running worker locally)
 
 #### Deployment
 - Docker
@@ -28,7 +27,7 @@ $ cargo build --all
 
 ---
 
-## Running benchmarks
+## Running AWS benchmarks
 
 The following dependancies are required to run the benchmarking script:
 - python3-tk
@@ -40,10 +39,8 @@ apt-get install python3-pip python3-tk
 pip3 install numpy matplotlib
 ```
 
-Run the benchmarking script with:
-```
-python3 benchmarks.py
-```
+The AWS benchmarking script is located at aws/benchmarking.py
+Run `cargo build --release` before running the script.
 
 ---
 
@@ -67,10 +64,12 @@ pip install boto3
 	A sample file is located in aws/credentials. Simply replace *ACCESS_KEY_ID* and *SECRET_ACCESS_KEY* with their respective values.
 
 2. **Update parameters in aws.py script**
+
+	You will need to create and download an EC2 key pair from AWS and update the python script to use your .pem file containing the created key.
 
 3. **Ensure that you push the latest version of the master/worker containers to DockerHub**
 
-	This can be done by running `./production-deployment` in the cerberus root directory.
+	This can be done by running `./production-deployment.sh` in the cerberus root directory.
 
 5. **Configure Launch Templates**
 
@@ -80,8 +79,8 @@ pip install boto3
 
 	| Template Name | Tag |
 	|----|----|
-	| Master | Key: "type", Value: "worker" |
-	| Worker | Key: "type", Value: "master" |
+	| Master | Key: "type", Value: "master" |
+	| Worker | Key: "type", Value: "worker" |
 
 6. **Deploy Instances**