[AKS] Update network plugin defaults and long summary#31516
Merged
zhoxing-ms merged 1 commit intoAzure:devfrom May 23, 2025
Merged
[AKS] Update network plugin defaults and long summary#31516zhoxing-ms merged 1 commit intoAzure:devfrom
zhoxing-ms merged 1 commit intoAzure:devfrom
Conversation
Signed-off-by: Sam Foo <samfoo@microsoft.com>
sf-msft
requested review from
FumingZhang,
jsntcy,
yanzhudd and
zhoxing-ms
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @sf-msft, |
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
requested review from
AllyW,
kairu-ms,
necusjz and
yonzhan
microsoft-github-policy-service
bot
added
the
Network
Contributor
There was a problem hiding this comment.
Pull Request Overview
Updates the AKS help text for network plugin settings in az aks create to reflect that Azure CNI is now the default and to clarify mode behavior.
- Change
--network-pluginlong-summary to show default is now "azure" and adjust wording. - Revise
--network-plugin-modelong-summary to note default and pod IP assignment details.
| type: string | ||
| short-summary: The Kubernetes network plugin to use. | ||
| long-summary: Specify "azure" for routable pod IPs from VNET, "kubenet" for non-routable pod IPs with an overlay network, or "none" for no networking configured. Defaults to "kubenet". | ||
| long-summary: Specify "azure" for highly scalable networking, "kubenet" for IP assignment from subnet NAT-based routing, or "none" for no networking configured. Defaults to "azure". |
There was a problem hiding this comment.
[nitpick] The phrase "highly scalable networking" is vague in this context. Consider replacing it with a more descriptive explanation, for example: "Specify "azure" to use Azure CNI (pod IPs assigned directly from the VNet), "kubenet" for NAT-based routing from the subnet, or "none" for no networking. Defaults to "azure"."
Suggested change
| long-summary: Specify "azure" for highly scalable networking, "kubenet" for IP assignment from subnet NAT-based routing, or "none" for no networking configured. Defaults to "azure". | |
| long-summary: Specify "azure" to use Azure CNI (pod IPs assigned directly from the VNet), "kubenet" for NAT-based routing from the subnet, or "none" for no networking configured. Defaults to "azure". |
Comment on lines
+242
to
+243
| Used to control the mode the network plugin should operate in. Defaults to "overlay". If not specified with "azure" as | ||
| network plugin, pods are given routable IPs from VNET. |
There was a problem hiding this comment.
This sentence is unclear and potentially inaccurate. --network-plugin-mode only applies to the Azure plugin; pods with the kubenet plugin always receive non-routable IPs through NAT. Consider clarifying: "Only applies when --network-plugin=azure. With azure, defaults to overlay mode (an overlay network); with kubenet, pods always use NAT-based routing."
Suggested change
| Used to control the mode the network plugin should operate in. Defaults to "overlay". If not specified with "azure" as | |
| network plugin, pods are given routable IPs from VNET. | |
| Only applies when `--network-plugin=azure`. Used to control the mode the network plugin should operate in. Defaults to "overlay" mode (an overlay network). | |
| With `--network-plugin=azure`, pods are given routable IPs from the VNET. With `--network-plugin=kubenet`, pods always use NAT-based routing and receive non-routable IPs. |
Member
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
zhoxing-ms
approved these changes
May 23, 2025
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.
Related command
az aks createDescription
xref: Azure/AKS#4897
Fixed help text inaccuracies with defaults and updated longer summary text to reflect current CNI options
Testing Guide
--network-pluginno longer defaults to kubenetHistory Notes
[AKS]
--network-plugin: Update longer summary to show "azure" is default instead of kubenetThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.