GitHub Actions을 활용하여 클라우드 VM 서버에 스프링 부트 애플리케이션 jar 파일 배포하기

🙄 GitHub Actions?

GitHub Actions는 GitHub에서 제공하는 CI/CD(Continuous Integration/Continuous Deployment) 플랫폼이다. 이를 통해 개발자는 코드를 빌드, 테스트, 배포하는 자동화된 워크플로우를 설정할 수 있다. GitHub Actions는 다양한 이벤트(예: 코드 푸시, 풀 리퀘스트 생성 등)에 반응하여 작업을 수행할 수 있다.

 

사이드 프로젝트를 제작하는데 젠킨스(Jenkins)까지는 부담스럽고, 가볍고 쉬운 배포 방식을 선택하고 고민한다면 GitHub Actions는 괜찮은 대안이 될 수 있다고 생각한다.

1. 준비

해당 포스트는 GitHub Actions를 활용해서 클라우드 VM 서버에 스프링 부트 애플리케이션 jar 파일을 배포하는 방법에 대해 설명한다.

 

준비된 환경은 아래와 같다.

 

- JDK 17

- Spring Boot 3

- Gradle

- Github Actions

- GCP VM 인스턴스 (Ubuntu 22 LTS)

- Github Private Repository

 

해당 포스트는 Docker 방식이 아닌 간단하게 스프링 부트 jar 파일을 실행시키는 배포 방식을 다룬다.

Docker 방식으로 배포하는 걸 원한다면 다른 포스트를 찾아야 한다.

2. Private Repository 생성

Spring Boot 3, Gradle, Jdk 17 환경으로 새로운 Git Repository를 Private으로 생성한다.

 

3. Secrets 설정하기

배포용 yml 파일 작성 전에 Secret 값을 설정해야 한다.

 

1) Settings - Security-Sercrets and variables - Actions 탭 들어가기

 

 

2) Secret 값 등록하기

 

총 4개의 Secret을 등록해야 하며 각 Secret은 다음 값들을 의미한다.

 

GCP_SSH_PRIVATE_KEY : SSH private key
GCP_SSH_USER : SSH로 접근할 수 있는 계정
GCP_VM_IP : GCP VM 인스턴스의 IP 주소
JAR_NAME : 프로젝트 빌드하면 나오는 jar 파일의 이름

 

각 Secret을 GCP 환경에서 획득하는 방법에 대해서 설명한다.

1. GCP_SSH_PRIVATE_KEY

Github Actions에서 SSH를 통해 해당 서버로 접근하기 위해 PRIVATE 값을 필요로 한다.

해당 값은 VM 서버에서 ssh-keygen 명령어를 수행하면 획득할 수 있다.

 

ssh-keygen -t ed25519 -f ~/.ssh/id-rsa -C [사용자 계정 ID]

 

[사용자 계정 ID] 에는 VM 서버에 배포하는 사용자 계정의 ID를 추가하면 된다.

배포용 사용자가 따로 존재한다면 해당 ID를 추가하고, 따로 없다면 SSH 접속 가능한 다른 계정을 추가한다.

 

이후 ~/.ssh 위치로 이동해서 파일 목록을 찾아보면  authorized_keys,  id-rsa,  id-rsa.pub 3개의 파일들을 확인할 수 있다. 그중 id-rsa 파일 내용 전체(-----BEGIN OPENSSH 부터 PRIVATE KEY ----- 까지)를 복사해서 GCP_SSH_PRIVATE_KEY로 등록하면 된다.

 

그리고 id-rsa.pub 파일 내용 전체를 복사해서 authorized_keys 파일에 붙여 넣기 한다.

2. GCP_SSH_USER 

GCP_SSH_PRIVATE_KEY 생성할 때 [사용자 계정 ID]로 입력한 계정을 등록하면 된다.

3. GCP_VM_IP

GCP VM 인스턴스에 접속 가능한 외부 IP를 등록하면 된다.

4. JAR_NAME

스프링 부트 애플리케이션을 빌드하면 나오는 이름 jar 파일의 이름을 적으면 된다.

프로젝트에 아무 것도 설정하지 않았다면 빌드 후에 build/libs에 있는 jar 파일 이름을 적는다.

4. CI 구축

생성한 자바 프로젝트를 jar 파일로 빌드하는 작업을 자동화할 것이다.

 

1) Actions - Java with Gradle의 Configure를 선택한다.

2) Deploy.yml에 다음과 같이 작성한다.

 

name: Java CI with Gradle

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

jobs:
  build:

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

    steps:
    # 기본 체크아웃
    - name: Checkout
      uses: actions/checkout@v4
    # Gradlew 실행 허용
    - name: Run chmod to make gradlew executable
      run: chmod +x ./gradlew
    # 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@v3
    # Gradle 빌드
    - name: Build with Gradle
      run: ./gradlew build
    # 배포 패키지 준비
    - name: Prepare deployment package
      run: |
        mkdir -p deploy
        cp build/libs/${{ secrets.JAR_NAME }}.jar deploy/
    # SSH 키 준비
    - name: Add SSH key
      uses: webfactory/ssh-agent@v0.9.0
      with:
        ssh-private-key: ${{ secrets.GCP_SSH_PRIVATE_KEY }}
    # GCP VM에 배포
    - name: Deploy to GCP VM
      run: |
        ssh -o StrictHostKeyChecking=no ${{ secrets.GCP_SSH_USER }}@${{ secrets.GCP_VM_IP }} 'sudo service shiba stop' 
        scp -o StrictHostKeyChecking=no deploy/${{ secrets.JAR_NAME }}.jar ${{ secrets.GCP_SSH_USER }}@${{ secrets.GCP_VM_IP }}:/home/${{ secrets.GCP_SSH_USER }}/app/ 
        ssh -o StrictHostKeyChecking=no ${{ secrets.GCP_SSH_USER }}@${{ secrets.GCP_VM_IP }} 'sudo service shiba start'

 

해당 워크플로우는 다음과 같은 단계를 수행한다.

 

1. 코드 체크아웃 - actions/checkout@v4 액션을 사용하여 저장소의 코드를 체크아웃한다.

2. JDK 17 설정 - actions/setup-java@v4 액션을 사용하여 JDK 17을 설정한다.

3. Gradle 설정 - gradle/actions/setup-gradle@v3 액션을 사용하여 Gradle을 설정한다.

4. Gradle 빌드 -./gradlew build 명령어를 실행하여 프로젝트를 빌드한다.

5. 배포 패키지 준비 - 빌드된 jar 파일을 deploy 디렉터리로 복사한다.

6. SSH 키 추가 - webfactory/ssh-agent@v0.9.0 액션을 사용하여 SSH 키를 추가한다.

7. GCP VM에 배포 - scp 명령어를 사용하여 jar 파일을 GCP VM 인스턴스로 복사하고, ssh 명령어를 사용하여 원격 서버에서 애플리케이션을 실행한다. (방화벽 22 포트가 반드시 열려있어야 한다.)

⛔️  브랜치 명이 main이 아닌 경우에는, 본인 리포지토리 환경에 맞는 브랜치로 수정해야 한다.

우분투 환경에서 스프링 부트 애플리케이션 서비스를 등록하는 방법은 다음 게시물을 참고한다.

 

Ubntu 환경에서 Spring Boot Application을 등록하기

 

작성 후에, 우측 상단에 커밋 버튼을 누르고 Actions 탭으로 들어가서 빌드가 수행되는지 확인해 본다.

 

빌드가 성공했다면 위 이미지처럼 초록색 빌드 체크 표시가 나온다.

5. 빌드 확인

이후 VM 서버에 접속해서 app 디렉터리에 접근하면 Secret으로 설정한 SNAPSHOT 파일이 존재하는 것을 확인할 수 있다.

 

netstat -tnlp 명령어를 수행해서 정상적으로 애플리케이션 포트가 떠있는지 확인해 보고, 애플리케이션 컨트롤러에 등록한 API를 호출해 보자.

📚 REFERENCE

https://github.com/webfactory/ssh-agent