Add ecs-params service resource fields to README

allisaurus · allisaurus · commit fbcac16f87d3 · 2018-06-29T09:36:26.000-07:00
diff --git a/README.md b/README.md
@@ -422,6 +422,9 @@ task_definition:
   services:
     <service_name>:
       essential: boolean
+      cpu_shares: integer
+      mem_limit: string
+      mem_reservation: string
 
 run_params:
   network_configuration:
@@ -441,8 +444,24 @@ Fields listed under `task_definition` correspond to fields that will be included
 
 * `task_role_arn` should be the ARN of an IAM role. **NOTE**: If this role does not have the proper permissions/trust relationships on it, the `up` command will fail.
 
-* `services` correspond to the services listed in your docker compose file, with `service_name` matching the name of the container you wish to run. Its fields will be merged into an [ECS Container Definition](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html).
-The only field you can specify on it is `essential`. The default value for the essential field is true.
+* `services` correspond to the services listed in your docker compose file, with `service_name` matching the name of the container you wish to run. Its fields will be merged into an [ECS Container Definition](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html). 
+  * If the [`essential`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-essential) field is not specified, the value defaults to true. 
+  * If you are using Docker compose version 3, the `cpu_shares`, `mem_limit`, and `mem_reservation` fields are optional and must be specified in the ECS params file rather than the compose file. 
+  * In Docker compose version 2, the `cpu_shares`, `mem_limit`, and `mem_reservation` fields can be specified in either the compose or ECS params file. If they are specified in the ECS params file, the values will override values present in the compose file.
+
+Example `ecs-params.yml` with service resources specified:
+```
+version: 1
+task_definition:
+  services:
+    wordpress:
+      cpu_shares: 100
+      mem_limit: 500m
+    mysql:
+      cpu_shares: 105
+      mem_limit: 500m
+      mem_reservation: 450m
+```
 
 * `task_execution_role` should be the ARN of an IAM role. **NOTE**: This field is required to enable ECS Tasks to be configured with Cloudwatch Logs, or to pull images from ECR for your tasks.
 
