Clarify service networks documentation

When jumping straight to this bit of the docs, it's not clear
that these are options under a service rather than the top-level
`networks` key. Added a service to make this super clear.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
Ben Firshman 2016-04-20 15:58:12 -07:00
parent a0aea42f75
commit 55fcd1c3e3
1 changed files with 15 additions and 11 deletions

View File

@ -502,9 +502,11 @@ the special form `service:[service name]`.
Networks to join, referencing entries under the Networks to join, referencing entries under the
[top-level `networks` key](#network-configuration-reference). [top-level `networks` key](#network-configuration-reference).
networks: services:
- some-network some-service:
- other-network networks:
- some-network
- other-network
#### aliases #### aliases
@ -516,14 +518,16 @@ Since `aliases` is network-scoped, the same service can have different aliases o
The general format is shown here. The general format is shown here.
networks: services:
some-network: some-service:
aliases: networks:
- alias1 some-network:
- alias3 aliases:
other-network: - alias1
aliases: - alias3
- alias2 other-network:
aliases:
- alias2
In the example below, three services are provided (`web`, `worker`, and `db`), along with two networks (`new` and `legacy`). The `db` service is reachable at the hostname `db` or `database` on the `new` network, and at `db` or `mysql` on the `legacy` network. In the example below, three services are provided (`web`, `worker`, and `db`), along with two networks (`new` and `legacy`). The `db` service is reachable at the hostname `db` or `database` on the `new` network, and at `db` or `mysql` on the `legacy` network.