Docker-compose
compose简介
ompose项目是 Docker 官方的开源项目,负责实现对 Docker 容器集群的快速编排。从功能上看,跟OpenStack中的Heat十分类似。其代码目前在https://github.com/docker/compose上开源。
Using Compose is basically a three-step process.
Define your app's environment with a Dockerfile so it can be reproduced anywhere.
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
Lastly, run docker-compose up and Compose will start and run your entire app.
A docker-compose.yml looks like this:
version: '2'
services:
web:
build: .
ports:
- "5000:5000"
volumes:
- .:/code
redis:
image: redis
注意缩进,两个空格
yml格式化网站
http://www.bejson.com/validators/yaml_editor/
Compose has commands for managing the whole lifecycle of your application:
Start, stop and rebuild services
View the status of running services
Stream the log output of running services
Run a one-off command on a service
Compose定位是「定义和运行多个 Docker 容器的应用(Defining and runningmulti-container Docker applications)」,其前身是开源项目 Fig。通过第一部分中的介绍,我们知道使用一个Dockerfile模板文件,可以让用户很方便的定义一个单独的应用容器。然而,在日常工作中,经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目,除了 Web 服务容器本身,往往还需要再加上后端的数据库服务容器,甚至还包括负载均衡容器等。
Compose恰好满足了这样的需求。它允许用户通过一个单独的docker-compose.yml模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目(project)。
服务 (service):一个应用的容器,实际上可以包括若干运行相同镜像的容器实例。
项目 (project):由一组关联的应用容器组成的一个完整业务单元,在docker-compose.yml文件中定义。
Compose的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。Compose项目由 Python 编写,实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此,只要所操作的平台支持 Docker API,就可以在其上利用Compose来进行编排管理。
compose安装
sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
# bash 补全命令
sudo curl -L https://raw.githubusercontent.com/docker/compose/1.23.2/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose
# 查看版本
docker-compose --version
卸载
sudo rm -rf /usr/local/bin/docker-compose
Compose使用
场景最常见的项目是 web 网站,该项目应该包含 web 应用和缓存。
下面我们用Python来建立一个能够记录页面访问次数的 web 网站。
新建文件夹,在该目录中编写app.py文件
from flask import Flask
from redis import Redis
app = Flask(__name__)
redis = Redis(host='redis', port=6379)
#为什么主机是redis?
# 是docker-compose.yaml里面的redis
@app.route('/')
defhello():
count = redis.incr('hits')
return'Hello World! 该页面已被访问 {} 次。\n'.format(count)
if __name__ == "__main__":
app.run(host="0.0.0.0", debug=True)
#默认端口5000,可以port=端口指定
编写Dockerfile文件,内容为
FROM python:3.6-alpine
ADD . /code
WORKDIR /code
RUN pip install redis flask
CMD ["python", "app.py"]
docker-compose.yml,内容如下:
version: '3'
services:
web:
build: .
ports:
-"5000:5000"
redis:
image:"redis:alpine"
文件里面内容如下:
unzip 打包项目名
cd 解压文件名
ls
# app.py Dockerfile docker-compose.yml
docker-compose up
# 启动命令
宿主机IP:5000访问
Compose 命令说明
命令对象与格式
对于 Compose 来说,大部分命令的对象既可以是项目本身,也可以指定为项目中的服务或者容器。如果没有特别的说明,命令对象将是项目,这意味着项目中所有的服务都会受到命令影响。
执行docker-compose [COMMAND] --help或者docker-compose help[COMMAND]可以查看具体某个命令的使用格式。
docker-compose help
docker-compose
命令的基本的使用格式是docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
命令选项
-f, --file FILE指定使用的 Compose 模板文件,默认为docker-compose.yml,可以多次指定。
docker-compose -f yourfilename. yml up
-p, --project-name NAME指定项目名称,默认将使用所在目录名称作为项目名。
--x-networking使用 Docker 的可拔插网络后端特性
--x-network-driver DRIVER指定网络后端的驱动,默认为bridge
--verbose 输出更多调试信息。
-v, --version 打印版本并退出。
命令使用说明
build
格式为docker-compose build [options] [SERVICE...]。
构建(重新构建)项目中的服务容器。
服务容器一旦构建后,将会带上一个标记名,例如对于 web 项目中的一个 db 容器,可能是 web_db。
可以随时在项目目录下运行docker-compose build来重新构建服务。
选项包括:
--force-rm删除构建过程中的临时容器。
--no-cache 构建镜像过程中不使用 cache(这将加长构建过程)。
--pull始终尝试通过 pull 来获取更新版本的镜像。
config
验证 Compose 文件格式是否正确,若正确则显示配置,若格式错误显示错误原因。
docker-compose config
down
此命令将会停止up命令所启动的容器,并移除网络
docker-compose up -d
#后台运行
docker-compose down
exec
进入指定的容器。
help
获取帮助
images
列出Compose文件中包含的镜像
docker-compose up -d
docker-compose images
kill
格式为docker-compose kill [options] [SERVICE...]
通过发送SIGKILL信号来强制停止服务容器。
支持通过-s参数来指定发送的信号,例如通过如下指令发送SIGINT信号
docker-compose kill-s SIGINT
logs
格式为docker-compose logs [options] [SERVICE...]。
docker-compose logs
#一大串日志
查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过--no-color来关闭颜色。
pause
格式为docker-compose pause [SERVICE...]。
暂停一个容器
port
格式为docker-compose port [options] SERVICE PRIVATE_PORT。
打印某个容器端口所映射的公共端口。
--protocol=proto指定端口协议,tcp(默认值)或者 udp。
--index=index如果同一服务存在多个容器,指定命令对象容器的序号(默认为 1)
ps
格式为docker-compose ps [options] [SERVICE...]。
列出项目中当前所有容器
选项:-q只打印容器的 ID 信息。
pull
格式为docker-compose pull [options] [SERVICE...]。
拉取服务依赖的镜像。
选项:--ignore-pull-failures忽略拉取镜像过程中的错误。
push
推送服务依赖的镜像到 Docker 镜像仓库。
restart
格式为docker-compose restart [options] [SERVICE...]。
重启项目中的服务。
选项:-t, --timeout TIMEOUT指定重启前停止容器的超时(默认为 10 秒)。
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...]。
scale
格式为docker-compose scale [options] [SERVICE=NUM...]。
设置指定服务运行的容器个数。通过service=num的参数来设置数量。例如:$ docker-compose scale web=3 db=2将启动 3 个容器运行 web 服务,2 个容器运行 db 服务。
一般的,当指定数目多于该服务当前实际运行容器,将新创建并启动容器;反之,将停止容器。
-t, --timeout TIMEOUT停止容器时候的超时(默认为 10 秒)。
start
格式为docker-compose start [SERVICE...]。启动已经存在的服务容器
stop
格式为docker-compose stop [options] [SERVICE...]。停止已经处于运行状态的容器,但不删除它。通过docker-compose start可以再次启动这些容器。选项:-t, --timeout TIMEOUT停止容器时候的超时(默认为 10 秒)。
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 如果容器已经存在了,则不重新创建,不能与--force-recreate同时使用。
--no-build 不自动构建缺失的服务镜像。
-t, --timeout TIMEOUT停止容器时候的超时(默认为 10 秒)。
version
格式为docker-compose version。
打印版本信息。