Add a "Good practice" section

isovalent / ebpf-docs

An effort to comprehensively document eBPF

https://ebpf-docs.dylanreimerink.nl/

BSD 2-Clause "Simplified" License

177 stars 18 forks source link

Add a "Good practice" section #8

Open ScriptSathi opened 6 months ago

ScriptSathi commented 6 months ago

Hello ! Thanks a lot for this documentation journey

I think it could be awesome to have a dedicated page(s) about all the good practices on developping eBPF programs.

For exemple :

Compilation good practice (the Tetragon way using clang or bpf2go
Tailcall usage (like handling recursivity if possible)
What's the best way to deal with vmlinux file or libbpf in a project

dylandreimerink commented 6 months ago

I would love to have that, but how do we actually derive these good practices? Normally these are the product of lots of opinions and then picking out the common wisdom. Can we come up with some sort of plan so this page doesn't get an edit war over time?

ScriptSathi commented 6 months ago

I have no idea how it is usually done, but I believe there is two (not too hardcore) way of doing that.

Isovalent or any major eBPF company suggest its own good practices definition and let it open to suggestion by the community to initiate this.
Let any member of the community write something about one single good practice for him and why (for exemple : eBPF program architectural best practices), based on their experience. Then submit it for debate. (using discussion tab maybe ?)