Skip to content

Document README quickstart network requirements #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bcho merged 4 commits into from
Jun 30, 2026
Merged

Document README quickstart network requirements #212

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a5173e
Initial plan
Copilot Jun 29, 2026
04f93cf
Document quickstart network requirements
Copilot Jun 29, 2026
ad39107
Refine README network wording
Copilot Jun 29, 2026
82954da
Potential fix for pull request finding
bcho Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ AKS Flex Node extends Azure Kubernetes Service (AKS) to customer-managed virtual

Before you begin, [create or choose an existing AKS cluster](https://learn.microsoft.com/azure/aks/learn/quick-kubernetes-deploy-cli) and a virtual machine or bare metal host to join as a Flex Node. This example assumes a Linux workstation with Azure CLI, `kubectl`, `curl`, and `python3`. The target host must run systemd, allow root installation, and reach the AKS API server over outbound HTTPS. Use a VM size with enough CPU and memory for nspawn startup and Kubernetes components; the validated quickstart used a 4-vCPU Azure VM.

For the quickstart network, place the target host in a peered or otherwise routed network with non-overlapping CIDRs. The Flex host and AKS node private IPs must have bidirectional reachability, and any NSGs or firewalls must allow the CNI's cross-node traffic (often TCP/UDP between node private IPs, and sometimes pod CIDR ranges depending on the CNI) so pod networking works after the node joins. For private AKS clusters, also ensure the host can resolve and reach the private API endpoint. For advanced network scenarios such as cross-region, gateway, or custom CNI topologies, follow the [lab guides](docs/labs/README.md).

The flow below will:

1. Apply the node bootstrap RBAC bindings on the AKS cluster.
Expand Down
Loading