Dockerfile注意事项

准则

  1. 尽可能将Dockerfile放在空目录中,若是目录中必须有其余文件,则使用.dockerignore文件。
  2. 避免安装没必要须的包。
  3. 每一个容器应该只关注一个功能点。
  4. 最小化镜像的层数。
  5. 多行参数时应该分类。这样更清晰直白,便于阅读和review,另外,在每一个换行符\前都增长一个空格。
  6. 对构建缓存要有清楚的认识。

指令注意事项

FROM

    Dockerfile reference for the FROM instruction
  任什么时候候,尽可能使用官方镜像源做为你镜像的基础镜像。咱们建议使用Debian Image,由于其被很好地管理着,而且做为一个完整的发布包,但体积却保持着最小化(当前不足150MB)。
  1. FROM必须是除了注释之外的第一行;
  2. 能够有多个FROM语句,来建立多个image;
  3.html

LABEL

  Dockerfile reference for the LABEL instructiongit

RUN

  Dockerfile reference for the RUN instruction
  RUN语句有两种格式:
1. RUNgithub

apt-get

  尽可能避免使用RUN apt-get upgrade或者dist-upgrade,由于基础镜像的不少核心包不会再未受权的容器中升级。
  要结合RUN apt-get update和apt-get install在同一个RUN语句下一块儿使用。如:web

RUN apt-get update && apt-get install -y \
        package-bar \
        package-baz \
        package-foo

  若是将update和install分开使用,执行多个Dockerfile时,会引发缓存问题,致使后面执行的install语句会失败。
  另外,执行完apt-get语句后,最后最好加上删除安装包的语句,以减少镜像的体积。如:docker

RUN apt-get update && apt-get install -y \
    aufs-tools \
    automake \
    build-essential \
 && rm -rf /var/lib/apt/lists/*

  注意:官方的Debian和Ubuntu镜像会自动执行“RUN apt-get clean”,因此不须要明确地删除指令。shell

管道使用

  不少RUN命令都须要使用到管道,如:数据库

RUN wget -O - https://some.site | wc -l > /number

  Docker使用/bin/sh -c解释器来执行这些命令,该解释器只评估管道最后一个操做的返回值来判断整个命令是否成功。在上面的例子中,只要wc -l命令成功了,即便wget命令失败了,也会建立一个新镜像。为了不上述状况,能够在语句首部加上set -o pipefail &&。好比:缓存

RUN set -o pipefail && wget -O - https://some.site | wc -l > /number

  注意:并不是全部的shell都支持-o pipefail选项,好比说基于Debian的镜像下的模式shell:dash shell。这种状况下,咱们可使用exec格式的RUN命令来显示地选择shell来支持pipefail选项。如:bash

RUN ["/bin/bash", "-c", "set -o pipefail && wget -O - https://some.site | wc -l > /number"]

CMD

  Dockerfile reference for the CMD instruction
  CMD语句与RUN不一样,RUN是在build镜像的时候运行,而CMD语句是在build结束后运行。一个Dockerfile钟能够有多个RUN语句,虽然也能够有多个CMD语句,可是却只有最后一条CMD语句会执行。CMD语句格式为:服务器

CMD [“executable”, “param1”, “param2”…]

EXPOSE

  Dockerfile reference for the EXPOSE instruction
  EXPOSE指令指明容器会监听连接的端口。所以,最好使用经常使用的、传统的应用端口。好比,Apache web服务器使用EXPOSE 80等。
  为了给外部连接使用,你须要使用docker run命令来制定容器端口和host端口的映射。

ENV

  Dockerfile reference for the ENV instruction
  用于设置环境变量,设置后,后面的RUM指令就可使用以前的环境变量了。同时,还能够经过docker run --env key=value,在容器启动时设置环境变量。如:

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和COPY

Dockerfile reference for the ADD instruction
Dockerfile reference for the COPY instruction
  虽然ADD和COPY功能类似,但通常来说,更建议使用COPY。由于COPY比ADD更透明,COPY只支持从本地文件到容器的拷贝,可是ADD还有一些其余不明显的特性(好比本地tar包解压缩和远程URL支持)。所以,ADD的最优用处是本地tar包自动解压缩到镜像中。如:ADD rootfs.tar.xz /。
  若是有多个Dockerfile步骤用于处理不一样的文件,建议分开COPY它们,而不是一次性拷贝。这能够保证每一个步骤的build缓存只在对应的文件改变时才无效。好比:

COPY requirements.txt /tmp/
RUN pip install --requirement /tmp/requirements.txt
COPY . /tmp/

  镜像的大小很重要,所以不鼓励使用ADD从远端URL获取包;可使用curl或者wget来代替。这种方式你能够删除再也不须要的文件,如解压缩后的tar包,从而不须要再添加额外的layer到镜像中。好比,你应该避免这样使用:

ADD http://example.com/big.tar.xz /usr/src/things/
RUN tar -xJf /usr/src/things/big.tar.xz -C /usr/src/things
RUN make -C /usr/src/things all

  而应该如此:

RUN mkdir -p /usr/src/things \
    && curl -SL http://example.com/big.tar.xz \
    | tar -xJC /usr/src/things \
    && make -C /usr/src/things all

  对于不须要使用ADD命令tar包自动解压缩功能的文件和目录,你应该老是使用COPY。

ENTRYPOINT

Dockerfile reference for the ENTRYPOINT instruction
  使用ENTRYPOINT来设置镜像的主命令,就像这个镜像运行时就是这条命令同样(而后再使用CMD做为默认的flag)。
  咱们使用s3cmd命令做为镜像的主命令。

ENTRYPOINT ["s3cmd"]
CMD ["--help"]

VOLUME

Dockerfile reference for the VOLUME instruction
  VOLUME指令通常用于数据库的存储区域,配置存储,或者docker容器建立的文件和目录。

USER

Dockerfile reference for the USER instruction
  若是服务能够在不须要特权的状况下运行,那么就应该使用USER来切换用户至非root用户。能够用RUN命令建立用户组和用户如:

RUN groupadd -r postgres && useradd -r -g postgres postgres

  应该避免安装和使用sudo,由于它有不可预知的TTY和信号转移特性,会产生不少问题。若是的确必定要使用相似sudo的功能(如root下初始化daemon,非root下运行),可使用“gosu”。

WORKDIR

Dockerfile reference for the WORKDIR instruction
  为了Dockerfile内容更加清晰和可靠,最好老是使用绝对路径。一样地,应该使用WORKDIR,而不是使用相似“cd … && do-something”这样的指令,由于那样会致使难以阅读、查找错误和维护。

ONBUILD

Dockerfile reference for the ONBUILD instruction

其余资源

Dockerfile Best Practices
Dockerfile Reference
https://github.com/docker-library/buildpack-deps/blob/master/jessie/Dockerfile
.dockerignore file
http://dockone.io/article/2034
https://docs.resin.io/deployment/build-optimisation/
  
others

相关文章
相关标签/搜索