docs(kubectl-trace): add architecture diagram

Signed-off-by: Lorenzo Fontana <[email protected]>
iovisor · Feb 15, 2019 · 7ec421d · 7ec421d
1 parent 45fba8a
commit 7ec421d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -49,6 +49,16 @@ If you use `yay` to manage AUR packages you can do:
 yay -S kubectl-trace-git
 ```
 
+## Architecture
+
+Since it is a kubectl plugin, kubectl-trace doesn't require you to install any component directly
+to your kubernetes cluster in order to execute your bpftrace programs, however when you point it to
+a cluster, it will schedule a temporary job there called `trace-runner` that executes the program.
+
+This figure, shows the general idea:
+
+![Kubectl trace architecture diagram](docs/img/kubectl-trace-architecture.png)
+
 ## Usage
 
 You don't need to setup anything on your cluster before using it, please don't use it already
@@ -63,7 +73,6 @@ on the node `ip-180-12-0-152.ec2.internal`.
 kubectl trace run ip-180-12-0-152.ec2.internal -e "tracepoint:syscalls:sys_enter_* { @[probe] = count(); }"
 ```
 
-
 ### Run a program from file
 
 Here we run a program named `read.bt` against the node `ip-180-12-0-152.ec2.internal`

diff --git a/docs/img/kubectl-trace-architecture.png b/docs/img/kubectl-trace-architecture.png