1. 시작하며

Spring Boot와 Ec2로 CI/CD 하는 과정의 Log를 기록.

1.1. 환경은 아래와 같다.

Web Framework: Spring Boot
AWS: EC2, CodeDeploy, IAM(role)
Etc: Github actions

1.2.실행과정

1. SpringBoot를 Github에 Push하면 Github actions 트리거 발동
2. ".github/workflows/CI.yml" 파일 기반으로 Github actions Job진행
3. CodeDeploy를 사용하여 Ec2에 코드를 주입하고 start.sh와 stop.sh를 기반으로 서비스 실행
4. 배포 완료

2. 설정

2.1. AWS

2.1.1. IAM설정

2.1.1.1. 사용자(Users) 설정

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

AmazonS3FullAccess
AWSCodeDeployFullAccess
AWSCodeDeployRole

2.1.1.2. 역할(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"
        }
    ]
}

2.1.2. EC2설정

2.1.2.1. EC2 인스턴스 생성 및 설정

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

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

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

2.1.2.3. 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

2.1.3. S3 설정

2.1.3.1. 버킷생성

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

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

2.1.4. CodeDeploy 설정

2.1.4.1. Application 생성

• Compute platform: EC2/On-premises

2.1.4.2. Deployment Group 생성

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

2.1.4.3. Environment configuration

• Amazon EC2 Instances로 설정

2.1.4.4. Deployment settings

• CodeDeployDefault.AllAtOnce

2.1.4.5. Load Balancer

• 로드 밸런싱 비활성화

3.1. SpringBoot & Github Actions

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

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

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

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

jar {
    enabled = false
}

3.1.3. Github Actions의 WorkFlow(.github/workflows/CI.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

3.1.4. 루트 경로에 appspec.yml 파일추가. CodeDeploy가 수행을 완료하면 AfterInstall과 AppllicationStart를 실행

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

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

3.1.5.1. 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

3.1.5.2. 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

3. 출처

https://wangkisa.tistory.com/67
https://bcp0109.tistory.com/363