User Tools

Site Tools


main:guides:guid_continuous_delivery_file_contents

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
main:guides:guid_continuous_delivery_file_contents [2018/05/14 13:00]
95f48b0f5770dfea3f2652eb733ce711e99132a48ab3fefbe2ad073a6752078c@egi.eu [Examples]
main:guides:guid_continuous_delivery_file_contents [2020/09/23 10:12] (current)
7dec9e27b58a2d54a2a96a538813e805058cb792ed68e744a68d87708e39628c@egi.eu [Example 2: Extended configuration]
Line 1: Line 1:
 <fs 1.5em>**Guide for AppDB Virtual Appliance Continuous Delivery File Format**</fs> <fs 1.5em>**Guide for AppDB Virtual Appliance Continuous Delivery File Format**</fs>
 ---- ----
-<fs 1.2em>Continuous delivery file contains an object describing the current virtual appliance metadata. </fs>+<fs 1.2em>Continuous delivery file contains information describing the current virtual appliance metadata. </fs>
 ---- ----
- +<html><p style="border:1px solid #aeaeae; background-color: #fff7d5; padding: 5px 10px;line-height: 20px;"><span style="padding-right: 10px;font-size: 18px;"><b>!</b></span><span>Currently only <b>JSON</b>, <b>XML</b> or <b>YAML</b> formatted files are supported. See file structure examples in the <i>"Examples"</i> section bellow.</span></p></html> 
-====Schema====+=====Schema=====
 The contents must be wrapped inside a **appdb** field. The contents must be wrapped inside a **appdb** field.
 ^ Fields                      ^^ Type        ^ Constraints                           ^ Mandatory  ^ Defaults  ^ Accepted Values ^ ^ Fields                      ^^ Type        ^ Constraints                           ^ Mandatory  ^ Defaults  ^ Accepted Values ^
Line 11: Line 11:
 |notes            |           |text          |maximum 1000 chars                     |yes                  |                  | |notes            |           |text          |maximum 1000 chars                     |yes                  |                  |
 |url              |           |text          |any valid http(s) url                  |yes                  |                  | |url              |           |text          |any valid http(s) url                  |yes                  |                  |
 +|sha512                     |text          |any valid sha-512 hash value           |no          |          |**note**: if this value is provided, the system will compare it with the sha-512 result of the integrity check process. If the values do not match the process will fail and the VA version won't be published. This is meant as a security enhancement to prevent publishing tampered VM images to production.                  |
 |arch                       |text          |                                       |yes                  |text value from [[https://appdb.egi.eu/rest/1.0/applications/archs|archs api]]| |arch                       |text          |                                       |yes                  |text value from [[https://appdb.egi.eu/rest/1.0/applications/archs|archs api]]|
 |os                         |object        |                                       |yes                  |                  | |os                         |object        |                                       |yes                  |                  |
Line 26: Line 27:
 |network_traffic  |           |object[]      |                                       |no          |          |                  | |network_traffic  |           |object[]      |                                       |no          |          |                  |
 |network_traffic  |direction  |text          |                                       |no          |          |inbound, outbound | |network_traffic  |direction  |text          |                                       |no          |          |inbound, outbound |
-|network_traffic  |protocols  |text          |                                       |no          |          |tcp, udp, icmp, ipsec|+|network_traffic  |protocols  |text          |                                       |no          |          |tcp, udp, icmp|
 |network_traffic  |port_range |text          |format "<port_from>:<port_to>"         |no          |          |eg "80:80", "3000:3010"| |network_traffic  |port_range |text          |format "<port_from>:<port_to>"         |no          |          |eg "80:80", "3000:3010"|
 |accelerator      |           |object        |                                       |no          |          |                  | |accelerator      |           |object        |                                       |no          |          |                  |
Line 32: Line 33:
 |accelerator      |minimum    |number        |< =recommended                         |no          |0         |1, 2, 4, 8, 16, 32| |accelerator      |minimum    |number        |< =recommended                         |no          |0         |1, 2, 4, 8, 16, 32|
 |accelerator      |recommended|number        |> =minimum                             |no          |0         |1, 2, 4, 8, 16, 32| |accelerator      |recommended|number        |> =minimum                             |no          |0         |1, 2, 4, 8, 16, 32|
-====Examples====+=====Examples=====
 Βelow are some examples with pseudo values in various formats. Βelow are some examples with pseudo values in various formats.
  
 ====Example 1: Basic configuration==== ====Example 1: Basic configuration====
 +The examples bellow contain all of the mandatory fields of a description file
 ===XML File=== ===XML File===
 <code xml> <code xml>
Line 92: Line 94:
  
 ====Example 2: Extended configuration==== ====Example 2: Extended configuration====
 +The examples bellow contain all of the mandatory and all of the optional fields of a descriptions file, such as number of cores, size of ram etc
 ===XML File=== ===XML File===
 <code xml> <code xml>
Line 186: Line 189:
   notes: This version will expire in 3 months   notes: This version will expire in 3 months
   url: https://mydomain.com/images/myvmimagefile.iso   url: https://mydomain.com/images/myvmimagefile.iso
 +  sha512: f524df5c15c80650143f1b9431f3bdf73c6ccfef0c34294253e651c102053a253efc53804a733052afb26061b792aaca0ce70a62ade84268f285533b5b583bba
   arch: x86_64   arch: x86_64
   os:   os:
main/guides/guid_continuous_delivery_file_contents.1526302854.txt.gz · Last modified: 2018/05/14 13:00 by 95f48b0f5770dfea3f2652eb733ce711e99132a48ab3fefbe2ad073a6752078c@egi.eu