[Docker] Docker compose란?

🌟 새로 알게된 점
- docker-compose network 부분 back과 front로 나누기
- docker-compose up은 # build => create => start  과정
- docker-compose 옵션 중 healthcheck

---

Docker Compose란?

다수의 Container로 소프트웨어가 구성되는 경우 사용할 수 있는 환경 설정 파일

파일 : docker-compose.yaml 혹은 .yml

• 다른 이름 파일 사용시 -f 옵션 사용

docker-compose -f docker-compose.mac.yml up

 

Docker Compose v.1.27+ 부터 v2와 v3가 합쳐짐

• v1은 docker-compose, v2는 docker compose인데, 대부분의 문서가 docker-compose 중심임
• 버전 확인 : docker-compose --version

 

#️⃣ 1. 구성

1. services: 다음으로 프로그램을 구성하는 서비스들을 지정
   • 각 서비스는 자신의 Dockerfile 갖고 있음
   • 각 서비스는 별도의 docker Image 지정과 Docker Container 실행으로 구성됨
   • 서비스별로 포트번호, 환경변수, 디스크 볼륨등을 지정
   • 서비스 이름은 아무 이름이나 가능
2. volumes : docker volume들을 지정
3. networks : network들을 지정
   • 지정 안 하면 “default” 이름으로 기본 네트워크 만들어지고, 같은 docker-compose 그룹 내에서 모두 연결됨
   • services에 준 이름으로 호스트 이름이 생성됨
   • 내부에 DNS 서버가 하나 생성되어 이름을 내부 IP로 변환해줌

예시 docker-compose.yaml

services:
  web:
    build: .
    ports:
      - "8000:5000"
    volumes:
      - .:/code
    environment:
      FLASK_DEBUG: "true"
  redis:
    image: "redis:alpine"

https://docs.docker.com/compose/gettingstarted/

 

#️⃣ 2. 관련 명령어

docs : Overview of docker compose CLI

• docker-compose build : compose 파일 빌드
• docker-compose start : 서비스 시작
• docker-compose stop : 서비스 중지
• docker-compose create: 서비스를 위한 컨테이너 생성
• docker-compose up : # build => create => start
• docker-compose pull : docker hub에서 이미지 읽어옴
• docker-compose push : docker hub로 이미지 push
• docker-compose images : 컨테이너로 실행되고 있는 이미지 목록
• docker-compose ps : 컨테이너 목록
• docker-compose down : 컨테이너 중지 및 네트워크와 함께 삭제
• docker-compose rm : 중지된 컨테이너 서비스 삭제
• docker-compose ls : docker-compose를 그룹별로 보여줌
• docker compose —help

Usage:  docker compose [OPTIONS] COMMAND

Define and run multi-container applications with Docker.

Options:
      --ansi string                Control when to print ANSI control characters ("never"|"always"|"auto") (default "auto")
      --compatibility              Run compose in backward compatibility mode
      --env-file stringArray       Specify an alternate environment file.
  -f, --file stringArray           Compose configuration files
      --parallel int               Control max parallelism, -1 for unlimited (default -1)
      --profile stringArray        Specify a profile to enable
      --project-directory string   Specify an alternate working directory
                                   (default: the path of the, first specified, Compose file)
  -p, --project-name string        Project name

Commands:
  build       Build or rebuild services
  config      Parse, resolve and render compose file in canonical format
  cp          Copy files/folders between a service container and the local filesystem
  create      Creates containers for a service.
  down        Stop and remove containers, networks
  events      Receive real time events from containers.
  exec        Execute a command in a running container.
  images      List images used by the created containers
  kill        Force stop service containers.
  logs        View output from containers
  ls          List running compose projects
  pause       Pause services
  port        Print the public port for a port binding.
  ps          List containers
  pull        Pull service images
  push        Push service images
  restart     Restart service containers
  rm          Removes stopped service containers
  run         Run a one-off command on a service.
  start       Start services
  stop        Stop services
  top         Display the running processes
  unpause     Unpause services
  up          Create and start containers
  version     Show the Docker Compose version information

Run 'docker compose COMMAND --help' for more information on a command.

 

#️⃣ 3. docker-compose 파일 설정

docs : https://docs.docker.com/compose/compose-file/compose-file-v3/

✅ build

빌드 시 적용되는 구성 옵션

간단하게 구성하면 아래 처럼 작성할 수 있다.

version: "3.9"
services:
  webapp:
    build: ./dir

지정된 경로/이름을 가진 경우 아래 처럼 추가로 작성 가능하다.

version: "3.9"
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

✅ healthcheck

서비스 상태 체크 (Dockerfile에서도 작성 가능)

healthcheck:
  test: ["CMD", "curl", "-f", "<http://localhost>"]
  interval: 1m30s
  timeout: 10s
  retries: 3
  start_period: 40s

• test: healthcheck하는 명령어 지정
• interval: healthcheck 실행하는 주기
• timeout: healthcheck 요청 최대 시간 (초과시 실패로 됨)
• retries: healthcheck 실패 시 재시도 횟수
• start_period: 컨테이너 시작된 후 healthcheck를 시작하기까지 대기시간

✅ depends_on

해당 서비스가 실행되기 위해서 먼저 실행되어야 하는 서비스들 기술

1. short syntax 예시

services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

2. long syntax 예시

services:
  web:
    build: .
    depends_on:
      db:
        condition: service_healthy
        restart: true
      redis:
        condition: service_started
  redis:
    image: redis
  db:
    image: postgres

• condition은 해당 서비스의 health 조건을 만족할 때 실행됨을 의미함
  • service_started: short syntax과 동일. healthy 상태
  • service_healthy: healthcheck가 health상태로 통과된 경우에만 충족됨
  • service_completed_successfully: dependency가 성공적으로 실행되어야 하는 경우에 사용됨

✅ environment

(Dockerfile ENV)해당 서비스가 컨테이너 안에서 실행될 때 환경변수들을 지정

작성 방식 : Map(위)과 Array(아래) 방식

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

✅ entrypoint

기본 entrypoint를 오버라이드함

entrypoint: /code/entrypoint.sh

Dockefile처럼 리스트로도 작성 가능하다.

entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]

✅ networks

해당 서비스의 네트워크 지정

services:
  some-service:
    networks:
     - some-network
     - other-network

alias를 사용하여 네트워크의 해당 서비스에 대한 별칭(호스트 이름) 등록 가능

services:
  some-service:
    networks:
      some-network:
        aliases:
          - alias1
          - alias3
      other-network:
        aliases:
          - alias2

의미 : ‘some-service’는 두 개의 네트워크(some-network, other-network)에 속한다.

이때, some-network는 alias1과 alias3 별칭을 갖고, other-network는 alias2 별칭을 갖는다.