【Docker】docker-compose基本使用

【Docker】docker-compose基本使用

1. docker 项目部署弊端

一般的docker部署项目有如下弊端：

1. 一个完整的项目通常需要用到多个容器，N个容器之间会形成依赖，比如项目启动时如果没有启动mysql容器，那么项目容器就启动不起来。没有启动es容器，kibana容器也启动不起来。所以，容器启动之间的编排显得至关重要，项目庞大时我们很难记住容器启动顺序
   • 对于容器的编排尚且有一个很简单的方法就是写一个shell脚本来一次性解决启动顺序的问题。
2. 一般情况下，docker中容器很多，可能有很多个其他项目的容器在里面。我们没有办法站在项目的角度将一个项目用到的容器划分在一起，日后在另一台服务器启动该项目就变得很困难了。

而 docker-compose 就能够解决以上问题。

---

2. docker-compose 简介

Docker Compose是一个用于定义和运行多个Docker容器的工具，负责实现对 docker 容器集群的快速编排，它使用 YAML 文件来配置应用程序的服务、网络和卷等方面。

Compose 中有两个重要的概念：

• 服务(service)：一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。
• 项目(project)：由一组关联的应用容器组成的一个完整业务单元，在 docker-compose.yml 文件中定义。

---

3. 实践

创建一个项目：

mkdir ems

在ems目录创建一个 docker-compose.yml 模板文件，如下所示：

#代表使用 docker-compose 项目的版本号
version: "3.0"

services:
	
	tomcat:
	 container_name: tomcat01	#代表给容器指定一个名称，类似于 docker run --name 参数。不写就会默认给一个名字，推荐使用默认名字。
	 image: tomcat:8.0	#代表使用哪个镜像，类似于 docker run 指定的镜像名称
	 ports:
	  - 8080:8080
	  
	tomcat1:
	 image: tomcat:8.0
	 ports:
	  - 8081:8080
	  
	redis:
	 image: redis:5.0.12
	 ports:
	  - "6379:6379"
	  
	mysql:
	 image: mysql:5.6
	 ports:
	 - "3306:3306"
	 environment: #代表给当前容器启动指定环境 类似于 docker run -e MYSQL_ROOT_PASSWORD=root
	  #MYSQL_ROOT_PASSWORD: root
	  - "MYSQL_ROOT_PASSWORD=root"
	 volumes:	#代表给当前容器和宿主机指定数据卷 类似于 docker run -v 注意：docker-compose使用绝对路径必须先创建才能使用
	  #- /root/mysqldata1:/var/lib/mysql
	  - mysqlData:/var/lib/mysql
	  
volumes:
 mysqlData: #声明数据卷别名，只需要声明就行，不用赋值，因为docker-compose不会自动创建数据卷，所以要先声明。

启动docker-compose一组服务：

#这个命令必须在 docker-compose.yml 配置文件目录下执行
docker-compose up

停止并销毁 Docker Compose 文件定义的容器、网络和卷：

docker-compose down

具体来说，docker-compose down 命令会执行以下步骤：

1. 停止正在运行的容器：它会找到并停止使用 docker-compose up 启动的容器。
2. 移除容器：停止后，这些容器将被，它们的状态信息也将被清除。
3. 移除网络：与容器关联的网络将被删除。这适用于由 docker-compose 创建的网络。
4. 移除卷：由 docker-compose 创建的卷将被销毁。这将删除在容器中创建的任何持久数据总之，docker-compose down 命令是一种方便的方式，用于停止和清理你在启动容器时所创建的所有资源，以便你可以完全重置环境或重新部署应用程序。请注意，执行此命令将不会删除 Docker 镜只会停止并移除与 docker-compose up 命令相关的容器、网络和卷。

---

4. 模板命令

参考文档：参考文档

4.1 build 指令

我们在 docker-compose.yml 文件中编写的服务在本地都需要有镜像，那如果是我们需要部署自己的springboot项目的话，我们是不是还得先编写Dockerfile来将项目打成镜像？这样就很麻烦了，所以可以使用build指令来解决这一问题。

version: '3'
services:

  webapp:
    build:
      context: ./dir # 指定Dockerfile上下文目录
      dockerfile: Dockerfile-alternate #指定Dockerfile文件的名字，一般Dockerfile不会改名
      args:	#使用 arg 指令指定构建镜像时的变量。
        buildno: 1

---

4.2 command 指令

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

command: echo "hello world"

---

4.3 container_name 指令

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

container_name: docker-web-container

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

---

4.4 depends_on 指令

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

version: '3'

services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis

  db:
    image: postgres

注意：web 服务不会等待 redis db 「完全启动」之后才启动。

---

4.5 env_file 指令

相当于 docker run -e。从文件中获取环境变量，可以为单独的文件路径或列表。

如果通过 docker compose -f FILE 方式来指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。

如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准。

env_file: .env

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

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

# common.env: Set development environment
PROG_ENV=development

注意：推荐文件都命名为 .env ，因为在linux中默认不会显示 .env文件，提高了一丝丝的安全性。

---

4.6 environment 指令

相当于 docker run -e。设置环境变量。你可以使用数组或字典两种格式。

只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

---

4.7 image 指令

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

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

---

4.8 nteworks 指令

相当于 docker run --network。配置容器连接的网络。

Compose指定网络必须先声明。

version: "3"
services:

  some-service:
    networks:
     - some-network
     - other-network

networks:
  some-network:
  other-network:

---

4.9 ports 指令

相当于 docker run -p。暴露端口信息。

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

ports:
 - "3000"	#宿主机端口随机
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

---

4.10 volumes 指令

相当于docker run -v。数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER)或者数据卷名称(VOLUME:CONTAINER)，并且可以设置访问模式 （HOST:CONTAINER:ro）。

该指令中路径支持相对路径。

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

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

version: "3"

services:
  my_src:
    image: mysql:8.0
    volumes:
      - mysql_data:/var/lib/mysql

volumes:
  mysql_data:

---

4.11 restart 指令

相当于 docker run --restart=always。指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效，在生产环境中推荐配置为 always 或者 unless-stopped。

restart: always

---

5. Compose 常用命令

5.1 命令对象与格式

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

执行 docker compose [COMMAND] --help 可以查看具体某个命令的使用格式。

docker compose 命令的基本的使用格式是

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

---

5.2 命令选项

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

---

5.3 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 秒）。

---

5.4 down 命令

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

docker-compose down				#对整个项目操作
docker-compose down 服务id	  #对某个服务操作	

---

5.5 exec 命令

进入指定的容器。

docker-compose exec 服务id bash

---

5.6 ps 命令

列出项目中目前的所有容器。

格式为 docker compose ps [options] [SERVICE...]。

选项：

• -q 只打印容器的 ID 信息。

---

5.7 restart 命令

重启项目中的服务。

格式为 docker compose restart [options] [SERVICE...]。

选项：

• -t, --timeout TIMEOUT 指定重启前停止容器的超时（默认为 10 秒）。

docker-compose restart 对整个项目操作
docker-compose restart -t 服务id

---

5.8 rm 命令

删除所有（停止状态的）服务容器。推荐先执行 docker compose stop 命令来停止容器。

格式为 docker compose rm [options] [SERVICE...]。

选项：

• -f, --force 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。
• -v 删除容器所挂载的数据卷。

---

5.9 top 命令

查看整个项目中所有服务容器内运行进程或者查看某个指定id服务的容器的进程。

docker-compose top [服务id]

---

5.10 logs 命令

查看服务容器的输出。默认情况下，docker compose 将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color 来关闭颜色。

格式为 docker compose logs [options] [SERVICE...]。