Loading... docker compose使用用于简化docker容器启动而设计的工具。其配置文件用于描述容器的启动配置。 ## 基本格式 每个目录下有且仅有一个`docker-compose.yml`文件用于描述Docker配置。该文件的基本格式如下： ```yml version: '3' # 定义版本，不指定默认为版本 1，新版本功能更多 services: # 容器，就像 docker run db: # 名称，随便起一个就好，别重名 image: mysql:5.7 # 镜像，如果像自定义镜像可以不指定这个参数，而用 build volumes: # 定义数据卷，类似 -v - db_data:/var/lib/mysql - .:/aaa # 挂载当前目录到容器中的 /aaa 无需使用绝对路径 environment: # 定义环境变量，类似 -e MYSQL_ROOT_PASSWORD: somewordpress ``` ## version字段 版本设置 这个字段用于指出当前配置文件是为哪一个docker compose版本编写的。因为不同版本间的配置文件可能不兼容。写出响应版本的version字段，程序就会按照那个版本的规则解析配置文件。 不同版本的区别可以到[docker官网查询](https://docs.docker.com/compose/compose-file/compose-versioning/) **当前最新版本是：**`version: "3.7"` ## services字段 容器列表 这个字段列举的就是需要建立的docker容器了。每一个容器对应着各自的配置参数。 接下来按照使用频次介绍配置字段。 ### image字段 指定要启动的镜像 image 则是指定服务的镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。 **格式：**`image: 镜像URI:版本tag（使用最新版可填写latest）"` 例如下面这些格式都是可以的： ```yml image: redis image: ubuntu:14.04 image: tutum/influxdb image: example-registry.com:4000/postgresql image: a4bc65fd ``` ### build字段 指定Dockerfile，执行构建任务 服务除了可以基于指定的镜像，还可以基于一份 Dockerfile，在使用 up 启动之时执行构建任务，这个构建标签就是 build，它可以指定 Dockerfile 所在文件夹的路径。Compose 将会利用它自动构建这个镜像，然后使用这个镜像启动服务容器。 ```yml build: /path/to/build/dir build: ./dir # 也可以是相对路径 build: # 设定上下文根目录，然后以该目录为准指定 Dockerfile。 context: ../ dockerfile: path/of/Dockerfile build: ./dir # 如果你同时指定了 image 和 build 两个标签，那么 Compose 会构建镜像并且把镜像命名为 image 后面的那个名字。 image: webapp:tag ``` ### command字段 设置启动后执行的指令 原本在Docker镜像构建的时候，会设置默认执行的入口，使用command字段可以覆盖或者追加。 ```yml command: bundle exec thin -p 3000 # 覆盖，使用新的指令作为入口 command: [bundle, exec, thin, -p, 3000] # 也可以写成类似 Dockerfile 中的格式： command: -p 3000 -mysql=123123 #追加设置 ``` ### container_name字段 起个名字吧 `container_name: app`这样容器的名字就指定为 app 了。 ### depends_on字段 控制启动顺序 在使用 Compose 时，最大的好处就是少打启动命令，但是一般项目容器启动的顺序是有要求的，如果直接从上到下启动容器，必然会因为容器依赖问题而启动失败。 例如在没启动数据库容器的时候启动了应用容器，这时候应用容器会因为找不到数据库而退出，为了避免这种情况我们需要加入一个标签，就是 depends_on，这个标签解决了容器的依赖、启动先后的问题。 例如下面容器会先启动 redis 和 db 两个服务，最后才启动 web 服务： ```yml version: '2' services: web: build: . depends_on: # 等待数据库启动 - db - redis redis: image: redis db: image: postgres ``` ### volumes字段 挂载容器外目录 挂载一个目录或者一个已存在的数据卷容器，可以直接使用`HOST:CONTAINER`这样的格式，或者使用`HOST:CONTAINER:ro`这样的格式，后者对于容器来说，数据卷是只读的，这样可以有效保护宿主机的文件系统。 **注意，再windows使用此方式挂载目录将面临权限问题。** ```yml volumes: // 只是指定一个路径，Docker 会自动在创建一个数据卷（这个路径是容器内部的）。 - /var/lib/mysql // 使用绝对路径挂载数据卷 - /opt/data:/var/lib/mysql // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器。 - ./cache:/tmp/cache // 使用用户的相对路径（~/ 表示的目录是 /home/<用户目录>/ 或者 /root/）。 - ~/configs:/etc/configs/:ro // 已经存在的命名的数据卷。 - datavolume:/var/lib/mysql ``` ### volumes_from字段 从其他容器挂载目录 从其它容器或者服务挂载数据卷，可选的参数是:ro或者 :rw前者表示容器只读，后者表示容器对数据卷是可读可写的。默认情况下是可读可写的。 ```yml volumes_from: - service_name - service_name:ro - container:container_name - container:container_name:rw ``` ### devices字段 挂载硬件设备 设备映射列表。与Docker client的--device参数类似。与volumes字段一致使用`HOST:CONTAINER`这样的格式。 ```yml devices: - "/dev/ttyUSB0:/dev/ttyUSB0" ``` ### extends字段 继承其他容器配置 ```yml extends: file: common.yml service: webapp ``` 用户可以在任何地方使用这个标签，只要标签内容包含file和service两个值就可以了。file的值可以是相对或者绝对路径，如果不指定file的值，那么Compose会读取当前YML文件的信息。 ### environment字段 设置环境变量 environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中，类似 docker run -e 的效果。 environment的书写方式有两种，一种是按照yml的键值对应，一种是直接写字符串。 ```yml environment: RACK_ENV: development SHOW: 'true' SESSION_SECRET: environment: - RACK_ENV=development - SHOW=true - SESSION_SECRET ``` ### env_file字段 从文件设置环境变量 ```yml env_file: .env env_file: - ./common.env - ./apps/web.env - /opt/secrets.env ``` 如果有变量名称与 environment 指令冲突，则以后者为准。 注意的是这里所说的环境变量是对宿主机的 Compose 而言的，如果在配置文件中有 build 操作，这些变量并不会进入构建过程中，如果要在构建中使用变量还是首选前面刚讲的 arg 标签。 ### ports字段 向外暴露端口 使用HOST:CONTAINER格式或者只是指定容器的端口，宿主机会随机映射端口。 ```yml ports: - "3000" - "8000:8000" - "49100:22" - "127.0.0.1:8001:8001" ``` **注意：当使用HOST:CONTAINER格式来映射端口时，如果你使用的容器端口小于60你可能会得到错误得结果，因为YAML将会解析xx:yy这种数字格式为60进制。所以建议采用字符串格式。** ### networks字段 容器间组网 所指的network可以由[networks字段 创建虚拟网络](#networks%e5%ad%97%e6%ae%b5-%e5%88%9b%e5%bb%ba%e8%99%9a%e6%8b%9f%e7%bd%91%e7%bb%9c)来设置。 ```yml services: some-service: networks: - some-network - other-network services: # 关于这个标签还有一个特别的子标签aliases，这是一个用来设置服务别名的标签 some-service: networks: some-network: aliases: - alias1 - alias3 other-network: aliases: - alias2 ``` 在同一个network中的容器，可以通过service名称来作为相互的ip地址，相互访问。例如上述例子中同属于`some-network`的容器，可以使用`http://some-service:80`来访问其web服务，本质上是使用了host映射。 ### links字段 容器间简单组网 不创建network，直接链接两个容器，**注意：**这类链接是单向的。 ```yml version: '2' services: web: build: . links: - "db:database" db: image: postgres ``` 使用的别名将会自动在服务容器中的/etc/hosts里创建。例如： ``` 172.12.2.186 db # ip就是docker虚拟网络的ip 172.12.2.186 database 172.12.2.187 redis ``` ### expose字段 向内暴露端口 链接[network](#networks%e5%ad%97%e6%ae%b5-%e5%ae%b9%e5%99%a8%e9%97%b4%e7%bb%84%e7%bd%91)或者[link](#links%e5%ad%97%e6%ae%b5-%e5%ae%b9%e5%99%a8%e9%97%b4%e7%ae%80%e5%8d%95%e7%bb%84%e7%bd%91)之后，在被访问的容器使用`expose`来向内网暴露端口。 ```yml expose: - "3000" - "8000" ``` ### external_links字段 跨Compose组网容器 在使用Docker过程中，我们会有许多单独使用docker run启动的容器，为了使Compose能够连接这些不在docker-compose.yml中定义的容器，我们需要一个特殊的标签，就是external_links，它可以让Compose项目里面的容器连接到那些项目配置外部的容器（前提是外部容器中必须至少有一个容器是连接到与项目内的服务的同一个网络里面）。 ```yml external_links: - redis_1 - project_db_1:mysql - project_db_1:postgresql ``` ### dns字段 设置容器的dns ```yml dns: - 8.8.8.8 - 9.9.9.9 dns_search: example.com # 此外 dns_search 的配置也类似 dns_search: - dc1.example.com - dc2.example.com ``` ### extra_hosts字段 添加host配置 就是往/etc/hosts文件中添加一些记录，与Docker client的--add-host类似： ```yml extra_hosts: - "somehost:162.242.195.82" - "otherhost:50.31.209.229" ``` ### labels字段 向容器添加元数据 向容器添加元数据，和Dockerfile的LABEL指令一个意思，格式如下： ```yml labels: com.example.description: "Accounting webapp" com.example.department: "Finance" com.example.label-with-empty-value: "" labels: - "com.example.description=Accounting webapp" - "com.example.department=Finance" - "com.example.label-with-empty-value" ``` ### entrypoint字段 指定启动指令 在 docker-compose.yml 中可以定义接入点，覆盖 Dockerfile 中的定义： ```yml entrypoint: /code/entrypoint.sh entrypoint: - php - -d - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so - -d - memory_limit=-1 - vendor/bin/phpunit ``` ### pid字段 设置PID模式 将PID模式设置为主机PID模式，跟主机系统共享进程命名空间。容器使用这个标签将能够访问和操纵其他容器和宿主机的名称空间。 ```yml pid: "host" ``` ### stop_signal字段 设置停止容器信号 设置另一个信号来停止容器。在默认情况下使用的是SIGTERM停止容器。设置另一个信号可以使用stop_signal标签。 ```yml stop_signal: SIGUSR1 ``` ### logging字段 配置日志服务 默认的driver是json-file。只有json-file和journald可以通过docker-compose logs显示日志，其他方式有其他日志查看方式，但目前Compose不支持。对于可选值可以使用options指定。 ```yml logging: driver: syslog options: syslog-address: "tcp://192.168.0.42:123" ``` 有关更多这方面的信息可以阅读官方文档： [https://docs.docker.com/engine/admin/logging/overview/](https://docs.docker.com/engine/admin/logging/overview/) ### tmpfs字段 挂载临时目录到容器 挂载临时目录到容器内部，与run的参数一样效果： ```yml tmpfs: /run tmpfs: - /run - /tmp ``` ### 其他字段 security_opt,cpu_shares, cpu_quota, cpuset, domainname, hostname, ipc, mac_address, mem_limit, memswap_limit, privileged, read_only, restart, shm_size, stdin_open, tty, user, working_dir 此类内容与docker run命令的先关参数对应。 ## networks字段 创建虚拟网络 ```yml version: "2" services: mongodb: image: mongo:4 container_name: devops-mongo # 容器名 ports: - "27017:27017" volumes: - "/data/docker_local/mongo/configdb:/data/configdb" - "/data/docker_local/mongo/data/db:/data/db" command: --auth # 开启授权验证 networks: - mongo_net networks: mongo_net: # 创建了一个虚拟网络 ``` 如果你想要你的容器加入到一个已存在的网络中，使用 external 选项: ```yml version: "3.7" services: proxy: build: ./proxy networks: - outside - default app: build: ./app networks: - default networks: outside: external: true ``` 这时候不会去创建一个 `[projectname]_outside` 的网络， Compose 会去查找一个已存在的叫做 `outside` 的网络，并且将它和 proxy 服务相连。 Last modification：November 8th, 2020 at 05:17 pm © 允许规范转载