Skip to content
Merged
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
add Getting Started section
  • Loading branch information
alan-maguire committed May 11, 2023
commit e3703bc323c5c99c5dfb62f9df517fefab661381
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ Each tuner shared object defines an init(), fini() and event_handler()
function. These respectively set up and clean up BPF and handle events
that originate from the BPF code.

## Building
## Getting Started

Simply run
If building the repository manually, simply run

```
$ make ; sudo make install
Expand All @@ -168,8 +168,7 @@ at the top-level of the repository. bpftune also supports a
$ make pkg
```

target, which will make a bpftune RPM. See ./buildrpm/bpftune.spec.

target, which will make a bpftune RPM. See ./buildrpm/bpftune.spec

To build the following packages are needed (names may vary by distro);

Expand All @@ -181,6 +180,30 @@ To build the following packages are needed (names may vary by distro);
- llvm >= 11
- python3-docutils

To enable bpftune as a service

```
$ sudo service bpftune start
```

...and to enable it by default

```
$ sudo systemctl enable bpftune
```

bpftune logs to syslog so /var/log/messags will contain details
of any tuning carried out.

bpftune can also be run in the foreground as a program; to redirect
output to stdout/stderr, run

```
$ sudo bpftune -s
```

On exit, bpftune will summarize any tuning done.

## Tests

Tests are supplied for each tuner in the tests/ subdirectory.
Expand Down