Skip to content

[DOCS] Complete local debug and troubleshooting guide for KinD/Minikube setup #5

@Jean-Regis-M

Description

@Jean-Regis-M

Description

Running kernel tracing programs locally requires configuring custom volumes (e.g., /sys/kernel/debug), permissions (CAP_SYS_ADMIN), and mounting properties on target nodes. We want to publish a developer troubleshooting reference within our documentation directory showing how to quickly debug local setup blocks.

Proposed Scope

  1. Document diagnostic commands (e.g. mount | grep bpffs, checking if /sys/kernel/debug is populated).
  2. Detail how to check if local container frameworks run on virtualization platforms (such as WS2/WSL systems or macOS Docker mounts) that require additional translation setups.
  3. Deliver a 3-step checklist showing how to identify if the local kernel meets the BTF requirements (/sys/kernel/btf/vmlinux).

Expected Files to Modify

  • Create /sentinelml/docs/troubleshooting.md or extend README.md / CONTRIBUTING.md.

Verification Steps

  • Ensure all markdown tables and commands render cleanly in standard viewer parsers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions