diff --git a/README.md b/README.md index 39389b9..5566b1a 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,10 @@ Links (from `services..links`) are displayed as plain arrows pointing t If we look at the link between `mysql` and `ambassador`, it reads as follow: "`mysql` is known as `mysql` in `ambassador`." If we look at the link between `ambassador` and `logs`, it reads as follow: "`ambassador` is known as `logstash` in `logs`." +External links are displayed using the same shapes but are grayed: + +![external_links](resources/external_links.png) + ### Volumes Volumes (from `services..volumes_from`) are displayed as dashed arrows pointing to the service that uses the volumes: @@ -99,13 +103,23 @@ If we look at the link between port `2580` and `elk`, it reads as follow: "traff ### Extends -Extended services (from `services..extends`) are displayed as components (just like normal services). The link between them and the extending services are +Extended services (from `services..extends`) are displayed as components (just like normal services). The links between them and the extending services are displayed as inverted arrows: -![ports](resources/extends.png) +![extends](resources/extends.png) If we look at the link between `mysql` and `db`, it reads as follow: "`mysql` extends service `db`". +### Networks + +Networks (from `networks.`) are displayed as pentagon. The links between them and services are displayed as plain arrows pointing to the network: + +![netowrks](resources/extends.png) + +If we look at the link between `mysql` and the `global` network, it reads as follow: "`mysql` is known as `mysql`, `db` and `reldb` in the `global` network. + +The `legacy` network is an external so it's displayed as a grayed pentagone. + ## Examples ### `dot` renderer diff --git a/resources/external_links.png b/resources/external_links.png new file mode 100644 index 0000000..4662b5c Binary files /dev/null and b/resources/external_links.png differ diff --git a/resources/networks.png b/resources/networks.png new file mode 100644 index 0000000..57c0024 Binary files /dev/null and b/resources/networks.png differ