Document README quickstart network requirements#212
Merged
Conversation
Copilot
AI
changed the title
[WIP] Update README to include network requirements for node connectivity
Document README quickstart network requirements
Jun 29, 2026
bcho
requested changes
Jun 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Getting Started quickstart in README.md to explicitly document baseline networking requirements for successfully joining and operating a Flex Node, and to route more complex/private topologies to the labs documentation.
Changes:
- Adds quickstart prerequisites around routed/peered networks, non-overlapping CIDRs, and bidirectional private IP reachability.
- Calls out NSG/firewall requirements for node-to-node (cross-node) traffic needed for pod networking post-join.
- Notes private AKS DNS/API endpoint reachability and points advanced scenarios to the lab guides.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
bcho
approved these changes
Jun 29, 2026
wenxuan0923
approved these changes
Jun 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Getting Started flow did not call out the minimum networking needed for Flex Node traffic after join. This clarifies the baseline topology and points advanced setups to the lab docs.
Quickstart requirements
Private and advanced topologies