Github Action 배포 자동화 파이프라인 구축 A-Z

작년에 10월에 처음 aws에 서버 배포를 시도했었다. 해커톤을 진행하다 개발을 끝내고 배포를 시도했던건데 아무런 지식도 없이 맨땅에 해딩하다보니 수없이 삽질을 했다. jpa + mysql을 사용한 프로젝트였지만 rds 세팅도 하지 않고 elastic beanstalk으로 배포하려 했었다. 아무튼 1년이 지난 지금 여전히 aws는 어렵다. 이번에 github action ci/cd 파이프라인을 구축했던 과정을 남겨두려한다.

 

 

 

인스턴스 생성

• 인스턴스 생성은 우분투로 하였고 따라할 다른 블로그도 너무 많으니 생략

 

 

태그 값 설정

• 지금 설정하는 태그는 뒤에서 codedeploy를 사용하기 위함이다

 

 

인바운드 규칙 편집

• 인바운드 규칙은 본인의 프로젝트에 맞게 열면 된다.
• 필자는 아래와 같이 열어주었다.
• ssh 접속을 위한 22번 포트
• 스프링 실행을 위한 8080 포트
• http, https 접속을 위한 80, 443 포트
• mysql을 사용하기 위한 3306 포트를 열어두었다.

 

 

탄력적 IP 연결

• 탄력적 IP 를 생성하고 이전에 만든 ec2에 연결해준다.
• 탄력적 IP를 연결하지 않으면 ec2의 IP가 계속 바뀌게 된다.
• 무엇보다 탄력적 IP를 연결하지 않고 ec2가 켜져있으면 요금이 부과된다.
• 반대로 탄력적 IP를 생성하고 ec2에 연결하지 않으면 요금이 부과된다.

 

 

ssh를 통해 ec2 접속

• 금방 해결했던 문제이긴 하지만 C드라이브 바로 아래에 pem 키를 넣으니 들어가지지 않았다.
• 바탕화면에 pem키를 두고 ec2에 접속하니 잘 들어가졌다. 이유는..모르겠다

 

 

ec2 세팅

sudo apt update && sudo apt upgrade # ubuntu 업데이트 및 업그레이드
sudo apt install openjdk-17-jdk # 자바 설치
java -version # 버전 확인

sudo apt-get install git # 깃 설치
git --version # 깃 버전 확인

# 아래는 aws 가이드라인 따라한것
sudo apt install ruby-full
sudo apt install wget
wget https://{bucket-name}.s3.{region-identifier}.amazonaws.com/latest/install
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  #code deploy 작동 확인

 

 

IAM 등록

• 사진과 같이 s3 와 deploy에 대한 권한을 추가해준다.

 

 

위에서 만든 IAM을 ec2에 등록해준다.

 

 

(참고) pem키 없이 비밀번호로 ec2에 접근 가능하도록 세팅

• ec2 서버에서 아래 파일에 PasswordAuthentication을 yes로 변경
• sudo vi /etc/ssh/sshd_config sudo su - #ubuntu에 권한 부여 passwd ubuntu #패스워드 변경 exit 후 #ec2로 나가서 sudo service ssh restart #재시작

• 이렇게 설정하면 ssh ubuntu@{ip}.ap-northeast-2.compute.amazonaws.com 을 통해 비밀번호로 접속 가능하다.

 

 

S3 생성

• 이미지를 저장하기 위한 s3와는 조금 다르게 세팅해줘야 한다.

 

 

IAM 사용자 생성

• 아래와 같이 액세스 키를 만들어준다.
• 이 액세스 키는 잊어버리지 않게 따로 저장해둬야 한다.
• 나중에 github action 에서 사용 예정

 

 

github setting

• AWS_ACCESS_KEY_ID와 AWS_SECRET_ACCESS_KEY는 바로 위에서 받은 키를 입력해준다.
• AWS_REGION은 ap-northeast-2로 세팅하면 된다.

 

 

Code Deploy 권한 부여 및 생성

• 아래 사진과 같이 부여 및 생성

 

 

생성 후 deployment group 설정

• 위에서 만든 IAM을 code-deploy에 등록해준다.

• 제일 처음 ec2에 등록했던 태그를 선택하여 ec2와 code deploy를 연결해준다.

 

 

./github/workflows/deploy.tml 생성

name: CI-CD

# 이벤트 트리거 설정
# push 이벤트 발생 시 실행
# release 브랜치에 push가 이루어졌을 때만 워크플로우 실행
on:
  push:
    branches:
      - release

# 환경 변수
env:
  S3_BUCKET_NAME: colony-deploy-bucket
  CODE_DEPLOY_APPLICATION_NAME: CODE-DEPLOY-COLONY-TEST
  CODE_DEPLOY_DEPLOYMENT_GROUP_NAME: CODE-DEPLOY-GROUP

# 작업 정의
jobs:
  build:
    runs-on: ubuntu-latest # 가장 최신 버전의 우분투를 사용

    steps:
      - name: Checkout # 저장소 체크아웃
        uses: actions/checkout@v2

      - name: Set up JDK 17 # JDK 17 설치
        uses: actions/setup-java@v2
        with:
          distribution: 'adopt'
          java-version: 17

      - name: Grant execute permission for gradlew # gradlew 실행 권한 부여
        run: chmod +x ./gradlew
        shell: bash

      - name: Build with Gradle  # Gradle을 사용하여 빌드
        run: ./gradlew build
        shell: bash

      - name: Make zip file # zip 파일 생성
        run: zip -r ./$GITHUB_SHA .
        shell: bash

      - name: Configure AWS credentials # AWS 인증 정보 설정
        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: ${{ secrets.AWS_REGION }}

      - name: Upload to S3 # 생성된 zip 파일을 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 \
          --deployment-config-name CodeDeployDefault.AllAtOnce \
          --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }} \
          --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }} \
          --s3-location bucket=$S3_BUCKET_NAME,bundleType=zip,key=$GITHUB_SHA.zip

 

 

appspec.yml 생성

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

permissions: # 파일 및 폴더의 권한 설정
  - object: /
    pattern: "**"
    owner: ubuntu
    group: ubuntu

hooks: # 후크 실행 설정
  ApplicationStart:
    - location: scripts/gh_deploy.sh # 실행할 스크립트 파일의 위치
      timeout: 60
      runas: ubuntu

 

 

codedeploy-agent를 ec2에 적용시키기 위해 재시작 및 로그설정

• 여기까지 됐다면 ec2 터미널에 codedeploy-agent를 재시작하여 적용시킨다.
• sudo service codedeploy-agent restart (좀 걸림) tail -F /var/log/aws/codedeploy-agent/codedeploy-agent.log

 

 

snapshot.jar 생성되지 않도록 설정

• jar파일을 찾아서 자동으로 실행되게 하는데 snapshot까지 있다면 jar파일이 두개가 된다.
• jar파일이 하나여야만 정상적으로 실행되기에 build 시 snapshot.jar는 생성되지 않도록 한다.

//SNAPSHOT 생성 x 
jar { 
	enabled = false 
}

 

 

sh 파일 생성

• 여기서 삽질을 꽤나 했다.
• yml파일에 필요한 환경변수가 있는데 이 환경변수를 프로그램 실행 시 세팅해주기 위해선 ec2 내부에 세팅이 필요했다.
• vim ~/.bashhrc 에 들어가 export로 환경변수를 등록해주어야 했다.
• export SPRING_PROFILES_ACTIVE = dev
• 이렇게 한 후 sh 파일에 source ~/.bashrc 를 추가해 jar실행 전 환경변수를 읽을 수 있도록 설정해주면서 해결했다.

#!/bin/bash
PROJECT_NAME="colony"
JAR_PATH="/home/ubuntu/colony/build/libs/*.jar"
DEPLOY_PATH=/home/ubuntu/$PROJECT_NAME/
DEPLOY_LOG_PATH="/home/ubuntu/$PROJECT_NAME/deploy.log"
DEPLOY_ERR_LOG_PATH="/home/ubuntu/$PROJECT_NAME/deploy_err.log"
APPLICATION_LOG_PATH="/home/ubuntu/$PROJECT_NAME/application.log"
BUILD_JAR=$(ls $JAR_PATH)
JAR_NAME=$(basename $BUILD_JAR)

echo "===== 배포 시작 : $(date +%c) =====" >> $DEPLOY_LOG_PATH

echo "> build 파일명: $JAR_NAME" >> $DEPLOY_LOG_PATH
echo "> build 파일 복사" >> $DEPLOY_LOG_PATH
cp $BUILD_JAR $DEPLOY_PATH

echo "> 현재 동작중인 어플리케이션 pid 체크" >> $DEPLOY_LOG_PATH
CURRENT_PID=$(pgrep -f $JAR_NAME)

if [ -z $CURRENT_PID ]
then
  echo "> 현재 동작중인 어플리케이션 존재 X" >> $DEPLOY_LOG_PATH
else
  echo "> 현재 동작중인 어플리케이션 존재 O" >> $DEPLOY_LOG_PATH
  echo "> 현재 동작중인 어플리케이션 강제 종료 진행" >> $DEPLOY_LOG_PATH
  echo "> kill -9 $CURRENT_PID" >> $DEPLOY_LOG_PATH
  kill -9 $CURRENT_PID
fi

DEPLOY_JAR=$DEPLOY_PATH$JAR_NAME
echo "> DEPLOY_JAR 배포" >> $DEPLOY_LOG_PATH
source ~/.bashrc  # 환경 변수 세팅
nohup java -jar $DEPLOY_JAR >> $APPLICATION_LOG_PATH 2> $DEPLOY_ERR_LOG_PATH &

sleep 3

echo "> 배포 종료 : $(date +%c)" >> $DEPLOY_LOG_PATH

• 여기까지 하면 ci/cd 배포 자동화 세팅은 끝이난다.
• 이제 release 브랜치에 push 되면 빌드 후 s3로 zip 파일이 올라가게 되고 ec2에서 jar파일이 실행되게 된다.

 

 

 

여기까지 하면  ci/cd 배포 자동화 세팅은 끝이난다.

이제 release 브랜치에 push 되면 빌드 후 s3로 zip 파일이 올라가게 되고 ec2에서 jar파일이 실행되게 된다.