官方编排(Orchestration)项目之一,负责快速的部署分布式应用
是用来组装多容器应用的工具,可以在 Swarm集群中部署分布式应用。
docker-compose.yml, docker-compose.yaml
compose重要概念
任务
服务
服务栈
安装
pip install -U docker-compose
或上传compose到服务器,然后
chmod a+x docker-compose
参数选项
.-f, --file FILE 指定使用的compose模板文件
.-p, --project-name NAME 指定项目名称,默认将所在目录名称作为项目名称
.-c, --context NAME
.--verbose 输出更多调试信息
.--log-level LEVEL
.--no-ansi
.-v, --version 显示版本,并退出
.-H, --host HOST 指定所操作的docker服务地址
.--tls 启用tls,若指定-tlsverify则默认开启
.--tlscacert CA_PATH 信任的tls ca 证书
.--tlscert CLIENT_CERT_PATH 客户端使用的tls证书
.--tlskey TLS_KEY_PATH tls的私钥文件路径
.--tlsverify 使用tls校验连接对方
.--skip-hostname-check 不使用tls证书验证对方主机名
.--project-directory PATH 指定工作目录
.--compatibility 在v3文件中转换为它们的非Swarm等价物
.--env-file PATH
命令
compose build 构建项目中的服务容器?镜像?
compose config 验证并查看Compose文件
compose create 为服务创建容器
compose down 停止容器并删除由其创建的容器,网络,卷和图像up
compose events 为项目中的每个容器流式传输容器事件
compose exec 这相当于docker exec
compose help
compose images List images
compose kill 通过发送SIGKILL信号来强制停止服务容器
compose logs 查看服务容器的输出
compose pause 暂停一个容器
compose port 打印某个容器端口所映射的公共端口
compose ps 列出项目中目前所有的容器
compose pull 拉取服务依赖镜像
compose push 推送服务镜像
compose restart 重启项目中的服务
compose rm 删除所有停止状态的服务容器
compose run 在指定服务上执行一个命令
compose scale 设置指定服务执行的容器个数
compose start 启动已存在的服务容器
compose stop 停止已存在的服务容器
compose top 显示容器正在运行的进程
compose unpause 恢复处于暂停状态的容器
compose up 自动完成包括构建镜像、创建服务、启动服务并关联服务相关容器的一系列操作
compose version
compose命令说明详细
build(构建或者是重新构建)项目中的服务容器
docker-compose build [options] [SERVICE...]
服务容器一旦构建后,将会带上一个标记名,例如对于 web 项目中的一个 db 容器,可能是 web_db。
可以随时在项目目录下运行 docker-compose build 来重新构建服务。
选项包括:
.--force-rm 删除构建过程中的临时容器。
.--no-cache 构建镜像过程中不使用 cache(这将加长构建过程)。
.--pull 始终尝试通过 pull 来获取更新版本的镜像。
.-m,-memory 指定创建服务所使用的内存限制
.-build-arg key=value 指定服务创建时的参数
bundle
docker-compose bundle 。。。
创建可分发的配置包,包括整个栈的所有数据,他人可利用文件启动服务栈
.-push-images 自动推送镜像到仓库
.-o,-output 配置包的导出路径
config
docker-compose config
验证Compose文件格式是否正确,如果正确,则显示配置,如果格式错误则显示错误原因。
.-resolve-image-digests
.-q,-quite
.-services
.-volumes
down
docker-compose down
停止服务栈,并删除相关资源,包括容器 挂载卷 网络 创建镜像等
默认情况只清除所创建的容器和网络资源
.-rmi 指定删除的镜像类型 all所有镜像 local仅本地
.-v,-volumes 删除挂载数据卷
.-remove-orphans 清除未在compose中定义的容器
.-t,-timeout 指定超时时间,默认10s
events
实时监控容器的事件信息
.-json json格式输出
exec
在运行的容器中执行给定的命令
.-d 在后台运行命令
.-privileged 以特权运行命令
.-u, -user 以给定用户身份运行
.-T 不分配tty伪终端,默认开启
.-index=index 当有多个容器时指定容器索引,默认第一个
.-e,-env KEY=VAL 设置环境变量
help
获取一个命令的帮助。
images
列出服务所创建的镜像。
kill
docker-compose kill [options] [SERVICE...]
通过发送 SIGKILL 信号来强制停止服务容器。支持通过 -s 参数来指定发送的信号,例如
过如下指令发送 SIGINT 信号。
logs
docker-compose logs [options] [SERVICE...]
查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的
颜色来区分。可以通过
.--no-color 来关闭颜色。
.-f,-follow 持续跟踪输出日志消息
.-t,-tilestamps 显示时间戳信息
.-tail='all' 仅显示指定行数的最新日志信息
pause
docker-compose pause [SERVICE...]
暂停一个服务器
port
docker-compose port [options] SERVICE PRIVATE_PORT
打印某个容器端口所映射的公共端口。
选项:
.--protocol=proto 指定端口协议,tcp(默认值)或者 udp。
.--index=index 如果同一服务存在多个容器,指定命令对象容器的序号(默认为 。
ps
docker-compose ps [options] [SERVICE...]
列出项目中目前的所有容器。
选项:
.-q 只打印容器的 ID 信息。
pull(拉取服务依赖的镜像)
docker-compose pull [options] [SERVICE...]
选项:
.--ignore-pull-failures 忽略拉取镜像过程中的错误。
push(推送服务依赖的镜像到 Docker 镜像仓库)
.--ignore-push-failures 忽略推送镜像过程的失误
restart
docker-compose restart [options] [SERVICE...]
重启项目中的服务。
选项:
.-t, --timeout TIMEOUT 指定重启前停止容器的超时(默认为 秒)。
rm
docker-compose rm [options] [SERVICE...]
删除所有(停止状态的)服务容器。推荐先执行 docker-compose stop 命令来停止容器。
选项:
.-f, --force 强制直接删除,包括非停止状态的容器。一般尽量不要使用该选项。
.-v 删除容器所挂载的数据卷。
run
docker-compose run [options] [-p PORT...] [-e KEY=VAL...]
SERVICE [COMMAND] [ARGS...]
在指定服务上执行一个命令。
例如: docker-compose run ubuntu ping docker.com
将会启动一个 ubuntu 服务容器,并执行 ping docker.com 命令。
默认情况下,如果存在关联,则所有关联的服务将会自动被启动,除非这些服务已经在运行中。
该命令类似启动容器后运行指定的命令,相关卷、链接等等都将会按照配置自动创建。
两个不同点:
给定命令将会覆盖原有的自动运行命令;
不会自动创建端口,以避免冲突。
如果不希望自动启动关联的容器,可以使用 --no-deps。
选项:
.-d 后台运行容器。
.--name NAME 为容器指定一个名字。
.--entrypoint CMD 覆盖默认的容器启动指令。
.-e KEY=VAL 设置环境变量值,可多次使用选项来设置多个环境变量。
.-u, --user="" 指定运行容器的用户名或者 uid。
.--no-deps 不自动启动关联的服务容器。
.--rm 运行命令后自动删除容器, d 模式下将忽略。
.-p, --publish=[] 映射容器端口到本地主机。
.--service-ports 配置服务端口并映射到本地主机。
.-T 不分配伪 tty,意味着依赖 tty 的指令将无法运行。
scale
docker-compose scale [options] [SERVICE=NUM...]
设置指定服务运行的容器个数。
通过 service=num 的参数来设置数量。例如:
docker-compose scale web=db将启动 个容器运行 web 服务 个容器运行 db 服务。
一般的,当指定数目多于该服务当前实际运行容器,将新创建并启动容器;反之,将停止容器。
.-t, --timeout TIMEOUT 停止容器时候的超时(默认为 秒)。
start
docker-compose start [SERVICE...]
启动已经存在的服务容器
stop
docker-compose stop [options] [SERVICE...]
停止已经处于运行状态的容器,但不删除它。通过 docker-compose start 可以再次启动这些容器。
.-t, --timeout TIMEOUT 停止容器时候的超时(默认为 秒)。
top
查看各个服务容器内运行的进程。
unpause
docker-compose unpause [SERVICE...]
恢复处于暂停状态中的服务。
up
docker-compose up [options] [SERVICE...]
该命令十分强大,它将尝试自动完成包括构建镜像,(重新)创建服务,启动服务,并
关联服务相关容器的一系列操作。
链接的服务都将会被自动启动,除非已经处于运行状态。
可以说,大部分时候都可以直接通过该命令来启动一个项目。
默认情况, docker-compose up
启动的容器都在前台,控制台将会同时打印所
有容器的输出信息,可以很方便进行调试。
当通过 Ctrl-C 停止命令时,所有容器将会停止。如果使用 docker-compose up -d
,将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。
默认情况,如果服务容器已经存在, docker-compose up 将会尝试停止容器,然后重
新创建(保持使用 volumes-from挂载的卷),以保证新启动的服务匹配docker-compose.yml 文件的最新内容
。如果用户不希望容器被停止并重新创建,可以使用 docker-compose up --no-recreate
。这样将只会启动处于停止状态的容器,而忽略已经运行的服务。如果用户只想重新部署
某个服务,可以使用docker-compose up --no-deps -d <SERVICE_NAME> 来重
创建服务并后台停止旧服务,启动新服务,并不会影响到其所依赖的服务。
选项:
.-d 在后台运行服务容器。
.--no-color 不使用颜色来区分不同的服务的控制台输出。
.--no-deps 不启动服务所链接的容器。
.--force-recreate 强制重新创建容器,不能与 --no-recreate 同时使用。
.--no-recreate如果容器已经存在了,则不重新创建,不能与 --forcerecreate同时使用。
.--no-build 不自动构建缺失的服务镜像。
.-t, --timeout TIMEOUT 停止容器时候的超时(默认为 秒),与-d冲突
.--abort-on-container-exit 当有容器停止时终止整个任务,与-d冲突
--remove-orphans:删除服务中未定义的容器
version
docker-compose version
compose模板文件
默认名docker-compose.yaml 最新版v3
compose模板主要命令
build 指定Dockerfile所在文件夹的路径(可以是绝对路径,或者相对于docker-compose.yml文件的路径)
cap_add.cap_drop
command 覆盖容器启动后默认执行的命令
cgroup_parent
configs 仅用于Swarm mode
container_name 指定容器名称。默认将会使用项目名称_服务名称_序号这样的格式
dns 自定义DNS 服务器。可以是一个值,也可以是一个列表。
dns_search 配置dns搜索域
deploy 仅用于Swarm mode
devices 指定设备映射关系
domainname 指定容器中搜索域名
dockerfile 指定的编译镜像的dockfile文件
entrypoint 指定服务容器启动后执行的入口文件
envfile 从文件获取环境变量
environment 设置环境变量。可以使用数组或字典两种格式。只给定名称的变量会自动获取运行Compose主机上对应变量的值,可以用来防止泄露不必要的数据。
expose 暴露端口,但不映射到宿主机,只被连接的服务访问。仅可以指定内部端口为参数。
extra_hosts 类似Docker中的–add-host参数,指定额外的host名称映射信息。会在启动后的服务容器中/etc/hosts文件中添加一个条目。如:8.8.8.8 googledns
healthcheck 通过命令检查容器是否健康运行
hostname 指定容器中主机名
image 指定为镜像名或镜像ID,如果镜像在本地不存在,Compose将会尝试拉取这个镜像。
isolation 配置容器隔离机制
labels 为容器添加Docker元数据(metadata)信息。例如可以为容器添加辅助说明信息。
links 连接到其他容器。注意:不推荐使用该指令。
logging 跟日志相关配置
mac_address 指定容器中mac地址
network_mode 设置网络模式。使用和docker run的–network参数一样的值。
networks 配置容器连接的网络
pid 跟主机共享进程命名空间
ports 暴露端口信息,使用宿主端口:容器端口(HOST:CONTAINER)格式,或者仅仅指定容器的端口(宿主将会随机选择端)
privileged 允许容器中运行一些特权命令
read_only 以只读模式挂载容器的root文件系统,意味着不能对容器内容进行修改
restart 指定容器退出后的重启策略为始终重启。在生产环境中推荐配置为 always 或者 unless-stopped
secrets 配置应用的秘密数据
security_opt 指定容器模板标签label机制的默认属性(用户角色)
stop_grace_period 指定容器停止时容器的优雅停止期限 默认10s,过期后通过sigkill强制退出
stop_signal 指定停止容器的信号
stdin_open 打开标准输入,可以接受外部输入
sysctls 配置容器内核参数,目前不支持swarm模式
tty 模拟一个伪终端
ulimits 指定容器的ulimits限制值。
user 指定容器中运行应用的用户名
userns_mode 指定用户空间命名模式,目前不支持swarm模式
volumes 数据卷所挂载路径设置,可以设置宿主机路径,同时支持相对路径
working_dir 指定容器中工作目录
compose环境变量
COMPOSE_PROJECT_NAME 设置项目名称。如果未设置,默认为当前工作目录的名称(如果未设置工作目录,工作目录默认为Compose配置文件所在目录)。在项目启动时该值与服务名称会一起添加到容器中。例如项目名称为myapp,并且包含两个服务db和web,则Compose会分别启动名为myapp_db_1和myapp_web_1的容器 。
COMPOSE_FILE 指定要使用的Compose配置文件的路径。如果未指定,Compose会先在当前目录中查找docker-compose.yml文件,找不到就依次在上层目录中查找,直到找到为止,如果找不到会报错。此变量支持由路径分隔符分隔的多个Compose文件(在Linux和macOS上路径分隔符为:,在Windows上为;)。例如, COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml。路径分隔符也可以使用COMPOSE_PATH_SEPARATOR进行自定义。
COMPOSE_API_VERSION 设置此变量的目的是为了解决Compose需要临时运行而客户端和服务器版本不匹配的情况。在生产环境中不推荐使用这个临时方案,最好通过升级来保证客户端和服务端版本的兼容性。
DOCKER_HOST 设置Docker守护进程(Daemon)的监听URL 。与Docker客户端一样,默认为unix:///var/run/docker.sock。
DOCKER_TLS_VERIFY 如果该环境变量不为空,则与Docker守护进程的所有交互都通过TLS协议进行加密。
DOCKER_CERT_PATH 配置用于TLS验证的ca.pem、cert.pem以及key.pem文件的路径。默认为~/.docker。
COMPOSE_HTTP_TIMEOUT 配置Compose向Docker守护进程发送请求的超时时间。单位为秒,默认值60s。
COMPOSE_TLS_VERSION 配置与Docker守护进程进行TLS通信的TSL版本。默认版本为TLSv1。支持TLSv1、TLSv1_1和TLSv1_2三个版本
COMPOSE_CONVERT_WINDOWS_PATHS 在卷的定义中是否启用从Windows形式到Unix形式的路径转换。默认值为0。true或1启用,false或0禁用。
COMPOSE_PATH_SEPARATOR 指COMPOSE_FILE环境变量中的路径间隔符。
COMPOSE_FORCE_WINDOWS_HOST 是否启用使用short syntax解析卷的声明并始终假设主机路径是Windows路径,即使Compose在基于UNIX的系统上运行。true或1启用,false或0禁用。
COMPOSE_IGNORE_ORPHANS 是否启用不检测项目中的孤儿容器。true或1启用,false或0禁用。
COMPOSE_PARALLEL_LIMIT 设置Compose可以执行进程的最大并发数。默认值为64,并且设置不能低于2。
COMPOSE_INTERACTIVE_NO_CLI 是否启用不使用Docker命令行执行run和exec命令。true或1启用,false或0禁用。在CLI被上述操作需要的Windows上,此选项不可用。