サービスの拡張と Compose ファイル¶

複数の Compose ファイル¶

デフォルトでは、Compose は２つのファイルを読み込みます。 docker-compose.yml と、オプションの docker-compose.override.yml （上書き用）ファイルです。慣例として、docker-compose.yml には基本設定を含みます。上書きファイルとは、その名前が暗に示しているように、既存のサービスを新しいサービスに全て置き換えるものです。

もし両方のファイルに定義があれば、Compose は追加された設定の情報でルールを上書きします。

複数の上書きファイルを使いたい場合や、違った名前で上書きしたい場合は、 -f オプションでファイルの一覧を指定可能です。Compose はコマンドライン上で指定した順番で、ファイルを統合します。詳細は docker-compose コマンド・リファレンス の -f に関する情報をご覧ください。

複数の設定ファイルを使う場合、全てのパスはベースになる Compose ファイル（ -f で１番めに指定したファイル）からの相対パスである必要があります。この指定が必要なのは、上書き用のファイルが適切な Compose ファイル形式でなくても構わないからです。上書きファイルは設定の一部だけでも問題ありません。相対パスで指定されたサービス断片の追跡は、難しく、混乱しがちです。そのため、パスが簡単に分かるようにするため、全てのパスの定義を、ベースファイルからの相対パスにする必要があります。

web:
  image: example/my_web_app:latest
  links:
    - db
    - cache

db:
  image: postgres:latest

cache:
  image: redis:latest

web:
  build: .
  volumes:
    - '.:/code'
  ports:
    - 8883:80
  environment:
    DEBUG: 'true'

db:
  command: '-d'
  ports:
    - 5432:5432

cache:
  ports:
    - 6379:6379

web:
  ports:
    - 80:80
  environment:
    PRODUCTION: 'true'

cache:
  environment:
    TTL: '500'

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

web:
  image: example/my_web_app:latest
  links:
    - db

db:
  image: postgres:latest

dbadmin:
  build: database_admin/
  links:
    - db

docker-compose -f docker-compose.yml -f docker-compose.admin.yml \
    run dbadmin db-backup

サービスの拡張¶

Docker Compose の extends （拡張）キーワードは、異なったファイル間で設定を共有できるだけでなく、異なったプロジェクトでも利用可能です。拡張サービスは複数のサービスを持っている場合、一般的な設定オプションの再利用に便利です。 extends を使えば、１箇所だけでなく、どこでも利用可能なサービス・オプションの共通セットを定義できます。

web:
  extends:
    file: common-services.yml
    service: webapp

webapp:
  build: .
  ports:
    - "8000:8000"
  volumes:
    - "/data"

web:
  extends:
    file: common-services.yml
    service: webapp
  environment:
    - DEBUG=1
  cpu_shares: 5

important_web:
  extends: web
  cpu_shares: 10

web:
  extends:
    file: common-services.yml
    service: webapp
  environment:
    - DEBUG=1
  cpu_shares: 5
  links:
    - db
db:
  image: postgres

app:
  build: .
  environment:
    CONFIG_FILE_PATH: /code/config
    API_KEY: xxxyyy
  cpu_shares: 5

webapp:
  extends:
    file: common.yml
    service: app
  command: /code/run_web_app
  ports:
    - 8080:8080
  links:
    - queue
    - db

queue_worker:
  extends:
    file: common.yml
    service: app
  command: /code/run_worker
  links:
    - queue

設定の追加と上書き¶

Compose は本来のサービス設定を、（訳者注：extends を使う時や、複数ファイルの読み込み時に）各所に対してコピー（引き継ぎ）します。もしも、設定オプションが元のサービスと、ローカル（直近の設定）のサービスの両方で定義された場合、ローカルの値は置き換えられるか、元の値を拡張します。

image 、command 、 mem_limit のような単一値のオプションは、古い値が新しい値に置き換わります。

# 元のサービス
command: python app.py

# ローカルのサービス
command: python otherapp.py

# 結果
command: python otherapp.py

build と image の場合、ローカルでサービスの指定があれば、Compose は一方を破棄します。一方がオリジナルのサービスとして定義されている場合でもです。

image が build を置き換える例：

# 元のサービス
build: .

# ローカルのサービス
image: redis

# 結果
image: redis

build がイメージを置き換える例：

# 元のサービス
image: redis

# ローカルのサービス
build: .

# 結果
build: .

複数の値を持つオプション、ports 、 expose 、 external_links 、 dns 、 dns_search 、 tmpfs の場合、Compose は両方の値を連結します。

# 元のサービス
expose:
  - "3000"

# ローカルのサービス
expose:
  - "4000"
  - "5000"

# 結果
expose:
  - "3000"
  - "4000"
  - "5000"

environment 、 label 、volumes 、 devices の場合、Compose はローカルで定義している値を優先して統合します。

# 元のサービス
environment:
  - FOO=original
  - BAR=original

# ローカルのサービス
environment:
  - BAR=local
  - BAZ=local

# 結果
environment:
  - FOO=original
  - BAR=local
  - BAZ=local

Compose のドキュメント¶

• ユーザガイド
• Compose を始めましょう
• クイックスタート・ガイド：Docker Compose と Django
• クイックスタート・ガイド：Docker Compose と Rails
• クイックスタート・ガイド：Docker Compose と Wordpress
• Compose CLI リファレンス
• Compose ファイル・リファレンス