https://github.com/funkwerk/compose_plantuml

Generate Plantuml graphs from docker-compose files
https://github.com/funkwerk/compose_plantuml

compose docker docker-compose model plantuml

Last synced: 29 days ago
JSON representation

Generate Plantuml graphs from docker-compose files

• Host: GitHub
• URL: https://github.com/funkwerk/compose_plantuml
• Owner: funkwerk
• License: mit
• Created: 2016-03-18T19:43:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-03-22T20:47:51.000Z (over 2 years ago)
• Last Synced: 2024-09-18T20:30:05.340Z (3 months ago)
• Topics: compose, docker, docker-compose, model, plantuml
• Language: Python
• Size: 32.2 KB
• Stars: 90
• Watchers: 10
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - funkwerk/compose_plantuml - Generate Plantuml graphs from docker-compose files (docker)
• awesome-docker - compose_plantuml - Generate Plantuml graphs from docker-compose files by [@funkwerk](https://github.com/funkwerk) (Container Operations / Container Composition)
• awesome-docker - compose_plantuml - Generate Plantuml graphs from docker-compose files by [@funkwerk](https://github.com/funkwerk) (Container Operations / Container Composition)

README

        
[![Build Status](https://travis-ci.org/funkwerk/compose_plantuml.svg)](https://travis-ci.org/funkwerk/compose_plantuml)

[![](https://badge.imagelayers.io/funkwerk/compose_plantuml.svg)](https://imagelayers.io/?images=funkwerk/compose_plantuml:latest 'funkwerk/compose_plantuml')

[![PyPi downloads](https://img.shields.io/pypi/dm/compose_plantuml.svg)](https://pypi.python.org/pypi/compose_plantuml/)

[![PyPi version](https://img.shields.io/pypi/v/compose_plantuml.svg)](https://pypi.python.org/pypi/compose_plantuml/)

[![Docker pulls](https://img.shields.io/docker/pulls/funkwerk/compose_plantuml.svg)](https://hub.docker.com/r/funkwerk/compose_plantuml/)

# 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