Skip to content

Commit a38c074

Browse files
leodidotoc-me[bot]
andauthored
Installation docs for v0.1.0-rc.0 (#83)
Installation docs for v0.1.0-rc.0 Co-authored-by: null <40475078+toc-me[bot]@users.noreply.github.com>
2 parents f1af597 + 325ac92 commit a38c074

File tree

2 files changed

+45
-7
lines changed

2 files changed

+45
-7
lines changed

README.md

+36-7
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ of [bpftrace](https://github.com/iovisor/bpftrace) programs in your Kubernetes c
88
<!-- toc -->
99

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

2829
## Installing
2930

31+
### Pre-built binaries
32+
33+
See the [release](https://github.com/iovisor/kubectl-trace/releases) page for the full list of pre-built assets.
34+
35+
The commands here show `amd64` versions, `386` versions are available in the releases page.
36+
37+
**Linux**
38+
39+
```bash
40+
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
41+
tar -xvf kubectl-trace.tar.gz
42+
mv kubectl-trace /usr/local/bin/kubectl-trace
43+
```
44+
45+
**OSX**
46+
47+
```bash
48+
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
49+
tar -xvf kubectl-trace.tar.gz
50+
mv kubectl-trace /usr/local/bin/kubectl-trace
51+
```
52+
53+
54+
**Windows**
55+
56+
In PowerShell v5+
57+
```powershell
58+
$url = "https://github.com/iovisor/kubectl-trace/releases/download/v0.1.0-rc.0/kubectl-trace_0.1.0-rc.0_windows_amd64.zip"
59+
$output = "$PSScriptRoot\kubectl-trace.zip"
60+
61+
Invoke-WebRequest -Uri $url -OutFile $output
62+
Expand-Archive "$PSScriptRoot\kubectl-trace.zip" -DestinationPath "$PSScriptRoot\kubectl-trace"
63+
```
64+
3065
### Source
3166

3267
```
@@ -52,13 +87,7 @@ yay -S kubectl-trace-git
5287

5388
## Architecture
5489

55-
Since it is a kubectl plugin, kubectl-trace doesn't require you to install any component directly
56-
to your kubernetes cluster in order to execute your bpftrace programs, however when you point it to
57-
a cluster, it will schedule a temporary job there called `trace-runner` that executes the program.
58-
59-
This figure, shows the general idea:
60-
61-
![Kubectl trace architecture diagram](docs/img/kubectl-trace-architecture.png)
90+
See [architecture.md](/docs/architecture.md)
6291

6392
## Usage
6493

docs/architecture.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Architecture
2+
3+
Since it is a kubectl plugin, kubectl-trace doesn't require you to install any component directly
4+
to your kubernetes cluster in order to execute your bpftrace programs, however when you point it to
5+
a cluster, it will schedule a temporary job there called `trace-runner` that executes the program.
6+
7+
This figure, shows the general idea:
8+
9+
![Kubectl trace architecture diagram](/docs/img/kubectl-trace-architecture.png)

0 commit comments

Comments
 (0)