Skip to content

Commit

Permalink
Merge pull request #44 from iovisor/feature/aur-package
Browse files Browse the repository at this point in the history
docs(kubectl-trace): inform about aur package
  • Loading branch information
fntlnz authored Jan 19, 2019
2 parents 3e8de86 + ba22dc3 commit f5d66ea
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# kubectl trace

`kubectl trace` is a kubectl plugin that allows you to schedule the execution
of [bpftrace](https://github.com/iovisor/bpftrace) programs in your Kubernetes cluster.

![Screenshot showing the read.bt program for kubectl-trace](docs/img/intro.png)

<!-- toc -->

- [Installation](#installation)
- [Installing](#installing)
* [Source](#source)
* [Packages](#packages)
+ [Arch - AUR](#arch---aur)
- [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 All @@ -16,19 +24,31 @@

<!-- tocstop -->

`kubectl trace` is a kubectl plugin that allows you to schedule the execution
of [bpftrace](https://github.com/iovisor/bpftrace) programs in your Kubernetes cluster.

![Screenshot showing the read.bt program for kubectl-trace](docs/img/intro.png)
## Installing

## Installation
### Source

```
go get -u github.com/iovisor/kubectl-trace/cmd/kubectl-trace
```

This will download and compile `kubectl-trace` so that you can use it as a kubectl plugin with `kubectl trace`

### Packages

You can't find the package for your distro of choice?
You are very welcome and encouraged to create it and then [open an issue](https://github.com/iovisor/kubectl-trace/issues/new) to inform us for review.

#### Arch - AUR

The official [PKGBUILD](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=kubectl-trace-git) is on AUR.

If you use `yay` to manage AUR packages you can do:

```
yay -S kubectl-trace-git
```

## Usage

You don't need to setup anything on your cluster before using it, please don't use it already
Expand Down

0 comments on commit f5d66ea

Please sign in to comment.