Clement Vachet commited on
Commit
821e9d8
1 Parent(s): 9b139db

docs: add AWS ECS deployment steps

Browse files
Files changed (1) hide show
  1. README.md +38 -4
README.md CHANGED
@@ -28,9 +28,43 @@ Command line:
28
 
29
  ## Back-end ML models
30
 
31
- ML models are available on Docker Hub and have been deployed on AWS ECS
32
 
33
-
34
- Docker hub containers:
35
  - DETR model: https://hub.docker.com/r/cvachet/object-detection-detr-api
36
- - YOLOS model: https://hub.docker.com/r/cvachet/object-detection-yolos-api
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
  ## Back-end ML models
30
 
31
+ Machine Learning (ML) models are available on Docker Hub and have been deployed on AWS ECS
32
 
33
+ **Docker hub containers:**
 
34
  - DETR model: https://hub.docker.com/r/cvachet/object-detection-detr-api
35
+ - YOLOS model: https://hub.docker.com/r/cvachet/object-detection-yolos-api
36
+
37
+ ## AWS ECS deployment steps:
38
+
39
+ ECS: Elastic Container Service
40
+ Steps after docker images are available on Docker Hub
41
+
42
+ ### Step 1. Create a new ECS task definition
43
+ - Task name (e.g. ObjectDetectionDETRTask)
44
+ - Infrastructure requirement:
45
+ - Launch type: ```AWS Fargate```
46
+ - Architecture: ```Linux/X86_64```
47
+ - Task size: ```0.5 CPU, 3GB memory```
48
+ - Container:
49
+ - Container name: (e.g. ```object-detection-detr```)
50
+ - Image uri: point to Docker image URI (e.g. ```cvachet/object-detection-detr-api```)
51
+ - Port mapping: assess port number (e.g. ```port 8000, TCP protocol```)
52
+
53
+
54
+ ### Step 2. Create a new ECS cluster
55
+ - Cluster name (e.g. ```ObjectDetectionCluster```)
56
+
57
+
58
+ ### Step 3. Add a new service to the cluster
59
+ - Compute configuration
60
+ - Use capacity provider strategy (e.g. using Fargate or Fargate_spot)
61
+ - Deployment configuration
62
+ - Application Type: Service
63
+ - Task Family: Select task definition family from prior instance (e.g. ```ObjectDetectionDETRTask```)
64
+ - Assign a Service Name: (e.g. ```object-detection-detr-api```)
65
+
66
+
67
+ ### Step 4. Update security group for new service
68
+ - Go to Cluster -> service -> task -> configuration and networking
69
+ - Click on ```Security Group```
70
+ - Adjust rules for inbound traffic (e.g. traffic only from my_ip)