무중단 배포 적용하기 (SpringBoot, Docker, Nginx, GithubAction)

무중단 배포란?

무중단 배포는 사용자에게 서비스 중단 없이 새로운 버전의 소프트웨어를 배포하는 방법입니다.

 

서비스를 운영 중일 때 새로운 버전을 배포하기 위해서는 

1. 기존 서비스를 종료 

2. 새로운 서비스 시작 

 

두개의 프로세스를 지나쳐야 한다. 

 

이렇게 되면 1번과 2번 사이의 과정에서 다운타임이 필연적으로 발생하며, 다운타임 동안 사용자들은 서비스를 이용할 수 없다. 이 다운타임을 해결해주는 방법이 바로 무중단 배포이다. 즉, 말그대로 중단이 없는 배포를 무중단 배포이다.

 

다운타임
시스템을 이용할 수 없는 시간.

 

 

 

무중단 배포 구현 방식에는 여러가지 기술이 존재한다.

- AWS에서 Blue-Greem 무중단 배포

- 도커를 이용한 무중단 배포

- L4, L7 스위치를 이용한 무중단 배포

- Nginx를 이용한 무중단 배포

 

나는 Nginx를 이용하여 무중단 배포를 진행하였고, 배포 전략으론 Blue/Green 을 사용하였다. 

 

 

 

무중단 배포 과정

1. 리버스 프록시로 nginx의 80포트를 스프링 앱으로 연결시켜줄 것이다. 초기에는 8080포트를 바라보고 있다고 가정한다.

2. 스프링 앱은 8080포트 또는 8081포트로 배포할 것이다.

3. 만약 스프링 A(8080)로 배포 중 이었다면, 스프링 B(8081)를 새로 실행한다.

4. 스프링 B가 정상적으로 다 실행되면, nginx가 8081포트를 바라보도록 하고, nginx를 재시작한다.

5. 구동 중이었던 스프링 A(8080)는 종료한다.

6. 만약 스프링 B(8081)로 배포 중 이었다면, 스프링 A(8080)를 새로 실행한다.

7. 스프링 A가 정상적으로 다 실행되면, nginx가 8080포트를 바라보도록 하고, nginx를 재시작한다.

8. 구동 중이었던 스프링 B(8081)는 종료한다.

 

 

 

먼저, 스프링 부트가 잘 실행되었는지 확인하기 위해 다음 dependency를 추가해주었다. 

implementation 'org.springframework.boot:spring-boot-starter-actuator'

 

 

actuaor 는 스프링 부트가 제공하는 기능으로 지표 수집, 추적, 감사 등의 모니터링을 쉽게 할 수 있는 다양한 편의 기능을 제공한다. 

# application.yml
management:
  endpoint:
  endpoints:
    web:
      base-path: /tickerbell

 

위와 같이 application.yml에 설정해주어 /tickerBell/health 로 접속할 시 서버가 켜져있는지 꺼져있는지 응답을 받도록 하였다. 

 

 

응답은 아래와 같이 나온다. 

{"status":"UP"}

 

 

 

이제 nginx 설정을 해보자.

# /etc/nginx/sites-available/tickerBell.conf

server {
        include /etc/nginx/conf.d/service-url.inc;
        server_name tickerBell;
        charset utf-8;

        location / {
                proxy_pass $service_url;
                proxy_set_header X-Real-Ip $remote_addr;
                proxy_set_header x-Forwarded-For $proxy_add_x_forwarded_for;
                proxy_set_header Host $host;
        }
}

 

서버 블록 내에 include /etc/nginx/conf.d/service-url.inc; 라는 코드가 있는데,

service-url.inc는 구동 중인 스프링 앱의 url을 기입해둔 파일이다. 

해당 파일을 include하면, 그 파일에 작성된 변수를 이용할 수 있다. 

proxy_pass $service_url; 에서 service_url은 service-url.inc 에 설정한 변수 값이다.

  

 

service-url.inc

# /etc/nginx/conf.d/service-url.inc

set $service_url http://127.0.0.1:8080;

 

 

 

여기까지 되었으면, ln -s 로 tickerBell.conf의 심볼릭링크를 sites-enabled에 등록해주고 nginx를 시작해준다.

# ln -s 원본파일 경로/디렉토리 심볼릭링크이름

sudo ln -s /etc/nginx/sites-available/tickerBell.conf /etc/nginx/sites-enabled/
sudo service nginx restart

 

 

 

spring boot 프로젝트의 루트경로에 Dockerfile을 작성해주었다. 

FROM openjdk:17-jdk-alpine

# JAR_FILE 변수 정의 -> 기본적으로 jar file이 2개이기 때문에 이름을 특정해야함
ARG JAR_FILE=./build/libs/tickerBell-0.0.1-SNAPSHOT.jar

# JAR 파일 메인 디렉토리에 복사
COPY ${JAR_FILE} app.jar

# 시스템 진입점 정의
ENTRYPOINT ["java","-Duser.timezone=Asia/Seoul","-Dspring.profiles.active=prod", "-jar","/app.jar"]

 

 

 

docker-compose 파일을 두 개 작성해준다. 

 

- docker-compose.a.yml

version: "3.8"
services:
  tickerbell-a:
    container_name: tickerbell-a
    image: ${DOCKERHUB_USERNAME}/tickerbell
    volumes: ...
    environment: ...
    ports:
      - "8081:8080"
    restart: always

networks:
  default:
    external:
      name: tickerbellnet

 

- docker-compose.b.yml

version: "3.8"
services:
  tickerbell-b:
    container_name: tickerbell-b
    image: ${DOCKERHUB_USERNAME}/tickerbell
    volumes: ...
    environment: ...
    ports:
      - "8081:8080"
    restart: always

networks:
  default:
    external:
      name: tickerbellnet

 

두 개의 docker-compose 파일은 port 말고는 전부 동일하다.

 

 

참고) 

기존엔 docker compose를 통해 redis 와 spring 컨테이너를 띄웠는데 redis는 굳이 다시 띄울 필요가 없기 때문에 docker compose에서 빼고 ec2에 바로 띄웠다. 

하지만 컨테이너끼리 통신하기 위해선 같은 네트워크에 있어야 한다. 

docker-compose를 사용하여 띄운 여러 개의 컨테이너는 기본적으로 같은 네트워크에 묶여 있기 때문에 따로 network를 지정해주지 않아도 되지만, 나같은 경우엔 redis를 먼저 ec2에 띄워두었기 때문에 network를 지정해주어야 한다. tickerbellnet 으로 네트워크를 생성해주었고 redis와 docker-compose에서 띄우는 스프링이 같은 network를 사용하도록 해주었다. 

 

 

이제 배포를 위한 스크립트 파일 deploy.sh를 작성해주었다. 

코드에 대한 설명은 주석에 달아두었다.

RUNNING_CONTAINER=$(sudo docker ps)
echo "실행중인 컨테이너 목록: ${RUNNING_CONTAINER}"

# 실행 중인 도커 컴포즈 확인
EXIST_A=$(sudo docker ps -q -f name=tickerbell-a)

echo "EXIST_A 값: ${EXIST_A}"

if [ -z "${EXIST_A}" ] # -z는 문자열 길이가 0이면 true. A가 실행 중이지 않다는 의미.
then
        # B가 실행 중인 경우
        START_CONTAINER=a
        TERMINATE_CONTAINER=b
        START_PORT=8080
        TERMINATE_PORT=8081
else
        # A가 실행 중인 경우
        START_CONTAINER=b
        TERMINATE_CONTAINER=a
        START_PORT=8081
        TERMINATE_PORT=8080
fi

echo "tickerbell-${START_CONTAINER} up"

# 실행해야하는 컨테이너 docker-compose로 실행. -p는 docker-compose 프로젝트에 이름을 부여
# -f는 docker-compose파일 경로를 지정
sudo docker-compose -f docker-compose.${START_CONTAINER}.yml up -d --build

RUNNING_CONTAINER=$(sudo docker ps)
echo "실행중인 컨테이너 목록: ${RUNNING_CONTAINER}"

for cnt in {1..10} # 10번 실행
do
        echo "check server start.."

        # 스프링부트에 등록했던 actuator로 실행되었는지 확인
        UP=$(curl -s http://127.0.0.1:${START_PORT}/tickerBell/health | grep 'UP')
        if [ -z "${UP}" ] # 실행되었다면 break
        then
                echo "server not start.."
        else
                break
        fi

        echo "wait 10 seconds" # 10 초간 대기
        sleep 10
done

if [ $cnt -eq 10 ] # 10번동안 실행이 안되었으면 배포 실패, 강제 종료
then
        echo "deployment failed."
        exit 1
fi

echo "server start!"
echo "change nginx server port"

# sed 명령어를 이용해서 아까 지정해줬던 service-url.inc의 url값을 변경해줍니다.
# sed -i "s/기존문자열/변경할문자열" 파일경로 입니다.
# 종료되는 포트를 새로 시작되는 포트로 값을 변경해줍니다.
sudo sed -i "s/${TERMINATE_PORT}/${START_PORT}/" /etc/nginx/conf.d/service-url.inc

# 새로운 포트로 스프링부트가 구동 되고, nginx의 포트를 변경해주었다면, nginx 재시작해줍니다.
echo "nginx reload.."
sudo service nginx reload

# 기존에 실행 중이었던 docker-compose는 종료시켜줍니다.
echo "tickerbell-${TERMINATE_CONTAINER} down"
sudo docker-compose -f docker-compose.${TERMINATE_CONTAINER}.yml down
echo "success deployment"

 

 

작성한 deploy.sh 파일을 실행하기 위해 github action deploy.yml 파일에 아래와 같이 작성해주었다. (관련된 일부 코드임)

  cd-pipeline:
    needs: build-docker-image
    runs-on: ubuntu-latest
    steps:
      # docker-compose.a.yml 파일을 ec2 /home/ubuntu 에 scp
      - uses: actions/checkout@master
      - name: copy docker-compose.a.yml to remote server
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ubuntu
          key: ${{ secrets.SSH_KEY }}
          port: 22
          source: "./docker-compose.a.yml"
          target: "/home/ubuntu/"

      # docker-compose.b.yml 파일을 ec2 /home/ubuntu 에 scp
      - uses: actions/checkout@master
      - name: copy docker-compose.b.yml to remote server
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ubuntu
          key: ${{ secrets.SSH_KEY }}
          port: 22
          source: "./docker-compose.b.yml"
          target: "/home/ubuntu/"

      - name: copy deploy.sh to remote server
        uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ubuntu
          key: ${{ secrets.SSH_KEY }}
          port: 22
          source: "./deploy.sh"
          target: "/home/ubuntu/"

      - name: Execute deploy.sh script remotely
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SSH_HOST }}
          username: ubuntu
          key: ${{ secrets.SSH_KEY }}
          port: 22
          script: |
            chmod +x /home/ubuntu/deploy.sh
            /home/ubuntu/deploy.sh

 

 

위에서 설명한 무중단 배포 과정 처럼 기존에 스프링B 가 구동중이었기에 스프링A가 새로 띄워졌고,

스프링A의 서버가 완전히 켜진 후 스프링B는 종료되는 모습을 볼 수 있다.