🐳 docker-compose.yml 작성

Compose file version 3 reference

Compose file version 3 reference

Compose 파일 구조와 예시

다음은 투표 애플리케이션의 간단한 컴포즈 파일 예시이다.

version: "3.9"
services:

  redis:
    image: redis:alpine
    ports:
      - "6379"
    networks:
      - frontend
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        max_replicas_per_node: 1
        constraints:
          - "node.role==manager"

  vote:
    image: dockersamples/examplevotingapp_vote:before
    ports:
      - "5000:80"
    networks:
      - frontend
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
      restart_policy:
        condition: on-failure

  result:
    image: dockersamples/examplevotingapp_result:before
    ports:
      - "5001:80"
    networks:
      - backend
    depends_on:
      - db
    deploy:
      replicas: 1
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 1
      labels: [APP=VOTING]
      restart_policy:
        condition: on-failure
        delay: 10s
        max_attempts: 3
        window: 120s
      placement:
        constraints:
          - "node.role==manager"

  visualizer:
    image: dockersamples/visualizer:stable
    ports:
      - "8080:8080"
    stop_grace_period: 1m30s
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"
    deploy:
      placement:
        constraints:
          - "node.role==manager"

networks:
  frontend:
  backend:

volumes:
  db-data:

Compose file

컴포즈 파일이란 service network 그리고 volume 을 정의하는 야믈파일이다. 컴포즈 파일의 기본 경로는 ./docker-compose.yml 이다.

.yml 이나 .yaml 둘 다 사용 가능

• service 정의는 각각의 컨테이너에 적용되는 configuration을 포함하고 있다.

  configuration의 예시: docker run 의 매개변수같은 것을 넘겨주는 일 같은 것들

---

자 지금부터 list of all configuration option을 소개해드릴게요‼️

build

build time에 적용되는 configuration option들이다.

build 는

1. build하려는 context의 경로를 설정하는 String

   build: ./dir

2. 또는 object이기도 하다. 다음은 context, dockerfile, args라는 프로퍼티를 가지는 오브젝트인 경우이다.

   build:
   	context: ./dir
   	dockerfile: Dockerfile-alternate
   	args:
   		buildno: 1

만약 우리가 image 라는 configuration option을 추가해서 build 후에 생성되는 이미지의 이름과 태그를 지정해줄 수 있다.

build: ./dir
image: webapp:tag # 이미지이름이 webapp 이고 태그가 tag로 빌드된다.

context

컨택스트는 Dockerfile을 포함하는 디렉토리 경로 또는 git repo의 url이다.

상대경로가 값으로 주어졌을때, 이건 compose file을 기준으로한 경로로 해석된다. 이 디렉토리는 Docker daemon으로 보내진다.

build:
	context: ./dir

dockerfile

Dockerfile을 대체하는 파일을 지정해준다.

args

build 과정에서만 접근 가능한 환경변수인 build argument를 추가한다.

일반 도커 파일에서는 다음과 같은 문법을 가지고 있었다.

# syntax=docker/dockerfile:1

ARG buildno
ARG gitcommithash

RUN echo "Build number: $buildno"
RUN echo "Based on commit: $gitcommithash"

args도 마찬가지로 build의 프로퍼티로 오게 된다. 이런식으로 할 수 있다.

build:
	context: .
	args:
		buildno: 1
		gitcommithas: cdc3b19

array로 표현할 수도 있다.

build:
	context: .
	args:
		- buildno=1
		- gitcommithash=cdc3b19

build argument들은 그 값을 생략할 수도 있는데, 그렇게 되면 빌드 시 인수값은 이전에 Compose가 실행하던 환경의 값이 된다.

network

빌드하는 동안에 RUN 기계어가 연결될 네트워크 컨테이너를 설정한다. (뭔소리지)

build:
	context: .
	network: host

build:
	context: .
	network: custom_network_1

만약 빌드 하는동안 네트워크가 불가능하게 하고싶으면 값으로 none을 넣어주면 된다.

---

command

default command를 덮어쓴다.

command: bundle exec thin -p 3000

dockerfile에서처럼 리스트로 표현할 수도 있다.

command: ["bundle", "exec", "thin", "-p", "3000"]

---

configs

config파일의 이름을 짓는 짧은 문법이다. 이 grants(초대)는 컨테이너가 개발자의 config 파일에 접근할 수 있게 하고, 컨테이너에 우리가 설정한 이름으로 저장되게 한다. ? source name과 destination mountpoint 는 모두 config name으로 설정된다. ?

version: "3.9"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs: # 사용하는 configuration file들의 이름
      - my_config
      - my_other_config

configs: # 여기서 정의함.
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true

---

container_name

기본값으로 실행되지 않도록 컨테이너의 이름을 커스텀으로 설정할 수 있다.

container_name: my-web-container

도커 컨테이너는 반드시 unique해야하기 때문에 만약 컨테이너 이름을 설정했을 경우에는 해당 이미지의 컨테이너를 여러 개 만들 수 없다. 그 결과는 에러를 일으킬 것이다.

---

depends_on

서비스(컨테이너) 간의 dependency를 표현한다. service dependencies 는 다음과 같은 행동을 유발한다.

• docker-compose up 은 dependency order로 서비스들을 실행한다.
• docker-compose up SERVICE 는 자동으로 SERVICE's dependencies 들을 포함한다. 👻
• docker-compose stop 은 의존성 순서에 맞춰서 서비스들을 종료시킨다.

version: "3.9"
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

---

volumes

데이터를 컨테이너에 저장하는 것이 아니라 호스트(컨테이너를 띄운 컴퓨터)에 저장하는 방식.

• 컨테이너 재 실행시 데이터가 초기화되는 것을 방지함.

볼륨은 host의 경로 또는 named volumes를 한 서비스의 sub-option으로 지정하는 configuration이다.

우리는 single service(컨테이너)의 part of a definition으로 host path를 지정할 수있고, 이 경우에는 top level volumes 키에는 경로를 지정할 필요가 없다.

그런데 우리가 multiple services들을 모두 이용하는 volume 을 지정하고 싶을 경우에는 그 named volume을 top level volumes 에 명시를 해주어야한다.

version: "3.9"
services:
  web:
    image: nginx:alpine
    volumes:
      - type: volume
        source: mydata
        target: /data
        volume:
          nocopy: true
      - type: bind
        source: ./static
        target: /opt/app/static

  db:
    image: postgres:latest
    volumes:
      - "/var/run/postgres/postgres.sock:/var/run/postgres/postgres.sock"
      - "dbdata:/var/lib/postgresql/data"

volumes:
  mydata:
  dbdata:

• short syntax

    volumes:
      # Just specify a path and let the Engine create a volume
      - /var/lib/mysql

      # Specify an absolute path mapping
      - /opt/data:/var/lib/mysql

      # Path on the host, relative to the Compose file
      - ./cache:/tmp/cache

      # User-relative path
      - ~/configs:/etc/configs/:ro

      # Named volume
      - datavolume:/var/lib/mysql

• long syntax

  • type: the mount type volume, bind, tmpfs or npipe

    Docker 컨테이너에 데이터 저장 (볼륨/바인드 마운트)

  • source: the source of the mount, a path on the host for a bind mount, or the name of a volume defined in the top-level volumes key. Not applicable for a tmpfs mount.

  • target: the path in the container where the volume is mounted

  • read_only: flag to set the volume as read-only

  • bind: configure additional bind options

    • propagation: the propagation mode used for the bind

  • volume: configure additional volume options

    • nocopy: flag to disable copying of data from a container when a volume is created

  • tmpfs: configure additional tmpfs options

    • size: the size for the tmpfs mount in bytes