Skip to content

[AKS] Update network plugin defaults and long summary #31516

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
zhoxing-ms merged 1 commit into from
May 23, 2025
Merged

[AKS] Update network plugin defaults and long summary #31516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/azure-cli/azure/cli/command_modules/acs/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,13 +234,13 @@
- name: --network-plugin
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".
Copy link

Copilot AI May 21, 2025

Choose a reason for hiding this comment

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

[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".

Copilot uses AI. Check for mistakes.
- name: --network-plugin-mode
type: string
short-summary: The network plugin mode to use.
long-summary: |
Used to control the mode the network plugin should operate in. For example, "overlay" used with
--network-plugin=azure will use an overlay network (non-VNET IPs) for pods in the cluster.
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.
Comment on lines +242 to +243
Copy link

Copilot AI May 21, 2025

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
- name: --network-policy
type: string
short-summary: Network Policy Engine to use.
Expand Down