{AKS} Rename to addon-autoscaling preview CLI to optimized-addon-scaling (Azure#8617)

* rename to optimized addon scaling

* address comment

* fix style error

---------

Co-authored-by: chihshenghuang <[email protected]>

Author: chihshenghuang

src/aks-preview/HISTORY.rst

@@ -13,6 +13,11 @@ Pending
 +++++++
 * Vendor new SDK and bump API version to 2025-01-02-preview.
 
+14.0.0b1
++++++++
+* [BREAKING CHANGE] Rename `--enable-addon-autoscaling` to `--enable-optimized-addon-scaling` to `az aks create` commands.
+* [BREAKING CHANGE] Rename `--enable-addon-autoscaling` to `--enable-optimized-addon-scaling` and `--disable-addon-autoscaling` to `--disable-optimized-addon-scaling` to `az aks update` commands.
+
 13.0.0b9
 +++++++
 * Vendor new SDK and bump API version to 2024-10-02-preview.

src/aks-preview/azext_aks_preview/_help.py

@@ -528,9 +528,9 @@
         - name: --enable-vpa
           type: bool
           short-summary: Enable vertical pod autoscaler for cluster.
-        - name: --enable-addon-autoscaling
+        - name: --enable-optimized-addon-scaling
           type: bool
-          short-summary: Enable addon autoscaling for cluster.
+          short-summary: Enable optimized addon scaling feature for cluster.
         - name: --nodepool-allowed-host-ports
           type: string
           short-summary: Expose host ports on the node pool. When specified, format should be a comma-separated list of ranges with protocol, eg. 80/TCP,443/TCP,4000-5000/TCP.
@@ -1170,12 +1170,12 @@
         - name: --disable-vpa
           type: bool
           short-summary: Disable vertical pod autoscaler for cluster.
-        - name: --enable-addon-autoscaling
+        - name: --enable-optimized-addon-scaling
           type: bool
-          short-summary: Enable addon autoscaling for cluster.
-        - name: --disable-addon-autoscaling
+          short-summary: Enable optimized addon scaling feature for cluster.
+        - name: --disable-optimized-addon-scaling
           type: bool
-          short-summary: Disable addon autoscaling for cluster.
+          short-summary: Disable optimized addon scaling feature for cluster.
         - name: --cluster-snapshot-id
           type: string
           short-summary: The source cluster snapshot id is used to update existing cluster.

src/aks-preview/azext_aks_preview/_params.py

@@ -798,10 +798,10 @@ def load_arguments(self, _):
             help="enable vertical pod autoscaler for cluster",
         )
         c.argument(
-            "enable_addon_autoscaling",
+            "enable_optimized_addon_scaling",
             action="store_true",
             is_preview=True,
-            help="enable addon autoscaling for cluster",
+            help="enable optimized addon scaling for cluster",
         )
         c.argument(
             "enable_cilium_dataplane",
@@ -1257,16 +1257,16 @@ def load_arguments(self, _):
             help="disable vertical pod autoscaler for cluster",
         )
         c.argument(
-            "enable_addon_autoscaling",
+            "enable_optimized_addon_scaling",
             action="store_true",
             is_preview=True,
-            help="enable addon autoscaling for cluster",
+            help="enable optimized addon scaling for cluster",
         )
         c.argument(
-            "disable_addon_autoscaling",
+            "disable_optimized_addon_scaling",
             action="store_true",
             is_preview=True,
-            help="disable addon autoscaling for cluster",
+            help="disable optimized addon scaling for cluster",
         )
         c.argument(
             "cluster_snapshot_id",

src/aks-preview/azext_aks_preview/custom.py

@@ -486,7 +486,7 @@ def aks_create(
     dns_zone_resource_ids=None,
     enable_keda=False,
     enable_vpa=False,
-    enable_addon_autoscaling=False,
+    enable_optimized_addon_scaling=False,
     enable_cilium_dataplane=False,
     custom_ca_trust_certificates=None,
     # advanced networking
@@ -711,8 +711,8 @@ def aks_update(
     disable_azure_monitor_app_monitoring=False,
     enable_vpa=False,
     disable_vpa=False,
-    enable_addon_autoscaling=False,
-    disable_addon_autoscaling=False,
+    enable_optimized_addon_scaling=False,
+    disable_optimized_addon_scaling=False,
     cluster_snapshot_id=None,
     custom_ca_trust_certificates=None,
     # safeguards parameters

src/aks-preview/azext_aks_preview/managed_cluster_decorator.py

@@ -2130,62 +2130,64 @@ def get_disable_vpa(self) -> bool:
         """
         return self._get_disable_vpa(enable_validation=True)
 
-    def _get_enable_addon_autoscaling(self, enable_validation: bool = False) -> bool:
-        """Internal function to obtain the value of enable_addon_autoscaling.
-        This function supports the option of enable_addon_autoscaling.
-        When enabled, if both enable_addon_autoscaling and disable_addon_autoscaling are
+    def _get_enable_optimized_addon_scaling(self, enable_validation: bool = False) -> bool:
+        """Internal function to obtain the value of enable_optimized_addon_scaling.
+        This function supports the option of enable_optimized_addon_scaling.
+        When enabled, if both enable_optimized_addon_scaling and disable_optimized_addon_scaling are
         specified, raise a MutuallyExclusiveArgumentError.
         :return: bool
         """
         # Read the original value passed by the command.
-        enable_addon_autoscaling = self.raw_param.get("enable_addon_autoscaling")
+        enable_optimized_addon_scaling = self.raw_param.get("enable_optimized_addon_scaling")
 
         # This parameter does not need dynamic completion.
         if enable_validation:
-            if enable_addon_autoscaling and self._get_disable_addon_autoscaling(enable_validation=False):
+            if enable_optimized_addon_scaling and self._get_disable_optimized_addon_scaling(enable_validation=False):
                 raise MutuallyExclusiveArgumentError(
-                    "Cannot specify --enable-addon-autoscaling and --disable-addon-autoscaling at the same time."
+                    "Cannot specify --enable-optimized-addon-scaling and \
+                    --disable-optimized-addon-scaling at the same time."
                 )
 
-        return enable_addon_autoscaling
+        return enable_optimized_addon_scaling
 
-    def get_enable_addon_autoscaling(self) -> bool:
-        """Obtain the value of enable_addon_autoscaling.
+    def get_enable_optimized_addon_scaling(self) -> bool:
+        """Obtain the value of enable_optimized_addon_scaling.
         This function will verify the parameter by default.
-        If both enable_addon_autoscaling and disable_addon_autoscaling are specified,
+        If both enable_optimized_addon_scaling and disable_optimized_addon_scaling are specified,
         raise a MutuallyExclusiveArgumentError.
         :return: bool
         """
-        return self._get_enable_addon_autoscaling(enable_validation=True)
+        return self._get_enable_optimized_addon_scaling(enable_validation=True)
 
-    def _get_disable_addon_autoscaling(self, enable_validation: bool = False) -> bool:
-        """Internal function to obtain the value of disable_addon_autoscaling.
-        This function supports the option of enable_addon_autoscaling.
-        When enabled, if both enable_addon_autoscaling and disable_addon_autoscaling are specified,
+    def _get_disable_optimized_addon_scaling(self, enable_validation: bool = False) -> bool:
+        """Internal function to obtain the value of disable_optimized_addon_scaling.
+        This function supports the option of enable_optimized_addon_scaling.
+        When enabled, if both enable_optimized_addon_scaling and disable_optimized_addon_scaling are specified,
         raise a MutuallyExclusiveArgumentError.
         :return: bool
         """
         # Read the original value passed by the command.
-        disable_addon_autoscaling = self.raw_param.get("disable_addon_autoscaling")
+        disable_optimized_addon_scaling = self.raw_param.get("disable_optimized_addon_scaling")
 
         # This option is not supported in create mode, hence we do not read the property value from the `mc` object.
         # This parameter does not need dynamic completion.
         if enable_validation:
-            if disable_addon_autoscaling and self._get_enable_addon_autoscaling(enable_validation=False):
+            if disable_optimized_addon_scaling and self._get_enable_optimized_addon_scaling(enable_validation=False):
                 raise MutuallyExclusiveArgumentError(
-                    "Cannot specify --enable-addon-autoscaling and --disable-addon-autoscaling at the same time."
+                    "Cannot specify --enable-optimized-addon-scaling and \
+                    --disable-optimized-addon-scaling at the same time."
                 )
 
-        return disable_addon_autoscaling
+        return disable_optimized_addon_scaling
 
-    def get_disable_addon_autoscaling(self) -> bool:
-        """Obtain the value of disable_addon_autoscaling.
+    def get_disable_optimized_addon_scaling(self) -> bool:
+        """Obtain the value of disable_optimized_addon_scaling.
         This function will verify the parameter by default.
-        If both enable_addon_autoscaling and disable_addon_autoscaling are specified,
+        If both enable_optimized_addon_scaling and disable_optimized_addon_scaling are specified,
         raise a MutuallyExclusiveArgumentError.
         :return: bool
         """
-        return self._get_disable_addon_autoscaling(enable_validation=True)
+        return self._get_disable_optimized_addon_scaling(enable_validation=True)
 
     def get_ssh_key_value_for_update(self) -> Tuple[str, bool]:
         """Obtain the value of ssh_key_value for "az aks update".
@@ -3161,14 +3163,14 @@ def set_up_vpa(self, mc: ManagedCluster) -> ManagedCluster:
                 mc.workload_auto_scaler_profile.vertical_pod_autoscaler.enabled = True
         return mc
 
-    def set_up_addon_autoscaling(self, mc: ManagedCluster) -> ManagedCluster:
+    def set_up_optimized_addon_scaling(self, mc: ManagedCluster) -> ManagedCluster:
         """Set up workload auto-scaler vertical pod autsocaler profile
         for the ManagedCluster object.
         :return: the ManagedCluster object
         """
         self._ensure_mc(mc)
 
-        if self.context.get_enable_addon_autoscaling():
+        if self.context.get_enable_optimized_addon_scaling():
             if mc.workload_auto_scaler_profile is None:
                 mc.workload_auto_scaler_profile = self.models.ManagedClusterWorkloadAutoScalerProfile()  # pylint: disable=no-member
             if mc.workload_auto_scaler_profile.vertical_pod_autoscaler is None:
@@ -3563,8 +3565,8 @@ def construct_mc_profile_preview(self, bypass_restore_defaults: bool = False) ->
         mc = self.set_up_workload_auto_scaler_profile(mc)
         # set up vpa
         mc = self.set_up_vpa(mc)
-        # set up addon autoscaling
-        mc = self.set_up_addon_autoscaling(mc)
+        # set up optimized addon scaling
+        mc = self.set_up_optimized_addon_scaling(mc)
         # set up kube-proxy config
         mc = self.set_up_kube_proxy_config(mc)
         # set up custom ca trust certificates
@@ -4710,14 +4712,14 @@ def update_vpa(self, mc: ManagedCluster) -> ManagedCluster:
 
         return mc
 
-    def update_addon_autoscaling(self, mc: ManagedCluster) -> ManagedCluster:
+    def update_optimized_addon_scaling(self, mc: ManagedCluster) -> ManagedCluster:
         """Update workload auto-scaler vertical pod auto-scaler profile
         for the ManagedCluster object.
         :return: the ManagedCluster object
         """
         self._ensure_mc(mc)
 
-        if self.context.get_enable_addon_autoscaling():
+        if self.context.get_enable_optimized_addon_scaling():
             if mc.workload_auto_scaler_profile is None:
                 mc.workload_auto_scaler_profile = self.models.ManagedClusterWorkloadAutoScalerProfile()  # pylint: disable=no-member
             if mc.workload_auto_scaler_profile.vertical_pod_autoscaler is None:
@@ -4728,7 +4730,7 @@ def update_addon_autoscaling(self, mc: ManagedCluster) -> ManagedCluster:
             mc.workload_auto_scaler_profile.vertical_pod_autoscaler.enabled = True
             mc.workload_auto_scaler_profile.vertical_pod_autoscaler.addon_autoscaling = "Enabled"
 
-        if self.context.get_disable_addon_autoscaling():
+        if self.context.get_disable_optimized_addon_scaling():
             if mc.workload_auto_scaler_profile is None:
                 mc.workload_auto_scaler_profile = self.models.ManagedClusterWorkloadAutoScalerProfile()  # pylint: disable=no-member
             if mc.workload_auto_scaler_profile.vertical_pod_autoscaler is None:
@@ -5255,8 +5257,8 @@ def update_mc_profile_preview(self) -> ManagedCluster:
         mc = self.update_azure_monitor_profile(mc)
         # update vpa
         mc = self.update_vpa(mc)
-        # update addon autoscaling
-        mc = self.update_addon_autoscaling(mc)
+        # update optimized addon scaling
+        mc = self.update_optimized_addon_scaling(mc)
         # update creation data
         mc = self.update_creation_data(mc)
         # update linux profile

…t_aks_create_with_addon_autoscaling.yaml …create_with_optimized_addon_scaling.yamlsrc/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_create_with_addon_autoscaling.yaml renamed to src/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_create_with_optimized_addon_scaling.yaml src/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_create_with_addon_autoscaling.yaml renamed to src/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_create_with_optimized_addon_scaling.yaml

@@ -587,7 +587,7 @@ def test_aks_create_and_update_with_vpa(
     @AKSCustomResourceGroupPreparer(
         random_name_length=17, name_prefix="clitest", location="westus2"
     )
-    def test_aks_create_with_addon_autoscaling(
+    def test_aks_create_with_optimized_addon_scaling(
         self, resource_group, resource_group_location
     ):
         # reset the count so in replay mode the random names will start with 0
@@ -609,7 +609,7 @@ def test_aks_create_with_addon_autoscaling(
         create_cmd = (
             "aks create --resource-group={resource_group} --name={name} "
             "--vm-set-type VirtualMachineScaleSets -c 1 "
-            "--enable-addon-autoscaling "
+            "--enable-optimized-addon-scaling "
             "--kubernetes-version={k8s_version} "
             "--aks-custom-headers AKSHTTPCustomFeatures=Microsoft.ContainerService/AKS-AddonAutoscalingPreview "
             "--ssh-key-value={ssh_key_value} -o json"
@@ -642,7 +642,7 @@ def test_aks_create_with_addon_autoscaling(
     @AKSCustomResourceGroupPreparer(
         random_name_length=17, name_prefix="clitest", location="westus2"
     )
-    def test_aks_update_with_addon_autoscaling(
+    def test_aks_update_with_optimized_addon_scaling(
         self, resource_group, resource_group_location
     ):
         # reset the count so in replay mode the random names will start with 0
@@ -678,7 +678,7 @@ def test_aks_update_with_addon_autoscaling(
         update_cmd = (
             "aks update --resource-group={resource_group} --name={name} "
             "--aks-custom-headers AKSHTTPCustomFeatures=Microsoft.ContainerService/AKS-AddonAutoscalingPreview "
-            "--enable-addon-autoscaling -o json"
+            "--enable-optimized-addon-scaling -o json"
         )
         self.cmd(
             update_cmd,
@@ -697,7 +697,7 @@ def test_aks_update_with_addon_autoscaling(
         update_cmd = (
             "aks update --resource-group={resource_group} --name={name} "
             "--aks-custom-headers AKSHTTPCustomFeatures=Microsoft.ContainerService/AKS-AddonAutoscalingPreview "
-            "--disable-addon-autoscaling -o json"
+            "--disable-optimized-addon-scaling -o json"
         )
         self.cmd(
             update_cmd,

…t_aks_update_with_addon_autoscaling.yaml …update_with_optimized_addon_scaling.yamlsrc/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_update_with_addon_autoscaling.yaml renamed to src/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_update_with_optimized_addon_scaling.yaml src/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_update_with_addon_autoscaling.yaml renamed to src/aks-preview/azext_aks_preview/tests/latest/recordings/test_aks_update_with_optimized_addon_scaling.yaml

@@ -5084,7 +5084,7 @@ def test_set_up_vpa(self):
 
         self.assertEqual(dec_mc_2, ground_truth_mc_2)
 
-    def test_set_up_addon_autoscaling(self):
+    def test_set_up_optimized_addon_scaling(self):
         dec_1 = AKSPreviewManagedClusterCreateDecorator(
             self.cmd,
             self.client,
@@ -5093,19 +5093,19 @@ def test_set_up_addon_autoscaling(self):
         )
         mc_1 = self.models.ManagedCluster(location="test_location")
         dec_1.context.attach_mc(mc_1)
-        dec_mc_1 = dec_1.set_up_addon_autoscaling(mc_1)
+        dec_mc_1 = dec_1.set_up_optimized_addon_scaling(mc_1)
         ground_truth_mc_1 = self.models.ManagedCluster(location="test_location")
         self.assertEqual(dec_mc_1, ground_truth_mc_1)
 
         dec_2 = AKSPreviewManagedClusterCreateDecorator(
             self.cmd,
             self.client,
-            {"enable_addon_autoscaling": True},
+            {"enable_optimized_addon_scaling": True},
             CUSTOM_MGMT_AKS_PREVIEW,
         )
         mc_2 = self.models.ManagedCluster(location="test_location")
         dec_2.context.attach_mc(mc_2)
-        dec_mc_2 = dec_2.set_up_addon_autoscaling(mc_2)
+        dec_mc_2 = dec_2.set_up_optimized_addon_scaling(mc_2)
         workload_auto_scaler_profile = (
             self.models.ManagedClusterWorkloadAutoScalerProfile()
         )
@@ -8017,7 +8017,7 @@ def test_update_upgrade_settings(self):
         with self.assertRaises(InvalidArgumentValueError):
             dec_6.update_upgrade_settings(mc_6)
 
-    def test_update_addon_autoscaling(self):
+    def test_update_optimized_addon_scaling(self):
         # Should not update mc if unset
         dec_0 = AKSPreviewManagedClusterUpdateDecorator(
             self.cmd,
@@ -8029,7 +8029,7 @@ def test_update_addon_autoscaling(self):
             location="test_location",
         )
         dec_0.context.attach_mc(mc_0)
-        dec_mc_0 = dec_0.update_addon_autoscaling(mc_0)
+        dec_mc_0 = dec_0.update_optimized_addon_scaling(mc_0)
         ground_truth_mc_0 = self.models.ManagedCluster(
             location="test_location",
         )
@@ -8039,28 +8039,28 @@ def test_update_addon_autoscaling(self):
         dec_1 = AKSPreviewManagedClusterUpdateDecorator(
             self.cmd,
             self.client,
-            {"enable_addon_autoscaling": True, "disable_addon_autoscaling": True},
+            {"enable_optimized_addon_scaling": True, "disable_optimized_addon_scaling": True},
             CUSTOM_MGMT_AKS_PREVIEW,
         )
         mc_1 = self.models.ManagedCluster(
             location="test_location",
         )
         dec_1.context.attach_mc(mc_1)
         with self.assertRaises(MutuallyExclusiveArgumentError):
-            dec_1.update_addon_autoscaling(mc_1)
+            dec_1.update_optimized_addon_scaling(mc_1)
 
-        # enable addon autoscaling should set addon_autoscaling to Enabled
+        # enable optimized addon scaling should set optimized_addon_scaling to Enabled
         dec_2 = AKSPreviewManagedClusterUpdateDecorator(
             self.cmd,
             self.client,
-            {"enable_addon_autoscaling": True},
+            {"enable_optimized_addon_scaling": True},
             CUSTOM_MGMT_AKS_PREVIEW,
         )
         mc_2 = self.models.ManagedCluster(
             location="test_location",
         )
         dec_2.context.attach_mc(mc_2)
-        dec_mc_2 = dec_2.update_addon_autoscaling(mc_2)
+        dec_mc_2 = dec_2.update_optimized_addon_scaling(mc_2)
         workload_auto_scaler_profile = (
             self.models.ManagedClusterWorkloadAutoScalerProfile()
         )
@@ -8076,18 +8076,18 @@ def test_update_addon_autoscaling(self):
         )
         self.assertEqual(dec_mc_2, ground_truth_mc_2)
 
-        # disable addon autoscaling should set addon_autoscaling to Disabled
+        # disable optimized addon scaling should set optimized_addon_scaling to Disabled
         dec_3 = AKSPreviewManagedClusterUpdateDecorator(
             self.cmd,
             self.client,
-            {"disable_addon_autoscaling": True},
+            {"disable_optimized_addon_scaling": True},
             CUSTOM_MGMT_AKS_PREVIEW,
         )
         mc_3 = self.models.ManagedCluster(
             location="test_location",
         )
         dec_3.context.attach_mc(mc_3)
-        dec_mc_3 = dec_3.update_addon_autoscaling(mc_3)
+        dec_mc_3 = dec_3.update_optimized_addon_scaling(mc_3)
         workload_auto_scaler_profile = (
             self.models.ManagedClusterWorkloadAutoScalerProfile()
         )