Skip to content

[Magic Transit] Use RFC 5737 prefixes in route examples - #33407

Open
SomSamantray wants to merge 2 commits into
cloudflare:productionfrom
SomSamantray:docs/magic-transit-rfc5737-prefixes
Open

SomSamantray wants to merge 2 commits into
cloudflare:productionfrom
SomSamantray:docs/magic-transit-rfc5737-prefixes

Conversation

@SomSamantray

Copy link
Copy Markdown
Contributor

Summary

Five Magic Transit pages used non-reserved addresses as placeholders for a customer's onboarded or advertised prefix. Magic Transit routes public prefixes only, and the style guide already mandates the RFC 5737 blocks for IPv4 examples, so the examples were both impossible as written and inconsistent with the rest of the docs.

Two kinds of placeholder were wrong: RFC 1918 private addresses, and — on two pages — subnets of Cloudflare's own published 103.21.244.0/22 range presented as if they were a customer's prefixes. Both now use reserved documentation space. reference/traffic-steering.mdx already carried an Aside stating that these blocks are reserved for documentation examples, so this change makes that page consistent with its own note.

The bandwidth-measurement example keeps its Longest Prefix Match shape. RFC 5737 reserves only /24 blocks, so its covering prefix and the more-specific ISP route become 203.0.113.0/24 and 203.0.113.128/25, and the prose reference to the covering /20 becomes /24.

Addresses that are factual references to real infrastructure are deliberately unchanged — Cloudflare's tunnel health-check source range, tunnel-interface addresses, documented CGNAT space, and a captured traceroute's hops would all become untrue if converted.

One non-reserved prefix is deliberately left alone: the /24-into-/23 summarization example at reference/traffic-steering.mdx:225-228 uses 192.0.3.0/24. RFC 5737's three blocks are not contiguous, so no reserved-space pair can be summarized into a /23, and the same page documents a /24 minimum advertising prefix, which rules out a sub-/24 rewrite. Removing it means reshaping the example, which is a separate editorial change. The Aside just below that example also claims RFC 5737 coverage for 192.0.3.0/24, which is inaccurate.

Fixes #31625

Documentation checklist

  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 29a9fb9.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use RFC Documentation Prefixes for all examples

4 participants