compose学习
- 入门介绍
-
- compose是什么?
- 如何使用Compose ?
- 总结
- 安装 Compose
-
- 步骤
- Compose文件具体参数配置
-
- build
- image
- container_name
- volumes
- command
- links
- external_links
- expose
- ports
- restart
- environment
- pid
- dns
- Docker-compose命令介绍
- 以上都参考官方文档
入门介绍
compose是什么?
Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.
Compose是用来定义和运行多容器应用实例的,通过一个YAML文件,我们可以轻松配置所有的容器,并且通过一个简单的命令,来根据配置文件创建并运行所有的容器
如何使用Compose ?
Using Compose is basically a three-step process:
- Define your app’s environment with a
Dockerfile
so it can be reproduced anywhere.Dockerfile保证我们的容器可以在任何地方运行
- Define the services that make up your app in
docker-compose.yml
so they can be run together in an isolated environment.在docker-compose.yml配置文件中配置所有服务,确保他们都可以在一个关联环境中被运行起来
- Run docker compose up and the Docker compose command starts and runs your entire app. You can alternatively run
docker-compose up
using the docker-compose binary.docker-compose up启动所有服务
总结
- Compose是Docker官方开源项目,需要安装
- Dockerfile让程序在任何地方运行
- Compose文件基础样式
version: "3.9" # 版本
services: # 服务
web:
build: .
ports:
- "5000:5000"
volumes:
- .:/code
- logvolume01:/var/log
links:
- redis
redis:
image: redis
volumes: # 全局配置
logvolume01: {}
Compose重要概念:
- 服务services: 容器,应用(web,redis,mysql…)
- 项目project: 一组关联的容器
安装 Compose
- Run this command to download the current stable release of Docker Compose
执行下面的命令来下载当前稳定版本的Docker Compose
这里官方给的链接是github上面的,但是github下载奇慢无比,因此下面我给出的是国内下载链接
daocloud下载
sudo curl -L https://get.daocloud.io/docker/compose/releases/download/1.25.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
默认下载到/usr/local/bin/目录下面
- Apply executable permissions to the binary
赋予可执行权限
sudo chmod +x /usr/local/bin/docker-compose
- Test the installation
测试安装是否成功
docker-compose --version
步骤
- 创建应用
- Dockerfile打包为镜像
- Docker-compose.yaml文件(定义整个服务,需要的环境,web,service,redis)完整的上线服务
- 启动compose项目(docker-compose up)
Compose文件具体参数配置
Compose文件是一个定义服务,网络和卷的YAML文件。 Compose文件的默认文件名为docker-compose.yml。
提示:您可以对此文件使用.yml或.yaml扩展名。 他们都工作。
与docker运行一样,默认情况下,Dockerfile中指定的选项(例如,CMD,EXPOSE,VOLUME,ENV)都被遵守,你不需要在docker-compose.yml中再次指定它们。
同时你可以使用类似Bash的$ {VARIABLE} 语法在配置值中使用环境变量,有关详细信息,请参考变量替换
本节包含版本3中服务定义支持的所有配置选项。
build
build 可以指定包含构建上下文的路径:
version: '2'
services:
webapp:
build: ./dir
或者,作为一个对象,该对象具有上下文路径和指定的Dockerfile文件以及args参数值:
version: '2'
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1
webapp服务将会通过./dir目录下的Dockerfile-alternate文件构建容器镜像。
如果你同时指定image和build,则compose会通过build指定的目录构建容器镜像,而构建的镜像名为image中指定的镜像名和标签。
build: ./dir
image: webapp:tag
这将由./dir构建的名为webapp和标记为tag的镜像。
context
包含Dockerfile文件的目录路径,或者是git仓库的URL。
当提供的值是相对路径时,它被解释为相对于当前compose文件的位置。 该目录也是发送到Docker守护程序构建镜像的上下文。
dockerfile
备用Docker文件。Compose将使用备用文件来构建。 还必须指定构建路径。
args
添加构建镜像的参数,环境变量只能在构建过程中访问。
首先,在Dockerfile中指定要使用的参数:
ARG buildno
ARG password
RUN echo "Build number: $buildno"
RUN script-requiring-password.sh "$password"
然后在args键下指定参数。 你可以传递映射或列表:
build:
context: .
args:
buildno: 1
password: secret
build:
context: .
args:
- buildno=1
- password=secret
注意:YAML布尔值(true,false,yes,no,on,off)必须用引号括起来,以便解析器将它们解释为字符串
image
指定启动容器的镜像,可以是镜像仓库/标签或者镜像id(或者id的前一部分)
image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd
如果镜像不存在,Compose将尝试从官方镜像仓库将其pull下来,如果你还指定了build,在这种情况下,它将使用指定的build选项构建它,并使用image指定的名字和标记对其进行标记。
container_name
指定一个自定义容器名称,而不是生成的默认名称。
container_name: my-web-container
由于Docker容器名称必须是唯一的,因此如果指定了自定义名称,则无法将服务扩展到多个容器。
volumes
卷挂载路径设置。可以设置宿主机路径 (HOST:CONTAINER) 或加上访问模式 (HOST:CONTAINER:ro),挂载数据卷的默认权限是读写(rw),可以通过ro指定为只读。
你可以在主机上挂载相对路径,该路径将相对于当前正在使用的Compose配置文件的目录进行扩展。 相对路径应始终以 . 或者 … 开始。
volumes:
# 只需指定一个路径,让引擎创建一个卷
- /var/lib/mysql
# 指定绝对路径映射
- /opt/data:/var/lib/mysql
# 相对于当前compose文件的相对路径
- ./cache:/tmp/cache
# 用户家目录相对路径
- ~/configs:/etc/configs/:ro
# 命名卷
- datavolume:/var/lib/mysql
但是,如果要跨多个服务并重用挂载卷,请在顶级volumes关键字中命名挂在卷,但是并不强制,如下的示例亦有重用挂载卷的功能,但是不提倡。
version: "3"
services:
web1:
build: ./web/
volumes:
- ../code:/opt/web/code
web2:
build: ./web/
volumes:
- ../code:/opt/web/code
注意:通过顶级volumes定义一个挂载卷,并从每个服务的卷列表中引用它, 这会替换早期版本的Compose文件格式中volumes_from。
version: "3"
services:
db:
image: db
volumes:
- data-volume:/var/lib/db
backup:
image: backup-service
volumes:
- data-volume:/var/lib/backup/data
volumes:
data-volume:
command
覆盖容器启动后默认执行的命令。
command: bundle exec thin -p 3000
该命令也可以是一个类似于dockerfile的列表:
command: ["bundle", "exec", "thin", "-p", "3000"]
links
链接到另一个服务中的容器。 请指定服务名称和链接别名(SERVICE:ALIAS),或者仅指定服务名称。
web:
links:
- db
- db:database
- redis
在当前的web服务的容器中可以通过链接的db服务的别名database访问db容器中的数据库应用,如果没有指定别名,则可直接使用服务名访问。
链接不需要启用服务进行通信 - 默认情况下,任何服务都可以以该服务的名称到达任何其他服务。 (实际是通过设置/etc/hosts的域名解析,从而实现容器间的通信。故可以像在应用中使用localhost一样使用服务的别名链接其他容器的服务,前提是多个服务容器在一个网络中可路由联通)
links也可以起到和depends_on相似的功能,即定义服务之间的依赖关系,从而确定服务启动的顺序。
external_links
链接到docker-compose.yml 外部的容器,甚至并非 Compose 管理的容器。参数格式跟 links 类似。
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql
expose
暴露端口,但不映射到宿主机,只被连接的服务访问。
仅可以指定内部端口为参数
expose:
- "3000"
- "8000"
ports
暴露端口信息。
常用的简单格式:使用宿主:容器 (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"
在v3.2中ports的长格式的语法允许配置不能用短格式表示的附加字段。
长格式:
ports:
- target: 80
published: 8080
protocol: tcp
mode: host
target:容器内的端口
published:物理主机的端口
protocol:端口协议(tcp或udp)
mode:host 和ingress 两总模式,host用于在每个节点上发布主机端口,ingress 用于被负载平衡的swarm模式端口。
restart
no是默认的重启策略,在任何情况下都不会重启容器。 指定为always时,容器总是重新启动。 如果退出代码指示出现故障错误,则on-failure将重新启动容器。
restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
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
注意:如果你的服务指定了build选项,那么在构建过程中通过environment定义的环境变量将不会起作用。 将使用build的args子选项来定义构建时的环境变量。
pid
将PID模式设置为主机PID模式。 这就打开了容器与主机操作系统之间的共享PID地址空间。 使用此标志启动的容器将能够访问和操作裸机的命名空间中的其他容器,反之亦然。即打开该选项的容器可以相互通过进程 ID 来访问和操作。
pid: "host"
dns
配置 DNS 服务器。可以是一个值,也可以是一个列表。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
Docker-compose命令介绍
1、docker-compose up 启动服务
常用命令选项:
-f : --file File 指定compose文件,默认是docker-compose.yml
-d: 在后台运行
常用命令:
docker-compose -f xxx.yaml up -d // 指定xxx.yaml文件,在后台启动该服务
2、docker-compose stop [SERVICE…] 停止正在运行的容器,可以通过docker-compose start再次启动
常用命令:
docker-compose -f xxx.yaml stop
3、docker-compose start [SERVICE…] 启动已经存在的服务容器
常用命令:
docker-compose -f xxx.yaml start
4、docker-compose down [options] 停止和删除容器
docker-compose down --volumes : —volumes 还可以删除容器使用过程中所使用的数据卷
常用命令:
docker-compose -f xxx.yaml down
5、docker-compose restart [SERVICE…] 重启服务
常用命令:
docker-compose -f xxx.yaml restart
docker-compose up/down 和 restart 的区别
问题的引出:工作中修改了yaml文件,执行restart命令,发现服务没有实现重启,遂去网上学习了一下,发现先down再up,和直接restart效果不一样。
区别体现:
- 只要xxx.yaml文件(默认是docker-compose.yaml文件)有任何修改,一定要执行docker-compose up才会生效,执行docker-compose restart是不会生效的;
- 如果是code发生变化,执行docker-compose restart是有效的。
docker-compose常用命令详解
以上都参考官方文档
官方文档