Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Architecture diagram #59

Merged
merged 2 commits into from
Feb 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.