[싹틔움] 11/15 개발일지 Github Actions 를 사용한 CI/CD 자동화

💡 목표

CI/CD 자동화를 통해 main 브랜치로 Pull Request 가 이루어지면 자동으로 배포까지 되도록 설정하고자 했다.

 

 

DockerFile

FROM amazoncorretto:17-alpine-jdk
EXPOSE 8080
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java", "-jar", "app.jar"]

 

Github Actions 를 사용하기 위해서 Docker File 을 만들어준다.

 

CICD.yml

name: CI/CD

on:
  pull_request:
    branches: ["main"]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Build with Gradle
        run: |
          chmod +x ./gradlew
          ./gradlew clean build -x test

      - name: Login to DockerHub
        uses: docker/login-action@v1
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Build Docker Image
        run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1 .

      - name: Push Docker Image
        run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

  deploy:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to Server
        uses: appleboy/ssh-action@master
        with:
          username: ubuntu
          host: ${{ secrets.SSAKTIUM_SERVER_IP }}
          key: ${{ secrets.EC2_SSH_KEY }}
          script_stop: true
          script: |
            # Pull the latest image from DockerHub
            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1
            
            # Stop and remove the existing container if it exists
            if [ "$(sudo docker ps -q -f name=daegyuhan-ssak)" ]; then
              sudo docker stop daegyuhan-ssak
            fi
            
            if [ "$(sudo docker ps -aq -f status=exited -f name=daegyuhan-ssak)" ]; then
              sudo docker rm daegyuhan-ssak
            fi
            
            # Run the new container with the .env file for environment variables
            sudo docker run -d --name daegyuhan-ssak --env-file /home/ubuntu/.env -p 8080:8080 ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

 

이벤트가 일어났을 때 자동으로 실행되는 것이 트리거.

 

main 브랜치에 pull request 가 일어나면 이 파일을 실행하겠다는 뜻이다.

---

💡 Work Flow 분석: Build

jobs:
  build:
    runs-on: ubuntu-latest

 

runs on : ubuntu 최신버전 

가상의 pc 가 실행될텐데 설정해주는 것

ubuntu  가 가장 가볍고 보편적고 서버로 많이 사용됨

 

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

      - name: Install JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Build with Gradle
        run: |
          chmod +x ./gradlew
          ./gradlew clean build -x test

steps:

단위는 name 으로 끊어서 실행한다.

 

uses:

github action 에 템플릿이 몇 가지 있다.

이 레포지토리에 pull request 가 일어나면 checkout, 자동으로 패치하고 풀 하겠다는 뜻이다.

ubuntu 에다가 자동으로 git 설치하고 repository 를 pull 하는 과정을 다 생략해주는 편한 기능이다.

 

install JDK 17

clean 하고 build 누르면 jar 파일 만들어지는데 jar 파일이 있어야지 다른 환경에서 실행을 할 수 있다.

이 jar 파일을 가지고 docker 를 실행시킬 것인데 그렇게 하기 위해서 

      - name: Build with Gradle
        run: |
          chmod +x ./gradlew
          ./gradlew clean build -x test

 

clean, build 작업을 진행한다.

이러면 jar 파일이 만들어진다.

 

지금 단계에서 테스트코드가 완성이 안되어있기 때문에 -x test 를 통해 test 코드 실행은 스킵해주었다.

 

      - name: Login to DockerHub
        uses: docker/login-action@v1
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Build Docker Image
        run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1 .

      - name: Push Docker Image
        run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

 

build 를 통해 만든 jar 파일을 Docker 이미지로 만들고 Docker Hub 에 올리기 위해서 Docker Hub 에 로그인을 해야한다.

이후에 Docker Hub 에 올려진 이 이미지 파일을 EC2 에 접속해 다운받게 하기 위함이다.

 

github 홈페이지에서 설정한 환경변수를 활용해서 해당 이름으로 이미지를 만들고,

그 이미지를 Docker Hub 에 push 를 한다.

 

Repository Secrets 설정하기

 

이렇게 정보들을 다 넣어준다.

그럼 해당 secrets 의 값을 넣을 수 있다.

---

💡 Work Flow 분석: Deploy

deploy:
  needs: build
  runs-on: ubuntu-latest
  steps:
    - name: Deploy to Server
      uses: appleboy/ssh-action@master
      with:
        username: ubuntu
        host: ${{ secrets.SSAKTIUM_SERVER_IP }}
        key: ${{ secrets.EC2_SSH_KEY }}
        script_stop: true
        script: |
          # Pull the latest image from DockerHub
          sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1
          
          # Stop and remove the existing container if it exists
          if [ "$(sudo docker ps -q -f name=daegyuhan-ssak)" ]; then
            sudo docker stop daegyuhan-ssak
          fi
          
          if [ "$(sudo docker ps -aq -f status=exited -f name=daegyuhan-ssak)" ]; then
            sudo docker rm daegyuhan-ssak
          fi
          
          # Run the new container with the .env file for environment variables
            sudo docker run -d --name daegyuhan-ssak --env-file /home/ubuntu/.env -p 8080:8080 ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

 

deploy 환경에서도 build 와 마찬가지로 ubuntu 환경에서 작업했다.

EC2 에 접속하기 위해서 해당 IP 와 SSH_KEY 를 입력했다.

 

Build 단계에서 Push 했던 Docker 이미지를 Pull 로 당겨왔다.

 

이전에 실행되고 있는 동일한 이름의 컨테이너가 있으면 충돌이 일어나기 때문에 

조건문을 사용해서 멈춘 후 삭제처리를 했다.

 

# Run the new container with the .env file for environment variables
sudo docker run -d --name daegyuhan-ssak --env-file /home/ubuntu/.env -p 8080:8080 ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

 

필자는 EC2 에 .env 파일을 만들어서 프로젝트 yml 파일에서 사용된 환경변수들을 처리했다.

 

때문에 컨테이너를 실행시킬 때 EC2 내부에 .env 를 참고해서 실행할 수 있도록 위와 같이 코드를 짜줬다.

---

이전에 발표했던 CI, CD 에 대한 내용과 파이프라인 구축에 대해 공부를 했던 내용들을 참고했다.

https://hanstory33.tistory.com/241

[CS] CI 와 CD 란?

https://hanstory33.tistory.com/243

[CS] CI/CD 파이프라인 구축을 위한 이해