（二）docker-compose使用——2 version3版本的yaml文件全部配置项

最新推荐文章于 2024-08-11 00:22:08 发布
最新推荐文章于 2024-08-11 00:22:08 发布
阅读量2.2k 收藏 11
点赞数
分类专栏： docker实战 文章标签： docker-compose
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yilvqingtai/article/details/118797874
版权

参考上一篇博客 版本对应。https://blog.csdn.net/yilvqingtai/article/details/118796925

配置文件配置项总览：

version: "3.9"
services:
  my_name: //自定义服务名称
    build:
      context: . //（1）可以dockerfile所在路径，也可以是git的url （2）相对路径，相对于当前配至文件目录
      dockerfile: Dockerfile //默认Dockerfile，此处可以自己指定某路径下的dockerfile文件
      args: //自定义参数kv，运行该文件的时候，参数可以被dockeefile文件引用，详见说明
      labels: //给镜像打标签，V3.3以上，官方建议格式:反向dns:业务名（如:com.baidu.text:accountapp）
      network: //V3.4以上，构建容器时，指派当前的网络环境组，如果none 表示禁用网络
      shm_size: 2gb 或者 1000000000 //为此构建的容器设置/dev/shm分区的大小/dev/shm可自行百度
      target: prod //V3.4以上，在内部定义构建指定的阶段dockerfile
    cap_add:
    cap_drop:
    cgroup_parent:
      command: //覆盖默认命令,和dockerfile指令相似.
    configs:
    container_name:  //指定自定义容器的名称;Docker容器名称必须是唯一的,如果指定了自定义名称，则无法将服务扩展到多个容器.
    credential_spec:  //v3.3
    depends_on:  //服务依赖关系
    deploy: //指定与部署和运行服务相关的配置
      endpoint_mode: //为连接到群集的外部客户端指定服务发现方法
      labels:  //指定服务的标签。这些标签仅在服务上设置，而不在服务的任何容器上设置。
      mode: //全局或复制(副本容器)
      placement:  //指定约束和首选项的位置
      max_replicas_per_node:
      replicas:  //如果复制了服务，请指定在任何给定时间应运行的容器数。
      resources:  //配置资源限制.
      restart_policy: //配置是否以及如何在容器退出时重新启动容器
      rollback_config: //配置在更新失败的情况下应如何回滚服务
      update_config:  //配置服务应如何更新。用于配置滚动更新.
    devices:
    dns: //自定义dns服务
    dns_search: //自定义DNS搜索域
    entrypoint: //覆盖默认entrypoint
    env_file: //从文件添加环境变量
    environment: //添加环境变量。您可以使用数组或字典。任何布尔值; true，false，yes no，需要用引号括起来
    expose:
    external_links:
    extra_hosts:
    healthcheck:
    image:
    init:
    isolation:
    labels:
    links:
    logging:
    network_mode:
    networks:
    pid:
    ports:
    profiles:
    restart:
    secrets:
    security_opt:
    stop_grace_period:
    stop_signal:
    sysctls:
    tmpfs:
    ulimits:
    userns_mode:
    volumes:
    driver:
    driver_opts:
    external:
    name:

build

  • 在构建时应用的配置选项. 可以指定为包含构建上下文路径的字符串.
version: "3.7"    #版本
services:         #服务
  nginx:          #服务名称
    build: ./dir  #指定构建目录
    image: nginx:tag  #指定基础镜像

context

  • 包含Dockerfile的目录的路径，或者是git存储库的url。
  • 当提供的值是相对路径时，它被解释为相对于Compose文件的位置。此目录也是发送到Docker守护程序的构建上下文。
build:
  context: ./dir

dockerfile

  • Compose使用备用文件来构建。还必须指定构建路径。
build:
  context: .
  dockerfile: Dockerfile-alternate

ARGS

  • 添加构建参数.在dockerfile中定义:
ARG buildno
ARG gitcommithash
  • 指定参数在build指令下构建
build:
  context: .
  args:
    buildno: 1
注意: 在Dockerfile中，如果在FROM指令之前指定ARG，则在FROM下的构建指令中不能使用ARG。
YAML布尔值（true，false，yes，no，on，off）必须用引号括起来，以便解析器将它们解释为字符串。

CACHE_FROM

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

LABELS

  • 使用Docker标签将元数据添加到生成的镜像中. 可以使用数组或字典。
build:
  context: .
  labels:
    com.example.description: "Accounting webapp"

SHM_SIZE

  • 为此构建的容器设置/dev/shm分区的大小
build:
  context: .
  shm_size: '2gb'

TARGET

build:
  context: .
  target: prod

cap_add和cap_drop

  • 添加或删除容器功能
cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

cgroup_parent

  • 为容器指定可选的父cgroup
cgroup_parent: m-executor-abcd

command

  • 覆盖默认命令,和dockerfile指令相似.
command: ["bundle", "exec", "thin", "-p", "3000"]

configs

  • 短语法变体仅指定配置名称。这将授予容器对配置的访问权限，并将其安装在容器中的/ <config_name>中。源名称和目标安装点都设置为配置名称. 支持3.3版本以上.
  • 以下示例使用短语法授予对my_config和my_other_config配置的redis服务访问权限。 my_config的值设置为./my_config.txt文件的内容，my_other_config被定义为外部资源，这意味着它已经在Docker中定义，通过运行docker config create命令或另一个堆栈部署。如果外部配置不存在，则堆栈部署将失败并显示config not found错误
version: "3.7"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs:
      - my_config
      - my_other_config
configs:
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true

LONG SYNTAX

  • source: Docker中存在的配置名称
  • target: 要在服务的任务容器中装入的文件的路径和名称。默认为:/<source>
  • uid和gid: 在服务的任务容器中拥有已装入的配置文件的数字UID或GID.默认为0.
  • mode: 以八进制表示法在服务的任务容器中装入的文件的权限。默认值为0444.配置无法写入，因为它们安装在临时文件系统中，因此如果设置了可写位，则会将其忽略。可以设置可执行位。
  • 以下示例将my_config的名称设置为容器中的redis_config，将模式设置为0440（组可读）并将用户和组设置为103. redis服务无权访问my_other_config配置。
version: "3.7"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs:
      - source: my_config
        target: /redis_config
        uid: '103'
        gid: '103'
        mode: 0440
configs:
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true
  • 可以授予对多个配置的服务访问权限.

container_name

  • 指定自定义容器的名称.
container_name: nginx-test
  • Docker容器名称必须是唯一的,如果指定了自定义名称，则无法将服务扩展到多个容器.

EXAMPLE GMSA CONFIGURATION

  • 为服务配置gMSA凭据规范时，只需指定凭据规范.
version: "3.8"
services:
  myservice:
    image: myimage:latest
    credential_spec:
      config: my_credential_spec

configs:
  my_credentials_spec:
    file: ./my-credential-spec.json|

depends_on

  1. 服务依赖关系之间的Express依赖关系会导致以下行为：
  2. docker-compose up: 以依赖顺序启动服务.
  3. docker-compose up SERVICE: 自动包含SERVICE的依赖项.
  4. docker-compose stop: 按依赖顺序停止服务.
version: "3.7"
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

deploy

  • 指定与部署和运行服务相关的配置.
version: "3.7"
services:
  redis:
    image: redis:alpine
    deploy:
      replicas: 6
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

ENDPOINT_MODE

  • 为连接到群集的外部客户端指定服务发现方法。
  • endpoint_mode: vip: Docker为服务分配虚拟IP(VIP),作为客户端到达网络服务的前端。 Docker在客户端和服务的可用工作节点之间路由请求，而无需客户端知道有多少节点参与服务或其IP地址或端口。
  • endpoint_mode: dnsrr: DNS循环（DNSRR）服务发现不使用单个虚拟IP。 Docker为服务设置DNS条目，以便服务名称的DNS查询返回IP地址列表，客户端直接连接到其中一个。
version: "3.7"

services:
  wordpress:
    image: wordpress
    ports:
      - "8080:80"
    networks:
      - overlay
    deploy:
      mode: replicated
      replicas: 2
      endpoint_mode: vip

  mysql:
    image: mysql
    volumes:
       - db-data:/var/lib/mysql/data
    networks:
       - overlay
    deploy:
      mode: replicated
      replicas: 2
      endpoint_mode: dnsrr

volumes:
  db-data:

networks:
  overlay:

LABELS

  • 指定服务的标签。这些标签仅在服务上设置，而不在服务的任何容器上设置。
version: "3.7"
services:
  web:
    image: web
    deploy:
      labels:
        com.example.description: "This label will appear on the web service"
  • 要在容器上设置标签,可以把labels键放在和image键同级.

MODE

  • 全局或复制(副本容器)
version: "3.7"
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    deploy:
      mode: global

PLACEMENT

  • 指定约束和首选项的位置
version: "3.7"
services:
  db:
    image: postgres
    deploy:
      placement:
        constraints:
          - node.role == manager
          - engine.labels.operatingsystem == ubuntu 14.04
        preferences:
          - spread: node.labels.zone

REPLICAS

  • 如果复制了服务，请指定在任何给定时间应运行的容器数。
version: "3.7"
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 6

RESOURCES

  • 配置资源限制.
  • 在这个示例中，redis服务被限制为使用不超过50M的内存和0.50（单核的50％）的可用处理时间（CPU），并且具有20M的内存和0.25个CPU时间保留(始终可用).
version: "3.7"
services:
  redis:
    image: redis:alpine
    deploy:
      resources:
        limits:
          cpus: '0.50'
          memory: 50M
        reservations:
          cpus: '0.25'
          memory: 20M

Out Of Memory Exceptions (OOME)

  • 如果您的服务或容器尝试使用的内存超过系统可用的内存，则可能会遇到内存不足异常（OOME），并且内核OOM杀手可能会杀死容器或Docker守护程序。要防止这种情况发生，请确保您的应用程序在具有足够内存的主机上运行.

RESTART_POLICY

  • 配置是否以及如何在容器退出时重新启动容器.
  • condition: none,on-failure,any
  • delay: 重启尝试之间等待多长时间,默认0.
  • max_attempts: 在放弃之前尝试重启容器的次数.例如，如果max_attempts设置为“2”，并且第一次尝试时重新启动失败，则可能会尝试重新启动两次以上。
  • window: 在决定重启是否成功之前等待多长时间.
version: "3.7"
services:
  redis:
    image: redis:alpine
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s

ROLLBACK_CONFIG

  • 配置在更新失败的情况下应如何回滚服务.
  • `parallelism: 一次回滚的容器数. 0为同时回滚.
  • delay: 每个容器组的回滚之间等待的时间.
  • failure_action: 如果回滚失败该怎么办。选择continue或者pause
  • monitor: 每次更新任务后的持续时间.ns|us|ms|s|m|h
  • max_failure_ratio: 回滚期间容忍的失败率.
  • order: 回滚期间的操作顺序。停止优先（旧任务在启动新任务之前停止）或启动优先（新任务首先启动，运行任务暂时重叠）（默认停止优先）

UPDATE_CONFIG

  • 配置服务应如何更新。用于配置滚动更新.
  • parallelism:一次更新的容器数
  • delay: 更新一组容器之间的等待时间.
  • failure_action: 如果更新失败该怎么办。选择continue,rollback,pause.默认pause.
  • monitor: 每次更新任务后的持续时间.(ns|us|ms|s|m|h)
  • max_failure_ratio: 更新期间容忍的失败率。
  • order : 更新期间的操作顺序。 stop-first之一（旧任务在启动新任务之前停止）或start-first（首先启动新任务，并且运行任务暂时重叠）（默认stop-first）
version: "3.7"
services:
  vote:
    image: dockersamples/examplevotingapp_vote:before
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
        order: stop-first

dns

  • 自定义dns服务
dns:
  - 8.8.8.8
  - 9.9.9.9

dns_search

  • 自定义DNS搜索域
dns_search:
  - dc1.example.com
  - dc2.example.com

entrypoint

  • 覆盖默认entrypoint
entrypoint: /code/entrypoint.sh

env_file

  • 从文件添加环境变量
env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env
  • Compose期望env文件中的每一行都是VAR = VAL格式。以＃开头的行被视为注释并被忽略。空行也被忽略。

environment

  • 添加环境变量。您可以使用数组或字典。任何布尔值; true，false，yes no，需要用引号括起来
environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:

expose

  • 暴露端口而不将它们发布到主机 - 它们只能被链接服务访问。只能指定内部端口
expose:
 - "3000"
 - "8000"

external_links

  • 链接到此docker-compose.yml之外或甚至在Compose之外的容器。指定容器名称和链接别名.
external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql

extra_hosts

  • 添加主机名映射
extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"
  • 在该服务的容器内的/ etc / hosts中创建具有ip地址和主机名的条目.
162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

  • 配置运行的检查以确定此服务的容器是否“健康”.
healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3
  start_period: 40s
test: ["CMD", "curl", "-f", "http://localhost"]
test: ["CMD-SHELL", "curl -f http://localhost || exit 1"]
test: curl -f https://localhost || exit 1

禁用运行状况检查

healthcheck:
  disable: true

init

  • 在容器内运行init，转发信号并重新获得进程.
version: "3.7"
services:
  web:
    image: alpine:latest
    init: true

links

  • 链接到另一个服务中的容器。指定服务名称和链接别名.
web:
  links:
   - db
   - db:database
   - redis
  • 链接服务的容器可以在与别名相同的主机名上访问，如果未指定别名，则可以访问服务名称。
  • 链接还以与depends_on相同的方式表达服务之间的依赖关系.

青苔猿猿
关注
专栏目录
微服务自动化docker-compose
m0_60375943的博客
03-03 2906
docker-compose Docker-Compose项目是Docker官方的开源项目,负责实现对Docker容器集群的快速编排 通过编写docker-compose文件可对多个服务同时进行启动/停止/更新(可定义依赖,按顺序启动服务) docker-compose将所管理的容器分为3层结构： project 1 一个微服务项目 service N 由N个微服务组成 container N 而每个微服务又由N个节点组成 docker-comp
Docker Compose 文件 v2 和 v3 版本的区别
乔木的博客
04-28 1122
在 v2 版本中，服务定义使用services关键字，而在 v3 版本中，该关键字保持不变。以下是两个版本的服务定义示例：services:web:ports:- "80:80"db:services:web:ports:- "80:80"db:在 v2 版本中，网络定义使用networks关键字，而在 v3 版本中，该关键字保持不变。以下是两个版本的网络定义示例：networks:app_net:services:web:...networks:- app_net。
解决执行docker-compose --version报错问题(亲测有效)
最新发布
younger152的博客
08-11 202
<title>503 Service Temporarily Unavailable</title>
docker-compose v3版本命令详解参考
weixin_30355437的博客
10-25 1028
参考和指南 这些主题描述了Compose文件格式的第3版。这是最新的版本. Compose and Docker 兼容性矩阵 有几个版本的Compose文件格式 - 1，2，2.x和3.x.下表是快速浏览。有关每个版本包含和如何升级的详细信息，请参阅关于版本和升级. Compose 文件结构和示例 version: "3" services: redis: image: redis:...
【docker】docker-compose.yml 文件详解
weixin_43346403的博客
07-04 3238
1.docker-compose.yml 文件详解。3.volumes 的新版本语法格式示例。4.关于布署参数说明。
使用docker-compose搭建高可用Apollo配置中心
09-24
1. 确保Docker Compose文件中的版本号和依赖项与Apollo和其依赖的各个组件的最新版本兼容。 2. 考虑到负载均衡，可能需要配置额外的网络策略，比如使用Nginx反向代理来分散请求到Configservice和Adminservice集群的...
Docker-Compose 与 YAML 配置文件格式
段小宝的博客
07-30 5496
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 目录前言一、Docker-Compose 实现Docker容器快速编排1.1 Docker-Compose 简介二、部署2.2 YAML文件格式及编写注意事项 前言 我们知道使用一个 Dockerfile 模板文件可以定义一个单独的应用容器（镜像），如果需要定义多个容器就需要服务编排，今天给大家介绍Docker 的官方产品 Docker Compose 对多个容器进行服务编排。 **Dockerfile 可以让用户管理一个单独的应用容器；
docker-compose,nacos的yaml,日志文件
01-17
通过编写`docker-compose.yml`文件，我们可以声明性地配置服务、网络和卷。在这个配置文件中，你可以定义服务的镜像、端口映射、环境变量、依赖关系等。例如： ```yaml version: '3' services: nacos: image: ...
docker&docker-compose 19.03.14二进制安装
10-14
通过YAML文件（通常命名为`docker-compose.yml`）来配置服务、网络和卷，然后使用`docker-compose`命令来启动、停止和管理这些服务。这样可以简化多容器应用的部署和管理，尤其适用于微服务架构。 **Docker&Docker ...
【云原生】Docker Compose 使用详解
congge
06-02 8252
Docker Compose 使用详解
Docker Compose file 版本3参考
幽灵 逐梦--专栏
09-20 1708
参考和指南 这些主题描述了Compose文件格式的版本3。这是最新版本。 Compose和Docker兼容性矩阵 有多种版本的Compose文件格式 – 1, 2, 2.x, and 3.x. 下表是快速浏览。有关每个版本包括什么以及如何升级的完整详细信息，请参阅About versions and upgrading. 下表显示了哪些Compose文件版本支持特定的Docker版本。 ...
【Docker实战】为docker-compose.yaml文件提供环境变量
weixin_42206314的博客
04-17 1339
比如工作中，我就遇到一种情况，需要在jenkins的pipeline中，提供版本号给docker-compose文件，使得每次docker compose up启动的容器使用不同的tag。在下面的docker-compose.yaml文件（wordpress+mysql）中使用这个TAG（格式为“${TAG}”）我们使用docker-compose来部署docker容器时，有时需要提供环境变量进行动态部署。我们使用config命令查看导入变量的情况，该命令会将解析后的应用程序配置打印到终端。
YAML Ain’t Markup Language (YAML™) Version 1.2
BLOG域名:programb.blog.csdn.net
04-26 228
YAML Ain’t Markup Language (YAML™) Version 1.2 3rd Edition, Patched at 2009-10-01 Oren Ben-Kiki oren@ben-kiki.org Clark Evans cce@clarkevans.com Ingy döt Net ingy@ingy.net Latest (patched) version: HT...
docker-compose实战----微服务架构一键部署yaml模板
浪荡的三木君
04-30 431
app：一个后端web服务 celery：异步服务队列 redis：消息中间件 db：数据持久化存储 nginx：web服务器，将请求代理到app version: "3" services: app: restart: always build: . # 代表当前目录 # 容器启动时需要运行的命令 command: bas...
docker-compose详解
红的羊
03-26 435
安装 yum -y install epel-release yum -y install python-pip pip --version pip install docker-compose yml文件 image image 是指定服务的镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。 例如下面这些格式都是可以的： image: redis image: ...
【Yaml】了解yaml文件格式
KEEP MOVING.
06-30 1770
一、简介 YAML 是一种较为人性化的数据序列化语言，可以配合目前大多数编程语言使用。 YAML 的语法比较简洁直观，特点是使用空格来表达层次结构，其最大优势在于数据结构方面的表达，所以 YAML 更多应用于编写配置文件，其文件一般以 .yml 为后缀。 二、基本语法 1. 大小写敏感。 大小视作不同变量 version: 1.12 Version: 1.12 2. 使用#表示注释。只支持单行注释 # 这是注释内容 # 这是另一行注释内容 version: 1.12 3. 缩进表示层级关系。 使用空格
Docker Compose的yaml文件配置
m0_64284147的博客
09-25 3337
Docker Compose的yaml文件配置
docker-compose.yaml示例
程序员的世界
01-03 4922
docker提供了一个工具docker-compose命令行，用于批量部署容器，docker-compose需要一个yaml文件(实质为文本文件)，默认名字为docker-compose.yaml(docker-compose.yml)。如果熟悉k8s的同学可能对yaml并不是陌生，这里只是做一个笔记方便日后查询。 version: '2' services: #服务定义 开始标签 con...
docker-compose docker-compose.yml build作用
12-22
docker-compose build命令用于构建docker-compose.yml文件中定义的服务。会根据配置文件中的指令，从Dockerfile构建镜像，并将其用于服务的容器。构建过程包括下载所需的基础镜像、执行Dockerfile中的指令以及安装所...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

青苔猿猿

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值