funkwerk/compose_plantuml

Generate Plantuml graphs from docker-compose files

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:

Related Links

• draw compose
  • https://github.com/Alexis-benoist/draw-compose
  • generates dot graphs from docker-compose files
  • currently just supports docker-compose version 1
  • does not read from stdin, so is not easy useable as docker container

compose_plantuml's Issues

support for "networks"

docker-compose supports a feature called "network" which groups together containers. This is the replacement for the now-obsolete "links".
It would be fantastic if nodes can be grouped together by network.
Regards

loader is depreciated

cannot run anymore ;)

[BUG]The PNG is not complete if the docker-compose contains a lot of containers

Hi,
I tried your project with 3 methods.

1. cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph | docker run -i think/plantuml -tpng > output.png who worked as expected

Then I see that we can display the volumes and the containers so I tried:
2) cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --boundaries | docker run -i think/plantuml > output.svg who is complet when I open it

3. cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --boundaries | docker run -i think/plantuml -tpng > output.png and here, the PNG doesn't contains all the containers, it's cut on the right...

Do you know why this happens ?

I want to display the graph as in the first try ("normal view") but with "volumes,ports", is it possible ? (I mean to have the "depends on" + "volumes and ports" ?)

Thank you for your amazing project !

How to avoid a "spam" of containers ?

Hi,
I'd like to know if there is a way to delete the container that the command cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph | docker run -i think/plantuml > output.svg creates because each time it creates 2 containers.

Thank you for the help :)