[FE] 모바일 청첩장 - 배포 자동화 구현

GitHub Actions, AWS ECR, EC2, Docker, Nginx를 조합하여 자동 배포 DevOps 파이프라인을 설계 및 구현했다.

 

1. 아키텍처 설계

전체 자동화 흐름은 아래와 같이 구성했다.
(1) 깃허브 레포지토리에 코드를 푸시하면, GitHub Actions이 트리거되어 Dockerfile을 기반으로 nginx 기반 이미지가 빌드된다.
(2) AWS ECR에 빌드된 이미지를 push하고, EC2 인스턴스에서 pull 받는다.

 

2. GitHub Actions

GitHub Actions를 사용하면 코드 푸시, PR 등의 이벤트를 트리거로 삼아 자동화된 워크플로우를 실행할 수 있도록 해준다.
워크플로우는 빌드, 테스트, 배포와 같은 일련의 작업들을 정의한 구성 파일이며 Repository 내 .github/workflows 디렉터리에 YAML 파일로 위치한다.

나는 GitHub Actions를 통해 코드가 main 브랜치에 푸시될 때 자동으로 Docker 이미지를 빌드하고, 이를 ECR에 업로드한 뒤 EC2 인스턴스에서 컨테이너를 재시작하도록 설정해야 했다.

따라서, 먼저 아래의 파일 위치에 yaml 파일을 작성해줬다.

name: Deploy Frontend

on:
  push:
   branches:
     - main

jobs:
  deploy:
    runs-on: ubuntu-latest

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

• name: 워크플로우의 이름
• on - push: 워크플로우가 main branch의 push 이벤트를 기준으로 실행된다는 뜻
• jobs: 워크플로우에서 실행할 작업들의 집합을 정의
• runs-on: deploy란 job이 어떤 OS 환경에서 실행될지를 정하는 부분으로 최신 Ubuntu 가상 환경에서 실행하겠다는 의미 (실행되는 서버는 GitHub Actions이 매 워크플로우 실행 시 자동으로 생성하고 삭제하는 일시적인 머신을 뜻한다.)
• actions/checkout@v3: GitHub이 공식 제공하는 액션 중 하나로, 머신에 현재 브랜치의 코드를 내려받는다는 뜻

 

 

3. ECR 생성과 IAM 권한 부여

ECR은 AWS에서 제공하는 Docker 이미지 저장소로, 내가 빌드한 애플리케이션 이미지를 안전하게 저장하고, EC2나 ECS와 같은 AWS 리소스에서 쉽게 pull하여 사용할 수 있도록 해준다. (도커허브와 비슷한 역할)

(1) ECR 생성

GitHub Actions에서 빌드한 Docker 이미지를 저장할 수 있도록 ECR 리포지토리를 생성했다.

또한, GitHub Actions에서 매번 docker build 후 docker push 하면서 새 이미지가 쌓이기 때문에 이를 위한 수명주기정책을 설정해줬다.

 

(2) IAM 권한 부여

ECR과 EC2에 접근하기 위해서는 IAM 권한이 필요하다.
GitHub Actions에서 ECR에 로그인하여 이미지를 push해야 하고, ECR에서 이미지를 pull 받아 EC2 인스턴스에 배포해야 한다.
따라서 IAM 콘솔에서 새로운 사용자를 생성하고, AmazonEC2ContainerRegistryFullAccess 권한을 부여해줬다.

 

(3) GitHub Secret 등록하기

IAM 사용자의 AWS Secret Key, Access Key를 발급 받아 이 키를 통해 ECR에 로그인해야 한다. 따라서 GitHub 리포지토리의 Settings → Secrets and variables → Actions에 해당 키들을 등록했다.

등록 후, build job의 총 yaml 코드는 아래와 같다.

jobs:
  build:
    name: Build Docker Image and Push to ECR
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source code
        uses: actions/checkout@v3

      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-credentials@v2
        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 AWS ECR
        id: login-ecr
        uses: aws-actions/amazon-ecr-login@v2

      - name: Build Docker Image
        run: docker build -t $REPOSITORY_NAME:$IMAGE_TAG .
      
      - name: Tag Docker Image
        run: docker tag $REPOSITORY_NAME:$IMAGE_TAG ${{ steps.login-ecr.outputs.registry }}/$REPOSITORY_NAME:$IMAGE_TAG
      
      - name: Push Image to ECR
        run: docker push ${{ steps.login-ecr.outputs.registry }}/$REPOSITORY_NAME:$IMAGE_TAG

 

4. EC2에서 배포

deploy job을 새로 선언해준다. ECR에 올라간 Docker Image를 EC2 인스턴스에서 pull하고 실행하는 단계이다.
nees: build를 추가하여 build 후 실행되도록 설정해준다.

runner 서버에서 ssh를 통해서 ec2에 접속해야 하기 때문에, github secrets에 EC2와 관련된 변수도 추가해준다.
PEM 키를 넣을땐 꼭 -----BEGIN RSA PRIVATE KEY----- 부터 끝까지 넣어야함..!!

GitHub Actions에서 제공하는 ssh-action을 사용했다.
env 파일을 workflow에 선언하고 jobs들에서 사용하려고 했으나... ec2에 ssh로 접속하면서 전역변수인 env를 사용할 수 없게 되어 에러가 났다.

outputs으로 registry를 선언하고 받는 방식도 해봤지만 실패..

이렇게 스크립트 내부에서 export 하는 방식도 실패...

엄청 헤매다가 결국 ... secrets에 ecr uri에 들어가는 account id를 추가해주고 env 변수를 하나하나 넣어주는 방식으로 해결했음 ㅠ 이게 최선인지는 모른다..
따라서 결과적으로 deploy 부분의 코드는 아래와 같다.

  deploy:
    name: Deploy to EC2
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to EC2 via SSH
        uses: appleboy/ssh-action@v1.0.3
        with:
          host: ${{ secrets.EC2_HOST }}
          username: ec2-user
          key: ${{ secrets.EC2_SSH_KEY }}
          script: |
            docker stop ${{ env.REPOSITORY_NAME }} || true
            docker rm ${{ env.REPOSITORY_NAME }} || true

            aws ecr get-login-password --region ap-northeast-2 | docker login --username AWS --password-stdin ${{ env.AWS_ACCOUNT_ID }}.dkr.ecr.ap-northeast-2.amazonaws.com/${{ env.REPOSITORY_NAME }}
            docker pull ${{ env.AWS_ACCOUNT_ID }}.dkr.ecr.ap-northeast-2.amazonaws.com/${{ env.REPOSITORY_NAME }}:latest
            docker run -d --name ${{ env.REPOSITORY_NAME }} -p 80:80 ${{ env.AWS_ACCOUNT_ID }}.dkr.ecr.ap-northeast-2.amazonaws.com/${{ env.REPOSITORY_NAME }}:latest

 

그런데도 위의 에러가 뜨며 안돼서 찾아보니.. EC2에는 AWS key값이 전달되지 않기 때문에 ECR에 접근할 수 있는 역할을 붙여줘야 했다.
IAM의 역할 생성에서 EC2 서비스에 AmazonEC2ContainerRegistryFullAccess 정책을 연결해주고, 이 역할을 내가 만든 인스턴스에 부여해줬다.

 

드디어 성공 ,, 
이제 퍼블릭 IP로 접속하면 웹이 보이게 되었다!