diff --git a/README.md b/README.md index 50157ece2..34d720366 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ -# 水 mizu +![Mizu: The API Traffic Viewer for Kubernetes](assets/mizu-logo.svg) +# The API Traffic Viewer for Kubernetes + A simple-yet-powerful API traffic viewer for Kubernetes to help you troubleshoot and debug your microservices. Think TCPDump and Chrome Dev Tools combined. +![Simple UI](assets/mizu-ui.png) + +## Features + +- Simple and powerful CLI +- Real time view of all HTTP requests, REST and gRPC API calls +- No installation or code instrumentation +- Works completely on premises (on-prem) + ## Download Download `mizu` for your platform and operating system @@ -142,10 +153,10 @@ See `examples/roles` for example `clusterroles`. ## How to run -1. Find pod you'd like to tap to in your Kubernetes cluster +1. Find pods you'd like to tap to in your Kubernetes cluster 2. Run `mizu tap PODNAME` or `mizu tap REGEX` -3. Open browser on `http://localhost:8899` as instructed .. -4. Watch the WebAPI traffic flowing .. +3. Open browser on `http://localhost:8899/mizu` **or** as instructed in the CLI .. +4. Watch the API traffic flowing .. 5. Type ^C to stop ## Examples diff --git a/assets/mizu-example.png b/assets/mizu-example.png new file mode 100644 index 000000000..329da58ae Binary files /dev/null and b/assets/mizu-example.png differ diff --git a/assets/mizu-logo.svg b/assets/mizu-logo.svg new file mode 100644 index 000000000..cbf980097 --- /dev/null +++ b/assets/mizu-logo.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/mizu-ui.png b/assets/mizu-ui.png new file mode 100644 index 000000000..29a1d17ba Binary files /dev/null and b/assets/mizu-ui.png differ