better readme

This commit is contained in:
Adil Hafeez 2025-02-20 17:50:38 -08:00
parent 24dfed7cde
commit f64a5b61d4
No known key found for this signature in database
GPG key ID: 9B18EF7691369645

View file

@ -1,8 +1,14 @@
This demo shows how you can use a publicly hosted rest api and interact it using arch gateway.
# Kubernetes API Demo
This demo shows how you can use a publicly hosted REST API and interact with it using the Arch Gateway.
## Summary
In this demo, you will learn how to set up and run a model server, Arch Gateway, and a Docker container for the UI. You will also learn how to tail access logs for debugging purposes. The demo includes examples of getting namespace details and retrieving pod information from a Kubernetes cluster.
# How to run this demo.
Before staring make sure you have completed the pre-requisites [here](https://github.com/katanemo/archgw?tab=readme-ov-file#prerequisites)
Before starting make sure you have completed the pre-requisites [here](https://github.com/katanemo/archgw?tab=readme-ov-file#prerequisites)
In separate window start 1) model server, 2) arch gateway 3) docker container for UI and for debugging 4) tail access logs
@ -30,3 +36,9 @@ Here is a sample screenshot of the demo in action,
![screenshot](image2.png)
- show usage of get namespace details and get pods
![Demo Screenshot](image.png)
# Observability
You can see access logs to see details of outbound API calls through arch gateway. You can also see request details using supplied jaeger UI. Following is a screenshot showing one request served through arch gateway,
![tracing](tracing.png)