Container 技術 - 最小化 Docker Image

3 minute read Posted on: 2022-12-04 Updated on: 2024-04-19 Views: Loading...

Why Do we Need to Minimize Image

Image 的大小對開發本身來說有很大的影響嗎？
考慮到要 deploy, pull image 這件事情來說，如果遇到網路速度慢的情況下
等個幾分鐘對於開發者來說真的會大幅度的拖慢進度
因此，如果 image 大小能維持在幾 MB, 是在好不過得事情了

換言之，好處就是

上傳下載 image 的時間可以縮短
佔用硬碟空間少

Ways to Minimized Image

Smaller Base Image

最直觀也最容易想到的方法之一，用小一點的 image 就可以縮小 docker image size 了
舉凡我們平常使用的 golang, ubuntu
他們的大小

Image	Size
golang 1.19	992 MB
ubuntu 22.04	77.8 MB

但是這樣還不夠小

Alpine Linux 是安全且輕量的發行版基於 musl libc 以及 BusyBox, 其大小只有 130 MB
而 Docker 版的 Alpine, image size 僅僅只有 7.05 MB
這使得目前主流推薦都使用這個發行版作為 base image

Don’t Install Unused Tools

舉凡像是 cURL, Vim … etc. 這些工具，都會極大的增加 image 大小
因此不建議安裝這些在 image 裡面(畢竟你可能久久才開一次)

但是如果說你的安裝過程需要用到 curl 安裝第三方 package 呢？
裝是當然要裝的，但是能不能不要把它包進去 image 裡面呢？可參考 Multi-stage Build

Volume

對於某些 application 會依賴相當多的 config 檔，如果檔案太大，與其把它寫入 image 裡面，也可以試著使用 volume 將資料掛載進去，減少 image 空間

Store only Binaries instead of Source Code

有一個絕大多數人會忽略的一個點是
把你的程式跑起來，只需要 binary 就行(source code 其實並不需要的)
因為相比於 binary 執行檔，你的 source code 大小肯定是大的多
那 binary 理所當然是從你的原始碼 compile 得到的

對於直譯式語言如 python, 仍然有 pyinstaller, p2exe 等等的解法可以打包成 binary

具體的作法有兩個選擇

將 source code 包進去 image, 並在 docker build 的時候生出 binary
在你的本地端直接 compile，單純的包 binary 進去 image

這兩種，無非都是很爛的選擇

第一種作法你還是會把 source code 包進去，對於最小化 docker image 可以說是一點幫助都沒有
這種作法看似沒問題，但是每個人的環境都不同，可能包進去雜七雜八的東西，可行性也不高

可行的作法是，一樣把 source code 塞進去，生成 binary 之後, 再把 source 拔掉就好

這裡說的不是單純的 rm -rf application/ (這樣還是沒用，可參考 Minimized Layer)
而是透過 Multi-stage Build 達成

我手上有一個數據，公司的 CI/CD pipeline 把整包 source code 一起包到 image 裡面
我把它改成只包 binary 的情況下，image 大小縮小的大約 5176%(從 2 GB 多直接縮減到 45.7 MB)

在 ambersun1234/blog-labs/minimized-docker-image-lab 裡面我提供了一個簡單的 echo API 實作
把 source code 包進去的跟只包 binary 的他們的差別如下

	with source code	binary only
Implementation	Multi-stage Build	Non-optimized
Size	1.18 GB	17.6 MB
Layer	10	2

Decouple Applications

將 application 分成多個 container 也有助於降低 image size
同時，如果有需要做擴展，分開也有助於 scale

.dockerignore

跟 .gitignore 一樣，docker 也有 .dockerignore

ignore 檔裡面的規則最好是包含那些可以被自動生成的
像是執行檔，暫存檔等等的
將這些放到 image 裡面是完全沒有任何幫助的
因此將這些規則一併寫入 ignore file 也有助於縮小 image

Minimize Layer

Docker 是由多層 layer 所組成
每一筆 command(RUN, COPY, ADD) 都會增加一層 layer
進而導致佔用的空間變得更大

因此，試著減少 layer 層數，也有助於縮小 image size

有關 docker container layer 的部份，我把它獨立出來一篇
詳細可以參考 Container 技術 - 理解 Docker Container | Shawn Hsu

Multi-stage Build

multi stage build 是終極大招，它很好的解決了上述 multiple layer 以及 application binary 的問題
具體來說，他是在 build time 建構多個 stage image, 每個 stage 都自上一個 stage 拿取需要的東西
直接看一個例子吧

FROM golang:1.19 AS builder_stage
WORKDIR /
COPY ./echo ./
RUN go mod download
RUN CGO_ENABLED=0 go build -o server

FROM alpine:latest AS final_stage
WORKDIR /
COPY --from=builder_stage /server .
CMD ["/server"]

可以清楚的看到，這裡用了兩個 FROM, 代表這個 dockerfile 用了兩個 stage 下去操作
第一部份 builder_stage 主要是作 compile 的部份
而重點來囉，第二部份 final_stage 它從 builder_stage 直接複製 echo server 的 binary 資料！
所以 multi-stage build 的重點就在這，它可以只留下最重要的部份，不只 source code 我連第三方 package 的依賴都可以拔掉

讓我們來檢查一下他的 layer 吧

$ docker image inspect --format "{{json .RootFS.Layers}}" echo-multi-stage-optimized
[
  "sha256:ded7a220bb058e28ee3254fbba04ca90b679070424424761a53a043b93b612bf",
  "sha256:64394d25bf3e8126f87c418023130624fc841dfe79f3c88a6d20232196f7bad6"
]

可以看到它的確只有兩層(FROM alpine:latest 以及 COPY --from=builder_layer /server .)
一樣照慣例，看一下第一層的 layer hash 是不是 alpine 的

$ docker inspect alpine:latest
        xxx

        "RootFS": {
            "Type": "layers",
            "Layers": [
                "sha256:ded7a220bb058e28ee3254fbba04ca90b679070424424761a53a043b93b612bf"
            ]
        },

        xxx

實驗程式碼可以參考 ambersun1234/blog-labs/minimized-docker-image-lab

exec: no such file or directory

在執行 Multi-stage Build 的時候需要特別注意一件事情(一般的 dockerfile 也需要注意就是)
每一種 base image(e.g. alpine) 它底層提供的 standard library runtime 都不盡相同
因此，你可以會遇到很奇怪的錯誤
例如 exec /app/server: no such file or directory

明明你有正確的檔案路徑，但是 docker 怎麼樣都是啟動不了的狀態
而系統一直跟你說找不到檔案，實際上的問題其實是底層 runtime 不同的問題
你卻花了不少的時間在調試，尋找看似遺失的檔案

像是我在打包 golang 的小程式的時候，在 build 裡面我忘記指定 CGO_ENABLED=0
所以我在 build 的時候就會出現 exec /app/server: no such file or directory

這種小細節，在平常打包的時候要特別小心就是

References

Share on

Twitter Facebook LinkedIn

Shawn Hsu