Skip to content

fix(docs): Add route overlap note for aws peering - #560

Open
moredure wants to merge 3 commits into
mainfrom
add-route-override-warning
Open

moredure wants to merge 3 commits into
mainfrom
add-route-override-warning

Conversation

@moredure

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Aug 27, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
documentation Ready Ready Preview Oct 15, 2026 12:06pm UTC

Request Review

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document AWS peering route precedence risks

🐞 Bug fix 📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Warns that more-specific AWS routes override broader Dragonfly Cloud peering routes.
• Adds an overlap example and route-table checks to prevent silent connectivity failures.
Diagram

graph TD
  Traffic["VPC Traffic"] --> Routes["AWS Route Table"] --> Match{"More-specific match?"}
  Match -->|No| Peering["Peering Route"] --> Cloud["Dragonfly Cloud"]
  Match -->|Yes| Alternate["Alternate Target"]
Loading
High-Level Assessment

An inline warning beside the AWS route setup steps is the appropriate approach because reviewers and users encounter the risk at the exact configuration point. A separate troubleshooting page would make this critical prerequisite easier to miss.

Files changed (1) +18 / -0

Documentation (1) +18 / -0
connections.mdWarn about AWS route overlap during peering setup +18/-0

Warn about AWS route overlap during peering setup

• Adds an AWS peering warning explaining longest-prefix-match behavior and how overlapping, more-specific routes can silently redirect traffic. Provides a concrete CIDR example and instructs users to inspect associated subnet route tables before adding the peering route.

docs/cloud/connections.md

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Aug 27, 2026 •

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX issues (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. Valid alternate routes misclassified ✓ Resolved
Description
The warning claims any more-specific route to a different target breaks connectivity, but
longest-prefix matching only proves that traffic bypasses the peering route; a transit gateway or
another connection may intentionally provide a valid path to the destination. This blanket
prohibition can make users remove a working alternate route even when the data store remains
reachable through it.
Code

docs/cloud/connections.md[R64-65]

+would be sent to that route instead of the AWS peering connection, causing the data store to become unreachable
+from those subnets.
Evidence
The added example itself establishes only that traffic is sent to the alternate target instead of
the peering connection, then makes the unsupported leap that the data store is therefore
unreachable. It explicitly lists transit and other peering gateways as alternate targets, while the
surrounding setup scopes the direct peering route to subnets that require that route.

docs/cloud/connections.md[61-65]
docs/cloud/connections.md[45-49]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The warning equates bypassing the AWS peering route with loss of connectivity, although a more-specific route can intentionally reach the destination through another target.
## Issue Context
Longest-prefix matching establishes which route wins, not whether the winning target provides connectivity. Describe the route as conflicting only when its target does not provide the intended valid path, and avoid stating that every alternate target makes the data store unreachable.
## Fix Focus Areas
- docs/cloud/connections.md[57-68]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Tip of the day
💡 Did you know, you can hide the parts of a finding you never read, like the evidence or the agent prompt

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

Comment thread docs/cloud/connections.md Outdated
@ashotland

Copy link
Copy Markdown
Contributor

maybe just point to the explanation about overlapping CIDRs here
https://www.dragonflydb.io/docs/cloud/networks

@moredure

moredure commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

@ashotland sounds reasonable, I'll fix it

Copilot AI balanced review requested due to automatic review settings October 12, 2026 08:57
@moredure
moredure requested a review from ashotland October 12, 2026 09:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The warning conflates CIDR overlap with route precedence and does not explain how more-specific AWS routes override the peering route.

1 open finding
What changed in this PR

Adds AWS peering guidance about CIDR conflicts and route overrides.

Changes:

  • Adds a warning about overlapping CIDRs and more-specific routes.
  • Links to existing private-network guidance.
File Description
docs/​cloud/​connections.md Adds AWS peering connectivity warning.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/cloud/connections.md Outdated
@moredure moredure changed the title fix(docs): Add route override note for aws peering fix(docs): Add route overlap note for aws peering Oct 15, 2026
@moredure
moredure requested a balanced review from Copilot October 15, 2026 12:04
Clarify CIDR overlap requirements and AWS route table considerations for Dragonfly Cloud connectivity.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Mykhailo Faraponov <11322032+moredure@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation-only change is technically accurate, links to existing guidance, and has no unresolved findings.

0 open findings

1 resolved since last review

🧠 Review effort: Balanced

This branch was successfully deployed

1 active deployment
Preview — b86868aa Deployed Oct 15, 2026 by vercel[bot]
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.

4 participants