스프링 부트 배포 스크립트 생성: 두 판 사이의 차이

기술노트
(컴퓨터 과학 용어 정리 - 스프링 부트 배포 스크립트 생성 추가)
 
편집 요약 없음
 
1번째 줄: 1번째 줄:
== [AWS] 스프링 부트 배포 스크립트 생성 ==
== [AWS] 스프링 부트 배포 스크립트 생성 ==


<br>
AWS에서 스프링 부트 프로젝트를 배포할 때는 프로젝트가 수정될 때마다 반복적인 작업을 수행해야 한다. 이를 자동화하여 배포 과정을 간소화할 수 있는 쉘 스크립트 작성 방법을 살펴보자.


<img src="https://img1.daumcdn.net/thumb/R1280x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FufFpw%2FbtrfolbIEVG%2F5U2LKUjUUKYKODQwmh7uf0%2Fimg.png">
=== 프로젝트 배포 과정 ===


<br>
배포 과정은 다음과 같은 단계로 진행된다.


AWS에서 프로젝트를 배포하는 과정은 프로젝트가 수정할 때마다 똑같은 일을 반복해야한다.
git pull로 프로젝트의 최신 소스를 가져온다.


===== 프로젝트 배포 과정 =====
Gradle을 이용해 프로젝트를 빌드한다.


* `git pull`로 프로젝트 업데이트
EC2 인스턴스 서버에서 프로젝트를 실행 및 배포한다.
* gradle 프로젝트 빌드
* ec2 인스턴스 서버에서 프로젝트 실행 및 배포


<br>
이 과정 전체를 자동화하는 배포 스크립트를 작성해보자.


이를 자동화 시킬 수 있다면 편리할 것이다. 따라서 배포에 필요한 쉘 스크립트를 생성해보자.
=== 배포 스크립트 작성 ===


`deploy.sh` 파일을 ec2 상에서 생성하여 아래와 같이 작성한다.
먼저 EC2 서버에 deploy.sh 파일을 생성한 후 아래의 내용을 입력한다.


<br>
<syntaxhighlight>sh
#!/bin/bash
#!/bin/bash


REPOSITORY=/home/ec2-user/app/{clone한 프로젝트 저장한 경로}
REPOSITORY=/home/ec2-user/app/{프로젝트가 clone된 경로}
PROJECT_NAME={프로젝트명}
PROJECT_NAME={프로젝트명}


cd $REPOSITORY/$PROJECT_NAME/
cd $REPOSITORY/$PROJECT_NAME/


echo "> Git Pull"
echo "> Git에서 최신 소스코드 Pull"
 
git pull
git pull


echo "> 프로젝트 Build 시작"
echo "> 프로젝트 빌드 시작"
 
./gradlew build
./gradlew build


echo "> step1 디렉토리로 이동"
echo "> 빌드 파일 복사를 위해 상위 디렉토리로 이동"
 
cd $REPOSITORY
cd $REPOSITORY


echo "> Build 파일 복사"
echo "> 생성된 JAR 파일 복사"
 
cp $REPOSITORY/$PROJECT_NAME/build/libs/*.jar $REPOSITORY/
cp $REPOSITORY/$PROJECT_NAME/build/libs/*.jar $REPOSITORY/


echo "> 현재 구동중인 애플리케이션 pid 확인"
echo "> 현재 실행 중인 애플리케이션 PID 확인"
 
CURRENT_PID=$(pgrep -f ${PROJECT_NAME}.*.jar)
CURRENT_PID=$(pgrep -f ${PROJECT_NAME}.*.jar)


echo "현재 구동 중인 애플리케이션 pid: $CURRENT_PID"
echo "현재 구동 중인 애플리케이션 PID: $CURRENT_PID"


if [ -z "$CURRENT_PID" ]; then
if [ -z "$CURRENT_PID" ]; then
        echo "> 현재 구동 중인 애플리케이션이 없으므로 종료하지 않습니다."
    echo "> 실행 중인 애플리케이션이 없습니다."
else
else
        echo "> kill -15 $CURRENT_PID"
    echo "> 기존 애플리케이션 종료 (PID: $CURRENT_PID)"
        kill -15 $CURRENT_PID
    kill -15 $CURRENT_PID
        sleep 5
    sleep 5
fi
fi


echo "> 새 애플리케이션 배포"
echo "> 새로운 애플리케이션 배포"
 
JAR_NAME=$(ls -tr $REPOSITORY/ | grep jar | tail -n 1)
JAR_NAME=$(ls -tr $REPOSITORY/ | grep jar | tail -n 1)
 
echo "> 배포할 JAR 파일: $JAR_NAME"
echo "> JAR Name: $JAR_NAME"
 
nohup java -jar \
      -Dspring.config.location=classpath:/application.properties,classpath:/application-real.properties,/home/ec2-user/app/application-oauth.properties,/home/ec2-user/app/application-real-db.properties \
      -Dspring.profiles.active=real \
      $REPOSITORY/$JAR_NAME 2>&1 &
</syntaxhighlight>
 
<br>
 
쉘 스크립트 내 경로명 같은 경우에는 사용자의 환경마다 다를 수 있으므로 확인 후 진행하도록 하자.
 
<br>
 
스크립트 순서대로 간단히 설명하면 아래와 같다.
 
<syntaxhighlight>sh
REPOSITORY=/home/ec2-user/app/{clone한 프로젝트 저장한 경로}
PROJECT_NAME={프로젝트명}
</syntaxhighlight>
 
자주 사용하는 프로젝트 명을 변수명으로 저장해둔 것이다.
 
`REPOSITORY`는 ec2 서버 내에서 본인이 git 프로젝트를 clone한 곳의 경로로 지정하며, `PROJECT_NAME`은 해당 프로젝트명을 입력하자.
 
<br>
 
<syntaxhighlight>SH
echo "> Git Pull"
 
git pull
 
echo "> 프로젝트 Build 시작"
 
./gradlew build
 
echo "> step1 디렉토리로 이동"
 
cd $REPOSITORY
 
echo "> Build 파일 복사"
 
cp $REPOSITORY/$PROJECT_NAME/build/libs/*.jar $REPOSITORY/
</syntaxhighlight>
 
<br>
 
현재 해당 경로는 clone한 곳이기 때문에 바로 `git pull`이 가능하다. 프로젝트의 변경사항을 ec2 인스턴스 서버 내의 코드에도 update를 시켜주기 위해 pull을 진행한다.
 
그 후 프로젝트 빌드를 진행한 뒤, 생성된 jar 파일을 현재 REPOSITORY 경로로 복사해서 가져오도록 설정했다.
 
<br>
 
<syntaxhighlight>sh
CURRENT_PID=$(pgrep -f ${PROJECT_NAME}.*.jar)
 
echo "현재 구동 중인 애플리케이션 pid: $CURRENT_PID"
 
if [ -z "$CURRENT_PID" ]; then
        echo "> 현재 구동 중인 애플리케이션이 없으므로 종료하지 않습니다."
else
        echo "> kill -15 $CURRENT_PID"
        kill -15 $CURRENT_PID
        sleep 5
fi
</syntaxhighlight>
 
<br>
 
기존에 수행 중인 프로젝트를 종료 후 재실행해야 되기 때문에 pid 값을 얻어내 kill 하는 과정을 진행한다.
 
현재 구동 중인 여부를 확인하기 위해서 `if else fi`로 체크하게 된다. 만약 존재하면 해당 pid 값에 해당하는 프로세스를 종료시킨다.
 
<br>
 
<syntaxhighlight>sh
echo "> JAR Name: $JAR_NAME"


nohup java -jar \
nohup java -jar \
      -Dspring.config.location=classpath:/application.properties,classpath:/application-real.properties,/home/ec2-user/app/application-oauth.properties,/home/ec2-user/app/application-real-db.properties \
    -Dspring.config.location=classpath:/application.properties,classpath:/application-real.properties,/home/ec2-user/app/application-oauth.properties,/home/ec2-user/app/application-real-db.properties \
      -Dspring.profiles.active=real \
    -Dspring.profiles.active=real \
      $REPOSITORY/$JAR_NAME 2>&1 &
    $REPOSITORY/$JAR_NAME 2>&1 &
</syntaxhighlight>


<br>
'''※ 주의사항:''' 사용자의 서버 환경에 따라 경로는 다를 수 있으므로 실제 환경에 맞게 수정해야 한다.


`nohup` 명령어는 터미널 종료 이후에도 애플리케이션이 계속 구동될 수 있도록 해준다. 따라서 이후에 ec2-user 터미널을 종료해도 현재 실행한 프로젝트 경로에 접속이 가능하다.
=== 스크립트 상세 설명 ===


`-Dspring.config.location`으로 처리된 부분은 우리가 git에 프로젝트를 올릴 때 보안상의 이유로 `.gitignore`로 제외시킨 파일들을 따로 등록하고, jar 내부에 존재하는 properties를 적용하기 위함이다.
REPOSITORY, PROJECT_NAME: 자주 변경될 수 있는 프로젝트 경로 및 이름을 변수로 설정하여 관리의 편의성을 높인다.


예제와 같이 `application-oauth.properties`, `application-real-db.properties`는 git으로 올라와 있지 않아 따로 ec2 서버에 사용자가 직접 생성한 외부 파일이므로, 절대경로를 통해 입력해줘야 한다.
git pull: 최신 소스코드를 EC2 인스턴스 서버로 업데이트한다.


<br>
./gradlew build: Gradle을 이용해 프로젝트를 빌드하고 실행 가능한 JAR 파일을 생성한다.


프로젝트의 수정사항이 생기면, EC2 인스턴스 서버에서 `deploy.sh`를 실행해주면, 차례대로 명령어가 실행되면서 수정된 사항을 배포할 수 있다.
생성된 JAR 파일을 EC2의 배포 경로로 복사하여 관리하기 쉽도록 구성한다.


<br>
현재 실행 중인 애플리케이션이 있는 경우, 이를 종료하고 새로운 애플리케이션을 배포한다.


<br>
nohup: 터미널 접속 종료 후에도 애플리케이션이 계속 실행될 수 있도록 유지한다.


===== [참고 사항] =====
-Dspring.config.location: 보안상의 이유로 git에 올리지 않은 외부 프로퍼티 파일의 위치를 절대 경로로 지정하여 사용한다.


* [링크](https://github.com/jojoldu/freelec-springboot2-webservice)
프로젝트의 변경 사항이 생기면 EC2 서버에서 이 deploy.sh 스크립트를 실행하면 자동으로 최신 버전으로의 배포가 이루어진다.

2025년 5월 5일 (월) 08:28 기준 최신판

[AWS] 스프링 부트 배포 스크립트 생성

AWS에서 스프링 부트 프로젝트를 배포할 때는 프로젝트가 수정될 때마다 반복적인 작업을 수행해야 한다. 이를 자동화하여 배포 과정을 간소화할 수 있는 쉘 스크립트 작성 방법을 살펴보자.

프로젝트 배포 과정

배포 과정은 다음과 같은 단계로 진행된다.

git pull로 프로젝트의 최신 소스를 가져온다.

Gradle을 이용해 프로젝트를 빌드한다.

EC2 인스턴스 서버에서 프로젝트를 실행 및 배포한다.

이 과정 전체를 자동화하는 배포 스크립트를 작성해보자.

배포 스크립트 작성

먼저 EC2 서버에 deploy.sh 파일을 생성한 후 아래의 내용을 입력한다.

  1. !/bin/bash

REPOSITORY=/home/ec2-user/app/{프로젝트가 clone된 경로} PROJECT_NAME={프로젝트명}

cd $REPOSITORY/$PROJECT_NAME/

echo "> Git에서 최신 소스코드 Pull" git pull

echo "> 프로젝트 빌드 시작" ./gradlew build

echo "> 빌드 파일 복사를 위해 상위 디렉토리로 이동" cd $REPOSITORY

echo "> 생성된 JAR 파일 복사" cp $REPOSITORY/$PROJECT_NAME/build/libs/*.jar $REPOSITORY/

echo "> 현재 실행 중인 애플리케이션 PID 확인" CURRENT_PID=$(pgrep -f ${PROJECT_NAME}.*.jar)

echo "현재 구동 중인 애플리케이션 PID: $CURRENT_PID"

if [ -z "$CURRENT_PID" ]; then 

   echo "> 실행 중인 애플리케이션이 없습니다."

else 

   echo "> 기존 애플리케이션 종료 (PID: $CURRENT_PID)"
   kill -15 $CURRENT_PID
   sleep 5

fi

echo "> 새로운 애플리케이션 배포" JAR_NAME=$(ls -tr $REPOSITORY/ | grep jar | tail -n 1) echo "> 배포할 JAR 파일: $JAR_NAME"

nohup java -jar \ 

    -Dspring.config.location=classpath:/application.properties,classpath:/application-real.properties,/home/ec2-user/app/application-oauth.properties,/home/ec2-user/app/application-real-db.properties \
    -Dspring.profiles.active=real \
    $REPOSITORY/$JAR_NAME 2>&1 &

※ 주의사항: 사용자의 서버 환경에 따라 경로는 다를 수 있으므로 실제 환경에 맞게 수정해야 한다.

스크립트 상세 설명

REPOSITORY, PROJECT_NAME: 자주 변경될 수 있는 프로젝트 경로 및 이름을 변수로 설정하여 관리의 편의성을 높인다.

git pull: 최신 소스코드를 EC2 인스턴스 서버로 업데이트한다.

./gradlew build: Gradle을 이용해 프로젝트를 빌드하고 실행 가능한 JAR 파일을 생성한다.

생성된 JAR 파일을 EC2의 배포 경로로 복사하여 관리하기 쉽도록 구성한다.

현재 실행 중인 애플리케이션이 있는 경우, 이를 종료하고 새로운 애플리케이션을 배포한다.

nohup: 터미널 접속 종료 후에도 애플리케이션이 계속 실행될 수 있도록 유지한다.

-Dspring.config.location: 보안상의 이유로 git에 올리지 않은 외부 프로퍼티 파일의 위치를 절대 경로로 지정하여 사용한다.

프로젝트의 변경 사항이 생기면 EC2 서버에서 이 deploy.sh 스크립트를 실행하면 자동으로 최신 버전으로의 배포가 이루어진다.

원본 주소 "https://technote.wiki/index.php?title=스프링_부트_배포_스크립트_생성&oldid=641"