docker-compose.ymlの書き方を実例付きで解説

（最終更新月：2023年8月）

✔当記事は以下のような方におすすめの記事です

「docker-compose.ymlの機能について詳しく知りたい」

「docker-compose.ymlの設定方法を見つけたい」

「docker-compose.ymlの具体的な使用例を探している」

✔当記事でご紹介する内容

docker-compose.ymlの基本概念
docker-compose.ymlの作成手順とその活用法
docker-compose.ymlを使った実例

当記事では、docker-compose.ymlの基本理解から、詳細な設定方法、そしてより効果的に活用するための手法まで、具体的な例を交えて詳細に解説します。

ぜひ記事の最後までお読みください。

筆者プロフィール

【現職】プロダクトマネージャー

【副業】ブログ（月間20万PV）/YouTube/Web・アプリ制作

「プログラミング × ライティング × 営業」の経験を活かし、30後半からのIT系職へシフト。現在はプロダクトマネージャーとして、さまざまな関係者の間に入り奮闘してます。当サイトでは、実際に手を動かせるWebアプリの開発を通じて、プログラミングはもちろん、IT職に必要な情報を提供していきます。

【当ブログで紹介しているサイト】

当サイトチュートリアルで作成したデモ版日報アプリ

Django × Reactで開発したツール系Webアプリ

✔人に見せても恥ずかしくないコードを書こう

「リーダブルコード」は、わかりやすく良いコードの定義を教えてくれる本です。

見るからにきれいなコードの書き方
コードの分割方法
変数や関数の命名規則

エンジニアのスタンダートとすべき基準を一から解説しています。

何回も読むのに値する本なので、ぜひ手にとって読んでみてください。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック

created by Rinker

¥2,640 (2024/11/23 13:53:32時点 Amazon調べ-詳細)

DockerとDocker Compose

こちらでは、Docker Composeの基本についてお伝えしていきます。

Docker Composeの主な機能を学習することは、ymlファイルの理解にも繋がるでしょう。

Docker Composeの主な機能
docker-compose.ymlの利点と効果

Docker Composeの主な機能

Docker Composeは、マルチコンテナDockerアプリケーションの定義と実行を容易にするツールです。

複数のサービスを連携させたアプリケーションを一度に構築・起動できます。

以下は、Docker Composeを起動するコマンドです。

docker-compose up

このシンプルなコマンドで、定義されたサービス、ネットワーク、ボリュームなどが一括で起動します。

docker-compose.ymlの利点と効果

docker-compose.ymlは、Docker Composeの構成ファイル。

中には、サービスやネットワーク、ボリュームの設定が記述されます。

このファイルの利用により、コンテナ化されたアプリケーションの構築と実行が一元化されるのです。

version: '3'
services:
  web:
    build: .
    ports:
      - "5000:5000"

この記述により、Docker Composeがwebサービスを構築してポート5000で公開することを理解し、実行します。

Docker Compose ymlの定義と概要

こちらでは、docker-compose.ymlの基本的な理解と、記載される要素の解説についてお伝えしていきます。

docker-compose.ymlの基本理解
docker-compose.ymlに記載される要素の解説

docker-compose.ymlの基本的理解

docker-compose.ymlは、YAMLフォーマットで書かれ、コンテナのサービスやネットワーク、ボリュームの構成を定義するものです。

このファイルによって、複雑なコマンドの代わりにシンプルな記述でサービスを管理できます。

version: '3'
services:
  db:
    image: postgres:latest

必要なバージョンとサービスのイメージを指定して管理します。

docker-compose.ymlに記載される要素の解説

docker-compose.ymlファイルには、以下のような主要なセクションが含まれます。

バージョン
サービス
ネットワーク
ボリューム

各セクションで特定の属性や設定が定義されることで、アプリケーションの動作が決定されます。

以下のようにサービス内でビルドのパスやポートの設定が可能です。

services:
  web:
    build: ./web
    ports:
      - "8000:8000"

この記述により、webサービスが指定したパスからビルドされ、指定したポートで公開されます。

docker-compose.ymlでよく使う要素とその意味

こちらでは、docker-compose.ymlでよく使われる要素とその意味について詳しくお伝えしていきます。

Version: バージョンについて
Services: サービス設定とは
各種サービス設定要素の解説 (build、container_name, image等)
具体的なサービス設定のサンプルコード

Version: バージョンについて

versionキーを使用することで、Docker Composeのファイルフォーマットバージョンを指定できます。

バージョンによって利用可能な機能が異なるため、注意が必要です。

version: '3.8'

バージョン3.8のファイルフォーマットを使用することを明示しています。

Services: サービス設定とは

docker-compose.ymlのservicesセクションでは、コンテナ化する各サービスの設定が記述されます。

ここで定義されたサービスは、docker-compose upコマンドで一括して起動されるものです。

services:
  web:
    image: nginx
  db:
    image: postgres

この例では、webとdbの2つのサービスが定義され、それぞれのイメージが指定されています。

各種サービス設定要素の解説

サービス設定には、さまざまな属性があります。

以下、主要な属性の例です。

services:
  web:
    build: ./web
    container_name: myweb
    image: nginx:latest
    ports:
      - "8080:80"

上記のファイルでは、以下のような設定がされています。

build: コンテナのビルドパスを指定
container_name: コンテナの名前を指定
image: 使用するイメージを指定
ports: ホストとコンテナのポートのマッピング

具体的なサービス設定のサンプルコード

実際のプロジェクトでは、複数のサービス設定要素を組み合わせて使用します。

以下は、具体的なサンプルコードの例です。

version: '3'
services:
  app:
    build: ./app
    volumes:
      - .:/app
    depends_on:
      - db
  db:
    image: postgres:latest
    environment:
      POSTGRES_USER: user
      POSTGRES_PASSWORD: pass

appサービスとdbサービスの連携を示しており、ボリュームや依存関係、環境変数などの設定が含まれています。

docker-compose.ymlの詳細設定

こちらでは、docker-compose.ymlでの詳細設定についてお伝えしていきます。

ボリューム設定
ネットワーク設定

ボリューム設定：driver, driver_optsなど

ボリューム設定では、永続データの保存や共有を実現します。

driverやdriver_optsを用いて、ボリュームの種類やオプションの設定が可能です。

volumes:
  my-volume:
    driver: local
    driver_opts:
      type: nfs
      o: addr=10.10.10.10,rw
      device: ":/path/to/dir"

この設定で、指定したアドレスとパスにあるNFSをローカルボリュームとしてマウントします。

ネットワーク設定：driverなど

ネットワーク設定は、コンテナ間の通信を制御するものです。

さまざまなネットワークドライバとオプションを設定できます。

networks:
  my-network:
    driver: bridge
    ipam:
      driver: default
      config:
        - subnet: 172.28.0.0/16

この設定で、ブリッジドライバを使用してサブネットを定義したカスタムネットワークを作成します。

docker-compose.ymlを活用した実践例

こちらでは、docker-compose.ymlを活用した実例をお伝えしていきます。

Webアプリケーションのデプロイ
docker-compose.ymlを使ったさまざまなケーススタディ

Webアプリケーションのデプロイ

docker-compose.ymlを使って、実際にWebアプリケーションをデプロイする例を以下に示します。

version: '3'
services:
  web:
    image: nginx:latest
    ports:
      - "80:80"
  app:
    build: ./app
    depends_on:
      - db
  db:
    image: postgres:latest

Nginxに関する以下3つのサービスを連携してデプロイします。