Add documentation for NetworkEgress

[phillebaba]

This documents the basics for using the new egress feature implemented in the operator.

netbirdio/kubernetes-operator#357

---

^{Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.}

Summary by CodeRabbit

• Documentation
  • Added guidance for using Kubernetes routing peers with NetworkEgress resources.
  • Documented targeting egress destinations by FQDN or IP address.
  • Added details about destination port handling and automatic Kubernetes service discovery.
  • Included a YAML example and expected HTTP request behavior.

[coderabbitai]

Warning

Review limit reached

@SunsetDrifter, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 16 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2a49ad1a-d0bb-43f1-ba3b-cb42199f2971

📥 Commits

Reviewing files that changed from the base of the PR and between 5d56798 and e370c7a.

📒 Files selected for processing (1)

• src/pages/use-cases/kubernetes/routing-peer.mdx

📝 Walkthrough

Walkthrough

The Kubernetes routing peer documentation now includes NetworkEgress guidance, covering target configuration, destination port rewriting, service discovery, a YAML example, and expected HTTP behavior.

Changes

Kubernetes egress documentation

Layer / File(s)	Summary
NetworkEgress routing peer guide src/pages/use-cases/kubernetes/routing-peer.mdx	Documents NetworkEgress targets, randomized destination ports, accompanying Kubernetes services, configuration examples, and expected HTTP requests.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: sunsetdrifter

Poem

A rabbit hops through routes anew,
With egress paths and services too.
YAML blooms beside the nginx door,
Requests now reach the peer’s far shore.
Hop, hop—docs guide the way!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: adding documentation for NetworkEgress.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/use-cases/kubernetes/routing-peer.mdx`:
- Around line 90-92: Correct the spelling and grammar in the network egress
documentation paragraph: change “a IP” to “an IP,” “rotuer” to “router,” “a
accompanying” to “an accompanying,” and “he target” to “the target.”
- Around line 90-92: Replace every occurrence of the internal-looking
prod.company.internal hostname in the routing-peer MDX example, including the
referenced lines, with the fictional placeholder example.com. Keep the hostname
usage and example behavior unchanged.
- Around line 92-112: Update the NetworkEgress example metadata.name from nginx
to a distinct name such as nginx-egress, avoiding conflict with the existing
Service/nginx; also update the subsequent HTTP request hostname to use the
generated egress Service name while preserving the namespace and cluster-local
format.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d9034298-abb5-49cb-889d-5a9de7fbda97

📥 Commits

Reviewing files that changed from the base of the PR and between 31f2b6c and 5d56798.

📒 Files selected for processing (1)

• src/pages/use-cases/kubernetes/routing-peer.mdx

[vercel]

@SunsetDrifter is attempting to deploy a commit to the NetBird GmbH Team on Vercel.

A member of the Team first needs to authorize it.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview	Aug 3, 2026 9:42am