converts docker-compose into plantuml
Project description
compose_plantuml
Generate Plantuml graphs from docker-compose files
Note that version 2 as well as the legacy version is supported.
Usage
Via Python
Install it via: pip3 install compose_plantuml
After that use it like: compose_plantuml --link-graph docker-compose.yml
Via Docker
Use it like: cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph
For SVG Output, just call:
cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph | docker run -i think/plantuml > output.svg
For PNG Output, just call:
cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph | docker run -i think/plantuml -tpng > output.png
Link Graph
Link Graphs provide an overview over docker-compose services.
Consider the following docker-compose.yml
version: '2'
services:
first:
links:
- second
second: {}
When calling ‘compose_plantuml docker-compose.yml’ it will generate the following link graph:
[first] [second] [first] --> [second]
Rendered it looks like:
Boundaries
Boundaries visualize the external boundaries a system has.
Consider the following docker-compose.yml
version: '2'
services:
service:
ports:
- 8080:80
When calling ‘compose_plantuml –boundaries docker-compose.yml’ it will generate the following plantuml:
rectangle system {
[service]
}
[service] --> 8080 : 80
Rendered it looks like:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
