From e49dec202ba199e333542ac419d4b6e4b0368d77 Mon Sep 17 00:00:00 2001 From: Rafael Roquetto Date: Tue, 17 Sep 2024 20:30:22 -0600 Subject: [PATCH] Update docs --- README.md | 7 ++++--- docs/sources/_index.md | 1 + 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e4cc01fff..793ec0b2d 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,12 @@ See [Documentation](https://grafana.com/docs/beyla/) and the [tutorials](https:/ enabled. BTF became enabled by default on most Linux distributions with kernel 5.14 or higher. You can check if your kernel has BTF enabled by verifying if `/sys/kernel/btf/vmlinux` exists on your system. If you need to recompile your kernel to enable BTF, the configuration option `CONFIG_DEBUG_INFO_BTF=y` must be - set. -- eBPF enabled on the host + set. +- Alternatively, RHEL 4.18 Linux kernels (at least build 348) are also supported, due to their heavily backported nature. +- eBPF enabled on the host. - For instrumenting Go programs, they must have been compiled with at least Go 1.17. We currently support Go applications built with a major **Go version no earlier than 3 versions** behind the current - stable major release. + stable major release. - Some level of elevated permissions to execute the instrumenter: - On host systems, running Beyla requires `sudo`. - For Kubernetes we have detailed configuration example on how to run with minimum diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 8815452c9..7d499dd23 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -45,6 +45,7 @@ Beyla offers the following features: You can check if your kernel has BTF enabled by verifying if `/sys/kernel/btf/vmlinux` exists on your system. If you need to recompile your kernel to enable BTF, the configuration option `CONFIG_DEBUG_INFO_BTF=y` must be set. +- Alternatively, RHEL 4.18 Linux kernels (at least build 348) are also supported, due to their heavily backported nature. - eBPF enabled in the host. - For instrumenting Go programs, they must have been compiled with at least Go 1.17. We currently support Go applications built with a major **Go version no earlier than 3 versions** behind the current