Skip to content

Commit

Permalink
Installation docs for v0.1.0-rc.0 (#83)
Browse files Browse the repository at this point in the history
Installation docs for v0.1.0-rc.0

Co-authored-by: null <40475078+toc-me[bot]@users.noreply.github.com>
  • Loading branch information
leodido and toc-me[bot] authored Sep 16, 2019
2 parents f1af597 + 325ac92 commit a38c074
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 7 deletions.
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ of [bpftrace](https://github.com/iovisor/bpftrace) programs in your Kubernetes c
<!-- toc -->

- [Installing](#installing)
* [Pre-built binaries](#pre-built-binaries)
* [Source](#source)
* [Packages](#packages)
+ [Arch - AUR](#arch---aur)
Expand All @@ -27,6 +28,40 @@ of [bpftrace](https://github.com/iovisor/bpftrace) programs in your Kubernetes c

## Installing

### Pre-built binaries

See the [release](https://github.com/iovisor/kubectl-trace/releases) page for the full list of pre-built assets.

The commands here show `amd64` versions, `386` versions are available in the releases page.

**Linux**

```bash
curl -Lo https://github.com/iovisor/kubectl-trace/releases/download/v0.1.0-rc.0/kubectl-trace_0.1.0-rc.0_linux_amd64.tar.gz
tar -xvf kubectl-trace.tar.gz
mv kubectl-trace /usr/local/bin/kubectl-trace
```

**OSX**

```bash
curl -Lo https://github.com/iovisor/kubectl-trace/releases/download/v0.1.0-rc.0/kubectl-trace_0.1.0-rc.0_linux_amd64.tar.gz
tar -xvf kubectl-trace.tar.gz
mv kubectl-trace /usr/local/bin/kubectl-trace
```


**Windows**

In PowerShell v5+
```powershell
$url = "https://github.com/iovisor/kubectl-trace/releases/download/v0.1.0-rc.0/kubectl-trace_0.1.0-rc.0_windows_amd64.zip"
$output = "$PSScriptRoot\kubectl-trace.zip"
Invoke-WebRequest -Uri $url -OutFile $output
Expand-Archive "$PSScriptRoot\kubectl-trace.zip" -DestinationPath "$PSScriptRoot\kubectl-trace"
```

### Source

```
Expand All @@ -52,13 +87,7 @@ 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)
See [architecture.md](/docs/architecture.md)

## Usage

Expand Down
9 changes: 9 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 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)

0 comments on commit a38c074

Please # to comment.