[Jenkins] AWS 인스턴스를 젠킨스로 배포해보기 - 2편

🌱 들어가기 전

지난 포스팅은 젠킨스를 설치하고 필요한 플러그인을 설치하는 과정까지 진행하였다.

 

---

🌱 레파지토리 WebHook 등록하기

우리는 깃허브 레파지토리의 특정 브랜치에 push 이벤트가 발생하면 자동으로 배포가 일어나게 만들 것이기 때문에, 해당 push 이벤트에 대해서 감지할 수 있도록 'webhook'이라는 친구를 등록해야 한다.

 

등록하고 싶은 레파지토리의 Settings > Webhooks > Add webhook을 클릭한다.

이런 식으로 payload URL과 content-type을 지정해준다.

aws 인스턴스로 띄웠다면 publicIP:8081과 같은 형태가 위 URL에 들어갈 것이다.

⭐️ 여기서 제일 중요한 거, 끝에 꼭 /github-webhook/ 붙여줘야 한다... 이거 때문에 1시간 넘게 삽질했다.

 

성공적으로 웹훅을 등록했다면 아래와 같이 목록에 뜨게 된다.

 

---

🌱 깃허브 토큰 발급받기

젠킨스에서 깃허브에 대한 접근 권한을 받기 위해서는 깃허브에서 키를 발급받아 젠킨스에게 설정해줘야 한다.

깃허브 계정에 대한 settings에 들어가준다. 그리고 왼쪽에 있는 'Developer Settings'에 들어간다.

Personal access tokens > Tokens (classic) > Generate new token > Generate new token (classic)을 클릭한다.

그리고 Select Scopes에서 repo, admin:org, admin:repo_hook 3가지에 대한 권한을 준다.

간단하게 설명하면 레파지토리에 대한 권한, orgnaization에 대한 권한, 레파지토리 훅(웹훅 같은)에 대한 권한을 주는 것이다.

Generate token을 클릭하면 토큰 정보가 나올 텐데, 잊어버리지 않게 다른 곳에 복사해두자.

 

---

 

🌱 젠킨스와 깃허브 연동해주기 - 토큰 연동 

먼저, 위에서 발급받은 깃허브 토큰 정보를 젠킨스에 등록해주는 과정을 진행해야 한다.

깃허브 대시보드에서 Manage Jenkins > 아래쪽의 Credentials 클릭!

 

Stores Scope to Jenkin에서 Domains의 (globals) 클릭. (전역적으로 설정을 등록해줘야 함)

Add Credentials 클릭. (1편부터 따라했다면 원래 여기에 ssh 키도 있어야 하는데, 이전에 캡쳐한 자료를 가져오느라 이렇게 됐다... ㅎㅎ)

 

이후 Username with password 지정 후,  깃허브 아이디와 위에서 발급받은 token 정보, 그리고 id를 지정해준다.

최종적으로 이런 모습으로 등록이 완료되었을 것이다.

💡 여기서 secret-id는 지금 신경쓰지 않아도 된다. 바로 아래에서 진행할 예정이기 때문이다 ㅎㅎ

 

---

 

🌱 젠킨스와 깃허브 연동해주기 - 깃허브 서버 연동

다시 젠킨스 대시보드에서 Manage Jenkins > System을 클릭한다.

내리다 보면 GitHub라는 게 있을 텐데, Name 지정 후 Credentials 밑에 있는 Add > Jenkins를 클릭해준다.

 

그럼 이런 식으로 또 다시 Credential을 등록하는 과정이 있을 텐데, 여기서 위에서 발급받은 깃허브 token을 또 다시 넣어준다.

앞서 웹훅 등록시, 깃허브 측에서 POST 요청으로 우리의 젠킨스 서버에 요청을 보낸다고 했었는데, 여기서 인증 정보를 등록하는 과정이라고 보면 된다.

 Credentials에 위에서 지정한 id 값을 선택해주고, Test Connection이 성공하는지 확인한다.

 

---

 

🌱 젠킨스 잡 생성하기

다시 대시보드로 돌아와서, 이번에는 New Item을 클릭한다.

아이템 이름은 자유롭게 설정해주고, Pipeline을 선택한다.

Github project, Build Triggers > Github hook trigger for GITscm polling을 체크한다.

 

---

 

🌱 파이프라인 스크립트 작성하기

정말 마지막 단계이다. 파이프라인 스크립트를 작성해주면 된다.

 

우선, 현재 나의 EC2 저장소의 구조이다.

 

pipeline {
    agent any
    tools {
        gradle 'gradle'
    }
    stages {
        stage('Git Clone') {
            steps {
                git branch: '{branch_name}', credentialsId: 'secret-id-github', url: '{Git Repository URL}'
            }
        }
        stage('Build') {
            steps {
                sh "./gradlew clean build"
            }
        }
        stage('Deploy') {
            steps {
                sshagent(credentials: ['journey-shop-ec2']) {
                    sh '''
                        ssh -o StrictHostKeyChecking=no ${DEPLOY_HOST} uptime
                        scp build/libs/jwp-shopping-order.jar ${DEPLOY_HOST}:/home/ubuntu/jwp-shopping-order
                        ssh -t ${DEPLOY_HOST} /home/ubuntu/jwp-shopping-order/deploy.sh
                    '''
                }
            }
        }
    }
    environment {
        DEPLOY_HOST = '{EC2 접속 사용자 이름}@{EC2 private IP}'
    }
}

과정은 간단하다.

원하는 깃 레파지토리의 브랜치에서 clone을 한 다음, gradlew를 통해 빌드를 진행한다.

그리고 배포를 시작하는데, ssh agent를 사용한 덕분에 위와 같이 ssh 명령어를 사용할 수 있게 된다.

1. 원격 호스트에 대해서 SSH 연결 후 uptime을 통해 실행 시간 정보를 표시한다. 이때, 호스트의 공개 키를 검사하지 않고 SSH 연결을 진행한다.
2. 위에서 빌드된 build/libs/jwp-shopping-order.jar 파일을 지정한 경로로 복사한다.
3. ssh 연결 후 deploy.sh 스크립트를 실행한다. (배포)

⭐️ 이때, 원격 호스트 정보는 이미 젠킨스 자체가 EC2 위에 띄워져 있기 때문에 private IP로 접속해야 한다.

 

나의 경우 쉘 스크립트는 다음과 같이 작성하였다.

#!/bin/bash
REPOSITORY=/home/ubuntu/jwp-shopping-order
PROJECT_NAME=jwp-shopping-order
cd $REPOSITORY/$PROJECT_NAME/
echo "> 현재 구동중인 애플리케이션 pid 확인"
CURRENT_PID=$(sudo lsof -i tcp:8080 | awk 'NR!=1 {print$2}')
echo "현재 구동중인 애플리케이션pid: $CURRENT_PID"
if [ -z "$CURRENT_PID" ]; then
    echo "> 현재 구동중인 애플리케이션이 없으므로 종료하지 않습니다."
else
    echo "> kill -9 $CURRENT_PID"
    sudo kill -9 $CURRENT_PID
    sleep 5
fi
echo "> 새 애플리케이션 배포"
JAR_NAME=$(ls -tr $REPOSITORY/*.jar | tail -n 1)
echo "> JAR Name: $JAR_NAME"
rm -rf $REPOSITORY/deploy.log $REPOSITORY/deploy-err.log
nohup sudo java -jar $JAR_NAME --spring.profiles.active=prod --spring.config.location=$REPOSITORY/application.yml >> $REPOSITORY/deploy.log 2> $REPOSITORY/deploy-err.log &

그냥 이동하고, 8080으로 띄워진 애플리케이션 확인 후 기존에 돌아가는 것은 제거한다.

새롭게 빌드하면 기존의 로그 파일은 제거한 다음, cp로 인해 복사된 파일을 java-jar를 통해서 실행해준다 ㅎㅎ

config 정보의 경우 외부로 노출시키지 않기 위해서 인스턴스 내부에 저장해두고 사용하고 있다 😊

 

아래는 젠킨스 사용 전 스크립트 파일인데, 혹시 도움이 될 수도 있으니 첨부해두겠다.

#!/bin/bash
REPOSITORY=/home/ubuntu/jwp-shopping-order
PROJECT_NAME=jwp-shopping-order
cd $REPOSITORY/$PROJECT_NAME/
echo "> Git Pull"
git pull origin step1
echo "> 현재 구동중인 애플리케이션 pid 확인"
CURRENT_PID=$(sudo lsof -i tcp:8080 | awk 'NR!=1 {print$2}')
echo "현재 구동중인 애플리케이션pid: $CURRENT_PID"
if [ -z "$CURRENT_PID" ]; then
    echo "> 현재 구동중인 애플리케이션이 없으므로 종료하지 않습니다."
else
    echo "> kill -9 $CURRENT_PID"
    sudo kill -9 $CURRENT_PID
    sleep 5
fi
echo "> 프로젝트 Build 시작"
./gradlew build -x test
echo "> Build 파일 복사"
cp $REPOSITORY/$PROJECT_NAME/build/libs/*.jar $REPOSITORY/
echo "> 새 애플리케이션 배포"
JAR_NAME=$(ls -tr $REPOSITORY/*.jar | tail -n 1)
echo "> JAR Name: $JAR_NAME"
rm -rf $REPOSITORY/deploy.log $REPOSITORY/deploy-err.log
nohup sudo java -jar --Dspring.profiles.active=prod $JAR_NAME --spring.config.location=$REPOSITORY/application.yml >> $REPOSITORY/deploy.log 2> $REPOSITORY/deploy-err.log &

 

최종적으로 브랜치에 push 이벤트가 발생하게 되면, 젠킨스 파이프라인이 돌면서 위의 스크립트를 실행하여 배포에 성공하게 된다!!

 

---

너무 감격이다... 🥹

많은 도움을 준 베베에게 다시 한 번 감사 인사 올립니다...

🙇‍♀️