概念
官方文档:https://docs.docker.com/compose/
服务 (service
):一个应用的容器,实际上可以包括若干运行相同镜像的容器实例。
项目 (project
):由一组关联的应用容器组成的一个完整业务单元,在 docker-compose.yml
文件中定义。Compose
的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。Compose
项目由 Python 编写,实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此,只要所操作的平台支持 Docker API,就可以在其上利用 Compose
来进行编排管理。
安装
官方安装教程 https://docs.docker.com/compose/install/
Docker for Mac 、Docker for Windows 自带 docker-compose 二进制文件,不需要再次安装,
$ docker-compose -v
docker-compose version 1.24.1, build 4667896b
Linux 安装
Linux 安装下载地址:https://github.com/docker/compose/releases
官方安装教程:https://docs.docker.com/compose/install/
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
$ sudo docker-compose -v
docker-compose version 1.29.2, build 5becea4c
或者wget 后台下载
$ wget -b https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)
$ sudo mv docker-compose-Linux-x86_64 /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose
$ docker-compose version
Pip 安装
注: x86_64
架构的 Linux 建议按照上边的方法下载二进制包进行安装,如果您计算机的架构是 ARM
(例如,树莓派),再使用 pip
安装。
这种方式是将 Compose 当作一个 Python 应用来从 pip 源中安装。
执行安装命令:
$ sudo pip install -U docker-compose
可以看到类似如下输出,说明安装成功。
Collecting docker-compose
Downloading docker-compose-1.24.1.tar.gz (149kB): 149kB downloaded
...
Successfully installed docker-compose cached-property requests texttable websocket-client docker-
语法
#docker-compose
Define and run multi-container applications with Docker.
#定义并运行多个docker容器
Usage:
docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]
docker-compose -h|--help
Options:
-f, --file FILE Specify an alternate compose file (default: docker-compose.yml)
#指定配置文件,默认当前目录下docker-compose.yml
--verbose Show more output
-v, --version Print version and exit
Commands:
down Stop and remove containers, networks, images, and volumes
#停止并删除容器、网络、docker镜像和卷组
kill Kill containers #关闭容器
logs View output from containers #显示容器的日志
pause Pause services #暂停服务
ps List containers #显示容器列表
pull Pull service images #下载一个服务镜像
push Push service images #推送一个服务镜像至服务器
restart Restart services #重启镜像
rm Remove stopped containers #删除停止的窗口
run Run a one-off command #运行一个停止的命令
start Start services #启动服务
stop Stop services #停止服务
top Display the running processes #显示运行中的进程
unpause Unpause services #恢复暂停中的服务
up Create and start containers #创建并运行一个容器
version Show the Docker-Compose version information #显示docker-compose的版本
image
镜像名称或镜像ID。如果镜像在本地不存在, 将会尝试拉取镜像。
image: ubuntu
image: redis
build
指定 Dockerfile 所在文件夹的路径。 Compose 将会利用它自动构建镜像。
build: /path/to/build/dir
command
覆盖容器启动后默认执行的命令。
command: bundle exec thin -p 3000
links
链接到其它服务中的容器。使用服务名称(同时作为别名)或服务名称:服务别名 (SERVICE:ALIAS) 格式都可以。
links:
- db
- db:database
- redis
environment
设置环境变量。你可以使用数组或字典两种格式
environment:
- RACK_ENV=development
- SESSION_SECRET
env_file
从文件中获取环境变量,可以为单独的文件路径或列表。如果通过 docker-compose -f FILE 指定了模板文件,则 env_file 中路径会基于模板文件路径。如果有变量名称与 environment 指令冲突,则以后者为准。
env_file: .env
Hello world
创建docker-compose.yml 文件
version: '3.7'
services:
db:
image: 'mysql:5.7'
restart: always
container_name: mysql
environment:
- MYSQL_ROOT_PASSWORD=123456
volumes:
- data:/var/lib/mysql
ports:
- '3306:3306'
network_mode: bridge
volumes:
data:
driver: local
执行启动命令
docker-compose up -d
查看启动结果
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
4b401d017343 mysql:5.7 "docker-entrypoint.s…" 10 minutes ago Up 10 minutes 0.0.0.0:3306->3306/tcp, 33060/tcp mysql
依赖关系
创建docker-compose.yml
version: '3'
services:
redis:
image: redis
container_name: redis
ports:
- '6379:6379'
command: redis-server
restart: always
web:
build: .
depends_on:
- redis
container_name: redis-web
ports:
- '8090:8090'
dockerfile
FROM golang:latest as build
WORKDIR /go/src/github.com/baxiang/redis-go
COPY . .
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go install -v
FROM alpine
WORKDIR /app
COPY --from=build /go/bin/redis-go .
EXPOSE 8090
CMD ["./redis-go"]
main.go
package main
import (
"fmt"
"github.com/go-redis/redis/v7"
"io"
"log"
"net/http"
)
func handleRedis(w http.ResponseWriter,r *http.Request){
query := r.URL.Query()
var key =""
key = query.Get("k")
fmt.Println(key)
if r.Method =="GET" {
val, err := client.Get(key).Result()
if err == redis.Nil {
io.WriteString(w,"key does not exist")
} else if err != nil {
io.WriteString(w,err.Error())
}else {
io.WriteString(w,fmt.Sprintf("%s: %s\n",key,val))
}
}else if r.Method =="POST"{
var val =""
val = query.Get("v")
err := client.Set(key, val, 0).Err()
if err != nil {
io.WriteString(w,err.Error())
}
io.WriteString(w,fmt.Sprintf("%s: %s\n",key,val))
}
}
var client *redis.Client
func init() {
client = redis.NewClient(&redis.Options{
Addr: "redis:6379",
Password: "", // no password set
DB: 0, // use default DB
})
pong, err := client.Ping().Result()
if err != nil {
fmt.Println(err.Error())
}else{
fmt.Println(pong)
}
}
func main() {
http.HandleFunc("/",handleRedis)
log.Fatal(http.ListenAndServe(":8090",nil))
}
docker-compose up --build
控制顺序
docker官方推荐使用wait-for-it.sh脚本来解决问题,
https://docs.docker.com/compose/startup-order/
常用命令
docker-compose
命令的基本的使用格式是
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
命令选项-f, --file FILE
指定使用的 Compose 模板文件,默认为 docker-compose.yml
,可以多次指定。-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 文件格式是否正确,若正确则显示配置,若格式错误显示错误原因。
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 秒)。
down
此命令将会停止 up
命令所启动的容器,并移除网络
Options:
--rmi type Remove images. Type must be one of:
'all': Remove all images used by any service.
'local': Remove only images that don't have a
custom tag set by the `image` field.
-v, --volumes Remove named volumes declared in the `volumes`
section of the Compose file and anonymous volumes
attached to containers.
--remove-orphans Remove containers for services not defined in the
Compose file
-t, --timeout TIMEOUT Specify a shutdown timeout in seconds.
(default: 10)
—rmi all 删除所有 service 镜像
—rmi local 删除没有自定义标签的镜像 image 字段
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
选项,例如
$ docker-compose run --no-deps web python manage.py shell
将不会启动 web 容器所关联的其它容器。
选项:-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
的参数来设置数量。例如:
将启动 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 秒)。
参考案例
部署consul
version: '3'
networks:
consul_net:
services:
consul1:
image: consul:latest
container_name: consul1
restart: always
networks:
- consul_net
command: agent -server -client=0.0.0.0 -bootstrap-expect=3 -node=consul1
consul2:
image: consul:latest
container_name: consul2
networks:
- consul_net
restart: always
command: agent -server -client=0.0.0.0 -retry-join=consul1 -node=consul2
consul3:
image: consul:latest
container_name: consul3
networks:
- consul_net
restart: always
command: agent -server -client=0.0.0.0 -retry-join=consul1 -node=consul3
consul4:
image: consul:latest
container_name: consul4
networks:
- consul_net
restart: always
ports:
- 8500:8500
command: agent -client=0.0.0.0 -retry-join=consul1 -ui -node=client1
部署skywalking
version: '3.3'
services:
elasticsearch:
image: docker.elastic.co/elasticsearch/elasticsearch:6.8.5
container_name: elasticsearch
restart: always
ports:
- 9200:9200
- 9300:9300
environment:
discovery.type: single-node
ulimits:
memlock:
soft: -1
hard: -1
oap:
image: skywalking/oap
container_name: oap
depends_on:
- elasticsearch
links:
- elasticsearch
restart: always
ports:
- 11800:11800
- 12800:12800
environment:
SW_STORAGE: elasticsearch
SW_STORAGE_ES_CLUSTER_NODES: elasticsearch:9200
ui:
image: skywalking/ui
container_name: ui
depends_on:
- oap
links:
- oap
restart: always
ports:
- 8080:8080
environment:
SW_OAP_ADDRESS: oap:12800
kompose
主要功能是把docker-compose 转成Kubernetes
官方地址:https://github.com/kubernetes/kompose
version: '3'
services:
mysql-db:
image: mysql:5.7 # 指定镜像和版本
container_name: mysql # 指定容器的名称
ports:
- "3306:3306"
environment:
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
MYSQL_ROOT_HOST: ${MYSQL_ROOT_HOST}
volumes:
- mysql-data:/var/lib/mysql # 挂载数据目录
- ./my.cnf:/etc/my.cnf # 挂载配置文件目录
volumes:
mysql-data:
参考
https://docs.docker.com/compose/gettingstarted/
https://yeasy.gitbooks.io/docker_practice/content/compose/commands.html
https://www.bookstack.cn/read/DockerNotes/ch6.md
https://blog.csdn.net/shan165310175/article/details/95470674