[Spring] Add migration command from Azure Spring Apps to Azure Container Apps (Azure#8538)

Author: ninpan-ms

src/spring/HISTORY.md

@@ -1,5 +1,9 @@
 Release History
 ===============
+1.27.0
+---
+* Add command `az spring export` which is used to generate target resources definitions to help customer migrating from Azure Spring Apps to other Azure services, such as Azure Container Apps.
+
 1.26.1
 ---
 * Fix command `az spring app update`, so that it can detect update failure and return error message.

src/spring/azext_spring/_help.py

@@ -1809,3 +1809,11 @@
         - name: Clean up private DNS zone with Azure Spring Apps.
           text: az spring private-dns-zone clean --service MyAzureSpringAppsInstance --resource-group MyResourceGroup
 """
+
+helps['spring export'] = """
+    type: command
+    short-summary: Commands to export target Azure resource definitions from Azure Spring Apps.
+    examples:
+        - name: Generate corresponding bicep files and README doc to create Azure Container Apps service.
+          text: az spring export --target aca --service MyAzureSpringAppsInstance --resource-group MyResourceGroup --output-folder output
+"""

src/spring/azext_spring/_params.py

@@ -1307,3 +1307,8 @@ def prepare_common_logs_argument(c):
         c.argument('zone_id', help='The resource id of the private DNS zone which you would like to configure with the service instance.')
     with self.argument_context('spring private-dns-zone clean') as c:
         c.argument('service', service_name_type)
+
+    with self.argument_context('spring export') as c:
+        c.argument('service', service_name_type)
+        c.argument('target', arg_type=get_enum_type(["aca", "azure-container-apps"]), help='The target Azure service to migrate to.')
+        c.argument('output_folder', help='The output folder for the generated Bicep files.')

src/spring/azext_spring/commands.py

@@ -5,6 +5,7 @@
 
 # pylint: disable=line-too-long
 from azure.cli.core.commands import CliCommandType
+from azure.cli.core.profiles import ResourceType
 from azext_spring._utils import handle_asc_exception
 
 from ._client_factory import (cf_spring,
@@ -519,5 +520,9 @@ def load_command_table(self, _):
                             exception_handler=handle_asc_exception, is_preview=True) as g:
         g.custom_command('list', 'job_execution_instance_list', validator=job_validators.validate_job_execution_instance_list)
 
+    with self.command_group('spring', custom_command_type=spring_routing_util, resource_type=ResourceType.MGMT_RESOURCE_RESOURCES,
+                            exception_handler=handle_asc_exception, is_preview=True) as g:
+        g.custom_command('export', 'spring_migration_start')
+
     with self.command_group('spring', exception_handler=handle_asc_exception):
         pass

src/spring/azext_spring/migration/__init__.py

@@ -0,0 +1,4 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------

src/spring/azext_spring/migration/converter/__init__.py

@@ -0,0 +1,4 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------

src/spring/azext_spring/migration/converter/acs_converter.py

@@ -0,0 +1,96 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+from knack.log import get_logger
+from .base_converter import BaseConverter
+
+logger = get_logger(__name__)
+
+
+# Concrete Converter Subclass for Config Server
+class ACSConverter(BaseConverter):
+
+    CONFIGURATION_KEY_PREFIX = "spring.cloud.config.server.git"
+    KEY_URI = ".uri"
+    KEY_LABEL = ".default-label"
+    KEY_SEARCH_PATHS = ".search-paths"
+    KEY_USERNAME = ".username"
+    KEY_PASSWORD = ".password"
+    KEY_PRIVATE_KEY = ".private-key"
+    KEY_HOST_KEY = ".host-key"
+    KEY_HOST_KEY_ALGORITHM = ".host-key-algorithm"
+    KEY_PATTERN = ".pattern"
+
+    def __init__(self, source):
+        def transform_data():
+            if self.wrapper_data.is_support_ossconfigserver() is False and self.wrapper_data.is_support_acs():
+                acs = self.wrapper_data.get_resources_by_type('Microsoft.AppPlatform/Spring/configurationServices')[0]
+                name = "config"
+                configurations, params = self._get_configurations_and_params(acs)
+                replicas = 2
+                return {
+                    "configServerName": name,
+                    "params": params,
+                    "configurations": configurations,
+                    "replicas": replicas
+                }
+            else:
+                return None
+        super().__init__(source, transform_data)
+
+    def get_template_name(self):
+        return "config_server.bicep"
+
+    def _get_configurations_and_params(self, acs):
+        configurations = []
+        params = []
+
+        git_repos = acs.get('properties', {}).get('settings', {}).get('gitProperty', {}).get('repositories', None)
+        if git_repos is not None and len(git_repos) > 0:
+            default_repo = git_repos[0]
+            self._add_property_if_exists(configurations, self.CONFIGURATION_KEY_PREFIX + self.KEY_URI, default_repo.get('uri'))
+            self._add_property_if_exists(configurations, self.CONFIGURATION_KEY_PREFIX + self.KEY_LABEL, default_repo.get('label'))
+            self._add_property_if_exists(configurations, self.CONFIGURATION_KEY_PREFIX + self.KEY_SEARCH_PATHS, default_repo.get('searchPaths'))
+            self._add_secret_config(self.CONFIGURATION_KEY_PREFIX + self.KEY_USERNAME, default_repo.get('username'), configurations, params)
+            self._add_secret_config(self.CONFIGURATION_KEY_PREFIX + self.KEY_PASSWORD, default_repo.get('password'), configurations, params)
+            self._add_secret_config(self.CONFIGURATION_KEY_PREFIX + self.KEY_PRIVATE_KEY, default_repo.get('privateKey'), configurations, params)
+            self._add_secret_config(self.CONFIGURATION_KEY_PREFIX + self.KEY_HOST_KEY, default_repo.get('hostKey'), configurations, params)
+            self._add_secret_config(self.CONFIGURATION_KEY_PREFIX + self.KEY_HOST_KEY_ALGORITHM, default_repo.get('hostKeyAlgorithm'), configurations, params)
+            self._check_patterns(default_repo)
+
+            for i in range(1, len(git_repos)):
+                repo = git_repos[i]
+                configuration_key_repo_prefix = self.CONFIGURATION_KEY_PREFIX + ".repos." + repo['name']
+                self._add_property_if_exists(configurations, configuration_key_repo_prefix + self.KEY_URI, repo.get('uri'))
+                self._add_property_if_exists(configurations, configuration_key_repo_prefix + self.KEY_LABEL, repo.get('label'))
+                self._add_property_if_exists(configurations, configuration_key_repo_prefix + self.KEY_SEARCH_PATHS, repo.get('searchPaths'))
+                self._add_secret_config(configuration_key_repo_prefix + self.KEY_USERNAME, repo.get('username'), configurations, params)
+                self._add_secret_config(configuration_key_repo_prefix + self.KEY_PASSWORD, repo.get('password'), configurations, params)
+                self._add_secret_config(configuration_key_repo_prefix + self.KEY_PRIVATE_KEY, repo.get('privateKey'), configurations, params)
+                self._add_secret_config(configuration_key_repo_prefix + self.KEY_HOST_KEY, repo.get('hostKey'), configurations, params)
+                self._add_secret_config(configuration_key_repo_prefix + self.KEY_HOST_KEY_ALGORITHM, repo.get('hostKeyAlgorithm'), configurations, params)
+                self._check_patterns(repo)
+
+        return configurations, params
+
+    def _add_property_if_exists(self, configurations, key, value):
+        if value:
+            if isinstance(value, (list, tuple)):
+                value = ",".join(map(str, value))
+            configurations.append({
+                "propertyName": key,
+                "value": value
+            })
+
+    def _add_secret_config(self, key, value, configurations, params):
+        if value:
+            param_name = key.replace(".", "_").replace("-", "_")
+            self._add_property_if_exists(configurations, key, param_name)
+            params.append(param_name)
+
+    def _check_patterns(self, repo):
+        patterns = repo.get('patterns', [])
+        if len(patterns) > 0:
+            pattern_str = ",".join(map(str, patterns))
+            logger.info(f"The patterns '{pattern_str}' of the git repository '{repo.get('name')}' in Application Configuration Service not need in Config Server of Azure Container Apps.")