docs(network): Document compute-node port allocation ranges#205
Conversation
Clarify the 10000-19999 / 20000-29999 / 30000-65535 split between network-agent ip_local_port_range, CubeProxy sandbox access, and CubeVS SNAT, in both zh and en network docs. Note that these port ranges are not configurable for now but should work for most use cases. We can revise this later. Signed-off-by: Hengqi Chen <hengqi.chen@gmail.com>
|
cc @fslongjin |
|
Claude finished @chenhengqi's task in 2m 13s —— View job PR Review: docs(network): Document compute-node port allocation ranges
DCO CheckPASS — The commit Review SummaryThis PR adds a new section 6.4 to both the English and Chinese network architecture docs, documenting the three-way port range partition on compute nodes. The addition is clean, well-placed, and the two language versions are consistent. Detailed FeedbackConsistency between EN and ZH: The two versions are well-aligned. The port ranges, purposes, and allocators match exactly across both files. Section numbering: Section 6.4 fits naturally after 6.3 (Management) within the Port Mapping section. Good placement. Minor observations (non-blocking):
Overall: This is a clear, well-structured documentation addition. No bugs, security issues, or performance concerns (docs-only change). The information is valuable for operators and developers working with the networking stack. |
| | Port range | Purpose | Allocator | | ||
| |------------|---------|-----------| | ||
| | `10000`--`19999` | `ip_local_port_range` (host ephemeral ports) | Set by network-agent at startup | |
There was a problem hiding this comment.
Nit: Consider adding a brief cross-reference to §6.3 here. The AddPortMapping() API from §6.3 allocates host ports from the 20000–29999 range documented in this row. A small note like "see §6.3 Management for the API" would help readers connect the allocation range to the API that consumes it.
| | 端口范围 | 用途 | 分配者 | | ||
| |----------|------|--------| | ||
| | `10000`--`19999` | `ip_local_port_range`(宿主机临时端口) | 由 network-agent 启动时修改 | | ||
| | `20000`--`29999` | CubeProxy 访问沙箱所用的端口范围 | 由 network-agent 在创建沙箱时分配 | |
There was a problem hiding this comment.
与英文版建议一致:可考虑在此处添加对 §6.3 管理的交叉引用,说明 AddPortMapping() 所分配的宿主端口即来自 20000–29999 这一范围。
Clarify the 10000-19999 / 20000-29999 / 30000-65535 split between network-agent ip_local_port_range, CubeProxy sandbox access, and CubeVS SNAT, in both zh and en network docs.
Note that these port ranges are not configurable for now but should work for most use cases. We can revise this later.