Added support of PARAVIRT interface type following IM change 6688
[osm/RO.git] / osm_ro / openmano_schemas.py
index ec15478..f717a4a 100644 (file)
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ##
-# Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
+# Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
 # This file is part of openmano
 # All Rights Reserved.
 #
@@ -37,6 +37,9 @@ description_schema={"type" : ["string","null"], "maxLength":255, "pattern" : "^[
 id_schema_fake = {"type" : "string", "minLength":2, "maxLength":36 }  #"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
 id_schema = {"type" : "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
 pci_schema={"type":"string", "pattern":"^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
+# allows [] for wildcards. For that reason huge length limit is set
+pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\[\]]{12,40}$"}
+
 http_schema={"type":"string", "pattern":"^https?://[^'\"=]+$"}
 bandwidth_schema={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"}
 memory_schema={"type":"string", "pattern" : "^[0-9]+ *([MG]i?[Bb])?$"}
@@ -101,9 +104,9 @@ config_schema = {
         "http_console_host": nameshort_schema,
         "http_console_ports": {
             "type": "array", 
-            "items": {"OneOf" : [
+            "items": {"OneOf": [
                 port_schema, 
-                {"type":"object", "properties":{"from": port_schema, "to": port_schema}, "required": ["from","to"]} 
+                {"type": "object", "properties": {"from": port_schema, "to": port_schema}, "required": ["from", "to"]}
             ]}
         },
         "log_level": log_level_schema,
@@ -283,15 +286,17 @@ datacenter_associate_schema={
     "type":"object",
     "properties":{
         "datacenter":{
-            "type":"object",
-            "properties":{
+            "type": "object",
+            "properties": {
+                "name": name_schema,
+                "vim_id": id_schema,
                 "vim_tenant": name_schema,
                 "vim_tenant_name": name_schema,
                 "vim_username": nameshort_schema,
                 "vim_password": nameshort_schema,
                 "config": {"type": "object"}
             },
-#            "required": ["vim_tenant"],
+            # "required": ["vim_tenant"],
             "additionalProperties": True
         }
     },
@@ -300,23 +305,23 @@ datacenter_associate_schema={
 }
 
 dhcp_schema = {
-    "title":"DHCP schema",
+    "title": "DHCP schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "type":"object",
+    "type": "object",
     "properties":{
         "enabled": {"type": "boolean"},
-        "start-address": ip_schema,
-        "count": integer1_schema
+        "start-address": {"OneOf": [{"type": "null"}, ip_schema]},
+        "count": integer0_schema
     },
-    "required": ["enabled", "start-address", "count"],
+    # "required": ["start-address", "count"],
 }
 
 ip_profile_schema = {
-    "title":"IP profile schema",
+    "title": "IP profile schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "type":"object",
-    "properties":{
-        "ip-version": {"type": "string", "enum": ["IPv4","IPv6"]},
+    "type": "object",
+    "properties": {
+        "ip-version": {"type": "string", "enum": ["IPv4", "IPv6"]},
         "subnet-address": ip_prefix_schema,
         "gateway-address": ip_schema,
         "dns-address": {"oneOf": [ip_schema,     # for backward compatibility
@@ -386,7 +391,7 @@ internal_connection_schema = {
         "name": name_schema,
         "description":description_schema,
         "type":{"type":"string", "enum":["bridge","data","ptp"]},
-        "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":2}
+        "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":1}
     },
     "required": ["name", "type", "elements"],
     "additionalProperties": False
@@ -400,7 +405,7 @@ internal_connection_schema_v02 = {
         "type": {"type": "string", "enum":["e-line", "e-lan"]},
         "implementation": {"type": "string", "enum":["overlay", "underlay"]},
         "ip-profile": ip_profile_schema,
-        "elements": {"type" : "array", "items": internal_connection_element_schema_v02, "minItems":2}
+        "elements": {"type" : "array", "items": internal_connection_element_schema_v02, "minItems":1}
     },
     "required": ["name", "type", "implementation", "elements"],
     "additionalProperties": False
@@ -460,7 +465,7 @@ bridge_interfaces_schema={
             "bandwidth":bandwidth_schema,
             "vpci":pci_schema,
             "mac_address": mac_schema,
-            "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
+            "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139", "paravirt"]},
             "port-security": {"type" : "boolean"},
             "floating-ip": {"type" : "boolean"}
         },
@@ -482,6 +487,7 @@ devices_schema={
             "size": size_schema,
             "vpci":pci_schema,
             "xml":xml_text_schema,
+            "name": name_schema,
         },
         "additionalProperties": False,
         "required": ["type"]
@@ -541,11 +547,12 @@ vnfc_schema = {
     "properties":{
         "name": name_schema,
         "description": description_schema,
+        "count": integer1_schema,
         "image name": name_schema,
         "availability_zone": name_schema,
         "VNFC image": {"oneOf": [path_schema, http_schema]},
         "image checksum": checksum_schema,
-        "image metadata": metadata_schema, 
+        "image metadata": metadata_schema,
         #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
         "processor": {
             "type":"object",
@@ -597,6 +604,7 @@ vnfd_schema_v01 = {
                 "class": nameshort_schema,
                 "public": {"type" : "boolean"},
                 "physical": {"type" : "boolean"},
+                "default_user": name_schema,
                 "tenant_id": id_schema, #only valid for admin
                 "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1},
                 "internal-connections": {"type" : "array", "items": internal_connection_schema, "minItems":1},
@@ -610,7 +618,7 @@ vnfd_schema_v01 = {
     "additionalProperties": False
 }
 
-#VNFD schema for OSM R1 
+#VNFD schema for OSM R1
 vnfd_schema_v02 = {
     "title":"vnfd information schema v0.2",
     "$schema": "http://json-schema.org/draft-04/schema#",
@@ -810,7 +818,7 @@ nsd_schema_v03 = {
                                                         "properties":{
                                                             "VNFC": name_schema,
                                                             "local_iface_name": name_schema,
-                                                            "ip_address": ip_schema
+                                                            "ip_address": ip_schema,
                                                         },
                                                         "required": ["VNFC", "local_iface_name"],
                                                     }
@@ -956,15 +964,17 @@ scenario_action_schema = {
 }
 
 instance_scenario_create_schema_v01 = {
-    "title":"instance scenario create information schema v0.1",
+    "title": "instance scenario create information schema v0.1",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "type":"object",
-    "properties":{
+    "type": "object",
+    "properties": {
         "schema_version": {"type": "string", "enum": ["0.1"]},
-        "instance":{
-            "type":"object",
-            "properties":{
-                "name":name_schema,
+        "instance": {
+            "type": "object",
+            "properties": {
+                "mgmt_keys": {"type": "array", "items": {"type":"string"}},
+                "vduImage": name_schema,
+                "name": name_schema,
                 "description":description_schema,
                 "datacenter": name_schema,
                 "scenario" : name_schema, #can be an UUID or name
@@ -982,41 +992,50 @@ instance_scenario_create_schema_v01 = {
                                 #"metadata": {"type": "object"},
                                 #"user_data": {"type": "string"}
                                 #"cloud-config": cloud_config_schema, #particular for a vnf
-                                "external-connections": {
+                                "vdus": {
                                     "type": "object",
                                     "patternProperties": {
                                         ".": {
                                             "type": "object",
                                             "properties": {
-                                                "vim-network-name": name_schema,
-                                                "ip_address": ip_schema
-                                            } 
+                                                "name": name_schema,  # overrides vdu name schema
+                                                "mgmt_keys": {"type": "array", "items": {"type": "string"}},
+                                                "vduImage": name_schema,
+                                                "devices": {
+                                                    "type": "object",
+                                                    "patternProperties": {
+                                                        ".": {
+                                                            "vim_id": name_schema,
+                                                        }
+                                                    }
+                                                },
+                                                "interfaces": {
+                                                    "type": "object",
+                                                    "patternProperties": {
+                                                        ".": {
+                                                            "ip_address": ip_schema,
+                                                            "mac_address": mac_schema,
+                                                            "floating-ip": {"type": "boolean"},
+                                                        }
+                                                    }
+                                                }
+                                            }
                                         }
                                     }
                                 },
-                                "internal-connections": {
+                                "networks": {
                                     "type": "object",
                                     "patternProperties": {
                                         ".": {
                                             "type": "object",
                                             "properties": {
+                                                "vim-network-name": name_schema,
                                                 "ip-profile": ip_profile_schema,
-                                                "elements": {
-                                                    "type" : "array",
-                                                    "items":{
-                                                        "type":"object",
-                                                        "properties":{
-                                                            "VNFC": name_schema,
-                                                            "local_iface_name": name_schema,
-                                                            "ip_address": ip_schema
-                                                        },
-                                                        "required": ["VNFC", "local_iface_name"],
-                                                    }
-                                                }
-                                            }
+                                                "name": name_schema,
+                                            } 
                                         }
                                     }
-                                }
+                                },
                             }
                         }
                     },
@@ -1065,9 +1084,6 @@ instance_scenario_create_schema_v01 = {
                                         }
                                     }
                                 },
-                                
-
-
                             }
                         }
                     },
@@ -1082,23 +1098,40 @@ instance_scenario_create_schema_v01 = {
 }
 
 instance_scenario_action_schema = {
-    "title":"instance scenario action information schema",
+    "title": "instance scenario action information schema",
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "type":"object",
-    "properties":{
-        "start":{"type": "null"},
-        "pause":{"type": "null"},
-        "resume":{"type": "null"},
-        "shutoff":{"type": "null"},
-        "shutdown":{"type": "null"},
-        "forceOff":{"type": "null"},
-        "rebuild":{"type": "null"},
-        "reboot":{
-            "type": ["object","null"],
+    "type": "object",
+    "properties": {
+        "start": {"type": "null"},
+        "pause": {"type": "null"},
+        "resume": {"type": "null"},
+        "shutoff": {"type": "null"},
+        "shutdown": {"type": "null"},
+        "forceOff": {"type": "null"},
+        "rebuild": {"type": "null"},
+        "reboot": {
+            "type": ["object", "null"],
         },
+        "add_public_key": description_schema,
         "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
-        "vnfs":{"type": "array", "items":{"type":"string"}},
-        "vms":{"type": "array", "items":{"type":"string"}}
+        "vdu-scaling": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "vdu-id": id_schema,
+                    "osm_vdu_id": name_schema,
+                    "member-vnf-index": name_schema,
+                    "count": integer1_schema,
+                    "type": {"enum": ["create", "delete"]}
+                },
+                "additionalProperties": False,
+                "minProperties": 1,
+                "required": ["type"]
+            }
+        },
+        "vnfs": {"type": "array", "items": {"type": "string"}},
+        "vms": {"type": "array", "items": {"type": "string"}}
     },
     "minProperties": 1,
     #"maxProperties": 1,
@@ -1162,7 +1195,7 @@ sdn_port_mapping_schema  = {
                         "items": {
                             "type": "object",
                             "properties": {
-                                "pci": pci_schema,
+                                "pci": pci_extended_schema,       # pci_schema,
                                 "switch_port": nameshort_schema,
                                 "switch_mac": mac_schema
                             },
@@ -1187,4 +1220,4 @@ sdn_external_port_schema = {
         "mac": mac_schema
     },
     "required": ["port"]
-}
\ No newline at end of file
+}