docs(observability): Add tutorial for IP option tracing#43961
docs(observability): Add tutorial for IP option tracing#43961joestringer merged 1 commit intocilium:mainfrom
Conversation
3fd1b84 to
019ede8
Compare
joestringer
left a comment
There was a problem hiding this comment.
Thanks for putting this together! I reviewed the content but didn't get a chance to try it out. The guide makes sense to me though, so the feedback is mainly just about ensuring consistency with other docs and how we keep these docs maintainable into the future.
019ede8 to
2ce468f
Compare
2ce468f to
3ee4b99
Compare
joestringer
left a comment
There was a problem hiding this comment.
Thanks, a few more changes are necessary but this is getting simpler and easier for users - great sign.
0533df5 to
2284999
Compare
This commit adds a new tutorial documenting how to configure and use the Generic IP Options packet tracing feature. The tutorial covers: - Configuring `bpf.monitorTraceIPOption` via Helm in a Kind environment. - Manually verifying the feature using `nping` to inject valid 2-byte Trace IDs. - Observing extracted Trace IDs using `cilium monitor` - Filtering flows by Trace ID using the `hubble observe --ip-trace-id` command. - Documentation of current BPF limitations regarding strict payload lengths (2, 4, or 8 bytes). Signed-off-by: Ben Bigdelle <bigdelle@google.com>
2284999 to
08b6aad
Compare
There was a problem hiding this comment.
Thanks, LGTM from a docs perspective and I was also able to try out the feature locally. Nice work, cool feature ❤️
For testing I had to substitute the install command from the version previewed from Netlify, but that's to be expected with how the cilium-helm-install Sphinx helper works today on main.
helm install cilium/cilium --version v1.19.0-rc.0 ...
| .. code-block:: shell-session | ||
|
|
||
| cd hubble | ||
| make hubble | ||
| cilium hubble port-forward & | ||
|
|
||
| #. Filter by Trace ID | ||
|
|
||
| Filter specifically for the injected ID ``13345`` (hex ``0x3421``): | ||
|
|
||
| .. code-block:: shell-session | ||
|
|
||
| ./hubble observe -f --ip-trace-id 13345 |
There was a problem hiding this comment.
Probably once we get the v1.19.0 release out and get a new Hubble v1.19.0 binary released, it'll make sense to come back to these instructions to update them to use the official binary. IIRC we wait until after the Cilium v1.19 release to create the Hubble CLI so maybe let's coordinate on that front with @cilium/sig-hubble .
|
/test |
Description:
This PR adds a tutorial for the IP Options packet tracing (#41306) feature landing in v1.19.
This guide provides a deterministic reproduction case to validate that Cilium is correctly extracting metadata from packet headers. It bridges the gap between feature implementation and user validation.
Key additions:
kindbased environment with the feature flag enabled.npingto inject IP options.cilium monitorto view the flow messages with the IP trace ID.