2. 程式人生 > >如何編寫最佳的Dockerfile

如何編寫最佳的Dockerfile

阿新 • • 發佈：2018-11-19
.json 優化 鏡像 指定 -c 支付寶 product log dep

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

  • 原文: How to write excellent Dockerfiles

  • 譯者: Fundebug

為了保證可讀性，本文采用意譯而非直譯。另外，本文版權歸原作者所有，翻譯僅用於學習。

我已經使用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 "[email protected]"  
...

14. 添加HEALTHCHECK

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

FROM node:7-alpine  
LABEL maintainer "[email protected]"

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累計處理了7億+錯誤事件，得到了Google、360、金山軟件、百姓網等眾多知名用戶的認可。歡迎免費試用！

技術分享圖片

版權聲明

轉載時請註明作者Fundebug以及本文地址：
https://blog.fundebug.com/2017/05/15/write-excellent-dockerfile/

如何編寫最佳的Dockerfile

相關推薦

如何編寫最佳的Dockerfile

.json 優化 鏡像 指定 -c 支付寶 product log dep 譯者按: Dockerfile的語法非常簡單，然而如何加快鏡像構建速度，如何減少Docker鏡像的大小卻不是那麽直觀，需要積累實踐經驗。這篇博客可以幫助你快速掌握編寫Dockerfile的技巧。

【轉】編寫最佳的Dockerfile的實踐

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

編寫 Dockerfile 的五個最佳實踐

此文適合Docker初學入門讀者，大師請繞行！，遵守最佳實踐可少踩坑、提升效能體驗及可移植性，期望對讀者有所幫助！ 什麼是Dockerfile Dockerfile 是一個文字檔案，裡面包含了打包Docker映象所需要用到的命令。Docker 可以通

編寫 Dockerfile 最佳實踐

route container contain ima pos clone c-c++ sta 如何 官方倉庫雖然有數十萬計的免費鏡像，但大多數無法直接滿足公司業務需求，這就需要我們自己去定制鏡像了。 Docker通過Dockerfile自動構建鏡像，Dockerfile是

編寫dockerfile

文件 其中 virtual per lba port ecb ports root 參考：http://www.cnblogs.com/liuyansheng/p/6098470.html 一、dockerfile介紹： 　　是一種被Docker程序解釋的腳本，Dock

編寫Shell腳本的最佳實踐

enc odin mes ood 執行權限 print 自己 syn name 　　前言 　　由於工作需要，最近重新開始拾掇shell腳本。雖然絕大部分命令自己平時也經常使用，但是在寫成腳本的時候總覺得寫的很難看。而且當我在看其他人寫的腳本的時候，總覺得難以閱讀

DockerFile的編寫

ja1、制作nginx服務器的dockerfile# This is my first Dockfile # version 1.0 # Author:fish FROM centos MAINTAINER fish.chen ADD nginx-1.9.3.tar.gz /usr/local/src

實戰docker，編寫Dockerfile定制tomcat8鏡像，實現web應用在線部署

tomcat tin 會有 image gin dep 所在 代碼 prot 最初在tomcat上部署web應用的方式，是通過maven的maven-compiler-plugin插件先打成war包，再將war包復制到tomcat的webapps目錄下，後來用上了tomca

Dockerfile編寫

Dockerfile編寫Dockerfile兩種方式對比： 1. 一步步的執行 #### (1) 編寫Dockerfile文件 vim Dockerfile FROM ubuntu:14.04 ENTRYPOINT ["/bin/echo"] （2）通過Dockerfile文件進行構建鏡像 [root@c72

自己動手編寫 Dockerfile 構建自定義的Jenkins

瀏覽器 80端口 dex ase hub com ring ip地址 -i 1.構建jenkins 鏡像 vim Dockerfile FROM jenkins USER root ARG dockerGid=999 RUN echo "docker:x:${d

Docker實戰（五）編寫Dockerfile

curl 進行 () hostname 添加文件 iso -name 默認 數據卷 一、創建Dockerfile文件 首先，需要創建一個目錄來存放 Dockerfile 文件，目錄名稱可以任意，在目錄裏創建Dockerfile文件： 二、Dockerfile 基本框架 D

docker-3-3編寫合適的dockerfile和指令碼

其實dockerfile我們並不需要學習多少，其實就是看幾個學幾句就夠了。下面上圖   這是一個最簡單的java的maven專案，大家看圖，我已經寫好註釋了   編寫好dockerFile之後，然後我們這邊就需要呼叫起dockerFile。 此處避免內部

簡單的dockerfile編寫方法

如需製作映象的工程名為pro 首先在工程資料夾pro內新建一個名為docker的資料夾 進入資料夾，建立一個新檔名為Dockerfile Dockerfile裡面的內容如下： # 基礎映象 FROM python:3.6 # 或 FROM ubuntu:latest 等 # 維護者

【譯】為什麼ReasonReact是編寫React的最佳方式

原文地址：medium.freecodecamp.org/psst-heres-… 你是否使用 React 來構建使用者介面？好吧，我也是。接下來你會了解為什麼要使用 ReasonML 來寫 React 應用。 React 是構建使用者介面的一種很酷的手段，我們該如何讓這個過程變得更酷呢？ 為了回答這個

編寫 Node.js Rest API 的 10 個最佳實踐

Node.js 除了用來編寫 WEB 應用之外，還可以用來編寫 API 服務，我們在本文中會介紹編寫 Node.js Rest API 的最佳實踐，包括如何命名路由、進行認證和測試等話題，內容摘要如下： 正確使用 HTTP Method 和路由 正確的使用 HTTP 狀態碼 使用 HTTP H

學習編寫Dockerfile

前言         我們學習docker的話，其主要目的還是要用來改變我們部署應用程式的傳統習慣，達到解放生產力，解放人力的目的。這篇則自己來熟悉一下dockerfile常用命令。並且嘗試改變下生產環境手動部署應用的方式。   常用基礎命令 &nbs

轉 dockerfile 介紹 及 編寫

Docker簡介 Docker專案提供了構建在Linux核心功能之上，協同在一起的的高階工具。其目標是幫助開發和運維人員更容易地跨系統跨主機交付應用程式和他們的依賴。Docker通過Docker容器，一個安全的，基於輕量級容器的環境，來實現這個目標。這些容器由映象建立，而映象可以通過命令列手工建立或

編寫Dockerfile和docker-compose.yaml檔案案例

本文使用flask基於redis構建一個web介面，教你使用Dockerfile來構建映象和使用docker-compose來啟動這一系列服務。 1. Flask服務 from flask import Flask from redis import Redis app = F

Doker之Dockerfile編寫

使用Dockerfile可以允許使用者建立自定義的映象 Dockerfile一般由一條條語句組成,並支援以 # 開頭的註釋行 一般來說Dockerfile分為四部分 基礎映象資訊 維護者資訊 映象操作

實戰docker，編寫Dockerfile定製tomcat映象，實現web應用線上部署

最初在tomcat上部署web應用的方式，是通過maven的maven-compiler-plugin外掛先打成war包，再將war包複製到tomcat的webapps目錄下，後來用上了tomcat7-maven-plugin外掛，可以直接在maven上編譯，打