readme

Author: mwunderl

README.md

@@ -1,11 +1,7 @@
 # Scorekeep
 Scorekeep is a RESTful web API implemented in Java that uses Spring to provide an HTTP interface for creating and managing game sessions and users. This project includes the Scorekeep API and a front-end web app that consumes it. The front end and API can run on the same server and domain or separately, with the API running in Elastic Beanstalk and the front end served statically by a CDN.
 
-The `fargate` branch shows the use of Spring, Angular, nginx, the [AWS SDK for Java](http://aws.amazon.com/sdkforjava), [Amazon DynamoDB](http://aws.amazon.com/dynamodb), Gradle, and [AWS ECS Fargate](http://aws.amazon.com/ecs) features that enable you to:
-
-- Run both components in the same [Amazon ECS](http://aws.amazon.com/ecs) task definition behind an [Amazon Application Load Balancer](https://aws.amazon.com/elasticloadbalancing/)
-- Create required DynamoDB and [Amazon SNS](http://aws.amazon.com/sns) resources through Cloudformation
-- Publishes container logs to [Amazon Cloudwatch Logs](https://aws.amazon.com/cloudwatch)
+The `ecs` branch shows how to deploy the application to Amazon Elastic Container Service (ECS) using AWS Elastic Beanstalk. It includes scripts for making Docker images of the frontend and API components, uploading the images to Amazon Elastic Container Registry (ECR), and generating a task definition.
 
 Other branches extend the application's functionality and show the use of other AWS services. See the readme in each branch for details about the integration and instructions for use.
 
@@ -21,7 +17,7 @@ Other branches extend the application's functionality and show the use of other
 - [`xray-gettingstarted`](https://github.com/awslabs/eb-java-scorekeep/tree/xray-gettingstarted) ([tutorial](https://docs.aws.amazon.com/xray/latest/devguide/xray-gettingstarted.html)) - Use the AWS X-Ray SDK for Java to instrument incoming requests and SDK clients (no additional configuration required).
 - [`xray-worker`](https://github.com/awslabs/eb-java-scorekeep/tree/xray-worker) - Instrumented Python Lambda worker function from the `lambda-worker` branch.
 
-Use the procedures in the following sections to run the project on Fargate and configure it for local testing and development.
+Use the procedures in the following sections to run the project on ECS and configure it for local testing and development.
 
 **Sections**
 - [Prerequisites](#prerequisites)
@@ -71,42 +67,7 @@ The Java application is built using the gradle Docker container so it does not r
 2. Build and Publish your API container to the ECR repository created by Cloudformation executing `make publish` in the root folder
 3. Build and Publish your Frontend container to the ECR repository created by Cloudformation executing `make publish` in the `scorekeep-frontend/` folder
 4. Populate your Task Definition with the correct region and account id using the `generate-task-definition` script in the `task-definition` folder
-5. Register your Task Definition to ECS with `aws ecs register-task-definition --cli-input-json file://scorekeep-task-definition.json`
-6. Launch your Service or Task using the AWS CLI, ECS CLI, or AWS Management Console
-
-To create a Fargate Service for Scorekeep with the ECS console
-
-1. Open [the ECS console](https://console.aws.amazon.com/ecs/home).
-2. Click **Create cluster**.
-3. Select **Networking only** and click **Next step**.
-4. Enter *scorekeep-cluster* for the cluster name and click **Create**.
-5. Choose **View cluster**.
-6. Under **Services**, click **Create**.
-7. Create a service with the following settings. Click **Next Step** to proceed through each page as necessary.
-  - Launch type: **Fargate**
-  - Task definition: **scorekeep:1**
-  - Platform version: **latest**
-  - Cluster: **scorekeep-cluster**
-  - Service name: **scorekeep-service**
-  - Number of tasks: **4**
-  - Minimum healthy percent: **50**
-  - Maximum percent: **200**
-  - Cluster VPC: **scorekeep**
-  - Subnets: both **scorekeep_Private** subnets
-  - Security groups: click Edit > Select existing > select **default**
-  - Auto-assign public IP: **enabled**
-  - Load balancer type: **Application load balancer**
-  - Load balancer name: **scorekeep-lb**
-  - Container name: **scorekeep-frontend** (click **Add to load balancer**)
-  - Listener port: **80:HTTP**
-  - Target group name: **Create new**
-  - Path pattern: /*
-  - Health check pattern: /
-  - Service auto scaling: **Do not adjust**
-8. Choose **View service**.
-9. Open the [load balancers screen](https://console.aws.amazon.com/ec2/v2/home#LoadBalancers:) in the EC2 console.
-10. Choose **scorekeep-lb**.
-11. Under **Description**, copy the **DNS name** and open it.
+5. Deploy the `Dockerrun.aws.json` file to a Multicontainer Docker Elastic Beanstalk Environment.
 
 ![Scorekeep flow](/img/scorekeep-flow.png)
 
@@ -118,14 +79,14 @@ The API uses SNS to send a notification email when a game ends. To enable e-mail
 # How it works
 
 ## Backend
-The API runs at paths under /api that provide access to user, session, game, state, and move resources stored as JSON documents in DynamoDB. The API is RESTful, so you can create resources by sending HTTP POST requests to the resource path, for example /api/session. See the [test script](https://github.com/awslabs/eb-java-scorekeep/blob/fargate/bin/test-api.sh) for example requests with cURL.
+The API runs at paths under /api that provide access to user, session, game, state, and move resources stored as JSON documents in DynamoDB. The API is RESTful, so you can create resources by sending HTTP POST requests to the resource path, for example /api/session. See the [test script](https://github.com/awslabs/eb-java-scorekeep/blob/ecs/bin/test-api.sh) for example requests with cURL.
 
 The Cloudformation template creates a DynamoDB table for each resource type.
 
 ## Front end
-The front end is an Angular 1.5 web app that uses `$resource` objects to perform CRUD operations on resources defined by the API. Users first encounter the [main view](https://github.com/awslabs/eb-java-scorekeep/blob/fargate/scorekeep-frontend/public/main.html) and [controller](https://github.com/awslabs/eb-java-scorekeep/blob/fargate/scorekeep-frontend/public/app/mainController.js) and progress through session and game views at routes that include the IDs of resources that the user creates.
+The front end is an Angular 1.5 web app that uses `$resource` objects to perform CRUD operations on resources defined by the API. Users first encounter the [main view](https://github.com/awslabs/eb-java-scorekeep/blob/ecs/scorekeep-frontend/public/main.html) and [controller](https://github.com/awslabs/eb-java-scorekeep/blob/ecs/scorekeep-frontend/public/app/mainController.js) and progress through session and game views at routes that include the IDs of resources that the user creates.
 
-The front end is served statically by an Nginx container. The [nginx.conf](https://github.com/awslabs/eb-java-scorekeep/blob/fargate/scorekeep-frontend/nginx.conf) file in the source code sets up Nginx to serve the frontend html pages from root, and forward requests starting with /api to the API backend running on port 5000. 
+The front end is served statically by an Nginx container. The [nginx.conf](https://github.com/awslabs/eb-java-scorekeep/blob/ecs/scorekeep-frontend/nginx.conf) file in the source code sets up Nginx to serve the frontend html pages from root, and forward requests starting with /api to the API backend running on port 5000. 
 
 # Running the project locally
 You can run both the API and front-end locally with Docker
@@ -156,8 +117,8 @@ You can run the frontend container locally by executing `make run-local` from th
 This sample application could be better with your help!
 
 - Add a new game!
-  - Implement game logic in the game class. See [TicTacToe.java](https://github.com/awslabs/eb-java-scorekeep/blob/fargate/src/main/java/scorekeep/TicTacToe.java).
-  - Add the class to [RulesFactory.java](https://github.com/awslabs/eb-java-scorekeep/blob/fargate/src/main/java/scorekeep/RulesFactory.java).
+  - Implement game logic in the game class. See [TicTacToe.java](https://github.com/awslabs/eb-java-scorekeep/blob/ecs/src/main/java/scorekeep/TicTacToe.java).
+  - Add the class to [RulesFactory.java](https://github.com/awslabs/eb-java-scorekeep/blob/ecs/src/main/java/scorekeep/RulesFactory.java).
 - Create your own client front end!
   - Web frameworks - Angular 2, React, ember, etc.
   - Mobile app