From f64a5b61d493594edf32e1fe04a974b5cfda7b2c Mon Sep 17 00:00:00 2001 From: Adil Hafeez Date: Thu, 20 Feb 2025 17:50:38 -0800 Subject: [PATCH] better readme --- demos/use_cases/k8s_api/README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/demos/use_cases/k8s_api/README.md b/demos/use_cases/k8s_api/README.md index a1e45416..a1ee833f 100644 --- a/demos/use_cases/k8s_api/README.md +++ b/demos/use_cases/k8s_api/README.md @@ -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)