templates: persist appliance metadata on install

Appliance fields that describe the appliance (vendor information, default
credentials, installation instructions...) were dropped when installing a
template. Keep them in a new appliance_metadata JSON column on the
templates table, filled by the appliance-to-template conversion for both
registry v1-6 and v8 (version level values override the appliance level
ones). The nested schema allows extra fields so future registry fields
persist without a migration.

gns3server/controller/appliance_to_template.py

@@ -23,6 +23,27 @@ from .controller_error import ControllerError
 log = logging.getLogger(__name__)
 
 
+# appliance fields that describe the appliance (vendor information, default
+# credentials...) and are kept on the template as metadata instead of being
+# dropped at installation time
+_APPLIANCE_METADATA_FIELDS = (
+    "description",
+    "vendor_name",
+    "vendor_url",
+    "vendor_logo_url",
+    "documentation_url",
+    "product_name",
+    "product_url",
+    "status",
+    "availability",
+    "maintainer",
+    "maintainer_email",
+    "installation_instructions",
+    "default_username",
+    "default_password",
+)
+
+
 class ApplianceToTemplate:
     """
     Appliance installation.
@@ -61,6 +82,10 @@ class ApplianceToTemplate:
         if appliance_config.get("netmiko_device_type"):
             new_template["netmiko_device_type"] = appliance_config["netmiko_device_type"]
 
+        appliance_metadata = self._build_appliance_metadata(appliance_config, version)
+        if appliance_metadata:
+            new_template["appliance_metadata"] = appliance_metadata
+
         if new_template.get("symbol") is None:
             if appliance_config["category"] == "guest":
                 if "docker" in appliance_config:
@@ -192,6 +217,10 @@ class ApplianceToTemplate:
         if appliance_config.get("netmiko_device_type"):
             new_template["netmiko_device_type"] = appliance_config["netmiko_device_type"]
 
+        appliance_metadata = self._build_appliance_metadata(appliance_config, version)
+        if appliance_metadata:
+            new_template["appliance_metadata"] = appliance_metadata
+
         if not new_template.get("symbol"):
             # apply a default symbol based on the effective category and template type
             if category_before_remap == "guest":
@@ -221,6 +250,26 @@ class ApplianceToTemplate:
 
         return new_template
 
+    def _build_appliance_metadata(self, appliance_config, version):
+        """
+        Builds the appliance metadata kept on the template: the fields that
+        describe the appliance, with version level values (e.g. credentials
+        specific to the installed version) overriding the appliance level ones.
+        """
+
+        version = version or {}
+        metadata = {}
+        for field in _APPLIANCE_METADATA_FIELDS:
+            value = version.get(field)
+            if value is None:
+                value = appliance_config.get(field)
+            if value is not None:
+                metadata[field] = value
+        appliance_id = appliance_config.get("appliance_id")
+        if appliance_id:
+            metadata["appliance_id"] = str(appliance_id)
+        return metadata or None
+
     def get_template_type(self, appliance_config, version):
         """
         Returns the template type of the settings set used to install the given