如何編寫最佳的Dockerfile

Fundebug發表於2017-05-22
Docker

譯者按: Dockerfile 的語法非常簡單，然而如何加快映象構建速度，如何減少 Docker 映象的大小卻不是那麼直觀，需要積累實踐經驗。這篇部落格可以幫助你快速掌握編寫 Dockerfile 的技巧。

本文采用意譯，版權歸原作者所有

我已經使用 Docker 有一段時間了，其中編寫 Dockerfile 是非常重要的一部分工作。在這篇部落格中，我打算分享一些建議，幫助大家編寫更好的 Dockerfile。

目標:

  • 更快的構建速度
  • 更小的 Docker 映象大小
  • 更少的 Docker 映象層
  • 充分利用映象快取
  • 增加 Dockerfile 可讀性
  • 讓 Docker 容器使用起來更簡單

總結

  • 編寫.dockerignore 檔案
  • 容器只執行單個應用
  • 將多個 RUN 指令合併為一個
  • 基礎映象的標籤不要用 latest
  • 每個 RUN 指令後刪除多餘檔案
  • 選擇合適的基礎映象(alpine 版本最好)
  • 設定 WORKDIR 和 CMD
  • 使用 ENTRYPOINT (可選)
  • 在 entrypoint 指令碼中使用 exec
  • COPY 與 ADD 優先使用前者
  • 合理調整 COPY 與 RUN 的順序
  • 設定預設的環境變數，對映埠和資料卷
  • 使用 LABEL 設定映象後設資料
  • 新增 HEALTHCHECK

示例

示例 Dockerfile 犯了幾乎所有的錯(當然我是故意的)。接下來，我會一步步優化它。假設我們需要使用 Docker 執行一個 Node.js 應用，下面就是它的 Dockerfile(CMD 指令太複雜了，所以我簡化了，它是錯誤的，僅供參考)。

FROM ubuntu

ADD . /app

RUN apt-get update
RUN apt-get upgrade -y
RUN apt-get install -y nodejs ssh mysql
RUN cd /app && npm install

# this should start three processes, mysql and ssh
# in the background and node app in foreground
# isn't it beautifully terrible? <3
CMD mysql & sshd & npm start
複製程式碼

構建映象:

docker build -t wtf .
複製程式碼

1. 編寫.dockerignore 檔案

構建映象時，Docker 需要先準備context ，將所有需要的檔案收集到程式中。預設的context包含 Dockerfile 目錄中的所有檔案，但是實際上，我們並不需要.git 目錄，node_modules 目錄等內容。 .dockerignore 的作用和語法類似於 .gitignore，可以忽略一些不需要的檔案，這樣可以有效加快映象構建時間，同時減少 Docker 映象的大小。示例如下:

.git/
node_modules/
複製程式碼

2. 容器只執行單個應用

從技術角度講，你可以在 Docker 容器中執行多個程式。你可以將資料庫，前端，後端，ssh，supervisor 都執行在同一個 Docker 容器中。但是，這會讓你非常痛苦:

  • 非常長的構建時間(修改前端之後，整個後端也需要重新構建)
  • 非常大的映象大小
  • 多個應用的日誌難以處理(不能直接使用 stdout，否則多個應用的日誌會混合到一起)
  • 橫向擴充套件時非常浪費資源(不同的應用需要執行的容器數並不相同)
  • 殭屍程式問題 - 你需要選擇合適的 init 程式

因此，我建議大家為每個應用構建單獨的 Docker 映象，然後使用 Docker Compose 執行多個 Docker 容器。

現在，我從 Dockerfile 中刪除一些不需要的安裝包，另外，SSH 可以用docker exec替代。示例如下：

FROM ubuntu

ADD . /app

RUN apt-get update
RUN apt-get upgrade -y

# we should remove ssh and mysql, and use
# separate container for database
RUN apt-get install -y nodejs  # ssh mysql
RUN cd /app && npm install

CMD npm start
複製程式碼

3. 將多個 RUN 指令合併為一個

Docker 映象是分層的，下面這些知識點非常重要:

  • Dockerfile 中的每個指令都會建立一個新的映象層。
  • 映象層將被快取和複用
  • 當 Dockerfile 的指令修改了，複製的檔案變化了，或者構建映象時指定的變數不同了，對應的映象層快取就會失效
  • 某一層的映象快取失效之後，它之後的映象層快取都會失效
  • 映象層是不可變的，如果我們再某一層中新增一個檔案，然後在下一層中刪除它，則映象中依然會包含該檔案(只是這個檔案在 Docker 容器中不可見了)。

Docker 映象類似於洋蔥。它們都有很多層。為了修改內層，則需要將外面的層都刪掉。記住這一點的話，其他內容就很好理解了。

現在，我們將所有的RUN指令合併為一個。同時把apt-get upgrade刪除，因為它會使得映象構建非常不確定(我們只需要依賴基礎映象的更新就好了)

FROM ubuntu

ADD . /app

RUN apt-get update \
    && apt-get install -y nodejs \
    && cd /app \
    && npm install

CMD npm start
複製程式碼

記住一點，我們只能將變化頻率一樣的指令合併在一起。將 node.js 安裝與 npm 模組安裝放在一起的話，則每次修改原始碼，都需要重新安裝 node.js，這顯然不合適。因此，正確的寫法是這樣的:

FROM ubuntu

RUN apt-get update && apt-get install -y nodejs
ADD . /app
RUN cd /app && npm install

CMD npm start
複製程式碼

4. 基礎映象的標籤不要用 latest

當映象沒有指定標籤時，將預設使用latest 標籤。因此， FROM ubuntu 指令等同於FROM ubuntu:latest。當時，當映象更新時，latest 標籤會指向不同的映象，這時構建映象有可能失敗。如果你的確需要使用最新版的基礎映象，可以使用 latest 標籤，否則的話，最好指定確定的映象標籤。

示例 Dockerfile 應該使用16.04作為標籤。

FROM ubuntu:16.04  # it's that easy!

RUN apt-get update && apt-get install -y nodejs
ADD . /app
RUN cd /app && npm install

CMD npm start
複製程式碼

5. 每個 RUN 指令後刪除多餘檔案

假設我們更新了 apt-get 源，下載，解壓並安裝了一些軟體包，它們都儲存在/var/lib/apt/lists/目錄中。但是，執行應用時 Docker 映象中並不需要這些檔案。我們最好將它們刪除，因為它會使 Docker 映象變大。

示例 Dockerfile 中，我們可以刪除/var/lib/apt/lists/目錄中的檔案(它們是由 apt-get update 生成的)。

FROM ubuntu:16.04

RUN apt-get update \
    && apt-get install -y nodejs \
    # added lines
    && rm -rf /var/lib/apt/lists/*

ADD . /app
RUN cd /app && npm install

CMD npm start
複製程式碼

6. 選擇合適的基礎映象(alpine 版本最好)

在示例中，我們選擇了ubuntu作為基礎映象。但是我們只需要執行 node 程式，有必要使用一個通用的基礎映象嗎？node映象應該是更好的選擇。

FROM node

ADD . /app
# we don't need to install node
# anymore and use apt-get
RUN cd /app && npm install

CMD npm start
複製程式碼

更好的選擇是 alpine 版本的node映象。alpine 是一個極小化的 Linux 發行版，只有 4MB，這讓它非常適合作為基礎映象。

FROM node:7-alpine

ADD . /app
RUN cd /app && npm install

CMD npm start
複製程式碼

apk是 Alpine 的包管理工具。它與apt-get有些不同，但是非常容易上手。另外，它還有一些非常有用的特性，比如no-cache和 --virtual選項，它們都可以幫助我們減少映象的大小。

7. 設定 WORKDIR 和 CMD

WORKDIR指令可以設定預設目錄，也就是執行RUN / CMD / ENTRYPOINT指令的地方。

CMD指令可以設定容器建立是執行的預設命令。另外，你應該講命令寫在一個陣列中，陣列中每個元素為命令的每個單詞(參考官方文件)。

FROM node:7-alpine

WORKDIR /app
ADD . /app
RUN npm install

CMD ["npm", "start"]
複製程式碼

8. 使用 ENTRYPOINT (可選)

ENTRYPOINT指令並不是必須的，因為它會增加複雜度。ENTRYPOINT是一個指令碼，它會預設執行，並且將指定的命令錯誤其引數。它通常用於構建可執行的 Docker 映象。entrypoint.sh 如下:

#!/usr/bin/env sh
# $0 is a script name,
# $1, $2, $3 etc are passed arguments
# $1 is our command
CMD=$1

case "$CMD" in
  "dev" )
    npm install
    export NODE_ENV=development
    exec npm run dev
    ;;

  "start" )
    # we can modify files here, using ENV variables passed in
    # "docker create" command. It can't be done during build process.
    echo "db: $DATABASE_ADDRESS" >> /app/config.yml
    export NODE_ENV=production
    exec npm start
    ;;

   * )
    # Run custom command. Thanks to this line we can still use
    # "docker run our_image /bin/bash" and it will work
    exec $CMD ${@:2}
    ;;
esac
複製程式碼

示例 Dockerfile:

FROM node:7-alpine

WORKDIR /app
ADD . /app
RUN npm install

ENTRYPOINT ["./entrypoint.sh"]
CMD ["start"]
複製程式碼

可以使用如下命令執行該映象:

# 執行開發版本
docker run our-app dev

# 執行生產版本
docker run our-app start

# 執行bash
docker run -it our-app /bin/bash
複製程式碼

9. 在 entrypoint 指令碼中使用 exec

在前文的 entrypoint 指令碼中，我使用了exec命令執行 node 應用。不使用exec的話，我們則不能順利地關閉容器，因為 SIGTERM 訊號會被 bash 指令碼程式吞沒。exec命令啟動的程式可以取代指令碼程式，因此所有的訊號都會正常工作。

10. COPY 與 ADD 優先使用前者

COPY指令非常簡單，僅用於將檔案拷貝到映象中。ADD相對來講複雜一些，可以用於下載遠端檔案以及解壓壓縮包(參考官方文件)。

FROM node:7-alpine

WORKDIR /app

COPY . /app
RUN npm install

ENTRYPOINT ["./entrypoint.sh"]
CMD ["start"]
複製程式碼

11. 合理調整 COPY 與 RUN 的順序

我們應該把變化最少的部分放在 Dockerfile 的前面，這樣可以充分利用映象快取。

示例中，原始碼會經常變化，則每次構建映象時都需要重新安裝 NPM 模組，這顯然不是我們希望看到的。因此我們可以先拷貝package.json，然後安裝 NPM 模組，最後才拷貝其餘的原始碼。這樣的話，即使原始碼變化，也不需要重新安裝 NPM 模組。

FROM node:7-alpine

WORKDIR /app

COPY package.json /app
RUN npm install
COPY . /app

ENTRYPOINT ["./entrypoint.sh"]
CMD ["start"]
複製程式碼

12. 設定預設的環境變數，對映埠和資料卷

執行 Docker 容器時很可能需要一些環境變數。在 Dockerfile 設定預設的環境變數是一種很好的方式。另外，我們應該在 Dockerfile 中設定對映埠和資料卷。示例如下:

FROM node:7-alpine

ENV PROJECT_DIR=/app

WORKDIR $PROJECT_DIR

COPY package.json $PROJECT_DIR
RUN npm install
COPY . $PROJECT_DIR

ENV MEDIA_DIR=/media \
    NODE_ENV=production \
    APP_PORT=3000

VOLUME $MEDIA_DIR
EXPOSE $APP_PORT

ENTRYPOINT ["./entrypoint.sh"]
CMD ["start"]
複製程式碼

ENV指令指定的環境變數在容器中可以使用。如果你只是需要指定構建映象時的變數，你可以使用ARG指令。

13. 使用 LABEL 設定映象後設資料

使用LABEL指令，可以為映象設定後設資料，例如映象建立者或者映象說明。舊版的 Dockerfile 語法使用MAINTAINER指令指定映象建立者，但是它已經被棄用了。有時，一些外部程式需要用到映象的後設資料，例如nvidia-docker需要用到com.nvidia.volumes.needed。示例如下:

FROM node:7-alpine
LABEL maintainer "jakub.skalecki@example.com"
...
複製程式碼

14. 新增 HEALTHCHECK

執行容器時，可以指定--restart always選項。這樣的話，容器崩潰時，Docker 守護程式(docker daemon)會重啟容器。對於需要長時間執行的容器，這個選項非常有用。但是，如果容器的確在執行，但是不可(陷入死迴圈，配置錯誤)用怎麼辦？使用HEALTHCHECK指令可以讓 Docker 週期性的檢查容器的健康狀況。我們只需要指定一個命令，如果一切正常的話返回 0，否則返回 1。對 HEALTHCHECK 感興趣的話，可以參考這篇部落格。示例如下:

FROM node:7-alpine
LABEL maintainer "jakub.skalecki@example.com"

ENV PROJECT_DIR=/app
WORKDIR $PROJECT_DIR

COPY package.json $PROJECT_DIR
RUN npm install
COPY . $PROJECT_DIR

ENV MEDIA_DIR=/media \
    NODE_ENV=production \
    APP_PORT=3000

VOLUME $MEDIA_DIR
EXPOSE $APP_PORT
HEALTHCHECK CMD curl --fail http://localhost:$APP_PORT || exit 1

ENTRYPOINT ["./entrypoint.sh"]
CMD ["start"]
複製程式碼

當請求失敗時，curl --fail 命令返回非 0 狀態。

關於Fundebug

Fundebug專注於JavaScript、微信小程式、微信小遊戲、支付寶小程式、React Native、Node.js和Java線上應用實時BUG監控。 自從2016年雙十一正式上線，Fundebug累計處理了10億+錯誤事件，付費客戶有Google、360、金山軟體、百姓網等眾多品牌企業。歡迎大家免費試用！

如何編寫最佳的Dockerfile

版權宣告

轉載時請註明作者Fundebug以及本文地址： blog.fundebug.com/2017/05/15/…

相關文章