Skip to content

Commit 584f458

Browse files
committed
minor instruction update to AGENTS.md
1 parent 8346fb2 commit 584f458

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,24 @@ This repository is a Rust workspace for a network flow extractor. The main crate
77
- `xtask`: helper commands for building and running the project
88
- `ebpf-ipv4` / `ebpf-ipv6`: Linux eBPF programs used for realtime capture
99

10+
## Platform Notes
11+
12+
- Realtime eBPF support is Linux-specific.
13+
- Linux is the source of truth for build, runtime, and performance validation.
14+
- Do not assume that successful non-Linux builds imply realtime correctness.
15+
- When touching `aya`/eBPF/realtime code, prefer validating on Linux.
16+
17+
## Local Test Network
18+
19+
- The primary dedicated software-path test setup is local to `rgbcore`.
20+
- A persistent veth pair is available for RustiFlow testing:
21+
- host namespace capture side: `rustiflow-t0`
22+
- peer namespace side: `rustiflow-p0`
23+
- peer namespace: `rustiflow-peer`
24+
- addressing: `10.203.0.1/30` on `rustiflow-t0`, `10.203.0.2/30` on `rustiflow-p0`
25+
- This setup is intended to stress the RustiFlow software path without depending on the physical LAN.
26+
- Treat it as a high-throughput local test harness, not as a substitute for true physical wire-rate validation.
27+
1028
## Remote Machine Guardrails
1129

1230
- Remote Linux machines reachable over SSH may be used only for this RustiFlow project.
@@ -61,13 +79,6 @@ This repository is a Rust workspace for a network flow extractor. The main crate
6179
- one exporter only
6280
- If you change contamination-free exports, keep in mind that these outputs intentionally avoid raw identifiers such as exact ports/IPs.
6381

64-
## Platform Notes
65-
66-
- Realtime eBPF support is Linux-specific.
67-
- macOS may be usable for some read-only work, formatting, and limited code inspection, but Linux is the source of truth for full build and runtime validation.
68-
- Do not assume that successful macOS builds imply realtime correctness.
69-
- When touching `aya`/eBPF/realtime code, prefer validating on Linux or in a Linux container/VM.
70-
7182
## Commands
7283

7384
Use the smallest command that gives confidence:

0 commit comments

Comments
 (0)