[Shell Script] 서버 재부팅 시 Docker 안에 특정 Deamon 자동 기동되게 만들기

 

 

 

리눅스 커맨드라인 쉘 스크립트 바이블

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

 

 

🚀 Docker 안의 Deamon 자동 기동되게 만들기

    🔽 개요

        📦 소개

주니는 이미 만들어져 있는 Docker Container Image 중 예전에 포스팅했던 gitea가 Host 서버가 재부팅 되거나 하면 Container는 잘 올라오는데, 내부 gitea daemon이 자동으로 올라오지 않아 수 작업으로 기동해줘야 하는 문제점을 만나게 되었어요.

[Synology NAS] 나만의 GitHub 만들기 - Git Server와 Gitea 설치

오늘도 역시나! 컴퓨터를 장난감으로 다루는 주니 답게 이러한 불편함을 어떻게 해결할 수 있을까?를 고민하다가 여러가지 방법을 시도를 해봤었어요.

일단 생각해낸 것은 gitea Container 내부에서 아래 글에서 정리했던 방법을 통해 쉘 스크립트를 만들고,

[Shell Script] 쉘 스크립트를 이용하여 특정 프로세스 상태 확인 뒤 자동 기동 시키기

아래 글에서 정리한 systemd를 이용해서 자동화를 해보려 했었어요.

[Shell Script] Bash Shell Script를 이용한 Docker 자동 기동

하지만 이 방법이 되었다면 이미 systemctl enable gitea로 문제를 해결할 수 있었겠지만, 이미 등록 되어 있음에도 불구하고, 문제가 발생해서 Host Server에서 처리하는 방법을 고민하다가 성공하여 정리하는 글 입니다.

    🔽 Shell Script

        📦 만들기

#!/bin/bash

# 명령어 실패 시 바로 스크립트를 나가기 위한 명령어
set -e

NOW=$(date +"%y-%m-%d %T")
DATE=$(date +%Y%m%d%H%M)

LOG_DIR="/var/log/docker/gitea/run"

echo "======================================[$NOW] Gitea Container 재 기동 스크립트 동작======================================" >> $LOG_DIR/$DATE-container-run.log 2>&1
echo "@Author(만든이): 주니(junyharang8592@gmail.com)" >> $LOG_DIR/$DATE-container-run.log 2>&1

if [ -d "$LOG_DIR" ];
then
         echo "[$NOW] Directory가 존재 합니다" >> $LOG_DIR/$DATE-container-run.log 2>&1
 else
         mkdir -p $LOG_DIR

         if [ $? != 0 ];
         then
                 echo "[$NOW] Log 저장을 위한 Directory 만들기 실패 하였습니다."
                 exit 1
         else
                 echo "[$NOW] Directory가 존재 하지 않아 생성 하였습니다." >> $LOG_DIR/$DATE-container-run.log 2>&1
         fi
fi

echo "[$NOW] gitea Docker Container 기동 여부 상태 및 자동 기동 작업을 시작할게요." >> $LOG_DIR/$DATE-container-run.log 2>&1
echo "[$NOW] 첫번째 작업. gitea Container가 존재 확인 할게요." >> $LOG_DIR/$DATE-container-run.log 2>&1

CONTAINER_NAME="junyss-gitea"
container_existence_status=$(docker ps --filter "name=$container_name")

check_container_existence_status() {
        sleep 5

        echo "[$NOW] gitea container 존재 여부 :" >> $LOG_DIR/$DATE-container-run.log 2>&1
        echo "$container_existence_status" >> $LOG_DIR/$DATE-container-run.log 2>&1

        check_container_info=$(docker ps --format '{{.Names}}' | grep "^${CONTAINER_NAME}\$")

        if [ ! -z "$check_container_info" ];
        then
                echo "[$NOW] gitea container가 정상 작동 중 입니다." >> $LOG_DIR/$DATE-container-run.log 2>&1
                echo "[$NOW] gitea container에 gitea Deamon 기동 작업을 시작합니다." >> $LOG_DIR/$DATE-container-run.log 2>&1

                send_deamon_up_commnad
        else
                echo "[$NOW] gitea container가 정상 실행되지 않았거나, 존재 하지 않아요." >> $LOG_DIR/$DATE-container-run.log 2>&1
                echo "[$NOW] gitea container 기동을 시도할게요." >> $LOG_DIR/$DATE-container-run.log 2>&1

                start_container
        fi
}

start_container() {
        echo "[$NOW] gitea container 기동 작업 시작 합니다." >> $LOG_DIR/$DATE-container-run.log 2>&1

        docker restart $CONTAINER_NAME

        if [ $? != 0 ];
        then
                echo "[$NOW] gitea container 기동 작업 실패하였어요." >> $LOG_DIR/$DATE-container-run.log 2>&1
                exit 1
        else

                echo "[$NOW] gitea container 기동 작업 성공 하였어요." >> $LOG_DIR/$DATE-container-run.log 2>&1
                echo "[$NOW] gitea container 존재 여부를 다시 확인할게요." >> $LOG_DIR/$DATE-container-run.log 2>&1

                check_container_existence_status
        fi
}

send_deamon_up_commnad() {
        echo "[$NOW] gitea container에 gitea Deamon 기동 명령어를 전달할게요." >> $LOG_DIR/$DATE-container-run.log 2>&1

        process_name="gitea"

         echo "[$NOW] gitea container에 gitea Deamon 기동 명령어 실행 상태 :" >> $LOG_DIR/$DATE-container-run.log 2>&1

        docker exec $CONTAINER_NAME bash -c "systemctl restart $process_name" >> $LOG_DIR/$DATE-container-run.log 2>&1

        gitea_process_status=$(docker exec $CONTAINER_NAME systemctl is-active $process_name)

        echo "[$NOW] gitea process 상태 정보 : $gitea_process_status" >> $LOG_DIR/$DATE-container-run.log 2>&1

        if [ "$gitea_process_status" == "inactive" ];
        then
                echo "[$NOW] gitea container에 gitea Deamon 기동 명령어 전달 하였으나, 기동에 실패하였어요." >> $LOG_DIR/$DATE-container-run.log 2>&1
                exit 1
        else
                echo "[$NOW] gitea container에 gitea Deamon 기동되었어요." >> $LOG_DIR/$DATE-container-run.log 2>&1
        fi
}

check_container_existence_status

주니가 만든 쉘 스크립트는 위와 같아요.

이제 하나하나 분석해 볼게요.

set -e 명령어에 대해서는 이 곳에 정성스럽게 준비 해 두었어요.

6 ~ 9번째 줄에 상수 변수를 선언하여 날짜값과 Log가 저장될 디렉터리 위치를 저장하게 해 주었어요.

17번째 줄에 LOG_DIR 상수 변수에 담긴 Log Directory가 존재하는지를 확인해 주고 있어요.

없다면 mkdir -p 명령어로 해당 Directory를 만들어 주고, 명령어가 잘 처리 되었는지를
23번째 ~ 29번째 줄까지 확인하고, 처리하는 과정을 두었어요.

그리고 이 곳에서 gitea Container 이름과 Container가 존재하는지 여부를
docker ps 명령어로 처리하여 그 결과 값을 변수에 담도록 하여 주었어요.

docker ps --filter "name={Cotainer Name}"

위 명령어를 입력하면 이렇게 컨테이너 이름에 해당하는 컨테이너 정보를 얻을 수 있어요.

이제 위와 같이 132번째 줄에서 check_container_existence_status()를
호출하여 본격적인 여정이 시작되게 해 주었어요.

        📦 Check_container_existence_status()

728x90

최초 39번째 ~ 44번째까지는 해당 쉘 스크립트가 동작하게 되면 sleep 5 명령어를 통해 5초 동안 대기하도록 해주었는데, 이 때, 예쁘게 Loading 표시 처리가 될 수 있도록 하기 위해서 만들어 준 거에요.

stdbuf 명령어는 출력 버퍼링을 변경해주는 명령어에요.

위와 같이 sleep 명령어를 실행할 때, stdbuf 명령어를 통해 출력 버퍼링을 끄도록 변경해 준 거에요.

이렇게 하지 않으면 애니메이션 효과 처리가 되지 않는데, 이는 출력 버퍼링 때문이에요.

쉘에서 출력은 버퍼에 모아져 특정 크기나 개행 문자를 만나면 한번에 화면에 출력되는 방식을 쓰고 있어요.

그렇기 때문에 로딩 애니메이션 표시가 나오지 않을 수 있어요.

-oL 옵션은 출력 버퍼링을 라인 단위로 설정하는 옵션이에요.

이렇게 하게 되면 로딩 표시가 실시간으로 출력되어 보다 예쁜 프로그램을 만들어 볼 수 있어요.

44번째 줄에 로딩 표시를 처리해주는 함수를 호출하는데,
이 때, $!를 전달하여 Back Ground Process PID를 가져올 수 있도록 처리해 준 것이에요.

49번째 줄 명령어를 입력하게 되면

위와 같이 컨테이너 이름값을 얻을 수 있어요.

이 값을 check_container_info 변수에 담아 주었어요.

그리고 나서 if문을 통해 check_container_info 변수에 담긴 값이 Null 인지 아닌지 (-z)를 통해 확인하는데 -z 앞에 ! (Not)을 붙혀줌으로 Null이 아니면 then 절이 작동하고, Null이면 else 절이 작동하도록 처리해 주었어요.

 

        📦 send_deamon_up_command()

이번 쉘 스크립트의 가장 핵심적인 역할을 처리하는 함수 부분이에요.

반응형

100번째 줄 명령어를 통해 바로 Container 내부에 명령어를 전달해서 실행될 수 있게 처리해 주었어요.
즉, junyss-gitea라는 Container에 systemctl restart $process_name 명령어를 전달하므로써
해당 데몬이 기동될 수 있도록 처리해 준 부분이에요.

그런 뒤 102번째 줄에 해당 데몬의 상태를 확인하기 위해 명령어를 입력해 주었어요.

docker exec {Docker Container Name} systemctl is-active {Container 내부 특정 Daemon Name}

데몬이 활성화가 되어 있으면 위와 같이 active라는 문자열이 반환될 것이에요.
만약 아니라면? inactive라는 문자열이 반환 된답니다.

그리고 106번째 줄에 gitea_process_status 변수에 담긴 문자열이 inactive와 같은지 물어보고, 같다면 then 절을 통해 작업을 진행하고, 스크립트를 바로 종료될 수 있게 처리하고, 아니면 기동이 되었다는 걸 알려주도록 처리해 주었어요.

 

 

 

        📦 start_container()

컨테이너가 구동되고 있지 않다면 데몬 기동 명령어는 아무 의미가 없을 거에요.

그렇기 때문에 Check_container_existence_status() 에서 기동 여부를 먼저 확인하고, 기동 되고 있지 않으면 start_container()가 작동될 수 있도록 해 주었어요.

73번째 줄에 docker restart 명령어를 통해 컨테이너 이름값을 전달하여 컨테이너가 기동 될 수 있게 해 주었고,

75번째 if문에서 해당 명령어 처리 결과를 확인하여 0이 아니라면 명령어 처리에 문제가 발생한 것이기 때문에 로그를 쓰고, 스크립트가 종료될 수 있게 처리해 주었고,

아니라면 check_container_existence_status()를 호출하여 다시 한번 컨테이너 기동 여부를 확인할 수 있도록
처리해 주었어요.

 

 

 

 

 

        📦 show_loading()

위 함수는 백그라운드에서 실행되는 프로세스 PID를 매개변수로 받게 되요.

또한, ASCII 아트 대신 유니코드 문자를 사용하여 로딩 애니매이션을 만들어 주었어요.

118번째 줄에 로딩 표시에 사용될 delay를 설정해 주고, 해당 프로세스가 종료될 때까지 frames 배열에 등록된 다양한 프레임을 포함하게 해서 각 프레임을 순환하면서 로딩 표시를 업데이트 할 수 있게 처리해 주었어요.

로딩 표시가 업데이트 되는 속도는 delay 변수에서 설정할 수 있고, 프레임은 frames 배열을 통해 수정할 수 있어요. 

프로세스가 종료되면 작업이 체크 마크 표시가 딱! 하고 표시가 되게 만들어 주었어요.

 

 

 

    🔽 자동화 작업

        📦 쉘 스크립트 부팅 시 기동 되게 하기

해당 작업에 대한 내용은 이 곳에 정성스럽게 준비해 두었어요.

[Shell Script] Bash Shell Script를 이용한 Docker 자동 기동

vim /etc/systemd/system/{임의의 서비스 이름}.service

참고로 이번 쉘 스크립트는 위와 같이 시작 프로그램에 등록해 주었어요.

 

        📦 잘 되는지 확인!

잘 되는지 확인을 위해 서버를 재기동 해 줄거에요.

그 전에 테스트하면서 생긴 로그들을 먼저 싹다 지워줄게요.

reboot

Log를 확인해보니 잘 진행된 걸 확인할 수 있었어요.

또한, 재 기동을 하지 않으면 접속할 수 없었던 gitea web service도 아래와 같이 정상 접속 가능했어요.

 

 

리눅스 커맨드라인 쉘 스크립트 바이블

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."