Github Actions 와 codeDeploy 로 EC2에 배포하기

github actions introduction

Go to English version

새로 시작한 프로젝트를 배포하여 테스트 유저들에게 보여줄 필요가 생겼습니다. 배포 툴이 여러가지가 있기 때문에 무엇을 사용할까 동료와 고민을 나누었습니다. 동료와 저는 회사에서는 젠킨스를 써서 배포를 하고 있었고, 사이드 프로젝트에서 배포 작업을 할 때는 heroku 밖에 써 본 적이 없었습니다. 저는 젠킨스를 제안했고, 동료는 Github Actions 를 제안했습니다.

내가 젠킨스를 제안한 이유

가장 친숙하고, dev => feature => production 으로 이어지는 flow 를 관리하기에 젠킨스가 제공하는 기능이 좋았기 때문입니다.

동료가 Github Actions 를 제안한 이유

일단 비교적 새로 나온 서비스이며 github 에서 소스코드를 관리하기 때문에 배포까지 같은 곳에서 하면 편리하고, 지금 당장은 프로덕션 배포만 할 것이라 서비스가 어느 정도 커지면 그 때 배포 단계를 나눠도 괜찮을 듯 하다는 이유였습니다.

동료의 의견에 설득되었고, 지금과 같은 서비스 개발 초창기에서는 빠른 속도가 가장 중요하다고 생각했습니다. 또한 새로운 것을 써보고 싶은 마음이 들어 우리는 Github Actions 를 사용해보기로 했습니다.

작업 목표

작업한 코드를 main 에 push 하면 AWS codeDeploy 를 사용해 ec2 에 코드를 배포합니다.

필요한 사전 작업 (이 과정은 이 포스트에서 자세히 다루지 않습니다.)

1. ec2 생성
2. AWS codeDeploy 에 들어가 새로 애플리케이션을 생성하고, 배포 그룹을 생성합니다.
   

   github actions introduction

github actions 작업 프로세스

1. Actions 메뉴에서 New workflow 를 클릭합니다.

   

   github actions introduction

2. popular service 에는 ec2 가 없으므로 Manual workflow 를 선택합니다.

   

   github actions introduction

3. .github/workflows/ 에 생성된 yml 파일의 내용을 채웁니다.

name: // workflow 의 이름. 하고 싶은대로 입력하면 됩니다.

on:
push: // 이 workflow 를 트리거할 github action 을 입력합니다.
  branches: [ main ]

workflow_dispatch:

jobs:
deploy: // workflow 에서 실행될 job 의 이름입니다. 

  runs-on: ubuntu-latest // default 대로 사용해도 괜찮았습니다.

  steps:
    - uses: actions/checkout@v2 // default 대로 사용해도 괜찮았습니다.
  
    // codeDeploy 를 통해 ec2 에 배포하기 전에, ec2 access configuration 을 해야 합다. 
    - name: Configure AWS credentials from Production account
      uses: aws-actions/configure-aws-credentials@v1
      with:
        aws-access-key-id: ${{ secrets.PROD_AWS_ACCESS_KEY_ID }}
        // repo settings 의 secrets 메뉴에 들어가면 secrets 을 등록할 수 있습니다. AWS credential access key 와 key id 를 넣어줍니다.    
        aws-secret-access-key: ${{ secrets.PROD_AWS_SECRET_ACCESS_KEY }}
        aws-region: ap-northeast-2

    // aws cli 를 설치하고 아래와 같은 명령어를 입력해줍니다.
    // GITHUB_REPOSITORY 와 GITHUB_SHA 는 이대로 입력하면 push 할 당시의 repo 와 commit_id 로 자동 반영됩니다.  
    - name: deploy with aws codeDeploy
      run: aws deploy create-deployment --application-name ${CODEDEPLOY에서 만든 애플리케이션이름}
          --deployment-group-name ${배포그룹명}
          --deployment-config-name CodeDeployDefault.AllAtOnce
          --github-location repository=${GITHUB_REPOSITORY},commitId=${GITHUB_SHA}

위 과정이 잘 실행되는 지 테스트해봅니다. repo 의 Actions 메뉴에 들어가면 진행 상황을 볼 수 있습니다.