Docker 여러 컨테이너의 볼륨, 네트워크를 간편하게 관리하고 실행하는 방법 (with Docker Compose)

1. 문제 상황

---

컨테이너를 각자 띄우고 네트워크를 연결해주고 볼륨을 연결해주고를 반복하다보니 아래와 같은 생각을 하였다.

MariaDB, Redis, Spring Boot Jar, Prometheus, Grafana 등의 컨테이너를 한번에 띄우고 업데이트할 수 있는 방법은 없을까?
그리고 각 컨테이너의 docker network를 손쉽게 연결하고 볼륨, 의존관계, 기타 환경설정 등을 하나의 파일에서 편리하게 설정하고 관리할 수 있는 방법은 없을까?

 

2. 문제 해결

---

✏️ Docker Compose를 사용하자!

• Docker Compose란 다중 컨테이너 애플리케이션을 정의하기 위한 Tool이라고 보면 된다.

 

✏️ Docker Compose 주요 특징

     1️⃣ 단일 호스트의 여러 개의 격리된 환경

          Compose는 프로젝트 이름을 사용하여 서로 환경을 격리시킨다. 
          kiosek라는 서비스를 실행시키려고 할 때, kiosek1, kiosek2와 같이 여러 개를 서로 격리하여 서비스 할 수 있다.  

     2️⃣ 컨테이너를 생성할 때 볼륨 데이터 보존

          컨테이너를 새로 생성해도 볼륨 데이터를 보존하여 데이터가 손실되지 않도록 한다.
          DB와 같은 컨테이너를 생성할때 컨테이너 내부 경로와 로컬 경로의 볼륨을 연결하지 않으면 컨테이너가 종료되거나              삭제될시에 데이터가 삭제되버리므로 중요한 부분이다.  

     3️⃣ 변경된 컨테이너만 재생성

          컨테이너를 생성하는데 사용된 구성을 캐싱하여 변경된 부분만 새로 생성하고 변경되지 않은 부분은 유지한다.

     4️⃣ 변수 및 환경 간 구성 이동

          Compose 파일의 변수를 지원하여 다양한 환경이나 사용자에게 알맞게 커스텀 할 수 있다.
          이 부분은 사용할 일이 없어 해보지는 않았으나 편리한 기능인 것 같다.

✏️ 실제 적용한 docker-compose.yml

version: "3.8"
services:
    kiosek-nginx:
        container_name: kiosek-nginx
        image: nginx
        restart: always
        ports:
         - 80:80
         - 443:443
        volumes: 
         - /home/se/kiosek/nginx/nginx.conf:/etc/nginx/nginx.conf
         - /home/se/kiosek/nginx/access.log:/var/log/nginx/access.log
         - /home/se/kiosek/nginx/error.log:/var/log/nginx/error.log
         - /home/se/kiosek/html:/usr/share/nginx/html
         - /home/se/kiosek/certbot-etc:/etc/letsencrypt
        depends_on:
         - kiosek-backend
        environment:
            TZ: "Asia/Seoul"


    kiosek-db:
        container_name: kiosek-db
        image: mariadb
        restart: always
        volumes:
         - /home/se/kiosek/mariadb/data:/var/lib/mysql
         - /home/se/kiosek/mariadb/log:/var/log/maria
        environment:
         - MYSQL_DATABASE=test
         - MYSQL_ROOT_PASSWORD=test
         - MYSQL_USER=root
         - TZ="Asia/Seoul"
        ports:
         - 3306:3306

    kiosek-redis:
        container_name: kiosek-redis
        restart: always
        image: redis
        volumes:
         - /home/se/kiosek/redis/data:/data
        ports:
         - 6379:6379
        environment:
            TZ: "Asia/Seoul"

    kiosek-backend:
        container_name: kiosek-backend
        restart: always
        image: zabcd121/kiosek:latest
        ports:
         - 8050:8050
         - 8060:8060
        volumes:
         - /home/se/kiosek/key.txt:/home/se/kiosek/key.txt
         - /home/se/kiosek/iv.txt:/home/se/kiosek/iv.txt
         - /home/se/kiosek/image:/home/se/kiosek/image
        depends_on:
         - kiosek-db
         - kiosek-redis
        environment:
            TZ: "Asia/Seoul"

    kiosek-prometheus:
        image: prom/prometheus:latest
        container_name: kiosek-prometheus
        user: root
        volumes:
         - /home/se/kiosek/monitor/prometheus:/etc/prometheus
         - /home/se/kiosek/monitor/prometheus/data:/prometheus
        ports:
         - 9090:9090
        restart: always
        environment:
            TZ: "Asia/Seoul"
    kiosek-grafana:
        image: grafana/grafana:latest
        container_name: kiosek-grafana
        environment:
         - GF_SECURITY_ADMIN_USER=admin
         - GF_SECURITY_ADMIN_PASSWORD=test
         - GF_USERS_ALLOW_SIGN_UP=false
         - TZ="Asia/Seoul"
        volumes:
         - /home/se/kiosek/monitor/grafana:/var/lib/grafana
         - /home/se/kiosek/monitor/grafana/provisioning:/etc/grafana/provisioning
        ports:
         - 3000:3000
        user: root
        depends_on:
         - kiosek-prometheus
        restart: always

    certbot:
       depends_on:
        - kiosek-backend
       image: certbot/certbot
       container_name: certbot
       volumes:
        - /home/se/kiosek/certbot-etc:/etc/letsencrypt
        - /home/se/kiosek/html:/usr/share/nginx/html
       command: certonly --webroot --webroot-path=/usr/share/nginx/html --email kiosek@naver.com --agree-tos --no-eff-email -d kiosek.kr -d www.kiosek.kr --force-renewal

 

✏️ Compose Network

    Docker Compose를 이용하여 컨테이너들을 실행하였을 때는 자동으로 네트워크를 생성하여 컨테이너들끼리 연결해준다.
    1. projectName_default 네트워크 생성
    2. 각 컨테이너가 생성되고 컨테이너의 이름으로 projectName_default 네트워크에 접속

    네트워크가 구성된 이후에는 내부 서로 연결된 컨테이너들은 mariadb://kiosek-db:3306 주소로 접속 가능하고
    외부 컨테이너에서는 mariadb://{컨테이너에_부여된_IP}:3306 주소로 접속한다.
   

✏️ Compose Version

    docker-compose.yml 파일 상단에 보면 version이 명시되어 있다.
     처음에는 내가 마음대로 적는 문서 버전을 뜻하는것인줄 알아서 에러를 보고 말았는데 사실 버전 별로 사용 가능한 도커 엔진이 다르고 Compose Version도 다르다고 한다.

• Version 1은 버전 생략 가능
• Version 2부터는 마이너 버전(2.x)까지 설정해야 함
• Version 3은 도커 스웜과 같이 사용되도록 디자인됨

 

✏️ Compose 주요 명령

1. up

docker-compose.yml을 통해 이미지를 빌드하고 애플리케이션을 실행한다.

$ docker-compose -p kiosek up -d

1. 서비스를 실행할 네트워크를 설정
2. 볼륨 생성
3. Docker Image Pull
4. Docker Image Build
5. Depend on 설정에 따라 서비스 순차 실행

options

• -d : 백그라운드에서 서비스를 실행 
• --force-recreate : 컨테이너를 삭제하고 새로 생성
• -f : 기본 docker-compose.yml 파일명이 아니라 다른 파일명을 사용할 때 사용
• --build: 서비스 시작 전 이미지를 새로 생성

etc) stop, start, ps, exec, run, logs, config

docker 명령과 거의 유사함