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

Create images/diagrams to explain main message flows and usecases #15

Open
sanjeewa-malalgoda opened this issue Dec 2, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@sanjeewa-malalgoda
Copy link

Project requires clear and visually engaging images/diagrams to explain its core message flows and use cases. These visuals will help developers, and end-users better understand the architecture, capabilities, and practical implementations of the gateway.

Requirements
Message Flows:
Illustrate the main data flow, including:

  • Request ingress through the gateway.
  • Routing to LLM backends or API backends.
  • Response handling and any transformations (e.g., prompt decorating or semantic caching).
  • Include dynamic features like weighted routing and multi-LLM backend switching.

Use Cases:
Multi-LLM Backend Support
Prompt Templating and Decorating
Semantic Caching
AI API Observability

@sanjeewa-malalgoda
Copy link
Author

Screenshot 2024-12-02 at 07 06 27 Screenshot 2024-12-02 at 07 06 10 Screenshot 2024-12-02 at 06 36 06

@sanjeewa-malalgoda
Copy link
Author

diagram-source-files.zip

@missBerg
Copy link
Contributor

missBerg commented Dec 2, 2024

Wondering if we should make the difference between the Control Plane, Data Plane, and External Processes clear?
As in Envoy Proxy being the data plane, and specific external processes extend functionality.
And that the Gateway control plane configures Envoy Proxy and External Processes?

CC @mathetake

@mathetake
Copy link
Member

yeah the relationship with Envoy Gateway and where External Processing sits in the request flow and how it's managed might be a good content in the diagram. This should be in line with #16 as well (which one of the maintainers will work on it for the next couple of weeks)

@sanjeewa-malalgoda
Copy link
Author

Thanks for suggestions. Will those to diagrams and i should be able to get some idea from #16 too.

@mathetake
Copy link
Member

so @yuzisun is working on the design doc, and after he finishes it let's get back to this and polish the diagram

@mathetake mathetake added the documentation Improvements or additions to documentation label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants