devbox
笔触狂放9
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

docker-compose 参数说明

作者：笔触狂放9 | 2024-02-10 12:38:51

赞

踩

docker-compose 参数

1、docker-compose的简介

docker-compose作为dokcer的官方编排工具，它可以让用户通过编写一个简单的模板文件，快速地创建和管理基于docker容器的应用集群。实现对docker容器集群的快速编排。我们知道Dockerfile模板文件，可以让用户很方便地定义一个单独的应用容器。然而在日常工作中，经常会遇到需要多个容器相互配合来完成某项任务的情况。例如要实现一个web项目，除了web服务器容器本身，往往还需要加上后端的数据库服务容器，甚至还包括负载均衡容器等。
    而 Compose 正好可以满足这样的需求，它允许用户通过一个单独的docker-compose.yml模板文件（YAML格式）来定义一组相关联的应用容器作为一个项目（project）
    Compose中有2个重要的概念：
    （1）服务（service）：一个应用的容器，实际上可以包含若干运行相同镜像的容器实例。
    （2）项目（project）：由一组关联的应用容器组成的一个完成业务单元，在docker-compose.yml文件中定义。

2、docker-compose安装

Compose项目是用Python语言编写的，所以compose可以通过python的pip工具进行安装。安装过程如下：

[root@localhost ~]# yum install -y python-pip
[root@localhost ~]# pip install -U docker-compose
[root@localhost ~]# docker-compose version
docker-compose version 1.21.0, build 5920eb0
docker-py version: 3.2.1
CPython version: 2.7.5
OpenSSL version: OpenSSL 1.0.1e-fips 11 Feb 2013

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

3、Compose命令

对于Compose来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或容器。如果没有特别说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令的影响。docker-compose命令的基本使用格式如下：

Usage:
  docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]
  docker-compose -h|--help

Options:
  -f, --file FILE             指定使用的Compose模板文件，默认为docker-compose.yml,可多次指定；                        
  -p, --project-name NAME     指定项目名称，默认将使用所在目录名称作为项目名 ；                           
  --verbose                   输出更多调试信息；

  -v, --version               打印版本信息；

Commands:
  build              构建项目中的服务容器
  help               获得一个命令的帮助
  images             列出所有镜像
  kill               通过发送SIGKILL信号来强制停止服务容器
  logs               查看服务器容器的输出
  pause              暂停一个服务容器
  port               打印某个容器的端口所映射的公共端口
  ps                 列出项目中目前的所有容器
  pull               拉取服务依赖的镜像
  push               推送服务依赖的镜像
  restart            重启项目中的服务
  rm                 删除所有的服务器容器（停止状态中的）
  run                在指定服务上执行一个命令
  scale              设置指定服务运行的容器个数
  start              启动已经存在的服务容器
  stop               停止已经处于运行状态的容器，但不删除它
  top                展示运行的进程
  unpause            恢复处于暂停状态中的服务
  up                 自动完成包括构建镜像、创建服务、启动服务并关联服务相关容器的一系列操作
  version            打印docker-compose的版本信息 

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32

4. Compose模板文件

模板文件是使用Compose的核心，设计的指令关键字也有很多，默认的模板文件名称为docker-compose.yml，格式为YAML格式。举例：

version: "2"
service:
    webapp:
        image: examplses/web
        ports:
            - "80:80"
        volumes:
            - "/data"

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

注意，每个服务都必须通过image指定镜像或build命令（需要Dockerfile）等来自动构建生成镜像。如果使用build指令，在Dockerfile中设置的选项（例如：CMD、EXPOSE、VOLUME、ENV等）将会自动被获取，无需在docker-compose.yml中再次设置。以下为模板的主要指令和功能：

  1. build指令

指定Dockerfile所在文件夹的路径（可以是绝对路劲，或相对docker-compose.yml文件的路径。）Compose将会利用它自动构建这个镜像，然后使用这个镜像：

build: /path/to/build/dir

  • 1
  1. cap_add,cap_drop

指定容器的内核能力（capacity）分配。例如，让容器拥有所有能力可以指定为：

cap_add:
    - ALL 
去掉NET_ADMIN能力可以指定为：

cap_drop:
    - NET_ADMIN

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  1. command

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

command: echo "hello world"

  • 1
  1. cgroup_parent
指定父cgroup组，意味着将继承该组的资源限制，例如，创建了一个cgroup组为cgroups_1：
cgroup_parent: cgroups_1

  • 1
  • 2
  1. container_name

指定容器名称。默认将会使用“项目名称_服务名称_序号”这样的格式。例如：

container_name: docker-web-container

  • 1

指定容器名称后，该服务将无法进行扩展，因为Docker不允许多个容器具有相同的名称。

  1. devices
    指定设备映射关系，例如：
devices:
    - "/dev/ttyUSB1:/dev/ttyUSB0"

  • 1
  • 2
  1. dns

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

dns: 8.8.8.8
dns:
    - 8.8.8.8
    - 114.114.114.114

  • 1
  • 2
  • 3
  • 4
  1. dns_search

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

dns_search: example.com
dns_search:
    - domain1.example.com
    - domain2.example.com

  • 1
  • 2
  • 3
  • 4
  1. dockerfile

如果需要，指定额外的编译镜像的Dockerfile文件，可以通过该指令来指定，例如：
该指令不能和image一起使用，否则Compose不知道根据哪个指令来生成最终的服务镜像。

dockerfile: Dockerfile-alternate

  • 1
  1. env_file

从文件中获取环境变量，可以为单独的文件路径或列表。
如果通过docker-compose -f FILE的方式来指定Compose模板文件，则env_file中变量的路径会基于模板文件路径，如果有变量名称和environment指令冲突，则按照惯例，以后者为准：

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

  • 1
  • 2
  • 3
  • 4
  • 5

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

  1. environment

设置环境变量，可以使用数组或字典两种格式。只给定名称的变量会自动获取运行Compose主机上对应变量的值，可以用来防止泄露不必要的数据。例如：

environment:
    RACK_ENV: development
    SESSION_SECRET
或者：
environment:
    - RACK_ENV=development
    - SESSION_SECRET

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  1. expose

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

expose:
    - "3000"
    - "8000"

  • 1
  • 2
  • 3
  1. extends
    基于其他模板文件进行扩展。例如我们已经有了一个webapp服务，定义一个基础模板文件为common.yml，如下所示：
  • common.yml
webapp:
    build: ./webapp
    environment:
        - DEBUG=false
        - SEND_EMAILS=false

  • 1
  • 2
  • 3
  • 4
  • 5

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

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

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

development.yml会自动继承common.yml中的webapp服务及环境变量定义。使用extends需要注意以下几点：
1.避免出现循环依赖，如A依赖B，B依赖C，C依赖A
2.extends不会继承links和volume_from中定义的容器和数据卷资源。
一般情况下，推荐在基础模板中只定义一些可以共享的镜像和环境变量，在扩展模板中具体指定应用变量、链接、数据卷等信息。

  1. external_links
    链接到docker-compose.yml外部的容器，甚至可以是非Compose管理的外部容器。参数格式和links类似
external_links:
    - redis_1
    - project_db_1:mysql
    - project_db_1:postgresql

  • 1
  • 2
  • 3
  • 4
  1. extra_hosts
    类似于Docker中的–add-host参数，指定额外的host名称映射信息，例如：
extra_hosts:
    - "googledns:8.8.8.8"
    - "dockerhub:52.1.157.61"

  • 1
  • 2
  • 3

会在启动后的服务容器中/etc/hosts文件中添加以下2个条目：

8.8.8.8 googledns
52.1.157.61 dockerhub

  • 1
  • 2
  1. image

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

image: centos
image: nginx

  • 1
  • 2
  1. labels
    为容器添加Docker元数据（metadata）信息。例如，可以为容器添加辅助说明信息：
labels:
    com.startupteam.description: "webapp for a startup team"
    com.startupteam.department: "devops department"
    com.startupteam.release: "rc3 for v1.0"

  • 1
  • 2
  • 3
  • 4
  1. links

链接到其他服务中的容器。使用服务名称（同时作为别名），或者”服务名称:服务别名”（如SERVICE:ALIAS），这样的格式都可以，例如：

links:
    - db
    - db:database
    - redis

  • 1
  • 2
  • 3
  • 4

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

172.17.2.186 db
172.17.2.186 database
172.17.2.187 redis

  • 1
  • 2
  • 3

所连接容器中相应的环境变量也将创建

  1. log_driver
    类似于Docker中的–log-driver参数，指定日志驱动类型。目前支持三种日志驱动类型：
log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"

  • 1
  • 2
  • 3
  1. log_opt

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

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

  • 1
  • 2
  • 3
  1. net

设置网络模式。参数类似于docker client的–net参数

net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"

  • 1
  • 2
  • 3
  • 4
  1. pid

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程ID来相互访问和操作：

pid: "host"

  • 1
  1. ports

暴露端口信息。使用”宿主：容器“的格式，或者仅仅指定容器的端口（宿主机会随机选择端口）：

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

  • 1
  • 2
  • 3
  • 4
  • 5

当使用"HOST:CONTAINER"格式来映射端口时，如果你使用的容器端口小于60并且没有放到引号里，可能会得到错误结果，因为YAML会自动解析xx:yy这种数字格式为60进制。为了避免这种问题的出现，建议数字串都用引号包括起来的字符串格式。

  1. security_opt

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

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

  • 1
  • 2
  • 3
  1. ulimits

指定容器的ulimits限制值，例如，指定最大进程数为65535，指定文件句柄数位20000（软限制，应用可以随时修改，不能超过硬限制，只能root用户提高）。

ulimits:
    nproc:65535
    nofile:
        soft:20000
        hard:40000

  • 1
  • 2
  • 3
  • 4
  • 5
  1. volumes

数据卷所挂载的路径设置。可以设置宿主机路径（HOST:CONTAINER）或加上访问模式（HOST:CONTAINER:ro）。该指令中路径支持相对路径。例如：

volumes:
    - /var/lib/mysql
    - cache/:/tmp/cache
    - ~/configs:/etc/configs/:ro
#### （27）volumes_driver

  • 1
  • 2
  • 3
  • 4
  • 5
  • 较新版本的Docker支持数据卷的插件驱动。用户可以先使用第三方驱动创建一个数据卷，然后使用名称来访问它。此时，可以通过volumes_driver来指定驱动：
volume_driver: mydriver

  • 1
  1. volumes_from
  • 从另一个服务或容器挂载它的数据卷：
volumes_from:
    - service_name
    - container_name

  • 1
  • 2
  • 3
声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/笔触狂放9/article/detail/74312?site
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号