|
794 | 794 | Provides scaled and performance-guaranteed control plane capacity for AKS clusters. |
795 | 795 | Enables customers to select a control plane scaling size that delivers higher API server throughput, |
796 | 796 | increased etcd capacity, and faster pod scheduling rates. Available values are 'H2', 'H4', and 'H8'. |
| 797 | + - name: --enable-upgrade-gate |
| 798 | + type: bool |
| 799 | + short-summary: Enable upgrade gate for the cluster. Agent pool upgrades wait for health signal validation and abort if unhealthy signals are observed. |
| 800 | + long-summary: This is a cluster-wide opt-in that applies to all agent pools in the cluster; an agent pool cannot opt out of it. Health signals are HealthSignal custom resources published by monitoring components running in the cluster. Force upgrade (--enable-force-upgrade) overrides the gate. For more information, see https://aka.ms/aks/upgrade-gate. |
797 | 801 | examples: |
| 802 | + - name: Create a kubernetes cluster with upgrade gate enabled. |
| 803 | + text: az aks create -g MyResourceGroup -n MyManagedCluster --enable-upgrade-gate |
798 | 804 | - name: Create a Kubernetes cluster with an existing SSH public key. |
799 | 805 | text: az aks create -g MyResourceGroup -n MyManagedCluster --ssh-key-value /path/to/publickey |
800 | 806 | - name: Create a Kubernetes cluster with a specific version. |
|
1120 | 1126 | - name: --upgrade-override-until |
1121 | 1127 | type: string |
1122 | 1128 | short-summary: Until when the cluster upgradeSettings overrides are effective. It needs to be in a valid date-time format that's within the next 30 days. For example, 2023-04-01T13:00:00Z. Note that if --force-upgrade is set to true and --upgrade-override-until is not set, by default it will be set to 3 days from now. |
| 1129 | + - name: --enable-upgrade-gate |
| 1130 | + type: bool |
| 1131 | + short-summary: Enable upgrade gate for the cluster. Agent pool upgrades wait for health signal validation and abort if unhealthy signals are observed. |
| 1132 | + long-summary: This is a cluster-wide opt-in that applies to all agent pools in the cluster; an agent pool cannot opt out of it. Health signals are HealthSignal custom resources published by monitoring components running in the cluster. Force upgrade (--enable-force-upgrade) overrides the gate. For more information, see https://aka.ms/aks/upgrade-gate. |
| 1133 | + - name: --disable-upgrade-gate |
| 1134 | + type: bool |
| 1135 | + short-summary: Disable upgrade gate for the cluster. |
| 1136 | + long-summary: Agent pools that explicitly enabled upgrade gate keep their own setting and remain gated. |
1123 | 1137 | - name: --enable-managed-identity |
1124 | 1138 | type: bool |
1125 | 1139 | short-summary: Update current cluster to managed identity to manage cluster resource group. |
|
1655 | 1669 | examples: |
1656 | 1670 | - name: Reconcile the cluster back to its current state. |
1657 | 1671 | text: az aks update -g MyResourceGroup -n MyManagedCluster |
| 1672 | + - name: Enable upgrade gate for a kubernetes cluster. |
| 1673 | + text: az aks update -g MyResourceGroup -n MyManagedCluster --enable-upgrade-gate |
1658 | 1674 | - name: Enable cluster-autoscaler within node count range [1,5] |
1659 | 1675 | text: az aks update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n MyManagedCluster |
1660 | 1676 | - name: Disable cluster-autoscaler for an existing cluster |
|
2701 | 2717 | - name: --final-soak-duration |
2702 | 2718 | type: int |
2703 | 2719 | short-summary: Wait time (in minutes) after all old nodes are drained before removing them. Default is 60 minutes. Only for blue-green upgrades. |
| 2720 | + - name: --enable-upgrade-gate |
| 2721 | + type: bool |
| 2722 | + short-summary: Enable upgrade gate for the node pool. Upgrades of this node pool wait for health signal validation and abort if unhealthy signals are observed. |
| 2723 | + long-summary: When the cluster-level upgrade gate is enabled, a new node pool inherits it by default. Health signals are HealthSignal custom resources published by monitoring components running in the cluster. Force upgrade (--enable-force-upgrade) overrides the gate. For more information, see https://aka.ms/aks/upgrade-gate. |
| 2724 | + - name: --disable-upgrade-gate |
| 2725 | + type: bool |
| 2726 | + short-summary: Disable upgrade gate for the node pool. |
| 2727 | + long-summary: Rejected by the service when the cluster-level upgrade gate is enabled, since a node pool cannot opt out of a cluster-wide opt-in. |
2704 | 2728 | examples: |
2705 | 2729 | - name: Create a nodepool in an existing AKS cluster with ephemeral os enabled. |
2706 | 2730 | text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --node-osdisk-type Ephemeral --node-osdisk-size 48 |
|
2728 | 2752 | text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --upgrade-strategy BlueGreen |
2729 | 2753 | - name: Create a node pool with an ordered mixed MIG profile layout |
2730 | 2754 | text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-managed-gpu --gpu-mig-strategy Mixed --gpu-mig-profiles MIG1g MIG2g MIG2g MIG2g |
| 2755 | + - name: Create a node pool with upgrade gate enabled |
| 2756 | + text: az aks nodepool add -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-upgrade-gate |
2731 | 2757 | """ |
2732 | 2758 |
|
2733 | 2759 | helps['aks nodepool scale'] = """ |
|
2943 | 2969 | - name: --crg-id |
2944 | 2970 | type: string |
2945 | 2971 | short-summary: The Capacity Reservation Group (CRG) ID used to associate the existing nodepool with the existing Capacity Reservation Group resource. |
| 2972 | + - name: --enable-upgrade-gate |
| 2973 | + type: bool |
| 2974 | + short-summary: Enable upgrade gate for the node pool. Upgrades of this node pool wait for health signal validation and abort if unhealthy signals are observed. |
| 2975 | + long-summary: Health signals are HealthSignal custom resources published by monitoring components running in the cluster. Force upgrade (--enable-force-upgrade) overrides the gate. For more information, see https://aka.ms/aks/upgrade-gate. |
| 2976 | + - name: --disable-upgrade-gate |
| 2977 | + type: bool |
| 2978 | + short-summary: Disable upgrade gate for the node pool. |
| 2979 | + long-summary: Rejected by the service when the cluster-level upgrade gate is enabled, since a node pool cannot opt out of a cluster-wide opt-in. Use 'az aks update --disable-upgrade-gate' instead. |
2946 | 2980 | - name: --node-public-ip-prefix-ids |
2947 | 2981 | type: string |
2948 | 2982 | short-summary: Comma-separated list of public IP prefix resource IDs for dual-stack node public IPs (IPv4 and/or IPv6). |
2949 | 2983 | long-summary: At most one IPv4 and one IPv6 prefix may be specified. On an existing node pool this adds or replaces the assigned prefixes; an accepted change rolls the pool so existing nodes are recreated with the new public IPs. Requires the NodePublicIPv6PrefixPreview feature flag. |
2950 | 2984 | examples: |
2951 | 2985 | - name: Reconcile the nodepool back to its current state. |
2952 | 2986 | text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster |
| 2987 | + - name: Enable upgrade gate for a node pool. |
| 2988 | + text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster --enable-upgrade-gate |
2953 | 2989 | - name: Enable cluster-autoscaler within node count range [1,5] |
2954 | 2990 | text: az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster |
2955 | 2991 | - name: Disable cluster-autoscaler for an existing cluster |
|
0 commit comments