Compose ファイル・リファレンス¶

build¶

構築時に適用するオプションを指定します。

build で指定できるのは、構築用コンテクストのパスを含む文字列だけでなく、 context の配下にある特定の物（オブジェクト）や、 dockerfile のオプションと 引数 を指定できます。

build: ./dir

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

build だけでなく image も指定できます。 Compose は image で指定したタグを使い、構築したイメージをタグ付けします。

build: ./dir
image: webapp

これは ./dir で構築したイメージを webapp としてタグ付けしています。

context¶

コンテクスト（訳者注：内容物の意味）には Dockerfile があるディレクトリのパスや Git リポジトリの URL を指定します。

値に相対パスを指定したら、Compose ファイルのある場所を基準とした相対パスとして解釈します。また、指定したディレクトリが構築コンテクストとなり、Docker デーモンに送信します。

Compose は生成時の名前で構築・タグ付けし、それがイメージとなります。

build:
  context: ./dir

dockerfile¶

Dockerfile の代わりになるものです。

Compose は構築時に別のファイルを使えます。構築時のパスも指定する必要があります。

build:
  context: .
  dockerfile: Dockerfile-alternate

args¶

構築時に build のオプション（args）を追加します。配列でも辞書形式（訳者注：「foo=bar」の形式）も指定できます。ブール演算子（true、false、yes、no）を使う場合はクォートで囲む必要があります。そうしませんと YAML パーサは True か False か判別できません。

構築時に引数のキーとして解釈する環境変数の値は、Compose を実行するマシン上のみです。

build:
  args:
    buildno: 1
    user: someuser

build:
  args:
    - buildno=1
    - user=someuser

cap_add, cap_drop¶

コンテナのケーパビリティ（capabilities）を追加・削除します。ケーパビリティの一覧は man 7 capabilities をご覧ください。

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

command¶

デフォルトのコマンドを上書きします。

command: bundle exec thin -p 3000

これは Dockerfile の書き方に似せることもできます。

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

cgroup_parent¶

コンテナに対し、オプションの親グループを指定します。

cgroup_parent: m-executor-abcd

container_name¶

デフォルトで生成される名前の代わりに、カスタム・コンテナ名を指定します。

container_name: my-web-container

Docker コンテナ名はユニークである必要があります。そのため、カスタム名を指定時、サービスは複数のコンテナにスケールできなくなります。

devices¶

デバイス・マッピングの一覧を表示します。docker クライアントで作成する際の --device と同じ形式を使います。

devices:
  - "/dev/ttyUSB0:/dev/ttyUSB0"

depends_on¶

サービス間の依存関係を指定したら、２つの効果があります。

• docker-compose up を実行したら、依存関係のある順番に従ってサービスを起動します。以下の例では、 web を開始する前に db と rails を実行します。

• docker-compose up サービス（の名称） を実行したら、自動的に サービス の依存関係を処理します。以下の例では、 docker-compose up web を実行したら、 db と redis も作成・起動します。

簡単なサンプル：

version: '2'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

dns¶

DNS サーバの設定を変更します。単一の値、もしくはリストになります。

dns: 8.8.8.8
dns:
  - 8.8.8.8
  - 9.9.9.9

dns_search¶

DNS の検索ドメインを変更します。単一の値、もしくはリストになります。

dns_search: example.com
dns_search:
  - dc1.example.com
  - dc2.example.com

tmpfs¶

コンテナ内にテンポラリ・ファイルシステムをマウントします。単一の値もしくはリストです。

tmpfs: /run
tmpfs:
  - /run
  - /tmp

entrypoint¶

デフォルトの entrypoint を上書きします。

entrypoint: /code/entrypoint.sh

entrypoint は Dockerfile のように列挙できます。

entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit

env_file¶

ファイル上の定義から環境変数を追加します。単一の値、もしくはリストになります。

Compose ファイルを docker-compose -f ファイル名 で指定する場合は、 env_file ファイルは指定したディレクトリに対する相対パスとみなします。

環境変数で指定されている値は、 environment で上書きできます。

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

Compose は各行を 変数=値 の形式とみなします。 # で始まる行（例：コメント）は無視され、空白行として扱います。

# Rails/Rack 環境変数を設定
RACK_ENV=development

environment¶

環境変数を追加します。配列もしくは辞書形式（dictionary）で指定できます。boolean 値は true、false、yes、no のいずれかであり、YML パーサによって True か False に変換されるよう、クォート（ ‘ 記号）で囲む必要があります。

キーだけの環境変数は、Compose の実行時にマシン上で指定するものであり、シークレット（訳注：API鍵などの秘密情報）やホスト固有の値を指定するのに便利です。

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

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

expose¶

ホストマシン上で公開するポートを指定せずに、コンテナの公開（露出）用のポート番号を指定します。これらはリンクされたサービス間でのみアクセス可能になります。内部で使うポートのみ指定できます。

expose:
 - "3000"
 - "8000"

extends¶

現在のファイルから別のファイルにサービスを拡張するもので、設定のオプションを追加します。

他の設定用のキーと一緒にサービスを extends （拡張）できます。 extends 値には service の定義が必要であり、オプションで file キーを指定します。

extends:
  file: common.yml
  service: webapp

サービスを拡張する service の名前とは、たとえば web や database です。 file はサービスを定義する Compose 設定ファイルの場所です。

file を省略したら、Compose は現在の設定ファイル上からサービスの定義を探します。 file の値は相対パスまたは絶対パスです。相対パスを指定したら、Compose はその場所を、現在のファイルからの相対パスとして扱います。

自分自身を他に対して拡張するサービス定義ができます。拡張は無限に可能です。Compose は循環参照をサポートしておらず、もし循環参照があれば docker-compose はエラーを返します。

extends に関するより詳細は、 extends ドキュメント をご覧ください。

external_links¶

対象の docker-compose.yml の外にあるコンテナだけでなく、Compose の外にあるコンテナとリンクします。特に、コンテナが共有サービスもしくは一般的なサービスを提供している場合に有用です。 external_links でコンテナ名とエイリアスを指定すると（ コンテナ名:エイリアス名 ）、 link のように動作します。

external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql

extra_hosts¶

ホスト名を割り当てます。これは docker クライアントで --add-host パラメータを使うのと同じものです。

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

コンテナ内の /etc/hosts に IP アドレスとホスト名のエントリが追加されます。例：

162.242.195.82  somehost
50.31.209.229   otherhost

image¶

コンテナを実行時に元となるイメージを指定します。リポジトリ名・タグあるいはイメージ ID の一部を指定できます。

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd

イメージが存在していなければ、Compose は pull （取得）を試みます。しかし build を指定している場合は除きます。その場合、指定されたタグやオプションを使って構築します。

labels¶

Docker ラベル を使いコンテナにメタデータを追加します。配列もしくは辞書形式で追加できます。

他のソフトウェアとラベルが競合しないようにするため、DNS 逆引き記法の利用を推奨します。

labels:
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""

labels:
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"

links¶

コンテナを他のサービスとリンクします。サービス名とリンク用エイリアスの両方を指定できます（ サービス名:エイリアス名 ）。あるいはサービス名だけの指定もできます（このサービス名はエイリアス名としても使われます）。

links:
 - db
 - db:database
 - redis

リンクするサービスのコンテナは、エイリアスとして認識できるホスト名で到達（接続）可能になります。エイリアスが指定されなければ、サービス名で到達できます。

また、サービス間の依存関係は depends_on を使っても同様に指定できますし、サービスを起動する順番も指定できます。

サービスに対してログ記録の設定をします。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

driver にはコンテナのサービスに使うロギング・ドライバを指定します。これは docker run コマンドにおける --log-driver オプションと同じです （ ドキュメントはこちら ）。

デフォルトの値は json-file です。

driver: "json-file"
driver: "syslog"
driver: "none"

ロギング・ドライバのオプションを指定するには options キーを使います。これは docker run コマンド実行時の --log-opt オプションと同じです。

ロギングのオプションはキーバリューのペアです。以下は syslog オプションを指定する例です。

driver: "syslog"
options:
  syslog-address: "tcp://192.168.0.42:123"

log_driver¶

ログ・ドライバを指定します。デフォルトは json-file（JSON ファイル形式）です。

log_driver: "syslog"

log_opt¶

ログ記録のオプション、キー・バリューのペアで指定します。次の例は syslog のオプションです。

log_opt:
  syslog-address: "tcp://192.168.0.42:123"

net¶

ネットワーク・モードを指定します。これは docker クライアントで --net パラメータを指定するのと同じものです。コンテナ名や ID の代わりに、 container:... で指定した名前が使えます。

net: "bridge"
net: "none"
net: "host"
net: "container:[サービス名かコンテナ名/id]"

network_mode¶

ネットワーク・モードです。 docker クライアントで --net パラメータを使うのと同じ働きですが、 サービス:[サービス名] の形式で指定します。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

networks¶

ネットワークに参加する時、トップ・レベルの network キー のエントリを参照します。

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

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

version: '2'

services:
  web:
    build: ./web
    networks:
      - new

  worker:
    build: ./worker
    networks:
    - legacy

  db:
    image: mysql
    networks:
      new:
        aliases:
          - database
      legacy:
        aliases:
          - mysql

networks:
  new:
  legacy:

IPv4 アドレス、IPv6 アドレス¶

サービスをネットワークに追加する時、コンテナに対して静的な IP アドレスを割り当てます。

トップレベルのネットワーク・セクション では、適切なネットワーク設定に ipam ブロックが必要です。ここで各静的アドレスが扱うサブネットやゲートウェイを定義します。 IPv6 アドレスが必要であれば、 com.docker.network.enable_ipv6 ドライバ・オプションを true にする必要があります。

例：

version: '2'

services:
  app:
    image: busybox
    command: ifconfig
    networks:
      app_net:
        ipv4_address: 172.16.238.10
        ipv6_address: 2001:3984:3989::10

networks:
  app_net:
    driver: bridge
    driver_opts:
      com.docker.network.enable_ipv6: "true"
    ipam:
      driver: default
      config:
      - subnet: 172.16.238.0/24
        gateway: 172.16.238.1
      - subnet: 2001:3984:3989::/64
        gateway: 2001:3984:3989::1

pid¶

pid: "host"

PID モードはホストの PID モードを設定します。有効化したら、コンテナとホスト・オペレーティング・システム間で PID アドレス空間を共有します。コンテナにこのフラグを付けて起動したら、他のコンテナからアクセスできるだけでなく、ベアメタル・マシン上の名前空間などから操作できるようになります。

ports¶

公開用のポートです。ホスト側とコンテナ側の両方のポートを指定（ ホスト側:コンテナ側 ）できるだけでなく、コンテナ側のポートのみも指定できます（ホスト側はランダムなポートが選ばれます）。

ports:
 - "3000"
 - "3000-3005"
 - "8000:8000"
 - "9090-9091:8080-8081"
 - "49100:22"
 - "127.0.0.1:8001:8001"
 - "127.0.0.1:5000-5010:5000-5010"

security_opt¶

各コンテナに対するデフォルトのラベリング・スキーマ（labeling scheme）を上書きします。

security_opt:
  - label:user:USER
  - label:role:ROLE

stop_signal¶

コンテナに対して別の停止シグナルを設定します。デフォルトでは stop で SIGTERM を使います。 stop_signal で別のシグナルを指定したら、 stop 実行時にそのシグナルを送信します。

stop_signal: SIGUSR1

ulimits¶

コンテナのデフォルト ulimits を上書きします。単一の整数値で上限を指定できるだけでなく、ソフト／ハード・リミットの両方も指定できます。

ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000

volumes, volume_driver¶

マウント・パスまたは名前を付けたボリュームは、オプションでホストマシン（ ホスト:コンテナ ）上のパス指定や、アクセス・モード（ ホスト:コンテナ:rw ） を指定できます。 バージョン２のファイル では名前を付けたボリュームを使うにはトップ・レベルの volumes キー を指定する必要があります。 バージョン１ の場合は、ボリュームが存在していなければ Docker Engine が自動的に作成します。

ホスト上の相対パスをマウント可能です。相対パスは Compose 設定ファイルが使っているディレクトリを基準とします。相対パスは . または .. で始まります。

volumes:
  # パスを指定したら、Engine はボリュームを作成
  - /var/lib/mysql

  # 絶対パスを指定しての割り当て
  - /opt/data:/var/lib/mysql

  # ホスト上のパスを指定する時、Compose ファイルからのパスを指定
  - ./cache:/tmp/cache

  # ユーザの相対パスを使用
  - ~/configs:/etc/configs/:ro

  # 名前付きボリューム（Named volume）
  - datavolume:/var/lib/mysql

ホスト側のパスを指定せず、 volume_driver を指定したい場合があるかもしれません。

volume_driver: mydriver

バージョン２のファイル では、名前付きボリュームに対してドライバを適用できません（ ボリュームを宣言する のではなく、 driver オプションを使ったほうが良いでしょう ）。 バージョン１ の場合は、ドライバを指定すると名前付きボリュームにもコンテナのボリュームにも適用されます。

詳しい情報は Docker ボリューム と ボリューム・プラグイン をご覧ください。

volumes_from¶

他のサービスやコンテナ上のボリュームをマウントします。オプションで、読み込み専用のアクセス（ ro ）や読み書き（ rw ）を指定できます。

volumes_from:
 - service_name
 - service_name:ro
 - container:container_name
 - container:container_name:rw

その他¶

cpu_shares、 cpuset、 domainname、 entrypoint、 hostname、 ipc、 mac_address、 mem_limit、 memswap_limit、 privileged、 read_only、 restart、 stdin_open、 tty、 user、 working_dir は、それぞれ単一の値を持ちます。いずれも docker run コマンドのオプションに対応しています。

cpu_shares: 73
cpu_quota: 50000
cpuset: 0,1

user: postgresql
working_dir: /code

domainname: foo.com
hostname: foo
ipc: host
mac_address: 02:42:ac:11:65:43

mem_limit: 1000000000
memswap_limit: 2000000000
privileged: true

restart: always

read_only: true
stdin_open: true
tty: true

driver¶

ボリューム・ドライバがどのボリュームを使うべきかを指定します。デフォルトは local です。ドライバを指定しなければ、Docker Engine はエラーを返します。

driver: foobar

driver_opts¶

ボリュームが使うドライバに対して、オプションをキーバリューのペアで指定します。これらのオプションはドライバに依存します。オプションの詳細については、各ドライバのドキュメントをご確認ください。

driver_opts:
  foo: "bar"
  baz: 1

driver¶

対象のネットワークが使用するドライバを指定します。

デフォルトでどのドライバを使用するかは Docker Engine の設定に依存します。一般的には単一ホスト上であれば bridge でしょうし、 Swarm 上であれば overlay でしょう。

ドライバが使えなければ、Docker Engine はエラーを返します。

driver: overlay

driver_opts¶

ネットワークが使うドライバに対して、オプションをキーバリューのペアで指定します。これらのオプションはドライバに依存します。オプションの詳細については、各ドライバのドキュメントをご確認ください。

driver_opts:
  foo: "bar"
  baz: 1

ipam:
  driver: default
  config:
    - subnet: 172.28.0.0/16
      ip_range: 172.28.5.0/24
      gateway: 172.28.5.254
      aux_addresses:
        host1: 172.28.1.5
        host2: 172.28.1.6
        host3: 172.28.1.7

version: '2'

services:
  proxy:
    build: ./proxy
    networks:
      - outside
      - default
  app:
    build: ./app
    networks:
      - default

networks:
  outside:
    external: true

networks:
  outside:
    external:
      name: actual-name-of-network

バージョン¶

Compose ファイル形式には２つのバージョンがあります。

• バージョン１は過去のフォーマットです。YAML の冒頭で version キーを指定不要です。
• バージョン２は推奨フォーマットです。YAML の冒頭で version: '2' のエントリを指定します。

プロジェクトをバージョン１からバージョン２に移行する方法は、 アップグレード方法 のセクションをご覧ください。

バージョンごとに異なった制約があります。

• 構造と利用可能な設定キー
• 実行に必要な Docker Engine の最低バージョン
• ネットワーク機能に関する Compose の挙動

これらの違いを、以下で説明します。

web:
  build: .
  ports:
   - "5000:5000"
  volumes:
   - .:/code
  links:
   - redis
redis:
  image: redis

version: '2'
services:
  web:
    build: .
    ports:
     - "5000:5000"
    volumes:
     - .:/code
  redis:
    image: redis

version: '2'
services:
  web:
    build: .
    ports:
     - "5000:5000"
    volumes:
     - .:/code
    networks:
      - front-tier
      - back-tier
  redis:
    image: redis
    volumes:
      - redis-data:/var/lib/redis
    networks:
      - back-tier
volumes:
  redis-data:
    driver: local
networks:
  front-tier:
    driver: bridge
  back-tier:
    driver: bridge

build:
  context: .
  dockerfile: Dockerfile-alternate

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

web:
  links:
    - db
  environment:
    - DB_PORT=tcp://db:5432

net: host    ->  network_mode: host
net: bridge  ->  network_mode: bridge
net: none    ->  network_mode: none

net: "container:web"  ->  network_mode: "service:web"

net: "container:cont-name"  ->  network_mode: "container:cont-name"
net: "container:abc12345"   ->  network_mode: "container:abc12345"

version: '2'
services:
  db:
    image: postgres
    volumes:
      - data:/var/lib/postgresql/data
volumes:
  data: {}

volumes:
  data:
    external: true