docker-compose容器编排

一、docker-compose简介

# docker-compose简介

Docker-Compose项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排。

Docker-Compose将所管理的容器分为三层，分别是工程（project），服务（service）以及容器（container）。Docker-Compose运行目录下的所有文件（docker-compose.yml，extends文件或环境变量文件等）组成一个工程，若无特殊指定工程名即为当前目录名。
一个工程当中可包含多个服务，每个服务中定义了容器运行的镜像，参数，依赖。一个服务当中可包括多个容器实例，Docker-Compose并没有解决负载均衡的问题，因此需要借助其它工具实现服务发现及负载均衡。

Docker-Compose的工程配置文件默认为docker-compose.yml，可通过环境变量COMPOSE_FILE或-f参数自定义配置文件，其定义了多个有依赖关系的服务及每个服务运行的容器。

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

Compose允许用户通过一个单独的docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。

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

# docker-compose安装
pip3 install docker-compose

# 查看安装的版本
docker-compose --version

二、docker-compose常用命令

# 命令格式
docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]

# 选项参数
-f --file FILE指定Compose模板文件，默认为docker-compose.yml
-p --project-name NAME 指定项目名称，默认使用当前所在目录为项目名
--verbose  输出更多调试信息
-v，-version 打印版本并退出
--log-level LEVEL 定义日志等级(DEBUG, INFO, WARNING, ERROR, CRITICAL)

# 1.docker-compose up

docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
# 选项包括：
-d 在后台运行服务容器
-no-color 不是有颜色来区分不同的服务的控制输出
-no-deps 不启动服务所链接的容器
--force-recreate 强制重新创建容器，不能与-no-recreate同时使用
–no-recreate 如果容器已经存在，则不重新创建，不能与–force-recreate同时使用
–no-build 不自动构建缺失的服务镜像
–build 在启动容器前构建服务镜像
–abort-on-container-exit 停止所有容器，如果任何一个容器被停止，不能与-d同时使用
-t, –timeout TIMEOUT 停止容器时候的超时（默认为10秒）
–remove-orphans 删除服务中没有在compose文件中定义的容器

# 2.docker-compose ps 
# 列出项目中所有容器
docker-compose  ps [options] [SERVICE...]

# 3.docker-compose stop
docker-compose stop [options] [SERVICE...]
# 选项包括
-t, –timeout TIMEOUT 停止容器时候的超时（默认为10秒）
docker-compose stop   停止正在运行的容器，可以通过docker-compose start 再次启动

#4.docker-compose down
docker-compose down [options]
停止和删除容器、网络、卷、镜像。
# 选项包括：
–rmi type，删除镜像，类型必须是：all，删除compose文件中定义的所有镜像；local，删除镜像名为空的镜像
-v, –volumes，删除已经在compose文件中定义的和匿名的附在容器上的数据卷
–remove-orphans，删除服务中没有在compose中定义的容器
docker-compose down  停用移除所有容器以及网络相关

# 5.docker-compose logs
docker-compose logs [options] [SERVICE...]
查看服务容器的输出。默认情况下，docker-compose将对不同的服务输出使用不同的颜色来区分。可以通过–no-color来关闭颜色。
docker-compose logs
查看服务容器的输出
-f 跟踪日志输出

# 6.docker-compose bulid
docker-compose build [options] [--build-arg key=val...] [SERVICE...]
构建（重新构建）项目中的服务容器。
# 选项包括：
–compress 通过gzip压缩构建上下环境
–force-rm 删除构建过程中的临时容器
–no-cache 构建镜像过程中不使用缓存
–pull 始终尝试通过拉取操作来获取更新版本的镜像
-m, –memory MEM为构建的容器设置内存大小
–build-arg key=val为服务设置build-time变量
服务容器一旦构建后，将会带上一个标记名。可以随时在项目目录下运行docker-compose build来重新构建服务

# 7.docker-compose pull
docker-compose pull [options] [SERVICE...]
拉取服务依赖的镜像。
# 选项包括：
–ignore-pull-failures，忽略拉取镜像过程中的错误
–parallel，多个镜像同时拉取
–quiet，拉取镜像过程中不打印进度信息
docker-compose pull   拉取服务依赖的镜像

# 8. docker-compose rm
docker-compose rm [options] [SERVICE...]
删除所有（停止状态的）服务容器。
# 选项包括：
–f, –force，强制直接删除，包括非停止状态的容器
-v，删除容器所挂载的数据卷
docker-compose rm   删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器。


# 9.docker-compose run
docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
在指定服务上执行一个命令。
docker-compose run centos ping www.baidu.com
在指定容器上执行一个ping命令

# 10.docker-compose scale
docker-compose scale web=3 db=2
设置指定服务运行的容器个数。通过service=num的参数来设置数量

# 11.docker-compose pause
docker-compose pause [SERVICE...]   暂停一个服务容器

# 12.docker-compose kill
docker-compose kill [options] [SERVICE...]
通过发送SIGKILL信号来强制停止服务容器。
支持通过-s参数来指定发送的信号，例如通过如下指令发送SIGINT信号：
docker-compose kill -s SIGINT

#13. docker-compose config
docker-compose config [options]
验证并查看compose文件配置。
选项包括：
–resolve-image-digests 将镜像标签标记为摘要
-q, –quiet 只验证配置，不输出。 当配置正确时，不输出任何内容，当文件配置错误，输出错误信息
–services 打印服务名，一行一个
–volumes 打印数据卷名，一行一个

# 14.docker-compose create
docker-compose create [options] [SERVICE...]
为服务创建容器。
# 选项包括：
–force-recreate：重新创建容器，即使配置和镜像没有改变，不兼容–no-recreate参数
–no-recreate：如果容器已经存在，不需要重新创建，不兼容–force-recreate参数
–no-build：不创建镜像，即使缺失
–build：创建容器前　　，生成镜像

# 15.docker-compose exec
docker-compose exec [options] SERVICE COMMAND [ARGS...]
# 选项包括：
-d 分离模式，后台运行命令。
–privileged 获取特权。
–user USER 指定运行的用户。
-T 禁用分配TTY，默认docker-compose exec分配TTY。
–index=index，当一个服务拥有多个容器时，可通过该参数登陆到该服务下的任何服务，例如：docker-compose exec –index=1 web /bin/bash ，web服务中包含多个容器

# 16.docker-compose port
docker-compose port [options] SERVICE PRIVATE_PORT
显示某个容器端口所映射的公共端口。
# 选项包括：
–protocol=proto，指定端口协议，TCP（默认值）或者UDP
–index=index，如果同意服务存在多个容器，指定命令对象容器的序号（默认为1）

# 17.docker-compose push
docker-compose push [options] [SERVICE...]
推送服务依的镜像。
选项包括：
–ignore-push-failures 忽略推送镜像过程中的错误

# 18.docker-compose stop
docker-compose stop [options] [SERVICE...]
停止运行的容器

# 19.docker-compose uppause
docker-compose unpause [SERVICE...]
恢复处于暂停状态中的服务

# 常见流程：
启动：创建docker-compose.yaml  ->  docker-compose pull  -> docker-compose up -d

更新：docker-compose down -v -> docker-compose pull -> docker-compose up -d 

# 登录容器
docker-compose exec web1 bash

三、docker-compose模板文件

Docker-compose模板文件简介

Compose允许用户通过一个docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。
Compose模板文件是一个定义服务、网络和卷的YAML文件。Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名。
Docker-Compose标准模板文件应该包含version、services、networks 三大部分，最关键的是services和networks两个部分。

Compose目前有三个版本分别为Version 1，Version 2，Version 3，Compose区分Version 1和Version 2（Compose 1.6.0+，Docker Engine 1.10.0+）。Version 2支持更多的指令。Version 1将来会被弃用。

简易yml文件介绍：

web1:
  image: nginx  # images镜像名称
  volumes:
    - /opt/index1.html:/usr/share/nginx/html/index.html  # 将本地文件映射到镜像里：  本地路径文件:镜像路径
  expose:
    - 80   # 告诉nginx内部开放的端口是80，没有对外映射

web2:
  image: nginx
  volumes:
    - /opt/index2.html:/usr/share/nginx/html/index.html
  expose:
    - 80

haproxy:
  image: haproxy
  volumes:
    - /opt/haproxy.cfg:/usr/local/etc/haproxy/haproxy.cfg
  links:  # 依赖，web1和web2启动后再启动haproxy
    - web1
    - web2
  ports:   # 外部端口映射到内部
    - "7777:1080"
    - "80:80

global
  log 127.0.0.1 local0
  log 127.0.0.1 local1 notice
  maxconn 4096

defaults
  log global
  mode http
  option httplog
  option dontlognull
  timeout connect 5000ms
  timeout client 5000ms
  timeout server 5000ms

listen stats
  bind 0.0.0.0:1080
  mode http
  stats enable
  stats hide-version
  stats uri /stats
  stats auth admin:admin

frontend balancer
  bind 0.0.0.0:80
  default_backend webserver

backend webserver
  balance roundrobin
  server web1 web1:80 check
  server web2 web2:80 check

 # 如果没有这个镜像也会自动去服务器镜像仓库上拉取

# docker-compose ps
    Name                   Command               State                                     Ports                                   
-----------------------------------------------------------------------------------------------------------------------------------
opt_haproxy_1   docker-entrypoint.sh hapro ...   Up      0.0.0.0:7777->1080/tcp,:::7777->1080/tcp, 0.0.0.0:80->80/tcp,:::80->80/tcp
opt_web1_1      /docker-entrypoint.sh ngin ...   Up      80/tcp                                                                    
opt_web2_1      /docker-entrypoint.sh ngin ...   Up      80/tcp

从启动日志上可以看出先启动web1和2，再启动的haproxy;curl ip访问也可以获得index1.html和index2.html内容;访问http://ip:7777/stats进界面

docker-compose.yml配置文件

version: "3"

services:
        webapp:
                build:
                        context: ./dir # 指定 Dockerfile所在文件夹的路径
                        dockerfile: Dockerfile-alternate # 指定 Dockerfile文件名
                        args: # 指定构建镜像时的变量
                                buildno: 1
                        cache_from: # 指定构建镜像的缓存
                                - alpine:latest
                                - corp/web_app:3.14
                cap_add: # 指定容器内核能力分配
                        - ALL
                cap_drop: # 剔除哪些能力
                        - NET_ADMIN
                command: # 覆盖容器启动后默认执行的命令
                        echo "hello world"
                configs: # 仅用于 Swarm mode
                cgroup_parent: cgroups_1 # 指定父 cgroup组，意味着将继承该组的资源限制
                container_name: docker-web-container # 指定容器名称，一般是 项目名称-服务名称-序号
                deploy: # 仅用于 Swarm mode
                devices: # 指定设备映射关系
                        - "/dev/ttyUSB1:/dev/ttyUSB0"
                depends_on: # 解决容器的依赖、启动先后的问题
                        - db
                        - redis
                dns: # 自定义 DNS服务器，可以是一个值，也可以是一个列表
                        - 8.8.8.8
                        - 114.114.114.114
                dns_search: # 配置 DNS搜索域
                        - domain1.example.com
                        - domain2.example.com
                tmpfs: # 挂载一个 tmpfs文件系统到容器
                        - /run
                        - /tmp
                env_file: # 从文件中获取环境变量 env_file中变量的路径会基于模版文件的路径，如果有变量名称域 environment指令冲突，以后者为准
                        - ./common.env
                        - ./apps/web.env
                        # 环境变量文件中每一行必须符合格式，支持 #开头的注视行
                        #  # common.env: Set development environment
                        #  PROG_ENV=development
                environment: # 设置环境变量，如果这些变量名称中使用到了 true,false,yes,no等敏感词汇，最好放到引号中
                        - RACK_ENV=development
                        - SESSION_SECRET
                expose: # 暴露端口，但不映射到宿主机，只被连接的服务访问
                        - "3000"
                        - "8000"
                external_links: # （不建议使用）链接到 docker-compose.yml外部的容器中，甚至并非 compose管理的外部容器不建议使用
                        - redis_1
                        - project_db_1:mysql
                extra_hosts: # 指定额外的 host名称映射信息，会在启动后服务容器中的 /etc/hosts文件中添加配置的内容
                        - "googledns:8.8.8.8"
                        - "dockerhub:52.1.157.61"
                healthcheck: # 通过命令检查容器是否健康运行
                        test: ["CMD", "curl", "-f", "http://localhost"]
                        interval: 1m30s
                        timeout: 10s
                        retries: 3
                image: ubuntu # 指定为镜像名称或镜像 ID
                labels: # 添加 Docker元数据（metadata信息）
                        com.startupteam.description: "webapp for a startup team"
                        com.startupteam.department: "devops department"
                        com.startupteam.release: "rc3 for v1.0"
                links: #（不推荐使用）创建同其他容器间的连接
                logging: # 配置日志选项
                        driver: syslog
                        options:
                                syslog-address: "tcp://192.168.0.42:123"
                        # 目前支持 3种格式的日志驱动类型
                        # driver: "json-file"
                        # driver: "syslog"
                        # driver: "none"
                        #
                        # options 配置日志驱动的相关参数
                        #       max-size: "200k"
                        #       max-file: "10"
                networks: # 配置容器链接的网络
                        some-network:
                        other-network:
                pid: "host" # 跟主机系统共享进程命名空间，在开启该选型的容器之间以及容器同宿主机之间可以通过进程 ID相互访问
                ports: # 暴露端口信息，使用 宿主端口:容器端口 (HOST:CONTAINER)的格式
                        - "3000"
                        - "8000:8000"
                        - "49100:22"
                        - "127.0.0.1:8001:8001"
                        # 如果使用的容器端口小于 60并且没放到引号里，可能会得到错误结果，因为 yml会自动解析 xx:yy这种数字格式为 60进制
                secrets: # 存储敏感数据，例如 mysql服务密码
                        - db_root_password
                        - my_other_secret
                        my_secret:
                                file: ./my_secret.txt
                        my_other_secret:
                                external: true
                security_opt: # 指定容器模版标签(label)机制的默认属性（用户、角色、类型、级别等）
                        - label:user:USER
                        - label:role:ROLE
                stop_signal: SIGUSR1 # 设置另一个信号来停止容器，在默认情况下使用的是 SIGTERM停止容器
                sysctls: # 配置容器内核参数
                        net.core.somaxconn: 1024
                        net.ipv4.tcp_syncookies: 0
                        - net.core.somaxconn=1024
                        - net.ipv4.tcp_syncookies=0
                ulimits: # 指定容器的 ulimits限制值，例如可以指定最大进程数为 65535，指定文件句柄数为 20000，都可作为软限制
                        nproc: 65535
                        nofile: 
                                soft: 20000
                                hard: 40000
                volumes: # 数据卷所挂载路径设置，可以设置为宿主机路径（HOST:CONTAINER）或者数据卷名称（VOLUME:CONTAINER）
                         # 并且可以设置访问模式（HOST:CONTAINER:ro）
                        - /var/lib/mysql
                        - cache/:/tmp/cache
                        - ~/configs:/etc/configs/:ro
                        # 如果引号前路径设置为数据卷名称，就必须在文件中配置数据卷
                        # services:
                        #       my_src:
                        #               image: mysql:8.0
                        #               volumes:
                        #                       - mysql_data:/var/lib/mysql
                        #
                        # volumes:
                        #       mysql_data
                entrypoint: /code/entrypoint.sh # 指定服务容器启动后执行的入口文件
                user: nginx # 指定容器中运行应用的用户名
                working_dir: /code # 指定容器中工作目录
                domainname: your_website.com # 指定容器中搜索域名
                hostname: test # 主机名
                mac_address: 08-00-27-00-0C-0A # mac 地址
                privileged: "true" # 允许容器中运行一些特权命令
                restart: always # 指定容器退出后的重启策略，该命令对保持服务始终运行十分有效
                read_only: "true" # 以只读模式挂载容器的 root文件系统
                stdin_open: "true" # 打开标准输入，可以接收外部输入
                tty: "true" # 模拟一个伪终端

                # Compose模板文件支持动态读取主机的系统环境变量和当前目录下的 .env文件中的变量
                # version: "3"
                # services:
                #       db:
                #               image: "mongo:${MONGO_VERSION}"

```yml

----------------------------未完成-----------------------------