mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-08-29 13:30:12 +03:00
300c53e6fb
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.
338 lines
13 KiB
Python
338 lines
13 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2021 GNS3 Technologies Inc.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
import logging
|
|
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.
|
|
"""
|
|
|
|
def new_template(self, appliance_config, version, server):
|
|
"""
|
|
Creates a new template from an appliance.
|
|
"""
|
|
|
|
if appliance_config.get("registry_version", 0) >= 8:
|
|
return self._new_template_v8(appliance_config, version, server)
|
|
|
|
new_template = {
|
|
"compute_id": server,
|
|
"name": appliance_config["name"],
|
|
}
|
|
|
|
if version:
|
|
new_template["version"] = version.get("name")
|
|
|
|
if "usage" in appliance_config:
|
|
new_template["usage"] = appliance_config["usage"]
|
|
|
|
if appliance_config["category"] == "multilayer_switch":
|
|
new_template["category"] = "switch"
|
|
else:
|
|
new_template["category"] = appliance_config["category"]
|
|
|
|
if "symbol" in appliance_config:
|
|
new_template["symbol"] = appliance_config.get("symbol")
|
|
|
|
if "tags" in appliance_config:
|
|
new_template["tags"] = appliance_config.get("tags")
|
|
|
|
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:
|
|
new_template["symbol"] = ":/symbols/docker_guest.svg"
|
|
else:
|
|
new_template["symbol"] = ":/symbols/qemu_guest.svg"
|
|
elif appliance_config["category"] == "router":
|
|
new_template["symbol"] = ":/symbols/router.svg"
|
|
elif appliance_config["category"] == "switch":
|
|
new_template["symbol"] = ":/symbols/ethernet_switch.svg"
|
|
elif appliance_config["category"] == "multilayer_switch":
|
|
new_template["symbol"] = ":/symbols/multilayer_switch.svg"
|
|
elif appliance_config["category"] == "firewall":
|
|
new_template["symbol"] = ":/symbols/firewall.svg"
|
|
|
|
if "qemu" in appliance_config:
|
|
new_template["template_type"] = "qemu"
|
|
self._add_qemu_config(new_template, appliance_config, version)
|
|
elif "iou" in appliance_config:
|
|
new_template["template_type"] = "iou"
|
|
self._add_iou_config(new_template, appliance_config, version)
|
|
elif "dynamips" in appliance_config:
|
|
new_template["template_type"] = "dynamips"
|
|
self._add_dynamips_config(new_template, appliance_config, version)
|
|
elif "docker" in appliance_config:
|
|
new_template["template_type"] = "docker"
|
|
self._add_docker_config(new_template, appliance_config)
|
|
|
|
return new_template
|
|
|
|
def _add_qemu_config(self, new_config, appliance_config, version):
|
|
|
|
new_config.update(appliance_config["qemu"])
|
|
|
|
# the following properties are not valid for a template
|
|
new_config.pop("kvm", None)
|
|
new_config.pop("path", None)
|
|
new_config.pop("arch", None)
|
|
|
|
options = appliance_config["qemu"].get("options", "")
|
|
if appliance_config["qemu"].get("kvm", "allow") == "disable" and "-machine accel=tcg" not in options:
|
|
options += " -machine accel=tcg"
|
|
new_config["options"] = options.strip()
|
|
new_config.update(version.get("images"))
|
|
|
|
if "arch" in appliance_config["qemu"]:
|
|
new_config["platform"] = appliance_config["qemu"]["arch"]
|
|
|
|
if "first_port_name" in appliance_config:
|
|
new_config["first_port_name"] = appliance_config["first_port_name"]
|
|
|
|
if "port_name_format" in appliance_config:
|
|
new_config["port_name_format"] = appliance_config["port_name_format"]
|
|
|
|
if "port_segment_size" in appliance_config:
|
|
new_config["port_segment_size"] = appliance_config["port_segment_size"]
|
|
|
|
if "custom_adapters" in appliance_config:
|
|
new_config["custom_adapters"] = appliance_config["custom_adapters"]
|
|
|
|
if "linked_clone" in appliance_config:
|
|
new_config["linked_clone"] = appliance_config["linked_clone"]
|
|
|
|
def _add_docker_config(self, new_config, appliance_config):
|
|
|
|
new_config.update(appliance_config["docker"])
|
|
|
|
if "custom_adapters" in appliance_config:
|
|
new_config["custom_adapters"] = appliance_config["custom_adapters"]
|
|
|
|
def _add_dynamips_config(self, new_config, appliance_config, version):
|
|
|
|
new_config.update(appliance_config["dynamips"])
|
|
new_config["idlepc"] = version.get("idlepc", "")
|
|
new_config["image"] = version.get("images").get("image")
|
|
|
|
def _add_iou_config(self, new_config, appliance_config, version):
|
|
|
|
new_config.update(appliance_config["iou"])
|
|
new_config["path"] = version.get("images").get("image")
|
|
|
|
def _new_template_v8(self, appliance_config, version, server):
|
|
"""
|
|
Creates a new template from an appliance using the registry version 8 format.
|
|
"""
|
|
|
|
settings = self._select_v8_settings(appliance_config, version)
|
|
properties = self._merge_v8_properties(settings, appliance_config)
|
|
|
|
new_template = {
|
|
"compute_id": server,
|
|
"template_type": settings["template_type"],
|
|
"name": appliance_config["name"],
|
|
}
|
|
|
|
if version:
|
|
new_template["version"] = version.get("name")
|
|
|
|
# category/usage/symbol can be defined in template_properties (already merged above),
|
|
# otherwise at the version level, otherwise at the appliance level
|
|
for prop in ("category", "usage", "symbol"):
|
|
if prop not in properties:
|
|
if version and version.get(prop) is not None:
|
|
properties[prop] = version[prop]
|
|
elif appliance_config.get(prop) is not None:
|
|
properties[prop] = appliance_config[prop]
|
|
|
|
category_before_remap = properties.get("category")
|
|
if category_before_remap == "multilayer_switch":
|
|
properties["category"] = "switch"
|
|
|
|
if settings["template_type"] == "qemu":
|
|
# kvm is not a valid template property: convert it to the
|
|
# equivalent qemu options like for registry versions 1-6
|
|
kvm = properties.pop("kvm", None) or "allow"
|
|
options = properties.get("options") or ""
|
|
if kvm == "disable" and "-machine accel=tcg" not in options:
|
|
options += " -machine accel=tcg"
|
|
properties["options"] = options.strip()
|
|
|
|
# template_properties must not override the structural fields
|
|
for reserved in ("template_type", "compute_id", "version"):
|
|
properties.pop(reserved, None)
|
|
|
|
new_template.update(properties)
|
|
if "tags" in appliance_config:
|
|
new_template["tags"] = appliance_config.get("tags")
|
|
|
|
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":
|
|
if settings["template_type"] == "docker":
|
|
new_template["symbol"] = ":/symbols/docker_guest.svg"
|
|
else:
|
|
new_template["symbol"] = ":/symbols/qemu_guest.svg"
|
|
else:
|
|
symbols = {
|
|
"router": ":/symbols/router.svg",
|
|
"switch": ":/symbols/ethernet_switch.svg",
|
|
"multilayer_switch": ":/symbols/multilayer_switch.svg",
|
|
"firewall": ":/symbols/firewall.svg",
|
|
}
|
|
new_template["symbol"] = symbols.get(category_before_remap)
|
|
|
|
if version and version.get("images"):
|
|
if settings["template_type"] == "iou":
|
|
# IOU templates take the image path, not an image name
|
|
new_template["path"] = version["images"].get("image")
|
|
else:
|
|
new_template.update(version["images"])
|
|
|
|
if version and settings["template_type"] == "dynamips" and version.get("idlepc"):
|
|
# settings level idlepc takes precedence over the version level
|
|
new_template.setdefault("idlepc", version["idlepc"])
|
|
|
|
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
|
|
version: for registry versions 1-6 it comes from the emulator block, for
|
|
version 8 from the settings set selected for the version.
|
|
"""
|
|
|
|
if appliance_config.get("registry_version", 0) >= 8:
|
|
return self._select_v8_settings(appliance_config, version)["template_type"]
|
|
if "iou" in appliance_config:
|
|
return "iou"
|
|
if "dynamips" in appliance_config:
|
|
return "dynamips"
|
|
if "docker" in appliance_config:
|
|
return "docker"
|
|
return "qemu"
|
|
|
|
def _select_v8_settings(self, appliance_config, version):
|
|
"""
|
|
Selects the settings set to use: the one referenced by the version,
|
|
otherwise the default set, otherwise the only set present.
|
|
"""
|
|
|
|
settings_list = appliance_config.get("settings") or []
|
|
if not settings_list:
|
|
raise ControllerError(f"Appliance '{appliance_config['name']}' has no settings")
|
|
|
|
if version and version.get("settings"):
|
|
settings_name = version["settings"]
|
|
for settings in settings_list:
|
|
if settings.get("name") == settings_name:
|
|
return settings
|
|
raise ControllerError(
|
|
f"Could not find settings '{settings_name}' referenced by "
|
|
f"version '{version.get('name')}' in appliance '{appliance_config['name']}'"
|
|
)
|
|
|
|
for settings in settings_list:
|
|
if settings.get("default"):
|
|
return settings
|
|
|
|
if len(settings_list) == 1:
|
|
return settings_list[0]
|
|
|
|
raise ControllerError(
|
|
f"Appliance '{appliance_config['name']}' has multiple settings "
|
|
f"but none is marked as default"
|
|
)
|
|
|
|
def _merge_v8_properties(self, settings, appliance_config):
|
|
"""
|
|
Merges the template properties of the selected settings with the default
|
|
settings properties, unless inheritance is disabled or the default set
|
|
is selected. Only a default set of the same emulator type is inherited
|
|
from, so properties of a different type never pollute the template.
|
|
"""
|
|
|
|
properties = {}
|
|
if not settings.get("default") and settings.get("inherit_default_properties", True):
|
|
for other_settings in appliance_config.get("settings") or []:
|
|
if other_settings.get("default") and other_settings.get("template_type") == settings["template_type"]:
|
|
properties.update(other_settings.get("template_properties") or {})
|
|
break
|
|
properties.update(settings.get("template_properties") or {})
|
|
return properties
|