💪도전! 프리티어로 AWS ECS 사용하기: Next.js 배포 자동화 구현하기 (feat. github actions)

전에 💪도전! 프리티어로 AWS ECS 사용하기: ECS 클러스터에 EC2 인스턴스 연결 + 간단 배포에서 AWS 콘솔에서 간단히 ECS 실습을 했었다.

이제 github actions을 활용해서 진짜 최종 목표인 배포 자동화를 달아보자!

바로 시작!!

1. 배포 설계하기

먼저 나는 프리티어를 사용하고 있고, EC2 인스턴스 하나를 ECS 클러스터에 연결해서 사용하고 있다.

배포 절차는 다음과 같다.

1. release 브랜치 버전, dev 브랜치 버전을 각각 배포한다.
2. 각각 release 태그, dev 태그를 붙여 사용한다.
3. AWS ECS service에 각 태그의 이미지 URI로 미리 작성해 둔 AWS ECS task를 연결해둔다.
4. AWS ECS service를 강제 재시작해서 새로운 image를 배포한다.

2. github actions에서 AWS 인증하기

github actions에서 AWS의 ECR, ECS를 사용하려면 인증 과정을 거쳐야 한다.

나는 aws-actions/configure-aws-credentials@v4을 사용하고 github actions에서 사용한 IAM Role을 생성해서 사용할 것이다.

2-1. github actions에서 사용할 IAM Role 생성하기

(1) 먼저 Identity providers 생성하기

🖱 AWS 콘솔 > IAM > Access management >Identity providers > [Add provider]

GitHub Actions의 OIDC(OpenID Connect) 토큰을 사용하여 AWS에서 임시 자격 증명을 얻을 수 있게 하기 위해 Identity providers을 먼저 생성해주어야 한다.

• 공급자 유형: OpenID Connect
• 공급자 URL: https://token.actions.githubusercontent.com
• 대상: sts.amazonaws.com

(2) IAM Role 생성

🖱 생성한 자격 증명 공급자 > [역할 할당] > ◎ 새 역할 생성

• 신뢰할 수 있는 엔터티 유형: ◎ 웹 자격 증명
• 자격 증명 공급자: token.actions.githubusercontent.com
• Audience: sts.amazonaws.com
• 권한 정책 선택
  • AmazonEC2ContainerRegistryFullAccess
  • AmazonECS_FullAccess

2-2. Github Repository Setting에서 변수 설정하기

🖱 Repository Setting > Security > Secrets and variables

• Repository secrets
  • AWS_ROLE_NAME: 생성한 Role의 ARN

• Repository variables
  • AWS_DEFAULT_REGION: region (서울은 ap-northeast-2)
  • REPOSITORY: 사용할 ECR 레포지터리 이름

2-3. github actions에서 AWS 인증하기

.github/workflows/CD.yml 작성하기

name: CD

on:
  push:
    branches: [dev, release]

# 이 부분 빼먹으면 안됨 ##
permissions:
  id-token: write
  contents: read
#######################

jobs:
  build:
    name: 🐳 도커 이미지 빌드 & 푸시
    runs-on: ubuntu-latest

    steps:
      - name: ① 레포지터리 체크아웃
        uses: actions/checkout@v3

      - name: ② AWS 자격 증명
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_NAME }}
          aws-region: ${{ vars.AWS_DEFAULT_REGION }}

3. docker image 빌드하고 AWS ECR에 푸시하기

이제 현재 버전을 ECR에 docker image에 push 해보자~!

3-1. Dockerfile 작성

프로젝트 루트 폴더에 Dockerfile을 작성한다.

FROM node:18-alpine

WORKDIR /app

RUN apk add --no-cache curl

COPY package.json pnpm-lock.yaml ./

RUN npm install -g pnpm

RUN pnpm install

COPY . .

RUN pnpm run build

EXPOSE 3000

ENV PORT 3000

CMD ["pnpm", "run", "start"]

3-2. docker image 빌드하고 ECR에 푸시하는 workflow 작성

• 이미지 태그를 브랜치 이름 (release, dev)를 이미지 태그를 사용한다.

name: CD

on:
  push:
    branches: [dev, release]

permissions:
  id-token: write
  contents: read

jobs:
  build:
    name: 🐳 도커 이미지 빌드 & 푸시
    runs-on: ubuntu-latest

    steps:
      - name: ① 레포지터리 체크아웃
        uses: actions/checkout@v3

      - name: ② AWS 자격 증명
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_NAME }}
          aws-region: ${{ vars.AWS_DEFAULT_REGION }}

      - name: ③ AWS ECR 로그인
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@v2

      - name: ④ 이미지 태그 설정
        run: |
          BRANCH_NAME=$(echo "${{ github.ref }}" | sed 's|refs/heads/||')
          echo "IMAGE_TAG=${BRANCH_NAME}" >> $GITHUB_ENV

      - name: ⑤ 도커 이미지 빌드
        env:
          REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          REPOSITORY: ${{ vars.REPOSITORY }}
          IMAGE_TAG: ${{ env.IMAGE_TAG }}
        run: |
          docker build -t $REGISTRY/$REPOSITORY:$IMAGE_TAG .

      - name: ⑥ AWS ECR 푸시
        env:
          REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          REPOSITORY: ${{ vars.REPOSITORY }}
          IMAGE_TAG: ${{ env.IMAGE_TAG }}
        run: |
          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG

4. ECS에 배포하기

ECS 배포는 간단하다!

  depoly:
    name: 🐳 ECS 배포
    runs-on: ubuntu-latest
    needs: build

    steps:
      - name: ① 레포지터리 체크아웃
        uses: actions/checkout@v3

      - name: ② AWS 자격 증명
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_NAME }}
          aws-region: ${{ vars.AWS_DEFAULT_REGION }}

      - name: ③ 브랜치 이름 가져오기
        run: |
          BRANCH_NAME=$(echo "${{ github.ref }}" | sed 's|refs/heads/||')
          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV

      - name: ④ ECS 배포
        env:
          CLUSTER: ${{ vars.AWS_ECS_CLUSTER }}
          SERVICE: ${{ vars.REPOSITORY }}-${{ env.BRANCH_NAME }}-service
        run: |
          aws ecs update-service \
            --cluster $CLUSTER \
            --service $SERVICE \
            --force-new-deployment

끝!

전체 도커 파일

name: CD

on:
  push:
    branches: [dev, release]

permissions:
  id-token: write
  contents: read

jobs:
  build:
    name: 🐳 도커 이미지 빌드 & 푸시
    runs-on: ubuntu-latest

    steps:
      - name: ① 레포지터리 체크아웃
        uses: actions/checkout@v3

      - name: ② AWS 자격 증명
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_NAME }}
          aws-region: ${{ vars.AWS_DEFAULT_REGION }}

      - name: ③ AWS ECR 로그인
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@v2

      - name: ④ 이미지 태그 설정
        run: |
          BRANCH_NAME=$(echo "${{ github.ref }}" | sed 's|refs/heads/||')
          echo "IMAGE_TAG=${BRANCH_NAME}" >> $GITHUB_ENV

      - name: ⑤ 도커 이미지 빌드
        env:
          REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          REPOSITORY: ${{ vars.REPOSITORY }}
          IMAGE_TAG: ${{ env.IMAGE_TAG }}
        run: |
          docker build -t $REGISTRY/$REPOSITORY:$IMAGE_TAG .

      - name: ⑥ AWS ECR 푸시
        env:
          REGISTRY: ${{ steps.login-ecr.outputs.registry }}
          REPOSITORY: ${{ vars.REPOSITORY }}
          IMAGE_TAG: ${{ env.IMAGE_TAG }}
        run: |
          docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG

  depoly:
    name: 🐳 ECS 배포
    runs-on: ubuntu-latest
    needs: build

    steps:
      - name: ① 레포지터리 체크아웃
        uses: actions/checkout@v3

      - name: ② AWS 자격 증명
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_NAME }}
          aws-region: ${{ vars.AWS_DEFAULT_REGION }}

      - name: ③ 브랜치 이름 가져오기
        run: |
          BRANCH_NAME=$(echo "${{ github.ref }}" | sed 's|refs/heads/||')
          echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV

      - name: ④ ECS 배포
        env:
          CLUSTER: ${{ vars.AWS_ECS_CLUSTER }}
          SERVICE: ${{ vars.REPOSITORY }}-${{ env.BRANCH_NAME }}-service
        run: |
          aws ecs update-service \
            --cluster $CLUSTER \
            --service $SERVICE \
            --force-new-deployment