You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+202-8
Original file line number
Diff line number
Diff line change
@@ -40,14 +40,208 @@ the file and can be use as documentation for each field.
40
40
41
41
GNS3 checks the schema version, if the schema of an appliance is not supported it shows the error "Please update GNS3 in order to install this appliance".
Schema version 8 is introduced many changes in the appliance schema. The most important changes are:
56
+
57
+
* Support for `uefi_boot_mode` property in Qemu template properties.
58
+
* Possibility to have multiple set of settings to use with different image versions. Default settings are specified if
59
+
60
+
1. a `default` field set to `true` exists
61
+
2. there is only one set present.
62
+
63
+
**Notes**
64
+
65
+
A `template_type` field must be added to tell GNS3 what template to create (qemu, iou, dynamips or docker), mixing different template types is not supported at the moment.
66
+
All template specific properties are defined in a `template_properties` field.
67
+
68
+
**Example**
69
+
70
+
```json
71
+
"settings": [
72
+
{
73
+
"default": true,
74
+
"template_type": "qemu",
75
+
"template_properties": {
76
+
"platform": "x86_64",
77
+
"adapter_type": "e1000",
78
+
"adapters": 1,
79
+
"ram": 1024,
80
+
"console_type": "vnc"
81
+
}
82
+
},
83
+
{
84
+
"name": "i386 settings",
85
+
"template_type": "qemu",
86
+
"template_properties": {
87
+
"platform": "i386",
88
+
"adapters": 8
89
+
}
90
+
},
91
+
{
92
+
"name": "ARM settings",
93
+
"template_type": "qemu",
94
+
"template_properties": {
95
+
"platform": "arm",
96
+
"ram": 512
97
+
}
98
+
}
99
+
],
100
+
"versions": [
101
+
{
102
+
"name": "1.0",
103
+
"images": {
104
+
"hda_disk_image": "disk1.qcow2"
105
+
}
106
+
},
107
+
{
108
+
"name": "2.0",
109
+
"settings": "i386 settings",
110
+
"images": {
111
+
"hda_disk_image": "disk2.qcow2"
112
+
}
113
+
},
114
+
{
115
+
"name": "3.0",
116
+
"settings": "ARM settings",
117
+
"images": {
118
+
"hda_disk_image": "disk3.qcow2"
119
+
}
120
+
},
121
+
]
122
+
```
123
+
124
+
* The default settings are inherited by other settings set, this can be blocked by setting `inherit_default_properties` to `false`
125
+
* The controller template default is used if a template property is not defined or inherited from the default settings.
126
+
* The `md5sum` field is renamed `checksum`. The `md5sum` field is still accepted for easier migration from previous format versions.
127
+
* New optional `checksum_type` field for future development. The default and only checksum type remains MD5 for now.
128
+
* New optional `default_username` and `default_password` fields at the appliance and version levels.
129
+
* New optional `installation_instructions` field at the appliance and version levels to give download/unpack instructions to some appliances.
130
+
* New optional `compression_target` field to be used along with the compression field in future development.
131
+
* The `idlepc` field in versions section is moved to the `template_properties` for the `dynamips` template type
132
+
* The `first_port_name`, `port_name_format`, `port_segment_size` and `linked_clone` fields are moved to the `template_properties` for the qemu template type (these fields are only valid for Qemu templates).
133
+
* The `arch` field for qemu has been renamed `platform` to match the template properties on the controller side.
134
+
* The `kvm` field has been dropped and no longer required. Installing an appliance shouldn't take into account the available servers and their capabilities (e.g. capable of running kvm etc.)
135
+
* The `category`, `usage` and `symbol` fields can be defined in any `template_properties`. Defaults are at the appliance level or version level (they will be injected in `template_properties` if there aren't already defined there).
136
+
* The appliance version installed will be injected in the `version` field of the template (only controller version >= v3.0)
137
+
* Add `name` and `default_name_format` fields to all template properties.
138
+
* Add `console_resolution`, `extra_hosts` and `extra_volumes` to Docker template properties.
139
+
* Allow `spice+agent` in `console_type` for Qemu template properties.
0 commit comments