Skip to content

doc about use hostnetwork with 'useListenerPortAsContainerPort'#552

Open
woodgear wants to merge 1 commit intoalauda:masterfrom
woodgear:feat/ACP-50061
Open

doc about use hostnetwork with 'useListenerPortAsContainerPort'#552
woodgear wants to merge 1 commit intoalauda:masterfrom
woodgear:feat/ACP-50061

Conversation

@woodgear
Copy link
Collaborator

@woodgear woodgear commented Feb 11, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced Envoy Gateway networking configuration documentation with two distinct approaches for hostNetwork setup
    • Added detailed configuration examples and pros/cons for port offset versus direct privileged port usage
    • Updated port mapping behavior documentation and clarified DNS policy settings
    • Expanded access details and known limitations for each configuration approach

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

Walkthrough

Documentation update for Envoy Gateway hostNetwork configuration, introducing two distinct approaches: Port Offset (default, recommended) and Privileged Ports Direct usage. Includes detailed YAML examples, pros/cons analysis, configuration steps, and updated access patterns for each approach.

Changes

Cohort / File(s) Summary
Envoy Gateway Networking Docs
docs/en/configure/networking/how_to/tasks_for_envoy_gateway.mdx
Restructured hostNetwork configuration section into two approaches with expanded explanations: Approach 1 uses port offset (80→10080, 443→10443); Approach 2 enables useListenerPortAsContainerPort with NET_BIND_SERVICE capability. Added YAML patch examples, pros/cons analysis, DNS policy details, and nodeSelector configurations for each approach.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 Two paths now gleam, where once was one,
Port offset gentle, or privileges won,
YAML flows clear with Envoy's might,
Documentation blooms—a networking light! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title partially relates to the changeset—it mentions 'useListenerPortAsContainerPort' which is one configuration approach covered, but fails to convey that the primary change is documenting two distinct approaches for configuring hostNetwork with Envoy Gateway. Consider a more comprehensive title like 'Add documentation for hostNetwork configuration approaches with Envoy Gateway' to better reflect that both port offset and useListenerPortAsContainerPort approaches are equally important.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
docs/en/configure/networking/how_to/tasks_for_envoy_gateway.mdx (1)

341-344: Nit: "Slightly reduced security" could be more specific.

Consider clarifying that the reduced security is specifically about granting the NET_BIND_SERVICE Linux capability, which is relatively narrow in scope. This helps users make an informed decision rather than being vaguely concerned.

📝 Suggested wording
 **Cons:**
 - Requires NET_BIND_SERVICE capability
-- Slightly reduced security compared to port offset approach
+- Slightly reduced security compared to port offset approach (grants the NET_BIND_SERVICE Linux capability to the container)
 - More complex configuration

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant