使用 Docker Compose

Docker Compose 是一個幫助您定義和共享多容器應用程式的工具。使用 Compose，您可以建立 YAML 檔案來定義服務，並透過一個命令啟動或解除安裝所有內容。

使用 Compose 的巨大優勢在於，您可以在檔案中定義應用程式堆疊，將其儲存在專案倉庫的根目錄（現在它已進行版本控制），並輕鬆地讓其他人為您的專案做出貢獻。其他人只需要克隆您的倉庫並使用 Compose 啟動應用程式即可。實際上，您現在可能會在 GitHub/GitLab 上看到許多專案都在這樣做。

建立 Compose 檔案

在 getting-started-app 目錄中，建立一個名為 compose.yaml 的檔案。

├── getting-started-app/
│ ├── Dockerfile
│ ├── compose.yaml
│ ├── node_modules/
│ ├── package.json
│ ├── spec/
│ ├── src/
│ └── yarn.lock

定義應用服務

在第 6 部分中，您使用了以下命令來啟動應用程式服務。

$ docker run -dp 127.0.0.1:3000:3000 \
  -w /app -v "$(pwd):/app" \
  --network todo-app \
  -e MYSQL_HOST=mysql \
  -e MYSQL_USER=root \
  -e MYSQL_PASSWORD=secret \
  -e MYSQL_DB=todos \
  node:18-alpine \
  sh -c "yarn install && yarn run dev"

現在您將在 compose.yaml 檔案中定義此服務。

1. 在文字或程式碼編輯器中開啟 compose.yaml，首先定義要作為應用程式一部分執行的第一個服務（或容器）的名稱和映象。該名稱將自動成為網路別名，這在定義 MySQL 服務時會很有用。

   services:
     app:
       image: node:18-alpine

2. 通常，您會看到 command 靠近 image 定義，儘管沒有強制排序要求。將 command 新增到您的 compose.yaml 檔案中。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"

3. 現在透過定義服務的 ports 來遷移命令的 -p 127.0.0.1:3000:3000 部分。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"
       ports:
         - 127.0.0.1:3000:3000

4. 接下來，使用 working_dir 和 volumes 定義來遷移工作目錄（-w /app）和卷對映（-v "$(pwd):/app"）。

   Docker Compose 卷定義的一個優勢是您可以使用當前目錄的相對路徑。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"
       ports:
         - 127.0.0.1:3000:3000
       working_dir: /app
       volumes:
         - ./:/app

5. 最後，您需要使用 environment 鍵遷移環境變數定義。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"
       ports:
         - 127.0.0.1:3000:3000
       working_dir: /app
       volumes:
         - ./:/app
       environment:
         MYSQL_HOST: mysql
         MYSQL_USER: root
         MYSQL_PASSWORD: secret
         MYSQL_DB: todos

定義 MySQL 服務

現在，是時候定義 MySQL 服務了。您用於該容器的命令如下

$ docker run -d \
  --network todo-app --network-alias mysql \
  -v todo-mysql-data:/var/lib/mysql \
  -e MYSQL_ROOT_PASSWORD=secret \
  -e MYSQL_DATABASE=todos \
  mysql:8.0

1. 首先定義新服務並將其命名為 mysql，這樣它就自動獲得了網路別名。同時指定要使用的映象。

   
   services:
     app:
       # The app service definition
     mysql:
       image: mysql:8.0

2. 接下來，定義卷對映。當您使用 docker run 執行容器時，Docker 會自動建立命名卷。但是，在使用 Compose 執行時不會發生這種情況。您需要在頂層 volumes: 部分定義卷，然後在服務配置中指定掛載點。透過只提供卷名，將使用預設選項。

   services:
     app:
       # The app service definition
     mysql:
       image: mysql:8.0
       volumes:
         - todo-mysql-data:/var/lib/mysql
   
   volumes:
     todo-mysql-data:

3. 最後，您需要指定環境變數。

   services:
     app:
       # The app service definition
     mysql:
       image: mysql:8.0
       volumes:
         - todo-mysql-data:/var/lib/mysql
       environment:
         MYSQL_ROOT_PASSWORD: secret
         MYSQL_DATABASE: todos
   
   volumes:
     todo-mysql-data:

此時，您的完整 compose.yaml 應該如下所示

services:
  app:
    image: node:18-alpine
    command: sh -c "yarn install && yarn run dev"
    ports:
      - 127.0.0.1:3000:3000
    working_dir: /app
    volumes:
      - ./:/app
    environment:
      MYSQL_HOST: mysql
      MYSQL_USER: root
      MYSQL_PASSWORD: secret
      MYSQL_DB: todos

  mysql:
    image: mysql:8.0
    volumes:
      - todo-mysql-data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: secret
      MYSQL_DATABASE: todos

volumes:
  todo-mysql-data:

執行應用程式棧

現在您有了 compose.yaml 檔案，您可以啟動您的應用程式了。

1. 首先確保沒有其他容器副本正在執行。使用 docker ps 列出容器，使用 docker rm -f 刪除它們。

2. 使用 docker compose up 命令啟動應用程式棧。新增 -d 標誌以在後臺執行所有內容。

   $ docker compose up -d
   

   當您執行上一個命令時，您應該會看到如下輸出

   Creating network "app_default" with the default driver
   Creating volume "app_todo-mysql-data" with default driver
   Creating app_app_1   ... done
   Creating app_mysql_1 ... done

   您會注意到 Docker Compose 建立了卷和網路。預設情況下，Docker Compose 會自動為應用程式堆疊建立一個網路（這就是為什麼您沒有在 Compose 檔案中定義它的原因）。

3. 使用 docker compose logs -f 命令檢視日誌。您將看到來自每個服務的日誌交錯到一個流中。這在您想要觀察與時間相關的問題時非常有用。-f 標誌會跟蹤日誌，因此會在生成時為您提供即時輸出。

   如果您已經運行了該命令，您將看到如下輸出

   mysql_1  | 2019-10-03T03:07:16.083639Z 0 [Note] mysqld: ready for connections.
   mysql_1  | Version: '8.0.31'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server (GPL)
   app_1    | Connected to mysql db at host mysql
   app_1    | Listening on port 3000

   服務名稱顯示在行首（通常有顏色），以幫助區分訊息。如果您想檢視特定服務的日誌，可以將服務名稱新增到日誌命令的末尾（例如，docker compose logs -f app）。

4. 此時，您應該能夠在瀏覽器中開啟您的應用程式，地址是https://:3000，並看到它正在執行。

在 Docker Desktop Dashboard 中檢視應用棧

如果您檢視 Docker Desktop Dashboard，您會看到一個名為 getting-started-app 的組。這是 Docker Compose 的專案名稱，用於將容器分組在一起。預設情況下，專案名稱就是 compose.yaml 所在目錄的名稱。

如果您展開堆疊，您將看到在 Compose 檔案中定義的兩個容器。名稱也更具描述性，因為它們遵循 - 的模式。因此，您可以很容易地快速檢視哪個容器是您的應用程式，哪個容器是 MySQL 資料庫。

全部解除安裝

當您準備好解除安裝所有內容時，只需執行 docker compose down 或點選 Docker Desktop Dashboard 中整個應用程式的垃圾桶圖示。容器將停止，網路將被刪除。

警告

預設情況下，當您執行 docker compose down 時，您的 compose 檔案中的命名卷不會被刪除。如果您想刪除這些卷，您需要新增 --volumes 標誌。

當您刪除應用程式堆疊時，Docker Desktop Dashboard 不會刪除卷。

摘要

在本節中，您瞭解了 Docker Compose 以及它如何幫助您簡化定義和共享多服務應用程式的方式。

相關資訊

• Compose 概述
• Compose 檔案參考
• Compose CLI 參考

後續步驟

接下來，您將瞭解一些可以用來改進 Dockerfile 的最佳實踐。