3 min read

GitHub ActionsからElastic Container Serviceへデプロイ

GitHub ActionsからElastic Container Serviceへデプロイ
Photo by Microsoft 365 / Unsplash

個人ブログのサイトはアプリケーションにGhost、インフラストラクチャーにAmazon Web Servicesで構築しています。コンテナのイメージをGitHubリポジトリで管理しています。Ghostアプリケーションが稼働しているElastic Container Serviceへ自動デプロイするワークフローを作成します。

前提

ワークフローを作成するまえに、セットアップをする必要があります。IAMユーザーやAWS ECS、ECRは作成されているものとします。

  • IAMユーザーを作成
  • Elastic Container ServiceのCluster、Service、Task Definitionを作成
  • Elastic Container RegistryのRepositoryを作成

ワークフローの作成

1.チェックアウトを追加します

AWS ECRへデプロイするワークフローを作成します。

$ touch .github/workflows/deploy-ghost.yaml

コードに対してスクリプトやビルドを実行するために、チェックアウトアクションを追加します。

name: Deploy to Amazon ECS

on:
  push:
    branches:

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3
.github/workflows/deploy-ghost.yaml

2.AWS資格情報の設定を追加します

GitHub ActionsからAmazon Web Servicesヘ更新するために、AWS資格情報をシークレットに作成します。「新しいリポジトリ シークレット」からAWS_ACCESS_KEY_IDとAWS_SECRET_ACCESS_KEYを作成します。

name: Deploy to Amazon ECS

on:
  push:
    branches:

env:
  AWS_REGION: ap-northeast-1

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1-node16
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ env.AWS_REGION }}
.github/workflows/deploy-ghost.yaml

3.ECRへ登録を追加します

dockerイメージをビルドしAWS ECRへ登録します。

name: Deploy to Amazon ECS

on:
  push:
    branches:

env:
  AWS_REGION: ap-northeast-1
  ECR_REPOSITORY: blog/ghost

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1-node16
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ env.AWS_REGION }}

      - name: Login to Amazon ECR
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@aaf69d68aa3fb14c1d5a6be9ac61fe15b48453a2

      - name: Build, tag, push image to Amazon ECR
        id: build-image
        env: 
          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          IMAGE_TAG: ${{ github.sha }}
        run: |
          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG ./docker/file
          docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
          echo "::set-output name=image::$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG"
.github/workflows/deploy-ghost.yaml

4.タスク定義の更新とECSへデプロイを追加します

name: Deploy to Amazon ECS

on:
  push:
    branches:

env:
  AWS_REGION: ap-northeast-1
  ECR_REPOSITORY: blog/ghost
  ECS_SERVICE: blog/ghost
  ECS_CLUSTER: blog
  ECS_TASK_DEFINITION: ./.github/workflows/ghost-task-definition.json

  CONTAINER_NAME: ghost


jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1-node16
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ env.AWS_REGION }}

      - name: Login to Amazon ECR
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@aaf69d68aa3fb14c1d5a6be9ac61fe15b48453a2

      - name: Build, tag, push image to Amazon ECR
        id: build-image
        env: 
          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          IMAGE_TAG: ${{ github.sha }}
        run: |
          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG ./docker/file
          docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
          echo "::set-output name=image::$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG"

      - name: Fill in the new image ID in the Amazon ECS task definition
        id: task-def
        uses: aws-actions/amazon-ecs-render-task-definition@97587c9d45a4930bf0e3da8dd2feb2a463cf4a3a
        with:
          task-definition: ${{ env.ECS_TASK_DEFINITION }}
          container-name: ${{ env.CONTAINER_NAME }}
          image: ${{ steps.build-image.outputs.image }}

      - name: Deploy Amazon ECS task defition
        uses: aws-actions/amazon-ecs-deploy-task-definition@v1
        with:
          task-definition: ${{ steps.task-def.outputs.task-definition }}
          service: ${{ env.ECS_SERVICE }}
          cluster: ${{ env.ECS_CLUSTER }}
          wait-for-service-stability: true
.github/workflows/deploy-ghost.yaml

5.Deploy to Amazon ECS ワークフロー

mainブランチでpushしたとき、ワークフローが実行されるようにする

参照ドキュメント

Amazon Elastic Container Serviceへのデプロイ - GitHub Docs
継続的デプロイメント(CD)ワークフローの一部として、Amazon Elastic Container Service (ECS) へのデプロイを行えます。