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:
1 maintainer
Metadata
1 maintainer
Release files for compose-plantuml 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| compose_plantuml-0.2.1.tar.gz | 6.0 kB | Without provenance | Details |
Release files / compose_plantuml-0.2.1.tar.gz
| Download URL | compose_plantuml-0.2.1.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d13326af5a0ce8545b4c285e483452834876cb9361ddb5102ae94a5283783e3c
|
|
BLAKE2b-256 checksum How to use checksums |
f78552b0d84bf9b0bdbc99d18dbde95b04f5da4f9263d8d1111adcd846618ebb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for compose-plantuml 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
