Dockerfile文件基本说明

# Dockerfile文件基本说明
## 基本定义
```shell
Dockerfile是一个包含用于组合映像的命令的文本文档。可以使用在命令行中调用任何命令。 Docker通过读取Dockerfile中的指令自动生成映像。

docker build命令用于从Dockerfile构建映像。可以在docker build命令中使用-f标志指向文件系统中任何位置的Dockerfile。
# 例如: docker build -f /path/to/a/Dockerfile
```

## 基本结构
```shell
# Dockerfile 一般分为四部分：
(1). 基础镜像信息
(2). 维护者信息
(3). 镜像操作指令
(4). 容器启动时执行指令

'#' 为 Dockerfile 中的注释。
```

## 文件说明
```shell
Docker从上到下的顺序运行Dockerfile的指令。为了指定基本映像，第一条指令必须是FROM。

一个声明以＃字符开头则被视为注释。

可以在Docker文件中使用RUN，CMD，FROM，EXPOSE，ENV等指令。
```

## 常用命令
### 01. FROM
```shell
# 命令作用: 指定基础镜像

# 命令格式:
	FROM <image>
	FROM <image>:<tag>
	FROM <image>@<digest>

# 命令示例:
	FROM mysql:5.6
	FROM harbor.sustech.edu.cn/dxbase/dx_nginx

# 备注说明:
	1). 必须为第一个命令, 即告诉别人，使用哪个基础镜像
	2). tag或digest是可选的，如果不使用这两个值时，会使用latest版本的基础镜像
```
### 02. MAINTAINER
```shell
# 命令作用: 维护者信息

# 命令格式:
	MAINTAINER <name>

# 命令示例:
	MAINTAINER HoiwanChang
	MAINTAINER Gao Qianjing<gaoqianjing@szdxsoft.com>

# 备注说明:
	1). 即告诉别人，谁创造了这个容器，谁来维护这个容器.
```
### 03. RUN
```shell
# 命令作用: 构建镜像时执行的命令, RUN用于在镜像容器中执行命令

# 命令格式:
	RUN <command>
	
# 命令示例:
	RUN mkdir -p /home/wwwroot/temporary_file/api
	RUN ln -s /home/wwwroot/temporary_file /home/wwwroot/temporary_file/api/temporary_file
	
# 备注说明:
	1). RUN指令创建的中间镜像会被缓存，并会在下次构建中使用。如果不想使用这些缓存镜像，可以在构建时指定--no-cache参数，如：docker build --no-cache
	2). RUN有两种命令执行方式,shell执行方式和exec执行方式，我们当前是shell执行方式.
	3). exec执行方式: RUN ["executable", "param1", "param2"]
	4). RUN告诉容器，想让它干什么，提供可执行的命令，在前面加上RUN即可.
```
### 04. ADD
```shell
# 命令作用: 将本地文件添加到容器中，tar类型文件会自动解压，可以访问网络资源，类似wget

# 命令格式:
	ADD <src>... <dest>          # 支持多源 -> 目的地
	ADD ["<src>",... "<dest>"]   # 用于支持包含空格的路径

# 命令示例:
	ADD http://1.2.3.4/enrollment/1.jar /opt/   # 使用网络资源
	ADD target/CI_COMMIT_SHA.jar /opt/          # 使用相对路径
	ADD hom* /mydir/                            # 添加所有以"hom"开头的文件
	ADD hom?.txt /mydir/                        # ? 替代一个单字符,例如："home.txt"
	ADD test relativeDir/                       # 添加 "test" 到 `WORKDIR`/relativeDir/
	ADD test /absoluteDir/                      # 添加 "test" 到 /absoluteDir/

# 备注说明: 
	1). tar类型文件会自动解压, 如果是网络压缩资源不会被解压.
	2). ADD相当于往容器中放点东西,拷贝文件,本地文件会自动解压;网络资源则不会.
```
### 05. COPY
```shell
# 命令作用: 功能类似ADD

# 命令格式:
	COPY <src> <dest>
	
# 命令示例:
	COPY check* /testdir/           # 拷贝所有 check 开头的文件
	COPY check?.log /testdir/       # ? 是单个字符的占位符，比如匹配文件 check1.log
	
# 备注说明:
	1). 功能类似ADD，但是是不会自动解压文件，也不能访问网络资源
	2). 如果仅仅是把本地的文件拷贝到容器镜像中，COPY命令是最合适不过的
```
### 06. CMD
```shell
# 命令作用: 构建容器后调用，也就是说在容器启动时才进行调用

# 命令格式:
	CMD ["executable","param1","param2"]  # 执行可执行文件，优先
	CMD ["param1","param2"]               # 设置了ENTRYPOINT，则直接调用ENTRYPOINT添加参数
	CMD command param1 param2             # 执行shell内部命令

# 命令示例:
	CMD echo "This is a test." | wc -
	CMD ["java","-Xms4096m","-Xmx6144m","-jar","/opt/admin-1.0-SNAPSHOT.jar","-Duser.timezone=GMT+08","--server.port=80"]
	
# 备注说明:
	1). CMD不同于RUN，CMD用于指定在容器启动时所要执行的命令，而RUN用于指定镜像构建时所要执行的命令.

```
### 07. ENTRYPOINT
```shell
# 命令作用: 配置容器，使其可执行化。配合CMD可省去"application"，只使用参数。

# 命令格式:
	ENTRYPOINT ["executable", "param1", "param2"]  # 可执行文件, 优先
	ENTRYPOINT command param1 param2  # shell内部命令
	
# 命令示例:
	FROM ubuntu
	ENTRYPOINT ["top", "-b"]
	CMD ["-c"]
	
# 备注说明:
	1). ENTRYPOINT与CMD非常类似，不同的是通过docker run执行的命令不会覆盖ENTRYPOINT，而docker run命令中指定的任何参数，都会被当做参数再次传递给ENTRYPOINT。
	2). Dockerfile中只允许有一个ENTRYPOINT命令，多指定时会覆盖前面的设置，而只执行最后的ENTRYPOINT指令。
```
### 08. LABEL
```shell
# 命令作用: 用于为镜像添加元数据, 通过Label来实现多维度的资源分组管理功能，以便灵活、方便地进行资源分配、调度、配置部署等管理工作，如：版本管理、监控和分析等

# 命令格式: 
	LABEL <key>=<value> <key>=<value> <key>=<value> ...

# 命令示例:
	LABEL version="1.0" description="k8s worker1"
	
# 备注说明:
	1). 指定多条元数据时不同元数据之间通过空格分隔。推荐将所有的元数据通过一条LABEL指令指定，以免生成过多的中间镜像。
```
### 09. ENV
```shell
# 命令作用: 设置环境变量

# 命令格式:
	ENV <key> <value>      # <key>之后的所有内容均会被视为其<value>的组成部分，因此一次只能设置一个变量
	ENV <key>=<value> ...  # 可以设置多个变量

# 命令示例:
	ENV PORT 80            # 设置PORT变量，端口为80
	ENV TZ "Asia/Shanghai" # 设置时区

# 备注说明:
	1). ENV设置多个变量，每个变量为一个"<key>=<value>"的键值对，如果<key>中包含空格，可以使用\来进行转义，也可以通过""来进行标示；另外，反斜线也可以用于续行
```
### 10. EXPOSE
```shell
# 命令作用: 指定于外界交互的端口

# 命令格式: 
	EXPOSE <port> [<port>...]
	
# 命令示例:
	EXPOSE 80                    # 一个端口
	EXPOSE 8080 443              # 多个端口
	EXPOSE 11211/tcp 11211/udp   # 多个端口 + 协议

# 备注说明:
	1). EXPOSE并不会让容器的端口访问到主机。要使其可访问，需要在docker run运行容器时通过-p来发布这些端口，或通过-P参数来发布EXPOSE导出的所有端口
```
### 11. VOLUME
```shell
# 命令作用: 用于指定持久化目录

# 命令格式: 
	VOLUME ["/path/to/dir"]
	
# 命令示例:
	VOLUME ["/data"]
	VOLUME ["/var/www", "/var/log/apache2", "/etc/apache2"]

# 备注说明: 一个卷可以存在于一个或多个容器的指定目录，该目录可以绕过联合文件系统，并具有以下功能:
	1). 卷可以在容器间共享和重用
	2). 容器并不一定要和其它容器共享卷
	3). 修改卷后会立即生效
	4). 对卷的修改不会对镜像产生影响
	5). 卷会一直存在，直到没有任何容器在使用它
```

### 12. WORKDIR
```shell
# 命令作用: 工作目录，类似于cd命令

# 命令格式: 
	WORKDIR /path/to/workdir
# 命令示例:
	WORKDIR /a  # 这时工作目录为/a
	WORKDIR b   # 这时工作目录为/a/b
	WORKDIR c   # 这时工作目录为/a/b/c
	
# 备注说明:
	1). 通过过WORKDIR设置工作目录后，Dockerfile中其后的命令RUN、CMD、ENTRYPOINT、ADD、COPY等命令都会在该目录下执行。
	2). 在使用docker run运行容器时，可以通过-w参数覆盖构建时所设置的工作目录
```

### 13. USER
```shell
# 命令作用: 指定运行容器时的用户名或 UID，后续的 RUN 也会使用指定用户。

# 命令格式:
	USER user
	USER user:group
	USER uid
	USER uid:gid
	USER user:gid
	USER uid:group
	
# 命令示例:
	USER www

# 备注说明:
	1). 使用USER指定用户时，可以使用用户名、UID或GID，或是两者的组合。
	2). 当服务不需要管理员权限时，可以通过该命令指定运行用户。并且可以在之前创建所需要的用户.
```

### 14. ARG
```shell
# 命令作用: 用于指定传递给构建运行时的变量

# 命令格式:
	ARG name=<value>
	
# 命令示例:
	ARG prod_dir=/home/wwwroot/api/schoolapi
	ARG build_user=www
	
# 备注说明: N/A

```

### 15. ONBUILD
```shell
# 命令作用: 用于设置镜像触发器

# 命令格式:
	ONBUILD [INSTRUCTION]
	
# 命令示例:
	ONBUILD ADD . /app/src
	ONBUILD RUN /usr/local/bin/python-build --dir /app/src
  
# 备注说明:
	1). 当所构建的镜像被用做其它镜像的基础镜像，该镜像中的触发器将会被钥触发
```