-
Notifications
You must be signed in to change notification settings - Fork 381
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tetragon: Add documentation for options
Signed-off-by: Jiri Olsa <jolsa@kernel.org>
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: "Options" | ||
icon: "overview" | ||
weight: 3 | ||
description: "Pass options to hook" | ||
--- | ||
|
||
It's possible to pass options through spec file as an array of name and value pairs: | ||
|
||
```yaml | ||
spec: | ||
options: | ||
- name: "option-1" | ||
value: "True" | ||
- name: "option-2" | ||
value: "10" | ||
``` | ||
Options array is passed and processed by each hook used in the spec file that | ||
supports options. At the moment it's availabe for kprobe hooks. | ||
- [`Kprobe Options`](#kprobe-options): options for kprobe hooks. | ||
|
||
## Kprobe options | ||
|
||
- [`disable-kprobe-multi`](#disable-kprobe-multi): disable kprobe multi link | ||
|
||
### disable-kprobe-multi | ||
|
||
This option disables kprobe multi link interface for all the kprobes defined in | ||
the spec file. If enabled, all the defined kprobes will be atached through standard | ||
kprobe interface. It stays enabled for another spec file without this option. | ||
|
||
It takes boolean as value, by default it's false. | ||
|
||
Example: | ||
|
||
```yaml | ||
options: | ||
- name: "disable-kprobe-multi" | ||
value: "1" | ||
``` |