Docker Compose 概述与安装

红太狼 2022-01-17 03:53 377阅读 0赞

# 1.Docker Compose 概述 #

Compose是Docker的服务编排工具，主要用来构建基于Docker的复杂应用，Compose 通过一个配置文件来管理多个Docker容器，非常适合组合使用多个容器进行开发的场景。

说明：**Compose是Fig的升级版，[Fig][]已经不再维护。Compose向下兼容Fig，所有`fig.yml`只需要更名为`docker-compose.yml`即可被Compose使用。**

服务编排工具使得Docker应用管理更为方便快捷。

Compose网站：[https://docs.docker.com/compose/][https_docs.docker.com_compose]

# 2.安装 Docker Compose #

*  安装 Docker Compose 可以通过下面命令自动下载适应版本的 Compose，并为安装脚本添加执行权限

# 方法一：
    $ curl -L https://github.com/docker/compose/releases/download/1.8.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
    $ chmod +x /usr/local/bin/docker-compose
    
    # Linux下等效于
    $ curl -L https://github.com/docker/compose/releases/download/1.8.1/docker-compose-Linux-x86_64 > /usr/local/bin/docker-compose; chmod +x /usr/local/bin/docker-compose
    
    # 方法二：使用pip安装，版本可能比较旧
    $ yum install python-pip python-dev
    $ pip install docker-compose
    
    # 方法三：作为容器安装
    $ curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
    $ chmod +x /usr/local/bin/docker-compose
    
    # 方法四：离线安装
    # 下载[docker-compose-Linux-x86_64](https://github.com/docker/compose/releases/download/1.8.1/docker-compose-Linux-x86_64)，然后重新命名添加可执行权限即可：
    $ mv docker-compose-Linux-x86_64 /usr/local/bin/docker-compose;
    $ chmod +x /usr/local/bin/docker-compose
    # 
    # docker官方离线地址：https://dl.bintray.com/docker-compose/master/

**是否成功**

docker-compose --version

**卸载 **

$ rm /usr/local/bin/docker-compose
    
    # 卸载使用pip安装的compose
    $ pip uninstall docker-compose

# 3.Docker Compose 常用命令与配置 #

docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]

命令选项如下：  
\-f，–file FILE指定Compose模板文件，默认为docker-compose.yml，可以多次指定。  
\-p，–project-name NAME指定项目名称，默认将使用所在目录名称作为项目名。  
\-x-network-driver 使用Docker的可拔插网络后端特性（需要Docker 1.9+版本）  
\-x-network-driver DRIVER指定网络后端的驱动，默认为bridge（需要Docker 1.9+版本）  
\-verbose输出更多调试信息  
\-v，–version打印版本并退出

## 1.**ps**：列出所有运行容器 ##

docker-compose ps

### 2.docker-compose -h ###

docker-compose -h

查看帮助

## **3.**docker-compose down ##

docker-compose down [options]

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

## 4.logs ##

查看服务日志输出

docker-compose logs

## 5.port ##

打印绑定的公共端口，下面命令可以输出 eureka 服务 8761 端口所绑定的公共端口

docker-compose port eureka 8761

## **6.build** ##

构建或者重新构建服务

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.start** ##

启动指定服务已存在的容器

docker-compose start [options] [SERVICE...]
    docker-compose restart [options] [SERVICE...]

选项包括：  
\-t, –timeout TIMEOUT，指定重启前停止容器的超时（默认为10秒）  
`docker-compose restart`  
重启项目中的服务

## **8.**stop ##

停止已运行的服务的容器

docker-compose stop [options] [SERVICE...]
    docker-compose pause 暂停一个容器

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

## **9.rm** ##

删除指定服务的容器

docker-compose rm [options] [SERVICE...]

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

## **10.**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文件中定义的容器  
–scale SERVICE=NUM 设置服务运行容器的个数，将覆盖在compose中通过scale指定的参数  
`docker-compose up`  
启动所有服务  
`docker-compose up -d`  
在后台所有启动服务  
\-f 指定使用的Compose模板文件，默认为docker-compose.yml，可以多次指定。  
`docker-compose -f docker-compose.yml up -d`

## **11.kill** ##

通过发送 SIGKILL 信号来停止指定服务的容器

docker-compose kill [options] [SERVICE...]

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

## **12.**pull ##

下载服务镜像

docker-compose pull [options] [SERVICE...]

拉取服务依赖的镜像。

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

## **13.scale** ##

设置指定服务运气容器的个数，以 service=num 形式指定

docker-compose scale user=3 movie=3

## **14.run** ##

在一个服务上执行一个命令

docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]

在指定服务上执行一个命令。  
`docker-compose run ubuntu ping www.baidu.com`  
在指定容器上执行一个ping命令。

## **15.**dokcer-compose config ##

docker-compose config [options]

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

## **16.**docker-compose create ##

docker-compose create [options] [SERVICE...]

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

## 17.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服务中包含多个容器

## **18.**docker-compose port ##

docker-compose port [options] SERVICE PRIVATE_PORT

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

## **19.**docker-compose push ##

docker-compose push [options] [SERVICE...]

推送服务依的镜像。  
选项包括：  
–ignore-push-failures 忽略推送镜像过程中的错误

## **20.**docker-compose unpause ##

docker-compose unpause [SERVICE...]

恢复处于暂停状态中的服务。

## **21.**docker-compose version ##

docker-compose version

打印版本信息。

# 4.Docker-Compose模板文件 docker-compose.yml  #

*  **Docker Compose 将所管理的容器分为三层，分别是工程（project）、服务（service）、容器（container）**
 *  **Docker Compose 运行目录下的所有文件（docker-compose.yml）组成一个工程,一个工程包含多个服务，每个服务中定义了容器运行的镜像、参数、依赖，一个服务可包括多个容器实例**

## Docker-Compose模板文件简介 ##

### 1.version：指定 docker-compose.yml 文件的写法格式 ###

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将来会被弃用。

### 2.services：多个容器集合 ###

### 3.build：配置构建服务 ###

服务除了可以基于指定的镜像，还可以基于一份Dockerfile，在使用up启动时执行构建任务，构建标签是build，可以指定Dockerfile所在文件夹的路径。Compose将会利用Dockerfile自动构建镜像，然后使用镜像启动服务容器。  
`build: /path/to/build/dir`  
也可以是相对路径，只要上下文确定就可以读取到Dockerfile。  
`build: ./dir`  
设定上下文根目录，然后以该目录为准指定Dockerfile。

build:
      context: ../
      dockerfile: path/of/Dockerfile

build都是一个目录，如果要指定Dockerfile文件需要在build标签的子级标签中使用**dockerfile**标签指定。  
如果同时指定image和build两个标签，那么Compose会构建镜像并且把镜像命名为image值指定的名字。

build: ./dir
    ---------------
    build:
        context: ./dir
        dockerfile: Dockerfile
        args:
            buildno: 1

**context**为路径，dockerfile为需要替换默认docker-compose的文件名，args为构建(build)过程中的环境变量，用于替换Dockerfile里定义的ARG参数，容器中不可用。示例：

Dockerfile:

ARG buildno
    ARG password
    
    RUN echo "Build number: $buildno"
    RUN script-requiring-password.sh "$password"

docker-compose.yml:

build:
      context: .
      args:
        buildno: 1
        password: secret
    
    build:
      context: .
      args:
        - buildno=1
        - password=secret

**command**：覆盖容器启动后默认执行的命令

command: bundle exec thin -p 3000
    ----------------------------------
    command: [bundle,exec,thin,-p,3000]

### **4.image**：指定服务所使用的镜像 ###

image: java

image是指定服务的镜像名称或镜像ID。如果镜像在本地不存在，Compose将会尝试拉取镜像。

### 5.container\_name ###

Compose的容器名称格式是：<项目名称><服务名称><序号>  
可以自定义项目名称、服务名称，但如果想完全控制容器的命名，可以使用标签指定：  
`container_name: app`

### 6.depends\_on ###

在使用Compose时，一般项目容器启动的顺序是有要求的，如果直接从上到下启动容器，必然会因为容器依赖问题而启动失败。例如在没启动数据库容器的时候启动应用容器，应用容器会因为找不到数据库而退出。depends\_on标签用于解决容器的依赖、启动先后的问题。

version: '2'
    services:
      web:
        build: .
        depends_on:
          - db
          - redis
      redis:
        image: redis
      db:
        image: postgres

上述YAML文件定义的容器会先启动redis和db两个服务，最后才启动web 服务。

### 7.pid ###

`pid: "host"`  
将PID模式设置为主机PID模式，跟主机系统共享进程命名空间。容器使用pid标签将能够访问和操纵其他容器和宿主机的名称空间。

### 8.ports ###

ports用于映射端口的标签。  
使用HOST:CONTAINER格式或者只是指定容器的端口，宿主机会随机映射端口。

ports:
     - "3000"
     - "8000:8000"
     - "49100:22"
     - "127.0.0.1:8001:8001"

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

### 9.extra\_hosts ###

添加主机名的标签，会在/etc/hosts文件中添加一些记录。

extra_hosts:
     - "somehost:162.242.195.82"
     - "otherhost:50.31.209.229"

启动后查看容器内部hosts：

162.242.195.82  somehost
    50.31.209.229   otherhost

### 10.volumes ###

挂载一个目录或者一个已存在的数据卷容器，可以直接使用 \[HOST:CONTAINER\]格式，或者使用\[HOST:CONTAINER:ro\]格式，后者对于容器来说，数据卷是只读的，可以有效保护宿主机的文件系统。  
Compose的数据卷指定路径可以是相对路径，使用 . 或者 .. 来指定相对目录。  
数据卷的格式可以是下面多种形式：

volumes:
      // 只是指定一个路径，Docker 会自动在创建一个数据卷（这个路径是容器内部的）。
      - /var/lib/mysql
      // 使用绝对路径挂载数据卷
      - /opt/data:/var/lib/mysql
      // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器。
      - ./cache:/tmp/cache
      // 使用用户的相对路径（~/ 表示的目录是 /home/<用户目录>/ 或者 /root/）。
      - ~/configs:/etc/configs/:ro
      // 已经存在的命名的数据卷。
      - datavolume:/var/lib/mysql

如果不使用宿主机的路径，可以指定一个volume\_driver。  
`volume_driver: mydriver`

### 11.volumes\_from ###

从另一个服务或容器挂载其数据卷：

volumes_from:
       - service_name    
         - container_name

### 12.dns ###

自定义DNS服务器。可以是一个值，也可以是一个列表。

dns：8.8.8.8
    dns：
        - 8.8.8.8    
          - 9.9.9.9

### 13.dns\_search ###

配置DNS搜索域。可以是一个值，也可以是一个列表。

dns_search：example.com
    dns_search：
        - domain1.example.com
        - domain2.example.com

### 14.entrypoint ###

在Dockerfile中有一个指令叫做ENTRYPOINT指令，用于指定接入点。  
在docker-compose.yml中可以定义接入点，覆盖Dockerfile中的定义：  
`entrypoint: /code/entrypoint.sh`

### 15.env\_file ###

在docker-compose.yml中可以定义一个专门存放变量的文件。  
如果通过docker-compose -f FILE指定配置文件，则env\_file中路径会使用配置文件路径。  
如果有变量名称与environment指令冲突，则以后者为准。格式如下：  
`env_file: .env`  
或者根据docker-compose.yml设置多个：

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

如果在配置文件中有build操作，变量并不会进入构建过程中。

### 16.cap\_add ###

增加指定容器的内核能力（capacity）。  
让容器具有所有能力可以指定：

cap_add:
        - ALL

### 17.cap\_drop ###

去掉指定容器的内核能力（capacity）。  
去掉NET\_ADMIN能力可以指定：

cap_drop:
        - NET_ADMIN

### 18.cgroup\_parent ###

创建了一个cgroup组名称为cgroups\_1:  
`cgroup_parent: cgroups_1`

### 19.devices ###

指定设备映射关系，例如：

devices:
        - "/dev/ttyUSB1:/dev/ttyUSB0"

### 20.expose ###

暴露端口，但不映射到宿主机，只允许能被连接的服务访问。仅可以指定内部端口为参数，如下所示：

expose:
        - "3000"
        - "8000"

### 21.extends ###

基于其它模板文件进行扩展。例如，对于webapp服务定义了一个基础模板文件为common.yml：

# common.yml
    webapp:
        build: ./webapp
        environment:
            - DEBUG=false
            - SEND_EMAILS=false

再编写一个新的development.yml文件，使用common.yml中的webapp服务进行扩展：

# development.yml
    web:
        extends:
            file: common.yml
            service: webapp
        ports:
            - "8000:8000"
        links:
            - db
        environment:
            - DEBUG=true
    db:
        image: mysql

后者会自动继承common.yml中的webapp服务及环境变量定义。  
extends限制如下：  
A、要避免出现循环依赖  
B、extends不会继承links和volumes\_from中定义的容器和数据卷资源  
推荐在基础模板中只定义一些可以共享的镜像和环境变量，在扩展模板中具体指定应用变量、链接、数据卷等信息

### 22.external\_links ###

链接到docker-compose.yml外部的容器，可以是非Compose管理的外部容器。

external_links:
        - redis_1
        - project_db_1:mysql
        - project_db_1:postgresql

### 23.labels ###

为容器添加Docker元数据（metadata）信息。例如，可以为容器添加辅助说明信息：

labels：
        com.startupteam.description: "webapp for a strtup team"

### 24.links ###

*  服务之间可以使用服务名称相互访问，links 允许定义一个别名，从而使用该别名访问其它服务

version: '2'
    services:
        web:
            build: .
            links:
                - "db:database"
        db:
            image: postgres

*  这样 Web 服务就可以使用 db 或 database 作为 hostname 访问 db 服务了

使用服务名称（同时作为别名），或者“服务名称:服务别名”（如 SERVICE:ALIAS），例如：

links:
        - db
        - db:database
        - redis

使用别名将会自动在服务容器中的/etc/hosts里创建。例如：

172.17.2.186  db
    172.17.2.186  database
    172.17.2.187  redis

### 25.log\_driver ###

指定日志驱动类型。目前支持三种日志驱动类型：

log_driver: "json-file"
    log_driver: "syslog"
    log_driver: "none"

### 26.log\_opt ###

日志驱动的相关参数。例如：

log_driver: "syslog"log_opt: 
        syslog-address: "tcp://192.168.0.42:123"

### 27.net ###

设置网络模式。

net: "bridge"
    net: "none"
    net: "host"

### 28.security\_opt ###

指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如，配置标签的用户名和角色名：

security_opt:
        - label:user:USER
        - label:role:ROLE

# 5.批处理脚本 #

# 关闭所有正在运行容器
    docker ps | awk  '{print $1}' | xargs docker stop
    
    # 删除所有容器应用
    docker ps -a | awk  '{print $1}' | xargs docker rm
    # 或者
    docker rm $(docker ps -a -q)

# 6.使用Docker Compose完成springboot项目部署 #

*  打包项目，获得 jar 包 docker-demo-0.0.1-SNAPSHOT.jar

mvn clean package

*  在 jar 包所在路径创建 Dockerfile 文件，添加以下内容

FROM openjdk:8-jdk-alpine
    MAINTAINER lihui ieflex@qq.com
    
    RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
    RUN echo "Asia/Shanghai" > /etc/timezone
    
    VOLUME /tmp
    ADD neuai-app-1.0.0-uat.jar app.jar
    ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]

*  在 jar 包所在路径创建文件 docker-compose.yml，添加以下内容

version: '2'    # 表示该 Docker-Compose 文件使用的是 Version 2 file
    services:
      mysqlapp:    # 指定服务名称
       container_name: app-mysql
       image: mysql:5.7
       volumes:
           - /root/app/dbdata:/var/lib/mysql
           - /etc/localtime:/etc/localtime
       environment:
            MYSQL_DATABASE: door
            MYSQL_ROOT_PASSWORD: xxx
            MYSQL_ROOT_HOST: '%'
       ports:
           - "3306:3306"
       restart: always
        
      app:
        container_name: app-scan
        restart: always
        build:
            context: .
            dockerfile: Dockerfile
        working_dir: /root/app
        environment:
            VIRTUAL_HOST: www.ieflex.com
        volumes:
            - /root/app:/app
            - /root/app/logs:/home/liqi/logs
            - /etc/localtime:/etc/localtime
        ports:
            - "8080:8080"
        depends_on:
            - mysqlapp
        command: mvn clean spring-boot:run -Dspring-boot.run.profiles=docker
    
    networks:
        default:
            external:
                name: nginx-proxy

*  在 docker-compose.yml 所在路径下执行该命令 Compose 就会自动构建镜像并使用镜像启动容器

docker-compose up
    docker-compose up -d  // 后台启动并运行容器

*  访问 [http://localhost:9000/hello][http_localhost_9000_hello] 即可访问微服务接口

[Fig]: http://www.fig.sh/
[https_docs.docker.com_compose]: https://docs.docker.com/compose/
[http_localhost_9000_hello]: http://localhost:9000/hello