Herramienta gratuita

Docker Compose a diagrama

Pega un docker-compose.yml y ve sus servicios, redes, volúmenes y dependencias como un diagrama. No necesitas cuenta para probarlo.

Resultado de ejemplo

Diagrama de ejemplo dibujado a partir de un ejemplo de Docker Compose

¿Tienes manifiestos de Kubernetes? Prueba la herramienta de YAML de Kubernetes

Cómo funciona

  1. Pega o suelta tu archivo de Compose

    Un docker-compose.yml o compose.yaml: el mismo archivo que ejecutas con docker compose up. Las anclas de YAML y los campos de extensión x- no son problema.

  2. Mira el diagrama

    Los servicios se convierten en tarjetas con su imagen, puertos y réplicas. Las redes se convierten en marcos, y los volúmenes con nombre, secrets y configs se conectan a los servicios que los usan.

  3. Ábrelo en Archboard

    Guárdalo como un diagrama nuevo para reorganizarlo, anotarlo, compartir un enlace o exportarlo en SVG y PNG. Para registrarte basta una cuenta de Google o GitHub.

Qué se dibuja a partir de un archivo de Compose

El diagrama se construye con estas claves de tu archivo:

  • services

    Cada servicio como una tarjeta con el nombre de su clave

  • imagebuild

    La imagen, o el contexto de build en los servicios que se construyen desde el código fuente

  • ports

    Los puertos como 8080:80 u 80, sin la IP del host; la sintaxis larga se muestra como published:target, con el protocolo si no es TCP

  • deploy.replicasscale

    El número de réplicas de deploy.replicas o scale

  • volumes

    Los volúmenes con nombre, conectados a los servicios que los montan

  • secretsconfigs

    Los secrets y configs, solo por su nombre, conectados a los servicios que los usan

  • networks

    Las redes como marcos: cada servicio dentro del marco de su primera red

  • depends_on

    Conexiones de un servicio a los servicios de los que depende

Sin la clave networks, todo el proyecto se dibuja en un único marco. Con redes, cada servicio se ubica en el marco de su primera red y se conecta a los marcos de las demás redes a las que pertenece.

Qué no muestra el diagrama

  • Qué servicios se llaman entre sí en tiempo de ejecución: depends_on fija el orden de arranque, y un archivo de Compose describe cómo se enlazan los servicios, no el tráfico real
  • Ni los valores de las variables de entorno, ni el contenido de env_file, ni lo que hay dentro de secrets y configs: solo se leen los nombres
  • Los contenedores en ejecución, su estado de salud, los logs o el uso de recursos
  • Los campos heredados con extends (aunque vengan de un servicio del mismo archivo) y los servicios de archivos incluidos con include: solo se dibujan los campos escritos en cada servicio

Preguntas

¿Qué archivos de Compose funcionan?

Cualquier docker-compose.yml o compose.yaml con una clave services en la raíz, incluidos los archivos antiguos que empiezan con una línea version. Pega un archivo cada vez.

¿Qué pasa con las variables y los archivos .env?

Las variables no se sustituyen: una imagen o un puerto escrito con una variable se muestra tal cual. Los valores de environment y los archivos indicados en env_file no se leen.

¿Puedo pegar un archivo override o varios archivos?

Pega un archivo cada vez. Un archivo override como docker-compose.override.yml se lee por separado: pega el archivo con los servicios que quieres ver o combina antes los archivos en uno. Los archivos de include no se siguen y extends no se resuelve: incluso dentro del mismo archivo, solo se dibujan los campos escritos en ese servicio.

¿Qué pasa al abrir el diagrama en Archboard?

El diagrama que ves, con sus formas, nombres y conexiones, se guarda como un diagrama nuevo en tu espacio de trabajo, donde puedes reorganizarlo, añadir notas, compartirlo o exportarlo. Es un punto de partida: los cambios posteriores en tu archivo de Compose no actualizan el diagrama.

¿La herramienta es gratuita?

Sí. Pegar un archivo de Compose y ver el diagrama no requiere cuenta. Para abrirlo en Archboard basta una cuenta gratuita.

Abre un lienzo en un minuto

Inicia sesión con Google o GitHub. Gratis para un asiento. Mejora el plan cuando se una el equipo.