Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
img
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status PyPi downloads PyPi version Docker pulls

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