[배포 및 인프라] 해보자 배포 [3] - 쉘 스크립트를 통한 배포 자동화

 

 

이전 글에서는 EC2 서버에서 직접 깃허브 프로젝트를 clone받고 직접 실행해 보았는데요, 사실 이러한 방법을 통해서 배포를 진행한다면 여러 귀찮은 상황이 발생할 것입니다.

 

새로운 기능을 개발해서 레포지토리에 커밋을 했다고 생각해 보겠습니다.

우선 EC2 인스턴스에 접근하여 변경된 사항을 PULL 받아야 합니다.

PULL 을 받은 이후에는 이를 빌드하고, 기존에 실행중인 애플리케이션을 종료시키고, 새롭게 애플리케이션을 다시 띄워야 합니다.

 

즉 기능의 개발이 이루어질 때 마다 해야 하는 귀찮은 반복 작업들이 너무 많습니다.

 

그래서 이러한 반복 작업을 쉘 스크립트를 통해서 자동화 해보도록 하겠습니다.

 

 

 

 

 

 

 

🧐 어떠한 순서로 배포가 이루어질까?

쉘 스크립트를 작성하기 전에, 우선 배포가 어떠한 순서로 이루어질지 생각해 보아야 합니다.

 

저는 다음과 같은 순서로 배포를 진행할 것 같습니다.

1. 프로젝트를 위치시킬 특정한 경로를 지정합니다.
2. 해당 경로로 이동합니다.
3. git pull 명령어를 통해 최신 파일을 가져옵니다.
4. gradle로 빌드를 실행합니다.
5. 이미 애플리케이션이 실행중이라면 이를 종료합니다.
6. 애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.
7. 애플리케이션을 실행합니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 단계별로 스크립트 작성하기

우선 쉘 스크립트 파일을 생성해 보도록 하겠습니다.

touch [쉘 스크립트 이름]

예시는 아래와 같습니다.

touch bapo.sh

(bapo-test는 이전 글에서 애플리케이션을 띄울 때 생성되었으므로 무시하시고 넘어가시면 됩니다.)

(제거해 주셔도 상관없습니다!)

 

 

 

 

 

 

 

 

 

 

 

 

🌱 1. 프로젝트를 위치시킬 특정한 경로를 지정합니다.

특정한 경로를 지정하고, 해당 경로를 생성하는 것은 최초 한번만 진행하면 되기 때문에 쉘 스크립트에는 작성하지 않도록 하겠습니다.

 

저희가 띄운 EC2 서버에서 홈 디렉토리의 경로를 확인해 보도록 하겠습니다.

pwd 명령어를 사용하여 확인했고, /home/ubuntu네요.

 

 

 

 

프로젝트를 위치시킬 경로는 마음대로 지정해주시면 되지만, 저는 다음과 같은 경로에 위치시키도록 하겠습니다.

/home/ubuntu/mallang-projects/{프로젝트 이름}

홈 디렉토리인 /home/ubuntu/는 기본적으로 존재하지만, 제가 임의로 지정한 mallang-projects라는 디렉토리는 아직 존재하지 않습니다.

 

 

 

mkdir 명령어를 통해서 이를 생성해 주도록 하겠습니다.

mkdir [디렉토리 이름]

mkdir mallang-projects

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🌱 2. 해당 경로로 이동합니다.

이제부터 쉘 스크립트에 작성을 해보도록 하겠습니다.

 

cd 명령어를 통해서 /home/ubuntu/mallang-projects/ 디렉토리로 이동해 주겠습니다.

cd [이동할 경로]

cd /home/ubuntu/mallang-projects/

이를 쉘 스크립트로 작성해 보도록 하겠습니다.

 

 

 

 

⚙️ bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects

echo "\n 🐳   [$PROJECT_PATH] 경로로 이동합니다.\n"

cd $PROJECT_PATH

 

 

./bapo.sh 를 통해 한번 실행해 볼까요?

오류가 나는 것을 확인할 수 있습니다.

 

 

다음 명령어를 통해 bapo.sh를 실행시킬 권한을 줄 수 있습니다.

chmod +x ./bapo.sh

 

 

이후 다시 ./bapo.sh를 통해 스크립트를 실행해 보겠습니다.

이동했는지 확인할순 없지만, 일단 예외는 없으니 넘어가겠습니다.

(사실 성공한거 맞습니다.)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🌱 3. git pull 명령어를 통해 최신 파일을 가져옵니다.

방금 디렉토리를 처음 생성했기 때문에, mallang-project 디렉토리 내부에는 아직 프로젝트가 없습니다.

레포지로리를 clone하는 과정은 서버를 만들고 최초 1회만 필요하기 때문에, 이 역시도 스크립트에는 따로 적어주지 않고 수동으로 진행하겠습니다.

git clone [레포지토리 주소]

https://github.com/shin-mallang/bapo-test.git

 

 

 

(인증이 필요하다면 이전 글에서 만든 토큰을 사용하면 됩니다. 만약 토큰을 잊어먹으셨다면 다시 만들어주세요!)

이제 레포지토리가 존재하므로, 앞으로는 git pull로 최신 버전의 파일만을 가져오면 됩니다.

이를 쉘 스크립트를 통해 작성해보도록 하겠습니다.

 

 

 

 

⚙️ bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test


echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

작성된 쉘 스크립트는 다음과 같으며, 위에서부터 추가된 부분을 확인하도록 하겠습니다.

 

 

PROJECT_NAME=bapo-test

프로젝트의 이름인 bapo-test를 변수로 추출했습니다.

 

 

 

 

echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

기존에는 $PROJECT_PATH로만 이동했지만, 프로젝트들이 존재하는 디렉토리에서 배포할 특정 프로젝트 디렉토리로 이동해야 하므로 추가적으로 작성해 주었습니다.

 

 

 

 

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

git pull을 통해 깃허브 레포지토리의 변경사항을 받아옵니다.

 

 

 

 

 

 

이를 한번 실행해볼까요?

저만 그런지는 모르겠지만, 자꾸 로그인 하라고 하니 화나서 로그인 안하게 설정좀 하도록 하겠습니다.

(아마 public repository라면 이런 과정이 필요 없을거예요)

 

 

해결방법은 간단합니다. 다음 명령어를 입력해주세요.

git config --global credential.helper store

위와 같이 명령어를 입력하고, 한번만 더 인증을 진행하면 더이상 인증을 진행하지 않아도 됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🌱 4. gradle로 빌드를 실행합니다.

이제 빌드를 실행해 보도록 하겠습니다.

./gradlew clean build

gradlew는 gradle이 설치되지 않은 환경에서도 실행할 수 있도록 해주는 무언가..? 입니다.

(관련 링크 - Gradle Wrapper)

 

clean build를 통해 기존에 build 과정에서 생긴 파일들을 모두 제거하고, 새롭게 build를 진행하도록 해줍니다.

 

 

쉘 스크립트에도 그래도 작성해주면 됩니다.

 

⚙️ bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test


echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

 

작성된 쉘 스크립트는 위와 같습니다.

 

 

 

 

 

한번 실행해볼까요?

잘 실행되는 것을 알 수 있습니다.

 

 

 

 

/build/libs 내부로 들어가면 생성된 jar 파일을 확인할 수 있습니다.

(전체 경로는 /home/ubuntu/mallang-projects/bapo-test/build/libs 입니다.)

 

 

 

 

 

 

 

 

 

 

 

 

 

🌱 5. 이미 애플리케이션이 실행중이라면 이를 종료합니다.

이전 글의 마지막에 애플리케이션을 종료하는 방법을 살펴보았습니다.

 

포트번호 8080를 사용하는 프로세스를 종료하기 위한 명령어는 아래와 같았습니다.

lsof -i :8080 -t | xargs kill -15

 

이를 항상 모두 실행하는 것이 아니라, 8080 포트를 사용중인 애플리케이션이 있을때만 이를 지울 수 있도록 스크립트를 작성하도록 하겠습니다.

 

 

 

⚙️ bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test
PORT=8080

echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

if [ -z $PID ]; then
	echo " 🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
	echo " ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
	kill -15 $PID
fi

 

새로 작성된 부분을 살펴보겠습니다.

 

 

 

 

 

PORT=8080

애플리케이션의 포트번호를 변수로 추출하였습니다.

 

 

 

 

 

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

특정 포트번호(8080)를 사용하는 프로세스의 PID를 찾아 PID 변수에 저장합니다.

 

 

 

 

 

 

if [ -z $PID ]; then
	echo "  🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
	echo "  ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
	kill -15 $PID
fi

[ -z $PID ]는 PID 변수가 비어있는지 아닌지를 확인하는 구문입니다.

 

즉 8080 포트를 사용하는 PID 가 없다면 이는 true가 될 것이고, 있다면 false가 될 것입니다.

 

만약 8080 포트를 사용하는 PID가 있다면 이를 종료해야 하므로 kill -15 를 통해서 안전하게 종료시킵니다.

 

 

 

 

 

실행 결과는 다음과 같습니다.

 

(실행 중인 애플리케이션이 없을 때)

 

 

 

 

(실행 중인 애플리케이션이 있을 때)

 

 

 

 

 

 

 

 

 

 

 

 

 

🌱 6. 애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.

코드에서 환경변수를 필요로 하는 상황을 가정하기 위해, 프로젝트에 다음과 같은 파일들을 추가하겠습니다.

 

 

⚙️ application.yml

my-env:
  first: ${FIRST_MALLANG_ENV}
  second: ${SECOND_MALLANG_ENV}

 

 

 

 

⚙️ HelloController

@RestController
public class HelloController {

    @Value("${my-env.first}")
    private String first;

    @Value("${my-env.second}")
    private Integer second;

    @GetMapping("/hello")
    String ping() {
        return String.format(
                "안녕! 설정된 정보는 FIRST = [%s], SECOND= [%d] !",
                first,
                second);
    }
}

 

해당 코드를 추가하고 repository에 push 합니다.

 

 

 

이제 EC2로 돌아가서 FIRST_MALLANG_ENV와 SECOND_MALLANG_ENV 환경변수를 세팅해서 애플리케이션을 실행할 수 있도록 해주겠습니다.

 

리눅스에서 환경변수를 설정하는 방법은 다음과 같습니다.

export 환경변수명=값

export FIRST_MALLANG_ENV="mallang1"
export SECOND_MALLANG_ENV=1234

 

 

이를 쉘 스크립트에 작성하면 다음과 같습니다.

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test
PORT=8080

echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

if [ -z $PID ]; then
	echo " 🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
	echo " ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
	kill -15 $PID
fi

echo " 🐳   애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.\n"

export FIRST_MALLANG_ENV="mallang1"
export SECOND_MALLANG_ENV=1234

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🌱 7. 애플리케이션을 실행합니다.

이제 애플리케이션을 실행하도록 하겠습니다.

실행하는 방법은 간단합니다.

nohup java -jar [jar파일 이름(경로 포함)].jar &

nohup java -jar /home/ubuntu/mallang-projects/bapo-test/build/libs/jwp-shopping-order.jar &

 

이때 jar 파일에 대해서 조금 더 분해해서 확인해 보도록 하겠습니다.

 

 

 

/home/ubuntu/mallang-projects/bapo-test/build/libs/jwp-shopping-order.jar

- /home/ubuntu/mallang-projects : PROJECT_PATH로 설정했습니다.
- bapo-test : PROJECT_NAME으로 설정했습니다.
- build/libs : 빌드 후 JAR 파일이 생성되는 경로입니다.
- jwp-shopping-order.jar : JAR 파일의 이름입니다.

이들을 반영해서 쉘 스크립트를 작성하겠습니다.

 

 

 

 

 

 

 

⚙️ bapo.sh

#!/bin/sh

PROJECT_PATH=/home/ubuntu/mallang-projects
PROJECT_NAME=bapo-test
PORT=8080
BUILD_PATH=build/libs
JAR_NAME=jwp-shopping-order.jar


echo "\n 🐳   [$PROJECT_PATH/$PROJECT_NAME] 경로로 이동합니다.\n"

cd $PROJECT_PATH/$PROJECT_NAME

echo " 🐳   최신 코드를 PULL 합니다!\n"

git pull

echo " 🐳   프로젝트를 새롭게 빌드합니다.\n"

./gradlew clean build

echo " 🐳   [$PORT] 번 포트를 사용하는 애플리케이션을 찾습니다...\n"

PID=$(lsof -i :$PORT -t)

if [ -z $PID ]; then
	echo " 🎉   실행중인 애플리케이션이 없어서 곧바로 실행합니다.\n"

else
	echo " ❌   실행중인 애플리케이션이 있어서 이를 종료합니다. [PID = $PID]\n"
	kill -15 $PID
fi

echo " 🐳   애플리케이션을 실행하는데 필요한 환경변수를 세팅합니다.\n"

export FIRST_MALLANG_ENV="mallang1"
export SECOND_MALLANG_ENV=1234

echo " 🎉   애플리케이션 실행합니다~ 🎉\n"

nohup java -jar $PROJECT_PATH/$PROJECT_NAME/$BUILD_PATH/$JAR_NAME &

 

추가된 부분은 다음과 같습니다.

 

 

 

 

 

 

BUILD_PATH=build/libs
JAR_NAME=jwp-shopping-order.jar

빌드시 생긴 JAR 파일의 경로와, 생성될 JAR 파일의 이름을 변수로 추출하였습니다.

 

 

 

 

echo " 🎉   애플리케이션 실행합니다~ 🎉\n"

nohup java -jar $PROJECT_PATH/$PROJECT_NAME/$BUILD_PATH/$JAR_NAME &

빌드된 JAR 파일을 실행하는 코드입니다.

 

 

 

 

실행 결과는 다음과 같습니다.

 

 

 

 

 

 

 

환경변수가 잘 세팅되었는지도 확인하겠습니다.

잘 설정된 것을 볼 수 있습니다.

 

 

 

 

 

 

 

 

 

🧐 마무리

이렇게 해서 쉘 스크립트를 통해서 수동으로 배포하는 작업을 자동으로 처리되도록 만들었습니다.

이전에 비해 많이 편해진 것 같지만, 새로운 기능이 개발될 때 마다 이를 반영하기 위해서 EC2에 들어와서 코드를 실행하는 것조차 귀찮을 수 있습니다.

 

그래서 조만간, 메인 브랜치에 코드가 머지되는 순간 이러한 배포 프로세스가 자동으로 실행되도록 CI/CD 를 적용해 보도록 하겠습니다.

 

(다음 포스팅에서 바로는 아니고, MYSQL 연결 & git submodule 적용 이후에 진행할 예정입니다.)