fablo icon indicating copy to clipboard operation
fablo copied to clipboard

Export network topology with PlantUML or Mermaid

Open dzikowski opened this issue 4 years ago • 4 comments

dzikowski avatar Jan 28 '21 12:01 dzikowski

I’d like to clarify a few things before starting:

  1. What all would need to be changed in order to support this feature?
  2. Should the export support both PlantUML and Mermaid, or is it okay to start with just one?
  3. Where should the export be triggered from — a CLI command, a config option, or a separate script?

Looking forward to your guidance so I can proceed in the right direction. Thanks!

OsamaRab3 avatar May 08 '25 01:05 OsamaRab3

I have a feeling Mermaid is more common tool, so that would be sufficient. I believe we need a similar command as validate or extend-config. It should follow the same pattern

dzikowski avatar May 08 '25 11:05 dzikowski

I’ve implemented the initial part of the network topology export using Mermaid . Here's a generated diagram based on the current implementation:

Image

Could you please confirm if this output matches your expectations in terms of structure and visual representation?

Also, I’m not entirely sure what parts of the codebase still need to be updated to fully integrate this feature with Fablo. Are there specific files or modules I should focus on next to make this work end-to-end

OsamaRab3 avatar May 20 '25 01:05 OsamaRab3

I think we should have a separate Yeoman command for that - like we for validate, extend-config, generate etc.

I like the diagram. We need to start simple and then iterate if needed. The only missing part here is an arrow from Orderer node to the channel - it's through orderer group.

dzikowski avatar May 20 '25 08:05 dzikowski

resolved in #565

dzikowski avatar Jul 11 '25 12:07 dzikowski