12장. Docker-Compose

💻 Microsoft Docker Compose 사용

Docker Compose

Docker Compose 필요성

여러 개의 컨테이너가 하나의 애플리키에션으로 동작할 때 이를 테스트하려면 각 컨테이너를 하나씩 생성해야 한다. 예를 들어 웹 애플리케이션을 테스트하려면 웹 서버 컨테이너와 데이터베이스 컨테이너를 생성해야 한다.

이처럼 여러개의 컨테이너로 구성된 애플리케이션을 구축하기 위해 run 명령어를 여러 번 사용할 수 있지만 각 컨테이너가 제대로 동작하는지 확인하는 테스트 단계에서는 이렇게 하기 번거롭다. 따라서 여러개의 컨테이너를 하나의 서비스로 정의해 컨테이너 묶음으로 관리할 수 있다면 좀 더 편리할 것이다.

동작 원리

도커 컴포즈는 여러개의 컨테이너의 옵션과 환경을 정의한 파일을 읽어 컨테이너를 순차적으로 생성하는 방식으로 동작한다. 도커 컴포즈의 설정 파일은 run 명령어의 옵션을 그대로 사용할 수 있으며, 각 컨테이너의 의존성, 네트워크, 볼륨 등을 함께 정의할 수 있다. 또한 설정 파일의 정의된 서비스의 컨테이너 수를 유동적으로 조절할 수 있으며 컨테이너의 서비스 디스커버리도 자동으로 이뤄진다.

물론 이러한 기능이 필요하지 않는 소규모 컨테이너 개발환경에서는 도커 엔진의 run 명령어로 컨테이너를 생성하는 것이 더 편리할 수 있겠다. 그렇지만 컨테이너가 많아지고 정의해야할 옵션이 많다면 도커 컴포즈를 사용하는게 좋다.

Docker Compose Usage

Install

여기서는 윈도우 환경을 가정하고 설명하도록 하겠다. 윈도우와 맥 OS 에서는 도커 툴박스나 Docker for Windows, Docker for Mac을 설치하면 도커 엔진과 함께 도커 컴포즈도 설치되기 때문에 따로 뭔가를 할 필요는 없다.

YAML 파일 생성

도커 컴포즈는 컨테이너의 설정이 정의된 YAML 파일일 읽어 도커 엔진을 통해 컨테이너를 생성해준다. 따라서 도커 컴포즈를 사용하려면 먼저 YAML 파일을 작성해야 한다. Docker Compose는 기본적으로 docker-compose.yml 파일을 설정 파일로 사용한다. 보통 앱 프로젝트 루트에 파일을 만들어 사용한다고 한다.

가장 먼저 스키마 버전을 정의한다. 대부분의 경우 지원되는 최신 버전을 사용하는 것이 좋다. 다음으로 애플리케이션 일부로 실행하려는 서비스(또는 컨테이너) 목록을 정의한다.

version: "3.7" # 필수
services: 작성예정(필수)
networks:
    # 네트워크 설정. 없어도 됨
volumnes:
    #볼륨 설정. 없어도 됨

YAML 파일 작성

먼저 서비스 항목과 컨테이너 이미지를 정의한다. 서비스 이름은 임의로 선택할 수 있다.

version: "3.7"

services:
  app: # service 이름
    image: node:14.15.5-alpine # 이미지
    command: sh -c "yarn install && yarn run dev" # 컨테이너 실행시 실행될 명령
    ports: # 포트 매핑
      - 3000:3000
    working_dir: /app # 컨테이너 내 작업공간(없으면 만들어줌)
    volumes: # 볼륨 설정 (호스트:컨테이너)
      - ./:/app
    environment: # 환경변수
      MYSQL_HOST: mysql
      MYSQL_USER: root
      MYSQL_PASSWORD: secret
      MYSQL_DB: todos
    depends_on: # 의존성 설정(db가 먼저 생성된 후에 app이 생성)
      - db
    restart: always # 오류가 나면 바로 다시 시작
  
  db: 
    image: mariadb:10.5
    volumes: # 볼륨 설정 (호스트:컨테이너)
      - todo-mysql-data:/var/lib/mysql
    environment: 
      MYSQL_ROOT_PASSWORD: secret
      MYSQL_DATABASE: todos

volumes: # 볼륨을 따로 생성
  todo-mysql-data:

docker-compose 실행

이제 docker-compose.yml 파일이 준비되었으므로 시작할 수 있다.

$ docker-compose up -d

처음에 mariadb_app_1(node 컨테이너)가 실행되자마자 꺼지는 오류가 나서 한동안 어려움을 겪었다. 이럴때는 밑에 로그 확인 방법을 사용하면 무슨 오류때문에 실행이 안되는지 확인할 수 있다.

일단 나는 처음에 node:14.15.5-appine에 app 폴더가 있고 그 안에 내용이 있어서 yarn으로 설치하고 실행되도록 하는건줄 알았다. 근데 알고 보니까 app 폴더는 존재하지 않고, working_dir를 통해 app 폴더를 생성한 후에 내가 지금 있는 폴더를 컨테이너에다가 복사붙여넣기 한 다음에 실행되도록 하는 거였다...

아... 생각해보니 진짜 바보같은 실수를 했다.

• working_dir: /app => 컨테이너의 작업공간을 app 폴더로 설정. 없다면 알아서 생성해준다.
• volumes: ./:/app => 볼륨설정을 이렇게 했다. 이것은 현재 내 컴퓨터의 현재 경로와 컨테이너이의 app 폴더와 공유하겠다는 의미이다.

✍ 정리해보면 현재 컴퓨터의 작업공간과 컨테이너의 app 작업공간을 서로 일치시켜서 컨테이너에서 실행되도록 만든 것이다. (오.. 이러면 윈도우에서 작업한게 리눅스에서 실시간으로 반영되면서 실행되는 건가???? 신세계 발견?)

도커 볼륨 확인

app 서비스의 volumes와 db 서비스의 volumes는 차이가 있다. 사실 이것 때문에 더 헷갈렸던거 같다. 가장 아래 volumnes: todo-mysql-data 라고 설정한 부분은 바로 도커 볼륨을 생성하는 명령이다. 도커 볼륨에 대해 기억이 안난다면 이전 글을 보고 오자.

그렇게 생성된 todo-mysql-data 볼륨에다가 mariaDB 컨테이너 안에 /var/lib/mysql 폴더를 공유해주겠다는 의미가 된다. 그렇다면 todo-mysql-data 볼륨은 어디있을까? 그것도 윈도우 안에서 말이다.

이것과 관련해서 스택오버플로우에 좋은 글이 있었다. 바로 \\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\ 경로에 있을 것이라는 것!!!

와.. 신기하다. mariadb_todo-mysql-data라는 볼륨이 진짜 있었다. 거기서 _date 폴더 안에 컨테이너 mysql 설정 관련 폴더와 파일들이 공유된 것을 확인할 수 있었다.

아무래도 이 공간이 Windows 호스트에서 리눅스 기반 도커를 실행하기 위한 WSL(리눅스용 윈도우 하위 시스템)인거 같다. WSL이란 Windows에서 네이티브 Linux 명령줄 도구를 직접 실행할 수 있는 새로운 Windows 10 기능이라고 한다.

WSL 1과는 다르게 WSL 2는 Hyper-V 기반의 최신 가상화 기술을 이용하여 실제 리눅스 커널을 직접 탑재하면서 성능 또한 비약적으로 상승하였다고 하니... 이래서 윈도우에서 도커를 자연스럽게 사용할 수 있었던 거구나.. 👏👏

Logs Checking

도커 컴포즈에서 로그를 확인해보려면 다음 명령을 실행하면 된다. -f 플래그는 로그가 실시간으로 뒤에 추가되도록 해주는 옵션이다.

$ docker-compose logs -f

만약 특정 컨테이너(서비스)에 대한 로그만 보고 싶다면 서비스 이름을 적고 실행하면 된다.

$ docker-compose logs 서비스 이름(ex. app, db)

docker-compose down

docker-compose down 명령을 통해 모두 제거할 수 있다.

마침

도커 컴포즈 중에서 아주 일부분만 실습해봤다. 설명하지 못한 옵션(networks 정의 등)도 많이 있으며 도커 컴포즈를 이용한 컨테이너를 여러개 복사 생성할 수도 있다.