[轉載] Dockerfile建立自定義Docker映象以及CMD與ENTRYPOINT指令的比較
1.概述
建立Docker映象的方式有三種
- docker commit命令:由容器生成映象;
- Dockerfile檔案+docker build命令;
- 從本地檔案系統匯入:OpenVZ的模板。
最近學習了Dockerfile檔案的相關配置,這裡做一下簡單的總結,並對之前一直感到有些迷惑的CMD和ENTRYPOINT指令做個差異對比。
2.Dockerfile檔案總結
Dockerfile 由一行行命令語句組成,並且支援以 # 開頭的註釋行。
一般地,Dockerfile 分為四部分:基礎映象資訊、維護者資訊、映象操作指令和容器啟動時執行指令。
四部分 |
指令 |
基礎映象資訊 |
FROM |
維護者資訊 |
MAINTAINER |
映象操作指令 |
RUN、COPY、ADD、EXPOSE等 |
容器啟動時執行指令 |
CMD、ENTRYPOINT |
Dockerfile檔案的第一條指令必須是FROM,其後可以是各種映象的操作指令,最後是CMD或ENTRYPOINT指定容器啟動時執行的命令。
指令
指令的一般格式為 INSTRUCTION arguments,指令包括 FROM、MAINTAINER、RUN 等。
FROM
格式為 FROM <image>或FROM <image>:<tag>。
第一條指令必須為 FROM 指令。並且,如果在同一個Dockerfile中建立多個映象時,可以使用多個 FROM 指令(每個映象一次)。
MAINTAINER
格式為 MAINTAINER <name>,指定維護者資訊。
RUN
格式為 RUN <command> 或 RUN ["executable", "param1", "param2"]。
前者將在 shell 終端中執行命令,即 /bin/sh -c;後者則使用 exec 執行。指定使用其它終端可以通過第二種方式實現,例如 RUN ["/bin/bash", "-c", "echo hello"]。
每條 RUN 指令將在當前映象基礎上執行指定命令,並提交為新的映象。當命令較長時可以使用 \ 來換行。
CMD
支援三種格式
CMD ["executable","param1","param2"] 使用 exec 執行,推薦方式;
CMD command param1 param2 在 /bin/sh 中執行,提供給需要互動的應用;
CMD ["param1","param2"] 提供給 ENTRYPOINT 的預設引數;
指定啟動容器時執行的命令,每個 Dockerfile 只能有一條 CMD 命令。如果指定了多條命令,只有最後一條會被執行。
如果使用者啟動容器時候指定了執行的命令,則會覆蓋掉 CMD 指定的命令。
EXPOSE
格式為 EXPOSE <port> [<port>...]。
告訴 Docker 服務端容器暴露的埠號,供互聯絡統使用。在啟動容器時需要通過 -P,Docker 主機會自動分配一個埠轉發到指定的埠。
ENV
格式為 ENV <key> <value>。 指定一個環境變數,會被後續 RUN 指令使用,並在容器執行時保持。
例如
ENV PG_MAJOR 9.3
ENV PG_VERSION 9.3.4
RUN curl -SL http://example.com/postgres-$PG_VERSION.tar.xz | tar -xJC /usr/src/postgress && …
ENV PATH /usr/local/postgres-$PG_MAJOR/bin:$PATH
ADD
格式為 ADD <src> <dest>。
該命令將複製指定的 <src> 到容器中的 <dest>。 其中 <src> 可以是Dockerfile所在目錄的一個相對路徑;也可以是一個 URL;還可以是一個 tar 檔案(自動解壓為目錄)。
COPY
格式為 COPY <src> <dest>。
複製本地主機的 <src>(為 Dockerfile 所在目錄的相對路徑)到容器中的 <dest>。
當使用本地目錄為源目錄時,推薦使用 COPY。
ENTRYPOINT
兩種格式:
ENTRYPOINT ["executable", "param1", "param2"]
ENTRYPOINT command param1 param2(shell中執行)。
配置容器啟動後執行的命令,並且不可被 docker run 提供的引數覆蓋。
每個 Dockerfile 中只能有一個 ENTRYPOINT,當指定多個時,只有最後一個起效。
VOLUME
格式為 VOLUME ["/data"]。
建立一個可以從本地主機或其他容器掛載的掛載點,一般用來存放資料庫和需要保持的資料等。
USER
格式為 USER daemon。
指定執行容器時的使用者名稱或 UID,後續的 RUN 也會使用指定使用者。
當服務不需要管理員許可權時,可以通過該命令指定執行使用者。並且可以在之前建立所需要的使用者,例如:RUN groupadd -r postgres && useradd -r -g postgres postgres。要臨時獲取管理員許可權可以使用 gosu,而不推薦 sudo。
WORKDIR
格式為 WORKDIR /path/to/workdir。
為後續的 RUN、CMD、ENTRYPOINT 指令配置工作目錄。
可以使用多個 WORKDIR 指令,後續命令如果引數是相對路徑,則會基於之前命令指定的路徑。例如
WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd
則最終路徑為 /a/b/c。
ONBUILD
格式為 ONBUILD [INSTRUCTION]。
配置當所建立的映象作為其它新建立映象的基礎映象時,所執行的操作指令。
例如,Dockerfile 使用如下的內容建立了映象 image-A。
[...]
ONBUILD ADD . /app/src
ONBUILD RUN /usr/local/bin/python-build --dir /app/src
[...]
如果基於 image-A 建立新的映象時,新的Dockerfile中使用 FROM image-A指定基礎映象時,會自動執行 ONBUILD 指令內容,等價於在後面添加了兩條指令。
FROM image-A #Automatically run the followingADD . /app/srcRUN /usr/local/bin/python-build --dir /app/src
使用 ONBUILD 指令的映象,推薦在標籤中註明,例如 ruby:1.9-onbuild。
3.建立映象
編寫完Dockerfile檔案後,通過執行docker build命令來建立自定義的映象。Docker build命令格式如下:
docker build [options] <path>
該命令將讀取指定路徑下(包括子目錄)的 Dockerfile,並將該路徑下所有內容傳送給 Docker 服務端,由服務端來建立映象。因此一般建議放置 Dockerfile 的目錄為空目錄。也可以通過 .dockerignore 檔案(每一行新增一條匹配模式)來讓 Docker 忽略路徑下的目錄和檔案。
例如下面使用Dockerfile樣例來建立了映象test:0.0.1,其中-t選項用來指定映象的tag。Dockerfile檔案內容如下:
FROM ubuntu:14.04 MAINTAINER [email protected] RUN mkdir /opt/leh RUN touch /opt/leh/test CMD echo "Hello lienhua34"
下面執行docker build命令生成映象test:0.0.1,
按 Ctrl+C 複製程式碼
按 Ctrl+C 複製程式碼
然後啟動該映象的容器來檢視結果,
[email protected]$ sudo docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE test 0.0.1 811ce27ce692 32 seconds ago 187.9 MB [email protected]$ sudo docker run -ti test:0.0.1 Hello lienhua34
Dockerfile檔案的每條指令生成映象的一層(注:一個映象不能超過127層)。Dockerfile中的指令被一條條地執行。每一步都建立一個新的容器,在容器中執行指令並提交修改。當所有指令執行完畢後,返回最終的映象id。
4.Dockerfile檔案中的CMD和ENTRYPOINT指令差異對比
CMD指令和ENTRYPOINT指令的作用都是為映象指定容器啟動後的命令,那麼它們兩者之間有什麼各自的優點呢?
為了更好地對比CMD指令和ENTRYPOINT指令的差異,我們這裡再列一下這兩個指令的說明,
CMD
支援三種格式
CMD ["executable","param1","param2"] 使用 exec 執行,推薦方式;
CMD command param1 param2 在 /bin/sh 中執行,提供給需要互動的應用;
CMD ["param1","param2"] 提供給 ENTRYPOINT 的預設引數;
指定啟動容器時執行的命令,每個 Dockerfile 只能有一條 CMD 命令。如果指定了多條命令,只有最後一條會被執行。
如果使用者啟動容器時候指定了執行的命令,則會覆蓋掉 CMD 指定的命令。
ENTRYPOINT
兩種格式:
ENTRYPOINT ["executable", "param1", "param2"]
ENTRYPOINT command param1 param2(shell中執行)。
配置容器啟動後執行的命令,並且不可被 docker run 提供的引數覆蓋。
每個 Dockerfile 中只能有一個 ENTRYPOINT,當指定多個時,只有最後一個起效。
從上面的說明,我們可以看到有兩個共同點:
- 都可以指定shell或exec函式呼叫的方式執行命令;
- 當存在多個CMD指令或ENTRYPOINT指令時,只有最後一個生效;
而它們有如下差異:
差異1:CMD指令指定的容器啟動時命令可以被docker run指定的命令覆蓋,而ENTRYPOINT指令指定的命令不能被覆蓋,而是將docker run指定的引數當做ENTRYPOINT指定命令的引數。
差異2:CMD指令可以為ENTRYPOINT指令設定預設引數,而且可以被docker run指定的引數覆蓋;
下面分別對上面兩個差異點進行詳細說明,
4.1 差異1
CMD指令指定的容器啟動時命令可以被docker run指定的命令覆蓋;而ENTRYPOINT指令指定的命令不能被覆蓋,而是將docker run指定的引數當做ENTRYPOINT指定命令的引數。
下面有個命名為startup的可執行shell指令碼,其功能就是輸出命令列引數而已。內容如下所示,
#!/bin/bash echo "in startup, args: [email protected]"
通過CMD指定容器啟動時命令:
現在我們新建一個Dockerfile檔案,其將startup指令碼拷貝到容器的/opt目錄下,並通過CMD指令指定容器啟動時執行該startup指令碼。其內容如下,
FROM ubuntu:14.04 MAINTAINER [email protected] ADD startup /opt RUN chmod a+x /opt/startup CMD ["/opt/startup"]
然後我們通過執行docker build命令生成test:latest映象,
[email protected]$ sudo docker build -t test . Sending build context to Docker daemon 4.096 kB Step 1 : FROM ubuntu:14.04 ---> a5a467fddcb8 Step 2 : MAINTAINER [email protected] ---> Using cache ---> 332259a92e74 Step 3 : ADD startup /opt ---> 3c26b6a8ef1b Removing intermediate container 87022b0f30c5 Step 4 : RUN chmod a+x /opt/startup ---> Running in 4518ba223345 ---> 04d9b53d6148 Removing intermediate container 4518ba223345 Step 5 : CMD /opt/startup ---> Running in 64a07c2f5e64 ---> 18a2d5066346 Removing intermediate container 64a07c2f5e64 Successfully built 18a2d5066346
然後使用docker run啟動兩個test:latest映象的容器,第一個docker run命令沒有指定容器啟動時命令,第二個docker run命令指定了容器啟動時的命令為“/bin/bash -c 'echo Hello'”,
[email protected]$ sudo docker run -ti --rm=true test in startup, args: [email protected]$ sudo docker run -ti --rm=true test /bin/bash -c 'echo Hello' Hello
從上面執行結果可以看到,docker run命令啟動容器時指定的執行命令覆蓋了Dockerfile檔案中CMD指令指定的命令。
通過ENTRYPOINT指定容器啟動時命令:
將上面的Dockerfile中的CMD替換成ENTRYPOINT,內容如下所示,
FROM ubuntu:14.04 MAINTAINER [email protected] ADD startup /opt RUN chmod a+x /opt/startup ENTRYPOINT [“/opt/startup”]
同樣,通過執行docker build生成test:latest映象,
[email protected]$ sudo docker build -t test . Sending build context to Docker daemon 4.096 kB Step 1 : FROM ubuntu:14.04 ---> a5a467fddcb8 Step 2 : MAINTAINER [email protected] ---> Using cache ---> 332259a92e74 Step 3 : ADD startup /opt ---> Using cache ---> 3c26b6a8ef1b Step 4 : RUN chmod a+x /opt/startup ---> Using cache ---> 04d9b53d6148 Step 5 : ENTRYPOINT /opt/startup ---> Running in cdec60940ad7 ---> 78f8aca2edc2 Removing intermediate container cdec60940ad7 Successfully built 78f8aca2edc2
然後使用docker run啟動兩個test:latest映象的容器,第一個docker run命令沒有指定容器啟動時命令,第二個docker run命令指定了容器啟動時的命令為“/bin/bash -c 'echo Hello'”,
[email protected]$ sudo docker run -ti --rm=true test in startup, args: [email protected]$ sudo docker run -ti --rm=true test /bin/bash -c 'echo Hello' in startup, args: /bin/bash -c echo Hello
通過上面的執行結果可以看出,docker run命令指定的容器執行命令不能覆蓋Dockerfile檔案中ENTRYPOINT指令指定的命令,反而被當做引數傳遞給ENTRYPOINT指令指定的命令。
4.2 差異2
CMD指令可以為ENTRYPOINT指令設定預設引數,而且可以被docker run指定的引數覆蓋;
同樣使用上面的startup指令碼。編寫Dockerfile,內容如下所示,
FROM ubuntu:14.04 MAINTAINER [email protected] ADD startup /opt RUN chmod a+x /opt/startup ENTRYPOINT ["/opt/startup", "arg1"] CMD ["arg2"]
執行docker build命令生成test:latest映象,
[email protected]$ sudo docker build -t test . Sending build context to Docker daemon 4.096 kB Step 1 : FROM ubuntu:14.04 ---> a5a467fddcb8 Step 2 : MAINTAINER [email protected] ---> Using cache ---> 332259a92e74 Step 3 : ADD startup /opt ---> Using cache ---> 3c26b6a8ef1b Step 4 : RUN chmod a+x /opt/startup ---> Using cache ---> 04d9b53d6148 Step 5 : ENTRYPOINT /opt/startup arg1 ---> Running in 54947233dc3d ---> 15a485253b4e Removing intermediate container 54947233dc3d Step 6 : CMD arg2 ---> Running in 18c43d2d90fd ---> 4684ba457cc2 Removing intermediate container 18c43d2d90fd Successfully built 4684ba457cc2
下面執行docker run啟動兩個test:latest映象的容器,第一條docker run命令沒有指定引數,第二條docker run命令指定了引數arg3,其執行結果如下,
[email protected]$ sudo docker run -ti --rm=true test in startup, args: arg1 arg2 [email protected]$ sudo docker run -ti --rm=true test arg3 in startup, args: arg1 arg3
從上面第一個容器的執行結果可以看出CMD指令為ENTRYPOINT指令設定了預設引數;從第二個容器的執行結果看出,docker run命令指定的引數覆蓋了CMD指令指定的引數。
4.3注意點
CMD指令為ENTRYPOINT指令提供預設引數是基於映象層次結構生效的,而不是基於是否在同個Dockerfile檔案中。意思就是說,如果Dockerfile指定基礎映象中是ENTRYPOINT指定的啟動命令,則該Dockerfile中的CMD依然是為基礎映象中的ENTRYPOINT設定預設引數。
例如,我們有如下一個Dockerfile檔案,
FROM ubuntu:14.04 MAINTAINER [email protected] ADD startup /opt RUN chmod a+x /opt/startup ENTRYPOINT ["/opt/startup", "arg1"]
通過執行docker build命令生成test:0.0.1映象,然後建立該映象的一個容器,檢視執行結果,
[email protected]$ sudo docker build -t test:0.0.1 . Sending build context to Docker daemon 6.144 kB Step 1 : FROM ubuntu:14.04 ---> a5a467fddcb8 Step 2 : MAINTAINER [email protected] ---> Running in 57a96522061a ---> c3bbf1bd8068 Removing intermediate container 57a96522061a Step 3 : ADD startup /opt ---> f9884fbc7607 Removing intermediate container 591a82b2f382 Step 4 : RUN chmod a+x /opt/startup ---> Running in 7a19f10b5513 ---> 16c03869a764 Removing intermediate container 7a19f10b5513 Step 5 : ENTRYPOINT /opt/startup arg1 ---> Running in b581c32b25c3 ---> c6b1365afe03 Removing intermediate container b581c32b25c3 Successfully built c6b1365afe03 [email protected]$ sudo docker run -ti --rm=true test:0.0.1 in startup, args: arg1
下面新建一個Dockerfile檔案,基礎映象是剛生成的test:0.0.1,通過CMD指定要通過echo列印字串“in test:0.0.2”。檔案內容如下所示,
FROM test:0.0.1 MAINTAINER [email protected] CMD ["/bin/bash", "-c", "echo in test:0.0.2"]
執行docker build命令生成test:0.0.2映象,然後通過執行docker run啟動一個test:0.0.2映象的容器來檢視結果,
[email protected]$ sudo docker build -t test:0.0.2 . Sending build context to Docker daemon 6.144 kB Step 1 : FROM test:0.0.1 ---> c6b1365afe03 Step 2 : MAINTAINER [email protected] ---> Running in deca95cf4c15 ---> 971b5a819b48 Removing intermediate container deca95cf4c15 Step 3 : CMD /bin/bash -c echo in test:0.0.2 ---> Running in 4a31c4652e1e ---> 0ca06ba31405 Removing intermediate container 4a31c4652e1e Successfully built 0ca06ba31405 [email protected]$ sudo docker run -ti --rm=true test:0.0.2 in startup, args: arg1 /bin/bash -c echo in test:0.0.2
從上面結果可以看到,映象test:0.0.2啟動的容器執行時並不是列印字串”in test:0.0.2”,而是將CMD指令指定的命令當做基礎映象test:0.0.1中ENTRYPOINT指定的執行指令碼startup的引數。
(done)