参考文献:

https://github.com/mykubernetes/Docker/blob/master/Docker%20Compose%E8%AF%A6%E8%A7%A3.md

https://github.com/datawhalechina/team-learning-program/blob/master/Docker/05%20Docker%20Compose.md

环境要求

培训学习服务器

# 1panel 面板
[1Panel Log]: 外部地址:  http://43.134.12.154:38438/4e57369521 
[1Panel Log]: 面板用户:  02d9d2cb63
[1Panel Log]: 面板密码:  54528a55e1
root 密码: cgXgnWoMP7QAn0

一、Docker Compose 简介

Compose 项目是Docker官方的开源项目,负责实现对Docker容器集群的快速编排。其代码目前在 https://github.com/docker/compose 上开源。Compose定位是【定义和运行多个Docker容器的应用(Oefining and running mult-container Docker applications)】

我们知道使用一个 Dockerfile 模板文件,可以让用户很方便的定义一个单独的应用容器。然而,在日常工作中,经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目,除了 Web 服务容器本身,往往还需要再加上后端的数据库服务容器,甚至还包括负载均衡容器等。

Compose中有两个重要的概念:

  • 服务 ( service ): 一个应用的容器,实际上可以包括若干运行相同镜像的容器实例。

  • 项目( project ): 由一组关联的应用容器组成的一个完整业务单元,在docker-compose.yml文件中定义。

Compose的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。

Compose项目由Python编写,实现上调用了Docker 服务提供的API来对容器进行管理。因此,只要所操作的平台支持Docker API,就可以在其上利用Compose来进行编排管理。

compose以项目为核心,在一个项目中定义一组具有与项目相关联的(相同业务逻辑单元)的服务或容器

Compose恰好满足了这样的需求。它允许用户通过一个单独的 docker-compose.yml 模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目(project)。不理解没关系,我们先看下面这样一个文件:

通过这个例子我们可以发现,这个文件里面我们好像看见了image、ports、networks这些,那么这些标签与之前docker run时候的一些指令是不是有一些关系呢?

docker run 方式启动容器

# 创建网络
docker network create wp-net
​
# mysql 注意生产环境 密码要用 Secrets
docker run --name mysql --network wp-net \
-v /bill/data:/var/lib/mysql \
-e MYSQL_DATABASE=exampledb \
-e MYSQL_USER=exampleuser \
-e MYSQL_PASSWORD=examplepass \
-e MYSQL_RANDOM_ROOT_PASSWORD=examplepass \
-d mysql:8.0
​
# WP
docker run -p 38080:80 --name wordpress --network wp-net \
  -v /bill/wordpress:/var/www/html \
  -e WORDPRESS_DB_HOST=mysql \
  -e WORDPRESS_DB_USER=exampleuser \
  -e WORDPRESS_DB_PASSWORD=examplepass \
  -e WORDPRESS_DB_NAME=exampledb \
  -d wordpress
​

docker compose 方式

services:
​
  wordpress:
    image: wordpress
    restart: always
    ports:
      - 38080:80
    environment:
      WORDPRESS_DB_HOST: db
      WORDPRESS_DB_USER: exampleuser
      WORDPRESS_DB_PASSWORD: examplepass
      WORDPRESS_DB_NAME: exampledb
    volumes:
      - wordpress:/var/www/html
​
  db:
    image: mysql:8.0
    restart: always
    environment:
      MYSQL_DATABASE: exampledb
      MYSQL_USER: exampleuser
      MYSQL_PASSWORD: examplepass
      MYSQL_RANDOM_ROOT_PASSWORD: examplepass
    volumes:
      - db:/var/lib/mysql
​
volumes:
  wordpress:
  db:
​

二、Docker Compose模板指令

images

  • 指定为镜像名称或镜像ID。如果镜像在本地不存在,Compose 将会尝试拉取这个镜像。

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd

ports

  • 暴露端口信息。使用宿主端口:容器端(HOST:CONTAINER)格式,或者仅仅指定容器的端(宿主将会随机选择端口)

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"

注意:当使用 HOST:CONTAINER 格式来映射端口时,如果你使用的容器端口小于 60 你可能会得到错误得结果,因为 YAML 将会解析 xx:yy 这种数字格式为 60 进制。所以建议采用字符串格式。

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,如果就需要使用自定义卷名,
  # 需要添加external,但是启动时事先需要先创建卷名,比较麻烦: docker volume create mydata
  - datavolume:/var/lib/mysql 

networks

  • 配置容器连接网络

version: "3"
services:
  some-service:
    networks:
      -some-network # 指定当前服务加入哪个网桥
      -other-network
​
networks:  # 创建网桥
  some-network:
  other-network:
    external:
      true # 使用自定义网桥,但是必须事先创建:外部使用命令 docker network create some-network

container_name

  • 指定一个自定义容器名称,而不是生成的默认名称。

container_name: my-web-container

由于Docker容器名称必须是唯一的,因此如果指定了自定义名称,则无法将服务扩展到多个容器。例如,启动两个tomcat,并加入自建网络

environment

  • 添加环境变量。 你可以使用数组或字典两种形式。 任何布尔值; true,false,yes,no需要用引号括起来,以确保它们不被YML解析器转换为True或False。

只给定名称的变量会自动获取它在 Compose 主机上的值,可以用来防止泄露不必要的数据。如果 environment 和env_file同时存在,前者会覆盖后者

y|Y|yes |Yes|YES|n |N|no|No|NO|true|True |TRUE |false|False|FALSE| on | On| ON |[off|0ff| OFF

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:
 
environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

注意:如果你的服务指定了build选项,那么在构建过程中通过environment定义的环境变量将不会起作用。 将使用build的args子选项来定义构建时的环境变量。

env_file (开发环境)

  • 从一个文件中加入环境变量,带入到容器中去,在容器中可以用printenv打印该环境变量。该文件可以是一个单独的值或者一张列表,在environment中指定的环境变量将会重写这些值

env_file : .env
​
或
env_file:
 - ./common.env
 - ./apps/ web.env
 - /opt/secrets.env

环境变量文件中每一行必须符合格式,支持#开头的注释行。

# common.env: Set development environment
MYSQL_ROOT_PASSWORD="123456"

secrets (生产环境)

存储敏感数据,例如 mysql 服务密码。

version: "3.1"
services:
​
mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  secrets:
    - db_root_password
​
secrets:
  db_root_password:
    file: ./db_root_password.txt

depends_on

  • 解决容器的依赖、启动先后的问题。以下例子中会先启动redis ,db再启动web

version: "3.8"
services:
  web:
    build: .
    depends_on:
      - db # 注意此处是服务名,而不是容器名
      - redis
  redis:
    image: redis
  db:
    image: postgres

三、Docker Compose常用命令

docker compose up -d  # 尝试自动完成包括构建镜像,(重新)创建服务,启动服务,并关联服务相关容器的一系列操作。
docker compose down  # 此命令将会停止 up 命令所启动的容器,并移除网络
docekr compose exec 服务id(不是容器名) bash  # 进入指定的容器。
docker compose ps  # 列出项目中目前的所有容器。
docker compose top mysql  # 查看各个服务容器内运行的进程。
docker compose logs -f -t --tail=10  # 查看日志