[Docker] Bash Shell Script를 이용한 Docker Backup

 

 

 

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

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

 

 

 

 

 

 

 

 

🚀 Docker Container Backup

    🔽 개요

        📦 소개

이번에 해 볼 작업은 Docker Container를 tar File로 만들고, Backup 하는 작업을 해보려고 해요.
이 작업은 이 곳에서 작업했던 내용을 토대로 진행이 되며, 자동화를 위해 Shell Script를 만들어 볼거에요.

[Docker] Container 다른 System으로 옮기기

 

Linux의 Shell Script는 리눅스에서 사용할 수 있는 명령어 들을 조합하여 하나의 프로그램으로 작동할 수 있게 만드는 방법이에요.

그렇다면 Shell이 무엇일까요?

Shell은 운영체제에서 이용자가 입력한 명령어를 읽고, 컴퓨터가 이해할 수 있는 이진법으로 해석하여 해당 명령어를 실행해주는 것이에요.
즉, 운영체제의 커널과 이용자를 연결해주는 연결 고리라고 할 수 있고, 명령어 해석기에요.

리눅스에서 사용할 수 있는 쉘 종류는 아래와 같아요.

1. Bash: Bourne-Again Shell (Prompt: #, 경로: /bin/bash) 가장 대표적으로 사용.
2. sh : Bourne Shell (Prompt: $, 경로: /bin/sh)
3. csh: C Shell (Prompt: %, 경로: /bin/csh)
4. ksh: Kron Shell(Prompt: $, 경로: /bin/ksh)
5. tcsh: TENEX C Shell (Prompt: >, 경로: /bin/tcsh)

쉘 스크립트는 쉘에서 사용할 수 있는 명령어들의 조합을 모아서 만든 Batch(배치) File을 말해요.
즉, 운영체제의 쉘을 이용하여 한줄 씩 순차적으로 읽으면서 명령어를 실행 시켜주는 인터프리터 방식의 프로그래밍 기법이라고 할 수 있어요.

쉘 스크립트를 이용하여 묶어진 명령어 조합을 수행하거나, 반복적인 명령어를 단일 명령어로 쓸 수 있도록 해 줄 수 있어요.

 

 

 

    🔽 Docker Backup

        📦 Shell Script 만들기

본격적으로 쉘 스크립트를 만들어 볼게요.

#!/bin/bash
NOW=$(date +"%y-%m-%d %T")
echo "[$NOW] Gitea Docker Container BackUp 작업을 시작 합니다." >> /var/log/docker/backup/command/junyss-gitea-backup.log 2>&1
echo "[$NOW] 변수로 사용될 내용을 정의 합니다." >> /var/log/docker/backup/command/junyss-gitea-backup.log 2>&1
# 백업 저장될 디렉터리 경로
BACKUP_DIR="/backup/docker/junyss-gitea"

# 백업 파일에 사용될 백업 날짜
DATE=$(date +%Y%m%d%H%M)

# Docker Container 이름
CONTAINER_NAME="junyss-gitea"

# Docker Image 이름
DOCKER_IMAGE_NAME="junyss/$DATE-junyss-gitea"

# Back Up 시작
echo "[$NOW] Docker Container Back Up 작업을 시작 합니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
echo "[$NOW] 저장할 Directory가 있는지 확인 할게요." >> /var/log/docker/backup/command/junyss-gitea-backup.log 2>&1

if [ -d "$BACKUP_DIR" ]; then
        echo "[$NOW] Directory가 존재 합니다" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
else
        echo "[$NOW] Directory가 존재 하지 않아 생성 합니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
        mkdir -p /backup/docker/junyss-gitea

        if [ $? != 0 ]; then
                echo "[$NOW] Backup File 저장할 Directory 생성 실패 (실패 이유 : $?)" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
        else
                echo "[$NOW] Backup File 저장할 Directory 생성 성공" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
        fi

        echo "[$NOW] Directory 권한을 설정 합니다." >> /var/log/docker/backup/command/junyss-gitea-backup.log 2>&1
        chmod -R 755 /backup/docker/junyss-gitea
  
        if [ $? != 0 ]; then
                echo "[$NOW] Backup File 저장할 Directory 권한 설정 실패 (실패 이유 : $?)" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
        else
                echo "[$NOW] Backup File 저장할 Directory 권한 설정 성공" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
        fi
fi

echo "[$NOW] 구동중인 Container $CONTAINER_NAME을 중지 합니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
docker stop $CONTAINER_NAME

if [ $? != 0 ]; then
        echo "[$NOW] 구동중인 Container $CONTAINER_NAME을 중지 실패 (실패 이유 : $?)" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
else
        echo "[$NOW] 구동중인 Container $CONTAINER_NAME을 중지 성공" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
fi

echo "[$NOW] Docker Container의 현재 상태와 Data를 Docker Image로 저장 합니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
docker commit $CONTAINER_NAME junyss/$DATE-$CONTAINER_NAME

if [ $? != 0 ]; then
        echo "[$NOW] 구동중인 Container $CONTAINER_NAME을 중지 실패 (실패 이유 : $?)" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
else
        echo "[$NOW] 구동중인 Container $CONTAINER_NAME을 중지 성공" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
fi

echo "[$NOW] Docker Container 현재 상태와 Data를 tar File로 만듭니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
docker save -o $BACKUP_DIR/[$NOW]$CONTAINER_NAME.tar $DOCKER_IMAGE_NAME

if [ $? != 0 ]; then
        echo "[$NOW] Docker Container 현재 상태와 Data를 tar File 만들기 실패 (실패 이유 : $?)" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
else
        echo "[$NOW] Docker Container 현재 상태와 Data를 tar File 만들기 성공" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
fi

echo "[$NOW] 기존 Container를 다시 기동 합니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
docker restart $CONTAINER_NAME

if [ $? != 0 ]; then
        echo "[$NOW] 기존 Container를 다시 기동 실패 (실패 이유 : $?)" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
else
        echo "[$NOW] 기존 Container를 다시 기동 성공" >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1
fi

echo "[$NOW] $CONTAINER_NAME Docker Back Up이 끝났습니다." >> /var/log/docker/backup/command/[$DATE]junyss-gitea-backup.log 2>&1

728x90

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

최초 첫번째 줄을 Bash를 이용한 스크립트 라는 것을 알려주는 부분이에요.
이 부분은 반드시 명시해 주어야 합니다.

두번째 줄에는 Log에 출력될 Date 값을 NOW 변수에 넣어준 거에요.
위와 같이 명령어를 쓰게 되면 [yyyy-mm-dd HH:MM:SS] 형식의 일시값이 NOW에 저장되게 되요.

echo 명령어는 터미널에 출력하라는 의미인데,
자바로 따지면 System.out.print 그리고, 자바 스크립트의 경우에는 console.log와 같은 의미에요.

이렇게 해서 NOW 변수에 담긴 일시를 축력하고, 출력하고자 하는 문자열을 입력해 주었어요.

>>의 의미는 Append의 의미로 >로만 하게 되면 기존 값을 다 지우고, 새로운 값만 덮어쓰는 형식으로 입력이 되는데,
>> 이렇게 표시를 하게 되면 계속 내용이 추가되게 할 수 있어요.

좀 더 자세히 이야기 해 보자면 아래와 같이 설명할 수 있어요.

• > : 명령어 뒤에 나오는 File에 쓸 때, 사용 - Write or Overwrite)
• >> : 명령어 뒤에 나오는 File에 추가할 때 사용 (Append)

 

계속 해서 /var/log/docker/backup/command/junyss-gitea-backup.log의 의미는 해당 echo에서 출력된 내용을 디렉터리 내에 junyss-gitea-backup.log를 만들고, 그 안에 해당 내용을 추가 하라는 의미에요.

2>&1의 의미는 무엇일까요?

이것은 Standard Error를 Standard Output으로 Redirection 하라는 명령어에요.

보통 프로그램에서 문제가 발생하면 화면에 해당 Message를 표시해서 사용자에게 경고를 주게 되는데, 이러한 기본 동작에 대해 사용자가 임의로 재지정 하여 오류가 발생해도 경고 메시지 출력을 사용자 임의로 조정할 수 있는데 이걸 표준 에러 리다이렉션이라고 부르고 있어요.

즉, 에러가 발생하게 되면 프로그램이 동작을 멈추거나, 꺼지게 하지 말고, 대신 에러 내용을 표준 출력 동작으로 행동하게 하여 명령어 실행 결과는 문제가 있어도 화면에 경고 메시지 출력하지 말고, Log File에 작성해라라는 의미에요.

주니는 결국 해당 Log File에 문제가 발생해도 이를 화면에 출력하지 말고, Log File에 쓰기 위해서 사용해 준 거에요.


6번째 줄은 Backup 된 File이 저장될 Directory 경로를 BACKUP_DIR 이라는 변수에 담아 주는 방식으로 변수들에 필요한 값을 먼저 선언해주었어요.

21번째 if문은 -d 즉, Directory를 의미하는데, 위에서 변수로 선언한 BACKUP_DIR(/backup/docker/junyss-gitea)가 존재하는가?를 묻고 있어요.

그래서 22번째 줄에는 존재 한다면 존재하는 내용을 Log File에 작성하게 해 주었고, 23번째 else문 안에 24 ~ 40번째는 Directory가 없을 때, 해야 하는 일을 명령해 주었어요.

최초 25번째 줄에 해당 Directory가 없으니 mkdir 명령어로 해당 Directory를 만들어 주었어요.

그런 뒤 27번째 줄에 if 문을 통해 해당 명령어가 잘 실행 되었는지를 확인하고 있어요.

$?는 위에 명령어 종료 상태(exit status)를 나타내는 특수 변수에요. 이전 명령이 성공적으로 실행되면 0값을 가지고, 오류가 발생하면 다른 값을 가지게 된답니다. 이 값은 일반적으로 다른 명령을 실행, 제어의 흐름을 결정할 때 많이 사용해요.

그래서 If문에서 0이 아니라면 mkdir 즉, Directory 생성을 실패한 거고, 왜? 실패 했는지를 Log에 남겨 주도록 하였어요.

마찬가지로 else문을 통해 성공했어도 성공 내용을 남기도록 하였어요.

리눅스 쉘 스크립트에서 if문은 끝이 나게 되면 자바에서 ;(세미 콜론)을 찍어주는 것처럼 fi로 마무리를 해주어야 해요.

그리고 34번째 줄에는 chmod 명령어를 통해 해당 Directory의 권한을 설정해 주도록 하였어요.

docker stop $CONTAINER_NAME

최초 Container를 Backup 하기 위해서는 기동중인 Container를 중지 시켜주어야 해요.

docker commit $CONTAINER_NAME junyss/$DATE-$CONTAINER_NAME

그런 뒤 docker commit 명령어를 통해 Container의 현재 상태와 Data를 Docker Image로 저장해 주도록 하였어요.
참고로 Directory Mapping 등 추가 설정 사항이 있는 Container는 추가적인 작업이 더 필요해요. 

docker save -o $BACKUP_DIR/[$NOW]$CONTAINER_NAME.tar $DOCKER_IMAGE_NAME

이 부분에서 본격적으로 Container를 tar File로 압축해 주게 되요. -o 뒤에 압축될 File 이름을 작성하고, 한 칸을 띄고, 위에서 저장한 Docker Image 이름을 작성해 주면 된답니다.


Backup이 실패했건 성공했건 어쨋든 Docker는 다시 기동되어야 해요.

그래서 마지막으로 기존 Container를 기동 시켜 줍니다.

docker restart $CONTAINER_NAME

작성이 완료 되었으면 :wq를 입력하고 나와 줍니다.

 

 

 

 

    🔽 Scheduling

        📦 crontab 사용하기

위와 같이 스크립트만 만들게 되면 사용자는 백업을 하고 싶을 때마다 주기적으로 서버에 접속해서 해당 스크립트를 실행 시켜주어야 한다는 귀찮은 일이 발생할 거에요.

이를 주기적으로 알아서 처리할 수 있도록 ctontab을 이용할 수 있어요.

crontab -l

반응형

주니는 위와 같이 crontab을 작성해 주었어요.
crontab을 작성하기 위해서는 crontab -e 명령어를 입력해 주면 되요.

💡 Crontab

Crontab 기본 명령어

crontab -e

Crontab 설정

crontab -l

Crontab 내용 확인 

crontab -r

Crontab 삭제


주기 설정

        *                      *                *             *              *
분(0-59)  시간(0-23) 일(1-31) 월(1-12) 요일(0-7)


매분 test.sh 실행

* * * * * /home/test.sh

특정 시간 실행
 - 매주 금요일 오전 05시 45분 test.sh 실행

45 5 * * 5 /home/test.sh

반복 실행
 - 매일 매시 0분, 20분, 40분 마다 test.sh 실행

0,20,40 * * * * /home/test.sh

범위 실행
 - 매일 01시 00분 부터 30분까지 매 분 test.sh 실행

0-30 1 * * * /home/test.sh​

 

간격 실행
 - 매 10분마다 test.sh 실행

*/10 * * * * /home/test.sh​

 

복잡한 예제
 - 5일에서 6일까지 2시, 3시, 4시에 매 10분마다 test.sh 실행

*/10 2,3,4, 5-6 * * /home/test.sh​

주니가 입력해 준 것은 매일 자정에 backup 스크립트를 동작 시켜서 백업을 하고, 해당 처리 내용을 /var/log/docker/backup/cron/junyss-gitea-bakcup-$(date +%Y%m%d%H%M).log
이 곳에 Append 하여 Log로 남겨라! 라고 리눅스에게 명령해 준 거랍니다.