Quality improvements for az aks extension and az aks extension type command groups (Azure#8794)

* add troubleshoot command under connectedk8s

* resolve check issues

* fix final new line

* add back troubleshoot params

* implement helm version and permission checks

* add aks extension and aks extension type cli groups

* fix pylint

* POC for extensions

* fix formatting

* add test and revert connectedk8s changes

* remove newline from readme

* fix linter issue

* fix faulty examples

* fix linting issues

* fix parse issue

* fix

* fix help.py

* fix more pylint issues

* fix params

* fix parameter issue

* fix the over indent

* fix pylint issue

* resolve pylinter issue

* remove location

* remove location

* add extension type

* remove unrecognized parameter

* add comma

* fix invalid naming convensitons

* fix pylinter issue

* remove duplicate functions from k8sextension

* add check for allowed extensions

* revise tests

* fix indentation issue

* fix trailing whitespace

* cmmit

* add params

* change

* fix format.py

* remove aks group

* fix format.py

* add library func for params

* add const

* remove libraries

* update format.py

* remove libraries from format.py

* add check for allow list of extensions

* add history.rst

* fix unit test

* fix style in help.py

* fix extension type test

* add cassete file

* add modified tests

* add cmd for patching the k8s extension

* fix cassette file

* add update

* fix PR comments in format, help.py

* fix style

* fix action.py

* fix style

* add newline in params.py

* update extension type command

* fix pylint indentation

* fix cli examples

* add resource group name as param

* add resource group param

* add autoupgrade as description

* fix autoupgrade param

* add abreviation

* fix option list

* add autoupgrade

* change autoupgrade order

* add description for config settings

* specify additional parameters

* add examples for aks extension API

* rerun pylinter

* rerun pipeline

* fix style and pylint issue

* add location param in help.py

* add region as param

* run new command with style and linter

* add command group

* make parameters optional

* use custom show command

* rerun style check

* fix style

* fix unexpected spaces

* remove extra show extension type commands

* fix params in extension types api

* add show version command

* fix style

* fix extension list version command

* fix style and linting issue

* fix aks test cases

* print allowed list of extensions

* fix help.py description

* fix pylinting issue

* fix style issue

* fix style issue

* add new cassette files

* commit action.py

* add backup scenario

* add extension type version API commands

* fix help.py examples

* fix help.py

* fix version summary

* remove print statement

* add version show

* add custom helper function

* fix new line issue

* remove show-version and list-versions

* fix style issue

* fix style issue

* fix style issue

* location of extension

* fix pylinting issue

* fix location flag

* Update src/aks-preview/azext_aks_preview/tests/latest/test_aks_commands.py

Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com>

* Update src/aks-preview/azext_aks_preview/tests/latest/test_aks_commands.py

Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com>

* add extension type filtering for core extensions

* remove 3 properties

* fix style

* add missing custom functions

* upload cassette files

* change pending version

* modify casette files

* add k8s extension firewall

* add latest cassette files

* remove secrets from test case

* register extension types feature

* add a wait period for the feature to register

* update version in setup.py

* fix cassette files

* update history.rst

* commit

* add validation

* update cassette files

* update history.rst

* fix style issue in helpers.py

* change api version

* update casset files with correct API verisons

* address PR comments

* update setup.py

* remove extra test files

* update casette files

* make tests live only

* fix style issue

* fix setup.py

* fix history.rst

* fix style

* fix failed test case

* fix syntax error

* update failed test

* fix

* fix recording

* revert yaml changes

* fix put call API

* update api verisons

* update api version

---------

Co-authored-by: Sophie Zhao <sophiezhao@microsoft.com>
Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com>

Author: 3 people

src/aks-preview/HISTORY.rst

@@ -12,6 +12,10 @@ To release a new version, please select a new version number (usually plus 1 to
 Pending
 +++++++
 
+18.0.0b6
++++++++
+* Quality improvements for `az aks extension` and `az aks extension type` command groups
+
 18.0.0b5
 +++++++
 * Add option `Ubuntu2204` and `Ubuntu2404` to `--os-sku` for `az aks nodepool add` and `az aks nodepool update`.

src/aks-preview/azext_aks_preview/_help.py

@@ -3432,17 +3432,17 @@
       short-summary: JSON file path for configuration-protected-settings
       long-summary: JSON file path for configuration-protected-settings. If not specified, default value is None
   examples:
-    - name: Install K8s extension on AKS cluster with required parameters
+    - name: Install Cluster extension on AKS cluster with required parameters
       text: az aks extension create --resource-group my-resource-group \
 --cluster-name mycluster --name myextension --extension-type microsoft.flux
-    - name: Install K8s extension with optional parameter configuration settings
+    - name: Install Cluster extension with optional parameter configuration settings
       text: az aks extension create --resource-group abc --cluster-name test --name flux \
 --extension-type microsoft.flux --config useKubeletIdentity=true
 """
 
 helps['aks extension delete'] = """
   type: command
-  short-summary: Delete a Kubernetes Extension.
+  short-summary: Delete a Cluster Extension.
   parameters:
     - name: --resource-group -g
       type: string
@@ -3463,18 +3463,18 @@
       long-summary: Specify whether to force delete the extension from the cluster \
 If not specified, default value is false
   examples:
-    - name: Delete an existing Kubernetes extension on AKS cluster
+    - name: Delete an existing Cluster extension on AKS cluster
       text: az aks extension delete --resource-group resource-group --cluster-name cluster --name ext
-    - name: Delete an existing Kubernetes extension on AKS cluster with optional parameters
+    - name: Delete an existing Cluster extension on AKS cluster with optional parameters
       text: az aks extension delete --resource-group resource-group --cluster-name cluster --name ext \
 --yes --force
 """
 
 helps['aks extension update'] = """
   type: command
-  short-summary: Update mutable properties of a Kubernetes Extension.
+  short-summary: Update mutable properties of a Cluster Extension.
   long-summary: For update to ConfigSettings and ConfigProtectedSettings, please \
-refer to documentation of the cluster extension service to check update to these \
+refer to documentation of the Cluster extension service to check update to these \
 properties is supported before updating these properties. \
 The output includes secrets that you must protect. Be sure that you do not include these secrets in your \
  source control. Also verify that no secrets are present in the logs of your command or script. \
@@ -3512,10 +3512,10 @@
       short-summary: Ignores confirmation prompt.
       long-summary: Ignores confirmation prompt. If not specified, default value is false
   examples:
-    - name: Update K8s extension on AKS cluster
+    - name: Update Cluster extension on AKS cluster
       text: az aks extension update --resource-group my-resource-group \
 --cluster-name mycluster --name myextension
-    - name: Update K8s extension on AKS cluster with optional parameters included
+    - name: Update Cluster extension on AKS cluster with optional parameters included
       text: az aks extension update --resource-group my-resource-group \
 --cluster-name mycluster --name myextension \
 --configuration-settings settings-key=settings-value \
@@ -3526,8 +3526,8 @@
 
 helps['aks extension list'] = """
   type: command
-  short-summary: List Kubernetes Extensions
-  long-summary: List all Kubernetes Extensions in a cluster, including their properties. \
+  short-summary: List Cluster Extensions
+  long-summary: List all Cluster Extensions in a cluster, including their properties. \
 The output includes secrets that you must protect. Be sure that you do not include these secrets in your \
   source control. Also verify that no secrets are present in the logs of your command or script. \
   For additional information, see http://aka.ms/clisecrets.
@@ -3539,14 +3539,14 @@
       type: string
       short-summary: Name of the AKS cluster
   examples:
-    - name: List all Kubernetes Extensions on a cluster
+    - name: List all Cluster Extensions on a cluster
       text: az aks extension list --resource-group <group> --cluster-name <name>
 """
 
 helps['aks extension show'] = """
   type: command
-  short-summary: Show a Kubernetes Extension
-  long-summary: Show a Kubernetes Extension including its properties. \
+  short-summary: Show a Cluster Extension
+  long-summary: Show a Cluster Extension including its properties. \
 The output includes secrets that you must protect. Be sure that you do not include these secrets in your \
   source control. Also verify that no secrets are present in the logs of your command or script. \
   For additional information, see http://aka.ms/clisecrets.
@@ -3561,7 +3561,7 @@
       type: string
       short-summary: Name of the extension instance
   examples:
-      - name: Show details of a Kubernetes Extension
+      - name: Show details of a Cluster Extension
         text: az aks extension show --resource-group my-resource-group \
 --cluster-name mycluster --name myextension
 """
@@ -3574,7 +3574,7 @@
 
 helps['aks extension type show'] = """
   type: command
-  short-summary: Show properties for a K8s Extension Type. The properties used for filtering include kubernetes version, location of the cluster.
+  short-summary: Show properties for a Cluster Extension Type. The properties used for filtering include kubernetes version, location of the cluster.
   parameters:
     - name: --extension-type -t
       type: string
@@ -3593,16 +3593,16 @@
       long-summary: Location of where we want to retrieve the extension type. If not specified, default value is None
 
   examples:
-    - name: Show properties for a K8s Extension Type for an existing cluster by cluster
+    - name: Show properties for a Cluster Extension Type for an existing cluster by cluster
       text: az aks extension type show --resource-group my-resource-group\
  --cluster-name mycluster --extension-type <type>
-    - name: Show properties for a K8s Extension Type in a location
+    - name: Show properties for a Cluster Extension Type in a location
       text: az aks extension type show --location eastus --extension-type type
 """
 
 helps['aks extension type list'] = """
   type: command
-  short-summary: List available K8s Extension Types. The properties used for filtering include kubernetes version, location of the cluster.
+  short-summary: List available Cluster Extension Types. The properties used for filtering include kubernetes version, location of the cluster.
   parameters:
     - name: --resource-group -g
       type: string
@@ -3620,10 +3620,10 @@
       type: string
       short-summary: Specify the release train for the K8s extension type
   examples:
-    - name: List available K8s Extension Types for an existing cluster
+    - name: List available Cluster Extension Types for an existing cluster
       text: az aks extension type list --resource-group my-resource-group \
 --cluster-name mycluster
-    - name: List available K8s Extension Types in a region
+    - name: List available Cluster Extension Types in a region
       text: az aks extension type list --location eastus
 """
 
@@ -3635,7 +3635,7 @@
 
 helps['aks extension type version show'] = """
   type: command
-  short-summary: Show properties associated with a K8s Extension Type version. The properties used for filtering include kubernetes version, location of the cluster.
+  short-summary: Show properties associated with a Cluster Extension Type version. The properties used for filtering include kubernetes version, location of the cluster.
   parameters:
     - name: --resource-group -g
       type: string
@@ -3656,16 +3656,16 @@
       short-summary: Location of where we want to retrieve the extension type
       long-summary: Location of where we want to retrieve the extension type. If not specified, default value is None
   examples:
-    - name: Show properties for a K8s Extension Type version for an existing cluster
+    - name: Show properties for a Cluster Extension Type version for an existing cluster
       text: az aks extension type version show --resource-group my-resource-group \
 --cluster-name mycluster --extension-type type --version 1.0.0
-    - name: Show properties for a K8s Extension Type version for a location
+    - name: Show properties for a Cluster Extension Type version for a location
       text: az aks extension type version show --location eastus --extension-type <type> --version 1.0.0
 """
 
 helps['aks extension type version list'] = """
   type: command
-  short-summary: List available K8s Extension Type versions. The properties used for filtering include kubernetes version, location of the cluster.
+  short-summary: List available Cluster Extension Type versions. The properties used for filtering include kubernetes version, location of the cluster.
   parameters:
     - name: --resource-group -g
       type: string
@@ -3683,10 +3683,10 @@
       short-summary: Location of where we want to retrieve the extension type
       long-summary: Location of where we want to retrieve the extension type. If not specified, default value is None
   examples:
-    - name: List available K8s Extension Types for an existing cluster
+    - name: List available Cluster Extension Types for an existing cluster
       text: az aks extension type version list --resource-group my-resource-group \
 --cluster-name mycluster --extension-type <type>
-    - name: List available K8s Extension Types in a region
+    - name: List available Cluster Extension Types in a region
       text: az aks extension type version list --location eastus --extension-type <type>
 """
 

src/aks-preview/azext_aks_preview/_helpers.py

@@ -403,8 +403,8 @@ def _check_if_extension_type_is_in_allow_list(extension_type_name):
 
 def raise_validation_error_if_extension_type_not_in_allow_list(extension_type_name):
     if not _check_if_extension_type_is_in_allow_list(extension_type_name):
-        raise ValidationError(f"Failed to get extension type version by cluster for {extension_type_name.lower()} " +
-                              f"as it is not in allowed list of extension types {allowed_extensions}")
+        raise ValidationError(f"Operation failed as extension type {extension_type_name.lower()} " +
+                              f"is not in allowed list of extension types {allowed_extensions}")
 
 
 def filter_hard_taints(node_initialization_taints: List[str]) -> List[str]:
@@ -442,3 +442,9 @@ def get_all_extensions_in_allow_list(result):
         if _check_if_extension_type_is_in_allow_list(obj.extension_type.lower()):
             output.append(obj)
     return output
+
+
+def get_extension_in_allow_list(result):
+    if _check_if_extension_type_is_in_allow_list(result.extension_type.lower()):
+        return result
+    return None

src/aks-preview/azext_aks_preview/_params.py

@@ -215,8 +215,8 @@
     validate_bootstrap_container_registry_resource_id,
     validate_gateway_prefix_size,
     validate_max_unavailable,
-    validate_location_cluster_name_resource_group_mutually_exclusive,
     validate_resource_group_parameter,
+    validate_location_resource_group_cluster_parameters,
 )
 from azext_aks_preview.azurecontainerstorage._consts import (
     CONST_ACSTOR_ALL,
@@ -2491,14 +2491,14 @@ def load_arguments(self, _):
                    help='Name of resource group.')
         c.argument('cluster_name',
                    options_list=['--cluster-name', '-c'],
-                   validator=validate_location_cluster_name_resource_group_mutually_exclusive,
+                   validator=validate_location_resource_group_cluster_parameters,
                    help='Name of the Kubernetes cluster')
         c.argument('extension_type',
                    options_list=['--extension-type', '-t'],
                    help='Name of the extension type.')
         c.argument('location',
                    options_list=['--location', '-l'],
-                   validator=validate_location_cluster_name_resource_group_mutually_exclusive,
+                   validator=validate_location_resource_group_cluster_parameters,
                    help='Name of the location. Values from: `az account list-locations`')
 
     # Reference: https://learn.microsoft.com/en-us/cli/azure/k8s-extension/extension-types?view=azure-cli-latest
@@ -2509,14 +2509,14 @@ def load_arguments(self, _):
                    help='Name of resource group.')
         c.argument('cluster_name',
                    options_list=['--cluster-name', '-c'],
-                   validator=validate_location_cluster_name_resource_group_mutually_exclusive,
+                   validator=validate_location_resource_group_cluster_parameters,
                    help='Name of the Kubernetes cluster')
         c.argument('extension_type',
                    options_list=['--extension-type', '-t'],
                    help='Name of the extension type.')
         c.argument('location',
                    options_list=['--location', '-l'],
-                   validator=validate_location_cluster_name_resource_group_mutually_exclusive,
+                   validator=validate_location_resource_group_cluster_parameters,
                    help='Name of the location. Values from: `az account list-locations`')
         c.argument('version',
                    help='Version for the extension type.')

src/aks-preview/azext_aks_preview/_validators.py

@@ -935,19 +935,25 @@ def validate_gateway_prefix_size(namespace):
             raise CLIError("--gateway-prefix-size must be in the range [28, 31]")
 
 
-def validate_location_cluster_name_resource_group_mutually_exclusive(namespace):
-    """Validates that location, cluster name, and resource group name are not specified at the same time"""
+def validate_resource_group_parameter(namespace):
+    """Validates that if the user specified the cluster name, resource group name is also specified and vice versa"""
+    if namespace.resource_group_name and not namespace.cluster_name:
+        raise RequiredArgumentMissingError("Please specify --cluster")
+    if not namespace.resource_group_name and namespace.cluster_name:
+        raise RequiredArgumentMissingError("Please specify --resource-group")
+
+
+def validate_location_resource_group_cluster_parameters(namespace):
+    """Validates location or cluster details are specified and not mutually exclusive"""
     location = namespace.location
     resource_group_name = namespace.resource_group_name
     cluster_name = namespace.cluster_name
+    if location and (resource_group_name or cluster_name):
+        raise RequiredArgumentMissingError(
+            "You must specify --location or --resource-group and --cluster."
+        )
+
     if location and resource_group_name and cluster_name:
         raise MutuallyExclusiveArgumentError(
             "Cannot specify --location and --resource-group and --cluster at the same time."
         )
-
-
-def validate_resource_group_parameter(namespace):
-    if namespace.resource_group_name and not namespace.cluster_name:
-        raise RequiredArgumentMissingError("Please specify --cluster")
-    if not namespace.resource_group_name and namespace.cluster_name:
-        raise RequiredArgumentMissingError("Please specify --resource-group")

src/aks-preview/azext_aks_preview/custom.py

@@ -71,6 +71,7 @@
     get_all_extension_types_in_allow_list,
     get_all_extensions_in_allow_list,
     raise_validation_error_if_extension_type_not_in_allow_list,
+    get_extension_in_allow_list,
 )
 from azext_aks_preview._podidentity import (
     _ensure_managed_identity_operator_permission,
@@ -3987,7 +3988,7 @@ def show_k8s_extension(cmd, client, resource_group_name, cluster_name, name):
             name,
             "managedClusters",
         )
-        return result
+        return get_extension_in_allow_list(result)
     except Exception as ex:
         logger.error("Failed to get K8s extension.\nError: %s", ex)