Aks [nodepool] update without args prompts to reconcile. (#4759)

Azure · May 5, 2022 · 239ccd4 · 239ccd4
1 parent d568b29
commit 239ccd4
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 68 deletions.
diff --git a/src/aks-preview/HISTORY.md b/src/aks-preview/HISTORY.md
@@ -3,6 +3,10 @@
 Release History
 ===============
 
+0.5.66
+++++++
+* Prompt when no arguments are given to update and nodepool update to see if the customer wants to try goal seek to current settings.
+
 0.5.65
 ++++++
 * Add `--ignore-pod-disruption-budget` flag for `az aks nodepool delete` for ignoring PodDisruptionBudget.

diff --git a/src/aks-preview/azext_aks_preview/_help.py b/src/aks-preview/azext_aks_preview/_help.py
@@ -517,7 +517,8 @@
 
 helps['aks update'] = """
     type: command
-    short-summary: Update a managed Kubernetes cluster properties, such as enable/disable cluster-autoscaler
+    short-summary: Update the properties of a managed Kubernetes cluster.
+    long-summary: Update the properties of a managed Kubernetes cluster. Can be used for example to enable/disable cluster-autoscaler.  When called with no optional arguments this attempts to move the cluster to its goal state without changing the current cluster configuration. This can be used to move out of a non succeeded state.
     parameters:
         - name: --enable-cluster-autoscaler -e
           type: bool
@@ -707,6 +708,8 @@
           type: string
           short-summary: Identifier of Azure Key Vault key.
     examples:
+      - name: Reconcile the cluster back to its current state.
+        text: az aks update -g MyResourceGroup -n MyManagedCluster
       - name: Enable cluster-autoscaler within node count range [1,5]
         text: az aks update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n MyManagedCluster
       - name: Disable cluster-autoscaler for an existing cluster
@@ -1132,7 +1135,8 @@
 
 helps['aks nodepool update'] = """
     type: command
-    short-summary: Update a node pool to enable/disable cluster-autoscaler or change min-count or max-count
+    short-summary: Update a node pool properties.
+    long-summary: Update a node pool to enable/disable cluster-autoscaler or change min-count or max-count.  When called with no optional arguments this attempts to move the cluster to its goal state without changing the current cluster configuration. This can be used to move out of a non succeeded state.
     parameters:
         - name: --enable-cluster-autoscaler -e
           type: bool
@@ -1165,6 +1169,8 @@
           type: string
           short-summary: The node taints for the node pool.
     examples:
+      - name: Reconcile the nodepool back to its current state.
+        text: az aks nodepool update -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster
       - name: Enable cluster-autoscaler within node count range [1,5]
         text: az aks nodepool update --enable-cluster-autoscaler --min-count 1 --max-count 5 -g MyResourceGroup -n nodepool1 --cluster-name MyManagedCluster
       - name: Disable cluster-autoscaler for an existing cluster

diff --git a/src/aks-preview/azext_aks_preview/custom.py b/src/aks-preview/azext_aks_preview/custom.py
@@ -52,7 +52,7 @@
 from dateutil.parser import parse  # pylint: disable=import-error
 from dateutil.relativedelta import relativedelta  # pylint: disable=import-error
 from knack.log import get_logger
-from knack.prompting import NoTTYException, prompt_pass
+from knack.prompting import NoTTYException, prompt_pass, prompt_y_n
 from knack.util import CLIError
 from msrestazure.azure_exceptions import CloudError
 from six.moves.urllib.error import URLError  # pylint: disable=import-error
@@ -398,7 +398,6 @@ def delete_role_assignments(cli_ctx, ids=None, assignee=None, role=None, resourc
             assignments_client.delete_by_id(i)
         return
     if not any([ids, assignee, role, resource_group_name, scope, assignee, yes]):
-        from knack.prompting import prompt_y_n
         msg = 'This will delete all role assignments under the subscription. Are you sure?'
         if not prompt_y_n(msg, default="n"):
             return
@@ -1058,8 +1057,6 @@ def aks_kollect(cmd,    # pylint: disable=too-many-statements,too-many-locals
 
         readonly_sas_token = readonly_sas_token.strip('?')
 
-    from knack.prompting import prompt_y_n
-
     print()
     print('This will deploy a daemon set to your cluster to collect logs and diagnostic information and '
           f'save them to the storage account '
@@ -1240,7 +1237,6 @@ def aks_upgrade(cmd,    # pylint: disable=unused-argument, too-many-return-state
                 node_image_only=False,
                 aks_custom_headers=None,
                 yes=False):
-    from knack.prompting import prompt_y_n
     msg = 'Kubernetes may be unavailable during cluster upgrades.\n Are you sure you want to perform this operation?'
     if not yes and not prompt_y_n(msg, default="n"):
         return None
@@ -1837,10 +1833,12 @@ def aks_agentpool_update(cmd,   # pylint: disable=unused-argument
         disable_cluster_autoscaler + update_cluster_autoscaler
 
     if (update_autoscaler != 1 and not tags and not scale_down_mode and not mode and not max_surge and labels is None and node_taints is None):
-        raise CLIError('Please specify one or more of "--enable-cluster-autoscaler" or '
-                       '"--disable-cluster-autoscaler" or '
-                       '"--update-cluster-autoscaler" or '
-                       '"--tags" or "--mode" or "--max-surge" or "--scale-down-mode" or "--labels" or "--node-taints')
+        reconcilePrompt = 'no argument specified to update would you like to reconcile to current settings?'
+        if not prompt_y_n(reconcilePrompt, default="n"):
+            raise CLIError('Please specify one or more of "--enable-cluster-autoscaler" or '
+                           '"--disable-cluster-autoscaler" or '
+                           '"--update-cluster-autoscaler" or '
+                           '"--tags" or "--mode" or "--max-surge" or "--scale-down-mode" or "--labels" or "--node-taints')
 
     instance = client.get(resource_group_name, cluster_name, nodepool_name)
 

diff --git a/src/aks-preview/azext_aks_preview/decorator.py b/src/aks-preview/azext_aks_preview/decorator.py
@@ -2345,61 +2345,63 @@ def check_raw_parameters(self):
         )
 
         if not is_changed and is_default:
-            # Note: Uncomment the followings to automatically generate the error message.
-            # option_names = [
-            #     '"{}"'.format(format_parameter_name_to_option_name(x))
-            #     for x in self.context.raw_param.keys()
-            #     if x not in excluded_keys
-            # ]
-            # error_msg = "Please specify one or more of {}.".format(
-            #     " or ".join(option_names)
-            # )
-            # raise RequiredArgumentMissingError(error_msg)
-            raise RequiredArgumentMissingError(
-                'Please specify "--enable-cluster-autoscaler" or '
-                '"--disable-cluster-autoscaler" or '
-                '"--update-cluster-autoscaler" or '
-                '"--cluster-autoscaler-profile" or '
-                '"--enable-pod-security-policy" or '
-                '"--disable-pod-security-policy" or '
-                '"--api-server-authorized-ip-ranges" or '
-                '"--attach-acr" or '
-                '"--detach-acr" or '
-                '"--uptime-sla" or '
-                '"--no-uptime-sla" or '
-                '"--load-balancer-managed-outbound-ip-count" or '
-                '"--load-balancer-outbound-ips" or '
-                '"--load-balancer-outbound-ip-prefixes" or '
-                '"--nat-gateway-managed-outbound-ip-count" or '
-                '"--nat-gateway-idle-timeout" or '
-                '"--enable-aad" or '
-                '"--aad-tenant-id" or '
-                '"--aad-admin-group-object-ids" or '
-                '"--enable-ahub" or '
-                '"--disable-ahub" or '
-                '"--enable-managed-identity" or '
-                '"--enable-pod-identity" or '
-                '"--disable-pod-identity" or '
-                '"--auto-upgrade-channel" or '
-                '"--enable-secret-rotation" or '
-                '"--disable-secret-rotation" or '
-                '"--rotation-poll-interval" or '
-                '"--tags" or '
-                '"--windows-admin-password" or '
-                '"--enable-azure-rbac" or '
-                '"--disable-azure-rbac" or '
-                '"--enable-local-accounts" or '
-                '"--disable-local-accounts" or '
-                '"--enable-public-fqdn" or '
-                '"--disable-public-fqdn"'
-                '"--enble-windows-gmsa" or '
-                '"--nodepool-labels" or '
-                '"--enable-oidc-issuer" or '
-                '"--http-proxy-config" or '
-                '"--enable-azure-keyvault-kms" or '
-                '"--enable-workload-identity" or '
-                '"--disable-workload-identity".'
-            )
+            reconcilePrompt = 'no argument specified to update would you like to reconcile to current settings?'
+            if not prompt_y_n(reconcilePrompt, default="n"):
+                # Note: Uncomment the followings to automatically generate the error message.
+                # option_names = [
+                #     '"{}"'.format(format_parameter_name_to_option_name(x))
+                #     for x in self.context.raw_param.keys()
+                #     if x not in excluded_keys
+                # ]
+                # error_msg = "Please specify one or more of {}.".format(
+                #     " or ".join(option_names)
+                # )
+                # raise RequiredArgumentMissingError(error_msg)
+                raise RequiredArgumentMissingError(
+                    'Please specify "--enable-cluster-autoscaler" or '
+                    '"--disable-cluster-autoscaler" or '
+                    '"--update-cluster-autoscaler" or '
+                    '"--cluster-autoscaler-profile" or '
+                    '"--enable-pod-security-policy" or '
+                    '"--disable-pod-security-policy" or '
+                    '"--api-server-authorized-ip-ranges" or '
+                    '"--attach-acr" or '
+                    '"--detach-acr" or '
+                    '"--uptime-sla" or '
+                    '"--no-uptime-sla" or '
+                    '"--load-balancer-managed-outbound-ip-count" or '
+                    '"--load-balancer-outbound-ips" or '
+                    '"--load-balancer-outbound-ip-prefixes" or '
+                    '"--nat-gateway-managed-outbound-ip-count" or '
+                    '"--nat-gateway-idle-timeout" or '
+                    '"--enable-aad" or '
+                    '"--aad-tenant-id" or '
+                    '"--aad-admin-group-object-ids" or '
+                    '"--enable-ahub" or '
+                    '"--disable-ahub" or '
+                    '"--enable-managed-identity" or '
+                    '"--enable-pod-identity" or '
+                    '"--disable-pod-identity" or '
+                    '"--auto-upgrade-channel" or '
+                    '"--enable-secret-rotation" or '
+                    '"--disable-secret-rotation" or '
+                    '"--rotation-poll-interval" or '
+                    '"--tags" or '
+                    '"--windows-admin-password" or '
+                    '"--enable-azure-rbac" or '
+                    '"--disable-azure-rbac" or '
+                    '"--enable-local-accounts" or '
+                    '"--disable-local-accounts" or '
+                    '"--enable-public-fqdn" or '
+                    '"--disable-public-fqdn"'
+                    '"--enble-windows-gmsa" or '
+                    '"--nodepool-labels" or '
+                    '"--enable-oidc-issuer" or '
+                    '"--http-proxy-config" or '
+                    '"--enable-azure-keyvault-kms" or '
+                    '"--enable-workload-identity" or '
+                    '"--disable-workload-identity".'
+                )
 
     def update_load_balancer_profile(self, mc: ManagedCluster) -> ManagedCluster:
         """Update load balancer profile for the ManagedCluster object.

diff --git a/src/aks-preview/azext_aks_preview/tests/latest/test_decorator.py b/src/aks-preview/azext_aks_preview/tests/latest/test_decorator.py
@@ -3265,7 +3265,17 @@ def test_check_raw_parameters(self):
             CUSTOM_MGMT_AKS_PREVIEW,
         )
         # fail on no updated parameter provided
-        with self.assertRaises(RequiredArgumentMissingError):
+        with patch(
+            "azext_aks_preview.decorator.prompt_y_n",
+            return_value=False,
+        ),self.assertRaises(RequiredArgumentMissingError):
+            dec_1.check_raw_parameters()
+
+        # unless user says they want to reconcile
+        with patch(
+            "azext_aks_preview.decorator.prompt_y_n",
+            return_value=True,
+        ):
             dec_1.check_raw_parameters()
 
         # custom value

diff --git a/src/aks-preview/setup.py b/src/aks-preview/setup.py
@@ -9,7 +9,7 @@
 
 from setuptools import setup, find_packages
 
-VERSION = "0.5.65"
+VERSION = "0.5.66"
 CLASSIFIERS = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",