Add prerequisites to lab documentation#192
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Add prerequisites to lab docs for environment setup
Add prerequisites to lab documentation
Jun 11, 2026
bcho
approved these changes
Jun 11, 2026
wenxuan0923
approved these changes
Jun 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the usability of the AKS Flex Node hands-on labs by making required Azure access, tooling, and networking assumptions explicit up front, reducing the chance users discover missing prerequisites mid-lab.
Changes:
- Added a shared “Common Prerequisites” section to the lab index covering subscription permissions, required tools, CIDR planning, and AKS API reachability.
- Expanded the GPU lab “Before you begin” section with Azure CLI + workstation tooling and network planning requirements.
- Added dedicated prerequisites sections for the private AKS Cilium and unbounded-net labs, including private API access expectations and Flex VM assumptions.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/labs/README.md | Adds shared prerequisites guidance before the lab list. |
| docs/labs/gpu-node-setup.md | Expands “Before you begin” to include subscription/tooling/network prerequisites. |
| docs/labs/aks-private-cluster-unbounded-net.md | Adds a prerequisites section tailored to private AKS + unbounded-net flows. |
| docs/labs/aks-private-cluster-cilium.md | Adds a prerequisites section tailored to private AKS + unmanaged Cilium flows. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+11
to
+13
| - `kubectl`, Helm, `curl`, and SSH/SCP tooling on the workstation or admin VM that will run the lab commands. | ||
| - Non-overlapping CIDR ranges for the AKS VNet, Flex VM VNet, pod networks, service CIDR, and any connected networks. | ||
| - Network access from the command runner and Flex VM to the AKS API server. For private AKS labs, run `kubectl`, Helm, and bootstrap config commands from a machine that can resolve and reach the private API endpoint. |
| - A GPU host with root access and outbound reach to the AKS API server. | ||
| - An Azure subscription and AKS cluster with `kubectl` admin access. | ||
| - Azure CLI logged in to the target subscription. | ||
| - `kubectl`, Helm, `curl`, and SSH/SCP tooling on your workstation. |
|
|
||
| - An Azure subscription where you can create resource groups, VNets, VMs, a private AKS cluster, private DNS links, and the bootstrap RBAC needed by AKS Flex Node. | ||
| - Azure CLI logged in to the target subscription. | ||
| - `kubectl`, Helm, `curl`, `python3`, and SSH/SCP tooling on the workstation or admin VM that will run the lab commands. |
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 lab docs did not clearly state the Azure access, tooling, network, and VM assumptions needed before starting. This adds prerequisite guidance up front so users can prepare the environment before running lab steps.
Lab index
GPU lab
Private AKS labs