[Continuous Deploy] AWS CodeDeploy & EC2 with Github Actions

배경

사용 기술

• Github Actions
• AWS CodeDeploy
• AWS EC2
• AWS IAM
• Spring Boot

구조

프로세스

1.  웹프레임워크 SpringBoot로 개발한 문서를 Github에 Push하면 Github actions 트리거 발동
2.  ".github/workflows/CI.yml" workflow 파일 기반으로 Github actions Job진행
   1.  JDK 버전에 맞게 JAVA 버전 설정 ( 본 프로젝트 : java-version:17 )
   2.  Gradlew 파일 권한 설정
   3.  Gradlew 파일로 Spring Boot Build
   4.  AWS 접근을 위한 IAM 설정 ( aws-access-key , aws-secret-access-key )
   5. 빌드한 jar 파일을 AWS S3에 업로드
   6. CodeDeploy를 사용하여 EC2에 주입
   7. CodeDeploy 주입을 완료하면 appspec.yml 코드 실행
      1. AfterInstall: 설치가 끝났을 때 ( stop.sh 스크립트 실행 )
      2. ApplicationStart: 서비스가 시작되었을 때 ( start.sh 스크립트 실행 )
   8. appspec.yml 코드 중 stop.sh 실행
      • 현재 JAR 파일이 실행 중인 확인 후 실행 중이면 종료
   9. appspec.yml 코드 중 start.sh 실행
      • nohup으로 새로 주입한 JAR 파일 백그라운드 실행
3. 배포 완료

세팅

AWS IAM 설정

AWS IAM USER 설정

• 사용자 이름 설정 후 3가지 정책추가
  • AmazonS3FullAccess
  • AmazonS3FullAccess
  • AmazonS3FullAccess

AWS IAM ROLE 설정

• 역할 이름 설정 후 3가지 정책 추가
• 신뢰할 수 있는 엔터티 유형: AWS 서비스
• 일반 사용사례: EC2
  • AmazonEC2RoleforAWSCodeDeploy
  • AmazonS3FullAccess
  • AWSCodeDeployRole
• 신뢰관계 정책 설정

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service": [
                    "codedeploy.ap-northeast-2.amazonaws.com",
                    "ec2.amazonaws.com"
                ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

AWS EC2 설정

EC2 인스턴스 생성 및 설정

• EC2생성, 탄력적 IP설정, 보안규칙설정(인바운드), 태그 추가도 좋음

생성 완료시 기존에 설정한 IAM 역할수정

• 작업 > 보안 > IAM 역할 수정
• 위에서 설정한 역할로 등록

CodeDeploy Agent 설치

• 공식 문서 혹은 아래 수행 내역을 진행
• ⚠ sudo ./install auto > /tmp/logfile 에서 오류 발생
  본인은 sudo ./install deb로 진행. 추가 자료는 공식 문서 확인

sudo apt update
sudo apt install ruby-full
sudo apt install wget
cd /home/ubuntu
wget https://aws-codedeploy-ap-southeast-1.s3.ap-southeast-1.amazonaws.com/latest/install
chmod +x ./install
sudo ./install auto > /tmp/logfile
sudo service codedeploy-agent start

AWS S3 설정

버킷생성

이 버킷의 퍼블릭 액세스 차단 설정

• 모든 퍼블릭 엑세스 차단 외 비활성화
• ⚠ github actions의 workflow file에서 bucket명 지정해줘야함

CodeDeploy 설정

Application 생성

• Compute platform: EC2/On-premises

Deployment Group 생성

• 위에서 설정한 Role을 Service Role로 생성
• ⚠ 본인은 이 과정에서 Role이 안나와서 난관을 겪음

Environment configuration

• Amazon EC2 Instances로 설정

Deployment settings

• CodeDeployDefault.AllAtOnce

Load Balancer

• 로드 밸런싱 비활성화

SpringBoot & Github Actions Workflow

Spring Boot 컨트롤러 설정

• HelloWorld 프로젝트를 생성 후 Root Path("/")요청시 HelloWorld가 출력되는 프로젝트 생성

@RestController
@RequestMapping("/")
public class HelloworldController {
    @RequestMapping()
    @GetMapping()
    public String main(){
        return "Hello World";
    }
}

Spring Boot build.gradle 설정

• Ouput되는 Jar파일의 이름을 고정하기 위해 build.gradle에 아래 코드 추가

bootJar{
    archivesBaseName = 'HelloWorld'
    archiveFileName = 'helloworld.jar'
    archiveVersion = "0.0.1"
}

jar {
    enabled = false
}

Github Actions WorkFlow 설정

• .github/workflows/CD.yml 위치에 파일 생성
• 수정해야할 부분 주석처리

name: Deploy to Amazon EC2

on:
  push:
    branches:
      - master
env:
  S3_BUCKET_NAME: backble //S3의 버킷명
  CODE_DEPLOY_APPLICATION_NAME: SpringCICD //CodeDeploy생성시 어플리케이션명
  CODE_DEPLOY_DEPLOYMENT_GROUP_NAME: SpringCICD //CodeDeploy를 생성후 어플리케이션 내부의 배포그룹명

permissions:
  contents: read

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    environment: production

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

      - name: Set up JDK 17 //프로젝트 JDK에 맞는 버전 설정 (build.gradle 참고)
        uses: actions/setup-java@v1
        with:
          java-version: '17' //프로젝트 JDK에 맞는 버전 설정 (build.gradle 참고)

      - name: Grant execute permission for gradlew
        run: chmod +x gradlew

      - name: Build with Gradle
        run: ./gradlew clean build

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} //IAM의 ACCESS KEY ID를 GITHUB SECRET KEY로 설정
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} //GITHUB SECRET KEY로 설정
          aws-region: ${{ secrets.AWS_REGION }} //GITHUB SECRET KEY중 AWS_REGION의 값을 ap-northeast-2로 설정

      - name: Upload to AWS S3
        run: |
          aws deploy push \
            --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }} \
            --ignore-hidden-files \
            --s3-location s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip \
            --source .

      - name: Deploy to AWS EC2 from S3
        run: |
          aws deploy create-deployment \
            --application-name ${{ env.CODE_DEPLOY_APPLICATION_NAME }} \
            --deployment-config-name CodeDeployDefault.AllAtOnce \
            --deployment-group-name ${{ env.CODE_DEPLOY_DEPLOYMENT_GROUP_NAME }} \
            --s3-location bucket=$S3_BUCKET_NAME,key=$GITHUB_SHA.zip,bundleType=zip

Github Actions appspec.yml 설정

• 레포지토리 루트 경로에 appspec.yml 파일 추가
• CodeDeploy가 해당 파일을 기반으로 AfterInstall(stop.sh) 과 AppllicationStart(start.sh)를 실행

version: 0.0
os: linux

files:
  - source:  /
    destination: /home/ubuntu/app
    overwrite: yes

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

hooks:
  AfterInstall:
    - location: scripts/stop.sh
      timeout: 60
      runas: ubuntu
  ApplicationStart:
    - location: scripts/start.sh
      timeout: 60
      runas: ubuntu

Github Actions Script Shell 설정

• 루트 경로에 scripts 폴더를 추가. scripts 폴더에 start.sh파일과 stop.sh파일을 추가
• scripts/start.sh

#!/usr/bin/env bash

PROJECT_ROOT="/home/ubuntu/app" #코드가 주입되는 경로
JAR_FILE="$PROJECT_ROOT/helloworld.jar" #build.gradle에서 설정한 파일명으로 변경

APP_LOG="$PROJECT_ROOT/application.log"
ERROR_LOG="$PROJECT_ROOT/error.log"
DEPLOY_LOG="$PROJECT_ROOT/deploy.log"

TIME_NOW=$(date +%c)

echo "$TIME_NOW > $JAR_FILE 파일 복사" >> $DEPLOY_LOG
cp $PROJECT_ROOT/build/libs/*.jar $JAR_FILE

echo "$TIME_NOW > $JAR_FILE 파일 실행" >> $DEPLOY_LOG
nohup java -jar $JAR_FILE > $APP_LOG 2> $ERROR_LOG &

CURRENT_PID=$(pgrep -f $JAR_FILE)
echo "$TIME_NOW > 실행된 프로세스 아이디 $CURRENT_PID 입니다." >> $DEPLOY_LOG

• scripts/stop.sh

#!/usr/bin/env bash

PROJECT_ROOT="/home/ubuntu/app" #코드가 주입되는 경로
JAR_FILE="$PROJECT_ROOT/helloworld.jar" #build.gradle에서 설정한 파일명으로 변경

DEPLOY_LOG="$PROJECT_ROOT/deploy.log"

TIME_NOW=$(date +%c)

CURRENT_PID=$(pgrep -f $JAR_FILE)

if [ -z $CURRENT_PID ]; then
  echo "$TIME_NOW > 현재 실행중인 애플리케이션이 없습니다" >> $DEPLOY_LOG
else
  echo "$TIME_NOW > 실행중인 $CURRENT_PID 애플리케이션 종료 " >> $DEPLOY_LOG
  kill -15 $CURRENT_PID
fi

출처

• https://wangkisa.tistory.com/67

GitHub Actions과 AWS CodeDeploy 사용하기

• https://bcp0109.tistory.com/363

Github Actions CD: AWS EC2 에 Spring Boot 배포하기