Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to generate overview diagram #12

Open
garethahealy opened this issue Apr 10, 2024 · 1 comment
Open

Ability to generate overview diagram #12

garethahealy opened this issue Apr 10, 2024 · 1 comment

Comments

@garethahealy
Copy link

garethahealy commented Apr 10, 2024

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

  • k8s cluster private connects to k8s cluster public

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
Copy link
Author

garethahealy commented Apr 10, 2024

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.

@garethahealy garethahealy reopened this Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant