Dockerfile 语法详解网站首页 学无止境

Dockerfile 语法详解

java_prinln 2024-06-14 17:18:54

简介Dockerfile 语法详解

Dockerfile语法命令

企业生产环境推荐使用Dockerfile制作镜像，Dockerfile制作原理，将基于一个基础镜像，通过编写Dockerfile方式，将各个功能进行叠加，最终形成新的Docker镜像，是目前互联网企业中打包镜像最为推荐的方式。
Dockerfile是一个镜像的表示，也是一个镜像的原材料，可以通过Dockerfile来描述构建镜像，并自动构建一个容器。

如下为DockerFile制作镜像，必备的指令和参数的详解：

FROM	      指定所创建镜像的基础镜像; from 
MAINTAINER	  指定维护者信息;         maintainer 
RUN	          运行命令;              run
CMD	          指定启动容器时默认执行的命令; cmd
LABEL	      指定生成镜像的元数据标签信息; label
EXPOSE	      声明镜像内服务所监听的端口; export
ENV	          指定环境变量; env
ADD	          赋值指定的<src>路径下的内容到容器中的<dest>路径下，<src>可以为URL；如果为tar文件，会自动解压到<dest>路径下 add 
COPY	      赋值本地主机的<scr>路径下的内容到容器中的<dest>路径下；一般情况下推荐使用COPY而不是ADD; copy 
ENTRYPOINT	 指定镜像的默认入口; entrypoint
VOLUME	     创建数据挂载点;  volume
USER	    指定运行容器时的用户名或UID;  user
WORKDIR	    配置工作目录; workdir
ARG	       指定镜像内使用的参数(例如版本号信息等); arg
ONBUILD	    配置当前所创建的镜像作为其他镜像的基础镜像时，所执行的创建操作的命令;       onbuild 
STOPSIGNAL	 容器退出的信号; stopsignal
HEALTHCHECK	  如何进行健康检查; healthcheck
SHELL	      指定使用SHELL时的默认SHELL类型; shell

Dockerfile 语法（含义）详解

FROM指定所创建的镜像的基础镜像，如果本地不存在，则默认会去Docker Hub下载指定镜像。
格式为：FROM<image>，或FROM<image>:<tag>，或FROM<image>@<digest>。任何Dockerfile中的第一条指令必须为FROM指令。并且，如果在同一个Dockerfile文件中创建多个镜像，可以使用多个FROM指令(每个镜像一次)。

MAINTAINER指定维护者信息，格式为MAINTAINER<name>。例如：
MAINTAINER image_creator@docker.com
该信息将会写入生成镜像的Author属性域中。

RUN运行指定命令。
格式为：RUN<command>或RUN ["executable","param1","param2"]。
注意：后一个指令会被解析为json数组，所以必须使用双引号。
前者默认将在shell终端中运行命令，即/bin/sh -c；后者则使用exec执行，不会启动shell环境。
指定使用其他终端类型可以通过第二种方式实现，例如：
RUN ["/bin/bash","-c","echo hello"]
每条RUN指令将在当前镜像的基础上执行指定命令，并提交为新的镜像。当命令较长时可以使用换行。例如：
RUN apt-get update 
&& apt-get install -y libsnappy-dev zliblg-dev libbz2-dev 
&& rm -rf /var/cache/apt

CMD用来指定启动容器时默认执行的命令。它支持三种格式：
CMD ["executable","param1","param2"] 使用exec执行，是推荐使用的方式；
CMD param1 param2 在/bin/sh中执行，提供给需要交互的应用；
CMD ["param1","param2"] 提供给ENTRYPOINT的默认参数。
每个Dockerfile只能有一条CMD命令。如果指定了多条命令，只有最后一条会被执行。入股用户启动容器时指定了运行的命令(作为run的参数)，则会覆盖掉CMD指定的命令。


LABEL指令用来生成用于生成镜像的元数据的标签信息。
格式为：LABEL <key>=<value> <key>=<value> <key>=<value> ...。
例如：
LABEL version="1.0"
LABEL description="This text illustrates  that label-values can span multiple lines."

EXPOSE声明镜像内服务所监听的端口。
格式为：EXPOSE <port> [<port>...]
例如：
EXPOSE 22 80 443 3306
注意：该命令只是起到声明租用，并不会自动完成端口映射。在容器启动时需要使用-P(大写P)，Docker主机会自动分配一个宿主机未被使用的临时端口转发到指定的端口；使用-p(小写p)，则可以具体指定哪个宿主机的本地端口映射过来。


ENV指定环境变量，在镜像生成过程中会被后续RUN指令使用，在镜像启动的容器中也会存在。
格式为：ENV <key><value>或ENV<key>=<value>...。
例如：
ENV GOLANG_VERSION 1.6.3
ENV GOLANG_DOWNLOAD_RUL https://golang.org/dl/go$GOLANG_VERSION.linux-amd64.tar.gz
ENV GOLANG_DOWNLOAD_SHA256 cdd5e08530c0579255d6153b08fdb3b8e47caabbe717bc7bcd7561275a87aeb
RUN curl -fssL "$GOLANG_DOWNLOAD_RUL" -o golang.tar.gz && echo "$GOLANG_DOWNLOAD_SHA256 golang.tar.gz" | sha256sum -c - && tar -C /usr/local -xzf golang.tar.gz && rm golang.tar.gz
ENV GOPATH $GOPATH/bin:/usr/local/go/bin:$PATH

RUN mkdir -p "$GOPATH/bin" && chmod -R 777 "$GOPATH"
指令指定的环境变量在运行时可以被覆盖掉，如docker run --env <key>=<value> built_image。

ADD该指令将复制指定的<src>路径下的内容到容器中的<dest>路径下。
格式为：ADD<src> <dest>
其中<src>可以使Dockerfile所在目录的一个相对路径(文件或目录)，也可以是一个URL，还可以是一个tar文件(如果是tar文件，会自动解压到<dest>路径下)。<dest>可以使镜像内的绝对路径，或者相当于工作目录(WORKDIR)的相对路径。路径支持正则表达式，例如：
ADD *.c /code/

COPY复制本地主机的<src>(为Dockerfile所在目录的一个相对路径、文件或目录)下的内容到镜像中的<dest>下。目标路径不存在时，会自动创建。路径同样支持正则。格式为：COPY <src> <dest>当使用本地目录为源目录时，推荐使用COPY。
ENTRYPOINT指定镜像的默认入口命令，该入口命令会在启动容器时作为根命令执行，所有传入值作为该命令的参数。
支持两种格式：
ENTRYPOINT ["executable","param1","param2"] (exec调用执行)；
ENTRYPOINT command param1 param2(shell中执行)。
此时，CMD指令指定值将作为根命令的参数。
每个Dockerfile中只能有一个ENTRYPOINT，当指定多个时，只有最后一个有效。
在运行时可以被--entrypoint参数覆盖掉，如docker run --entrypoint。
VOLUME
创建一个数据卷挂载点。
格式为：VOLUME ["/data"]
可以从本地主机或者其他容器挂载数据卷，一般用来存放数据库和需要保存的数据等。

USER
指定运行容器时的用户名或UID，后续的RUN等指令也会使用特定的用户身份。格式为：USER daemon
当服务不需要管理员权限时，可以通过该指令指定运行用户，并且可以在之前创建所需要的用户。例如：
RUN groupadd -r nginx && useradd -r -g nginx nginx要临时获取管理员权限可以用gosu或者sudo。
WORKDIR为后续的RUN、CMD和ENTRYPOINT指令配置工作目录。
格式为：WORKDIR /path/to/workdir。
可以使用多个WORKDIR指令，后续命令如果参数是相对的，则会基于之前命令指定的路径。例如：
WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd
则最终路径为/a/b/c

ARG指定一些镜像内使用的参数(例如版本号信息等)，这些参数在执行docker build命令时才以--build-arg<varname>=<value>格式传入。格式为：ARG<name>[=<default value>]。
则可以用docker build --build-arg<name>=<value>来指定参数值。
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 following
ONBUILD ADD . /app/src
ONBUILD RUN /usr/local/bin/python-build --dir /app/src
使用ONBUILD指令的镜像，推荐在标签中注明，例如：ruby:1.9-onbuild。
STOPSIGNAL
指定所创建镜像启动的容器接收退出的信号值。例如：
STOPSIGNAL singnal
HEALTHCHECK配置所启动容器如何进行健康检查(如何判断是否健康)，自Docker 1.12开始支持。格式有两种：
HEALTHCHECK [OPTIONS] CMD command    ：根据所执行命令返回值是否为0判断；HEALTHCHECK NONE:禁止基础镜像中的健康检查。
 [OPTION]支持：
--inerval=DURATION  (默认为：30s)：多久检查一次；
--timeout=DURATION  (默认为：30s)：每次检查等待结果的超时时间；
--retries=N 　　     (默认为：3)：如果失败了，重试几次才最终确定失败。
SHELL指定其他命令使用shell时的默认shell类型。
格式为： SHELL ["executable","parameters"]默认值为 ["bin/sh","-c"]。
注意：对于Windows系统，建议在Dockerfile开头添加# escape=`来指定转移信息。
创建镜像
编写Dockerfile之后，可以通过docker build命令来创建镜像。
基本的docker build [选项] 内容路径，该命令将读取指定路径下(包括子目录)的Dockerfile，并将该路径下的所有内容发送给Docker服务端，由服务端来创建镜像。因此除非生成镜像需要，否则一般建议放置Dockerfile的目录为空目录。
如果使用非内容路径下的Dockerfile，可以通过-f选项来指定其路径；
要指定生成镜像的标签信息，可以使用-t选项。
例如：指定Dockerfile所在路径为 /tmp/docker_builder/，并且希望生成镜像标签为build_repo/first_image，可以使用下面的命令：
docker build -t build_repo/first_image /tmp/docker_builder
使用.dockerignore文件
可以通过.dockeringore文件(每一行添加一条匹配模式)来让Docker忽略匹配模式路径下的目录和文件。例如：
# comment
*/tmp*
*/*/tmp*
tmp?
~*