diff --git a/dockerfile/README.md b/dockerfile/README.md index a24e6e1..41959be 100644 --- a/dockerfile/README.md +++ b/dockerfile/README.md @@ -1,3 +1,3 @@ # Dockerfile -使用 Dockerfile 可以允許用戶創建自定義的鏡像。 +使用 Dockerfile 讓使用者可以建立自定義的鏡映像檔。 diff --git a/dockerfile/basic_structure.md b/dockerfile/basic_structure.md index f4b55c2..5cd7de0 100644 --- a/dockerfile/basic_structure.md +++ b/dockerfile/basic_structure.md @@ -1,7 +1,7 @@ ## 基本結構 Dockerfile 由一行行命令語句組成，並且支援以 `#` 開頭的註釋行。 -一般而言，Dockerfile 分為四部分：基礎鏡像資訊、維護者資訊、鏡像操作指令和容器啟動時執行指令。 +一般而言，Dockerfile 分為四部分：基底映像檔資訊、維護者資訊、映像檔操作指令和容器啟動時執行指令。 例如 ``` @@ -10,26 +10,26 @@ Dockerfile 由一行行命令語句組成，並且支援以 `#` 開頭的註釋 # Author: docker_user # Command format: Instruction [arguments / command] .. -# Base image to use, this must be set as the first line +# 基本映像檔，必須是第一個指令 FROM ubuntu -# Maintainer: docker_user (@docker_user) +# 維護者： docker_user (@docker_user) MAINTAINER docker_user docker_user@email.com -# Commands to update the image +# 更新映像檔的指令 RUN echo "deb http://archive.ubuntu.com/ubuntu/ raring main universe" >> /etc/apt/sources.list RUN apt-get update && apt-get install -y nginx RUN echo "\ndaemon off;" >> /etc/nginx/nginx.conf -# Commands when creating a new container +# 建立新容器時要執行的指令 CMD /usr/sbin/nginx ``` -其中，一開始必須指明作為基底的鏡像名稱，接下來說明維護者資訊（建議）。 +其中，一開始必須指明作為基底的映像檔名稱，接下來說明維護者資訊（建議）。 -後面則是鏡像操作指令，例如 `RUN` 指令，`RUN` 指令將對鏡像執行相對應的命令。每執行一條 `RUN` 指令，鏡像添加新的一層，並提交。 +接著則是映像檔操作指令，例如 `RUN` 指令，`RUN` 指令將對映像檔執行相對應的命令。每運行一條 `RUN` 指令，映像檔就會新增一層。 -最後是 `CMD` 指令，來指定執行容器時的操作命令。 +最後是 `CMD` 指令，指定執行容器時的操作命令。 下面來看一個更複雜的例子 ``` diff --git a/dockerfile/build_image.md b/dockerfile/build_image.md index 8e43ffb..25e0599 100644 --- a/dockerfile/build_image.md +++ b/dockerfile/build_image.md @@ -1,5 +1,5 @@ -## 創建鏡像 -編輯完成 Dockerfile 之後，可以透過 `docker build` 命令來創建鏡像。 +## 建立映像檔 +編輯完成 Dockerfile 之後，可以透過 `docker build` 命令建立映像檔。 基本的格式為 `docekr build [選項] 路徑`，該命令將讀取指定路徑下（包括子目錄）的 Dockerfile，並將該路徑下所有內容發送給 Docker 伺服端，由伺服端來創建鏡像。因此一般會建議放置 Dockerfile 的目錄為空目錄。也可以透過 `.dockerignore` 文件（每一行添加一條排除模式：exclusion patterns）來讓 Docker 忽略路徑下的目錄和文件。 diff --git a/dockerfile/instructions.md b/dockerfile/instructions.md index 466de1f..5ccefba 100644 --- a/dockerfile/instructions.md +++ b/dockerfile/instructions.md @@ -4,7 +4,7 @@ ### FROM 格式為 `FROM `或`FROM :`。 -第一條指令必須為 `FROM` 指令。並且，如果在同一個Dockerfile中創建多個鏡像時，可以使用多個 `FROM` 指令（每個鏡像一次）。 +第一條指令必須為 `FROM` 指令。並且，如果在同一個Dockerfile中建立多個映像檔時，可以使用多個 `FROM` 指令（每個映像檔一次）。 ### MAINTAINER 格式為 `MAINTAINER `，指定維護者信息。 @@ -12,29 +12,29 @@ ### RUN 格式為 `RUN ` 或 `RUN ["executable", "param1", "param2"]`。 -前者將在 shell 終端中執行命令，即 `/bin/sh -c`；後者則使用 `exec` 執行。指定使用其它終端可以通過第二種方式實現，例如 `RUN ["/bin/bash", "-c", "echo hello"]`。 +前者將在 shell 終端中運行命令，即 `/bin/sh -c`；後者則使用 `exec` 執行。指定使用其它終端可以通過第二種方式實現，例如 `RUN ["/bin/bash", "-c", "echo hello"]`。 -每條 `RUN` 指令將在當前鏡像基礎上執行指定命令，並提交為新的鏡像。當命令較長時可以使用 `\` 來換行。 +每條 `RUN` 指令將在當前映像檔基底上執行指定命令，並產生新的映像檔。當命令較長時可以使用 `\` 來換行。 ### CMD 支持三種格式 -* `CMD ["executable","param1","param2"]` 使用 `exec` 執行，推薦方式； -* `CMD command param1 param2` 在 `/bin/sh` 中執行，提供給需要交互的應用； -* `CMD ["param1","param2"]` 提供給 `ENTRYPOINT` 的默認參數； +* `CMD ["executable","param1","param2"]` 使用 `exec` 執行，推薦使用； +* `CMD command param1 param2` 在 `/bin/sh` 中執行，使用在給需要互動的指令； +* `CMD ["param1","param2"]` 提供給 `ENTRYPOINT` 的預設參數； 指定啟動容器時執行的命令，每個 Dockerfile 只能有一條 `CMD` 命令。如果指定了多條命令，只有最後一條會被執行。 -如果用戶啟動容器時候指定了執行的命令，則會覆蓋掉 `CMD` 指定的命令。 +如果使用者啟動容器時候指定了運行的命令，則會覆蓋掉 `CMD` 指定的命令。 ### EXPOSE 格式為 `EXPOSE [...]`。 -告訴 Docker 服務端容器暴露的端口號，供互聯系統使用。在啟動容器時需要通過 -P，Docker 主機會自動分配一個端口轉發到指定的端口。 +設定 Docker 伺服器容器對外的埠號，供外界使用。在啟動容器時需要通過 -P，Docker 會自動分配一個埠號轉發到指定的埠號。 ### ENV 格式為 `ENV `。 -指定一個環境變量，會被後續 `RUN` 指令使用，並在容器執行時保持。 +指定一個環境變數，會被後續 `RUN` 指令使用，並在容器運行時保持。 例如 ``` @@ -47,41 +47,41 @@ ENV PATH /usr/local/postgres-$PG_MAJOR/bin:$PATH ### ADD 格式為 `ADD `。 -該命令將復制指定的 `` 到容器中的 ``。 -其中 `` 可以是Dockerfile所在目錄的一個相對路徑；也可以是一個 URL；還可以是一個 tar 文件（自動解壓為目錄）。 +該命令將複製指定的 `` 到容器中的 ``。 +其中 `` 可以是 Dockerfile 所在目錄的相對路徑；也可以是一個 URL；還可以是一個 tar 文件（其複製後會自動解壓縮）。 ### COPY 格式為 `COPY `。 -復制本地主機的 ``（為 Dockerfile 所在目錄的相對路徑）到容器中的 ``。 +複製本地端的 ``（為 Dockerfile 所在目錄的相對路徑）到容器中的 ``。 -當使用本地目錄為源目錄時，推薦使用 `COPY`。 +當使用本地目錄為根目錄時，推薦使用 `COPY`。 ### ENTRYPOINT 兩種格式： * `ENTRYPOINT ["executable", "param1", "param2"]` * `ENTRYPOINT command param1 param2`（shell中執行）。 -配置容器啟動後執行的命令，並且不可被 `docker run` 提供的參數覆蓋。 +指定容器啟動後執行的命令，並且不會被 `docker run` 提供的參數覆蓋。 -每個 Dockerfile 中只能有一個 `ENTRYPOINT`，當指定多個時，只有最後一個起效。 +每個 Dockerfile 中只能有一個 `ENTRYPOINT`，當指定多個時，只有最後一個會生效。 ### VOLUME 格式為 `VOLUME ["/data"]`。 -創建一個可以從本地主機或其他容器掛載的掛載點，一般用來存放數據庫和需要保持的數據等。 +建立一個可以從本地端或其他容器掛載的掛載點，一般用來存放資料庫和需要保存的資料等。 ### USER 格式為 `USER daemon`。 -指定執行容器時的用戶名或 UID，後續的 `RUN` 也會使用指定用戶。 +指定運行容器時的使用者名稱或 UID，後續的 `RUN` 也會使用指定使用者。 -當服務不需要管理員權限時，可以通過該命令指定執行用戶。並且可以在之前創建所需要的用戶，例如：`RUN groupadd -r postgres && useradd -r -g postgres postgres`。要臨時獲取管理員權限可以使用 `gosu`，而不推薦 `sudo`。 +當服務不需要管理員權限時，可以通過該命令指定運行使用者。並且可以在之前建立所需要的使用者，例如：`RUN groupadd -r postgres && useradd -r -g postgres postgres`。要臨時獲取管理員權限可以使用 `gosu`，而不推薦 `sudo`。 ### WORKDIR 格式為 `WORKDIR /path/to/workdir`。 -為後續的 `RUN`、`CMD`、`ENTRYPOINT` 指令配置工作目錄。 +為後續的 `RUN`、`CMD`、`ENTRYPOINT` 指令指定工作目錄。 可以使用多個 `WORKDIR` 指令，後續命令如果參數是相對路徑，則會基於之前命令指定的路徑。例如 ``` @@ -95,9 +95,9 @@ RUN pwd ### ONBUILD 格式為 `ONBUILD [INSTRUCTION]`。 -配置當所創建的鏡像作為其它新創建鏡像的基礎鏡像時，所執行的操作指令。 +指定當建立的映像檔作為其它新建立映像檔的基底映像檔時，所執行的操作指令。 -例如，Dockerfile 使用如下的內容創建了鏡像 `image-A`。 +例如，Dockerfile 使用如下的內容建立了映像檔 `image-A`。 ``` [...] ONBUILD ADD . /app/src @@ -105,7 +105,7 @@ ONBUILD RUN /usr/local/bin/python-build --dir /app/src [...] ``` -如果基於 image-A 創建新的鏡像時，新的Dockerfile中使用 `FROM image-A`指定基礎鏡像時，會自動執行 `ONBUILD` 指令內容，等價於在後面添加了兩條指令。 +如果基於 image-A 建立新的映像檔時，新的 Dockerfile 中使用 `FROM image-A`指定基底映像檔時，會自動執行 `ONBUILD` 指令內容，等於在後面添加了兩條指令。 ``` FROM image-A @@ -114,5 +114,4 @@ ADD . /app/src RUN /usr/local/bin/python-build --dir /app/src ``` -使用 `ONBUILD` 指令的鏡像，推薦在標簽中註明，例如 `ruby:1.9-onbuild`。 - +使用 `ONBUILD` 指令的映像檔，推薦在標簽中註明，例如 `ruby:1.9-onbuild`。