docs: Enhance kernel configuration FAQ with 'tetra probe config' guidance #4248
Conversation
This file contains hidden or 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
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mtardy
reviewed
Oct 27, 2025
|
|
||
| ### What are the Linux kernel configuration options needed to run Tetragon? | ||
|
|
||
| As a first step to verify your kernel configuration, you can use the `tetra probe config` command. This will output a list of detected kernel features relevant to Tetragon. Missing features can indicate that your kernel is not configured correctly. |
Member
There was a problem hiding this comment.
hey, as last time, please wrap lines
Suggested change
| As a first step to verify your kernel configuration, you can use the `tetra probe config` command. This will output a list of detected kernel features relevant to Tetragon. Missing features can indicate that your kernel is not configured correctly. | |
| As a first step to verify your kernel configuration, you can use the `tetra probe config` command. This will output a list of detected kernel features | |
| relevant to Tetragon. Missing features can indicate that your kernel is not | |
| configured correctly. |
mtardy
added
area/documentation
AritraDey-Dev
force-pushed
the
docs/kernel-config-faq-update
branch
from
63f80bc to
bd5c0d2
Compare
mtardy
reviewed
Oct 29, 2025
Member
mtardy
left a comment
mtardy
left a comment
There was a problem hiding this comment.
I think by reading the FAQ entry that we should maybe reorganize a little bit to make it understandable, what do you think? :) here are a few suggestions
Comment on lines
109
to
133
| At runtime, to probe if your kernel has sufficient features turned on, you can | ||
| run `tetra` with root privileges with the `probe` command: | ||
|
|
||
| ```shell | ||
| sudo tetra probe | ||
| ``` | ||
|
|
||
| You can also run this command directly from the tetragon container image on a | ||
| Kubernetes cluster node. For example: | ||
|
|
||
| ```shell | ||
| kubectl run bpf-probe --image=quay.io/cilium/tetragon-ci:latest --privileged --restart=Never -it --rm --command -- tetra probe | ||
| ``` | ||
|
|
||
| The output should be similar to this (with boolean values depending on your | ||
| actual configuration): | ||
|
|
||
| ``` | ||
| override_return: true | ||
| buildid: true | ||
| kprobe_multi: false | ||
| fmodret: true | ||
| fmodret_syscall: true | ||
| signal: true | ||
| large: true | ||
| ``` |
Member
There was a problem hiding this comment.
by the way you could move the rest in a separate new commit so that you have
- your new probe config: to read your kernel conf
- the old probe command: to actually probe the feature on the running kernel
- the details on particular kernel config: to have the details of kernel config by config flag.
And try to make sense of how they articulate with each others because I think looks a bit strange now and is not easily understandable how this FAQ answer is written.
AritraDey-Dev
force-pushed
the
docs/kernel-config-faq-update
branch
3 times, most recently
from
51cc81b to
5c5abe2
Compare
The kernel configuration section now provides a comprehensive and well-structured guide for users to verify their system compatibility with Tetragon. Fixes cilium#4114 Co-authored-by: Mahe Tardy <[email protected]> Signed-off-by: Mahe Tardy <[email protected]> Signed-off-by: Aritra Dey <[email protected]>
mtardy
force-pushed
the
docs/kernel-config-faq-update
branch
from
5c5abe2 to
fe8ff80
Compare
mtardy
approved these changes
Nov 5, 2025
Member
mtardy
left a comment
mtardy
left a comment
There was a problem hiding this comment.
Thanks I adjusted the content myself, thanks for the help on this!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4114
Description
Update FAQ to highlight recommended
tetra probe kernel configand improve clarity.