Always show TSG link for AzureMLKubernetes extension at the head (#161)

* Always show TSG link for AzureMLKubernetes extension at the head * refine tsg message * refine tsg message * move to 1.3.1 release * remove space Co-authored-by: Ubuntu <zetia@DevBox-zetia.1jltvvkrfgyuhl3llhmbyldkog.bx.internal.cloudapp.net> Co-authored-by: Bavneet Singh <[email protected]>
AzureArcForKubernetes · Aug 12, 2022 · 19c1598 · 19c1598
1 parent 486979c
commit 19c1598
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 11 deletions.
diff --git a/src/k8s-extension/HISTORY.rst b/src/k8s-extension/HISTORY.rst
@@ -3,6 +3,10 @@
 Release History
 ===============
 
+1.3.1
+++++++++++++++++++
+* microsoft.azureml.kubernetes: Always show TSG link for AzureMLKubernetes extension at the head.
+
 1.3.0
 ++++++++++++++++++
 * Add support for provisionedClusters

diff --git a/src/k8s-extension/azext_k8s_extension/partner_extensions/AzureMLKubernetes.py b/src/k8s-extension/azext_k8s_extension/partner_extensions/AzureMLKubernetes.py
@@ -46,6 +46,9 @@
 # pylint: disable=too-many-instance-attributes
 class AzureMLKubernetes(DefaultExtension):
     def __init__(self):
+        # tsg link
+        self.TSG_LINK = 'https://aka.ms/arcmltsg'
+
         # constants for configuration settings.
         self.DEFAULT_RELEASE_NAMESPACE = 'azureml'
         self.RELAY_CONNECTION_STRING_KEY = 'relayserver.relayConnectionString'
@@ -112,10 +115,13 @@ def Create(self, cmd, client, resource_group_name, cluster_name, name, cluster_t
                extension_type, scope, auto_upgrade_minor_version, release_train, version, target_namespace,
                release_namespace, configuration_settings, configuration_protected_settings,
                configuration_settings_file, configuration_protected_settings_file):
+
+        logger.warning("Troubleshooting: {}".format(self.TSG_LINK))
+
         if scope == 'namespace':
             raise InvalidArgumentValueError("Invalid scope '{}'.  This extension can't be installed "
                                             "only at 'cluster' scope. "
-                                            "Check https://aka.ms/arcmltsg for more information.".format(scope))
+                                            "Check {} for more information.".format(scope, self.TSG_LINK))
         # set release name explicitly to azureml
         release_namespace = self.DEFAULT_RELEASE_NAMESPACE
         scope_cluster = ScopeCluster(release_namespace=release_namespace)
@@ -217,10 +223,14 @@ def Create(self, cmd, client, resource_group_name, cluster_name, name, cluster_t
         return extension, name, create_identity
 
     def Delete(self, cmd, client, resource_group_name, cluster_name, name, cluster_type, cluster_rp, yes):
+        logger.warning("Troubleshooting: {}".format(self.TSG_LINK))
         user_confirmation_factory(cmd, yes)
 
     def Update(self, cmd, resource_group_name, cluster_name, auto_upgrade_minor_version, release_train, version, configuration_settings,
                configuration_protected_settings, original_extension, yes=False):
+
+        logger.warning("Troubleshooting: {}".format(self.TSG_LINK))
+
         input_configuration_settings = copy.deepcopy(configuration_settings)
         input_configuration_protected_settings = copy.deepcopy(configuration_protected_settings)
         # configuration_settings and configuration_protected_settings can be none, so need to set them to empty dict
@@ -335,9 +345,9 @@ def Update(self, cmd, resource_group_name, cluster_name, auto_upgrade_minor_vers
                 except azure.mgmt.relay.models.ErrorResponseException as ex:
                     if ex.response.status_code == 404:
                         raise ResourceNotFoundError("Relay server not found. "
-                                                    "Check https://aka.ms/arcmltsg for more information.") from ex
+                                                    "Check {} for more information.".format(self.TSG_LINK)) from ex
                     raise AzureResponseError("Failed to get relay connection string."
-                                             "Check https://aka.ms/arcmltsg for more information.") from ex
+                                             "Check {} for more information.".format(self.TSG_LINK)) from ex
 
             if original_extension_config_settings.get(self.SERVICE_BUS_ENABLED).lower() != 'false' \
                     and self.SERVICE_BUS_CONNECTION_STRING not in configuration_protected_settings:
@@ -349,9 +359,9 @@ def Update(self, cmd, resource_group_name, cluster_name, auto_upgrade_minor_vers
                 except azure.core.exceptions.HttpResponseError as ex:
                     if ex.response.status_code == 404:
                         raise ResourceNotFoundError("Service bus not found."
-                                                    "Check https://aka.ms/arcmltsg for more information.") from ex
+                                                    "Check {} for more information.".format(self.TSG_LINK)) from ex
                     raise AzureResponseError("Failed to get service bus connection string."
-                                             "Check https://aka.ms/arcmltsg for more information.") from ex
+                                             "Check {} for more information.".format(self.TSG_LINK)) from ex
 
             configuration_protected_settings = _dereference(self.reference_mapping, configuration_protected_settings)
 
@@ -384,7 +394,7 @@ def __normalize_config(self, configuration_settings, configuration_protected_set
             if not _is_valid_service_type(inferenceRouterServiceType):
                 raise InvalidArgumentValueError(
                     "inferenceRouterServiceType only supports NodePort or LoadBalancer or ClusterIP."
-                    "Check https://aka.ms/arcmltsg for more information.")
+                    "Check {} for more information.".format(self.TSG_LINK))
 
             feIsNodePort = str(inferenceRouterServiceType).lower() == 'nodeport'
             configuration_settings['scoringFe.serviceType.nodePort'] = feIsNodePort
@@ -407,7 +417,7 @@ def __validate_config(self, configuration_settings, configuration_protected_sett
                 logger.warning(
                     'Duplicate keys found in both configuration settings and configuration protected setttings: %s', key)
             raise InvalidArgumentValueError("Duplicate keys found."
-                                            "Check https://aka.ms/arcmltsg for more information.")
+                                            "Check {} for more information.".format(self.TSG_LINK))
 
         enable_training = _get_value_from_config_protected_config(
             self.ENABLE_TRAINING, configuration_settings, configuration_protected_settings)
@@ -425,7 +435,7 @@ def __validate_config(self, configuration_settings, configuration_protected_sett
                 "To create Microsoft.AzureML.Kubernetes extension, either "
                 "enable Machine Learning training or inference by specifying "
                 f"'--configuration-settings {self.ENABLE_TRAINING}=true' or '--configuration-settings {self.ENABLE_INFERENCE}=true'."
-                "Please check https://aka.ms/arcmltsg for more information.")
+                "Please check {} for more information.".format(self.TSG_LINK))
 
         configuration_settings[self.ENABLE_TRAINING] = configuration_settings.get(self.ENABLE_TRAINING, enable_training)
         configuration_settings[self.ENABLE_INFERENCE] = configuration_settings.get(
@@ -461,15 +471,15 @@ def __validate_scoring_fe_settings(self, configuration_settings, configuration_p
             if not sslCname:
                 raise InvalidArgumentValueError(
                     "To enable HTTPs endpoint, "
-                    "please specify sslCname parameter in --configuration-settings. Check https://aka.ms/arcmltsg for more information.")
+                    "please specify sslCname parameter in --configuration-settings. Check {} for more information.".format(self.TSG_LINK))
 
         inferenceRouterServiceType = _get_value_from_config_protected_config(
             self.inferenceRouterServiceType, configuration_settings, configuration_protected_settings)
         if not _is_valid_service_type(inferenceRouterServiceType):
             raise InvalidArgumentValueError(
                 "To use inference, "
                 "please specify inferenceRouterServiceType=ClusterIP or inferenceRouterServiceType=NodePort or inferenceRouterServiceType=LoadBalancer in --configuration-settings and also set internalLoadBalancerProvider=azure if your aks only supports internal load balancer."
-                "Check https://aka.ms/arcmltsg for more information.")
+                "Check {} for more information.".format(self.TSG_LINK))
 
         feIsNodePort = str(inferenceRouterServiceType).lower() == 'nodeport'
         internalLoadBalancerProvider = _get_value_from_config_protected_config(
@@ -479,7 +489,7 @@ def __validate_scoring_fe_settings(self, configuration_settings, configuration_p
         if feIsNodePort and feIsInternalLoadBalancer:
             raise MutuallyExclusiveArgumentError(
                 "When using nodePort as inferenceRouterServiceType, no need to specify internalLoadBalancerProvider."
-                "Check https://aka.ms/arcmltsg for more information.")
+                "Check {} for more information.".format(self.TSG_LINK))
         if feIsNodePort:
             configuration_settings['scoringFe.serviceType.nodePort'] = feIsNodePort
         elif feIsInternalLoadBalancer: