docker_practice/dockerfile/instructions.md

118 lines
4.3 KiB
Markdown
Raw Normal View History

2014-10-10 09:30:53 +00:00
## 指令
指令的一般格式為 `INSTRUCTION arguments`,指令包括 `FROM`、`MAINTAINER`、`RUN` 等。
2014-10-10 09:30:53 +00:00
### FROM
格式為 `FROM <image>`或`FROM <image>:<tag>`。
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
第一條指令必須為 `FROM` 指令。並且如果在同一個Dockerfile中建立多個映像檔時可以使用多個 `FROM` 指令(每個映像檔一次)。
2014-10-10 09:30:53 +00:00
### MAINTAINER
格式為 `MAINTAINER <name>`,指定維護者訊息。
2014-10-10 09:30:53 +00:00
### RUN
格式為 `RUN <command>``RUN ["executable", "param1", "param2"]`
2014-10-10 09:30:53 +00:00
2014-11-24 14:37:20 +00:00
前者將在 shell 終端中運行命令,即 `/bin/sh -c`;後者則使用 `exec` 執行。指定使用其它終端可以透過第二種方式實做,例如 `RUN ["/bin/bash", "-c", "echo hello"]`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
每條 `RUN` 指令將在當前映像檔基底上執行指定命令,並產生新的映像檔。當命令較長時可以使用 `\` 來換行。
2014-10-10 09:30:53 +00:00
### CMD
支持三種格式
2014-11-20 02:22:16 +00:00
* `CMD ["executable","param1","param2"]` 使用 `exec` 執行,推薦使用;
* `CMD command param1 param2``/bin/sh` 中執行,使用在給需要互動的指令;
* `CMD ["param1","param2"]` 提供給 `ENTRYPOINT` 的預設參數;
2014-10-10 09:30:53 +00:00
指定啟動容器時執行的命令,每個 Dockerfile 只能有一條 `CMD` 命令。如果指定了多條命令,只有最後一條會被執行。
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
如果使用者啟動容器時候指定了運行的命令,則會覆蓋掉 `CMD` 指定的命令。
2014-10-10 09:30:53 +00:00
### EXPOSE
格式為 `EXPOSE <port> [<port>...]`
2014-10-10 09:30:53 +00:00
2014-11-24 14:37:20 +00:00
設定 Docker 伺服器容器對外的埠號,供外界使用。在啟動容器時需要透過 -PDocker 會自動分配一個埠號轉發到指定的埠號。
2014-10-10 09:30:53 +00:00
### ENV
格式為 `ENV <key> <value>`
2014-11-20 02:22:16 +00:00
指定一個環境變數,會被後續 `RUN` 指令使用,並在容器運行時保持。
2014-10-10 09:30:53 +00:00
例如
```
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>`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
該命令將複製指定的 `<src>` 到容器中的 `<dest>`
其中 `<src>` 可以是 Dockerfile 所在目錄的相對路徑;也可以是一個 URL還可以是一個 tar 文件(其複製後會自動解壓縮)。
2014-10-10 09:30:53 +00:00
### COPY
格式為 `COPY <src> <dest>`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
複製本地端的 `<src>`(為 Dockerfile 所在目錄的相對路徑)到容器中的 `<dest>`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
當使用本地目錄為根目錄時,推薦使用 `COPY`
2014-10-10 09:30:53 +00:00
### ENTRYPOINT
兩種格式:
2014-10-10 09:30:53 +00:00
* `ENTRYPOINT ["executable", "param1", "param2"]`
* `ENTRYPOINT command param1 param2`shell中執行
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
指定容器啟動後執行的命令,並且不會被 `docker run` 提供的參數覆蓋。
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
每個 Dockerfile 中只能有一個 `ENTRYPOINT`,當指定多個時,只有最後一個會生效。
2014-10-10 09:30:53 +00:00
### VOLUME
格式為 `VOLUME ["/data"]`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
建立一個可以從本地端或其他容器掛載的掛載點,一般用來存放資料庫和需要保存的資料等。
2014-10-10 09:30:53 +00:00
### USER
格式為 `USER daemon`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
指定運行容器時的使用者名稱或 UID後續的 `RUN` 也會使用指定使用者。
2014-10-10 09:30:53 +00:00
當服務不需要管理員權限時,可以透過該命令指定運行使用者。並且可以在之前建立所需要的使用者,例如:`RUN groupadd -r postgres && useradd -r -g postgres postgres`。要臨時取得管理員權限可以使用 `gosu`,而不推薦 `sudo`
2014-10-10 09:30:53 +00:00
### WORKDIR
格式為 `WORKDIR /path/to/workdir`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
為後續的 `RUN`、`CMD`、`ENTRYPOINT` 指令指定工作目錄。
2014-10-10 09:30:53 +00:00
可以使用多個 `WORKDIR` 指令,後續命令如果參數是相對路徑,則會基於之前命令指定的路徑。例如
2014-10-10 09:30:53 +00:00
```
WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd
```
則最終路徑為 `/a/b/c`
2014-10-10 09:30:53 +00:00
### ONBUILD
格式為 `ONBUILD [INSTRUCTION]`
2014-10-10 09:30:53 +00:00
2014-11-20 02:22:16 +00:00
指定當建立的映像檔作為其它新建立映像檔的基底映像檔時,所執行的操作指令。
2014-10-10 09:30:53 +00:00
例如Dockerfile 使用以下的內容建立了映像檔 `image-A`
2014-10-10 09:30:53 +00:00
```
[...]
ONBUILD ADD . /app/src
ONBUILD RUN /usr/local/bin/python-build --dir /app/src
[...]
```
2014-11-24 14:37:20 +00:00
如果基於 image-A 建立新的映像檔時,新的 Dockerfile 中使用 `FROM image-A`指定基底映像檔時,會自動執行 `ONBUILD` 指令內容,等於在後面新增了兩條指令。
2014-10-10 09:30:53 +00:00
```
FROM image-A
#Automatically run the following
ADD . /app/src
RUN /usr/local/bin/python-build --dir /app/src
```
2014-11-20 02:22:16 +00:00
使用 `ONBUILD` 指令的映像檔,推薦在標簽中註明,例如 `ruby:1.9-onbuild`