what's the Dockerfile
Dockerfile 是一個用來構建鏡像的文本文件,文本內容包含了一條條構建鏡像所需的指令和說明。
定義好 Dockerfile 后,一般執行 build 命令構建 docker 鏡像
docker build -t xxx:v1 .
主要構建命令
- FROM
- RUN
- CMD
- LABLE
- MAINTAINER
- EXPOSE
- ENV
- ADD
- COPY
- ENTRYPOINT
- VOLUME
- WORKDIR
- ARG
- ONBUILD
- STOPSIGNAL
- HEALTHCHECK
命令
FROM
功能:指定基礎鏡像,必須是 Dockerfile 的第一條指令。
如果不以任何鏡像為基礎,那么寫法為:FROM scratch。同時意味着接下來所寫的指令將作為鏡像的第一層開始
語法:
# 三種寫法,其中<tag>和<digest> 是可選項,如果沒有選擇,那么默認值為latest FROM <image> FROM <image>:<tag> FROM <image>:<digest>
RUN
功能:運行指定的命令
語法:RUN 命令有兩種語法格式
# 格式一:直接跟shell命令(linux操作系統上默認 /bin/sh -c, windows操作系統上默認 cmd /S /C) RUN <command> # 格式二:類似於函數調用,可將executable理解成為可執行文件,后面就是兩個參數。 RUN ["executable", "param1", "param2"]
注意:多行命令不要寫多個RUN,原因是Dockerfile中每一個指令都會建立一層, 多少個RUN就構建了多少層鏡像,會造成鏡像的臃腫、多層,不僅僅增加了構件部署的時間,還容易出錯。多行 RUN 書寫時可用換行符 \ 分割
CMD
功能:容器啟動時要運行的命令
語法:有三種寫法
# 格式一 CMD ["executable","param1","param2"] # 格式二 CMD ["param1","param2"] # 格式三 CMD command param1 param2
注意:這里邊包括參數的一定要用雙引號,不能是單引號。原因是參數傳遞后,docker 解析的是一個 JSON array
RUN & CMD 對比
不要把 RUN 和 CMD 搞混了。
- RUN 是構件容器時就運行的命令以及提交運行結果
- CMD 是容器啟動時執行的命令,在構件時並不運行,構件時緊緊指定了這個命令到底是個什么樣子
LABEL
功能:為鏡像指定標簽
語法:
LABEL <key>=<value> <key>=<value> <key>=<value> ...
一個 Dockerfile 中可以有多個 LABEL,如下:
LABEL "com.example.vendor"="ACME Incorporated" LABEL com.example.label-with-value="foo" LABEL version="1.0" LABEL description="This text illustrates \ that label-values can span multiple lines."
但是並不建議這樣寫,最好就寫成一行,如太長需要換行的話則使用 \ 符號
LABEL multi.label1="value1" \ multi.label2="value2" \ other="value3"
注意:LABEL 會繼承基礎鏡像的 LABEL,如遇到 key 相同,則值覆蓋
MAINTAINER
功能:指定作者
語法:
MAINTAINER <name>
EXPOSE
功能:暴漏容器運行時的監聽端口給外部,但是 EXPOSE 並不會使容器訪問主機的端口。如果想使得容器與主機的端口有映射關系,必須在容器啟動的時候加上 -P 參數
ENV
功能:設置環境變量
語法:有兩種
# 格式一 ENV <key> <value> # 格式二 ENV <key>=<value> ...
兩者的區別就是第一種是一次設置一個,第二種是一次設置多個
ADD
功能:復制命令,把文件復制到鏡像中。
如果把虛擬機與容器想象成兩台 Linux 服務器的話,那么這個命令就類似於 scp,只是 scp 需要加用戶名和密碼的權限驗證,而 ADD 不用。
語法:
# 格式一 ADD <src>... <dest> # 格式二 ADD ["<src>",... "<dest>"]
注意
- <dest>路徑的填寫可以是容器內的絕對路徑,也可以是相對於工作目錄的相對路徑
- <src>可以是一個本地文件或者是一個本地壓縮文件,還可以是一個url
- 如果把<src>寫成一個url,那么ADD就類似於wget命令
- 盡量不要把<scr>寫成一個文件夾,如果<src>是一個文件夾了,復制整個目錄的內容,包括文件系統元數據
COPY
功能:復制命令
語法:
# 格式一 COPY <src>... <dest> # 格式二 COPY ["<src>",... "<dest>"]
與ADD的區別
COPY的<src>只能是本地文件,其他用法一致
ENTRYPOINT
功能:啟動時的默認命令
語法:
# 格式一 ENTRYPOINT ["executable", "param1", "param2"] # 格式二 ENTRYPOINT command param1 param2
與 CMD 比較說明(這倆命令太像了,而且還可以配合使用):
1. 相同點:
-
只能寫一條,如果寫了多條,那么只有最后一條生效
-
容器啟動時才運行,運行時機相同
2. 不同點:
-
ENTRYPOINT 不會被運行的 command 覆蓋,而 CMD 則會被覆蓋
-
如果在 Dockerfile 中同時寫了 ENTRYPOINT 和 CMD,並且 CMD 指令不是一個完整的可執行命令,那么 CMD 指定的內容將會作為 ENTRYPOINT 的參數
FROM ubuntu ENTRYPOINT ["top", "-b"] CMD ["-c"]
-
如果在 Dockerfile 中同時寫了 ENTRYPOINT 和 CMD,並且 CMD 是一個完整的指令,那么它們兩個會互相覆蓋,誰在最后誰生效
FROM ubuntu ENTRYPOINT ["top", "-b"] CMD ls -al
此時將執行 ls -al ,而 top -b 則不會執行。
Docker 官方使用一張表格來展示了 ENTRYPOINT 和 CMD 不同組合的執行情況
VOLUME
功能:實現掛載功能,可以將內地文件夾或者其他容器中的文件夾掛在到這個容器中
語法:
VOLUME ["/data"]
說明:
["/data"] 可以是一個 JsonArray ,也可以是多個值。所以如下幾種寫法都是正確的
VOLUME ["/var/log/"] VOLUME /var/log VOLUME /var/log /var/db
一般的使用場景為需要持久化存儲數據時,容器使用的是 AUFS,這種文件系統不能持久化數據,當容器關閉后,所有的更改都會丟失。所以當數據需要持久化時用這個命令。
USER
功能:設置啟動容器的用戶,可以是用戶名或 UID,所以,只有下面的兩種寫法是正確的
語法:
# 格式一 USER daemo # 格式二 USER UID
注意:如果設置了容器以 daemon 用戶去運行,那么 RUN、CMD 和 ENTRYPOINT 都會以這個用戶去運行
WORKDIR
功能:設置工作目錄,對 RUN、CMD、ENTRYPOINT、COPY、ADD 生效。如果不存在則會創建,也可以設置多次。
語法:
WORKDIR /path/to/workdir
如:
WORKDIR /a WORKDIR b WORKDIR c RUN pwd
# pwd執行的結果是/a/b/c
WORKDIR 也可以解析環境變量
如:
ENV DIRPATH /path WORKDIR $DIRPATH/$DIRNAME RUN pwd # pwd的執行結果是/path/$DIRNAME
ARG
功能:設置變量命令
語法:
ARG <name>[=<default value>]
ARG 命令定義了一個變量,在 docker build 創建鏡像的時候,使用 --build-arg <varname>=<value> 來指定參數
如果用戶在 build 鏡像時指定了一個參數沒有定義在 Dockerfile 中,那么將有一個 Warning
提示如下:
[Warning] One or more build-args [foo] were not consumed.
可以定義一個或多個參數,如下:
FROM busybox ARG user1 ARG buildno ...
也可以給參數一個默認值:
FROM busybox ARG user1=someuser ARG buildno=1 ...
如果給了 ARG 定義的參數默認值,那么當 build 鏡像時沒有指定參數值,將會使用這個默認值
ONBUILD
語法:
ONBUILD [INSTRUCTION]
這個命令只對當前鏡像的子鏡像生效。
比如當前鏡像為 A,在 Dockerfile 添加:
ONBUILD RUN ls -al
這個 ls -al 命令不會在 A 鏡像構建或啟動的時候執行。此時有一個鏡像 B 是基於 A 鏡像構建的,那么這個 ls -al 命令會在B鏡像構建的時候被執行。
STOPSIGNAL
功能:當容器退出時給系統發送的指令
語法:
STOPSIGNAL signal
HEALTHCHECK
功能:容器健康狀況檢查命令
語法:
# 在容器內部運行一個命令來檢查容器的健康狀況 HEALTHCHECK [OPTIONS] CMD command # 在基礎鏡像中取消健康檢查命令 HEALTHCHECK NONE
[OPTIONS]的選項支持以下三中選項:
- --interval=DURATION 兩次檢查默認的時間間隔為30秒
- --timeout=DURATION 健康檢查命令運行超時時長,默認30秒
- --retries=N 當連續失敗指定次數后,則容器被認為是不健康的,狀態為unhealthy,默認次數是3
注意:HEALTHCHECK 命令只能出現一次,如果出現了多次,只有最后一個生效。
CMD 后邊的命令的返回值決定了本次健康檢查是否成功,具體的返回值如下:
- 0: success - 表示容器是健康的
- 1: unhealthy - 表示容器已經不能工作了
- 2: reserved - 保留值
例子:
HEALTHCHECK --interval=5m --timeout=3s \ CMD curl -f http://localhost/ || exit 1
健康檢查命令是
curl -f http://localhost/ || exit 1
兩次檢查的間隔時間是 5 秒,命令超時時間為 3 秒
參考:https://www.cnblogs.com/lingfengblogs/p/11093246.html