[TECH] GitHub Actions로 CI/CD 구축하기(2)

[티끌] 티끌 GitHub Actions로 CICD 구축하기(2)

안녕하세요 티플의 백엔드 개발자 김유정입니다 :)

저는 오늘 CI/CD를 구축하는 단계에서 CodeDeploy Agent 설치 과정, 배포 스크립트 작성, 배포 동작 추가에 대한 내용을 설명해보려 합니다. 

---

이전 글에서 이어지는 내용입니다.

 

👩‍💻 CodeDeploy Agent 설치

다음 명령어를 차례대로 입력합니다.

*설치 방법은 ubuntu 기준입니다.

 

# apt 업데이트
sudo apt-get update && sudo apt-get upgrade

# JDK 11 설치
sudo apt-get install openjdk-11-jdk

# Ruby 설치 (3.xx 버전 설치됨)
sudo apt install ruby-full

# wget 모듈 설치
sudo apt install wget

cd /home/ubuntu

# codedeploy 파일 다운로드
sudo wget https://aws-codedeploy-ap-northeast-2.s3.ap-northeast-2.amazonaws.com/latest/install

다음의 명령어를 차례대로 수행했다면, 다운로드 받은 디렉토리에 install파일이 생성됩니다.

 

다음 명령어를 차례대로 입력해 설정 및 사용 가능한 codedeploy 버전을 확인합니다.

# 권한 설정
sudo chmod +x ./install

# 출력을 임시 로그파일에 씀
sudo ./install auto > /tmp/logfile

# aws cli 설치
sudo apt-get install awscli

# 서울 리전에서 사용 가능한 codedeploy 버전 확인
sudo aws s3 ls s3://aws-codedeploy-ap-northeast-2/releases/ | grep '\.deb$'

위 명령어로 사용 가능한 버전을 확인 할 수 있습니다. 티끌은 1.3.2 버전을 사용하겠습니다.

sudo ./install auto -v releases/codedeploy-agent_1.3.2-1902_all.deb > /tmp/logfile

# 서비스가 실행중인지 확인
sudo service codedeploy-agent status

 

sudo service codedeploy-agent-status 명령어를 입력해 다음과 같이 codedeploy-agent service가 Active된 상태임을 확인합니다.

 

---

👩‍💻 CodeDeploy 생성

AWS에서 CodeDeploy 어플리케이션을 생성해보겠습니다.

 

1. CodeDeploy를 위한 IAM 역할 생성

“다른 AWS 서비스의 사용 사례 → CodeDeploy”를 클릭하면 CodeDeploy의 모든 권한이 보여된 상태가 됩니다.

 

2. CodeDeploy 어플리케이션 생성 

AWS콘솔에서 CodeDeploy를 검색하여 새 어플리케이션을 생성합니다.

 

어플리케이션 이름을 지정하고, EC2/온프레미스를 선택해 어플리케이션을 생성합니다.

 

3. 배포 그룹 생성

생성된 CodeDeploy 어플리케이션을 클릭하고 배포 그룹을 생성합니다.

배포 그룹명을 지정하고, 서비스 역할에는 방금 만들었던 IAM 역할과 연결합니다.

배포 구성은 어플리케이션 배포를 어떻게 수행할지에 대한 선택입니다. AllAtOnce는 한번에 모든 인스턴스를 배포한다는 뜻입니다.

 

---

👩‍💻 deploy.yml 수정

deploy.yml에 배포 동작 코드를 추가합니다.

 

name: Build and Deploy Spring Boot to AWS EC2

on:
  push:
    branches: [ main ]
# 추가
env:
  PROJECT_NAME: tikkle-server
  BUCKET_NAME: github-actions-s3-bucket-ec2
  CODE_DEPLOY_APP_NAME: codedeploy-app
  DEPLOYMENT_GROUP_NAME: codedeploy-deployment-group
# ---------------------
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Setup Java JDK 11
        uses: actions/setup-java@v1
        with:
          java-version: 11

      - name: Setup MySQL
        uses: samin/mysql-action@v1
        with:
          character set server: 'utf8'
          mysql database: 'rds'
          mysql user: ${{user}}
          mysql password: ${{password}}

      - name: Grant execute permission for gradlew
        run: chmod +x ./gradlew
        shell: bash

      - name: Make application-prod.properties
        if: contains(github.ref, 'main') # branch가 main 일 때
        run: |
          cd ./src/main/resources
          touch ./application-prod.properties
          echo "${{ secrets.APPLICATION }}" > ./application-prod.properties
        shell: bash

      - name: Build with Gradle
        run: ./gradlew build -x test
        shell: bash
# 추가
			- name: Make Zip File
        run: zip -qq -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: ap-northeast-2

      - name: Upload to S3
        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$BUCKET_NAME/$PROJECT_NAME/$GITHUB_SHA.zip

      - name: Code Deploy
        run: aws deploy create-deployment --application-name $CODE_DEPLOY_APP_NAME --deployment-config-name CodeDeployDefault.OneAtATime --deployment-group-name $DEPLOYMENT_GROUP_NAME --s3-location bucket=$BUCKET_NAME,bundleType=zip,key=$PROJECT_NAME/$GITHUB_SHA.zip
# ---------------------

1) env: deploy.yml 파일에 사용되는 변수를 선언합니다.

• PROJECT_NAME: 프로젝트 이름을 설정합니다. 이 변수는 S3 경로 설정에 사용욉니다.
• BUCKET_NAME: 앞서 생성한 S3 버킷 이름을 넣어줍니다.
• CODE_DEPLOY_APP_NAME: CodeDeploy 어플리케이션 이름을 넣어줍니다.
• DEPLOYMENT_GROUP_NAME: CodeDeploy 배포 그룹 이름을 넣어줍니다.

2) jobs - steps에 다음과 같은 동작을 추가합니다.

• Make Zip File : zip파일을 생성합니다.
• Configure AWS Credentials : AWS_SECRET_ACCESS_KEY을 통해 AWS 계정에 접근할 수 있는 권한을 얻습니다.
• Upload to S3 : S3 버킷에 zip파일을 업로드합니다.
• Code Deploy : CodeDeploy에 배포 요청을 날립니다.

---

👩‍💻 appspec.yml 생성

프로젝트 최상단 경로에 appspec.yml파일을 생성합니다. 이 파일은 배포 시, CodeDeploy가 참조하는 파일입니다.

yml파일을 다음과 같이 작성합니다.

version: 0.0
os: linux
files:
  - source:  /
    destination: /home/ubuntu/tikkle
    overwrite: yes

permissions:
  - object: /
    pattern: "**"
    owner: root
    group: root

hooks:
  AfterInstall:
    - location: scripts/deploy.sh
      timeout: 60
      runas: root

• version: appspec.yml파일 버전을 정의합니다.
• files:
  • 배포할 파일 및 디렉토리를 정의합니다. 애플리케이션을 루트 디렉토리에서 가져와 “/home/ubuntu/tikkle” 디렉토리로 복사합니다.
• permissions:
  • 어플리케이션 파일에 대한 권한을 설정합니다. “/home/ubuntu/tikkle” 디렉토리의 그룹과 소유자를 root로 설정합니다.
• hooks:
  • AfterInstall: 여러 배포 단계 중 AfterInstall 단계에서 스크립트를 실행합니다
  • 배포 단계에서 실행할 훅 스크립트를 정의합니다. 배포 후 실행할 스크립트인 deploy.sh 파일을 지정하고, 스크립트 실행 시간을 60초로 설정합니다.

---

👩‍💻 scripts/deploy.sh 배포 스크립트 생성

프로젝트 최상단에 scripts/deploy.sh 파일을 생성합니다.

이 스크립트는 이전에 실행중인 프로세스를 중단하고, 최신 버전의 Jar파일을 실행하는 작업을 수행합니다.

 

#!/usr/bin/env bash

REPOSITORY=/home/ubuntu/tikkle
cd $REPOSITORY

echo "> Build 파일 복사"
cp ./build/libs/*.jar $REPOSITORY/

echo "> 현재 구동중인 애플리케이션 pid 확인"
CURRENT_PID=$(pgrep -fl tikkle)
echo "$CURRENT_PID"

if [ -z $CURRENT_PID ]
then
  echo "> 종료할것 없음."
else
  echo "> kill -15 $CURRENT_PID"
  kill -15 $CURRENT_PID
  sleep 5
fi

echo "> 새 어플리케이션 배포"
JAR_NAME=$(ls -tr $REPOSITORY/ | grep jar | tail -n 1)

echo "> JAR Name: $JAR_NAME"

echo "> $JAR_NAME에 실행권한 추가"
chmod +x $JAR_NAME

echo ">$JAR_NAME 실행"

nohup java -jar $JAR_NAME > /dev/null 2> /dev/null < /dev/null &

 

---

👩‍💻 결과

cicd를 하기 위한 준비는 다 마쳤습니다. 메인 브랜치로 푸시해 정상 작동하는지 확인해 봅니다.

 

---

👩‍💻 마치며

드디어 CI/CD 구축에 대한 내용이 끝났습니다!

 

자동 배포 프로세스를 구축하는데 긴 시간이 걸렸지만, 한 번 구축해 놓으면 배포 과정을 줄일 수 있으니 구축해 보는 것을 추천드립니다!

 

다음에는 티끌이 어떻게 요구사항을 분석하고 테이블을 설계하는지에 대한 내용으로 찾아뵙겠습니다.

 

감사합니다😄

 

📩 Contact : uuuuujeong00000@naver.com

📲 SNS : https://www.instagram.com/may_u_j__