手動デプロイにさようなら！GitLab CIで実現するECS/ECRへの自動デプロイ

ECRレジストリ: xxx.dkr.ecr.ap-northeast-1.amazonaws.com
ECRリポジトリ: your-repo-name
ECSクラスター: your-cluster-name
ECSサービス: your-service-name
タスク定義: your-task-definition

services:
  - docker:dind

variables:
  AWS_DEFAULT_REGION: ap-northeast-1

stages:
  - build
  - deploy

image-build:
  stage: build
  image: docker:latest
  script:
    - aws ecr get-login-password --region ${AWS_DEFAULT_REGION} | docker login --username AWS --password-stdin ${ECR_REGISTRY}
    - docker build -t ${ECR_REGISTRY}/${ECR_REPOSITORY}:${CI_COMMIT_TAG} .
    - docker push ${ECR_REGISTRY}/${ECR_REPOSITORY}:${CI_COMMIT_TAG}
  rules:
    - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/   

task-deploy:
  stage: deploy
  image: docker:latest
  script:
    - export NEW_IMAGE="${ECR_REGISTRY}/${ECR_REPOSITORY}:${CI_COMMIT_TAG}"
    - aws ecs describe-task-definition --task-definition ${TASK_DEFINITION} --output json > temp.json
    - jq '.taskDefinition | del (.taskDefinitionArn, .revision, .status, .requiresAttributes, .compatibilities, .registeredAt, .registeredBy)' temp.json > task-def.json
    - jq --arg NEW_IMAGE "${NEW_IMAGE}" '.containerDefinitions[0].image = $NEW_IMAGE' task-def.json > new-task-def.json
    - aws ecs register-task-definition --cli-input-json file://new-task-def.json
    - aws ecs update-service --cluster ${ECS_CLUSTER} --service ${ECS_SERVICE} --task-definition ${TASK_DEFINITION}
    - aws ecs wait services-stable --cluster ${ECS_CLUSTER} --services ${ECS_SERVICE}
  rules:
    - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/  

# ECRへのプッシュに必要な変数
ECR_REGISTRY: ${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_DEFAULT_REGION}.amazonaws.com
ECR_REPOSITORY: your-repository-name

# ECSの更新に必要な変数
ECS_CLUSTER: your-cluster-name
ECS_SERVICE: your-service-name
TASK_DEFINITION: your-task-definition-name

# ECRへのログイン
aws ecr get-login-password --region ${AWS_DEFAULT_REGION} | docker login --username AWS --password-stdin ${ECR_REGISTRY}

# イメージのビルドとプッシュ
docker build -t ${ECR_REGISTRY}/${ECR_REPOSITORY}:${CI_COMMIT_TAG} .
docker push ${ECR_REGISTRY}/${ECR_REPOSITORY}:${CI_COMMIT_TAG}

# 現在のタスク定義を取得
aws ecs describe-task-definition --task-definition ${TASK_DEFINITION} --output json > temp.json

# 不要なフィールドを削除
jq '.taskDefinition | del (.taskDefinitionArn, .revision, .status, .requiresAttributes, .compatibilities, .registeredAt, .registeredBy)' temp.json > task-def.json

# 新しいイメージURIを設定
jq --arg NEW_IMAGE "${NEW_IMAGE}" '.containerDefinitions[0].image = $NEW_IMAGE' task-def.json > new-task-def.json

# 新しいタスク定義を登録
aws ecs register-task-definition --cli-input-json file://new-task-def.json

# サービスを更新
aws ecs update-service --cluster ${ECS_CLUSTER} --service ${ECS_SERVICE} --task-definition ${TASK_DEFINITION}

# サービスが安定するまで待機
aws ecs wait services-stable --cluster ${ECS_CLUSTER} --services ${ECS_SERVICE}ECS

rules:
  - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/   

script:
  - docker build -t ${ECR_REGISTRY}/${ECR_REPOSITORY}:${CI_COMMIT_TAG} .

# 以下のような形
your-repo:v1.0.1
your-repo:v1.1.0
your-repo:v2.0.0

# アンチパターン
your-repo:latest    # どのバージョンが使われているか不明確
your-repo:stable    # 「安定版」の定義があいまい
your-repo:test      # 一時的なタグは避ける

# 本番環境で動いているバージョン
your-repo:latest  # 現在はv1.0.0を指している

# 新バージョンのデプロイ
your-repo:latest  # いつの間にかv1.1.0を指すように変更される