Dockerfile命令详解之 ARG

缺乏、安全感 2024-04-07 12:19 64阅读 0赞

许多同学不知道Dockerfile应该如何写，不清楚Dockerfile中的指令分别有什么意义，能达到什么样的目的，接下来我将在[容器化][Link 1]专栏中详细的为大家解释每一个指令的含义以及用法。  
[专栏订阅传送门![icon-default.png_t_M85B][]https://blog.csdn.net/qq\_38220908/category\_11989778.html][Link 1]

指令不区分大小写。但是，按照惯例，它们应该是大写的，以便更容易地将它们与参数区分开来。([引用至官方文档>>>][Link 2])

![4c9a5ebafce44f1d9aef5dcf5030070c.jpeg][]

[【开发云】年年都是折扣价，不用四处薅羊毛][Link 3]

--------------------

### 语法 ###

ARG <name>[=<default value>]

ARG指令用于定义一个变量，用户可以在构建Docker镜像的时候，使用 --build-arg 定义变量的值。比如：

我们新建一个Dockerfile文件，使用ARG定义参数username，这里我们没有赋予默认值

FROM ubuntu
    ARG username
    RUN echo $username

然后我们使用以下命令构建镜像，我们可以看到RUN echo $username被替换成了RUN echo 清风怎不知意

docker build --build-arg username=清风怎不知意 -t myapp:tag-v0.0.1 .

![5de90fc271a644a1a3c93a2e798850f5.png][]

> 来自Docker官方的警告：
> 
> 不建议在构建时使用ARG传递密钥、用户凭证等信息，因为构建时的信息是任何用户都可以通过docker history看到的！！！！！！！！！

我们也可以使用 ARG username=默认姓名 赋予变量默认值。

我们还可以利用ARG指令，声明基础镜像的版本，使其在构建的时候可以通过--build-arg选项对镜像版本进行修改，比如：

Dockerfile

ARG BASE_VERSION=latest
    FROM openjdk:$BASE_VERSION
    RUN echo $BASE_VERSION

当我们运行命令 docker build . 的时候，没有使用--build-arg 定义BASE\_VERSION的值，所以BASE\_VERSION取默认值latest，实际拉取的基础镜像版本是 openjdk:latest

![a30565f6cd9045c1b649bfc7b3c1e550.png][]

当我们运行命令docker build --build-arg BASE\_VERSION=11 . 的时候，BASE\_VERSION的值为11，所以实际拉取的镜像版本是 openjdk:11

![954d538b134b41a4a36ca289d0269f59.png][]

> **注意：**
> 
>  在FROM指令前使用ARG指令定义的变量，只能用于FROM指令。所以，Dockerfile第三行的 RUN echo $BASE\_VERSION指令，并未取到值！！！

### 作用域 ###

上面的例子我们可以看到，ARG声明的变量是有作用域限制的。接下来我们说说ARG指令定义变量的作用域。

#### 1、与常规变量的定义一样，变量的生效时间，都是在被定义之后。 ####

比如：

Dockerfile

FROM ubuntu
    
    # 定义环境变量
    ENV MYENV=test
    RUN echo $MYENV
    
    # 覆盖定义的环境变量
    ARG MYENV
    RUN echo $MYENV

使用以下命令构建镜像文件

docker build --build-arg MYENV=pre -t myapp:tag-v0.0.2 .

运行的结果为：

![ccfeeff5ec254a138ab57f041e5089bb.png][]

第一次RUN 指令 echo 的值是test，第二次RUN指令 echo 的值是pre，我们可以看到ARG指令只影响到了其后面的变量值。

如果我们构建镜像的时候，不指定参数值，那么ARG指令声明的MYENV变量的值，会以上面EVN指令定义的值为默认值

docker build -t myapp:tag-v0.0.2 .

可以看到，两次RUN指令echo的值都是与ENV指令定义的值一样的

![97a75f149dec4e92a6a6e6d0c94e04e2.png][]

#### 2、 ARG指令声明的变量在当前构建阶段完成后失效 ####

相当于在函数内声明的变量，只能在该函数内生效。所以在进行多阶段构建时，每个阶段都必须重新使用ARG指令声明变量。

*  **错误使用方式**

多阶段构建Dockerfile

FROM ubuntu
    ARG SETTINGS=12
    RUN echo $SETTINGS
    
    FROM ubuntu
    RUN echo $SETTINGS

使用以下命令构建镜像

docker build  --no-cache .

我们可以看到，我们在第一阶段声明的SETTINGS参数，在第二阶段构建的时候，SETTINGS未取值

![51bde828614745f0ab94274d8b3c2f80.png][]

*  **正确使用方式**

当我们为第二阶段使用ARG声明参数后，再次构建，可以看到，此时变量SETTINGS的值变为了22

多阶段构建Dockerfile

FROM ubuntu
    ARG SETTINGS=12
    RUN echo $SETTINGS
    
    FROM ubuntu
    ARG SETTINGS=22
    RUN echo $SETTINGS

![880a1fa79e974ec898f6f214cf6bd316.png][]

> 我们可以使用ARG或者ENV指令指定RUN指令可用的变量，但是ENV指令定义的环境变量，会覆盖ARG定义的同名变量

### 预定义变量 ###

Docker提供以下预定义变量

>  *  `HTTP_PROXY`
>  *  `http_proxy`
>  *  `HTTPS_PROXY`
>  *  `https_proxy`
>  *  `FTP_PROXY`
>  *  `ftp_proxy`
>  *  `NO_PROXY`
>  *  `no_proxy`
>  *  `ALL_PROXY`
>  *  `all_proxy`

针对以上预定义的变量，我们同样可以使用--build-arg给他们赋值，并且，这些预定义变量不会被docker history所记录，能够相对安全的保护这部分敏感信息。

如果我们需要改变预定义变量的行为，我们可以在Dockerfile中声明同名变量，比如我们在Dockerfile中使用指令 ARG HTTP\_PROXY重新声明了预定义变量，这时候，我们在构建镜像的时候，docker history就会记录下它的值，失去对此信息的保护，并且，更改HTTP\_PROXY的值会使构建的缓存失效。

\[1\] 感谢大佬 [@kenllf][kenllf] 的斧正

[Link 1]: https://blog.csdn.net/qq_38220908/category_11989778.html
[icon-default.png_t_M85B]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/c81803cd23c347a1b0d985df6ae6ff1a.png
[Link 2]: https://docs.docker.com/engine/reference/builder/#format
[4c9a5ebafce44f1d9aef5dcf5030070c.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f641a2756c924181a5b4f6ef812476cd.jpeg
[Link 3]: https://dev.csdn.net/activity?utm_source=sale_source&sale_source=vECxzD2gAz
[5de90fc271a644a1a3c93a2e798850f5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/b1297b51b43a4562887769eb314ad4a3.png
[a30565f6cd9045c1b649bfc7b3c1e550.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/98ca47eb16864125b991d128aabc8db9.png
[954d538b134b41a4a36ca289d0269f59.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/572a7812ff5e4621a5ce4c24de894228.png
[ccfeeff5ec254a138ab57f041e5089bb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8a474122937544e69f746e85ee670d29.png
[97a75f149dec4e92a6a6e6d0c94e04e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/b4ee94a4342149b783ab11a09f8a0c58.png
[51bde828614745f0ab94274d8b3c2f80.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/9b2360a826ab4cf2880420a3489a7d3d.png
[880a1fa79e974ec898f6f214cf6bd316.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/9b0fa4b294364e11812871be05944a14.png
[kenllf]: https://blog.csdn.net/kenllf?type=blog