|
2075 | 2075 | short-summary: Set the localDNS Profile for a nodepool with a JSON config file. |
2076 | 2076 | - name: --upgrade-strategy |
2077 | 2077 | 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". |
2079 | 2079 | - name: --drain-batch-size |
2080 | 2080 | 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%. |
2082 | 2082 | 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 |
2084 | 2084 | - name: --drain-timeout-bg |
2085 | 2085 | 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. |
2088 | 2088 | - name: --batch-soak-duration |
2089 | 2089 | 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. |
2091 | 2091 | - name: --final-soak-duration |
2092 | 2092 | 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. |
2094 | 2094 | examples: |
2095 | 2095 | - name: Create a nodepool in an existing AKS cluster with ephemeral os enabled. |
2096 | 2096 | text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48 |
|
2170 | 2170 | short-summary: Define the behavior for undrainable nodes during upgrade. The value should be "Cordon" or "Schedule". The default value is "Schedule". |
2171 | 2171 | - name: --upgrade-strategy |
2172 | 2172 | 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". |
2174 | 2174 | - name: --drain-batch-size |
2175 | 2175 | 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%. |
2177 | 2177 | long-summary: |- |
2178 | 2178 | 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 |
2179 | 2179 | - name: --drain-timeout-bg |
2180 | 2180 | 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. |
2183 | 2183 | - name: --batch-soak-duration |
2184 | 2184 | 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. |
2186 | 2186 | - name: --final-soak-duration |
2187 | 2187 | 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. |
2189 | 2189 | """ |
2190 | 2190 |
|
2191 | 2191 | helps['aks nodepool update'] = """ |
|
2291 | 2291 | short-summary: Set the localDNS Profile for a nodepool with a JSON config file. |
2292 | 2292 | - name: --upgrade-strategy |
2293 | 2293 | 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". |
2295 | 2295 | - name: --drain-batch-size |
2296 | 2296 | 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%. |
2298 | 2298 | long-summary: |- |
2299 | 2299 | 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 |
2300 | 2300 | - name: --drain-timeout-bg |
2301 | 2301 | 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. |
2304 | 2304 | - name: --batch-soak-duration |
2305 | 2305 | 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. |
2307 | 2307 | - name: --final-soak-duration |
2308 | 2308 | 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. |
2310 | 2310 | examples: |
2311 | 2311 | - name: Reconcile the nodepool back to its current state. |
2312 | 2312 | text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster |
|
0 commit comments