Skip to content

Commit a93a243

Browse files
committed
readme
1 parent dc17ac3 commit a93a243

File tree

1 file changed

+40
-5
lines changed

1 file changed

+40
-5
lines changed

README.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ Use the procedures in the following sections to run the project on Fargate and c
3333
- [Contributing](#contributing)
3434

3535
# Prerequisites
36-
- Docker installed locally
37-
- AWS CLI installed locally with permission for: IAM, DynamoDB, SNS, ECS, Cloudwatch Logs, and ECR
36+
Install the following tools to create Docker images, upload them to ECR, and register task definitions with ECS.
37+
- Docker
38+
- AWS CLI v1.14.0+
39+
- AWS user with permission for IAM, DynamoDB, SNS, ECS, CloudWatch Logs, and ECR
3840

3941
# Repository Layout
4042
The project contains two independent applications:
@@ -63,15 +65,48 @@ The Java application is built using the gradle Docker container so it does not r
6365

6466
# Deploying the application
6567

66-
To deploy the containers to your AWS Account,
68+
*To deploy the containers to your AWS Account*
6769

6870
1. Setup the Cloudformation stack to create the prerequisite resources by executing `make stack` in the `cloudformation/` folder
6971
2. Build and Publish your API container to the ECR repository created by Cloudformation executing `make publish` in the root folder
7072
3. Build and Publish your Frontend container to the ECR repository created by Cloudformation executing `make publish` in the `scorekeep-frontend/` folder
7173
4. Populate your Task Definition with the correct region and account id using the `generate-task-definition` script in the `task-definition` folder
7274
5. Register your Task Definition to ECS with `aws ecs register-task-definition --cli-input-json file://scorekeep-task-definition.json`
73-
6. Launch your Service or Task using the AWS CLI, ECS CLI, or AWS Console
74-
75+
6. Launch your Service or Task using the AWS CLI, ECS CLI, or AWS Management Console
76+
77+
To create a Fargate Service for Scorekeep with the ECS console
78+
79+
1. Open [the ECS console](https://console.aws.amazon.com/ecs/home).
80+
2. Click **Create cluster**.
81+
3. Select **Networking only** and click **Next step**.
82+
4. Enter *scorekeep-cluster* for the cluster name and click **Create**.
83+
5. Choose **View cluster**.
84+
6. Under **Services**, click **Create**.
85+
7. Create a service with the following settings. Click **Next Step** to proceed through each page as necessary.
86+
- Launch type: **Fargate**
87+
- Task definition: **scorekeep:1**
88+
- Platform version: **latest**
89+
- Cluster: **scorekeep-cluster**
90+
- Service name: **scorekeep-service**
91+
- Number of tasks: **4**
92+
- Minimum healthy percent: **50**
93+
- Maximum percent: **200**
94+
- Cluster VPC: **scorekeep**
95+
- Subnets: both **scorekeep_Private** subnets
96+
- Security groups: click Edit > Select existing > select **default**
97+
- Auto-assign public IP: **enabled**
98+
- Load balancer type: **Application load balancer**
99+
- Load balancer name: **scorekeep-lb**
100+
- Container name: **scorekeep-frontend** (click **Add to load balancer**)
101+
- Listener port: **80:HTTP**
102+
- Target group name: **Create new**
103+
- Path pattern: /
104+
- Health check pattern: /
105+
- Service auto scaling: **Do not adjust**
106+
8. Choose **View service**.
107+
9. Open the [load balancers screen](https://console.aws.amazon.com/ec2/v2/home#LoadBalancers:) in the EC2 console.
108+
10. Choose **scorekeep-lb**.
109+
11. Under **Description**, copy the **DNS name** and open it.
75110

76111
![Scorekeep flow](/img/scorekeep-flow.png)
77112

0 commit comments

Comments
 (0)