Add Deployment Controller #34

enokawa · 2019-09-14T12:59:32Z

Add Deployment Controller for Blue/Green Deployment.
https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html

Ref: #33

I confirmed that B/G Deployment was successful using my own orb.

#!/bin/bash -eo pipefail
DEPLOYMENT_CONTROLLER="$(echo CODE_DEPLOY)"

if [ "${DEPLOYMENT_CONTROLLER}" = "CODE_DEPLOY" ]; then
    DEPLOYED_REVISION=$(aws deploy create-deployment \
        --application-name "AppECS-sample-cluster-sample" \
        --deployment-group-name "DgpECS-sample-cluster-sample" \
        --revision '{"revisionType": "AppSpecContent", "appSpecContent": {"content": "{\"version\": 1, \"Resources\": [{\"TargetService\": {\"Type\": \"AWS::ECS::Service\", \"Properties\": {\"TaskDefinition\": \"'${CCI_ORB_AWS_ECS_REGISTERED_TASK_DFN}'\", \"LoadBalancerInfo\": {\"ContainerName\": \"nginx\", \"ContainerPort\": 80}}}}]}"}}' \
        --query deploymentId)
else
  SERVICE_NAME="$(echo sample)"

  if [ -z "${SERVICE_NAME}" ]; then
      SERVICE_NAME="$(echo sample-app)"
  fi
  DEPLOYED_REVISION=$(aws ecs update-service \
      --cluster "sample-cluster" \
      --service "${SERVICE_NAME}" \
      --task-definition "${CCI_ORB_AWS_ECS_REGISTERED_TASK_DFN}" \
      --output text \
      --query service.taskDefinition)
fi
echo "export CCI_ORB_AWS_ECS_DEPLOYED_REVISION='${DEPLOYED_REVISION}'" >> $BASH_ENV

This is .circleci/config.yml .

version: 2.1
orbs:
  aws-ecr: circleci/aws-ecr@6.2.0
  aws-ecs: enokawa/aws-ecs@0.0.1
workflows:
  build_and_push_image:
    jobs:
      - aws-ecr/build-and-push-image:
          name: nginx
          account-url: AWS_ECR_ACCOUNT_URL
          aws-access-key-id: AWS_ACCESS_KEY_ID
          aws-secret-access-key: AWS_SECRET_ACCESS_KEY
          dockerfile: docker/nginx/Dockerfile
          region: AWS_REGION
          repo: sample/nginx
          tag: "${CIRCLE_SHA1}"
      - aws-ecr/build-and-push-image:
          name: php-fpm
          account-url: AWS_ECR_ACCOUNT_URL
          aws-access-key-id: AWS_ACCESS_KEY_ID
          aws-secret-access-key: AWS_SECRET_ACCESS_KEY
          dockerfile: docker/php-fpm/Dockerfile
          region: AWS_REGION
          repo: sample/php-fpm
          tag: "${CIRCLE_SHA1}"
      - aws-ecs/deploy-service-update:
          requires:
            - nginx
            - php-fpm
          family: 'sample-app'
          service-name: 'sample'
          cluster-name: 'sample-cluster'
          deployment-controller: 'CODE_DEPLOY'
          application-name: 'AppECS-sample-cluster-sample'
          deployment-group-name: 'DgpECS-sample-cluster-sample'
          container-name-for-code-deploy: 'nginx'
          container-port-for-code-deploy: 80
          container-image-name-updates: 'container=nginx,image-and-tag=${AWS_ECR_ACCOUNT_URL}/sample/nginx:${CIRCLE_SHA1},container=php-fpm,image-and-tag=${AWS_ECR_ACCOUNT_URL}/sample/php-fpm:${CIRCLE_SHA1}'

lokst · 2019-09-16T03:54:30Z

@enokawa Thank you so much for taking this on and do let us know once the PR is ready for review 🙂

enokawa · 2019-09-19T15:41:20Z

@lokst Please code review!!

lokst · 2019-09-20T05:06:06Z

@enokawa Thank you, I'll review this as soon as possible!

lokst · 2019-09-30T03:15:08Z

src/orb.yml.hbs

+      deployment-controller:
+        description:
+          "The deployment controller to use for the service. Defaulted to ECS"
+        type: string


I think it would be great if the type could be an enum: https://circleci.com/docs/2.0/reusing-config/#enum

Fixed by 4da210a .

lokst · 2019-09-30T03:19:41Z

src/orb.yml.hbs

+          "The deployment controller to use for the service. Defaulted to ECS"
+        type: string
+        default: "ECS"
+      application-name:


Could this be changed to codedeploy-application-name for clarity?

Fixed by e4fd0ed .

lokst · 2019-09-30T03:25:01Z

src/orb.yml.hbs

+        default: "ECS"
+      application-name:
+        description:
+          "The name of an AWS CodeDeploy application."


I would like to add some more details to the description to clarify the purpose of this parameter:

description: | The name of the AWS CodeDeploy application used for the deployment. Only effective when the deployment-controller parameter value is "C ODE_DEPLOY".

Fixed by 302f398 .

lokst · 2019-09-30T03:25:57Z

src/orb.yml.hbs

+          "The name of an AWS CodeDeploy application."
+        type: string
+        default: ""
+      deployment-group-name:


Could this be changed to codedeploy-deployment-group-name for clarity?

Fixed by 80b9c36 .

lokst · 2019-09-30T03:27:05Z

src/orb.yml.hbs

+        default: ""
+      deployment-group-name:
+        description:
+          "The name of an AWS CodeDeploy deployment group."


I would like to add some more details to the description to clarify the purpose of this parameter, like this:

description: | The name of the AWS CodeDeploy deployment group used for the deployment. Only effective when the deployment-controller parameter value is "C ODE_DEPLOY".

Fixed by a84730b .

lokst · 2019-09-30T03:47:05Z

src/orb.yml.hbs

+          "The name of an AWS CodeDeploy deployment group."
+        type: string
+        default: ""
+      container-name-for-code-deploy:


Could this be changed to codedeploy-load-balanced-container-name for clarity? (Please feel free to suggest a better name!)

Fixed by adcb99c .

lokst · 2019-09-30T03:48:24Z

src/orb.yml.hbs

+        default: ""
+      container-name-for-code-deploy:
+        description:
+          "The name of the container for CodeDeploy."


I would like to add some more details to the description to clarify the purpose of this parameter, like this:

description: | The name of the container to be load-balanced via AWS CodeDeploy. Only effective when the deployment-controller parameter value is "C ODE_DEPLOY".

Fixed by 3bd0e61 .

lokst · 2019-09-30T03:48:51Z

src/orb.yml.hbs

+          "The name of the container for CodeDeploy."
+        type: string
+        default: ""
+      container-port-for-code-deploy:


Could this be changed to codedeploy-load-balanced-container-port for clarity? (Please feel free to suggest a better name!)

Fixed by 102d851 .

lokst · 2019-09-30T03:49:20Z

src/orb.yml.hbs

+        default: ""
+      container-port-for-code-deploy:
+        description:
+          "The port of the container for CodeDeploy."


I would like to add some more details to the description to clarify the purpose of this parameter, like this:

description: | The port of the container to be load-balanced via AWS CodeDeploy. Only effective when the deployment-controller parameter value is "C ODE_DEPLOY".

Fixed by b7e161f .

lokst · 2019-09-30T04:02:18Z

src/orb.yml.hbs

+                    --application-name "<< parameters.application-name >>" \
+                    --deployment-group-name "<< parameters.deployment-group-name >>" \
+                    --revision '{"revisionType": "AppSpecContent", "appSpecContent": {"content": "{\"version\": 1, \"Resources\": [{\"TargetService\": {\"Type\": \"AWS::ECS::Service\", \"Properties\": {\"TaskDefinition\": \"'${CCI_ORB_AWS_ECS_REGISTERED_TASK_DFN}'\", \"LoadBalancerInfo\": {\"ContainerName\": \"<< parameters.container-name-for-code-deploy >>\", \"ContainerPort\": << parameters.container-port-for-code-deploy >>}}}}]}"}}' \
+                    --query deploymentId)


What do you think of the following changes? That way, the verify-revision-is-deployed parameter should still be able to work if set to true.

DEPLOYED_REVISION="${CCI_ORB_AWS_ECS_REGISTERED_TASK_DFN}" DEPLOYMENT_ID=$(aws deploy create-deployment ...)

and also adding echo "Created CodeDeploy deployment: $DEPLOYMENT_ID"

This is great changes! I fixed by ae19b28 .

lokst

@enokawa Thanks so much for this PR. I tested them and found that they work well. I've made some suggestions here and would love if you can review them!

enokawa · 2019-10-01T12:47:25Z

@lokst Thank you for your review!
I'll fix them.

…up-name

…balanced-container-name

…balanced-container-port

enokawa · 2019-10-01T15:12:51Z

@lokst I Fixed them. Please code review again.
And also big thanks for create some tests!!

lokst · 2019-10-01T16:43:03Z

src/orb.yml.hbs

@@ -530,24 +535,28 @@ commands:
          "The deployment controller to use for the service. Defaulted to ECS"
        type: string


I missed out on this in my earlier review. Could this be changed to an enum too? 🙂

Sorry, I missed too. Fixed by 500ac8c .

lokst

Thank you for your changes! I gave this a test and realized that some changes will be required to the verify-revision-is-deployed command in order to support verification for blue/green deployments. Hence could you also update the description of theverify-revision-is-deployed command and verify-revision-is-deployed parameter to add something like "Does not support ECS services that are of the blue/green deployment type." (Of course, feel free to add support for verify-revision-is-deployed: true if you like, in this PR or another)

lokst · 2019-10-02T07:29:22Z

Thanks @enokawa, could you also update the description of the verify-revision-is- deployedcommand and verify-revision-is-deployed parameter to add something like "Does not support ECS services that are of the blue/green deployment type", and also pull in the latest changes in master branch?

enokawa · 2019-10-03T07:37:33Z

@lokst Sorry I'm late. I was update verify-revision-is-deployed command and parameter description.
And also I merged master branch changes.

enokawa · 2019-10-03T07:42:04Z

And I will add support for verify-revision-is-deployed another PR!!

lokst · 2019-10-04T01:25:21Z

Thanks @enokawa! I am out of office most of this week and will review this once I'm back next week!

lokst · 2019-10-06T20:32:47Z

@enokawa Thanks so much for contributing this new feature of blue/green deployment support! Your changes are now available in version 0.0.12 of the orb!

enokawa · 2019-10-07T04:44:32Z

@lokst Thanks so much!!
I'll try version 0.0.12 of the orb soon!

Add Deployment Controller

4230214

enokawa requested review from iynere and lokst as code owners September 14, 2019 12:59

enokawa mentioned this pull request Sep 14, 2019

Support Blue/Green Deployment #33

Closed

Set default value for container-port-for-code-deploy.

58ccb7d

enokawa added 2 commits September 20, 2019 00:17

Add parameters

d1bf45d

Fix typo

cf72b5e

enokawa changed the title ~~[WIP] Add Deployment Controller~~ Add Deployment Controller Sep 19, 2019

lokst reviewed Sep 30, 2019

View reviewed changes

lokst suggested changes Sep 30, 2019

View reviewed changes

lokst self-assigned this Sep 30, 2019

lokst mentioned this pull request Oct 1, 2019

[CIRCLE-21355][CIRCLE-21358] Add blue/green deployment type ECS service setup to tests #37

Merged

enokawa added 5 commits October 1, 2019 22:04

Fix deployment-controller parameter type string to enum

4da210a

Fix application-name parameter name to codedeploy-application-name

e4fd0ed

Fix codedeploy-application-name parameter description

302f398

Fix deployment-group-name parameter name to codedeploy-deployment-gro…

80b9c36

…up-name

Fix codedeploy-deployment-group-name parameter description

a84730b

enokawa added 5 commits October 1, 2019 23:13

Fix container-name-for-code-deploy parameter name to codedeploy-load-…

adcb99c

…balanced-container-name

Fix codedeploy-load-balanced-container-name parameter description

3bd0e61

Fix container-port-for-code-deploy parameter name to codedeploy-load-…

102d851

…balanced-container-port

Fix codedeploy-load-balanced-container-port parameter description

b7e161f

Fix so that verify-revision-is-deployed can still be able to work

ae19b28

lokst reviewed Oct 1, 2019

View reviewed changes

lokst suggested changes Oct 1, 2019

View reviewed changes

Fix deployment-controller parameter type string to enum

500ac8c

enokawa added 2 commits October 3, 2019 16:09

verify-revision-is-deployed does not support Blue/Green Deployment

8efd01a

Merge branch 'master' into bg-deploy

fe6c9c4

enokawa requested a review from lokst October 3, 2019 12:40

lokst approved these changes Oct 6, 2019

View reviewed changes

lokst merged commit cc110ab into CircleCI-Public:master Oct 6, 2019

lokst added the enhancement New feature or request label Oct 6, 2019

lokst added this to the 0.0.12 milestone Oct 6, 2019

enokawa deleted the bg-deploy branch October 7, 2019 04:44

enokawa mentioned this pull request Jan 27, 2020

Support verify-revision-is-deployed command when deployment-controller is CODE_DEPLOY #93

Closed

		@@ -530,24 +535,28 @@ commands:
		"The deployment controller to use for the service. Defaulted to ECS"
		type: string

Add Deployment Controller #34

Add Deployment Controller #34

Conversation

enokawa commented Sep 14, 2019 • edited Loading

lokst commented Sep 16, 2019 • edited Loading

enokawa commented Sep 19, 2019

lokst commented Sep 20, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lokst Sep 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

enokawa Oct 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lokst left a comment

Choose a reason for hiding this comment

enokawa commented Oct 1, 2019

enokawa commented Oct 1, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lokst left a comment • edited Loading

Choose a reason for hiding this comment

lokst commented Oct 2, 2019 • edited Loading

enokawa commented Oct 3, 2019 • edited Loading

enokawa commented Oct 3, 2019

lokst commented Oct 4, 2019

lokst commented Oct 6, 2019

enokawa commented Oct 7, 2019

enokawa commented Sep 14, 2019 •

edited

Loading

lokst commented Sep 16, 2019 •

edited

Loading

lokst Sep 30, 2019 •

edited

Loading

enokawa Oct 1, 2019 •

edited

Loading

lokst left a comment •

edited

Loading

lokst commented Oct 2, 2019 •

edited

Loading

enokawa commented Oct 3, 2019 •

edited

Loading