Skip to content

Commit

Permalink
Merge pull request #59 from iovisor/docs/architecture-diagram
Browse files Browse the repository at this point in the history
Architecture diagram
  • Loading branch information
leodido authored Feb 15, 2019
2 parents 45fba8a + 3fdf42e commit 7e2aab1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ of [bpftrace](https://github.com/iovisor/bpftrace) programs in your Kubernetes c
* [Source](#source)
* [Packages](#packages)
+ [Arch - AUR](#arch---aur)
- [Architecture](#architecture)
- [Usage](#usage)
* [Run a program from string literal](#run-a-program-from-string-literal)
* [Run a program from file](#run-a-program-from-file)
Expand Down Expand Up @@ -49,6 +50,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
Expand All @@ -63,7 +74,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`
Expand Down
Binary file added docs/img/kubectl-trace-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7e2aab1

Please sign in to comment.