Merge pull request #77 from buildkite-plugins/toote_container_defs_task_defs

Container/Task/Service definitions

Author: pzeballos

.buildkite/pipeline.yml

@@ -1,7 +1,7 @@
 steps:
   - label: ":docker: :hammer:"
     plugins:
-      docker-compose#v3.9.0:
+      docker-compose#v3.10.0:
         run: tests
 
   - label: ":shell: Lint"

README.md

@@ -18,7 +18,7 @@ steps:
       - ecs-deploy#v1.4.1:
           cluster: "my-ecs-cluster"
           service: "my-service"
-          task-definition: "examples/hello-world.json"
+          container-definitions: "examples/hello-world.json"
           task-family: "hello-world"
           image: "${ECR_REPOSITORY}/hello-world:${BUILDKITE_BUILD_NUMBER}"
 ```
@@ -37,11 +37,62 @@ The name of the ECS service.
 
 Example: `"my-service"`
 
+### `container-definitions`
+
+The file path to the ECS container definition JSON file. This JSON file must be an array of objects, each corresponding to one of the images you defined in the `image` parameter.
+
+Example: `"ecs/containers.json"`
+```json
+[
+    {
+        "essential": true,
+        "image": "amazon/amazon-ecs-sample",
+        "memory": 100,
+        "name": "sample",
+        "portMappings": [
+            {
+                "containerPort": 80,
+                "hostPort": 80
+            }
+        ]
+    },
+    {
+        "essential": true,
+        "image": "amazon/amazon-ecs-sample",
+        "memory": 100,
+        "name": "sample",
+        "portMappings": [
+            {
+                "containerPort": 80,
+                "hostPort": 80
+            }
+        ]
+    }
+]
+```
+
 ### `task-definition`
 
-The file path to the ECS task definition JSON file.
+The file path to the ECS task definition JSON file. Parameters specified in this file will be overridden by other arguments if set. Setting the `containers` property in this file will have no effect, define those parameters in `container-definitions`
 
 Example: `"ecs/task.json"`
+```json
+{
+  "networkMode": "awsvpc"
+}
+```
+
+### `service-definition`
+
+The file path to the ECS service definition JSON file. Parameters specified in this file will be overridden by other arguments if set, e.g. `cluster`, `desired-count`, etc. Note that currently this json input will only be used when creating the service, NOT when updating it.
+
+Example: `"ecs/service.json"`
+```json
+{
+  "schedulingStrategy": "DAEMON",
+  "propagateTags": "TASK_DEFINITION"
+}
+```
 
 ### `task-family`
 

docker-compose.yml

@@ -1,6 +1,6 @@
 version: '2'
 services:
   tests:
-    image: buildkite/plugin-tester:v3.0.0
+    image: buildkite/plugin-tester:v3.0.1
     volumes:
       - ".:/plugin:ro"

examples/service-definition.json

@@ -0,0 +1,4 @@
+{
+    "schedulingStrategy": "DAEMON",
+    "propagateTags": "TASK_DEFINITION"
+}

examples/task-definition.json

@@ -0,0 +1,3 @@
+{
+    "networkMode": "awsvpc"
+}

hooks/command

@@ -31,7 +31,9 @@ images=()
 while read -r line ; do
   [[ -n "$line" ]] && images+=("$line")
 done <<< "$(plugin_read_list IMAGE)"
-task_definition=${BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION?}
+task_definition=${BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION:-""}
+service_definition=${BUILDKITE_PLUGIN_ECS_DEPLOY_SERVICE_DEFINITION:-""}
+container_definitions=${BUILDKITE_PLUGIN_ECS_DEPLOY_CONTAINER_DEFINITIONS?}
 desired_count=${BUILDKITE_PLUGIN_ECS_DEPLOY_DESIRED_COUNT:-"1"}
 task_role_arn=${BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_ROLE_ARN:-""}
 target_group=${BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_GROUP:-""}
@@ -60,9 +62,9 @@ min_max_percent=(${deployment_config//\// })
 min_deploy_perc=${min_max_percent[0]}
 max_deploy_perc=${min_max_percent[1]}
 
-if [[ $(jq '. | keys |first' "$task_definition") != "0" ]]; then
+if [[ $(jq '. | keys |first' "$container_definitions") != "0" ]]; then
     echo "^^^"
-    echo "Invalid Task Definition"
+    echo "Invalid Container Definitions"
     echo 'JSON definition should be in the format of [{"image": "..."}]'
     exit 1
 fi
@@ -74,6 +76,11 @@ function create_service() {
     local desired_count=$4
     local target_group_arguments
     target_group_arguments=$(generate_target_group_arguments "$5" "$6" "$7")
+    
+    local service_definition_json="{}"
+    if [[ -n "${service_definition}" ]]; then
+      service_definition_json=$(cat "${service_definition}")
+    fi
 
     # shellcheck disable=SC2016
     service_defined=$(aws ecs describe-services --cluster "$cluster_name" --service "$service_name" --query 'services[?status==`ACTIVE`].status' --output text |wc -l)
@@ -86,7 +93,8 @@ function create_service() {
         --task-definition "$task_definition" \
         --desired-count "$desired_count" \
         --deployment-configuration "maximumPercent=${max_deploy_perc},minimumHealthyPercent=${min_deploy_perc}" \
-        $target_group_arguments
+        $target_group_arguments \
+        --cli-input-json "$service_definition_json"
     fi
 }
 
@@ -115,7 +123,7 @@ function generate_target_group_arguments() {
 
 ## This is the template definition of your containers
 image_idx=0
-container_definitions_json=$(cat "${task_definition}")
+container_definitions_json=$(cat "${container_definitions}")
 for image in "${images[@]}"; do
   container_definitions_json=$(echo "$container_definitions_json" | jq --arg IMAGE "$image" \
   ".[${image_idx}].image=\$IMAGE"
@@ -149,6 +157,13 @@ if [[ -n "${execution_role}" ]]; then
     register_command+=" --execution-role-arn ${execution_role}"
 fi
 
+if [[ -n "${task_definition}" ]]; then
+    task_definition_json=$(cat "${task_definition}")
+    register_command+=" --cli-input-json '${task_definition_json}'"
+fi
+
+echo "--- :ecs: register command:"
+
 json_output=$(eval "$register_command")
 register_exit_code=$?
 

plugin.yml

@@ -8,12 +8,16 @@ configuration:
   properties:
     cluster:
       type: string
+    container-definitions:
+      type: string
     service:
       type: string
     task-definition:
       type: string
     task-family:
       type: string
+    service-definition:
+      type: string
     image:
       type: [ string, array ]
     desired-count:
@@ -37,6 +41,6 @@ configuration:
   required:
     - cluster
     - service
-    - task-definition
+    - container-definitions
     - task-family
     - image