docker compose书写规则 浅谈docker compose书写规则

version # docker compose版本
networks # 网络，用于docker容器内部通讯
x-{name} # 模版命名规则 以x-开头 用于复用
volumes # 挂载卷
services # 服务模块，内部定义容器信息 其内部参数相当于docker run时的参数

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

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

version: "3"
networks:
 default-network:

version: "3.8"

services:
 web:
  image: "nginx:alpine"
  networks:
   - new

 worker:
  image: "my-worker-image:latest"
  networks:
   - legacy

 db:
  image: mysql
  networks:
   new:
    aliases:
     - database
   legacy:
    aliases:
     - mysql

networks:
 new:
 legacy:

version: "3.8"

services:
 app:
  image: nginx:alpine
  networks:
   app_net:
    ipv4_address: 172.16.238.10
    ipv6_address: 2001:3984:3989::10

networks:
 app_net:
  ipam:
   driver: default
   config:
    - subnet: "172.16.238.0/24"
    - subnet: "2001:3984:3989::/64"

version: "3.8" # docker compose版本
services:
 webapp: # docker-compose定义的服务（容器）名，主要是针对docker-compose命令的参数，与docker ps看到的容器名不一定一致
  build: # 使用Dockerfile构建镜像
   context: ./dir 上下文路径，相对路径则是相对于compose文件路径
   dockerfile: Dockerfile-alternate # 指定Dockerfile文件名
   args: # 指定Dockerfile的参数 环境变量
    buildno: 1 # directory写法和list写法均可

build:
 context: ./dir

build:
 context: .
 dockerfile: Dockerfile-alternate

ARG buildno
ARG gitcommithash

RUN echo "Build number: $buildno" # bash-like风格的写法
RUN echo "Based on commit: $gitcommithash"

build:
 context: .
 args: # map
  buildno: 1
  gitcommithash: cdc3b19

build:
 context: .
 args: # list
  - buildno=1
  - gitcommithash=cdc3b19

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

build:
 context: .
 labels: # map
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""

build:
 context: .
 labels: # list
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"

build:
 context: .
 network: host # host模式，网络延迟最低，性能与宿主机一致

build:
 context: .
 network: custom_network_1 # 自创network 

build:
 context: .
 network: none # 无网络

build:
 context: .
 shm_size: '2gb' # 使用字符串设置大小

build:
 context: .
 shm_size: 10000000 # 设置字节大小

command: bundle exec thin -p 3000 # shell-like

command: ["bundle", "exec", "thin", "-p", "3000"] # json-like

container_name: my-web-container

version: "3.8"
services:
 web:
  build: .
  depends_on: # 先启动 db 和 redis
   - db
   - redis
 redis:
  image: redis
 db:
  image: postgres

devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"

dns: 8.8.8.8 # 单个string值

dns: # list 
 - 8.8.8.8
 - 9.9.9.9

dns_search: example.com # 单个string值

dns_search:
 - dc1.example.com
 - dc2.example.com

entrypoint: /code/entrypoint.sh

entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]

env_file: .env # single value

env_file: # list
 - ./common.env
 - ./apps/web.env
 - /opt/runtime_opts.env

# Set Rails/Rack environment # '#'为注释，
# 空行会被忽略
RACK_ENV=development # 格式为 VAR=VAL

environment: # map
 RACK_ENV: development
 SHOW: 'true'
 SESSION_SECRET:

environment: # list
 - RACK_ENV=development
 - SHOW=true
 - SESSION_SECRET

func getEnvInfo() string {
  rackEnv := os.Getenv("RACK_ENV")
  fmt.Println(rackEnv)
}

output:
development

expose:
 - "3000"
 - "8000"

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

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

162.242.195.82 somehost
50.31.209.229  otherhost

healthcheck:
 test: ["CMD", "curl", "-f", "http://localhost"]
 interval: 1m30s
 timeout: 10s
 retries: 3
 start_period: 40s

healthcheck:
 disable: true

image: redis # 默认标签 latest
image: ubuntu:18.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd

version: "3.8"
services:
 web:
  image: alpine:latest
  init: true

build:
 context: .
 labels: # map
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""

build:
 context: .
 labels: # list
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"

logging:
 driver: syslog
 options:
  syslog-address: "tcp://192.168.0.42:123"

driver: "json-file"
driver: "syslog"
driver: "none"

driver: "syslog"
options:
 syslog-address: "tcp://192.168.0.42:123"

options:
 max-size: "200k" # 单文件最大存储
 max-file: "10" # 文件最大数量

ports:
 - "3000"
 - "3000-3005"
 - "8000:8000"
 - "9090-9091:8080-8081"
 - "49100:22"
 - "127.0.0.1:8001:8001"
 - "127.0.0.1:5000-5010:5000-5010"
 - "6060:6060/udp"
 - "12400-12500:1240"

ports:
 - target: 80
  published: 8080
  protocol: tcp
  mode: host

restart: "no" # 失败不重启
restart: always # 失败后总是重启
restart: on-failure # 错误码为 on-failure 时才重启
restart: unless-stopped # 手动停止后不重启

volumes:
 # 指定容器内路径，docker 自动创建路径
 - /var/lib/mysql

 # 挂载绝对路径
 - /opt/data:/var/lib/mysql

 # 挂载相对路径
 - ./cache:/tmp/cache

 # 用户目录相对路径
 - ~/configs:/etc/configs/:ro

 # 命名挂载
 - datavolume:/var/lib/mysql

version: "3.8"
services:
 web:
  image: nginx:alpine
  ports:
   - "80:80"
  volumes:
   - type: volume
    source: mydata
    target: /data
    volume:
     nocopy: true
   - type: bind
    source: ./static
    target: /opt/app/static

networks:
 webnet:

volumes:
 mydata: