Docker Community Forums

Share and learn in the Docker community.

How to document deployments?

Deploying with compose and need to document the deployment.
Also usefull for getting a high level overview of the deployment:

  • Which ports are used? [1]
  • Which volumes are used?
  • How do the services relate to each other? [2]

I automate this with compose_plantuml.
Would like to listen your opinion about it.
Do you guys have similar issues?

Thanks!

[1] Port Boundaries

Generated out of the following docker-compose.yml:

version: '2'
services:
  service:
    ports:
      - 8080:80

[2] Service Dependency Chart

Generated out of the following docker-compose.yml:

[first]
[second]
[first] --> [second]