Docker学习笔记-Task05Docker Compose

Docker compose

1 什么是docker compose

  使用一个Dockerfile模板文件，可以让用户很方便的定义一个单独的应用容器。然而，在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个Web项目，除了Web服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等，Compose恰好满足了这样的需求。它允许用户通过一个单独的docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目。
  docker compose安装链接：
https://vuepress.mirror.docker-practice.com/compose/install
https://docs.docker.com/compose/install/
  在Compose中有两个重要的概念：
  服务 (service)：一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。
  项目(project)：由一组关联的应用容器组成的一个完整业务单元，在docker-compose.yml 文件中定义。
  Compose的默认管理对象是项目，也就是通过docker-compose.yml定义的一组服务集合，通过一些命令来对项目中的一组容器进行便捷地生命周期管理。

2 docker compose基本使用

2.1 启动服务

  在创建好docker-compose.yml文件后，可以通过docker-compose up命令将文件中定义的容器都启动起来，在docker compose中我们更习惯于将每一个容器叫做service。
  命令后会自动接一个默认值-f docker-compose.yml，也就是默认是使用docker-compose.yml文件的。我们也可以给文件起名为docke-test.yml，这样在使用时指定文件名，docker-compose up -f docer-test.yml。但是为了符合规范，还是统一为docker-compose.yml。
  但是通过这种方式的话会直接将启动时的输出打印到终端，所以我们常会加上-d参数：docker-compose up -d。

2.2 查看服务状态

  查看创建的service状态：docker-compose ps
  查看所有service的状态可以使用-a参数：docker-compose ps -a

2.3 停止或删除服务

  可以使用以下两个命令停止已经运行的services：
  docker-compose stop
  docker-compose down
  其中stop是直接停止services，而down则会停止并删除创建的service，volume和network。

2.4 进入服务

  有些情况下需要进入容器来执行一些命令，可以通过docker-compose exec mysql bash进入容器。exec后面接的就是我们要进入具体的service的名字，名字后面就是我们要执行的命令。

2.5 查看服务输出日志

  有些情况下一些服务可能无法正常启动，这时可以使用命令查看日志并定位发生错误的原因：docker-compose logs。

3 Compose模板文件

  模板文件是使用Compose的核心，涉及到的指令关键字也比较多。这里仅介绍一些较为常用的指令，更多指令请见：
https://vuepress.mirror.docker-practice.com/compose/compose_file/
  默认的模板文件名称为docker-compose.yml，格式为YAML格式。

  注：每个服务都必须通过image指令指定镜像或build指令（需要 Dockerfile）等来自动构建生成镜像。如果使用 build 指令，在Dockerfile中设置的选项(例如：CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取，无需在docker-compose.yml中重复设置。

3.1 build

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

  也可以使用context指令指定Dockerfile所在文件夹的路径，使用dockerfile指令指定Dockerfile文件名，使用arg指令指定构建镜像时的变量。

  使用cache_from指定构建镜像的缓存。

3.2 depends_on

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

  注意：web服务不会等待redis db「完全启动」之后才启动。这里需要注意，如果redis启动失败，那么web依然会正常启动。

3.3 environment

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

  如果变量名称或者值中用到true|false，yes|no等表达布尔 (opens new window)含义的词汇，最好放到引号里，避免YAML自动解析某些内容为对应的布尔语义。这些特定词汇，包括  y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF。

3.4 expose

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

3.5 ports

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

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

3.6 secrets

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

3.7 image

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

3.8 labels

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

3.9 network_mode

  设置网络模式。使用和docker run的–network参数一样的值。

3.10 networks

  配置容器连接的网络。

3.11 volumes

  数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER)或者数据卷名称(VOLUME:CONTAINER)，并且可以设置访问模式（HOST:CONTAINER:ro）。该指令中路径支持相对路径。

  如果路径为数据卷名称，必须在文件中配置数据卷。

4 Compose命令

4.1 命令对象与格式

  对于Compose来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或者容器。如果没有特别的说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令影响。
  执行docker-compose [COMMAND] --help或者docker-compose help [COMMAND]可以查看具体某个命令的使用格式。
  docker-compose命令的基本的使用格式是：
  docker-compose [-f=…] [options] [COMMAND] [ARGS…]

4.2 命令选项

  -f, --file FILE指定使用的Compose模板文件，默认为docker-compose.yml，可以多次指定。
  -p, --project-name NAME指定项目名称，默认将使用所在目录名称作为项目名。
  --verbose输出更多调试信息。
  -v, --version打印版本并退出。

4.3 COMMAND

4.3.1 bulid

  格式为docker-compose build [options] [SERVICE…]
  构建（重新构建）项目中的服务容器。服务容器一旦构建后，将会带上一个标记名，例如对于web项目中的一个db容器，可能是web_db。可以随时在项目目录下运行docker-compose build来重新构建服务。
  选项包括：
  --force-rm删除构建过程中的临时容器。
  --no-cache构建镜像过程中不使用cache（这将加长构建过程）。
  --pull始终尝试通过pull来获取更新版本的镜像。

4.3.2 config

  验证Compose文件格式是否正确，若正确则显示配置，若格式错误显示错误原因。

4.3.3 down

  此命令将会停止up命令所启动的容器，并移除网络。

4.3.4 exec

  进入指定的容器。

4.3.5 help

  获得一个命令的帮助。

4.3.6 images

  列出Compose文件中包含的镜像。

4.3.7 kill

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

4.3.8 logs

  格式为docker-compose logs [options] [SERVICE…]，查看服务容器的输出。默认情况下，docker-compose将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color来关闭颜色，该命令在调试问题的时候十分有用。

4.3.9 pause

  格式为docker-compose pause [SERVICE…]，暂停一个服务容器。

4.3.10 port

  格式为docker-compose port [options] SERVICE PRIVATE_PORT，打印某个容器端口所映射的公共端口。
  选项：
  --protocol=proto指定端口协议，tcp（默认值）或者udp。
  --index=index如果同一服务存在多个容器，指定命令对象容器的序号（默认为 1）。

4.3.11 ps

  格式为docker-compose ps [options] [SERVICE…]，列出项目中目前的所有容器。
  选项：
  -q只打印容器的ID信息。

4.3.12 pull

  格式为docker-compose pull [options] [SERVICE…]，拉取服务依赖的镜像。
  选项：
  --ignore-pull-failures忽略拉取镜像过程中的错误。

4.3.13 push

  推送服务依赖的镜像到Docker镜像仓库。

4.3.14 restart

  格式为docker-compose restart [options] [SERVICE…]，重启项目中的服务。
  选项：
  -t, --timeout TIMEOUT指定重启前停止容器的超时（默认为10秒）。

4.3.15 rm

  格式为docker-compose rm [options] [SERVICE…]，删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器。
  选项：
  -f, --force强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。
  -v删除容器所挂载的数据卷。

4.3.16 start

  格式为docker-compose start [SERVICE…]，启动已经存在的服务容器。

4.3.17 stop

  格式为docker-compose stop [options] [SERVICE…]，停止已经处于运行状态的容器，但不删除它。通过docker-compose start可以再次启动这些容器。
  选项：
  -t, --timeout TIMEOUT 停止容器时候的超时（默认为10秒）。

4.3.18 top

  查看各个服务容器内运行的进程。

4.3.19 unpause

  格式为docker-compose unpause [SERVICE…]，恢复处于暂停状态中的服务。

4.3.20 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来重新创建服务并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。
  选项：
  -d在后台运行服务容器。
  --no-color不使用颜色来区分不同的服务的控制台输出。
  --no-deps不启动服务所链接的容器。
  --force-recreate强制重新创建容器，不能与–no-recreate同时使用。
  --no-recreate如果容器已经存在了，则不重新创建，不能与–force-recreate同时使用。
  --no-build不自动构建缺失的服务镜像。
  -t, --timeout TIMEOUT停止容器时候的超时（默认为10秒）。

4.3.21 version

  格式为docker-compose version，打印版本信息。