|
1879 | 1879 | short-summary: List node pools in the managed Kubernetes cluster. |
1880 | 1880 | """ |
1881 | 1881 |
|
1882 | | -# TODO: Add params for blue green upgrade settings |
1883 | 1882 | helps['aks nodepool add'] = """ |
1884 | 1883 | type: command |
1885 | 1884 | short-summary: Add a node pool to the managed Kubernetes cluster. |
|
2074 | 2073 | - name: --localdns-config |
2075 | 2074 | type: string |
2076 | 2075 | short-summary: Set the localDNS Profile for a nodepool with a JSON config file. |
| 2076 | + - name: --upgrade-strategy |
| 2077 | + type: string |
| 2078 | + short-summary: Upgrade strategy for the node pool. Allowed values: "Rolling" or "BlueGreen". Default: "Rolling". |
| 2079 | + - name: --drain-batch-size |
| 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%. |
| 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 |
| 2084 | + - name: --drain-timeout-bg |
| 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. |
| 2088 | + - name: --batch-soak-duration |
| 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. |
| 2091 | + - name: --final-soak-duration |
| 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. |
2077 | 2094 | examples: |
2078 | 2095 | - name: Create a nodepool in an existing AKS cluster with ephemeral os enabled. |
2079 | 2096 | text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48 |
|
2095 | 2112 | text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --vm-set-type VirtualMachines --vm-sizes "Standard_D4s_v3,Standard_D8s_v3" --node-count 3 |
2096 | 2113 | - name: Create a nodepool with ManagedSystem mode |
2097 | 2114 | text: az aks nodepool add -g MyResourceGroup -n managedsystem1 --cluster-name MyManagedCluster --mode ManagedSystem |
| 2115 | + - name: Create a node pool with blue-green upgrade strategy and default parameters |
| 2116 | + text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --upgrade-strategy BlueGreen |
2098 | 2117 | """ |
2099 | 2118 |
|
2100 | 2119 | helps['aks nodepool scale'] = """ |
|
2149 | 2168 | - name: --undrainable-node-behavior |
2150 | 2169 | type: string |
2151 | 2170 | short-summary: Define the behavior for undrainable nodes during upgrade. The value should be "Cordon" or "Schedule". The default value is "Schedule". |
| 2171 | + - name: --upgrade-strategy |
| 2172 | + type: string |
| 2173 | + short-summary: Upgrade strategy for the node pool. Allowed values: "Rolling" or "BlueGreen". Default: "Rolling". |
| 2174 | + - name: --drain-batch-size |
| 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%. |
| 2177 | + long-summary: |- |
| 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 | + - name: --drain-timeout-bg |
| 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. |
| 2183 | + - name: --batch-soak-duration |
| 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. |
| 2186 | + - name: --final-soak-duration |
| 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. |
2152 | 2189 | """ |
2153 | 2190 |
|
2154 | 2191 | helps['aks nodepool update'] = """ |
|
2252 | 2289 | - name: --localdns-config |
2253 | 2290 | type: string |
2254 | 2291 | short-summary: Set the localDNS Profile for a nodepool with a JSON config file. |
| 2292 | + - name: --upgrade-strategy |
| 2293 | + type: string |
| 2294 | + short-summary: Upgrade strategy for the node pool. Allowed values: "Rolling" or "BlueGreen". Default: "Rolling". |
| 2295 | + - name: --drain-batch-size |
| 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%. |
| 2298 | + long-summary: |- |
| 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 | + - name: --drain-timeout-bg |
| 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. |
| 2304 | + - name: --batch-soak-duration |
| 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. |
| 2307 | + - name: --final-soak-duration |
| 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. |
2255 | 2310 | examples: |
2256 | 2311 | - name: Reconcile the nodepool back to its current state. |
2257 | 2312 | text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster |
|
2263 | 2318 | text: az aks nodepool update --update-cluster-autoscaler --min-count 1 --max-count 10 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster |
2264 | 2319 | - name: Change a node pool to system mode |
2265 | 2320 | text: az aks nodepool update --mode System -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster |
| 2321 | + - name: Update a node pool with blue-green upgrade settings |
| 2322 | + text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --drain-batch-size 50% --drain-timeout-bg 5 --batch-soak-duration 10 --final-soak-duration 10 |
2266 | 2323 | """ |
2267 | 2324 |
|
2268 | 2325 | helps['aks nodepool get-upgrades'] = """ |
|
0 commit comments