Skip to content

Commit 3fbaf26

Browse files
committed
chore: tidy up az aks nodepool help summaries
1 parent ba23d62 commit 3fbaf26

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

  • src/aks-preview/azext_aks_preview

src/aks-preview/azext_aks_preview/_help.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2075,22 +2075,22 @@
20752075
short-summary: Set the localDNS Profile for a nodepool with a JSON config file.
20762076
- name: --upgrade-strategy
20772077
type: string
2078-
short-summary: Upgrade strategy for the node pool. Allowed values: "Rolling" or "BlueGreen". Default: "Rolling".
2078+
short-summary: Upgrade strategy for the node pool. Allowed values are "Rolling" or "BlueGreen". Default is "Rolling".
20792079
- name: --drain-batch-size
20802080
type: string
2081-
short-summary: Number or percentage of nodes to drain per batch during blue-green upgrades. Accepts an integer (e.g. '5') or percentage (e.g. '50%'). Default: 10%.
2081+
short-summary: Number or percentage of nodes to drain per batch during blue-green upgrades. Accepts an integer (e.g. '5') or percentage (e.g. '50%'). Default is 10%.
20822082
long-summary: |-
2083-
Specifies how many nodes to drain in each batch during a blue-green upgrade. Must be a non-zero value, either as an integer (e.g. '5') or a percentage (e.g. '50%') of the total blue nodes at the start of the upgrade. Fractional nodes are rounded up. For more details and best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
2083+
Specifies how many nodes to drain in each batch during a blue-green upgrade. Must be a non-zero value, either as an integer (e.g. '5') or a percentage (e.g. '50%') of the total blue nodes at the start of the upgrade. Fractional nodes are rounded up. For more details and best practices, see https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
20842084
- name: --drain-timeout-bg
20852085
type: int
2086-
short-summary: Timeout (in minutes) to evict pods and gracefully terminate per node during blue-green upgrades. Default: 30 minutes.
2087-
long-summary: Maximum time (in minutes) to wait for pod eviction and graceful termination per node during blue-green upgrades. Honors pod disruption budgets. If exceeded, the upgrade fails. Default: 30 minutes.
2086+
short-summary: Timeout (in minutes) to evict pods and gracefully terminate per node during blue-green upgrades. Default is 30 minutes.
2087+
long-summary: Maximum time (in minutes) to wait for pod eviction and graceful termination per node during blue-green upgrades. Honors pod disruption budgets. If exceeded, the upgrade fails. Default is 30 minutes.
20882088
- name: --batch-soak-duration
20892089
type: int
2090-
short-summary: Wait time (in minutes) after draining a batch of nodes before proceeding to the next batch. Default: 15 minutes. Only for blue-green upgrades.
2090+
short-summary: Wait time (in minutes) after draining a batch of nodes before proceeding to the next batch. Default is 15 minutes. Only for blue-green upgrades.
20912091
- name: --final-soak-duration
20922092
type: int
2093-
short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default: 60 minutes. Only for blue-green upgrades.
2093+
short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default is 60 minutes. Only for blue-green upgrades.
20942094
examples:
20952095
- name: Create a nodepool in an existing AKS cluster with ephemeral os enabled.
20962096
text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48
@@ -2170,22 +2170,22 @@
21702170
short-summary: Define the behavior for undrainable nodes during upgrade. The value should be "Cordon" or "Schedule". The default value is "Schedule".
21712171
- name: --upgrade-strategy
21722172
type: string
2173-
short-summary: Upgrade strategy for the node pool. Allowed values: "Rolling" or "BlueGreen". Default: "Rolling".
2173+
short-summary: Upgrade strategy for the node pool. Allowed values are "Rolling" or "BlueGreen". Default is "Rolling".
21742174
- name: --drain-batch-size
21752175
type: string
2176-
short-summary: Number or percentage of nodes to drain per batch during blue-green upgrades. Accepts an integer (e.g. '5') or percentage (e.g. '50%'). Default: 10%.
2176+
short-summary: Number or percentage of nodes to drain per batch during blue-green upgrades. Accepts an integer (e.g. '5') or percentage (e.g. '50%'). Default is 10%.
21772177
long-summary: |-
21782178
Specifies how many nodes to drain in each batch during a blue-green upgrade. Must be a non-zero value, either as an integer (e.g. '5') or a percentage (e.g. '50%') of the total blue nodes at the start of the upgrade. Fractional nodes are rounded up. For more details and best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
21792179
- name: --drain-timeout-bg
21802180
type: int
2181-
short-summary: Timeout (in minutes) to evict pods and gracefully terminate per node during blue-green upgrades. Default: 30 minutes.
2182-
long-summary: Maximum time (in minutes) to wait for pod eviction and graceful termination per node during blue-green upgrades. Honors pod disruption budgets. If exceeded, the upgrade fails. Default: 30 minutes.
2181+
short-summary: Timeout (in minutes) to evict pods and gracefully terminate per node during blue-green upgrades. Default is 30 minutes.
2182+
long-summary: Maximum time (in minutes) to wait for pod eviction and graceful termination per node during blue-green upgrades. Honors pod disruption budgets. If exceeded, the upgrade fails. Default is 30 minutes.
21832183
- name: --batch-soak-duration
21842184
type: int
2185-
short-summary: Wait time (in minutes) after draining a batch of nodes before proceeding to the next batch. Default: 15 minutes. Only for blue-green upgrades.
2185+
short-summary: Wait time (in minutes) after draining a batch of nodes before proceeding to the next batch. Default is 15 minutes. Only for blue-green upgrades.
21862186
- name: --final-soak-duration
21872187
type: int
2188-
short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default: 60 minutes. Only for blue-green upgrades.
2188+
short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default is 60 minutes. Only for blue-green upgrades.
21892189
"""
21902190

21912191
helps['aks nodepool update'] = """
@@ -2291,22 +2291,22 @@
22912291
short-summary: Set the localDNS Profile for a nodepool with a JSON config file.
22922292
- name: --upgrade-strategy
22932293
type: string
2294-
short-summary: Upgrade strategy for the node pool. Allowed values: "Rolling" or "BlueGreen". Default: "Rolling".
2294+
short-summary: Upgrade strategy for the node pool. Allowed values are "Rolling" or "BlueGreen". Default is "Rolling".
22952295
- name: --drain-batch-size
22962296
type: string
2297-
short-summary: Number or percentage of nodes to drain per batch during blue-green upgrades. Accepts an integer (e.g. '5') or percentage (e.g. '50%'). Default: 10%.
2297+
short-summary: Number or percentage of nodes to drain per batch during blue-green upgrades. Accepts an integer (e.g. '5') or percentage (e.g. '50%'). Default is 10%.
22982298
long-summary: |-
22992299
Specifies how many nodes to drain in each batch during a blue-green upgrade. Must be a non-zero value, either as an integer (e.g. '5') or a percentage (e.g. '50%') of the total blue nodes at the start of the upgrade. Fractional nodes are rounded up. For more details and best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
23002300
- name: --drain-timeout-bg
23012301
type: int
2302-
short-summary: Timeout (in minutes) to evict pods and gracefully terminate per node during blue-green upgrades. Default: 30 minutes.
2303-
long-summary: Maximum time (in minutes) to wait for pod eviction and graceful termination per node during blue-green upgrades. Honors pod disruption budgets. If exceeded, the upgrade fails. Default: 30 minutes.
2302+
short-summary: Timeout (in minutes) to evict pods and gracefully terminate per node during blue-green upgrades. Default is 30 minutes.
2303+
long-summary: Maximum time (in minutes) to wait for pod eviction and graceful termination per node during blue-green upgrades. Honors pod disruption budgets. If exceeded, the upgrade fails. Default is 30 minutes.
23042304
- name: --batch-soak-duration
23052305
type: int
2306-
short-summary: Wait time (in minutes) after draining a batch of nodes before proceeding to the next batch. Default: 15 minutes. Only for blue-green upgrades.
2306+
short-summary: Wait time (in minutes) after draining a batch of nodes before proceeding to the next batch. Default is 15 minutes. Only for blue-green upgrades.
23072307
- name: --final-soak-duration
23082308
type: int
2309-
short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default: 60 minutes. Only for blue-green upgrades.
2309+
short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default is 60 minutes. Only for blue-green upgrades.
23102310
examples:
23112311
- name: Reconcile the nodepool back to its current state.
23122312
text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster

0 commit comments

Comments
 (0)