docker-compose.yml文件常用参数详解

本文详细介绍了docker-compose.yml文件的使用,包括version、services和networks等关键部分。重点讲解了services中的image、build、command、container_name等参数,以及ports、expose、volumes、links和external_links等配置,帮助理解如何管理和启动多容器应用。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

docker-compose.yml文件详解

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

version

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

services

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

services:
  web1:					#服务名
  	image: nginx

build:可以指定Dockerfile所在文件夹的路径。Compose将会利用Dockerfile自动构建镜像,然后使用镜像启动服务容器。

#写法一
build: path/Dockerfile	

#写法二
build:
  context: path
  dockerfile: Dockerfile

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

context选项可以是Dockerfile的文件路径,也可以是到链接到git仓库的url,当提供的值是相对路径时,被解析为相对于撰写文件的路径,此目录也是发送到Docker守护进程的context

commond:使用command可以覆盖容器启动后默认执行的命令。

container_name:Compose的默认容器名称格式是:<项目名称><服务名称><序号>,例如webapp_web3_1

指定容器名称

container_name: web3

depends_on: 容器的启动会因容器依赖问题而启动失败,所以项目容器启动的顺序是有要求的。这个标签可以解决==容器的依赖、启动先后的问题。

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

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

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

pid: "host"

ports:用于映射端口的标签。使用HOST:CONTAINER格式或者只是指定容器的端口,宿主机会随机映射端口。当使用HOST:CONTAINER格式来映射端口时,如果使用的容器端口小于60可能会得到错误得结果,因为YAML将会解析xx:yy这种数字格式为60进制。所以建议采用字符串格式。

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

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

expose:
  - "3000"

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

extra_hosts:
  - "hostname1:IP"
  - "hostname2:IP"

启动后进入容器查看==/etc/hosts/==文件

IP	hostname1
IP	hostname2

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

volumes_from:从其它容器或者服务挂载数据卷,可选的参数是 :ro:rw,前者表示容器只读,后者表示容器对数据卷是可读可写的(默认情况为可读可写的)。

volumes_from:
  - service_name
  - service_name:ro
  - container:container_name
  - container:container_name:rw

links:链接到其它服务中的容器。使用服务名称(同时作为别名)或服务名称:服务别名 (SERVICE:ALIAS) 格式都可以

links:
    - db
    - db:database
    - redis

使用的别名将会自动在服务容器中的 /etc/hosts 里创建。相应的环境变量也将被创建。例如:

容器IP db

external_links:链接到 docker-compose.yml 外部的容器,甚至 并非 Compose 管理的容器。参数格式跟 links 类似。在使用Docker过程中,会有许多单独使用 docker run 启动的容器的情况,为了使 Compose 能够连接这些不在docker-compose.yml 配置文件中定义的容器,那么就需要一个特殊的标签,就是 external_links,它可以让Compose 项目里面的容器连接到那些项目配置外部的容器(前提是外部容器中必须至少有一个容器是连接到与项目内的服务的同一个网络里面)

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

net:设置网络模式。

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

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

dns:8.8.8.8
dns:
    - 8.8.8.8   
    - 9.9.9.9
### 启动 `docker-compose.yml` 文件及其配置解析 #### 使用命令启动 Docker Compose 应用程序 要启动由 `docker-compose.yml` 配置定义的服务集合,需在该文件所在的目录下运行如下命令: ```bash docker-compose up ``` 此命令将会读取当前目录下的默认名为 `docker-compose.yml` 的文件并根据其中的定义来启动服务。如果希望指定其他名称或者位置不同的 YAML 文件,则可以通过 `-f` 参数提供具体路径。 对于后台运行的应用程序实例,可附加参数 `-d` 来让容器以后台模式执行: ```bash docker-compose up -d ``` #### 关键配置项解释 - **版本声明** 在编写 `docker-compose.yml` 文件时,必须指明所使用的 Docker Compose 文件格式版本。常见的做法是指定为 `"3"` 或者更具体的子版本号如 `"3.8"` [^2]: ```yaml version: '3' ``` - **构建自定义镜像** 当项目依赖于特定环境设置而这些无法通过公共仓库获取现成镜像满足需求时,可以在本地利用 Dockerfile 构建自己的镜像。为此,在服务条目中加入 `build` 字段,并指出构建上下文及可能不同于默认名 (`Dockerfile`) 的构建脚本文件名 [^1] : ```yaml services: webapp: build: context: . dockerfile: Dockerfile-alternate ``` - **持久化数据管理——命名卷** 命名卷允许开发者创建一种特殊类型的挂载点,它不仅能够实现跨不同容器间的数据共享而且保障了即便原生容器销毁之后重要资料依旧得以保存下来 [^3]. 这种方式非常适合用来处理数据库或其他需要长期保持状态的应用场景. 下面是一个简单的例子展示了怎样把 MySQL 数据库的日志和实际表空间分别映射到两个独立的命名卷之上: ```yaml volumes: db_data: {} db_logs: {} services: database: image: mysql:latest environment: MYSQL_ROOT_PASSWORD: example volumes: - db_data:/var/lib/mysql - db_logs:/var/log/mysql ``` 上述内容涵盖了启动基于 `docker-compose.yml` 描述之应用程序所需的基础知识以及一些重要的配置选项介绍。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值