Docker Compose 치트시트 - 예제와 함께 가장 유용한 명령어

다음은 Docker Compose 파일과 명령어를 빠르게 습득할 수 있도록 주석이 달린 예제가 포함된 **Docker Compose 치트시트**입니다.

이 가이드는 개발자 도구: 현대적 개발 워크플로우 완벽 가이드의 일부입니다.

전제 조건

Compose를 사용하려면 Docker Engine이 먼저 설치되어 있어야 합니다. Ubuntu의 경우, Ubuntu에 Docker 설치하기를 참조하여 적절한 설치 방법을 선택하고 docker compose 플러그인을 설정하세요.

Compose 파일 참조: docker-compose.yml

핵심 구조:

version: '3'       # Compose 파일 형식 버전

services:
  web:
    image: nginx:latest
    ports:
      - "8080:80"   # 호스트 포트 8080:컨테이너 포트 80
  db:
    image: postgres
    environment:            # 환경 변수
      POSTGRES_PASSWORD: example
    volumes:
      - db_data:/var/lib/postgresql/data

networks:          # 사용자 정의 네트워크
  appnet:
    driver: bridge

volumes:           # 이름이 지정된 볼륨
  db_data:

• services: 다중 컨테이너 애플리케이션의 각 컨테이너를 의미합니다. 위의 예제에는 web과 db라는 두 개의 서비스가 있습니다. 개별 컨테이너 작업에 대해서는 Docker Cheatsheet를 참조하세요.
• networks & volumes: 격리된 네트워크와 영구 저장소를 정의합니다. 여기서는 appnet 네트워크와 db_data 볼륨이 정의되어 있습니다.

예제

포트 매핑이 있는 단일 서비스

services:
  app:
    build: .
    ports:
      - "8000:80"   # 호스트 포트 8000:컨테이너 포트 80

호스트 포트 8000에서 앱을 노출하며, 현재 디렉토리의 Dockerfile에서 빌드합니다.

공유 볼륨 및 사용자 정의 네트워크가 있는 다중 서비스

version: '3'
services:
  web:
    build: .
    ports:
      - "5000:5000"
    volumes:
      - type: bind
        source: ./app
        target: /app
    networks:
      - mynet
  db:
    image: postgres
    volumes:
      - db_data:/var/lib/postgresql/data
    networks:
      - mynet

networks:
  mynet:

volumes:
  db_data:

Web과 DB는 동일한 네트워크에 있으며, DB는 지속되는 이름이 지정된 볼륨인 db_data를 사용합니다.

빌드 컨텍스트 및 Dockerfile 경로 사용

docker-compose.yaml에 지정된 Dockerfile에서 docker 이미지 빌드를 온디맨드 방식으로 수행할 수 있습니다.

services:
  app:
    build:
      context: .
      dockerfile: docker/MyDockerfile

서비스 간 데이터 공유

services:
  web:
    image: nginx
    volumes:
      - shared_data:/usr/share/nginx/html
  worker:
    image: myworker
    volumes:
      - shared_data:/usr/src/app/data

volumes:
  shared_data:

두 서비스 모두 동일한 볼륨에 접근하여 정적 파일이나 데이터 교환을 수행합니다 - shared_data.

고급 Compose 파일 옵션

• environment: 컨테이너의 ENV 변수를 설정합니다.
• depends_on: 서비스 시작 순서를 제어합니다.
• deploy.replicas: Swarm 모드에서 서비스를 확장합니다.

예제:

services:
  web:
    image: nginx
    deploy:
      replicas: 3
    depends_on:
      - db

3개의 web 인스턴스를 시작합니다; 시작 순서만 제어하며(준비 상태는 제어하지 않음).

필수 Docker Compose 명령어

일반적인 Compose 패턴

• 지속적인 데이터가 있는 데이터베이스

  services:
    mysql:
      image: mysql
      environment:
        MYSQL_ROOT_PASSWORD: password
      volumes:
        - mysql_data:/var/lib/mysql
  
  volumes:
    mysql_data:
  

  DB 데이터는 컨테이너 재시동 시에도 mysql_data 볼륨에 유지됩니다.

• 개발을 위한 코드 바인드 마운트

  services:
    app:
      build: .
      volumes:
        - .:/app
  

  호스트에서 코드를 실시간으로 편집하면 컨테이너에 자동으로 반영됩니다.

유용한 플래그

• -d: 디태치 모드 (백그라운드 실행).
• --build: 시작 전에 이미지 강제 재빌드.
• --force-recreate: 변경 사항이 없더라도 컨테이너 재생성.
• --remove-orphans: Compose 파일에 정의되지 않은 컨테이너 제거.

서비스 정의 및 사용자 정의

docker-compose.yml 파일을 활용하여 Docker Compose에서 서비스, 네트워크 및 볼륨을 정의하고 사용자 정의할 수 있습니다. 이 파일은 애플리케이션의 모든 구성 및 오케스트레이션 요구 사항을 중앙화합니다.

• 서비스는 services 키 아래에 정의됩니다.
• 각 서비스는 컨테이너 구성을 나타내며, 다음을 설정할 수 있습니다:
  • Image: Docker Hub 또는 기타 레지스트리에서 이미지를 선택합니다.
  • Ports: 컨테이너 포트를 호스트 포트에 매핑합니다.
  • Environment variables: 구성 값을 전달합니다.
  • Volumes: 데이터를 영구 저장하거나 호스트 또는 다른 서비스와 파일/폴더를 공유합니다.
  • Networks: 서비스가 접근할 수 있는 네트워크를 제어합니다.

예제:

services:
  web:
    image: nginx:latest
    ports:
      - "8080:80"   # 호스트 포트 8080:컨테이너 포트 80
    environment:
      - NGINX_HOST=localhost
    volumes:
      - web_data:/usr/share/nginx/html
    networks:
      - frontend

  db:
    image: postgres:13
    environment:
      POSTGRES_USER: admin
      POSTGRES_PASSWORD: secret
    volumes:
      - db_data:/var/lib/postgresql/data
    networks:
      - backend

• 여기서 web 서비스는 nginx 이미지를 사용하고, 환경 변수를 설정하며, 볼륨을 연결하고, 호스트에서 포트 80을 8080으로 열어 frontend 네트워크에 연결합니다. db 서비스는 PostgreSQL에 대해 유사하게 동작합니다.

네트워크 사용자 정의

• Networks는 어떤 서비스가 통신할 수 있는지 제어합니다. Compose는 기본 네트워크를 생성하지만, 더 많은 네트워크를 정의하고, 사용자 정의 드라이버를 지정하며, 옵션을 설정하고, 세밀한 격리를 위해 어떤 서비스가 어떤 네트워크에 참여할지 결정할 수 있습니다.
• networks 아래 최상위 레벨에서 네트워크를 정의하고, 서비스 레벨의 networks 키를 사용하여 서비스가 연결해야 할 네트워크를 나열합니다.

예제:

networks:
  frontend:
    driver: bridge
  backend:
    driver: bridge
    driver_opts:
      com.docker.network.bridge.host_binding_ipv4: "127.0.0.1"

• 서비스에 네트워크 연결:

services:
  app:
    networks:
      - frontend
      - backend
  db:
    networks:
      - backend

• 이 설정을 통해 app 서비스는 frontend 및 backend 네트워크의 사용자를 모두 접근할 수 있게 되며, db는 backend 내부에서만 접근 가능합니다.

볼륨 사용자 정의

• Volumes는 최상위 volumes 키 아래에 정의됩니다. 서비스 아래의 volumes 키를 사용하여 컨테이너에 마운트합니다.
• 볼륨에는 이름을 지정하고, 사용자 정의 드라이버를 사용하며, 여러 서비스 간 데이터 지속성 및 공유를 위해 공유할 수 있습니다.

예제:

volumes:
  web_data:                # 웹 콘텐츠를 위한 이름이 지정된 볼륨
  db_data:                 # 데이터베이스를 위한 이름이 지정된 볼륨

services:
  web:
    volumes:
      - web_data:/usr/share/nginx/html

  db:
    volumes:
      - db_data:/var/lib/postgresql/data

• 이 예제에서 web_data는 영구 저장되며, 이를 마운트하는 모든 컨테이너에서 사용할 수 있습니다. db_data는 컨테이너 재생성 시에도 데이터베이스 데이터가 손실되지 않도록 보장합니다.
• 고급 사례를 위해 사용자 정의 드라이버 옵션과 함께 바인드 마운트를 정의할 수 있습니다:

volumes:
  db_data:
    driver: local
    driver_opts:
      type: none
      device: /data/db_data
      o: bind

• 이 구성은 호스트 경로 /data/db_data에서 컨테이너로의 바인드 마운트를 설정합니다.

모범 사례 요약:

• 서비스 간 통신을 위해 서비스 이름을 DNS 호스트명으로 사용하세요.
• 접근을 제어하기 위해 필요에 따라 서비스를 여러 네트워크에 연결하세요.
• 영구 저장 및 데이터 공유를 위해 이름이 지정된 볼륨을 사용하세요.
• YAML을 사용하여 모든 것을 정의하여 버전 관리 및 쉬운 배포 스크립트를 활성화하세요.
• 컨테이너 관리 및 시각화를 위해 Linux에 Portainer 설치하기를 고려해 보세요.

여러 Compose 파일

Docker Compose에서 복잡한 다중 서비스 설정을 구성하려면 여러 Compose 파일 및 오버라이드 파일을 사용하여 모듈식, 환경별, 확장 가능한 구성을 구현할 수 있습니다. 작동 방식은 다음과 같습니다:

1. 베이스 및 오버라이드 파일 구조

• 베이스 파일 (compose.yaml 또는 docker-compose.yml)을 생성하여 모든 공통 기본 서비스 정의를 포함시킵니다.
• 환경별 오버라이드 파일 추가 (예: docker-compose.override.yml, docker-compose.dev.yml, docker-compose.prod.yml).

예제 파일 구조:

/project-directory
|-- docker-compose.yml           # 베이스 구성
|-- docker-compose.override.yml  # 로컬/개발 오버라이드 (자동 적용)
|-- docker-compose.prod.yml      # 프로덕션 오버라이드
|-- docker-compose.test.yml      # 테스트 오버라이드 (필요시)

베이스 구성은 핵심 서비스를 정의하며, 각 오버라이드는 특정 환경 또는 사례에 맞게 설정을 사용자 정의합니다.

2. 파일 오버라이드 작동 방식

• 병합: docker compose up을 실행하면 Docker Compose는 베이스 파일을 순서대로 오버라이드와 병합합니다. 후続 파일은 이전 파일의 설정을 오버라이드, 확장 또는 추가합니다.
• 필드 오버라이드: 서비스나 필드가 여러 파일에 정의된 경우, 마지막으로 지정된 파일의 값이 사용됩니다. 새 필드는 추가됩니다.

예제 병합:

• docker-compose.yml:

  services:
    web:
      image: myapp
      ports:
        - "8000:80"
  

• docker-compose.override.yml:

  services:
    web:
      environment:
        - DEBUG=true
  

• 결과: web 서비스는 베이스 이미지 및 포트와 함께 오버라이드된 DEBUG 환경 변수를 사용합니다.

3. 여러 파일을 위한 명령어 사용

• 기본 동작: 존재할 경우, Docker Compose는 명령어를 실행할 때 자동으로 docker-compose.override.yml을 docker-compose.yml과 함께 로드합니다.
• 파일 수동 지정: -f 플래그를 사용하여 병합할 파일 및 순서를 제어합니다:

  docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
  

  • 이는 기본 오버라이드를 무시하고 프로덕션 전용 설정을 사용합니다.

4. 실용적인 구성 전략

• 환경 분리: dev, test, prod 등 각 환경마다 하나의 오버라이드를 사용하세요.
• 마이크로 서비스 및 팀: 다른 서비스나 팀을 위해 구성을 별도의 파일로 나누고 필요에 따라 결합하세요.
• 기능 토글: 추가 파일은 임시 필요 사항(예: 추가 로깅을 위한 compose.debug.yml)에 대한 선택적 서비스나 구성을 도입하거나 제거할 수 있습니다.

5. 장점

• 명확성: 개별 파일을 작고 집중적으로 유지합니다.
• 확장성: 새 서비스, 환경 또는 설정을 쉽게 추가할 수 있습니다.
• 유지 관리 용이성: 특정 배포에 대해 관련 섹션만 변경하거나 검토합니다.

6. 예제: 환경 전환

개발:

docker compose -f docker-compose.yml -f docker-compose.dev.yml up

프로덕션:

docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d

각 환경은 베이스 파일의 모든 공유 구성과 함께 자신에게 필요한 구성만 얻습니다.

여러 파일로 복잡한 Compose 설정을 구성하고 오버라이드/병합 시스템을 활용하면 모듈성, 환경별 사용자 정의 및 대규모 다중 서비스 Docker 애플리케이션의 쉬운 확장성을 보장합니다.

단일 Linux 호스트에서 프로덕션 배포(시작 시 부팅, 깔끔한 종료, 업데이트 및 로그 회전)에 대해서는 systemd를 사용하여 Docker Compose를 Linux 서비스로 실행하기를 참조하세요.

유용한 링크

• https://docs.docker.com/compose/
• Docker Cheatsheet
• Kubernetes Cheatsheet
• Dockerised Flutter Web app with dockerised Flutter build and Nginx
• Install Portainer on Linux