[AWS] Elastic Beanstalk + ECR + Git Action 으로 Nest.js 무중단 배포하기

회사에서 EB와 ECR을 통해 Nest.js를 배포하기로 정하여 몇번의 수고 끝에 해당 스택으로 진행 해보고자 한다.

개인적으로 스타트업에는 잘 맞는 플랫폼이라고 생각하며 빠르고 간편하게 인프라를 구성할 수 있고 신경써서 한번만 구성하게 된다면 오토스케일링, 로드밸런싱, 모니터링, 용량 등등 신경 써야할 부분이 많이 줄어들기 때문에 시도했다.

ECR을 사용한 이유는 확장되면서 도커를 사용할 일이 많아 미리 연습차원에서 적용해보자 이번 배포 스택에 추가했다.

기존에 사용중이었던 CodePipeline, CodeBuild, CodeDeploy 보다는 개인적으로 더 간편하고 좋은 것 같았다. 그래서 이번에 잘 정리하여 나중에 다른 프로젝트에서 해당 스팩을 적용하기 편하도록 글을 작성해보고자 한다.

기본적으로 Nest.js 프로젝트, AWS 계정, Docker가 준비되면 될 것 같다.

1. Dockerfile 만들기

프로젝트에 먼저 Dockerfile을 만들고 해당 파일을 로컬 Docker에서 테스트를 한다.

먼저 잘 동작하는 Dockerfile이 있어야 후에 덜 수고스러운 것 같아서 먼저 만들어보길..

Root에 docker라는 folder를 만들고 dev, prod으로 나누며 본 글에서는 dev를 서버에 올리는 작업으로 예시를 만들 예정이다.

.dockerignore

node_modules
dist

Dockerfile

해당 Dockerfile은 퍼블릭한 코드를 많이 가져왔는데 추가한 것은 .env 파일이다. 해당 부분이 빠지면 실행을 할때 적절한 환경변수를 찾지 못해 실행이 되지 않거나 문제가 생기기 때문에 추가함.

FROM node:14.17.6-alpine as builder

WORKDIR /app

COPY . /app

RUN npm ci \
    && npm i @types/express \
    && npm i -g @nestjs/cli \
    && npm run build

FROM node:14.17.6-alpine

WORKDIR /app

COPY --from=builder /app/package*.json /app/
COPY --from=builder /app/node_modules/ /app/node_modules/
COPY --from=builder /app/dist/ /app/dist/
COPY --from=builder /app/.env.development /app/
EXPOSE 3001
CMD ["npm", "run", "start:dev"]

이제 프로젝트 루트에 터미널을 켜서 실제 이미지 빌드를 진행하고자함.

{ docker image name } 에 이미지 명을 입력해하면 됩니다.

docker build -f docker/dev/Dockerfile -t { docker image name } .

빌드가 완료되면 빌드 때 정한 { docker image name } 으로 컨테이너를 띄워 본다.

docker run -p 3001:3001 { docker image name }

이제 기본적인 Dockfile은 준비가 끝. 이제 Github action을 구성한다.

2. Github workflows 만들기

루트에 .github/workflows 폴더를 만들고 그 안에 dev-deploy.yml을 만든다.

* 그대로 복사해서 사용하면 안되고 한 번씩 흐름을 따라가면서 수정할 부분에서 수정해야함.

1. 해당 flow가 발생할 브랜치명

2. AWS_ACCESS_KEY_ID

3. AWS_SECRET_ACCESS_KEY

4. env

5. ECR 레포지토리 이름

6. Beanstalk 어플리케이션 이름

7. Beanstalk 환경 이름

이렇게만 추가하시면 끝! 굉장히 간단하다.

2-4의 경우는 github의 secrets를 이용하면 좋다. 직접 입력해도 상관없지만 보안의 문제로 secrets을 사용하면 좋은데 아래의 링크에서 추가하는 방법을 확인할 수 있다.

name: Deploy to ECR

on:
  push:
    branches: [ 해당 flow가 발생할 브랜치명 ]

jobs:
  build:
    name: Build Image
    runs-on: ubuntu-latest
   
    steps:
    - name: Check out code
      uses: actions/checkout@v2
    
    - name: Configure AWS credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:
        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        aws-region: ap-northeast-2

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

    - name: Create env file
      run: |
        touch .env.development
        echo DB_HOST=${{ secrets.DB_HOST }} >> .env.development
        echo DB_PORT=${{ secrets.DB_PORT }} >> .env.development
        echo DB_USERNAME=${{ secrets.DB_USERNAME }} >> .env.development
        ...
        cat .env.development

    - name: Build, tag, and push image to Amazon ECR
      id: build-image
      env:
        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
        ECR_REPOSITORY: ECR 레포지토리 이름
        IMAGE_TAG: latest
      run: |
        docker build -f docker/dev/Dockerfile -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
        docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
    - name: Get current time
      uses: 1466587594/get-current-time@v2
      id: current-time
      with:
        format: YYYYMMDD_HH-mm-ss
        utcOffset: "+09:00"
    - name: Generate deployment package
      run: |
        mkdir -p deploy
        cp docker/dev/Dockerrun.aws.json deploy/Dockerrun.aws.json
        cd deploy && zip -r deploy.zip .
    - name: Beanstalk Deploy
      uses: einaregilsson/beanstalk-deploy@v14
      with:
        aws_access_key: ${{ secrets.AWS_ACCESS_KEY_ID }}
        aws_secret_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        application_name: Beanstalk 어플리케이션 이름
        environment_name: Beanstalk 환경 이름
        version_label: earth-docker-${{steps.current-time.outputs.formattedTime}}
        region: ap-northeast-2
        deployment_package: deploy/deploy.zip
        wait_for_environment_recovery: 200