From 11f72401b362da1debd68114e178cac703e8cfb7 Mon Sep 17 00:00:00 2001 From: Jiri Olsa Date: Wed, 25 Oct 2023 07:23:10 +0000 Subject: [PATCH] tetragon: Add documentation for options Signed-off-by: Jiri Olsa --- .../docs/concepts/tracing-policy/options.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/content/en/docs/concepts/tracing-policy/options.md diff --git a/docs/content/en/docs/concepts/tracing-policy/options.md b/docs/content/en/docs/concepts/tracing-policy/options.md new file mode 100644 index 00000000000..b95428f5e83 --- /dev/null +++ b/docs/content/en/docs/concepts/tracing-policy/options.md @@ -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" +```