docker_practice/compose/yaml_file.md

260 lines
5.2 KiB
Markdown
Raw Normal View History

2015-05-08 12:10:01 +00:00
## YAML 模板文件
默认的模板文件是 `docker-compose.yml`,其中定义的每个服务都必须通过 `image` 指令指定镜像或 `build` 指令(需要 Dockerfile来自动构建。
其它大部分指令都跟 `docker run` 中的类似。
如果使用 `build` 指令,在 `Dockerfile` 中设置的选项(例如:`CMD`, `EXPOSE`, `VOLUME`, `ENV` 等) 将会自动被获取,无需在 `docker-compose.yml` 中再次设置。
### `image`
指定为镜像名称或镜像 ID。如果镜像在本地不存在`Compose` 将会尝试拉去这个镜像。
例如:
```bash
2015-05-08 12:10:01 +00:00
image: ubuntu
image: orchardup/postgresql
image: a4bc65fd
```
### `build`
指定 `Dockerfile` 所在文件夹的路径。 `Compose` 将会利用它自动构建这个镜像,然后使用这个镜像。
```
build: /path/to/build/dir
```
### `command`
覆盖容器启动后默认执行的命令。
```bash
2015-05-08 12:10:01 +00:00
command: bundle exec thin -p 3000
```
### `links`
链接到其它服务中的容器。使用服务名称(同时作为别名)或服务名称:服务别名 `SERVICE:ALIAS` 格式都可以。
```bash
2015-05-08 12:10:01 +00:00
links:
- db
- db:database
- redis
```
使用的别名将会自动在服务容器中的 `/etc/hosts` 里创建。例如:
```bash
2015-05-08 12:10:01 +00:00
172.17.2.186 db
172.17.2.186 database
172.17.2.187 redis
```
相应的环境变量也将被创建。
### `external_links`
链接到 docker-compose.yml 外部的容器,甚至 并非 `Compose` 管理的容器。参数格式跟 `links` 类似。
```
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql
```
### `ports`
暴露端口信息。
使用宿主:容器 `HOST:CONTAINER`格式或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。
```
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"
```
*注:当使用 `HOST:CONTAINER` 格式来映射端口时,如果你使用的容器端口小于 60 你可能会得到错误得结果,因为 `YAML` 将会解析 `xx:yy` 这种数字格式为 60 进制。所以建议采用字符串格式。*
### `expose`
暴露端口,但不映射到宿主机,只被连接的服务访问。
仅可以指定内部端口为参数
```bash
2015-05-08 12:10:01 +00:00
expose:
- "3000"
- "8000"
```
### `volumes`
卷挂载路径设置。可以设置宿主机路径 `HOST:CONTAINER` 或加上访问模式 `HOST:CONTAINER:ro`)。
```bash
2015-05-08 12:10:01 +00:00
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
```
### `volumes_from`
从另一个服务或容器挂载它的所有卷。
```bash
2015-05-08 12:10:01 +00:00
volumes_from:
- service_name
- container_name
```
### `environment`
设置环境变量。你可以使用数组或字典两种格式。
只给定名称的变量会自动获取它在 Compose 主机上的值,可以用来防止泄露不必要的数据。
```
environment:
RACK_ENV: development
SESSION_SECRET:
environment:
- RACK_ENV=development
- SESSION_SECRET
```
### `env_file`
从文件中获取环境变量,可以为单独的文件路径或列表。
如果通过 `docker-compose -f FILE` 指定了模板文件,则 `env_file` 中路径会基于模板文件路径。
如果有变量名称与 `environment` 指令冲突,则以后者为准。
```bash
2015-05-08 12:10:01 +00:00
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
```
环境变量文件中每一行必须符合格式,支持 `#` 开头的注释行。
```bash
2015-05-08 12:10:01 +00:00
# common.env: Set Rails/Rack environment
RACK_ENV=development
```
### `extends`
基于已有的服务进行扩展。例如我们已经有了一个 webapp 服务,模板文件为 `common.yml`
```bash
2015-05-08 12:10:01 +00:00
# common.yml
webapp:
build: ./webapp
environment:
- DEBUG=false
- SEND_EMAILS=false
```
编写一个新的 `development.yml` 文件,使用 `common.yml` 中的 webapp 服务进行扩展。
```bash
2015-05-08 12:10:01 +00:00
# development.yml
web:
extends:
file: common.yml
service: webapp
ports:
- "8000:8000"
links:
- db
environment:
- DEBUG=true
db:
image: postgres
```
后者会自动继承 common.yml 中的 webapp 服务及相关环节变量。
### `net`
设置网络模式。使用和 `docker client``--net` 参数一样的值。
```bash
2015-05-08 12:10:01 +00:00
net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"
```
2015-05-10 06:56:05 +00:00
### `pid`
跟主机系统共享进程命名空间。打开该选项的容器可以相互通过进程 ID 来访问和操作。
```bash
2015-05-10 06:56:05 +00:00
pid: "host"
```
2015-05-08 12:10:01 +00:00
### `dns`
2015-05-10 06:56:05 +00:00
配置 DNS 服务器。可以是一个值,也可以是一个列表。
2015-05-08 12:10:01 +00:00
```bash
2015-05-08 12:10:01 +00:00
dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
```
2015-05-10 06:56:05 +00:00
### `cap_add, cap_drop`
添加或放弃容器的 Linux 能力Capabiliity
```bash
2015-05-10 06:56:05 +00:00
cap_add:
- ALL
cap_drop:
- NET_ADMIN
- SYS_ADMIN
```
### `dns_search`
配置 DNS 搜索域。可以是一个值,也可以是一个列表。
```bash
2015-05-10 06:56:05 +00:00
dns_search: example.com
dns_search:
- domain1.example.com
- domain2.example.com
```
### `working_dir, entrypoint, user, hostname, domainname, mem_limit, privileged, restart, stdin_open, tty, cpu_shares`
2015-05-08 12:10:01 +00:00
2015-05-10 06:56:05 +00:00
这些都是和 `docker run` 支持的选项类似。
2015-05-08 12:10:01 +00:00
```
2015-05-10 06:56:05 +00:00
cpu_shares: 73
2015-05-08 12:10:01 +00:00
working_dir: /code
entrypoint: /code/entrypoint.sh
user: postgresql
hostname: foo
domainname: foo.com
mem_limit: 1000000000
privileged: true
2015-05-10 06:56:05 +00:00
restart: always
stdin_open: true
tty: true
2015-05-08 12:10:01 +00:00
```