[⛓️CI/CD] GitHub Actions - AWS CodeDeploy & S3 이용해서 배포

이전 글에서 GitHub Actions를 CI의 용도로 사용했고, 코드의 자동 배포를 위한 AWS CodeDeploy를 구현해보겠다.

GitHub Actions를 사용해서 CI를 구축하고, AWS CodeDeploy로 CD를 구축해 스프링 프로젝트를 자동 배포할 것이다. 

 

 

간단 요약 

1. GitHub에 push하면 GitHub Actions가 자동으로 실행 👉 gradlew build 명령어로 빌드하여 실행할 수 있는 jar 파일 생성
2. 배포에 필요한 jar 파일과 shell script 파일은 압축해서 zip 파일을 AWS S3로 업로드
3. EC2에 설치되어 있는 CodeDeploy Agent가 S3에 업로드된 zip 파일을 가져와서 배포
4. CodeDeploy Agent는 S3에서 zip 파일을 내려받고, appspec.yml을 읽어서 설정된 스크립트 파일을 실행시키면서 배포 

 

📍 'GitHub Actions 설정'을 먼저 작성했지만, 'S3 버킷 생성'하는 것을 먼저 해야 한다 !

 

1. GitHub Actions 설정

배포하고자 하는 프로젝트에서 workflow을 생성하고 GitHub Actions 설정을 한다.

 

 

name: github-action-workflow

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  workflow_dispatch:

env:
  S3_BUCKET_NAME: soogoori-bucket
  AWS_REGION: ap-northeast-2

jobs:
  build:
    runs-on: ubuntu-latest 

    steps:
      - name: Github checkout
        uses: actions/checkout@v4
      
      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0

      - name: Grant execute permission for gradlew
        run: chmod +x ./gradlew
      
      - name: Build with Gradle
        run: ./gradlew build

      - name: Make zip file
        run: zip -r ./$GITHUB_SHA.zip .
        shell: bash
      
      - 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: ${{ env.AWS_REGION }}
      
      - name: Upload to S3
        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip

 

 

변수로 있었던 액세스 키 값을 저장한다. (액세스 키 발급은 2. S3 버킷 생성 및 IAM 설정 - '액세스 키 발급'에서 확인할 수 있다)

GitHub Actions 탭에서도 build 성공했고, AWS S3에서도 zip 파일이 업로드된 것을 확인할 수 있다. 

 

 

 

2. S3 버킷 생성 및 IAM 설정 

✨ S3 사용 목적 : AWS 저장소로, gradle 빌드 결과 (jar)파일 업로드

 

 

1️⃣ S3 접속, 버킷 생성 

'모든 퍼블릭 액세스 차단'을 해제한다. 

해당 설정으로 인해서 URL을 입력하여 이미지를 업로드할 수 있게 된다.

 

생성완료

 

 

 

2️⃣ 정책 설정 

버킷 정책 ➔ 편집에 들어가면 

다음과 같은 창이 나오고, 정책 생성기에 들어가서 정책 설정을 해야한다.

 

Amazon Resource Name(ARN)에는 복사해온 버킷 ARN/* 형식으로 입력한다. 

Add Statement을 클릭하면 위와 같은 결과가 나온다. 

 

 

Generate Policy를 누르면 위와 같이 Json 형태의 데이터가 나온다. 

이를 복사해서

붙여넣고 변경사항을 저장한다. 

 

3️⃣ IAM 설정 

IAM은 Identity and Access Management의 약자로 AWS의 각 객체(사용자, 서비스)에 권한을 주는 서비스이다.
CodeDeploy에서 S3로의 접근 권한을 열어주기 위한 설정을 하는 것이다. 

 

사용자를 생성하고, 권한 설정에서 직접 정책 연결을 선택해 'AmazonS3FullAccess'와 'AWSCodeDeployFullAccess'를 선택한다. 

내용을 확인 후 사용자 생성 버튼을 누른다. 

 

 

4️⃣ 액세스 키 발급 

생성된 사용자를 클릭하여 보안 자격 증명 탭에서 액세스 키 만들기 버튼을 누른다. 

액세스 키 만들기 버튼을 누르면 키가 생성된다.

발급된 액세스 키와 비밀 액세스 키를 따로 저장하고 완료한다. 

 

 

 

 

3. CodeDeploy 생성

S3에 업로드된 파일을 CodeDeploy에게 전달하고, CodeDeploy가 build된 파일을 찾아서 배포할 수 있게 된다. 

이 명령을 GitHub Actions에 명시해야한다. 

 

먼저 CodeDeploy를 생성하기 전에 IAM 역할을 생성해보자.

 

🔹 IAM 역할 생성 

역할 생성 완료

---

 

🔹 CodeDeploy Agent 설치 

 

배포하고자 하는 서버에 접속해 CodeDeploy Agent를 설치한다. 

EC2 인스턴스를 생성해 연결하고 다음과 같은 명령어를 입력하면 된다. 

$ sudo yum update
$ sudo yum install ruby
$ sudo yum install wget

$ cd /home/ec2-user
$ wget https://aws-codedeploy-ap-northeast-2.s3.ap-northeast-2.amazonaws.com/latest/install
$ chmod +x ./install
$ sudo ./install auto

설치를 한 후 sudo service codedeploy-agent status를 입력하면 CodeDeploy agent의 상태를 확인할 수 있다. 

 

---

🔹 CodeDeploy Agent 구성 - CodeDeploy 애플리케이션 생성 

AWS CodeDeploy ➔ 애플리케이션 ➔ 애플리케이션 생성을 클릭해 새로운 CodeDeploy를 생성한다.

 

배포 그룹도 생성한다. 

위에서 생성한 IAM 역할에 접속해서 ARN을 복사하고

서비스 역할 입력에 입력한다. 

환경 구성에서 태그 그룹은 키/값으로 구성되어있다.

키는 Name으로 설정하고, 값은 추천하는 이름으로 넣어준다. 

태그 값을 참조해서 어떤 인스턴스에 배포할 것인지 정하므로 꼭 지정해야한다 !

로드밸런서는 사용하지 않을 것이므로 비활성화하고 배포 그룹 생성을 클릭한다. 

만약 서버가 여러 대라면 로드밸런서를 설정해서 요청이 들어오면 어떤 장비로 연결할지 결정한다. 

 

배포 그룹 생성 완료

 

 

4. 스크립트 추가 

각 배포 단계에서 어떤 스크립트 파일을 실행할 것인지 설정하는 appspec.yml 파일을 작성할 것이고, 

서버에서 실행될 배포 스크립트 파일인 scripts/deploy.sh도 작성할 것이다. 

🔸 appspec.yml 

👉 CodeDeploy가 참조할 파일이다.

version: 0.0
os: linux
files:
  - source:  /
    destination: /home/ec2-user/action # 배포 시 참조할 루트 = 목적지 루트 
    overwrite: yes

permissions:
  - object: /
    pattern: "**"
    owner: ec2-user
    group: ec2-user

hooks:
  ApplicationStart:
    - location: scripts/deploy.sh # application 시작할 때 이 파일을 실행
      timeout: 60
      runas: ec2-user

 

 

🔸 scripts/deploy.sh 

#!/bin/bash

BUILD_JAR=$(ls /home/ec2-user/action/build/libs/*SNAPSHOT.jar) # 특정 파일 찾기
JAR_NAME=$(basename $BUILD_JAR) # 원본 파일 명 
echo "## build file name : $JAR_NAME" >> /home/ec2-user/action/spring-deploy.log # 추출한 파일명을 로그 파일에 추가

# 출력된 메시지를 로그 파일에 추가하고 빌드된 JAR 파일을 지정된 디렉토리로 복사
echo "## copy build file" >> /home/ec2-user/action/spring-deploy.log 
DEPLOY_PATH=/home/ec2-user/action/
cp $BUILD_JAR $DEPLOY_PATH

# 실행 중인 Java 프로세스의 PID 찾기 
echo "## current pid" >> /home/ec2-user/action/spring-deploy.log
CURRENT_PID=$(ps -ef | grep "java" | awk 'NR==1 {print $2}') 

# 현재 실행 중인 Java 프로세스 종료
if [ -z $CURRENT_PID ]
then
  echo "## 현재 구동중인 애플리케이션이 없으므로 종료하지 않습니다." >> /home/ec2-user/action/spring-deploy.log
else
  echo "## kill -15 $CURRENT_PID"
  kill -15 $CURRENT_PID 
  sleep 5
fi

# 새로운 JAR 파일 실행하여 애플리케이션을 배포하는 작업 수행
DEPLOY_JAR=$DEPLOY_PATH$JAR_NAME 
echo "## deploy JAR file"   >> /home/ec2-user/action/spring-deploy.log
nohup java -jar $DEPLOY_JAR >> /home/ec2-user/action/spring-deploy.log 2> /home/ec2-user/action/spring-deploy_err.log &

deploy.sh 파일은 생성 후 실행 권한을 부여하여 서버에서 문제없이 실행될 수 있도록 한다. 

git update-index --chmod=+x deploy.sh

 

🔸 gradle.yml 

name: github-action-workflow

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  workflow_dispatch:

env:
  S3_BUCKET_NAME: soogoori-bucket
  AWS_REGION: ap-northeast-2
  CODEDEPLOY_NAME: github-actions 
  CODEDEPLOY_GROUP: soogoori-github-actions-group
  

jobs:
  build:
    runs-on: ubuntu-latest 

    steps:
      - name: Github checkout
        uses: actions/checkout@v4
      
      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0

      - name: Grant execute permission for gradlew
        run: chmod +x ./gradlew
      
      - name: Build with Gradle
        run: ./gradlew build -x test
      
      - name: Make zip file
        run: zip -r ./$GITHUB_SHA.zip .
      
      - 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: ${{ env.AWS_REGION }}
      
      - name: Upload to S3
        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip

      - name: Code Deploy
        run: aws deploy create-deployment --application-name $CODEDEPLOY_NAME --deployment-config-name CodeDeployDefault.AllAtOnce --deployment-group-name $CODEDEPLOY_GROUP --s3-location bucket=$S3_BUCKET_NAME,bundleType=zip,key=$GITHUB_SHA.zip

GitHub Actions에서 추가한 gradle.yml 파일에도 CodeDeploy 배포에 필요한 데이터와 step을 추가한다. 

 

 

위와 같은 파일들을 수정 및 추가하여 git 저장소에 push하면 workflow가 동작하는 것을 확인할 수 있다. 

 

 

CodeDeploy에서 배포가 정상적으로 됐는지 확인해 본 결과 실패가 떴다.

tail -f /var/log/aws/codedeploy-agent/codedeploy-agent.log

 

로그를 확인해보니 IAM 관련해서 오류가 난 것 같다. 

 

 

✨ EC2 서버 IAM 역할 수정 

CodeDeploy에서 배포 시점에 EC2 서버로 접근해 배포를 수행하기 때문에 EC2 서버 IAM 역할에도 CodeDeploy 접근 권한 관련된 설정이 필요하다. 

 

권한 정책 추가를 해준다. 

AmazonEC2RoleforAWSCodeDeploy
AWSCodeDeployFullAccess
AWSCodeDeployRole

역할 이름을 작성하고, 

 

권한 정책 요약 목록을 확인한 후 역할 생성 버튼을 클릭한다. 

 

역할 생성 완료

역할 생성 후 다시 EC2 인스턴스에 돌아와서 IAM 역할을 업데이트한다. 

그러면 정상적으로 CodeDeploy에서 EC2 서버에 접근하고 배포할 수 있는 권한을 적용할 수 있다. 

 

위 작업 후 CodeDeploy Agent를 다시 실행시키면 된다. 

sudo service codedeploy-agent restart

성공 Vv