compose-plantuml

compose_plantuml

Generate Plantuml graphs from docker-compose files

Note that version 2 as well as the legacy version is supported.

Install it via: pip3 install compose_plantuml

After that use it like: compose_plantuml --link-graph docker-compose.yml

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 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 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:

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

compose_plantuml-0.2.1.tar.gz (6.0 kB view details)

Uploaded Nov 23, 2020 Source

Details for the file compose_plantuml-0.2.1.tar.gz.

Download URL: compose_plantuml-0.2.1.tar.gz
Upload date: Nov 23, 2020
Size: 6.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.8.5

Hashes for compose_plantuml-0.2.1.tar.gz
Algorithm	Hash digest
SHA256	`d13326af5a0ce8545b4c285e483452834876cb9361ddb5102ae94a5283783e3c`
MD5	`978b304cfc0e803754d3c6e6eff21e21`
BLAKE2b-256	`f78552b0d84bf9b0bdbc99d18dbde95b04f5da4f9263d8d1111adcd846618ebb`