skupperproject / skewer

A library for documenting and testing Skupper examples
Apache License 2.0
2 stars 2 forks source link

Ability to generate overview diagram #12

Open garethahealy opened 3 months ago

garethahealy commented 3 months ago

One thing missing from the examples is a simple overview diagram. There is a lot of text but not much on the visual side, which sometimes makes it hard to remember what is connecting to what.

For example, for skupper-example-public-to-private

I had a google to see if there were any text to SVG (which there seems to be a few) and obviously, gen-ai came up, one of them being: https://www.eraser.io/diagramgpt

Which generated the below image:

Screenshot 2024-04-10 at 14 51 21

Based on the below YAML (notice the links key)

sites:
  public:
    title: Public
    platform: kubernetes
    namespace: public
  private:
    title: Private
    platform: kubernetes
    namespace: private
    links: [public]

The above is to trigger more of a whats possible, than an actual solution suggestion.

gahealy@rh

garethahealy commented 3 months ago

Diagrams exist for the connectivity examples, i.e.: https://github.com/skupperproject/skupper-example-public-to-private?tab=readme-ov-file#overview

But for other examples, there isn't anything, such as

Would be nice if skewer could do this, based on the yaml.