文档有点长，先列个目录
yaml文件
build
cap_add,cap_drop
cgroup_parent
command
configs
container_name
credential_spec
GMSA配置示例
depends_on
deploy 部署
devices
dns
dns_search
entrypoint
env_file
environment
expose
external_links
extar_hosts
healthcheck
images
init
isolation
labels
links
logging
network_mode
netwoeks
networks.aliases
networks.ipv4_address,ipv6_address
pid
ports
restart
secrets
security_opt
stop_grace_period
stop_signal
sysctls
tmpfs
ulimits
userns_mode
volumes 卷
volumes for srevices,swarms,stack files 服务，群集和堆栈文件的卷
卷装载的缓存选项（适用于MAC的DOCKER桌面）
域名，主机名，IPC，MAC_ADDRESS，特权，READ_ONLY，shm_size，stdin_open，TTY用户，working_dir
specifying durations 指定持续时间
specifying byte values 指定字节值
卷配置参考
driver
volumes.driver _opts
volumes.external
labels
volumes.name
网络配置参考
driver
bridge
overlay
HOST OR NONE
driver_opts
ipam
internal
yaml文件
./docker-compose.yml。
可以为此文件使用a .yml或.yaml扩展名。其他名字后缀其实也行
以使用类似Bash的${VARIABLE}语法在配置值中使用环境变量 - 有关完整详细信息，请参见变量替换
build
"服务除了可以基于指定的镜像，还可以基于一份 Dockerfile，在使用 up 启动之时执行构建任务，这个构建标签就是 build，
它可以指定 Dockerfile 所在文件夹的路径。Compose 将会利用它自动构建这个镜像，然后使用这个镜像启动服务容器。"
build 可以指定为包含构建上下文路径的字符串
services:
webapp:
build: ./dir
或者，作为具有在context下指定的路径的对象，以及可选的Dockerfile和args：
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1
如果您指定image和build，那么Compose将使用中指定的webapp和可选名称命名构建的图像：tagimage
build: ./dir
image: webapp:tag
这将产生一个名为webapp并标记为的图像，该图像tag是从构建的./dir。
"!!!使用docker stack deploy时的注意事项：
在以群集模式部署堆栈build时，将忽略该选项。 该docker stack命令不会在部署之前生成映像。"
context
包含Dockerfile的目录的路径，或者git存储库的URL。当提供的值是相对路径时，它将被解释为相对于Compose文件的位置
dickerfile
Compose使用一个替代文件进行构建。还必须指定一个构建路径。
args
添加构建参数，这是只能在构建过程中访问的环境变量。
首先，在Dockerfile中指定参数：
ARG buildno
ARG gitcommithash
RUN echo "Build number: $buildno"
RUN echo "Based on commit: $gitcommithash"
然后在build键下指定参数。您可以传递映射或列表：
build:
context: .
args:
buildno: 1
gitcommithash: cdc3b19
build:
context: .
args:
- buildno=1
- gitcommithash=cdc3b19
在Dockerfile中，如果您ARG在FROM指令之前指定， ARG则在下方的构建指令中不可用FROM。如果您需要一个参数在两个地方都可用，请在FROM说明中也指定它。 有关用法的详细信息，请参阅文档中的“ 了解ARGS和FROM之间的交互方式”部分。
您可以在指定构建参数时忽略该值，在这种情况下，构建时的值就是运行Compose的环境中的值。
args:
- buildno
- gitcommithash
cache_from
以3.2版文件格式添加
引擎用于缓存解析的镜像列表。
build:
context: .
cache_from:
- alpine:latest
- corp/web_app:3.14
labels
使用Docker标签将元数据添加到生成的图像中。您可以使用数组或字典。
建议您使用反向DNS表示法，以防止标签与其他软件使用的标签冲突。
build:
context: .
labels:
com.example.description: "Accounting webapp"
com.example.department: "Finance"
com.example.label-with-empty-value: ""
build:
context: .
labels:
- "com.example.description=Accounting webapp"
- "com.example.department=Finance"
- "com.example.label-with-empty-value"
shm_size
以3.5版文件格式添加
设置/dev/shm此构建容器的分区大小。指定为表示字节数的整数值或表示字节值的字符串。
build:
context: .
shm_size: '2gb'
build:
context: .
shm_size: 10000000
target
以3.4版文件格式添加
建立内定义的指定阶段Dockerfile。有关详细信息，请参见 多阶段构建文档。
build:
context: .
target: prod
cap_add,cap_drop
添加或删除容器拥有的宿主机的内核功能。请参阅man 7 capabilities以获取完整列表。
cap_add:
- ALL # # 开启全部权限
cap_drop:
- NET_ADMIN # 关闭 xxx
- SYS_ADMIN
!!! 在群模式下部署堆栈时，cap_add和cap_drop选项将被忽略
cgroup_parent
为容器指定一个可选的父cgroup
cgroup_parent: m-executor-abcd
在集群模式下部署堆栈cgroup_parent时，将忽略该选项
command
覆盖默认命令。
command: bundle exec thin -p 3000
该命令也可以是列表，类似于 dockerfile：
command: ["bundle", "exec", "thin", "-p", "3000"]
configs
使用按服务configs 配置，按服务授予对配置的访问权限。支持两种不同的语法变体。
!!!注意：该配置必须已经存在或已 在configs 此堆栈文件的顶级配置中定义，否则堆栈部署失败。
短语法
简短的语法变体仅指定配置名称。这将授予容器访问配置的权限，并将其安装在/<config_name> 容器内。源名称和目标安装点都设置为配置名称。
以下示例使用短语法来授予redis服务对my_config和my_other_config配置的访问权限。的值 my_config设置为file的内容./my_config.txt，并 my_other_config定义为外部资源，这意味着它已经在Docker中定义，可以通过运行docker config create 命令或通过其他堆栈部署进行定义。如果外部配置不存在，则堆栈部署失败并显示config not found错误。
以版本3.3文件格式添加。config 版本3.3和更高版本的撰写文件格式仅支持定义。
version: "3.7"
services:
redis:
image: redis:latest
deploy:
replicas: 1
configs:
- my_config
- my_other_config
configs:
my_config:
file: ./my_config.txt
my_other_config:
external: true
长语法
长语法提供了在服务的任务容器中如何创建配置的更多粒度。
source：Docker中存在的配置名称。
target：要在服务的任务容器中挂载的文件的路径和名称。/<source>如果未指定，则默认为。
uid和gid：服务的任务容器中拥有已挂载的配置文件的数字UID或GID。0如果未指定，则两者默认都在Linux上。Windows不支持。
mode：服务的任务容器中装入的文件的权限，以八进制表示法。例如，0444 表示世界可读。默认值为0444。由于配置文件已挂载在临时文件系统中，因此它们不可写，因此，如果设置可写位，则会将其忽略。可执行位可以设置。如果您不熟悉UNIX文件权限模式，则可能会发现此 权限计算器 很有用。
下面的示例设置的名称my_config，以redis_config在容器内，将模式设定为0440（组可读），并且将所述用户和组103。该redis服务无权访问该my_other_config 配置。
version: "3.7"
services:
redis:
image: redis:latest
deploy:
replicas: 1
configs:
- source: my_config
target: /redis_config
uid: '103'
gid: '103'
mode: 0440
configs:
my_config:
file: ./my_config.txt
my_other_config:
external: true
您可以授予服务访问多个配置的权限，并且可以混合长短语法。定义配置并不意味着授予对它的服务访问权限。
container_name
指定自定义容器名称，而不是生成的默认名称。
container_name: my-web-container
由于Docker容器名称必须唯一，因此如果您指定了自定义名称，则不能将服务扩展到1个以上的容器。尝试这样做会导致错误。
!!! 在集群模式下部署堆栈container_name时，将忽略该选项
credential_spec
以版本3.3文件格式添加。
该credential_spec选项已在v3.3中添加。文件格式版本3.8或更高版本支持将组托管服务帐户（gMSA）配置与撰写文件一起使用。
配置托管服务帐户的凭据规范。此选项仅用于使用Windows容器的服务。在credential_spec必须在格式file://<filename>或registry://<value-name>。
使用时file:，引用的文件必须存在于CredentialSpecs Docker数据目录的子目录中，默认情况下C:\ProgramData\Docker\ 在Windows上。以下示例从名为的文件中加载凭据规范 C:\ProgramData\Docker\CredentialSpecs\my-credential-spec.json：
credential_spec:
file: my-credential-spec.json
使用时registry:，将从守护程序主机上的Windows注册表中读取凭据规范。具有给定名称的注册表值必须位于：
HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs
以下示例从my-credential-spec 注册表中命名的值加载凭据规范：
credential_spec:
registry: my-credential-spec
GMSA配置示例
为服务配置gMSA凭据规范时，您只需使用即可指定凭据规范config，如以下示例所示：
version: "3.7"
services:
myservice:
image: myimage:latest
credential_spec:
config: my_credential_spec
configs:
my_credentials_spec:
file: ./my-credential-spec.json|
depends_on
服务之间的依赖性。服务依赖性导致以下行为：
docker-compose up以依赖性顺序启动服务。在以下示例中，db和redis在之前启动web。
docker-compose up SERVICE自动包含SERVICE的依赖项。在下面的示例中，docker-compose up web还将创建并启动db和redis。
docker-compose stop按依赖关系顺序停止服务。在以下示例中，web在db和之前停止redis。
简单的例子：
version: "3.7"
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
使用时需要注意以下几点depends_on：
depends_on在启动之前不会等待db并且redis要“准备就绪” web-仅在启动之前。如果需要等待服务准备就绪，请参阅控制启动顺序以 获取有关此问题的更多信息以及解决该问题的策略。
版本3不再支持的condition形式depends_on。
在以群体模式 3版本的Compose文件部署堆栈depends_on时，将忽略该选项 。
deploy 部署
以版本3文件格式添加。
指定与服务的部署和运行有关的配置。这只能部署到时生效群与 泊坞窗堆栈部署，并且被忽略docker-compose up和docker-compose run。
version: "3.7"
services:
redis:
image: redis:alpine
deploy:
replicas: 6
update_config:
parallelism: 2
delay: 10s
restart_policy:
condition: on-failure
有几个子选项可用：
端点模式
以版本3.3文件格式添加。
为连接到群集的外部客户端指定服务发现方法。
endpoint_mode: vip-Docker为服务分配了虚拟IP（VIP），该虚拟IP充当客户端访问网络上服务的前端。Docker在客户端与服务的可用工作节点之间路由请求，而客户端却不知道有多少节点正在参与服务或其IP地址或端口。（这是默认设置。）
endpoint_mode: dnsrr-DNS轮询（DNSRR）服务发现不使用单个虚拟IP。Docker设置服务的DNS条目，以便对服务名称的DNS查询返回IP地址列表，并且客户端直接连接到其中之一。在需要使用自己的负载平衡器或混合Windows和Linux应用程序的情况下，DNS轮询很有用。
version: "3.7"
services:
wordpress:
image: wordpress
ports:
- "8080:80"
networks:
- overlay
deploy:
mode: replicated
replicas: 2
endpoint_mode: vip
mysql:
image: mysql
volumes:
- db-data:/var/lib/mysql/data
networks:
- overlay
deploy:
mode: replicated
replicas: 2
endpoint_mode: dnsrr
volumes:
db-data:
networks:
overlay:
的选项endpoint_mode还可以在群集模式CLI命令docker service create上用作标志 。有关所有swarm相关docker命令的快速列表，请参阅Swarm模式CLI命令。
要了解有关群集模式下的服务发现和联网的更多信息，请参阅 群集模式主题中的配置服务发现。
deploy.labels
指定服务标签。这些标签仅在服务上设置，而不在服务的任何容器上设置。
version: "3.7"
services:
web:
image: web
deploy:
labels:
com.example.description: "This label will appear on the web service"
要在容器上设置标签，请使用labels之外的键deploy：
version: "3.7"
services:
web:
image: web
labels:
com.example.description: "This label will appear on all containers for the web service"
deploy.mode
任一global（正好一个每群节点容器）或replicated（容器的指定数量）。默认值为replicated。（要了解更多信息，请参阅群集主题 中的复制服务和全局服务。）
version: "3.7"
services:
worker:
image: dockersamples/examplevotingapp_worker
deploy:
mode: global
deploy.placement
指定约束和首选项的位置。有关语法以及约束和首选项的可用类型的完整说明，请参阅docker服务create文档。
version: "3.7"
services:
db:
image: postgres
deploy:
placement:
constraints:
- "node.role==manager"
- "engine.labels.operatingsystem==ubuntu 18.04"
preferences:
- spread: node.labels.zone
deploy.replicas
如果服务是replicated（默认）服务，请指定在任何给定时间应运行的容器数。
version: "3.7"
services:
worker:
image: dockersamples/examplevotingapp_worker
networks:
- frontend
- backend
deploy:
mode: replicated
replicas: 6
deploy.resources
配置资源约束。
更改了撰写文件版本3
该resources部分取代了旧的资源约束选项 在撰写第3版之前的文件（cpu_shares，cpu_quota，cpuset， mem_limit，memswap_limit，mem_swappiness）。请参阅将版本2.x升级到3.x， 以了解版本2和版本3的撰写文件格式之间的差异。
每个参数都是一个值，类似于其docker服务create对应项。
在此一般示例中，redis服务被限制为使用不超过50M的内存和0.50（不超过单个内核的50％）可用处理时间（CPU），并且具有保留20M的内存和0.25CPU时间（始终可用）。
version: "3.7"
services:
redis:
image: redis:alpine
deploy:
resources:
limits:
cpus: '0.50'
memory: 50M
memory: 50M
cpus: '0.25'
memory: 20M
以下主题描述了可用于设置群中服务或容器的资源约束的可用选项。
寻找用于在非群模式容器上设置资源的选项吗？
此处描述的选项特定于 deploy键和群模式。如果要在非群集部署中设置资源限制，请使用 Compose文件格式版本2 CPU，内存和其他资源选项。如果您还有其他问题，请参阅有关GitHub问题docker / compose / 4513的讨论。
内存不足异常（OOME）
服务或容器尝试使用的内存超过系统可用的内存，则可能会遇到内存不足异常（OOME），并且容器或Docker守护程序可能会被内核OOM杀手杀死。为防止这种情况的发生，请确保您的应用程序在具有足够内存的主机上运行
deploy.restart_policy
配置是否以及如何在退出容器时重新启动容器。替换 restart。
condition：其一none，on-failure或者any（默认值：any）。
delay：重新启动尝试之间等待的时间，指定为 持续时间（默认值：0）。
max_attempts：放弃之前尝试重新启动容器的次数（默认值：永不放弃）。如果重启未在configure内成功完成 window，则此尝试不会计入配置max_attempts值。例如，如果max_attempts设置为“ 2”，并且第一次尝试重启失败，则可能会尝试两次以上重启。
window：决定重新启动是否成功之前要等待的时间，指定为持续时间（默认值：立即决定）。
version: "3.7"
services:
redis:
image: redis:alpine
deploy:
restart_policy:
condition: on-failure
delay: 5s
max_attempts: 3
window: 120s
deploy.rollback_config
以3.7版文件格式添加。
配置在更新失败的情况下应如何回滚服务。
parallelism：一次要回滚的容器数。如果设置为0，则所有容器将同时回滚。
delay：每个容器组回滚之间等待的时间（默认为0s）。
failure_action：如果回滚失败，该怎么办。其中一个continue或者pause（默认pause）
monitor：更新每个任务以监视失败后的持续时间(ns|us|ms|s|m|h)（默认为0s）。
max_failure_ratio：在回滚期间可以容忍的故障率（默认为0）。
order：回滚期间的操作顺序。其中一个stop-first（旧任务，开始新的一个前停止），或者start-first（新的任务首先启动，并且正在运行的任务简单地重叠）（默认stop-first）
deploy.update_config
配置应如何更新服务。对于配置滚动更新很有用。以3.4版文件格式添加。
parallelism：一次更新的容器数。
delay：在更新一组容器之间等待的时间。
failure_action：如果更新失败，该怎么办。其中一个continue，rollback或者pause （默认：pause）。
monitor：更新每个任务以监视失败后的持续时间(ns|us|ms|s|m|h)（默认为0s）。
max_failure_ratio：更新期间可以容忍的故障率。
order：更新期间的操作顺序。其中一个stop-first（旧任务，开始新的一个前停止），或者start-first（新的任务首先启动，并且正在运行的任务简单重叠）（默认stop-first）注：仅支持V3.4及更高版本。
version: "3.7"
services:
vote:
image: dockersamples/examplevotingapp_vote:before
depends_on:
- redis
deploy:
replicas: 2
update_config:
parallelism: 2
delay: 10s
order: stop-first
不支持 DOCKER STACK DEPLOY
下面的子选项（支持docker-compose up和docker-compose run）是不支持的docker stack deploy或deploy关键的。
build
cgroup_parent
container_name
devices
tmpfs
external_links
links
network_mode
restart
security_opt
userns_mode
devices
设备映射列表。使用与--devicedocker client create选项相同的格式。
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
dns
自定义DNS服务器。可以是单个值或列表。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
dns_search
自定义DNS搜索域。可以是单个值或列表。
dns_search: example.com
dns_search:
- dc1.example.com
- dc2.example.com
entrypoint
覆盖默认入口点。
entrypoint: /code/entrypoint.sh
入口点也可以是列表，类似于 dockerfile：
entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]
注意
设置entrypoint两者都会覆盖使用ENTRYPOINTDockerfile指令在服务映像上设置的任何默认入口点，并清除映像上的任何默认命令-这意味着如果CMDDockerfile中有指令，则将其忽略。
env_file
从文件添加环境变量。可以是单个值或列表。
如果您使用指定了Compose文件docker-compose -f FILE，则in env_file的路径 相对于该文件所在的目录。
在环境部分中 声明的环境变量将覆盖这些值–即使这些值为空或未定义，也是如此。
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/runtime_opts.env
Compose期望环境文件中的每一行都采用VAR=VAL格式。以开头的行#被视为注释，并被忽略。空行也将被忽略。
# Set Rails/Rack environment
RACK_ENV=development
注意
如果您的服务指定了构建选项，则在构建过程中不会自动显示环境文件中定义的变量。使用的args子选项build来定义构建时环境变量。
的值按VAL原样使用，根本没有修改。例如，如果该值用引号引起来（通常是shell变量），则引号包含在传递给Compose的值中。
请记住，列表中文件的顺序对于确定分配给多次显示的变量的值很重要。列表中的文件从上至下进行处理。对于在file中指定并在file中a.env分配了不同值的相同变量 b.env，如果b.env在下面（之后）列出，则来自标准位的值b.env。例如，在中给出以下声明docker-compose.yml：
services:
some-service:
env_file:
- a.env
- b.env
和以下文件：
# a.env
VAR=1
和
# b.env
VAR=hello
$VAR是hello。
environment
添加环境变量。您可以使用数组或字典。任何布尔值（true，false，yes，no）都需要用引号引起来，以确保YML解析器不会将其转换为True或False。
仅具有键的环境变量在运行Compose的计算机上解析为它们的值，这对于秘密或特定于主机的值很有用。
environment:
RACK_ENV: development
SHOW: 'true'
SESSION_SECRET:
environment:
- RACK_ENV=development
- SHOW=true
- SESSION_SECRET
注意
如果您的服务指定了构建选项，environment则在构建过程中不会自动显示中定义的变量 。使用的 args子选项build来定义构建时环境变量。
expose
公开端口而不将其发布到主机上-只有链接的服务才能访问它们。只能指定内部端口。
expose:
- "3000"
- "8000"
external_links
链接到在此范围之外docker-compose.yml甚至在Compose之外开始的容器，尤其是对于提供共享或公共服务的容器。 同时指定容器名称和链接别名（）时，请external_links遵循与legacy选项相似的语义。linksCONTAINER:ALIAS
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql
注意
外部创建的容器必须连接到与其链接的服务相同的网络中的至少一个。链接 是旧选项。我们建议改为使用网络。
使用docker stack deploy时的注意事项
在集群模式下部署堆栈external_links时，将忽略该选项
extar_hosts
添加主机名映射。使用与docker client --add-host参数相同的值。
extra_hosts:
- "somehost:162.242.195.82"
- "otherhost:50.31.209.229"
在/etc/hosts此服务的内部容器中创建一个具有ip地址和主机名的条目，例如：
162.242.195.82 somehost
50.31.209.229 otherhost
healthcheck
配置运行的检查以确定该服务的容器是否“健康”。有关运行状况检查 如何工作的详细信息，请参阅文档中的 HEALTHCHECK Dockerfile指令。
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"]
interval: 1m30s
timeout: 10s
retries: 3
start_period: 40s
interval，timeout并start_period指定为 duration。
以3.4版文件格式添加。
该start_period选项以文件格式3.4添加。
test必须是字符串或列表。如果它是一个列表，第一项必须是NONE，CMD或CMD-SHELL。如果是字符串，则等效于指定CMD-SHELL后跟该字符串。
# Hit the local web app
test: ["CMD", "curl", "-f", "http://localhost"]
如上所述，但包裹在中/bin/sh。以下两种形式是等效的。
test: ["CMD-SHELL", "curl -f http://localhost || exit 1"]
test: curl -f https://localhost || exit 1
要禁用图像设置的任何默认运行状况检查，可以使用disable: true。这等效于指定test: ["NONE"]。
healthcheck:
disable: true
images
指定用于启动容器的图像。可以是存储库/标签或部分图像ID。
image: redis
image: ubuntu:18.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd
如果图像不存在，除非您还指定了build，否则Compose会尝试将其拉出，在这种情况下，它将使用指定的选项来构建它并使用指定的标签对其进行标记。
init
在容器内运行一个初始化程序，以转发信号并获取进程。设置此选项可以true为服务启用此功能。
version: "3.7"
services:
web:
image: alpine:latest
init: true
使用的默认初始化二进制文件是Tini，并安装在/usr/libexec/docker-init守护程序主机上。您可以通过init-path配置选项将守护程序配置为使用自定义init二进制文件 。
isolation
指定容器的隔离技术。在Linux上，唯一支持的值是default。在Windows中，可接受的值是default，process和 hyperv。 有关详细信息，请参阅 Docker Engine文档。
labels
使用Docker标签将元数据添加到容器中。您可以使用数组或字典。
建议您使用反向DNS表示法，以防止标签与其他软件使用的标签冲突。
labels:
com.example.description: "Accounting webapp"
com.example.department: "Finance"
com.example.label-with-empty-value: ""
labels:
- "com.example.description=Accounting webapp"
- "com.example.department=Finance"
- "com.example.label-with-empty-value"
links
该--link标志是Docker的遗留功能。它最终可能会被删除。除非您绝对需要继续使用它，否则建议您使用 用户定义的网络 来促进两个容器之间的通信，而不要使用--link。
用户定义的网络不支持的一项功能 --link是在容器之间共享环境变量。但是，您可以使用其他机制（例如卷）以更可控的方式在容器之间共享环境变量。
链接到另一个服务中的容器。指定服务名称和链接别名（"SERVICE:ALIAS"），或者仅指定服务名称。
web:
links:
- "db"
- "db:database"
- "redis"
可以使用与别名相同的主机名访问链接服务的容器，如果未指定别名，则可以使用服务名。
不需要链接即可使服务进行通信-默认情况下，任何服务都可以使用该服务的名称访问任何其他服务。（另请参见Compose中的Networking中的 Links主题。）
链接也以与depends_on相同的方式表示服务之间的依赖关系 ，因此它们确定了服务启动的顺序。
注意
如果同时定义链接和网络，则它们之间具有链接的服务必须共享至少一个公共网络才能进行通信。
使用docker stack deploy时的注意事项
在集群模式下部署堆栈links时，将忽略该选项
logging
服务的日志记录配置。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"
该driver 名称指定了服务容器的日志记录驱动程序，以及--log-driverdocker run选项（在此处记录）。
默认值为json-file。
driver: "json-file"
driver: "syslog"
driver: "none"
注意
只有json-file和journald驱动程序才能从docker-compose up和直接提供日志docker-compose logs。使用任何其他驱动程序不会打印任何日志。
使用options键为日志记录驱动程序指定日志记录选项，如的--log-opt选项docker run。
日志记录选项是键值对。syslog选项示例：
driver: "syslog"
options:
syslog-address: "tcp://192.168.0.42:123"
默认驱动程序json-file，具有用于限制存储的日志量的选项。为此，请使用键值对以获取最大存储大小和最大文件数：
options:
max-size: "200k"
max-file: "10"
上面显示的示例将存储日志文件，直到它们达到max-size200kB，然后旋转它们。各个日志文件的存储量由该max-file值指定。随着日志超出最大限制，将删除较旧的日志文件以允许存储新日志。
这是一个docker-compose.yml限制日志存储的示例文件：
version: "3.7"
services:
some-service:
image: some-service
logging:
driver: "json-file"
options:
max-size: "200k"
max-file: "10"
可用的日志记录选项取决于您使用的日志记录驱动程序
上面用于控制日志文件和大小的示例使用特定于json-file driver的选项。这些特定选项在其他日志记录驱动程序上不可用。有关受支持的日志记录驱动程序及其选项的完整列表，请参阅 日志记录驱动程序文档。
network_mode
网络模式。使用与docker client --network参数相同的值，以及特殊形式service:[service name]。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
!!! 在集群模式下部署堆栈时，将忽略此选项 ,network_mode: "host"不能与链接混合使用。
netwoeks
要加入的网络，引用顶级networks密钥下的条目 。
services:
some-service:
networks:
- some-network
- other-network
networks.aliases
网络上此服务的别名（备用主机名）。同一网络上的其他容器可以使用服务名称或此别名来连接到服务的容器之一。
由于aliases是网络范围的，因此同一服务在不同的网络上可以具有不同的别名。
注意
一个网络范围的别名可以被多个容器甚至多个服务共享。如果是这样，则不能保证名称解析到哪个容器。
一般格式如下所示。
services:
some-service:
networks:
some-network:
aliases:
- alias1
- alias3
other-network:
aliases:
- alias2
在下面的例子中，提供了三种服务（web，worker，和db），其中两个网络（沿new和legacy）。该db服务是在到达的主机名db或database上new网络，并db或mysql将上legacy网络。
version: "3.7"
services:
web:
image: "nginx:alpine"
networks:
- new
worker:
image: "my-worker-image:latest"
networks:
- legacy
db:
image: mysql
networks:
new:
aliases:
- database
legacy:
aliases:
- mysql
networks:
new:
legacy:
networks.ipv4_address,ipv6_address
加入网络后，为此服务的容器指定一个静态IP地址。
顶级网络部分中的相应网络配置 必须具有一个 ipam块，其中子网配置覆盖每个静态地址。
如果需要IPv6寻址，则enable_ipv6 必须设置该选项，并且必须使用版本2.x的Compose文件。 IPv6选项当前在群集模式下不起作用。
一个例子：
version: "3.7"
services:
app:
image: nginx:alpine
networks:
app_net:
ipv4_address: 172.16.238.10
ipv6_address: 2001:3984:3989::10
networks:
app_net:
ipam:
driver: default
config:
- subnet: "172.16.238.0/24"
- subnet: "2001:3984:3989::/64"
pid
pid: "host"
将PID模式设置为主机PID模式。这将打开容器和主机操作系统之间的PID地址空间共享。使用此标志启动的容器可以访问和操作裸机名称空间中的其他容器，反之亦然。
ports
露出端口。
注意
端口映射与 network_mode: host
短语法
要么指定两个端口（HOST:CONTAINER），要么仅指定容器端口（选择了临时主机端口）。
注意
当以该HOST:CONTAINER格式映射端口时，使用小于60的容器端口可能会遇到错误的结果，因为YAML会将格式xx:yy中的数字解析为以60为底的值。因此，我们建议始终将端口映射显式指定为字符串。
ports:
- "3000"
- "3000-3005"
- "8000:8000"
- "9090-9091:8080-8081"
- "49100:22"
- "127.0.0.1:8001:8001"
- "127.0.0.1:5000-5010:5000-5010"
- "6060:6060/udp"
- "12400-12500:1240"
长语法
长格式语法允许配置其他不能以短格式表示的字段。
target：容器内的端口
published：公开端口
protocol：端口协议（tcp或udp）
mode：host用于在每个节点上发布主机端口，或ingress使群集模式端口达到负载平衡。
ports:
- target: 80
published: 8080
protocol: tcp
mode: host
以3.2版文件格式添加。
长语法是v3.2文件格式的新语法
restart
no是默认的重启策略，在任何情况下都不会重启容器。当always指定时，容器总是重新启动。该 on-failure如果退出代码指示的故障错误政策重启的容器。
restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
!!! 使用docker stack deploy时的注意事项: 在以群集模式部署堆栈restart时，将忽略该选项 。
secrets
使用按服务secrets 配置，按服务授予对机密的访问权限。支持两种不同的语法变体。
使用docker stack deploy时的注意事项
该密码必须已经存在或 在撰写文件的顶级secrets配置中定义，否则堆栈部署将失败。
有关机密的更多信息，请参阅机密。
短语法
简短的语法变体仅指定秘密名称。这会授予容器访问机密的权限，并将其安装在/run/secrets/<secret_name> 容器内。源名称和目标安装点都设置为机密名称。
以下示例使用short语法授予redis服务对my_secret和my_other_secret秘密的访问权限。的值 my_secret设置为file的内容./my_secret.txt，并 my_other_secret定义为外部资源，这意味着它已经在Docker中定义，可以通过运行docker secret create 命令或通过其他堆栈部署进行定义。如果外部机密不存在，则堆栈部署将失败并显示secret not found错误。
version: "3.7"
services:
redis:
image: redis:latest
deploy:
replicas: 1
secrets:
- my_secret
- my_other_secret
secrets:
my_secret:
file: ./my_secret.txt
my_other_secret:
external: true
长语法
长语法提供了在服务的任务容器中如何创建机密的更细粒度。
source：秘密的名称，因为它存在于Docker中。
target：要/run/secrets/在服务的任务容器中挂载的文件的名称。source如果未指定，则默认为。
uid和gid：/run/secrets/在服务的任务容器中拥有文件的数字UID或GID 。0如果未指定，则两者都默认为。
mode：文件的权限以/run/secrets/ 八进制表示法装入服务的任务容器中。例如，0444 表示世界可读。Docker 1.13.1中的默认值为0000，但是是0444较新的版本。机密信息不可写，因为它们已安装在临时文件系统中，因此，如果设置了可写位，则会将其忽略。可执行位可以设置。如果您不熟悉UNIX文件权限模式，则可能会发现此 权限计算器 很有用。
的下面的示例集名称my_secret以redis_secret在容器内，将模式设定为0440（组可读）和套在用户和组103。该redis服务无权访问该my_other_secret 机密。
version: "3.7"
services:
redis:
image: redis:latest
deploy:
replicas: 1
secrets:
- source: my_secret
target: redis_secret
uid: '103'
gid: '103'
mode: 0440
secrets:
my_secret:
file: ./my_secret.txt
my_other_secret:
external: true
您可以授予服务访问多个机密的权限，并且可以混合长短语法。定义机密并不意味着授予服务对其的访问权限。
security_opt
覆盖每个容器的默认标签方案。
security_opt:
- label:user:USER
- label:role:ROLE
!!! 在以群集模式部署堆栈security_opt时，将忽略该选项 。
stop_grace_period
指定stop_signal在发送SIGKILL之前，如果容器无法处理SIGTERM（或已使用指定的任何停止信号）而试图停止容器的等待时间 。指定为持续时间。
stop_grace_period: 1s
stop_grace_period: 1m30s
默认情况下，stop在发送SIGKILL之前等待10秒以退出容器。
stop_signal
设置替代信号以停止容器。默认情况下stop使用SIGTERM。使用stop_signal原因设置替代信号会导致 stop发送该信号。
stop_signal: SIGUSR1
sysctls
要在容器中设置的内核参数。您可以使用数组或字典。
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0
您只能使用内核中已命名空间的sysctls。Docker不支持更改也会修改主机系统的容器内的sysctls。有关受支持的sysctls的概述，请参阅在运行时配置命名空间的内核参数（sysctls）。
使用docker stack deploy时的注意事项
在以集群模式部署堆栈时，此选项需要Docker Engine 19.03或更高版本 。
tmpfs
以3.6版文件格式添加。
在容器内安装一个临时文件系统。可以是单个值或列表。
tmpfs: /run
tmpfs:
- /run
- /tmp
使用docker stack deploy时的注意事项
在 以（3-3.5版）撰写文件以群集模式部署堆栈时，将忽略此选项 。
在容器内安装一个临时文件系统。Size参数指定tmpfs安装的大小（以字节为单位）。默认情况下不受限制。
- type: tmpfs
target: /app
tmpfs:
size: 1000
ulimits
覆盖容器的默认ulimit。您可以将单个限制指定为整数，也可以将软/硬限制指定为映射。
ulimits:
nproc: 65535
nofile:
soft: 20000
hard: 40000
userns_mode
userns_mode: "host"
如果Docker守护程序配置了用户名称空间，则禁用此服务的用户名称空间。有关更多信息，请参见dockerd。
使用docker stack deploy时的注意事项
在以群集模式部署堆栈userns_mode时，将忽略该选项 。
volumes 卷
挂载主机路径或命名卷，指定为服务的子选项。
您可以将主机路径安装为单个服务的定义的一部分，而无需在顶级volumes密钥中进行定义。
但是，如果要在多个服务之间重用卷，请在顶级volumes密钥中定义一个命名卷。将命名卷与服务，群集和堆栈文件一起使用。
更改为版本3文件格式。
顶级卷键定义了一个命名卷，并从每个服务的volumes列表中引用了该卷。这将替换volumes_from早期版本的Compose文件格式。
此示例显示了服务mydata正在使用的命名卷（）web，以及为单个服务（db服务 下的第一个路径volumes）定义的绑定安装。该db服务还使用一个名为dbdata（dbservice 下的第二个路径volumes）的命名卷，但是使用旧的字符串格式定义它来装入命名卷。volumes如图所示，命名卷必须在顶级 键下列出。
version: "3.7"
services:
web:
image: nginx:alpine
volumes:
- type: volume
source: mydata
target: /data
volume:
nocopy: true
- type: bind
source: ./static
target: /opt/app/static
db:
image: postgres:latest
volumes:
- "/var/run/postgres/postgres.sock:/var/run/postgres/postgres.sock"
- "dbdata:/var/lib/postgresql/data"
volumes:
mydata:
dbdata:
注意
有关卷的一般信息，请参阅文档中的“ 使用卷 和卷插件”部分。
短语法
简短语法使用通用[SOURCE:]TARGET[:MODE]格式，其中 SOURCE可以是主机路径或卷名。TARGET是安装卷的容器路径。标准模式适用ro于只读和rw读写（默认）。
您可以在主机上安装相对路径，该相对路径相对于正在使用的Compose配置文件的目录进行扩展。相对路径应始终以.或开头..。
volumes:
# Just specify a path and let the Engine create a volume
- /var/lib/mysql
# Specify an absolute path mapping
- /opt/data:/var/lib/mysql
# Path on the host, relative to the Compose file
- ./cache:/tmp/cache
# User-relative path
- ~/configs:/etc/configs/:ro
# Named volume
- datavolume:/var/lib/mysql
长语法
以3.2版文件格式添加。
长格式语法允许配置其他不能以短格式表示的字段。
type：所述安装型volume，bind，tmpfs或npipe
source：挂载的源，主机上用于绑定挂载的路径或顶级volumes密钥中定义的卷的名称 。不适用于tmpfs挂载。
target：安装了卷的容器中的路径
read_only：将卷设置为只读的标志
bind：配置其他绑定选项
propagation：用于绑定的传播模式
volume：配置其他音量选项
nocopy：创建卷时禁用从容器复制数据的标志
tmpfs：配置其他tmpfs选项
size：tmpfs挂载的大小（以字节为单位）
consistency：装载的一致性要求，consistent （主机和容器具有相同的视图），cached（读缓存，主机视图具有权威性）或delegated（读写缓存，容器的视图具有权威性）之一
version: "3.7"
services:
web:
image: nginx:alpine
ports:
- "80:80"
volumes:
- type: volume
source: mydata
target: /data
volume:
nocopy: true
- type: bind
source: ./static
target: /opt/app/static
networks:
webnet:
volumes:
mydata:
注意
创建绑定安装时，使用长语法要求事先创建引用的文件夹。如果该文件夹不存在，则使用简短语法创建该文件夹。有关 更多信息，请参见绑定安装文档。
volumes for srevices,swarms,stack files 服务，群集和堆栈文件的卷
使用docker stack deploy时的注意事项
使用服务，群集和docker-stack.yml文件时，请记住，支持服务的任务（容器）可以部署在群集中的任何节点上，并且每次更新服务时，该节点都可以是不同的节点。
在没有使用指定源命名卷的情况下，Docker为支持服务的每个任务创建一个匿名卷。删除关联的容器后，匿名卷不会继续存在。
如果要保留数据，请使用命名卷和支持多主机的卷驱动程序，以便可以从任何节点访问数据。或者，对服务设置约束，以便将其任务部署在具有该卷的节点上。
例如，Docker Labs中votingapp示例的docker-stack.yml文件 定义了一个称为运行数据库的服务。它被配置为命名卷，以将数据持久存储在群集中， 并且被限制为仅在节点上运行。这是该文件的相关摘录：dbpostgresmanager
version: "3.7"
services:
db:
image: postgres:9.4
volumes:
- db-data:/var/lib/postgresql/data
networks:
- backend
deploy:
placement:
constraints: [node.role == manager]
卷装载的缓存选项（适用于MAC的DOCKER桌面）
您可以在Compose文件中为绑定安装的目录配置容器和主机的一致性要求，以提高卷装载的读/写性能。这些选项解决了osxfs文件共享所特有的问题，因此仅适用于Mac的Docker Desktop。
标志是：
consistent：完全一致。容器运行时和主机始终保持相同的安装视图。这是默认值。
cached：主机对挂载的观点是权威的。在容器中可以看到主机上进行的更新，这可能会有所延迟。
delegated：容器运行时的挂载视图具有权威性。在主机上看到容器中所做的更新之前可能会有所延迟。
这是将卷配置为的示例cached：
version: "3.7"
services:
php:
image: php:7.1-fpm
ports:
- "9000"
volumes:
- .:/var/www/project:cached
有关这些标志，它们所解决的问题以及docker run与之对应的问题的完整详细信息，请 参见Docker Desktop for Mac主题“针对卷挂载（共享文件系统）的性能调整”。
域名，主机名，IPC，MAC_ADDRESS，特权，READ_ONLY，shm_size，stdin_open，TTY用户，working_dir
其中每个都是一个值，类似于其 docker run对应项。请注意，这mac_address是一个旧选项。
user: postgresql
working_dir: /code
domainname: foo.com
hostname: foo
ipc: host
mac_address: 02:42:ac:11:65:43
privileged: true
read_only: true
shm_size: 64M
stdin_open: true
tty: true
specifying durations 指定持续时间
某些配置选项，例如的interval和timeout子选项 check，将持续时间作为字符串以如下格式显示：
2.5s
10s
1m30s
2h32m
5h34m56s
支持的单位是us，ms，s，m和h。
specifying byte values 指定字节值
某些配置选项（例如shm_sizefor 的子选项 build）接受字节值作为字符串，格式如下：
2b
1024kb
2048k
300m
1gb
支持的单位是b，k，m和g，和它们的替代符号kb， mb和gb。目前不支持十进制值。
卷配置参考 卷配置参考
这是一个两种服务设置的示例，其中数据库的数据目录作为卷与另一个服务共享，以便可以定期备份它：
version: "3.7"
services:
db:
image: db
volumes:
- data-volume:/var/lib/db
backup:
image: backup-service
volumes:
- data-volume:/var/lib/backup/data
volumes:
data-volume:
顶级volumes键下的条目可以为空，在这种情况下，它使用引擎配置的默认驱动程序（在大多数情况下，这是 local驱动程序）。（可选）您可以使用以下键对其进行配置：
driver
定该卷应使用哪个卷驱动程序。默认为Docker Engine配置为使用的任何驱动程序，大多数情况下为 local。如果驱动程序不可用，则引擎在docker-compose up尝试创建卷时将返回错误 。
driver: foobar
volumes.driver _opts
指定选项列表作为键值对，以传递给该卷的驱动程序。这些选项取决于驱动程序-有关更多信息，请参考驱动程序的文档。可选的。
volumes:
example:
driver_opts:
type: "nfs"
o: "addr=10.40.0.199,nolock,soft,rw"
device: ":/docker/example"
volumes.external
如果设置为true，则指定此卷是在Compose之外创建的。docker-compose up不会尝试创建它，如果不存在则引发错误。
为3.3和下面的格式的版本，external不能同时使用与其它卷配置键（driver，driver_opts， labels）。对于3.4及更高版本，此限制不再存在 。
在下面的示例中，[projectname]_dataCompose 不会尝试创建一个名为的卷，而是 查找一个简单地称为的现有卷data并将其安装到db服务的容器中。
version: "3.7"
services:
db:
image: postgres
volumes:
- data:/var/lib/postgresql/data
volumes:
data:
external: true
不推荐使用3.4版文件格式。
使用版本3.4文件格式弃用了external.name name。
您还可以与在Compose文件中用于引用卷的名称分开指定卷的名称：
volumes:
data:
external:
name: actual-name-of-volume
使用docker stack deploy时的注意事项
如果您使用docker stack deploy以swarm模式启动应用程序 （而不是docker compose up），则会创建不存在的外部卷。在群模式下，由服务定义卷后将自动创建该卷。由于服务任务是在新节点上安排的，因此swarmkit 在本地节点上创建卷。要了解更多信息，请参见moby / moby＃29976。
labels
使用Docker标签将元数据添加到容器中 。您可以使用数组或字典。
建议您使用反向DNS表示法，以防止标签与其他软件使用的标签冲突。
labels:
com.example.description: "Database volume"
com.example.department: "IT/Ops"
com.example.label-with-empty-value: ""
labels:
- "com.example.description=Database volume"
- "com.example.department=IT/Ops"
- "com.example.label-with-empty-value"
volumes.name
为此卷设置一个自定义名称。名称字段可用于引用包含特殊字符的卷。该名称按原样使用，不会与堆栈名称一起作用域。
version: "3.7"
volumes:
data:
name: my-app-data
它也可以与external属性一起使用：
version: "3.7"
volumes:
data:
external: true
name: my-app-data
网络配置参考
driver
指定该网络应使用哪个驱动程序。
默认驱动程序取决于您所使用的Docker引擎的配置方式，但在大多数情况下，它bridge位于单个主机和overlaySwarm上。
如果驱动程序不可用，Docker引擎将返回错误。
driver: overlay
bridge
Docker默认bridge在单个主机上使用网络。有关如何使用网桥网络的示例，请参阅关于网桥网络的Docker Labs教程。
overlay
该overlay驱动程序创建一个跨多个节点命名的网络 群。
有关如何以overlay群集模式构建和使用带有服务的网络的有效示例 ，请参阅《覆盖网络和服务发现》的Docker Labs教程 。
有关深入了解其工作原理的信息，请参见“ 覆盖驱动程序网络体系结构”上的网络概念实验室。
HOST OR NONE
使用主机的网络堆栈，或者不使用网络。等同于 docker run --net=host或docker run --net=none。仅在使用docker stack命令时使用 。如果使用docker-compose命令，请改用network_mode。
如果要在通用版本上使用特定网络，请使用第二个yaml文件示例中提到的[network]。
使用内置网络（例如host和none）的语法略有不同。使用名称host或none（Docker已经自动创建的）定义一个外部网络，并定义一个Compose可以使用的别名（hostnet或nonet在以下示例中），然后使用该别名向该网络授予服务访问权限。
version: "3.7"
services:
web:
networks:
hostnet: {}
networks:
hostnet:
external: true
name: host
services:
web:
...
build:
...
network: host
context: .
...
services:
web:
...
networks:
nonet: {}
networks:
nonet:
external: true
name: none
driver_opts
指定选项列表作为键值对，以传递给该网络的驱动程序。这些选项取决于驱动程序-有关更多信息，请参考驱动程序的文档。可选的
driver_opts:
foo: "bar"
baz: 1
enable_ipv6
在此网络上启用IPv6网络。
ipam
指定自定义IPAM配置。这是一个具有多个属性的对象，每个属性都是可选的：
driver：自定义IPAM驱动程序，而不是默认驱动程序。
config：具有零个或多个配置块的列表，每个配置块包含以下任一键：
subnet：CIDR格式的子网表示一个网段
一个完整的例子：
ipam:
driver: default
config:
- subnet: 172.28.0.0/16
注意
gateway目前仅支持版本2 等其他IPAM配置。
internal
默认情况下，Docker还将桥接网络连接到它以提供外部连接。如果要创建外部隔离的覆盖网络，可以将此选项设置为true。
