闲的蛋疼整理了一下Dockerfile的命令和参数备查

2024-09-11 19:55 由鹰的翅膀让我翱翔发表于 #其他

Dockerfile 主要指令及参数：

指令	主要参数	作用	用法示例
FROM	<image>[:<tag>] [AS <name>]	指定基础镜像	`FROM ubuntu:24.04 AS base`
RUN	<command> 或 ["executable", "param1", "param2"]	执行命令，通常用于安装软件包	`RUN apt-get update && apt-get install -y python3`
CMD	<command> 或 ["executable","param1","param2"]	指定容器启动时执行的命令	`CMD ["python3", "app.py"]`
LABEL	<key>=<value>	为镜像添加元数据	`LABEL version="1.0" description="This is my app"`
EXPOSE	<port>[/<protocol>]	声明容器运行时监听的端口	`EXPOSE 80/tcp`
ENV	<key>=<value>	设置环境变量	`ENV NODE_ENV production`
ADD	<src>... <dest>	复制文件，支持URL和自动解压	`ADD https://example.com/big.tar.xz /usr/src/things/`
COPY	[--chown=<user>:<group>] <src>... <dest>	复制文件或目录	`COPY --chown=user:group files* /data/`
ENTRYPOINT	["executable", "param1", "param2"]	设置容器的入口点，通常与CMD结合使用	`ENTRYPOINT ["nginx", "-g", "daemon off;"]`
VOLUME	["/data"]	创建挂载点，用于持久化数据	`VOLUME ["/var/log/"]`
USER	<user>[:<group>]	指定运行容器时的用户名或UID	`USER www-data`
WORKDIR	/path/to/workdir	设置工作目录	`WORKDIR /app`
ARG	<name>[=<default value>]	定义构建参数，可以在构建时传递	`ARG VERSION=latest`
ONBUILD	INSTRUCTION	为镜像添加触发器，执行特定命令	`ONBUILD RUN /usr/local/bin/python-build --dir /app/src`
STOPSIGNAL	signal	设置停止容器的系统调用信号	`STOPSIGNAL SIGTERM`
HEALTHCHECK	[OPTIONS] CMD command	定义容器健康检查	`HEALTHCHECK --interval=5m --timeout=3s CMD curl -f http://localhost/
SHELL	["executable", "parameters"]	覆盖默认shell	`SHELL ["/bin/bash", "-c"]`
COPY --from		从多阶段构建中复制文件	COPY --from=builder /app /app
RUN --mount		在构建时挂载目录或缓存	RUN --mount=type=cache,target=/root/.cache pip install -r requirements.txt

额外的参数和选项：

COPY和ADD指令：
- --chown=\<user\>:\<group\>
- --chmod=\<permissions>
- --from=\<name|index>
RUN指令：
- --mount=type=\<type>,target=\<path>,source=\<source>
- --network=\<network>
- --security=\<security-opt>
HEALTHCHECK指令选项：
- --interval=DURATION (默认: 30s)
- --timeout=DURATION (默认: 30s)
- --start-period=DURATION (默认: 0s)
- --retries=N (默认: 3)
ARG指令：
- 可以在FROM指令之前使用，影响基础镜像的选择
多阶段构建相关：
- FROM \<image\> AS \<stage>
- COPY --from=\<stage\> \<src\> \<dest>

Dockerfile样例：

> #### 注意：此文件仅用于参考，不要直接使用


# 语法版本声明
# syntax=docker/dockerfile:1

# 定义构建参数
ARG BASE_IMAGE=ubuntu:24.04

# 指定基础镜像
FROM ${BASE_IMAGE} AS base

# 设置维护者信息（已弃用，使用LABEL代替）
MAINTAINER John Doe <john.doe@example.com>

# LABEL添加元数据
# 代替MAINTAINER
LABEL org.opencontainers.image.authors="John Doe <john@example.com>"
LABEL version="1.0" description="这是一个示例Dockerfile"

# 设置环境变量
ENV APP_HOME=/app \
    NODE_ENV=production

# 设置工作目录
WORKDIR ${APP_HOME}

# 复制文件到镜像中
COPY --chown=node:node . .

# 添加远程文件到镜像中
ADD https://example.com/big.tar.xz /tmp/

# 运行命令
RUN apt-get update && apt-get install -y python3 \
    && apt-get clean \
    && rm -rf /var/lib/apt/lists/*

# 使用挂载运行命令（需要BuildKit支持）
RUN --mount=type=cache,target=/root/.cache \
    pip install -r requirements.txt

# 暴露端口
EXPOSE 8080

# 创建数据卷
VOLUME ["/data"]

# 设置默认用户
USER node

# 定义健康检查
HEALTHCHECK --interval=5m --timeout=3s \
  CMD curl -f http://localhost:8080/ || exit 1

# 设置容器启动时运行的命令
ENTRYPOINT ["node"]

# 设置默认命令
CMD ["app.js"]

# 设置停止信号
STOPSIGNAL SIGTERM

# 更改默认shell
SHELL ["/bin/bash", "-c"]

# 多阶段构建：新阶段
FROM base AS production

# 为子镜像添加触发器指令
ONBUILD RUN echo "This is triggered when used as a base image"

# 从之前阶段复制文件
COPY --from=base ${APP_HOME} ${APP_HOME}

> AI提醒构建Dockerfile时要注意的问题：
> - 某些指令（如HEALTHCHECK和RUN --mount）需要较新版本的Docker或特定的构建器（如BuildKit）才能使用。
> - 在实际使用中，您通常不会在一个Dockerfile中使用所有这些指令。应该根据项目需求选择适当的指令。
> - 指令的顺序很重要，特别是像FROM、ARG、ENV这样的指令，它们会影响后续指令的行为。
> - 多阶段构建（在此示例中使用FROM ... AS ...）是一种优化镜像大小和提高安全性的高级技术。
> - MAINTAINER指令已被弃用，建议使用LABEL来添加维护者信息。

参考:
[1] https://docs.docker.com/reference/dockerfile/
[2] https://docs.docker.com/build/concepts/dockerfile/