Github Actions + Docker + EC2로 Spring Boot CI /CD 구축

1. Github Secrets 설정

 

 

Github Actions를 적용할 Repo의 Setting에서 Secrets and variables에 들어가주면

New repository secret로 환경 변수를 설정할 수 있음

 

• DOCKERHUB_USERNAME
  
  => Docker Hub 사용자 이름
  
  
• DOCKERHUB_PASSWORD
  
  => Docker Hub 비밀번호
  
  
• EC2_HOST
  
  => EC2 퍼블릭 IP
  
  
• EC2_USER
  
  => EC2에 SSH로 접속할 때 사용할 사용자 이름임
  (우분투 EC2를 사용중이기에 ubuntu로 지정하였음)
  
  
• EC2_SSH_KEY
  
  
  

https://hanjungyo.tistory.com/127

Jenkins을 이용한 Spring Boot 배포 자동화

 

EC2_SSH_KEY에 대해서는 위 포스팅의 SSH키 설정 부분을 참고하면 알 수 있음

주의해야할 부분은

1. 접근하는쪽인 GitHub에 공개키가 아닌 비밀키를 넣어줘야한다는점

2. EC2 인스턴스의 authorized_keys에는 GitHub Actions에서 사용되는 비밀키에 해당하는 공개키 (id_rsa.pub) 가 등록되어야 SSH 연결이 가능하다는점

 

• APPLICATION

 

application.yml 파일도 설정을 해야하는데 (보안상의 이슈로 gitignore 처리 되어 있음)

 

코드를 그냥 넣어도 되지만 공백이나 특수문자 등에서 오류가 날 수 있다고해서 Base64로 인코딩한 값을 APPLICATION으로 저장하였음

 

https://www.convertstring.com/ko/EncodeDecode/Base64Encode

Base64로 인코딩 - 온라인 Base64로 인코더

 

위 사이트에서 application.yaml 파일을 넣고 Base64로 인코딩할 수 있음

 

 

2.  CI 테스트 (Java with Gradle)

 

 

CI / CD를 적용할 Github Repo의 상단바에서 Actions를 클릭하고 Java with Gradle을 Configure해야함

 

name: Java CI with Gradle

on:
  push:
    branches: [ "backend/main", "backend/feature/cd-setup" ]
  pull_request:
    branches: [ "backend/main", "backend/feature/cd-setup" ]
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
      - uses: actions/checkout@v4

      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0

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

      - name: Create application.yml from GitHub Secrets
        run: |
          mkdir -p backend/src/main/resources
          echo "${{ secrets.APPLICATION }}" | base64 --decode > backend/src/main/resources/application.yml

      - name: Build with Gradle Wrapper
        working-directory: backend
        run: ./gradlew build

 

필요없는 부분도 있기에 위와 같이 수정해줬음

 

코드를 살펴보면

 

• Java CI with Gradle 이라는 이름의 GitHub Actions 워크플로우를 만듬
  
  
• backend/main 과  backend/feature/cd-setup 로 시작하는 브랜치에 push 또는 pull request 가 발생하면 이 워크플로우가 실행되도록 트리거 조건을 걸었음
  
  => workflow_dispatch를 통해 이 workflow 파일을 가진 브랜치에서 트리거 외에 수동으로 작업을 수행할 수 있음
  
  

 

workflow_dispatch 설정 시 Actions에 들어가서 좌측의 실행할 workflow 이름을 선택하게되면 오른쪽 빨간 박스에 있는 Run workflow를 볼 수 있음

이 때 실행할 branch를 선택하게 되면 수동으로 workflow 수행이 가능한데 이를 위해선 해당 branch의 .github/workflows에 해당 workflow 관련 yml 파일이 존재해야함

 

• build라는 job을 정의하고 실행 환경을 ubuntu 최신 환경으로 지정하였음
  (저장소의 내용을 읽을 수 있도록 최소한의 권한을 설정)
  
  
  • 현재 저장소의 코드를 checkout하여 runner 환경에 다운로드
    
    
  • JDK 17을 설치 (Adoptium에서 제공하는 OpenJDK 배포판인 temurin)
    
    
  • 공식 Gradle GitHub Action을 사용하여 Gradle을 설정
    
    
  • gradlew(Gradle Wrapper) 파일이 실행될 수 있도록 권한 부여
    
    => 현재 github repo의 디렉토리 구조가 fornt 와 backend 폴더가 함께 존재하기에 gradlew의 위치를 backend/gradelw로 해줘야 backend 폴더 안에 있는 gradlew를 제대로 찾을 수 있음
    
    
  • github secrets에 저장한 base64 인코딩된 application.yml 파일을 (변수명 APPLICATION) 디코딩 하여 지정해둔 위치에 저장
  • Gradle을 사용하여 프로젝트 빌드
    
    => working directory를 backend로 설정하였음
    (이전에 말한대로 현재 루트에는 front 와 backend 두개의 디렉토리가 모두 존재하기에)

 

 

 

프로젝트 폴더 구조가 위와 같으므로 빌드할 때 working-directory를 backend로 지정해주어야함

 

위와 같은 CI 워크플로우를 통해 PR이나 코드 변경 시 자동으로 빌드 오류를 확인할 수 있음

 

 

위와 같이 성공하는 것을 확인할 수 있음

 

주의사항

.github/worflows/gradle.yml 에 위에서 작성한 yml 파일이 들어가게될텐데

 

이미 존재하는 특정 branch를 트리거해놨더라도 해당 브렌치에 gradle.yml 파일 즉, Github Action 파일이 없다면 실행되지 않음

 

따라서, master 브랜치에 yml 파일을 만들고 트리거 설정을 해놓은 브랜치에 merge 하거나 처음부터 Action을 사용할 브랜치에 gradle.yml을 생성하면 됨

 

 

3. CD 작성

 

name: Java CI/CD with Gradle & Docker

on:
  push:
    branches: [ "backend/main", "backend/feature/cd-setup" ]
  pull_request:
    branches: [ "backend/main", "backend/feature/cd-setup" ]
  workflow_dispatch:

jobs:
  build-docker-image:
    runs-on: ubuntu-latest
    permissions:
      contents: read

    steps:
      # GitHub 저장소에서 코드를 가져옴
      - uses: actions/checkout@v4
      
      # JDK 17 설정
      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      # Gradle 설정
      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0

      # Gradle wrapper 실행 권한 부여
      - name: Grant execute permission for gradlew
        run: chmod +x backend/gradlew

      # GitHub Secrets에서 application.yml 파일 생성
      - name: Create application.yml from GitHub Secrets
        run: |
          mkdir -p backend/src/main/resources
          echo "${{ secrets.APPLICATION }}" | base64 --decode > backend/src/main/resources/application.yml

      # Gradle 빌드 실행
      - name: Build with Gradle Wrapper
        working-directory: backend
        run: ./gradlew build

      # Docker 이미지 빌드
      - name: Build Docker Image
        working-directory: backend
        run: |
          docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/2025capstone:latest .

      # Docker Hub 로그인
      - name: Login to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_PASSWORD }}

      # Docker Hub에 이미지 푸시
      - name: Push Docker Image to Docker Hub
        run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/2025capstone:latest

  run-docker-image-on-ec2:
    needs: build-docker-image
    runs-on: ubuntu-latest

    steps:
      # Known Hosts 업데이트: EC2에 SSH 접속하기 위해 known_hosts 파일에 EC2 호스트 추가
      - name: Update Known Hosts
        run: |
          mkdir -p ~/.ssh
          ssh-keyscan -H ${{ secrets.EC2_HOST }} >> ~/.ssh/known_hosts

      # EC2에 Docker 이미지 배포
      - name: Deploy to EC2
        uses: appleboy/ssh-action@v0.1.6
        with:
          host: ${{ secrets.EC2_HOST }}
          username: ${{ secrets.EC2_USER }}
          key: ${{ secrets.EC2_SSH_KEY }}
          script: |
            # 기존 컨테이너가 있으면 중지하고 삭제
            sudo docker stop $(sudo docker ps -q --filter ancestor=${{ secrets.DOCKERHUB_USERNAME }}/2025capstone)
            sudo docker rm $(sudo docker ps -aq --filter ancestor=${{ secrets.DOCKERHUB_USERNAME }}/2025capstone)
            
            # 최신 Docker 이미지 가져오기
            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/2025capstone:latest
            
            # 새 컨테이너 실행
            sudo docker run --rm -it -d -p 8080:8080 --name 2025capstone ${{ secrets.DOCKERHUB_USERNAME }}/2025capstone:latest
            
            # 사용하지 않는 Docker 이미지 및 캐시 정리
            sudo docker system prune -f

 

 

기존의 CI 테스트 코드에서 변경된 부분을 살펴보면

 

• ./gradlew build 명령어로 Gradle을 사용해 어플리케이션을 빌드한 후 docker build 명령어를 사용하여 backend 디렉토리에서 Docker 이미지를 빌드하고 USERNAME 값에 따라 2025capstone:latest 로 태깅함
  
  => USERNAME/2025capstone:latest 이미지 생성
  
  
• docekr/login-action@v2 를 사용해 Docker Hub에 로그인함
  
  => github secrets에 지정해둔 유저아이디와 비밀번호 사용
  
  
• 빌드한 Docker 이미지를 docker push 명령어로 Docker Hub에 푸시함
  
  
  
• run-docker-image-oon-ec2 작업
  
  
  • ssh-keyscan을 사용해 EC2 호스트의 SSH 공개 키를 ~/.ssh/known_hosts에 추가함
    
    (위에 첨부한 ssh 설정 포스팅 참고)
    
    
  • appleboy/ssh-action@v0.1.6을 사용해 EC2에 SSH로 연결하고 작업 실행
    
    
    • docker stop 및 docker rm 명령어로 이전에 실행중인 컨테이너를 중지하고 삭제
      
      
    • docker pull 로 Docker Hub에서 최신 이미지를 가져옴
      
      
    • docker run 명령어로 새로운 컨테이너를 8080 포트에 배포함
      
      
    • docker system prune을 사용해 불필요한 Docker 이미지와 캐시를 정리함

 

4. 테스트

 

 

 

 

workflow에 지정해둔 backend/feature/cd-setup 브랜치에 test.md 를 push 하자 위 사진과 같이 체크표시로 CD 작업이 성공적으로 이루어진 것을 확인할 수 있음

 

 

EC2에 들어가 sudo docker ps 명령어로 현재 실행중인 컨테이너 확인시 잘 동작하는 것을 확인할 수 있음