github/kubeshark
1
0
Fork 0
mirror of https://github.com/kubeshark/kubeshark.git synced 2025-08-21 01:45:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Introduction to Mizu (markdown)

M. Mert Yıldıran 2021-11-09 14:27:22 +03:00
parent f107b25259
commit 6a8f7e5eb9
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Introduction-to-Mizu.md

@ -13,6 +13,8 @@ Mizu CLI is the program that's published under the [latest release](https://gith
Mizu CLI automatically establishes a proxy to the Mizu Agent as soon as it's deployed, so the user can effortlessly access the web UI. Mizu CLI automatically establishes a proxy to the Mizu Agent as soon as it's deployed, so the user can effortlessly access the web UI.
Automatic deployment through a CLI program is required because a network sniffer(tapper) per node needs to be deployed.
## Agent ## Agent
Mizu Agent is a Docker image that's pulled into the subject Kubernetes cluster. Mizu CLI is the software that orchestrates this deployment. Mizu Agent is a Docker image that's pulled into the subject Kubernetes cluster. Mizu CLI is the software that orchestrates this deployment.
@ -48,15 +50,14 @@ Mizu aims to understand the traffic above the Transport layer in the OSI Model.
recognizing Application and Presentation layer. The UDP in the Transport layer is out-of-scope for Mizu. recognizing Application and Presentation layer. The UDP in the Transport layer is out-of-scope for Mizu.
In a Kubernetes cluster, there can be one or many tappers. The number of tappers scales with the number of nodes in In a Kubernetes cluster, there can be one or many tappers. The number of tappers scales with the number of nodes in
a given Kubernetes namespace. Nodes mean machines, so each machine needs its own tapper. a given Kubernetes namespace. Nodes mean machines, so each machine needs its own network sniffer.
Tapper is an extremely parallel software thanks to the Goroutines and it's able to keep up with high traffic loads, but just like any other software, it's limited by physical resources like CPU and memory. It's not Tapper is an extremely parallel software thanks to the Goroutines and it's able to keep up with high traffic loads, but just like any other software, it's limited by physical resources like CPU and memory. It's not a disk intensive program.
a disk intensive program.
### API Server ### API Server
If the tapper is a highway, the API server is a freeway. It's the road all the other roads connect into. If the tapper is a highway, the API server is a freeway. It's the road all the other roads connect into.
The API server pod communicates with the tappers through a series of WebSocket pipelines and eventually streams The API server pod communicates with the tappers through a series of WebSocket pipelines and eventually streams
the dissected traffic into the web UI. It's essentially a web application, in that it provides a REST API, a server the dissected traffic into the web UI. It's essentially a web application, such that it provides a REST API, a server
for the React app (web UI) and lets you do a bunch of other things that can be done after the traffic analysis step. for the React app (web UI) and lets you do a bunch of other things that can be done after the traffic analysis step.