dockerfile ONBUILD 指令

基本信息

镜像中一个延迟触发的触发器，在作为其它容器的base时，会在from后面插入并在下一个from执行前执行这条命令。

示例：

ONBUILD ADD . /app/src
ONBUILD RUN /usr/local/bin/python-build --dir /app/src

如示例所示，所有的dockerfile指令都可以跟在ONBUILD后面。

当你构建一个基础镜像时这很有用，你可以再被使用时检查当前镜像的基础要求是否被满足，因为很多时候使用该镜像的人会对于配置和组件进行定制改造，这可能不满足基础镜像功能要求。

例如，如果你的镜像是一个可供重用的Python构建应用基础镜像，那么它需要应用源码需要被放置在一个特定的目录，在此之后需要调用一个构建脚本。你可能会想着增加一个AAD和RUN，但是因为你在这时还没有获取到应用源码，不同应用构建目录还可能存在差异。你只能提供一个模板给开发者，让其可以复制粘贴到他的Dockerfile中，但是这种方式效率很低，容易出错且难以更新，因为这个行为混合在了应用代码之中。

解决方法就是使用ONBUILD，将必要的操作延迟进行，在下一个构建阶段（build stage）和当前构建阶段之间执行。

那么，它时怎样工作的呢？

1. 当构建器遇到ONBUILD指令时，构建器给当前正在构建的镜像的元数据（metadata）增加一个触发器。这个指令除此之外不影响当前构建。
2. 构建的结束阶段，manifest中ONBUILD标签下面，会列出来镜像所有的触发器。可以使用docker inspeect命令查看。
3. 之后，该镜像可能会成为一个新景象的基础，使用FROM引入。在执行FROM指令时，向后的执行流会查找ONBUILD触发器，按照他们注册的顺序依次执行。如果任何一个触发器（trigger）执行失败，FROM指令会中断，导致整个构建流程失败。如果所有的触发器执行成功，FROM指令完成，同时构建正常进行。
4. 最后一个镜像执行之后，触发器被清理。换句话说，它们不能被继承。

注意：

1. ONBUILD不能链式调用，ONBUILD ONBUILD是非法语句
2. OBUILD指令可能不会触发FROM或者MAINTAINER

测试：

base.dockerfile:

FROM openjdk:11-jre-slim
ONBUILD RUN echo 'In base Image.'

son.dockerfile:

FROM base_image:0.0.1
RUN echo 'In sub image.'

运行脚本：

docker build -t base_image:0.0.1 -f base.dockerfile ../

Sending build context to Docker daemon  3.584kB
Step 1/2 : FROM openjdk:11-jre-slim
11-jre-slim: Pulling from library/openjdk
1efc276f4ff9: Pull complete
a2f2f93da482: Pull complete
12cca292b13c: Pull complete
d73cf48caaac: Pull complete
Digest: sha256:93af7df2308c5141a751c4830e6b6c5717db102b3b31f012ea29d842dc4f2b02
Status: Downloaded newer image for openjdk:11-jre-slim
 ---> 764a04af3eff
Step 2/2 : ONBUILD RUN echo 'In base Image.'
 ---> Running in 89dc0a60c6e4
Removing intermediate container 89dc0a60c6e4
 ---> 9edfd6851dca
Successfully built 9edfd6851dca
Successfully tagged base_image:0.0.1


docker build -t son_image:0.0.1 -f son.dockerfile ../

Sending build context to Docker daemon  3.584kB
Step 1/2 : FROM base_image:0.0.1
# Executing 1 build trigger
 ---> Running in cc7289c5603d
In base Image.
Removing intermediate container cc7289c5603d
 ---> abdbf8f32603
Step 2/2 : RUN echo 'In sub image.'
 ---> Running in 779c8d503215
In sub image.
Removing intermediate container 779c8d503215
 ---> 2f912d0726ea
Successfully built 2f912d0726ea
Successfully tagged son_image:0.0.1

参考文档

[1] ONBUILD doc