Skip to main content

converts docker-compose into plantuml

Project description

Build Status image1 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

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:

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
compose_plantuml-0.1.2.tar.gz (5.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page