ECS B/Gデプロイについて –ECS ネイティブB/Gデプロイ編–

こんにちは、またはこんばんは、関根です。 私実は趣味で毎週野球をやって


こんにちは、またはこんばんは、関根です。

私実は趣味で毎週野球をやってたりします。
これがまた最近はやたら調子がいいのです^^
この前の試合では投げては1回、三振を含むパーフェクトなピッチング
打っては2打数2安打2打点1死球
守っては全ての守備機会で完璧なグラブさばき&送球で全てアウトに…とやたら調子がいいです。
私が所属している草野球チームでは変わった風習がありまして、その日一番活躍した人をMVPとして記念写真を撮影、1週間チームのLINEグループのサムネイルとして使用されるという証人欲求爆上がりな習わしがあります。
最高の活躍してしまった筆者は当たり前のように1週間MVPとして崇め奉られましたv^^v

与太話はこの辺りとしまして、前回に続いてECS B/Gデプロイに関する内容を掲載したいと思います。
前回は、以下CloudFormationによるHooksを活用したB/Gデプロイを紹介しました。
リンク:ECS B/Gデプロイについて –CloudFormation Hooks編–

今回は、割と新しい(たしか2025年7月くらい実装された?)ECSのネイティブ機能を活用したB/Gデプロイに関して検証していきたいと思います。
前回同様長めの内容になると思いますが、最後までお付き合いいただけると幸いです。


1.目次

  • 1.目次
  • 2.Cfnテンプレート作成
  • 3.検証環境作成
  • 4.検証環境リソース確認
  • 5.検証環境再構築
  • 6.B/Gデプロイ検証
  • 7.ECS ネイティブB/Gを試してみた感想とか、なんとか
  • 8.まとめ
  • 9.最後に

2.Cfnテンプレート作成

例のごとく検証環境を構築するためのテンプレートを作成します。
今回は以下のような内容のテンプレートを作成しました。

AWSTemplateFormatVersion: 2010-09-09

# ------------------------------------------------------------#
# Parameters
# ------------------------------------------------------------#
Parameters:
  #デプロイ種類を指定(初期構築はblue)
  DeployType:
    Type: String
    Default: blue
    AllowedValues:
      - blue
      - green
  RepositoryName:
    Type: String
    Default: bg-test

  #実リソースの値を利用するようパラメータを定義
  Vpc:
    Type: 'AWS::EC2::VPC::Id'
  Subnet1:
    Type: 'AWS::EC2::Subnet::Id'
  Subnet2:
    Type: 'AWS::EC2::Subnet::Id'

# ------------------------------------------------------------#
# Resources
# ------------------------------------------------------------#
Resources:
#Blue/Greenデプロイ環境を構成する各リソースを定義
  # ------------------------------------------------------------#
  # IAM:ロール
  # ------------------------------------------------------------#
  ECSTaskExecutionRole:
    Type: 'AWS::IAM::Role'
    Properties:
      #ロール名
      RoleName: "BGTEST-ECSTaskExecutionRole"
      #ポリシードキュメント
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Sid: ''
            Effect: Allow
            Principal:
              Service: ecs-tasks.amazonaws.com
            Action: 'sts:AssumeRole'
      #ロールに付与するポリシーのArn
      ManagedPolicyArns:
        - 'arn:aws:iam::aws:policy/service-role/AmazonECSTaskExecutionRolePolicy'

  ECSExecutionRole:
    Type: 'AWS::IAM::Role'
    Properties:
      #ロール名
      RoleName: "BGTEST-ECSExecutionRole"
      #ポリシードキュメント
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Sid: ''
            Effect: Allow
            Principal:
              Service: ecs.amazonaws.com
            Action: 'sts:AssumeRole'
      #ロールに付与するポリシーのArn
      ManagedPolicyArns:
        - 'arn:aws:iam::aws:policy/AmazonECSInfrastructureRolePolicyForLoadBalancers'

  # ------------------------------------------------------------#
  # SG
  # ------------------------------------------------------------#
  SecurityGroup:
    Type: 'AWS::EC2::SecurityGroup'
    Properties:
      #SGの説明
      GroupDescription: Security group for ec2 access
      #VPCのID
      VpcId: !Ref Vpc
      #インバウンドルール
      SecurityGroupIngress:
        - IpProtocol: tcp
          FromPort: 80
          ToPort: 80
          CidrIp: 0.0.0.0/0
        - IpProtocol: tcp
          FromPort: 8080
          ToPort: 8080
          CidrIp: 0.0.0.0/0
        - IpProtocol: tcp
          FromPort: 22
          ToPort: 22
          CidrIp: 0.0.0.0/0
      Tags:
        - Key: "Name"
          Value: "BGTEST-sg"

  # ------------------------------------------------------------#
  # ALB:ターゲットグループ(Blue環境)
  # ------------------------------------------------------------#
  ALBTargetGroupBlue:
    Type: 'AWS::ElasticLoadBalancingV2::TargetGroup'
    Properties:
      #ヘルスチェック間隔(秒)
      HealthCheckIntervalSeconds: 5
      #ヘルスチェックパス
      HealthCheckPath: /
      #ヘルスチェックに利用するポート
      HealthCheckPort: '80'
      #ヘルスチェックに利用するプロトコル
      HealthCheckProtocol: HTTP
      #ヘルスチェックのタイムアウト時間(秒)
      HealthCheckTimeoutSeconds: 2
      #ターゲットが正常であると判断するために必要なヘルスチェックの連続成功回数
      HealthyThresholdCount: 2
      #ヘルスチェック正常時に利用するコード
      Matcher:
        HttpCode: '200'
      #ターゲットの受信ポート
      Port: 80
      #ターゲットへの通信に利用するプロトコル
      Protocol: HTTP
      #タグ
      Tags:
        - Key: Name
          Value: BGTEST-ALB-TG-Blue
      #ターゲットのタイプ
      TargetType: ip
      #ターゲットが異常であると判断するために必要なヘルスチェックの連続失敗回数
      UnhealthyThresholdCount: 4
      #VPCのID
      VpcId: !Ref Vpc
      Name: bg-test-tg-blue

  # ------------------------------------------------------------#
  # ALB:ターゲットグループ(Green環境)
  # ------------------------------------------------------------#
  ALBTargetGroupGreen:
    Type: 'AWS::ElasticLoadBalancingV2::TargetGroup'
    Properties:
      #ヘルスチェック間隔(秒)
      HealthCheckIntervalSeconds: 5
      #ヘルスチェックパス
      HealthCheckPath: /
      #ヘルスチェックに利用するポート
      HealthCheckPort: '80'
      #ヘルスチェックに利用するプロトコル
      HealthCheckProtocol: HTTP
      #ヘルスチェックのタイムアウト時間(秒)
      HealthCheckTimeoutSeconds: 2
      #ターゲットが正常であると判断するために必要なヘルスチェックの連続成功回数
      HealthyThresholdCount: 2
      #ヘルスチェック正常時に利用するコード
      Matcher:
        HttpCode: '200'
      #ターゲットの受信ポート
      Port: 80
      #ターゲットへの通信に利用するプロトコル
      Protocol: HTTP
      #タグ
      Tags:
        - Key: Name
          Value: BGTEST-ALB-TG-Green
      #ターゲットのタイプ
      TargetType: ip
      #ターゲットが異常であると判断するために必要なヘルスチェックの連続失敗回数
      UnhealthyThresholdCount: 4
      #VPCのID
      VpcId: !Ref Vpc
      Name: bg-test-tg-green

  # ------------------------------------------------------------#
  # ALB
  # ------------------------------------------------------------#
  ALB:
    Type: 'AWS::ElasticLoadBalancingV2::LoadBalancer'
    Properties:
      #ロードバランサーの属性
      #LoadBalancerAttributes
      #スキーマ
      Scheme: internet-facing
      #関連付けるSG
      SecurityGroups:
        - !Ref SecurityGroup
      #関連付けるサブネット
      Subnets:
        - !Ref Subnet1
        - !Ref Subnet2
      #タグ
      Tags:
        - Key: Name
          Value: BGTEST-ALB
      #ロードバランサーのタイプ
      Type: application
      #IPのタイプ
      IpAddressType: ipv4
      Name: bg-test-alb

  # ------------------------------------------------------------#
  # ALB:リスナー
  # ------------------------------------------------------------#
  ALBListenerProd:
    Type: 'AWS::ElasticLoadBalancingV2::Listener'
    Properties:
      #デフォルトルールのアクション
      DefaultActions:
          #アクションのタイプ
        - Type: forward
          TargetGroupArn: !Ref ALBTargetGroupBlue

      #紐づけ先ALBのArn
      LoadBalancerArn: !Ref ALB
      #ロードバランサーがリッスンしているポート
      Port: 80
      #ロードバランサーへの接続に使用するプロトコル
      Protocol: HTTP

  ALBListenerStg:
    Type: 'AWS::ElasticLoadBalancingV2::Listener'
    Properties:
      #デフォルトルールのアクション
      DefaultActions:
          #アクションのタイプ
        - Type: forward
          TargetGroupArn: !Ref ALBTargetGroupGreen
      #紐づけ先ALBのArn
      LoadBalancerArn: !Ref ALB
      #ロードバランサーがリッスンしているポート
      Port: 8080
      #ロードバランサーへの接続に使用するプロトコル
      Protocol: HTTP

  # ------------------------------------------------------------#
  # ALB:リスナールール
  # ------------------------------------------------------------#
  ALBListenerProdRule:
    Type: 'AWS::ElasticLoadBalancingV2::ListenerRule'
    Properties:
      #リスナールールのアクション
      Actions:
          #アクションのタイプ
        - Type: forward
          TargetGroupArn: !Ref ALBTargetGroupBlue
      #ルールの条件
      Conditions:
          #HTTPリクエスト内のフィールド
        - Field: http-header
          #HTTPヘッダー条件の情報
          HttpHeaderConfig:
            #HTTPヘッダーフィールドの名前
            HttpHeaderName: User-Agent
            #HTTPヘッダーの値と比較する文字列
            Values:
              - Mozilla
      #紐づけ先リスナーのArn
      ListenerArn: !Ref ALBListenerProd
      #ルールの優先度
      Priority: 1

  ALBListenerStgRule:
    Type: 'AWS::ElasticLoadBalancingV2::ListenerRule'
    Properties:
      #リスナールールのアクション
      Actions:
          #アクションのタイプ
        - Type: forward
          TargetGroupArn: !Ref ALBTargetGroupGreen
      #ルールの条件
      Conditions:
          #HTTPリクエスト内のフィールド
        - Field: http-header
          #HTTPヘッダー条件の情報
          HttpHeaderConfig:
            #HTTPヘッダーフィールドの名前
            HttpHeaderName: User-Agent
            #HTTPヘッダーの値と比較する文字列
            Values:
              - Mozilla
      #紐づけ先リスナーのArn
      ListenerArn: !Ref ALBListenerStg
      #ルールの優先度
      Priority: 1
  # ------------------------------------------------------------#
  # ECS:タスク定義
  # ------------------------------------------------------------#
  BlueTaskDefinition:
    Type: 'AWS::ECS::TaskDefinition'
    Properties:
      #タスク実行時に使用するロールのArn
      ExecutionRoleArn: !GetAtt ECSTaskExecutionRole.Arn
      #タスクを構成するコンテナを記述するJSON形式のコンテナ定義リスト
      ContainerDefinitions:
          #コンテナ名
        - Name: DemoApp
          #コンテナの起動に使用するイメージ
          Image: 
            !Join
              - ":"
              - - !Sub "${AWS::AccountId}.dkr.ecr.${AWS::Region}.amazonaws.com/${RepositoryName}"
                - !Sub "Dockerfile_${DeployType}"
          #コンテナ失敗、停止した際の挙動を指定
          Essential: true
          #コンテナのポートマッピング
          PortMappings:
              #コンテナ用に予約するコンテナ インスタンス上のポート
            - HostPort: 80
              #ポートマッピングに使用するプロトコル
              Protocol: tcp
              #動的にマッピングされたホストポート範囲にバインドされているコンテナー上のポート
              ContainerPort: 80
      #タスク定義が検証されたタスク起動タイプ
      RequiresCompatibilities:
        - FARGATE
      #タスク内のコンテナに使用するDockerネットワークモード
      NetworkMode: awsvpc
      #タスクで使用されるCPUユニット数
      Cpu: '256'
      #タスクで使用されるメモリの量(MiB単位)
      Memory: '512'
      #タスク定義が登録されているファミリーの名前
      Family: ecs-demo

  # ------------------------------------------------------------#
  # ECS:クラスタ
  # ------------------------------------------------------------#
  ECSCluster:
    Type: 'AWS::ECS::Cluster'
    Properties: 
      ClusterName: bg-test-cluster

  # ------------------------------------------------------------#
  # ECS:サービス
  # ------------------------------------------------------------#
  ECSService:
    Type: 'AWS::ECS::Service'
    Properties:
      #紐づけ先ECSクラスタ
      Cluster: !Ref ECSCluster
      #サービス内に配置し、実行を継続する指定されたタスク定義のインスタンス化の数
      DesiredCount: 1
      #デプロイ設定
      DeploymentConfiguration:
        #展開戦略をB/Gデプロイを指定
        Strategy: BLUE_GREEN        
      #サービスに使用するデプロイメントコントローラー
      DeploymentController:
        Type: ECS
      #サービスを実行する起動タイプ
      LaunchType: FARGATE
      #サービスに関連付けるLB
      LoadBalancers:
        #B/Gデプロイで使用するLBの詳細設定
        - AdvancedConfiguration:
            #B/Gデプロイにおける代替ターゲットグループ
            AlternateTargetGroupArn: !Ref ALBTargetGroupGreen
            #トラフィックをルーティングするためのリスナールール
            ProductionListenerRule: !Ref ALBListenerProdRule
            #ELB APIを呼び出すための権限
            RoleArn: !GetAtt ECSExecutionRole.Arn
            #テストトラフィックをルーティングするためのリスナールール
            TestListenerRule: !Ref ALBListenerStgRule
          #LBに関連付けるコンテナの名前
          ContainerName: DemoApp
          #コンテナ上でLBに関連付けるポート
          ContainerPort: 80
          #サービスに関連付けるターゲットグループ
          TargetGroupArn: !Ref ALBTargetGroupBlue
      #サービスのネットワーク構成
      NetworkConfiguration:
        #タスクに関連付けるVPCの設定
        AwsvpcConfiguration:
          #タスクのEIPがパブリックIPを取得するか
          AssignPublicIp: ENABLED
          #サービスに関連付けるSG
          SecurityGroups:
            - !Ref SecurityGroup
          #サービスに関連付けるサブネット
          Subnets:
            - !Ref Subnet1
            - !Ref Subnet2
      #サービス内のタスクが実行されるプラットフォームバージョン
      PlatformVersion: 1.4.0
      #サービスで実行するタスク定義
      TaskDefinition: !Ref BlueTaskDefinition
      ServiceName: bg-test-ecs-service

今回もまぁそれは長いテンプレートが出来上がりました。
まぁ複数サービスを一つテンプレートにまとめているのでこればかりはしょうがないですね。

やってることは前回と似たようなものです。
ですが、今回はECSの機能によるB/Gデプロイになりますので、「AWS::ECS::Service」に以下のような記述を入れてます。
・デプロイメントコントローラーに「ECS」を選択しています。(当たり前ですね)
・デプロイ設定も当然「BLUE_GREEN」を選択しています。
※ここから重要
・B/Gデプロイ時に使用するロードバランサーを設定するため「AdvancedConfiguration」を定義
・B/Gデプロイ実行時の代替ターゲットグループに「グリーン環境用ターゲットグループ」を指定
・トラフィックをルーティングするためのリスナールールに「本番用リスナールール」を指定
・テストトラフィックをルーティングするためのリスナールールに「テスト用リスナールール」を指定
・ECSサービスが標準で参照するターゲットグループに「ブルー環境用ターゲットグループ」を指定

今回も前回同様に機能単体での検証となるので特別CI/CD化は実施していません。
また、今回作成予定の環境では、手動にてタスク定義を更新後、これまた手動にてサービスの更新を実施することでテンプレートに記載の通りB/Gデプロイを実行する想定になります。

※普通にスタックからタスク定義を修正するだけで、タスク定義が置換されるのでECSサービス更新の契機となりB/Gデプロイ自体は動きます。
ただECSがデプロイを実施しちゃう関係上、普通にドリフトしちゃうのでスタックからの更新は想定していない+するべきではないです。


コメントを残す

メールアドレスが公開されることはありません。