From 709de031ede9d9407a4830317b2c6c5f8969025b Mon Sep 17 00:00:00 2001 From: Victor Gao Date: Mon, 4 Jun 2018 16:05:09 +0800 Subject: handle model spec by branches Change-Id: I4ac13c55261be3e347b00c46fc21d721f8c3332b Issue-ID: MODELING-79 Signed-off-by: Victor Gao --- docs/ONAP Model Spec/dm/ArtifactTypes.rst | 9 + docs/ONAP Model Spec/dm/CapabilitiesTypes.rst | 39 + docs/ONAP Model Spec/dm/DataTypes.rst | 466 ++++++++ docs/ONAP Model Spec/dm/InterfaceTypes.rst | 65 ++ docs/ONAP Model Spec/dm/NodeTypes.rst | 263 +++++ docs/ONAP Model Spec/dm/RelationshipTypes.rst | 15 + docs/ONAP Model Spec/dm/index.rst | 20 + docs/ONAP Model Spec/im/AddressData.rst | 60 + .../im/AffinityOrAntiAffinityGroup.rst | 35 + docs/ONAP Model Spec/im/BaseConfigGroup.rst | 6 + docs/ONAP Model Spec/im/ConnectivityType.rst | 27 + docs/ONAP Model Spec/im/CpProtocolData.rst | 26 + docs/ONAP Model Spec/im/DeploymentGroup.rst | 8 + docs/ONAP Model Spec/im/L2AddressData.rst | 35 + docs/ONAP Model Spec/im/L3AddressData.rst | 56 + .../im/LifecycleManagementScript.rst | 165 +++ .../im/LocalAffinityOrAntiAffinityRule.rst | 27 + docs/ONAP Model Spec/im/MonitoringParameter.rst | 80 ++ docs/ONAP Model Spec/im/PlacementGroup.rst | 84 ++ docs/ONAP Model Spec/im/QoS.rst | 26 + .../im/RequestedAdditionalCapabilityData.rst | 61 + docs/ONAP Model Spec/im/ScaleInfo.rst | 21 + docs/ONAP Model Spec/im/SwImageDesc.rst | 144 +++ docs/ONAP Model Spec/im/VduLevel.rst | 24 + docs/ONAP Model Spec/im/VirtualCpuPinningData.rst | 46 + .../im/VnfConfigurableProperties.rst | 60 + docs/ONAP Model Spec/im/VnfIndicator.rst | 39 + .../im/VnfInfoModifiableAttributes.rst | 27 + .../im/VnfcConfigurableProperties.rst | 33 + docs/ONAP Model Spec/im/VnfdElementGroup.rst | 35 + docs/ONAP Model Spec/im/cpd.rst | 109 ++ docs/ONAP Model Spec/im/index.rst | 55 + docs/ONAP Model Spec/im/instantiationlevel.rst | 76 ++ .../ONAP Model Spec/im/linkbitraterequirements.rst | 52 + docs/ONAP Model Spec/im/logicalnodedata.rst | 53 + docs/ONAP Model Spec/im/vdu.rst | 201 ++++ docs/ONAP Model Spec/im/vducpd.rst | 64 ++ docs/ONAP Model Spec/im/vduprofile.rst | 152 +++ docs/ONAP Model Spec/im/virtualcomputedesc.rst | 56 + docs/ONAP Model Spec/im/virtualcpudata.rst | 86 ++ docs/ONAP Model Spec/im/virtuallinkdescflavour.rst | 18 + docs/ONAP Model Spec/im/virtuallinkprofile.rst | 152 +++ docs/ONAP Model Spec/im/virtualmemorydata.rst | 68 ++ .../im/virtualnetworkinterfacerequirements.rst | 90 ++ docs/ONAP Model Spec/im/virtualstoragedesc.rst | 58 + docs/ONAP Model Spec/im/vnfd.rst | 309 ++++++ docs/ONAP Model Spec/im/vnfdf.rst | 210 ++++ docs/ONAP Model Spec/im/vnfextcpd.rst | 61 + docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst | 62 ++ docs/ONAP Model Spec/index.rst | 17 + docs/ONAP release 1 spec/Usecase/VoLTE/e2e.rst | 15 - docs/ONAP release 1 spec/Usecase/VoLTE/index.rst | 19 - docs/ONAP release 1 spec/Usecase/VoLTE/ns.rst | 13 - docs/ONAP release 1 spec/Usecase/VoLTE/vnfs.rst | 45 - docs/ONAP release 1 spec/Usecase/index.rst | 17 - docs/ONAP release 1 spec/Usecase/vCPE/index.rst | 15 - docs/ONAP release 1 spec/csar/csar-sdc-input.JPG | Bin 38421 -> 0 bytes .../csar/csar-sdc-output-service.JPG | Bin 38698 -> 0 bytes .../csar/csar-sdc-output-vf.JPG | Bin 39089 -> 0 bytes docs/ONAP release 1 spec/csar/csar.rst | 140 --- docs/ONAP release 1 spec/csar/index.rst | 12 - docs/ONAP release 1 spec/dm/dm.rst | 1161 -------------------- docs/ONAP release 1 spec/dm/index.rst | 14 - docs/ONAP release 1 spec/im/index.rst | 17 - docs/ONAP release 1 spec/im/ns-im.rst | 200 ---- docs/ONAP release 1 spec/im/overlay-im.rst | 122 -- docs/ONAP release 1 spec/im/service-im.rst | 85 -- docs/ONAP release 1 spec/index.rst | 18 - docs/ONAP release 2 spec/dm/ArtifactTypes.rst | 9 - docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst | 39 - docs/ONAP release 2 spec/dm/DataTypes.rst | 466 -------- docs/ONAP release 2 spec/dm/InterfaceTypes.rst | 65 -- docs/ONAP release 2 spec/dm/NodeTypes.rst | 263 ----- docs/ONAP release 2 spec/dm/RelationshipTypes.rst | 15 - docs/ONAP release 2 spec/dm/index.rst | 20 - docs/ONAP release 2 spec/im/AddressData.rst | 60 - .../im/AffinityOrAntiAffinityGroup.rst | 35 - docs/ONAP release 2 spec/im/BaseConfigGroup.rst | 6 - docs/ONAP release 2 spec/im/ConnectivityType.rst | 27 - docs/ONAP release 2 spec/im/CpProtocolData.rst | 26 - docs/ONAP release 2 spec/im/DeploymentGroup.rst | 8 - docs/ONAP release 2 spec/im/L2AddressData.rst | 35 - docs/ONAP release 2 spec/im/L3AddressData.rst | 56 - .../im/LifecycleManagementScript.rst | 165 --- .../im/LocalAffinityOrAntiAffinityRule.rst | 27 - .../ONAP release 2 spec/im/MonitoringParameter.rst | 80 -- docs/ONAP release 2 spec/im/PlacementGroup.rst | 84 -- docs/ONAP release 2 spec/im/QoS.rst | 26 - .../im/RequestedAdditionalCapabilityData.rst | 61 - docs/ONAP release 2 spec/im/ScaleInfo.rst | 21 - docs/ONAP release 2 spec/im/SwImageDesc.rst | 144 --- docs/ONAP release 2 spec/im/VduLevel.rst | 24 - .../im/VirtualCpuPinningData.rst | 46 - .../im/VnfConfigurableProperties.rst | 60 - docs/ONAP release 2 spec/im/VnfIndicator.rst | 39 - .../im/VnfInfoModifiableAttributes.rst | 27 - .../im/VnfcConfigurableProperties.rst | 33 - docs/ONAP release 2 spec/im/VnfdElementGroup.rst | 35 - docs/ONAP release 2 spec/im/cpd.rst | 109 -- docs/ONAP release 2 spec/im/index.rst | 55 - docs/ONAP release 2 spec/im/instantiationlevel.rst | 76 -- .../im/linkbitraterequirements.rst | 52 - docs/ONAP release 2 spec/im/logicalnodedata.rst | 53 - docs/ONAP release 2 spec/im/vdu.rst | 201 ---- docs/ONAP release 2 spec/im/vducpd.rst | 64 -- docs/ONAP release 2 spec/im/vduprofile.rst | 152 --- docs/ONAP release 2 spec/im/virtualcomputedesc.rst | 56 - docs/ONAP release 2 spec/im/virtualcpudata.rst | 86 -- .../im/virtuallinkdescflavour.rst | 18 - docs/ONAP release 2 spec/im/virtuallinkprofile.rst | 152 --- docs/ONAP release 2 spec/im/virtualmemorydata.rst | 68 -- .../im/virtualnetworkinterfacerequirements.rst | 90 -- docs/ONAP release 2 spec/im/virtualstoragedesc.rst | 58 - docs/ONAP release 2 spec/im/vnfd.rst | 309 ------ docs/ONAP release 2 spec/im/vnfdf.rst | 210 ---- docs/ONAP release 2 spec/im/vnfextcpd.rst | 61 - docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst | 62 -- docs/ONAP release 2 spec/index.rst | 17 - docs/index.rst | 10 +- 119 files changed, 3953 insertions(+), 5852 deletions(-) create mode 100644 docs/ONAP Model Spec/dm/ArtifactTypes.rst create mode 100644 docs/ONAP Model Spec/dm/CapabilitiesTypes.rst create mode 100644 docs/ONAP Model Spec/dm/DataTypes.rst create mode 100644 docs/ONAP Model Spec/dm/InterfaceTypes.rst create mode 100644 docs/ONAP Model Spec/dm/NodeTypes.rst create mode 100644 docs/ONAP Model Spec/dm/RelationshipTypes.rst create mode 100644 docs/ONAP Model Spec/dm/index.rst create mode 100644 docs/ONAP Model Spec/im/AddressData.rst create mode 100644 docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst create mode 100644 docs/ONAP Model Spec/im/BaseConfigGroup.rst create mode 100644 docs/ONAP Model Spec/im/ConnectivityType.rst create mode 100644 docs/ONAP Model Spec/im/CpProtocolData.rst create mode 100644 docs/ONAP Model Spec/im/DeploymentGroup.rst create mode 100644 docs/ONAP Model Spec/im/L2AddressData.rst create mode 100644 docs/ONAP Model Spec/im/L3AddressData.rst create mode 100644 docs/ONAP Model Spec/im/LifecycleManagementScript.rst create mode 100644 docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst create mode 100644 docs/ONAP Model Spec/im/MonitoringParameter.rst create mode 100644 docs/ONAP Model Spec/im/PlacementGroup.rst create mode 100644 docs/ONAP Model Spec/im/QoS.rst create mode 100644 docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst create mode 100644 docs/ONAP Model Spec/im/ScaleInfo.rst create mode 100644 docs/ONAP Model Spec/im/SwImageDesc.rst create mode 100644 docs/ONAP Model Spec/im/VduLevel.rst create mode 100644 docs/ONAP Model Spec/im/VirtualCpuPinningData.rst create mode 100644 docs/ONAP Model Spec/im/VnfConfigurableProperties.rst create mode 100644 docs/ONAP Model Spec/im/VnfIndicator.rst create mode 100644 docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst create mode 100644 docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst create mode 100644 docs/ONAP Model Spec/im/VnfdElementGroup.rst create mode 100644 docs/ONAP Model Spec/im/cpd.rst create mode 100644 docs/ONAP Model Spec/im/index.rst create mode 100644 docs/ONAP Model Spec/im/instantiationlevel.rst create mode 100644 docs/ONAP Model Spec/im/linkbitraterequirements.rst create mode 100644 docs/ONAP Model Spec/im/logicalnodedata.rst create mode 100644 docs/ONAP Model Spec/im/vdu.rst create mode 100644 docs/ONAP Model Spec/im/vducpd.rst create mode 100644 docs/ONAP Model Spec/im/vduprofile.rst create mode 100644 docs/ONAP Model Spec/im/virtualcomputedesc.rst create mode 100644 docs/ONAP Model Spec/im/virtualcpudata.rst create mode 100644 docs/ONAP Model Spec/im/virtuallinkdescflavour.rst create mode 100644 docs/ONAP Model Spec/im/virtuallinkprofile.rst create mode 100644 docs/ONAP Model Spec/im/virtualmemorydata.rst create mode 100644 docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst create mode 100644 docs/ONAP Model Spec/im/virtualstoragedesc.rst create mode 100644 docs/ONAP Model Spec/im/vnfd.rst create mode 100644 docs/ONAP Model Spec/im/vnfdf.rst create mode 100644 docs/ONAP Model Spec/im/vnfextcpd.rst create mode 100644 docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst create mode 100644 docs/ONAP Model Spec/index.rst delete mode 100644 docs/ONAP release 1 spec/Usecase/VoLTE/e2e.rst delete mode 100644 docs/ONAP release 1 spec/Usecase/VoLTE/index.rst delete mode 100644 docs/ONAP release 1 spec/Usecase/VoLTE/ns.rst delete mode 100644 docs/ONAP release 1 spec/Usecase/VoLTE/vnfs.rst delete mode 100644 docs/ONAP release 1 spec/Usecase/index.rst delete mode 100644 docs/ONAP release 1 spec/Usecase/vCPE/index.rst delete mode 100644 docs/ONAP release 1 spec/csar/csar-sdc-input.JPG delete mode 100644 docs/ONAP release 1 spec/csar/csar-sdc-output-service.JPG delete mode 100644 docs/ONAP release 1 spec/csar/csar-sdc-output-vf.JPG delete mode 100644 docs/ONAP release 1 spec/csar/csar.rst delete mode 100644 docs/ONAP release 1 spec/csar/index.rst delete mode 100644 docs/ONAP release 1 spec/dm/dm.rst delete mode 100644 docs/ONAP release 1 spec/dm/index.rst delete mode 100644 docs/ONAP release 1 spec/im/index.rst delete mode 100644 docs/ONAP release 1 spec/im/ns-im.rst delete mode 100644 docs/ONAP release 1 spec/im/overlay-im.rst delete mode 100644 docs/ONAP release 1 spec/im/service-im.rst delete mode 100644 docs/ONAP release 1 spec/index.rst delete mode 100644 docs/ONAP release 2 spec/dm/ArtifactTypes.rst delete mode 100644 docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst delete mode 100644 docs/ONAP release 2 spec/dm/DataTypes.rst delete mode 100644 docs/ONAP release 2 spec/dm/InterfaceTypes.rst delete mode 100644 docs/ONAP release 2 spec/dm/NodeTypes.rst delete mode 100644 docs/ONAP release 2 spec/dm/RelationshipTypes.rst delete mode 100644 docs/ONAP release 2 spec/dm/index.rst delete mode 100644 docs/ONAP release 2 spec/im/AddressData.rst delete mode 100644 docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst delete mode 100644 docs/ONAP release 2 spec/im/BaseConfigGroup.rst delete mode 100644 docs/ONAP release 2 spec/im/ConnectivityType.rst delete mode 100644 docs/ONAP release 2 spec/im/CpProtocolData.rst delete mode 100644 docs/ONAP release 2 spec/im/DeploymentGroup.rst delete mode 100644 docs/ONAP release 2 spec/im/L2AddressData.rst delete mode 100644 docs/ONAP release 2 spec/im/L3AddressData.rst delete mode 100644 docs/ONAP release 2 spec/im/LifecycleManagementScript.rst delete mode 100644 docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst delete mode 100644 docs/ONAP release 2 spec/im/MonitoringParameter.rst delete mode 100644 docs/ONAP release 2 spec/im/PlacementGroup.rst delete mode 100644 docs/ONAP release 2 spec/im/QoS.rst delete mode 100644 docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst delete mode 100644 docs/ONAP release 2 spec/im/ScaleInfo.rst delete mode 100644 docs/ONAP release 2 spec/im/SwImageDesc.rst delete mode 100644 docs/ONAP release 2 spec/im/VduLevel.rst delete mode 100644 docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst delete mode 100644 docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst delete mode 100644 docs/ONAP release 2 spec/im/VnfIndicator.rst delete mode 100644 docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst delete mode 100644 docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst delete mode 100644 docs/ONAP release 2 spec/im/VnfdElementGroup.rst delete mode 100644 docs/ONAP release 2 spec/im/cpd.rst delete mode 100644 docs/ONAP release 2 spec/im/index.rst delete mode 100644 docs/ONAP release 2 spec/im/instantiationlevel.rst delete mode 100644 docs/ONAP release 2 spec/im/linkbitraterequirements.rst delete mode 100644 docs/ONAP release 2 spec/im/logicalnodedata.rst delete mode 100644 docs/ONAP release 2 spec/im/vdu.rst delete mode 100644 docs/ONAP release 2 spec/im/vducpd.rst delete mode 100644 docs/ONAP release 2 spec/im/vduprofile.rst delete mode 100644 docs/ONAP release 2 spec/im/virtualcomputedesc.rst delete mode 100644 docs/ONAP release 2 spec/im/virtualcpudata.rst delete mode 100644 docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst delete mode 100644 docs/ONAP release 2 spec/im/virtuallinkprofile.rst delete mode 100644 docs/ONAP release 2 spec/im/virtualmemorydata.rst delete mode 100644 docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst delete mode 100644 docs/ONAP release 2 spec/im/virtualstoragedesc.rst delete mode 100644 docs/ONAP release 2 spec/im/vnfd.rst delete mode 100644 docs/ONAP release 2 spec/im/vnfdf.rst delete mode 100644 docs/ONAP release 2 spec/im/vnfextcpd.rst delete mode 100644 docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst delete mode 100644 docs/ONAP release 2 spec/index.rst diff --git a/docs/ONAP Model Spec/dm/ArtifactTypes.rst b/docs/ONAP Model Spec/dm/ArtifactTypes.rst new file mode 100644 index 0000000..36a9759 --- /dev/null +++ b/docs/ONAP Model Spec/dm/ArtifactTypes.rst @@ -0,0 +1,9 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Artifact Types +============== + +| tosca.artifacts.nfv.SwImage: #don't need move to clean version +| derived_from: tosca.artifacts.Deployment.Image \ No newline at end of file diff --git a/docs/ONAP Model Spec/dm/CapabilitiesTypes.rst b/docs/ONAP Model Spec/dm/CapabilitiesTypes.rst new file mode 100644 index 0000000..d8ed14e --- /dev/null +++ b/docs/ONAP Model Spec/dm/CapabilitiesTypes.rst @@ -0,0 +1,39 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Capabilities Types +================== + +| **tosca.capabilities.nfv.VirtualBindable:** +| derived_from: tosca.capabilities.root + +| **tosca.capabilities.nfv.VirtualCompute:** +| derived_from: tosca.capabilities.Root +| properties: +| logical_node: +| type: tosca.datatypes.nfv.LogicalNodeData +| required: false +| compute_requirements: +| type: map +| required: false +| requested_additional_capabilities: +| type: map +| entry_schema: +| type: tosca.datatypes.nfv.RequestedAdditionalCapability +| required: false +| virtual_memory: +| type: tosca.datatypes.nfv.VirtualMemory +| required: true +| virtual_cpu: +| type: tosca.datatypes.nfv.VirtualCpu +| required: true + +| **tosca.capabilities.nfv.VirtualLinkable:** +| derived_from: tosca.capabilities.root + +| **tosca.capabilities.nfv.ExtVirtualLinkable:** +| derived_from: tosca.capabilities.root + +| **tosca.capabilities.nfv.VirtualStorage:** +| derived_from: tosca.capabilities.root diff --git a/docs/ONAP Model Spec/dm/DataTypes.rst b/docs/ONAP Model Spec/dm/DataTypes.rst new file mode 100644 index 0000000..3821cf5 --- /dev/null +++ b/docs/ONAP Model Spec/dm/DataTypes.rst @@ -0,0 +1,466 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Data Types +========== + +| **tosca.datatypes.nfv.L2AddressData:** +| derived_from: tosca.datatypes.Root +| properties: +| mac_address_assignment: +| type: Boolean +| required: true +| +| +| **tosca.datatypes.nfv.injectFile: #used for vCPE usecase** +| derived_from: tosca.datatypes.Root +| properties: +| source_path: +| type: string +| required: true +| dest_path: +| type:string +| required: true +| +| +| **tosca.datatypes.nfv.L3AddressData:** +| derived_from: tosca.datatypes.Root +| properties: +| ip_address_assignment: +| type: Boolean +| required: true +| floating_ip_activated: +| type: Boolean +| required: true +| ip_address_type: +| type: string +| required: false +| constraints: +| - valid_values: [ipv4, ipv6] +| number_of_ip_address: +| type: integer +| required: false +| fixed_ip_address: #used for vCPE usecase +| type:list +| entry_schema: +| type:string +| required: false +| +| +| **tosca.datatypes.nfv.AddressData:** +| derived_from: tosca.datatypes.Root +| properties: +| address_type: +| type: string +| required: true +| constraints: +| - valid_values: [mac_address, ip_address] +| l2_address_data: +| type: tosca.datatypes.nfv.L2AddressData # empty in "GS NFV IFA011 V0.7.3" +| required: false +| l3_address_data: +| type: tosca.datatypes.nfv.L3AddressData +| required: false +| +| +| **tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:** +| derived_from: tosca.datatypes.Root +| properties: +| name: +| type: string +| required: false +| description: +| type: string +| required: false +| support_mandatory: +| type: boolean +| required: true +| network_interface_requirements: +| type: Map +| required: true +| nic_io_requirements: +| type: tosca.datatypes.nfv.LogicalNodeData +| required: false +| +| +| **tosca.datatypes.nfv.ConnectivityType:** +| derived_from: tosca.datatypes.Root +| properties: +| layer_protocol: +| type: string +| required: true +| constraints: +| - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ] +| flow_pattern: +| type: string +| required: false +| constraints: # not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| - valid_values: [Line, Tree, Mesh] +| +| +| **tosca.datatypes.nfv.RequestedAdditionalCapability:** +| derived_from: tosca.datatypes.Root +| properties: +| #name: +| # key of containing map +| support_mandatory: +| type: boolean +| required: true +| min_requested_additional_capability_version: +| type: string +| required: false +| preferred_requested_additional_capability_version: +| type: string +| required: false +| requested_additional_capability_name: +| type: string +| required: true +| target_performance_parameters: +| type: map +| entry_schema: +| type: string +| required: true +| +| +| **tosca.datatypes.nfv.VirtualMemory:** +| derived_from: tosca.datatypes.Root +| properties: +| virtual_mem_size: +| type: scalar-unit.size # Number +| required: true +| virtual_mem_oversubscription_policy: +| type: string +| required: false +| vdu_memory_requirements: +| type: map +| required: false +| numa_enabled: +| type: boolean +| required: false +| +| +| **tosca.datatypes.nfv.VirtualCpu:** +| derived_from: tosca.datatypes.Root +| properties: +| cpu_architecture: +| type: string +| required: false +| num_virtual_cpu: +| type: integer +| required: true +| virtual_cpu_clock: +| type: scalar-unit.frequency +| required: false +| virtual_cpu_oversubscription_policy: +| type: string +| required: false +| vdu_cpu_requirements: +| type: map +| required: false +| virtual_cpu_pinning: +| type: tosca.datatypes.nfv.VirtualCpuPinning +| required: false +| +| +| **tosca.datatypes.nfv.VirtualCpuPinning:** +| derived_from: tosca.datatypes.Root +| properties: +| cpu_pinning_policy: +| type: string # CpuPinningPolicy +| constraints: +| - valid_values: [ static, dynamic ] +| required: false +| cpu_pinning_map: +| type: map +| entry_schema: +| type: string +| required: false +| +| +| **tosca.datatypes.nfv.VnfcConfigurableProperties:** +| derived_from: tosca.datatypes.Root +| properties: +| additional_vnfc_configurable_properties: +| type: map +| entry_schema: +| type: string +| required: false +| +| +| **tosca.datatypes.nfv.VduProfile:** +| derived_from: tosca.datatypes.Root +| properties: +| min_number_of_instances: +| type: integer +| required: true +| max_number_of_instances: +| type: integer +| required: true +| #localAffinityOrAntiAffinityRule: # not defined in SOL001 v.6.0 +| # type: tosca.datatypes.nfv.LocalAffinityOrAntiAffinityRule +| # required: true +| #affinityOrAntiAffinityGroupId: # not defined in SOL001 v.6.0 +| # type: string +| # required: true +| watchdog: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: string +| required: true +| vmBootUpTimeOut: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: integer +| required: optional +| +| +| **tosca.datatypes.nfv.VlProfile:** +| derived_from: tosca.datatypes.Root +| properties: +| max_bit_rate_requirements: +| type: tosca.datatypes.nfv.LinkBitRateRequirements +| required: true +| min_bit_rate_requirements: +| type: tosca.datatypes.nfv.LinkBitRateRequirements +| required: true +| qos: +| type: tosca.datatypes.nfv.Qos +| required: false +| initiationParameters: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: map +| entry_schema: +| type: string +| required: false +| cidr: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| networkName: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| startIp: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| endIp: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| gatewayIp: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| segmentationId: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: Integer +| required: false +| physicalNetwork: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| networkType: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: String +| required: false +| constraints: +| - valid_values: [VLAN, VXLAN] +| dhcpEnabled: # not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: Boolean +| required: false +| vlanTransparent: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 +| type: Boolean +| required: false +| +| +| **tosca.datatypes.nfv.InstantiationLevel:** +| derived_from: tosca.datatypes.Root +| properties: +| description: +| type: string +| required: true +| vdu_levels: +| type: map # key: vduId +| required: true +| entry_schema: +| type: tosca.datatypes.nfv.VduLevel +| scale_info: +| type: map # key: aspectId +| required: false +| entry_schema: +| type: tosca.datatypes.nfv.ScaleInfo +| +| +| **tosca.datatypes.nfv.VduLevel:** +| derived_from: tosca.datatypes.Root +| properties: +| number_of_instances: +| type: integer +| required: true + +| **tosca.datatypes.nfv.VnfLcmOperationsConfiguration:** +| derived_from: tosca.datatypes.Root +| properties: +| instantiate: +| type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration +| scale: +| type: tosca.datatypes.nfv.VnfScaleOperationConfiguration +| scale_to_level: +| type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration +| heal: +| type: tosca.datatypes.nfv.VnfHealOperationConfiguratin +| terminate: +| type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration +| operate: +| type: tosca.datatypes.nfv.VnfOperateOperationConfiguration +| +| +| **tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:** +| derived_from: tosca.datatypes.Root +| properties: +| #parameters: +| #modeled as part of operation parameter list +| +| +| **tosca.datatypes.nfv.VnfScaleOperationConfiguration:** +| derived_from: tosca.datatypes.Root +| properties: +| #parameters: +| #modeled as part of the operation parameter list +| scaling_by_more_than_one_step_supported: +| type: boolean +| +| +| **tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:** +| derived_from: tosca.datatypes.Root +| properties: +| #parameters: +| #modeled as part of the operation parameter list +| arbitrary_target_levels_supported: +| type: boolean +| +| +| **tosca.datatypes.nfv.VnfHealOperationConfiguration** +| derived_from: tosca.datatypes.Root +| properties: +| #parameters: +| #modeled as part of the operation parameter list +| causes: +| type: list +| entry_schema: +| type: string +| +| +| **tosca.datatypes.nfv.VnfTerminateOperationConfiguration** +| derived_from: tosca.datatypes.Root +| properties: +| min_graceful_termination_timeout: +| type: integer +| max_recommended_graceful_termination_timeout: +| type: integer +| +| +| +| **tosca.datatypes.nfv.VnfOperateOperationConfiguration** +| derived_from: tosca.datatypes.Root +| properties: +| min_graceful_termination_timeout: +| type: integer +| max_recommended_graceful_termination_timeout: +| type: integer +| +| +| **tosca.datatypes.nfv.ScaleInfo** +| derived_from: tosca.datatypes.Root +| properties: +| scaleLevel: +| type: integer +| required: true +| +| +| **tosca.datatypes.nfv.ScaleAspect:** +| derived_from: tosca.datatypes.Root +| properties: +| name: +| type: string +| required: true +| description: +| type: string +| required: true +| associated_group: +| type: string #Identifier +| required: false +| max_scale_level: +| type: integer #PositiveInteger +| required: true +| +| +| **tosca.datatypes.nfv.LinkBitRateRequirements:** +| derived_from: tosca.datatypes.Root +| properties: +| root: +| type: integer +| required: true +| leaf: +| type: integer +| required: true +| +| +| **tosca.datatypes.nfv.Qos:** +| derived_from: tosca.datatypes.Root +| properties: +| latency: +| type: integer #Number [ms] +| required: true +| packet_delay_variation: +| type: integer #Number [ms] +| required: true +| packet_loss_ratio: +| type: Scalar #Number [0 ..1] +| required: false +| +| +| **tosca.datatypes.nfv.CpProtocolData:** +| derived_from: tosca.datatypes.Root +| properties: +| asscociated_layer_protocol: +| type: string +| constraints: +| - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] +| required: true +| address_data: +| type: tosca.datatypes.nfv.AddressData +| required: false +| +| +| **tosca.datatypes.nfv.VnfConfigurableProperties:** +| derived_from: tosca.datatypes.Root +| properties: +| is_autoscale_enabled: +| type: boolean +| required: false +| is_autoheal_enabled: +| type: boolean +| required: false +| additional_configurable_properties: +| type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties +| required: false + +| **tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:** +| derived_from: tosca.datatypes.Root +| +| +| **tosca.datatypes.nfv.VnfInfoModifiableAttributes:** +| derived_from: tosca.datatypes.Root +| properties: +| extensions: +| type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions +| required: false +| metadata: +| type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata +| required: false +| +| +| **tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:** +| derived_from: tosca.datatypes.Root +| +| +| **tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:** +| derived_from: tosca.datatypes.Root +| +| +| **tosca.datatypes.nfv.LogicalNodeData:** +| derived_from: tosca.datatypes.Root +| properties: +| logical_node_requirements: +| type: map # not defined in SOL001 v.6.0 +| required: false \ No newline at end of file diff --git a/docs/ONAP Model Spec/dm/InterfaceTypes.rst b/docs/ONAP Model Spec/dm/InterfaceTypes.rst new file mode 100644 index 0000000..f4783a9 --- /dev/null +++ b/docs/ONAP Model Spec/dm/InterfaceTypes.rst @@ -0,0 +1,65 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Interface Types +=============== + +| **tosca.interfaces.nfv.vnf.lifecycle.Nfv** +| derived_from: tosca.interfaces.Root +| instantiate: +| description: Invoked upon receipt of an Instantiate VNF request +| instantiate_start: +| description: Invoked before instantiate +| instantiate_end: +| description: Invoked after instantiate +| terminate: +| description: Invoked upon receipt Terminate VNF request +| terminate_start: +| description: Invoked before terminate +| terminate_end: +| description: Invoked after terminate +| modify_information: +| description: Invoked upon receipt of a Modify VNF Information request +| modify_information_start: +| description: Invoked before modify_information +| modify_information_end: +| description: Invoked after modify_information +| change_flavour: +| description: Invoked upon receipt of a Change VNF Flavour request +| change_flavour_start: +| description: Invoked before change_flavour +| change_flavour_end: +| description: Invoked after change_flavour +| change_external_connectivity: +| description: Invoked upon receipt of a Change External VNF Connectivity request +| change_external_connectivity_start: +| description: Invoked before change_external_connectivity +| change_external_connectivity_end: +| description: Invoked after change_external_connectivity +| operate: +| description: Invoked upon receipt of an Operate VNF request +| operate_start: +| description: Invoked before operate +| operate_end: +| description: Invoked after operate +| heal: +| description: Invoked upon receipt of a Heal VNF request +| heal_start: +| description: Invoked before heal +| heal_end: +| description: Invoked after heal +| scale: +| description: Invoked upon receipt of a Scale VNF request +| scale_start: +| description: Invoked before scale +| scale_end: +| description: Invoked after scale +| scale_to_level: +| description: Invoked upon receipt of a Scale VNF to Level request +| scale_to_level_start: +| description: Invoked before scale_to_level +| scale_to_level_end: +| description: Invoked after scale_to_level +| # indicator_changed: +| # description: On receiving a VNF indicator value change notification \ No newline at end of file diff --git a/docs/ONAP Model Spec/dm/NodeTypes.rst b/docs/ONAP Model Spec/dm/NodeTypes.rst new file mode 100644 index 0000000..bdbdce5 --- /dev/null +++ b/docs/ONAP Model Spec/dm/NodeTypes.rst @@ -0,0 +1,263 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Node Types +========== + +| **tosca.nodes.nfv.Vdu.Compute:** +| derived_from: tosca.nodes.Root +| properties: +| #id: +| # node name +| name: # align with the IM, please refer to https://wiki.onap.org/display/DW/Design+Time+Model+Clean+Version#DesignTimeModelCleanVersion-Class:VDU/VDUDesc +| type: string +| required: true +| description: +| type: string +| required: true +| boot_order: +| type: map # explicit index (boot index) not necessary, contrary to IFA011. In the IM, it shoul be a array of KeyValuePair/NameValuePair +| entry_schema: +| type: string +| required: false +| nfvi_constraints: +| type: map # Align with IM, it shoul be a array of KeyValuePair/NameValuePair +| entry_schema: +| type: string +| required: false +| configurable_properties: +| type: map #In the IM, the multipilicity of VnfcConfigurableProperties is 1, not a map. +| entry_schema: +| type: tosca.datatypes.nfv.VnfcConfigurableProperties +| required: true +| vdu_profile: +| type: tosca.datatypes.nfv.VduProfile +| required: true +| inject_files: # Used for vCPE usecase Aligned with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v0.6.0. +| type: tosca.datatypes.nfv.injectFile +| required: false #Aligned with ONAP R2 IM. it should be false. +| meta_data: #metadata attached to the VM or container +| type: map +| entry_schema: +| type: string +| required: false +| user_data: #cloudinit userdata script support +| type: string +| required: false +| #attributes: NOT DEFINED IN ONAP IM and SOL001 +| #private_address: +| # status: deprecated +| #public_address: +| # status: deprecated +| #networks: +| # status: deprecated +| #ports: +| # status: deprecated +| capabilities: +| virtual_compute: +| type: tosca.capabilities.nfv.VirtualCompute +| virtual_binding: +| type: tosca.capabilities.nfv.VirtualBindable +| occurrences: [1, UNBOUND] +| monitoring_parameter: +| type: tosca.capabilities.nfv.Metric # this is not a very clear data structure enough to be coded, suggest to be annotated. +| occurrences: [0,UNBOUND] +| requirements: +| - virtual_storage: +| capability: tosca.capabilities.nfv.VirtualStorage +| relationship: tosca.relationships.nfv.Vdu.AttachedTo +| node: tosca.nodes.nfv.VDU.VirtualStorage +| occurences: [ 0, UNBOUNDED ] +| artifacts: +| - sw_image: +| file: +| type: tosca.artifacts.nfv.SwImage +| +| +| **tosca.nodes.nfv.Vdu.VirtualStorage:** +| derived_from: tosca.nodes.Root +| properties: +| #id: +| # node name +| type_of_storage: +| type: string +| constraints: +| - valid_values: [volume, object, root, block] +| required: true +| size_of_storage: +| type: scalar-unit.size +| required: true +| vdu_storage_requirements: +| type: map +| required: false +| rdma_enabled: +| type: boolean +| required: false +| capabilities: +| virtual_storage: +| type: tosca.capabilities.nfv.VirtualStorage +| artifacts: +| - sw_image: +| file: +| type: tosca.artifacts.Deployment.Image +| #interfaces: # not needed for virtualstroage. it doesn't support cloudinit. +| # cloudinit: +| # type:tosca.interfaces.nfv.vdu.cloudinit +| +| +| **tosca.nodes.nfv.Cp:** +| derived_from: tosca.nodes.Root +| properties: +| layer_protocol: +| type:list +| entry_schema: +| constraints: +| - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ] +| required:true +| role: #Name in ETSI NFV IFA011 v0.7.3 cpRole +| type:string +| constraints: +| - valid_values: [ root, leaf ] +| required:false +| description: +| type: string +| required: false +| protocol_data: +| type: list +| entry_schema: +| type: tosca.datatypes.nfv.CpProtocolData +| required:true +| trunk_mode: +| type: boolean +| required: true +| allowed_address_data: # Aligned with ONAP R2 Im.not defined in IFA011 v2.4.1 and SOL001 v0.6.0. +| type: tosca.datatypes.nfv.AddressData # In the IM, it is a array, but here it is not a array. TBD. +| required: false +| +| +| **tosca.nodes.nfv.VduCp:** +| derived_from: tosca.nodes.nfv.Cp +| properties: +| bitrate_requirement: +| type: integer +| required:false +| vnic_name: # Aligned with ONAP R2 Im.not defined in IFA011 v2.4.1 and SOL001 v0.6.0. +| type: string +| required:false +| vnic_order: # Aligned with ONAP R2 Im. not defined in IFA011 v2.4.1 and SOL001 v0.6.0. +| type: integer +| required:false +| vnic_type: # Aligned with ONAP R2 Im. not defined in IFA011 v2.4.1 and SOL001 v0.6.0 +| type: string +| constraints: +| - valid_values: [normal, macvtap, direct, baremetal, direct-physical, virtio-forwarder] +| required:false +| virtual_network_interface_requirements: +| type: list +| entry_schema: +| type: VirtualNetworkInterfaceRequirements +| required:false +| # order: #there is no this attribute in IM. +| # type: integer +| # required: false +| # constraints: +| # - greater_or_equal: 0 +| requirements: +| - virtual_link: +| capability: tosca.capabilities.nfv.VirtualLinkable +| relationship: tosca.relationships.nfv.VirtualLinksTo +| node: tosca.nodes.nfv.VnfVirtualLink +| - virtual_binding: +| capability: tosca.capabilities.nfv.VirtualBindable +| relationship: tosca.relationships.nfv.VirtualBindsTo +| node: tosca.nodes.nfv.Vdu.Compute +| +| +| **tosca.nodes.nfv.VnfVirtualLink:** +| derived_from: tosca.nodes.Root +| properties: +| connectivity_type: +| type: tosca.datatypes.nfv.ConnectivityType +| required: true +| description: +| type: string +| required: false +| test_access: +| type: list +| entry_schema: +| type: string +| required: false +| vl_profile: +| type: tosca.datatypes.nfv.VlProfile +| required: true +| capabilities: +| monitoring_parameter: # this is not a very clear data structure enough to be coded, suggest to be annotated. +| type: tosca.capabilities.nfv.Metric +| occurrences: [0,UNBOUND] +| virtual_linkable: +| type: tosca.capabilities.nfv.VirtualLinkable +| +| +| **tosca.nodes.nfv.VNF:** +| derived_from: tosca.nodes.Root +| properties: +| descriptor_id: # instead of vnfd_id +| type: string # GUID +| required: true +| descriptor_version: # instead of vnfd_version +| type: string +| required: true +| provider: # instead of vnf_provider +| type: string +| required: true +| product_name: # instead of vnf_product_name +| type: string +| required: true +| software_version: # instead of vnf_software_version +| type: string +| required: true +| product_info_name: # instead of vnf_product_info_name +| type: string +| required: false +| product_info_description: # instead of vnf_product_info_description +| type: string +| required: false +| vnfm_info: +| type: list +| entry_schema: +| type: string +| required: true +| localization_languages: +| type: list +| entry_schema: +| type: string +| required: false +| default_localization_language: +| type: string +| required: false +| configurable_properties: +| type: tosca.datatypes.nfv.VnfConfigurableProperties +| required: false +| modifiable_attributes: +| type: tosca.datatypes.nfv.VnfInfoModifiableAttributes +| required: false # true in IFA011, but all of members are false. Align with the IM, it is false +| flavour_id: +| type: string +| required: true +| flavour_description: +| type: string +| required: true +| capabilities: +| # monitoring_parameter: +| # modelled as ad hoc capabilities in the VNF node template +| requirements: +| - virtual_link: +| capability: tosca.capabilities.nfv.VirtualLinkable +| relationship: tosca.relationships.nfv.VirtualLinksTo +| node: tosca.nodes.nfv.VnfVirtualLink +| occurrences: [ 0, UNBOUNDED ] +| interfaces: +| Nfv: +| type: tosca.interfaces.nfv.vnf.lifecycle.Nfv +| \ No newline at end of file diff --git a/docs/ONAP Model Spec/dm/RelationshipTypes.rst b/docs/ONAP Model Spec/dm/RelationshipTypes.rst new file mode 100644 index 0000000..1c9965b --- /dev/null +++ b/docs/ONAP Model Spec/dm/RelationshipTypes.rst @@ -0,0 +1,15 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Relationships Types +=================== + +| **tosca.relationships.nfv.VirtualBindsTo:** +| derived_from: tosca.relationships.DependsOn +| valid_target_types: [ tosca.capabilities.nfv.VirtualBindable] +| +| +| **tosca.relationships.nfv.VirtualLinksTo:** +| derived_from: tosca.relationships.DependsOn +| valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable] diff --git a/docs/ONAP Model Spec/dm/index.rst b/docs/ONAP Model Spec/dm/index.rst new file mode 100644 index 0000000..bc44519 --- /dev/null +++ b/docs/ONAP Model Spec/dm/index.rst @@ -0,0 +1,20 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +.. onap-documentation documentation master file, created by + sphinx-quickstart on Mon Sep 18 15:12:14 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +ONAP Data Model Specifications +============================== + +.. toctree:: + :titlesonly: + + ArtifactTypes + CapabilitiesTypes + DataTypes + InterfaceTypes + NodeTypes + RelationshipTypes diff --git a/docs/ONAP Model Spec/im/AddressData.rst b/docs/ONAP Model Spec/im/AddressData.rst new file mode 100644 index 0000000..a3e703d --- /dev/null +++ b/docs/ONAP Model Spec/im/AddressData.rst @@ -0,0 +1,60 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: AddressData +================== + ++---------------+---------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++===============+===============+==================+=================+===============+ +| addressType | Identifier | 1 | Describes | support: | +| | | | the type of | MANDATORY | +| | | | the address to | | +| | | | be assigned to | | +| | | | the CP | | +| | | | instantiated | | +| | | | from the | | +| | | | parent CPD. | | +| | | | The content | | +| | | | type shall | | +| | | | be aligned | | +| | | | with the | | +| | | | address type | | +| | | | supported | | +| | | | by the | | +| | | | layerProtocol | | +| | | | attribute | | +| | | | of the | | +| | | | parent CPD. | | ++---------------+---------------+------------------+-----------------+---------------+ +| l2AddressData | L2AddressData | 0..1 | Provides the | support: | +| | | | information on | MANDATORY | +| | | | the MAC | | +| | | | addresses to be | | +| | | | assigned to | | +| | | | the CP(s) | | +| | | | instantiated | | +| | | | from the | | +| | | | parent CPD. | | +| | | | | | +| | | | Shall be present| | +| | | | when the | | +| | | | addressType is | | +| | | | MAC address. | | ++---------------+---------------+------------------+-----------------+---------------+ +| l3AddressData | L3AddressData | 0..1 | Provides the | support: | +| | | | information on | MANDATORY | +| | | | the IP addresses| | +| | | | to be assigned | | +| | | | to the CP | | +| | | | instantiated | | +| | | | from the | | +| | | | parent CPD. | | +| | | | | | +| | | | Shall be | | +| | | | present when | | +| | | | the addressType | | +| | | | is IP address. | | ++---------------+---------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst b/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst new file mode 100644 index 0000000..a2c8d72 --- /dev/null +++ b/docs/ONAP Model Spec/im/AffinityOrAntiAffinityGroup.rst @@ -0,0 +1,35 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: AffinityOrAntiAffinityGroup +================================== + ++-------------+-------------+------------------+-----------------+-----------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++=============+=============+==================+=================+=================+ +| groupId | Identifier | 1 | Identifies | support: | +| | | | an affinity or | MANDATORY | +| | | | anti-affinity | | +| | | | group to which | | +| | | | the affinity or | | +| | | | anti-affinity | | +| | | | rule applies. | | ++-------------+-------------+------------------+-----------------+-----------------+ +| type | Enum | 1 | Specifies | support: | +| | | | whether the rule| MANDATORY | +| | | | is an affinity | | +| | | | rule or an | valueRange: | +| | | | anti-affinity | "Affinity", | +| | | | rule. | "Anti-Affinity" | ++-------------+-------------+------------------+-----------------+-----------------+ +| scope | Enum | 1 | Specifies | support: | +| | | | the scope | MANDATORY | +| | | | of the rule. | | +| | | | | valueRange: | +| | | | | "NFVI-PoP", | +| | | | | "Zone", | +| | | | | "ZoneGroup", | +| | | | | "NFVI-node" | ++-------------+-------------+------------------+-----------------+-----------------+ diff --git a/docs/ONAP Model Spec/im/BaseConfigGroup.rst b/docs/ONAP Model Spec/im/BaseConfigGroup.rst new file mode 100644 index 0000000..2397c0e --- /dev/null +++ b/docs/ONAP Model Spec/im/BaseConfigGroup.rst @@ -0,0 +1,6 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: BaseConfigGroup (Experimental) +===================================== diff --git a/docs/ONAP Model Spec/im/ConnectivityType.rst b/docs/ONAP Model Spec/im/ConnectivityType.rst new file mode 100644 index 0000000..d47a1be --- /dev/null +++ b/docs/ONAP Model Spec/im/ConnectivityType.rst @@ -0,0 +1,27 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: ConnectivityType +======================= + ++---------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++===============+=============+==================+=================+===============+ +| layerProtocol | Enum | 1 | Identifies | support: | +| | | | the protocol | MANDATORY | +| | | | this VL gives | | +| | | | access to | | +| | | | (Ethernet, | | +| | | | MPLS, ODU2, | | +| | | | IPV4, IPV6, | | +| | | | Pseudo-Wire). | | ++---------------+-------------+------------------+-----------------+---------------+ +| flowPattern | String | 0..1 | Identifies | support: | +| | | | the flow | MANDATORY | +| | | | pattern of the | | +| | | | the connectivity| | +| | | | (Line, Tree, | | +| | | | Mesh). | | ++---------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/CpProtocolData.rst b/docs/ONAP Model Spec/im/CpProtocolData.rst new file mode 100644 index 0000000..c9cf840 --- /dev/null +++ b/docs/ONAP Model Spec/im/CpProtocolData.rst @@ -0,0 +1,26 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: CpProtocolData +===================== + ++-------------------------+-------------+------------------+-----------------+---------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | +| | | | | Stereotypes** | ++=========================+=============+==================+=================+===============+ +| associatedLayerProtocol | Enum | 1 | One of the | support: | +| | | | values of the | MANDATORY | +| | | | attribute | | +| | | | layerProtocol | | +| | | | of the Cpd IE. | | ++-------------------------+-------------+------------------+-----------------+---------------+ +| addressData | AddressData | 0..N | Provides | support: | +| | | | information | MANDATORY | +| | | | on the addresses| | +| | | | to be | | +| | | | assigned to | | +| | | | the CP(s) | | +| | | | instantiated | | +| | | | from the CPD. | | ++-------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/DeploymentGroup.rst b/docs/ONAP Model Spec/im/DeploymentGroup.rst new file mode 100644 index 0000000..4dd8b1e --- /dev/null +++ b/docs/ONAP Model Spec/im/DeploymentGroup.rst @@ -0,0 +1,8 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: DeploymentGroup (Experimental) +===================================== + +This class is experimental and the detailed definition is for further discussion. diff --git a/docs/ONAP Model Spec/im/L2AddressData.rst b/docs/ONAP Model Spec/im/L2AddressData.rst new file mode 100644 index 0000000..d4620df --- /dev/null +++ b/docs/ONAP Model Spec/im/L2AddressData.rst @@ -0,0 +1,35 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: L2AddressData +==================== + ++----------------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++======================+=============+==================+=================+===============+ +| macAddressAssignment | Boolean | 1 | Specify if | support: | +| | | | the MAC address | MANDATORY | +| | | | assignment | | +| | | | is the | | +| | | | responsibility | | +| | | | of management | | +| | | | and | | +| | | | orchestration | | +| | | | function or not.| | +| | | | | | +| | | | If it is set to | | +| | | | True, it is the | | +| | | | management and | | +| | | | orchestration | | +| | | | function | | +| | | | responsibility. | | +| | | | | | +| | | | If it is set to | | +| | | | False, it will | | +| | | | be provided by | | +| | | | an external | | +| | | | entity, e.g. | | +| | | | OSS/BSS.  | | ++----------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/L3AddressData.rst b/docs/ONAP Model Spec/im/L3AddressData.rst new file mode 100644 index 0000000..ccb651f --- /dev/null +++ b/docs/ONAP Model Spec/im/L3AddressData.rst @@ -0,0 +1,56 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: L3AddressData +==================== + ++---------------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++=====================+=============+==================+=================+===============+ +| iPAddressAssignment | Boolean | 1 | Specify if | support: | +| | | | the address | MANDATORY | +| | | | assignment | | +| | | | is the | | +| | | | responsibility | | +| | | | of management | | +| | | | and | | +| | | | orchestration | | +| | | | function or not.| | +| | | | | | +| | | | If it is set to | | +| | | | True, it is the | | +| | | | management and | | +| | | | orchestration | | +| | | | function | | +| | | | responsibility. | | ++---------------------+-------------+------------------+-----------------+---------------+ +| floatingIpActivated | Boolean | 1 | Specify if the | support: | +| | | | floating IP | MANDATORY | +| | | | scheme is | | +| | | | activated on | | +| | | | the CP or not. | | ++---------------------+-------------+------------------+-----------------+---------------+ +| iPAddressType | Enum | 0..1 | Define address | support: | +| | | | type. | MANDATORY | +| | | | | | +| | | | NOTE: The | valueRange: | +| | | | address type | "IPv4", | +| | | | should be | "IPv6" | +| | | | aligned with | | +| | | | the address type| | +| | | | supported by the| | +| | | | layerProtocol | | +| | | | attribute of | | +| | | | the parent Cpd. | | ++---------------------+-------------+------------------+-----------------+---------------+ +| numberOfIpAddress | Integer | 0..1 | Minimum | support: | +| | | | number of IP | MANDATORY | +| | | | addresses to be | | +| | | | assigned based | | +| | | | on this | | +| | | | L3AddressData | | +| | | | information | | +| | | | element. | | ++---------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/LifecycleManagementScript.rst b/docs/ONAP Model Spec/im/LifecycleManagementScript.rst new file mode 100644 index 0000000..b7ce432 --- /dev/null +++ b/docs/ONAP Model Spec/im/LifecycleManagementScript.rst @@ -0,0 +1,165 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: LifecycleManagementScript +================================ + ++--------------------+-------------+------------------+-------------------+-------------------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+==================+===================+=====================================+ +| event | Enum | 0..N | Describes | support: | +| | | | VNF | MANDATORY | +| | | | lifecycle | | +| | | | event(s) or | valueRange: | +| | | | an external | for | +| | | | stimulus | lifecycle | +| | | | detected on | events, | +| | | | a VNFM | include: | +| | | | reference | "EVENT_START_INSTANTIATION", | +| | | | point. | "EVENT_END_INSTANTIATION", | +| | | | | "EVENT_START_SCALING", | +| | | | NOTE: At | "EVENT_END_SCALING", | +| | | | least one | "EVENT_START_SCALING_TO_LEVEL", | +| | | | of these | "EVENT_END_SCALING_TO_LEVEL", | +| | | | two | "EVENT_START_HEALING", | +| | | | attributes | "EVENT_END_HEALING", | +| | | | shall be | "EVENT_START_TERMINATION", | +| | | | included. | "EVENT_END_TERMINATION", | +| | | | | "EVENT_START_VNF_FLAVOR_CHANGE", | +| | | | | "EVENT_END_VNF_FLAVOR_CHANGE", | +| | | | | "EVENT_START_VNF_OPERATION_CHANGE", | +| | | | | "EVENT_END_VNF_OPERATION_CHANGE", | +| | | | | "EVENT_START_VNF_EXT_CONN_CHANGE", | +| | | | | "EVENT_END_VNF_EXT_CONN_CHANGE", | +| | | | | "EVENT_START_VNFINFO_MODIFICATION", | +| | | | | "EVENT_END_VNFINFO_MODIFICATION"; | +| | | | | for | +| | | | | external | +| | | | | stimulus, | +| | | | | include: | +| | | | | receipt of | +| | | | | request | +| | | | | message of | +| | | | | instantiation, | +| | | | | scaling, | +| | | | | healing, | +| | | | | termination, | +| | | | | change of | +| | | | | VNF | +| | | | | flavour, | +| | | | | change of | +| | | | | the | +| | | | | operation | +| | | | | state of | +| | | | | the VNF, | +| | | | | change of | +| | | | | external | +| | | | | VNF | +| | | | | connectivity, | +| | | | | modification | +| | | | | of VNF | +| | | | | information | +| | | | | or the | +| | | | | receipt of | +| | | | | a | +| | | | | notification | +| | | | | regarding | +| | | | | the change | +| | | | | of a VNF | +| | | | | indicator | +| | | | | value. | ++--------------------+-------------+------------------+-------------------+-------------------------------------+ +| lcmTransitionEvent | String | 0..N | Describes | support: | +| | | | the | MANDATORY | +| | | | transition | | +| | | | VNF | | +| | | | lifecycle | | +| | | | event(s) | | +| | | | that cannot | | +| | | | be mapped | | +| | | | to any of | | +| | | | the | | +| | | | enumerated | | +| | | | values | | +| | | | defined for | | +| | | | the event | | +| | | | attribute. | | +| | | | | | +| | | | NOTE: At | | +| | | | least one | | +| | | | of these | | +| | | | two | | +| | | | attributes | | +| | | | shall be | | +| | | | included. | | ++--------------------+-------------+------------------+-------------------+-------------------------------------+ +| script | String | 1 | Information | support: | +| | | | to locate a | MANDATORY | +| | | | VNF LCM | | +| | | | script | | +| | | | (e.g. | | +| | | | written in | | +| | | | a DSL as | | +| | | | specified | | +| | | | in | | +| | | | requirement | | +| | | | VNF_PACK.LCM.001) | | +| | | | triggered | | +| | | | to react to | | +| | | | one of the | | +| | | | events | | +| | | | listed in | | +| | | | the event | | +| | | | attribute. | | ++--------------------+-------------+------------------+-------------------+-------------------------------------+ +| scriptDsl | String | 1 | Defines the | support: | +| | | | domain | MANDATORY | +| | | | specific | | +| | | | language | | +| | | | (i.e. the | | +| | | | type) of | | +| | | | script that | | +| | | | is | | +| | | | provided. | | +| | | | Types of | | +| | | | scripts | | +| | | | could | | +| | | | include | | +| | | | bash, | | +| | | | python, | | +| | | | etc. | | ++--------------------+-------------+------------------+-------------------+-------------------------------------+ +| scriptInput | KeyValuePair| 0..N | Array of | support: | +| | | | KVP | MANDATORY | +| | | | requirements | | +| | | | with the | | +| | | | key as the | | +| | | | parameter | | +| | | | name and | | +| | | | the value | | +| | | | as the | | +| | | | parameter | | +| | | | that need | | +| | | | to be | | +| | | | passed as | | +| | | | an input to | | +| | | | the script. | | +| | | | | | +| | | | NOTE: The | | +| | | | scriptInput | | +| | | | values are | | +| | | | passed to | | +| | | | the scripts | | +| | | | in addition | | +| | | | to the | | +| | | | parameters | | +| | | | received in | | +| | | | the | | +| | | | operation | | +| | | | invocation | | +| | | | request or | | +| | | | indicator | | +| | | | value | | +| | | | change. | | ++--------------------+-------------+------------------+-------------------+-------------------------------------+ diff --git a/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst b/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst new file mode 100644 index 0000000..57d1f63 --- /dev/null +++ b/docs/ONAP Model Spec/im/LocalAffinityOrAntiAffinityRule.rst @@ -0,0 +1,27 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: LocalAffinityOrAntiAffinityRule +====================================== + ++-------------+-------------+------------------+-----------------+----------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++=============+=============+==================+=================+================+ +| type | Enum | 1 | Specifies | support: | +| | | | whether the rule| MANDATORY | +| | | | is an affinity | | +| | | | rule or an | valueRange: | +| | | | anti-affinity | "Affinity", | +| | | | rule. | "Anti-Affinity"| ++-------------+-------------+------------------+-----------------+----------------+ +| scope | Enum | 1 | Specifies the | support: | +| | | | scope of the | MANDATORY | +| | | | rule. | | +| | | | | valueRange: | +| | | | | "NFVI-PoP", | +| | | | | "Zone", | +| | | | | "ZoneGroup", | +| | | | | "NFVI-node" | ++-------------+-------------+------------------+-----------------+----------------+ diff --git a/docs/ONAP Model Spec/im/MonitoringParameter.rst b/docs/ONAP Model Spec/im/MonitoringParameter.rst new file mode 100644 index 0000000..9dfc5b9 --- /dev/null +++ b/docs/ONAP Model Spec/im/MonitoringParameter.rst @@ -0,0 +1,80 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: MonitoringParameter +========================== + ++-------------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++===================+=============+==================+=================+===============+ +| id | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of the | | +| | | | monitoring | | +| | | | parameter. | | ++-------------------+-------------+------------------+-----------------+---------------+ +| name | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | name of the | | +| | | | monitoring | | +| | | | parameter. | | ++-------------------+-------------+------------------+-----------------+---------------+ +| performanceMetric | String | 1 | Identifies | support: | +| | | | the | MANDATORY | +| | | | virtualised | | +| | | | resource | | +| | | | performance | | +| | | | metric. | | ++-------------------+-------------+------------------+-----------------+---------------+ +| collectionPeriod | Not | 0..1 | An | support: | +| | specified | | attribute | MANDATORY | +| | | | that | | +| | Editor's | | describes | | +| | note: need | | the | | +| | to be | | recommended | | +| | specified | | periodicity | | +| | | | at which to | | +| | | | collect the | | +| | | | performance | | +| | | | information. | | +| | | | | | +| | | | VNFM | | +| | | | determines | | +| | | | if this | | +| | | | parameter | | +| | | | is | | +| | | | considered. | | +| | | | | | +| | | | The vendor | | +| | | | may provide | | +| | | | this | | +| | | | information | | +| | | | as a | | +| | | | guidance | | +| | | | for | | +| | | | creating | | +| | | | PmJobs if | | +| | | | needed. | | +| | | | | | +| | | | NOTE: The | | +| | | | MANO or | | +| | | | NFVI may | | +| | | | not support | | +| | | | the | | +| | | | recommended | | +| | | | collectionPeriod| | +| | | | based on | | +| | | | their | | +| | | | functionalities,| | +| | | | and can | | +| | | | reject the | | +| | | | requests | | +| | | | based on | | +| | | | the | | +| | | | recommended | | +| | | | collectionPeriod| | +| | | | in this | | +| | | | case. | | ++-------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/PlacementGroup.rst b/docs/ONAP Model Spec/im/PlacementGroup.rst new file mode 100644 index 0000000..db8008b --- /dev/null +++ b/docs/ONAP Model Spec/im/PlacementGroup.rst @@ -0,0 +1,84 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: PlacementGroup (Experimental) +==================================== + ++-------------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++===================+=============+==================+=================+===============+ +| elementGroupId | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this | | +| | | | group in | | +| | | | the VNFD. | | ++-------------------+-------------+------------------+-----------------+---------------+ +| placementStrategy | Enum | 1 | Determine | support: | +| | | | where | MANDATORY | +| | | | VNFC's | | +| | | | (VDU's) are | valueRange: | +| | | | placed with | "co-location",| +| | | | respect to | "isolation", | +| | | | the VNF. | "exclusively" | +| | | | | | +| | | | | NOTE: | +| | | | | | +| | | | | - Co-location| +| | | | | - | +| | | | | members | +| | | | | of the | +| | | | | group | +| | | | | share | +| | | | | the same | +| | | | | physical | +| | | | | host or | +| | | | | rack. | +| | | | | | +| | | | | - isolation | +| | | | | - | +| | | | | members | +| | | | | of the | +| | | | | group do | +| | | | | not | +| | | | | share | +| | | | | the same | +| | | | | physical | +| | | | | host or | +| | | | | rack. | +| | | | | | +| | | | | - Exclusively| +| | | | | - | +| | | | | members | +| | | | | have | +| | | | | sole use | +| | | | | of a | +| | | | | given | +| | | | | physical | +| | | | | host or | +| | | | | rack | +| | | | | (not | +| | | | | shared | +| | | | | with any | +| | | | | vnfcs | +| | | | | outside | +| | | | | the | +| | | | | group). | ++-------------------+-------------+------------------+-----------------+---------------+ +| vnfcMembers | Not | 0..N | References | support: | +| | specified | | to Vdus | MANDATORY | +| | | | that are | | +| | | | part of | | +| | | | this group. | | +| | | | | | +| | | | | | +| | | | | | ++-------------------+-------------+------------------+-----------------+---------------+ +| strategyScope | Enum | 1 | indicate if | support: | +| | | | the | MANDATORY | +| | | | strategy is | | +| | | | applied at | valueRange: | +| | | | the host or | "host", | +| | | | rack level | "rack" | ++-------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/QoS.rst b/docs/ONAP Model Spec/im/QoS.rst new file mode 100644 index 0000000..8f64127 --- /dev/null +++ b/docs/ONAP Model Spec/im/QoS.rst @@ -0,0 +1,26 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: QoS +========== + ++--------------------+-------------+------------------+-----------------+---------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | +| | | | | Stereotypes** | ++====================+=============+==================+=================+===============+ +|latency | Number | 1 | Maximum | support: | +| | | | latency in ms. | MANDATORY | ++--------------------+-------------+------------------+-----------------+---------------+ +|packetDelayVariation| Number | 1 | Maximum | support: | +| | | | jitter in ms. | MANDATORY | ++--------------------+-------------+------------------+-----------------+---------------+ +|packetLossRatio | Number | 0..1 | Maximum | support: | +| | | | packet loss | MANDATORY | +| | | | ratio. | | +| | | | Cardinality | | +| | | | is 0 if no | | +| | | | packetLossRatio | | +| | | | requirement | | +| | | | exists. | | ++--------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst b/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst new file mode 100644 index 0000000..ce9ab2f --- /dev/null +++ b/docs/ONAP Model Spec/im/RequestedAdditionalCapabilityData.rst @@ -0,0 +1,61 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: RequestedAdditionalCapabilityData +======================================== + ++-----------------------------------------------+-------------+------------------+-----------------+---------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | +| | | | | Stereotypes** | ++===============================================+=============+==================+=================+===============+ +| requestedAdditionalCapabilityName | String | 1 | Identifies | support: | +| | | | a requested | MANDATORY | +| | | | additional | | +| | | | capability | valueRange: | +| | | | for the | For | +| | | | VDU. | acceleration | +| | | | | capabilities, | +| | | | | reference | +| | | | | to ETSI GS | +| | | | | NFV-IFA | +| | | | | 002. | ++-----------------------------------------------+-------------+------------------+-----------------+---------------+ +| supportMandatory | Boolean | 1 | Indicates | support: | +| | | | whether the | MANDATORY | +| | | | requested | | +| | | | additional | | +| | | | capability | | +| | | | is | | +| | | | mandatory | | +| | | | for | | +| | | | successful | | +| | | | operation. | | ++-----------------------------------------------+-------------+------------------+-----------------+---------------+ +| minRequestedAdditionalCapabilityVersion | String | 0..1 | Identifies | support: | +| | | | the minimum | MANDATORY | +| | | | version of | | +| | | | the | | +| | | | requested | | +| | | | additional | | +| | | | capability. | | ++-----------------------------------------------+-------------+------------------+-----------------+---------------+ +| preferredRequestedAdditionalCapabilityVersion | String | 0..1 | Identifies | support: | +| | | | the | MANDATORY | +| | | | preferred | | +| | | | version of | | +| | | | the | | +| | | | requested | | +| | | | additional | | +| | | | capability. | | ++-----------------------------------------------+-------------+------------------+-----------------+---------------+ +| targetPerformanceParameters | KeyValuePair| 1..N | Identifies | support: | +| | | | specific | MANDATORY | +| | | | attributes, | | +| | | | dependent | | +| | | | on the | | +| | | | requested | | +| | | | additional | | +| | | | capability | | +| | | | type. | | ++-----------------------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/ScaleInfo.rst b/docs/ONAP Model Spec/im/ScaleInfo.rst new file mode 100644 index 0000000..14f74cf --- /dev/null +++ b/docs/ONAP Model Spec/im/ScaleInfo.rst @@ -0,0 +1,21 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: ScaleInfo +================ + ++--------------------+----------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+================+==================+=================+==========================+ +| aspectId | Identifier | 1 | Reference | support: | +| | (Reference | | to the | MANDATORY | +| | to | | scaling | | +| | ScalingAspect) | | aspect. | | ++--------------------+----------------+------------------+-----------------+--------------------------+ +| scaleLevel | Integer | 1 | The scale | support: | +| | | | level, | MANDATORY | +| | | | greater | | +| | | | than or | | +| | | | equal to 0. | | ++--------------------+----------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/SwImageDesc.rst b/docs/ONAP Model Spec/im/SwImageDesc.rst new file mode 100644 index 0000000..2add32f --- /dev/null +++ b/docs/ONAP Model Spec/im/SwImageDesc.rst @@ -0,0 +1,144 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: SwImageDesc +================== + ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++===================================+===================+==================+===================+==========================+ +| id | Identifier | 1 | The | support: | +| | | | identifier | MANDATORY | +| | | | of this | | +| | | | software | | +| | | | image. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| name | String | 1 | The name of | support: | +| | | | this | MANDATORY | +| | | | software | | +| | | | image. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| version | String | 1 | The version | support: | +| | | | of this | MANDATORY | +| | | | software | | +| | | | image. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| checksum | String | 1 | The | support: | +| | | | checksum of | MANDATORY | +| | | | the | | +| | | | software | | +| | | | image file. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| containerFormat | String | 1 | The | support: | +| | | | container | MANDATORY | +| | | | format | | +| | | | describes | | +| | | | the | | +| | | | container | | +| | | | file format | | +| | | | in which | | +| | | | software | | +| | | | image is | | +| | | | provided. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| diskFormat | String | 1 | The disk | support: | +| | | | format of a | MANDATORY | +| | | | software | | +| | | | image is | | +| | | | the format | | +| | | | of the | | +| | | | underlying | | +| | | | disk image. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| minDisk | Number | 1 | The minimal | support: | +| | (recommended | | disk size | MANDATORY | +| | DM type: | | requirement | | +| | Scalar-Unit-Size) | | for this | | +| | | | software | | +| | | | image. The | | +| | | | value of | | +| | | | the "size | | +| | | | of storage" | | +| | | | attribute | | +| | | | of the | | +| | | | VirtualStorageDesc| | +| | | | referencing | | +| | | | this | | +| | | | SwImageDesc | | +| | | | shall not | | +| | | | be smaller | | +| | | | than the | | +| | | | value of | | +| | | | minDisk. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| minRam | Number | 0..1 | The minimal | support: | +| | (recommended | | RAM | MANDATORY | +| | DM type: | | requirement | | +| | Scalar-Unit-Size) | | for this | | +| | | | software | | +| | | | image. The | | +| | | | value of | | +| | | | the "size" | | +| | | | attribute | | +| | | | of | | +| | | | VirtualMemoryData | | +| | | | of the Vdu | | +| | | | referencing | | +| | | | this | | +| | | | SwImageDesc | | +| | | | shall not | | +| | | | be smaller | | +| | | | than the | | +| | | | value of | | +| | | | minRam. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| size | Number | 1 | The size of | support: | +| | (recommended | | this | MANDATORY | +| | DM type: | | software | | +| | Scalar-Unit-Size) | | image. | | +| | | | | | +| | | | | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| swImage | Identifier | 1 | This is a | support: | +| | (Reference | | reference | MANDATORY | +| | to a | | to the | | +| | SwImage) | | actual | | +| | | | software | | +| | | | image. The | | +| | | | reference | | +| | | | can be | | +| | | | relative to | | +| | | | the root of | | +| | | | the VNF | | +| | | | Package or | | +| | | | can be a | | +| | | | URL. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| operatingSystem | String | 0..1 | Identifies | support: | +| | | | the | MANDATORY | +| | | | operating | | +| | | | system used | | +| | | | in the | | +| | | | software | | +| | | | image. This | | +| | | | attribute | | +| | | | may also | | +| | | | identify if | | +| | | | a 32 bit or | | +| | | | 64 bit | | +| | | | software | | +| | | | image is | | +| | | | used. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ +| supportedVirtualisationEnvironment| String | 0..N | Identifies | support: | +| | | | the | MANDATORY | +| | | | virtualisation | | +| | | | environments | | +| | | | (e.g. | | +| | | | hypervisor) | | +| | | | compatible | | +| | | | with this | | +| | | | software | | +| | | | image. | | ++-----------------------------------+-------------------+------------------+-------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/VduLevel.rst b/docs/ONAP Model Spec/im/VduLevel.rst new file mode 100644 index 0000000..8d86ba4 --- /dev/null +++ b/docs/ONAP Model Spec/im/VduLevel.rst @@ -0,0 +1,24 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VduLevel +=============== + ++-----------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++=================+=============+==================+=================+===============+ +| vduId | Identifier | 1 | Uniquely | support: | +| | (Reference | | identifies | MANDATORY | +| | to Vdu) | | a VDU. | | ++-----------------+-------------+------------------+-----------------+---------------+ +|numberOfInstances| Integer | 1 | Number of | support: | +| | | | instances | MANDATORY | +| | | | of VNFC based on| | +| | | | this VDU to | | +| | | | deploy for an | | +| | | | instantiation | | +| | | | level or for a | | +| | | | scaling delta. | | ++-----------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst b/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst new file mode 100644 index 0000000..d1876bc --- /dev/null +++ b/docs/ONAP Model Spec/im/VirtualCpuPinningData.rst @@ -0,0 +1,46 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualCpuPinningData +============================ + ++-------------------------+-------------+------------------+-------------------------+---------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | +| | | | | Stereotypes** | ++=========================+=============+==================+=========================+===============+ +| virtualCpuPinningPolicy | Enum | 0..1 | The policy | support: | +| | | | can take | MANDATORY | +| | | | values of | | +| | | | "static" or | valueRange: | +| | | | "dynamic". | "static", | +| | | | In case of | "dynamic" | +| | | | "static" the virtual | | +| | | | CPU cores are | | +| | | | requested to be | | +| | | | allocated to logical | | +| | | | CPU cores according | | +| | | | to the rules defined in | | +| | | | virtualCpuPinningRules. | | +| | | | In case of "dynamic" | | +| | | | the allocation | | +| | | | of virtual CPU cores | | +| | | | to logical CPU cores | | +| | | | is decided by the VIM. | | +| | | | (e.g.: SMT | | +| | | | (Simultaneous | | +| | | | Multi-Threading) | | +| | | | requirements). | | ++-------------------------+-------------+------------------+-------------------------+---------------+ +| virtualCpuPinningRule | Not | 0..1 | A list of | support: | +| | specified | | rules that | MANDATORY | +| | | | should be | | +| | Editor's | | considered | | +| | note: need | | during the | | +| | to be | | allocation | | +| | specified | | of the | | +| | | | virtual CPUs to | | +| | | | logical CPUs in case of | | +| | | | "static" | | +| | | | virtualCpuPinningPolicy.| | ++-------------------------+-------------+------------------+-------------------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst b/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst new file mode 100644 index 0000000..3dd6c92 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfConfigurableProperties.rst @@ -0,0 +1,60 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfConfigurableProperties +================================ + ++--------------------------------+-------------+------------------+-----------------+---------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | +| | | | | Stereotypes** | ++================================+=============+==================+=================+===============+ +| isAutoscaleEnabled | Boolean | 0..1 | It permits | support: | +| | | | to enable | MANDATORY | +| | | | (TRUE)/disable | | +| | | | (FALSE) the | | +| | | | auto-scaling | | +| | | | functionality. | | +| | | | | | +| | | | NOTE: A | | +| | | | cardinality | | +| | | | of "0" | | +| | | | indicates | | +| | | | that | | +| | | | configuring | | +| | | | this | | +| | | | present VNF | | +| | | | property is | | +| | | | not | | +| | | | supported. | | ++--------------------------------+-------------+------------------+-----------------+---------------+ +| isAutohealEnabled | Boolean | 0..1 | It permits | support: | +| | | | to enable | MANDATORY | +| | | | (TRUE)/disable | | +| | | | (FALSE) the | | +| | | | auto-healing | | +| | | | functionality. | | +| | | | | | +| | | | NOTE: A | | +| | | | cardinality | | +| | | | of "0" | | +| | | | indicates | | +| | | | that | | +| | | | configuring | | +| | | | this | | +| | | | present VNF | | +| | | | property is | | +| | | | not | | +| | | | supported. | | ++--------------------------------+-------------+------------------+-----------------+---------------+ +| additionalConfigurableProperty | String | 0..N | It provides | support: | +| | | | VNF | MANDATORY | +| | | | specific | | +| | | | configurable | | +| | | | properties | | +| | | | that can be | | +| | | | modified | | +| | | | using the | | +| | | | ModifyVnfInfo | | +| | | | operation. | | ++--------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfIndicator.rst b/docs/ONAP Model Spec/im/VnfIndicator.rst new file mode 100644 index 0000000..d06bdf6 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfIndicator.rst @@ -0,0 +1,39 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfIndicator +=================== + ++----------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++================+=============+==================+=================+===============+ +| id | Identifier | 1 | Unique | support: | +| | | | identifier. | MANDATORY | ++----------------+-------------+------------------+-----------------+---------------+ +| name | String | 0..1 | The human | support: | +| | | | readable | MANDATORY | +| | | | name of the | | +| | | | VnfIndicator. | | ++----------------+-------------+------------------+-----------------+---------------+ +| indicatorValue | String | 1..N | Defines the | support: | +| | | | allowed | MANDATORY | +| | | | values or | | +| | | | value | | +| | | | ranges of | | +| | | | this | | +| | | | indicator. | | ++----------------+-------------+------------------+-----------------+---------------+ +| source | Enum | 1 | Describe | support: | +| | | | the source | MANDATORY | +| | | | of the | | +| | | | indicator. | valueRange: | +| | | | This tells | "VNF", | +| | | | the | "EM", | +| | | | consumer | "Both" | +| | | | where to | | +| | | | send the | | +| | | | subscription | | +| | | | request. | | ++----------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst b/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst new file mode 100644 index 0000000..94bb5cd --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfInfoModifiableAttributes.rst @@ -0,0 +1,27 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfInfoModifiableAttributes +================================== + ++-------------+-------------+------------------+-----------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++=============+=============+==================+=================+===============+ +| extension | Not | 0..N | "Extension" | support: | +| | specified | | attributes | MANDATORY | +| | | | of VnfInfo | | +| | Editor's | | that are | | +| | note: need | | writeable. | | +| | to be | | | | +| | specified | | | | ++-------------+-------------+------------------+-----------------+---------------+ +| metadata | Not | 0..N | "Metadata" | support: | +| | specified | | attributes | MANDATORY | +| | | | of VnfInfo | | +| | Editor's | | that are | | +| | note: need | | writeable. | | +| | to be | | | | +| | specified | | | | ++-------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst b/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst new file mode 100644 index 0000000..5676b25 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfcConfigurableProperties.rst @@ -0,0 +1,33 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfcConfigurableProperties +================================= + ++------------------------------------+-------------+------------------+-----------------+---------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | +| | | | | Stereotypes** | ++====================================+=============+==================+=================+===============+ +| additionalVnfcConfigurableProperty | String | 0..N | It provides | support: | +| | | | VNFC | MANDATORY | +| | | | configurable | | +| | | | properties | | +| | | | that can be | | +| | | | modified | | +| | | | using the | | +| | | | ModifyVnfInfo | | +| | | | operation. | | +| | | | | | +| | | | NOTE: A | | +| | | | cardinality | | +| | | | of "0" | | +| | | | indicates | | +| | | | that | | +| | | | configuring | | +| | | | this | | +| | | | present VNF | | +| | | | property is | | +| | | | not | | +| | | | supported. | | ++------------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP Model Spec/im/VnfdElementGroup.rst b/docs/ONAP Model Spec/im/VnfdElementGroup.rst new file mode 100644 index 0000000..89c6125 --- /dev/null +++ b/docs/ONAP Model Spec/im/VnfdElementGroup.rst @@ -0,0 +1,35 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfdElementGroup +======================= + ++--------------------+---------------------+------------------+--------------------+---------------+ +| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | +| Name** | | | | Stereotypes** | ++====================+=====================+==================+====================+===============+ +| vnfdElementGroupId | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this | | +| | | | group in | | +| | | | the VNFD. | | ++--------------------+---------------------+------------------+--------------------+---------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the | | +| | | | group. | | ++--------------------+---------------------+------------------+--------------------+---------------+ +| vdu | Identifier | 0..N | References | support: | +| | (Reference | | to Vdus | MANDATORY | +| | to Vdu) | | that are | | +| | | | part of | | +| | | | this group. | | ++--------------------+---------------------+------------------+--------------------+---------------+ +| virtualLinkDesc | Identifier | 0..N | References | support: | +| | (Reference | | to | MANDATORY | +| | to | | VnfVirtualLinkDesc | | +| | VnfVirtualLinkDesc) | | that are part of | | +| | | | this group. | | ++--------------------+---------------------+------------------+--------------------+---------------+ diff --git a/docs/ONAP Model Spec/im/cpd.rst b/docs/ONAP Model Spec/im/cpd.rst new file mode 100644 index 0000000..be0177e --- /dev/null +++ b/docs/ONAP Model Spec/im/cpd.rst @@ -0,0 +1,109 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: Cpd +========== + ++--------------------+----------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+================+==================+=================+==========================+ +| cpdId | Identifier | 1 | Identifier | support: | +| | | | of this Cpd | MANDATORY | +| | | | information | | +| | | | element. | | ++--------------------+----------------+------------------+-----------------+--------------------------+ +| cpRole | String | 0..1 | Identifies | support: | +| | | | the role of | MANDATORY | +| | | | the port in | | +| | | | the context | | +| | | | of the | | +| | | | traffic | | +| | | | flow | | +| | | | patterns in | | +| | | | the VNF or | | +| | | | parent NS. | | +| | | | | | +| | | | For example | | +| | | | a VNF with | | +| | | | a tree flow | | +| | | | pattern | | +| | | | within the | | +| | | | VNF will | | +| | | | have legal | | +| | | | cpRoles of | | +| | | | ROOT and | | +| | | | LEAF. | | ++--------------------+----------------+------------------+-----------------+--------------------------+ +| description | String | 0..1 | Provides | support: | +| | | | human-readable | MANDATORY | +| | | | information | | +| | | | on the | | +| | | | purpose of | | +| | | | the CP | | +| | | | (e.g. CP | | +| | | | for control | | +| | | | plane | | +| | | | traffic). | | ++--------------------+----------------+------------------+-----------------+--------------------------+ +| cpProtocol | CpProtocolData | 1..N | Identifies | support: | +| | | | the | MANDATORY | +| | | | protocol | | +| | | | layering | | +| | | | information | | +| | | | the CP uses | | +| | | | for | | +| | | | connectivity | | +| | | | purposes | | +| | | | and | | +| | | | associated | | +| | | | information. | | +| | | | There shall | | +| | | | be one | | +| | | | cpProtocol | | +| | | | for each | | +| | | | layer | | +| | | | protocol as | | +| | | | indicated | | +| | | | by the | | +| | | | attribute | | +| | | | layerProtocol. | | +| | | | | | +| | | | Editor's | | +| | | | note: the | | +| | | | attribute | | +| | | | "layerProto | | +| | | | col" | | +| | | | still needs | | +| | | | further | | +| | | | discussion | | +| | | | and not | | +| | | | included in | | +| | | | this table. | | ++--------------------+----------------+------------------+-----------------+--------------------------+ +| trunkMode | Boolean | 1 | Information | support: | +| | | | about | MANDATORY | +| | | | whether the | | +| | | | CP | | +| | | | instantiated | | +| | | | from this | | +| | | | CPD is in | | +| | | | Trunk mode | | +| | | | (802.1Q or | | +| | | | other). | | ++--------------------+----------------+------------------+-----------------+--------------------------+ +| allowedAddressData | AddressData | 0..N | For | support: | +| | | | specifying | MANDATORY | +| | | | floating | | +| | | | IP(s) to be | | +| | | | shared | | +| | | | among Cpds, | | +| | | | which are | | +| | | | reserved | | +| | | | for | | +| | | | vnfReserved | | +| | | | Cpd | | +| | | | described | | +| | | | in the | | +| | | | VNFD. | | ++--------------------+----------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst new file mode 100644 index 0000000..e38744d --- /dev/null +++ b/docs/ONAP Model Spec/im/index.rst @@ -0,0 +1,55 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +.. onap-documentation documentation master file, created by + sphinx-quickstart on Mon Sep 18 15:12:14 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +ONAP Information Model Specifications +===================================== + +.. toctree:: + :titlesonly: + + AddressData + AffinityOrAntiAffinityGroup + BaseConfigGroup + ConnectivityType + cpd + CpProtocolData + DeploymentGroup + instantiationlevel + L2AddressData + L3AddressData + LifecycleManagementScript + linkbitraterequirements + LocalAffinityOrAntiAffinityRule + logicalnodedata + MonitoringParameter + PlacementGroup + QoS + RequestedAdditionalCapabilityData + ScaleInfo + SwImageDesc + vdu + vducpd + VduLevel + vduprofile + virtualcomputedesc + virtualcpudata + VirtualCpuPinningData + virtuallinkdescflavour + virtuallinkprofile + virtualmemorydata + virtualnetworkinterfacerequirements + virtualstoragedesc + VnfcConfigurableProperties + VnfConfigurableProperties + vnfd + VnfdElementGroup + vnfdf + vnfextcpd + VnfIndicator + VnfInfoModifiableAttributes + vnfvirtuallinkdesc diff --git a/docs/ONAP Model Spec/im/instantiationlevel.rst b/docs/ONAP Model Spec/im/instantiationlevel.rst new file mode 100644 index 0000000..a36998a --- /dev/null +++ b/docs/ONAP Model Spec/im/instantiationlevel.rst @@ -0,0 +1,76 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: InstantiationLevel +========================= + ++------------------------+-------------------------+------------------+-------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++========================+=========================+==================+===================+==========================+ +| levelId | Identifier | 1 | Uniquely | support: | +| | | | identifies | MANDATORY | +| | | | a level | | +| | | | with the DF. | | ++------------------------+-------------------------+------------------+-------------------+--------------------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the level. | | ++------------------------+-------------------------+------------------+-------------------+--------------------------+ +| vduLevel | VduLevel | 1..N | Indicates | support: | +| | | | the number | MANDATORY | +| | | | of instance | | +| | | | of this VDU | | +| | | | to deploy | | +| | | | for this level. | | ++------------------------+-------------------------+------------------+-------------------+--------------------------+ +| virtualLinkBitRateLevel| VirtualLinkBitRateLevel | 0..N | Specifies | support: | +| | | | bitrate | MANDATORY | +| | | | requirements | | +| | | | applicable | | +| | | | to virtual links | | +| | | | created from | | +| | | | particular | | +| | | | virtual link | | +| | | | descriptors | | +| | | | for this level. | | +| | | | | | +| | | | NOTE: If not | | +| | | | present, it | | +| | | | is assumed | | +| | | | that the bitrate | | +| | | | requirements | | +| | | | can be derived | | +| | | | from those | | +| | | | specified in the | | +| | | | VduCpd instances | | +| | | | applicable | | +| | | | to the internal | | +| | | | VL. If | | +| | | | present in | | +| | | | both the | | +| | | | InstantiationLevel| | +| | | | and the VduCpd | | +| | | | instances | | +| | | | applicable | | +| | | | to the | | +| | | | internal VL, the | | +| | | | highest | | +| | | | value takes | | +| | | | precedence. | | ++------------------------+-------------------------+------------------+-------------------+--------------------------+ +| scaleInfo | ScaleInfo | 0..N | Represents | support: | +| | | | for each | MANDATORY | +| | | | aspect the | | +| | | | scale level that | | +| | | | corresponds | | +| | | | to this | | +| | | | instantiation | | +| | | | level. | | +| | | | scaleInfo | | +| | | | shall be | | +| | | | present if | | +| | | | the VNF | | +| | | | supports scaling. | | ++------------------------+-------------------------+------------------+-------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/linkbitraterequirements.rst b/docs/ONAP Model Spec/im/linkbitraterequirements.rst new file mode 100644 index 0000000..ab2c497 --- /dev/null +++ b/docs/ONAP Model Spec/im/linkbitraterequirements.rst @@ -0,0 +1,52 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: LinkBitrateRequirements +============================== + ++--------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================+=============+==================+=================+==========================+ +| root | Number | 1 | Throughput | support: | +| | | | requirement | MANDATORY | +| | | | of the | | +| | | | link (e.g. | | +| | | | bitrate of | | +| | | | E-Line, | | +| | | | root | | +| | | | bitrate of | | +| | | | E-Tree, | | +| | | | aggregate | | +| | | | capacity of | | +| | | | E-LAN). | | ++--------------------+-------------+------------------+-----------------+--------------------------+ +| leaf | Number | 0..1 | Throughput | support: | +| | | | requirement | MANDATORY | +| | | | of leaf | | +| | | | connections | | +| | | | to the link | | +| | | | when | | +| | | | applicable | | +| | | | to the | | +| | | | connectivity | | +| | | | type (e.g. | | +| | | | for E-Tree | | +| | | | and E-LAN | | +| | | | branches). | | +| | | | | | +| | | | NOTE: The | | +| | | | present | | +| | | | document | | +| | | | does not | | +| | | | specify the | | +| | | | means to | | +| | | | declare | | +| | | | different | | +| | | | bitrate | | +| | | | requirements | | +| | | | for leaf | | +| | | | connections | | +| | | | (e.g. E-LAN | | +| | | | leaves). | | ++--------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/logicalnodedata.rst b/docs/ONAP Model Spec/im/logicalnodedata.rst new file mode 100644 index 0000000..a0981de --- /dev/null +++ b/docs/ONAP Model Spec/im/logicalnodedata.rst @@ -0,0 +1,53 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: LogicalNodeData +====================== + ++-------------------------+-------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=========================+=============+==================+=================+==========================+ +| logicalNodeRequirements | KeyValuePair| 0..N | The logical | support: | +| | | | node-level | MANDATORY | +| | | | compute, | | +| | | | memory and | | +| | | | I/O | | +| | | | requirements. | | +| | | | An array of | | +| | | | key-value | | +| | | | pairs that | | +| | | | articulate | | +| | | | the | | +| | | | deployment | | +| | | | requirements. | | +| | | | | | +| | | | This could | | +| | | | include the | | +| | | | number of | | +| | | | CPU cores | | +| | | | on this | | +| | | | logical | | +| | | | node, a | | +| | | | memory | | +| | | | configuration | | +| | | | specific to | | +| | | | a logical | | +| | | | node (e.g. | | +| | | | such as | | +| | | | available | | +| | | | in the | | +| | | | Linux | | +| | | | kernel via | | +| | | | the libnuma | | +| | | | library) or | | +| | | | a | | +| | | | requirement | | +| | | | related to | | +| | | | the | | +| | | | association | | +| | | | of an I/O | | +| | | | device with | | +| | | | the logical | | +| | | | node. | | ++-------------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/vdu.rst b/docs/ONAP Model Spec/im/vdu.rst new file mode 100644 index 0000000..f83ed43 --- /dev/null +++ b/docs/ONAP Model Spec/im/vdu.rst @@ -0,0 +1,201 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: Vdu +========== + ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=======================+===========================+==================+====================+=========================+ +| vduId | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this Vdu | | +| | | | in VNFD. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| name | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | name of the | | +| | | | Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| vduCpd | VduCpd | 1..N | Describes | support: | +| | | | network | MANDATORY | +| | | | connectivity | | +| | | | between a | | +| | | | VNFC | | +| | | | instance | | +| | | | (based on | | +| | | | this Vdu) | | +| | | | and an | | +| | | | Virtual | | +| | | | Link (VL). | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| virtualComputeDesc | Identifier | 1 | Describes | support: | +| | (reference | | CPU, Memory | MANDATORY | +| | to | | and | | +| | VirtualComputeDesc) | | acceleration | | +| | | | requirements | | +| | | | of the | | +| | | | Virtualisation | | +| | | | Container | | +| | | | realising | | +| | | | this Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| virtualStorageDesc | Identifier | 0..N | Describes | support: | +| | (reference | | storage | MANDATORY | +| | to | | requirements | | +| | VirtualStorageDesc) | | for a | | +| | | | VirtualStorage | | +| | | | instance | | +| | | | attached to | | +| | | | the | | +| | | | virtualisation | | +| | | | container | | +| | | | created | | +| | | | from | | +| | | | virtualComputeDesc | | +| | | | defined for | | +| | | | this Vdu. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| bootOrder | KeyValuePair | 0..N | Boot order | support: | +| | | | of valid | MANDATORY | +| | | | boot | | +| | | | devices. | valueRange: | +| | | | | "key/name" | +| | | | NOTE: If no | indicates | +| | | | boot order | the the | +| | | | is defined | boot index | +| | | | the default | (lowest | +| | | | boot order | index | +| | | | defined in | defines | +| | | | the VIM or | highest | +| | | | NFVI shall | boot | +| | | | be used. | priority). | +| | | | | "value" | +| | | | | references | +| | | | | a | +| | | | | descriptor | +| | | | | from which | +| | | | | a valid | +| | | | | boot device | +| | | | | is created | +| | | | | e.g. | +| | | | | VirtualStorageDesc | +| | | | | from which | +| | | | | a | +| | | | | VirtualStorage | +| | | | | instance is | +| | | | | created. | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| swImageDesc | SwImageDesc | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | Editor's | software | | +| | | note: the | image which | | +| | | scenario of | is directly | | +| | | using "0" | loaded on | | +| | | needs to be | the | | +| | | clarified. | virtualisation | | +| | | | container | | +| | | | realising | | +| | | | this Vdu. | | +| | | | | | +| | | | NOTE: More | | +| | | | software | | +| | | | images can | | +| | | | be attached | | +| | | | to the | | +| | | | virtualisation | | +| | | | container | | +| | | | using | | +| | | | VirtualStorage | | +| | | | resources. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| nfviConstraint | KeyValuePair | 0..N | Describes | support: | +| | | | constraints | MANDATORY | +| | | | on the NFVI | | +| | | | for the | valueRange: | +| | | | VNFC | "key/name" | +| | | | instance(s) | includes | +| | | | created | "AvailabilityZone", | +| | | | from this | "HostAggregates". | +| | | | Vdu. For | | +| | | | example, | | +| | | | aspects of | | +| | | | a secure | | +| | | | hosting | | +| | | | environment | | +| | | | for the | | +| | | | VNFC | | +| | | | instance | | +| | | | that | | +| | | | involve | | +| | | | additional | | +| | | | entities or | | +| | | | processes. | | +| | | | | | +| | | | NOTE: These | | +| | | | are | | +| | | | constraints | | +| | | | other than | | +| | | | stipulating | | +| | | | that a VNFC | | +| | | | instance | | +| | | | has access | | +| | | | to a | | +| | | | certain | | +| | | | resource, | | +| | | | as a | | +| | | | prerequisite | | +| | | | to | | +| | | | instantiation. | | +| | | | The | | +| | | | attributes | | +| | | | virtualComputeDesc | | +| | | | and | | +| | | | virtualStorageDesc | | +| | | | define the | | +| | | | resources | | +| | | | required | | +| | | | for | | +| | | | instantiation | | +| | | | of the VNFC | | +| | | | instance. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: | +| | | | virtualised | MANDATORY | +| | | | resources | | +| | | | monitoring | | +| | | | parameters | | +| | | | on VDU | | +| | | | level. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| configurableProperties| VnfcConfigurableProperties| 1 | Describes | support: | +| | | | the | MANDATORY | +| | | | configurable | | +| | | | properties | | +| | | | of all VNFC | | +| | | | instances | | +| | | | based on | | +| | | | this VDU. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ +| injectFiles | String | 0..N | Describes | support: | +| | | | the | MANDATORY | +| | | | information | | +| | | | (e.g. URL) | | +| | | | about the | | +| | | | scripts, | | +| | | | config | | +| | | | drive | | +| | | | metadata, | | +| | | | etc. which | | +| | | | can be used | | +| | | | during Vdu | | +| | | | booting | | +| | | | process. | | ++-----------------------+---------------------------+------------------+--------------------+-------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/vducpd.rst b/docs/ONAP Model Spec/im/vducpd.rst new file mode 100644 index 0000000..e0247d4 --- /dev/null +++ b/docs/ONAP Model Spec/im/vducpd.rst @@ -0,0 +1,64 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VduCpd +============= + ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++====================================+====================================+==================+==================+==========================+ +| bitrateRequirement | Number | 0..1 | Bitrate | support: | +| | (recommended | | requirement | MANDATORY | +| | DM type: Scalar-Unit-Rate) | | on this CP. | | ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| vnicName | String | 0..1 | Describes | support: | +| | | | the name of | MANDATORY | +| | | | the vNIC | | +| | | | this CP | | +| | | | attaches | | +| | | | to, e.g. | | +| | | | eth0. It | | +| | | | will be | | +| | | | configured | | +| | | | during the | | +| | | | Vdu booting | | +| | | | process. | | ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| vnicOrder | Integer | 0..1 | Describes | support: | +| | | | the order | MANDATORY | +| | | | to create | | +| | | | the vNIC | | +| | | | within the | | +| | | | scope of | | +| | | | this Vdu. | | ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| vnicType | Enum | 0..1 | Describes | support: | +| | | | the type of | MANDATORY | +| | | | the vNIC | | +| | | | this CP | valueRange: | +| | | | attaches | normal, | +| | | | to. | macvtap, | +| | | | | direct, | +| | | | | baremetal, | +| | | | | direct-physical | +| | | | | and | +| | | | | virtio-forwarder | ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| virtualNetworkInterfaceRequirements| VirtualNetworkInterfaceRequirements| 0..N | Specifies | support: | +| | | | requirements | MANDATORY | +| | | | on a | | +| | | | virtual | | +| | | | network | | +| | | | interface | | +| | | | realising | | +| | | | the CPs | | +| | | | instantiated | | +| | | | from this | | +| | | | CPD. | | ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ +| (inherited | | | All | | +| attributes) | | | attributes | | +| | | | inherited | | +| | | | from Cpd. | | ++------------------------------------+------------------------------------+------------------+------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/vduprofile.rst b/docs/ONAP Model Spec/im/vduprofile.rst new file mode 100644 index 0000000..2d7e64a --- /dev/null +++ b/docs/ONAP Model Spec/im/vduprofile.rst @@ -0,0 +1,152 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VduProfile +================= + ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=================================+=================================+===================+=================+==========================+ +| vduId | Identifier | 1 | Uniquely | support: | +| | (Reference | | identifies | MANDATORY | +| | to Vdu) | | a VDU. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| minNumberOfInstances | Integer | 1 | Minimum | support: | +| | | | number of | MANDATORY | +| | | | instances | | +| | | | of the VNFC | | +| | | | based on | | +| | | | this VDU | | +| | | | that is | | +| | | | permitted | | +| | | | to exist | | +| | | | for this | | +| | | | flavour. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| maxNumberOfInstances | Integer | 1 | Maximum | support: | +| | | | number of | MANDATORY | +| | | | instances | | +| | | | of the VNFC | | +| | | | based on | | +| | | | this VDU | | +| | | | that is | | +| | | | permitted | | +| | | | to exist | | +| | | | for this | | +| | | | flavour. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N | Specifies | support: | +| | | | affinity or | MANDATORY | +| | | | anti-affinity | | +| | | | rules | | +| | | | applicable | | +| | | | between the | | +| | | | virtualisation | | +| | | | containers | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machines) | | +| | | | to be | | +| | | | created | | +| | | | based on | | +| | | | this VDU. | | +| | | | | | +| | | | When the | | +| | | | cardinality | | +| | | | is greater | | +| | | | than 1, | | +| | | | both | | +| | | | affinity | | +| | | | rule(s) and | | +| | | | anti-affinity | | +| | | | rule(s) | | +| | | | with | | +| | | | different | | +| | | | scopes | | +| | | | (e.g. | | +| | | | "Affinity | | +| | | | with the | | +| | | | scope | | +| | | | resource | | +| | | | zone and | | +| | | | anti-affinity | | +| | | | with the | | +| | | | scope NFVI | | +| | | | node") are | | +| | | | applicable | | +| | | | to the | | +| | | | virtualisation | | +| | | | containers | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machines) | | +| | | | to be | | +| | | | created | | +| | | | based on | | +| | | | this VDU. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| affinityOrAntiAffinityGroupId | Identifier | 0..N | Identifier(s) | support: | +| | | | of the | MANDATORY | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group(s) | | +| | | | the VDU | | +| | | | belongs to. | | +| | | | | | +| | | | NOTE: Each | | +| | | | identifier | | +| | | | references | | +| | | | an affinity | | +| | | | or | | +| | | | anti-affinity | | +| | | | group which | | +| | | | expresses | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | relationships | | +| | | | between the | | +| | | | virtualisation | | +| | | | container(s) | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machine(s)) | | +| | | | to be | | +| | | | created | | +| | | | using this | | +| | | | VDU and the | | +| | | | virtualisation | | +| | | | container(s) | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machine(s)) | | +| | | | to be | | +| | | | created | | +| | | | using other | | +| | | | VDU(s) in | | +| | | | the same | | +| | | | group. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| watchdog | String | 0..1 | Watchdog | support: | +| | | | action to | MANDATORY | +| | | | be | | +| | | | triggered | | +| | | | by the VIM | | +| | | | for the VNF | | +| | | | in case the | | +| | | | heart beat | | +| | | | fails, e.g. | | +| | | | reset or | | +| | | | hard | | +| | | | shutdown, | | +| | | | etc. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ +| vmBootUpTimeOut | Integer | 0..1 | Timeout | support: | +| | | | value for | OPTIONAL | +| | | | the VNFM to | | +| | | | wait before | | +| | | | the | | +| | | | successful | | +| | | | booting up | | +| | | | of the VDU. | | ++---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtualcomputedesc.rst b/docs/ONAP Model Spec/im/virtualcomputedesc.rst new file mode 100644 index 0000000..081f90b --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualcomputedesc.rst @@ -0,0 +1,56 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualComputeDesc +========================= + ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++===============================+===================================+==================+===================+==========================+ +| virtualComputeDescId | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this | | +| | | | VirtualComputeDesc| | +| | | | in the | | +| | | | VNFD. | | ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| logicalNode | LogicalNodeData | 1..N | The logical | support: | +|   | | | Node | MANDATORY | +| | | | requirements. | | ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| requestAdditionalCapabilities | RequestedAdditionalCapabilityData | 0..N | Specifies | support: | +| | | | requirements | MANDATORY | +| | | | for | | +| | | | additional | | +| | | | capabilities. | | +| | | | These may | | +| | | | be for a | | +| | | | range of | | +| | | | purposes. | | +| | | | One example | | +| | | | is | | +| | | | acceleration | | +| | | | related | | +| | | | capabilities. | | ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| computeRequirements | KeyValuePair | 0..N | Specifies | support: | +| | | | compute | MANDATORY | +| | | | requirements. | | ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| virtualMemory | VirtualMemoryData | 1 | The virtual | support: | +| | | | memory of | MANDATORY | +| | | | the | | +| | | | virtualised | | +| | | | compute. | | +| | | | | | +| | | | | | ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ +| virtualCpu | VirtualCpuData | 1 | The virtual | support: | +| | | | CPU(s) of | MANDATORY | +| | | | the | | +| | | | virtualised | | +| | | | compute. | | +| | | | | | ++-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/virtualcpudata.rst b/docs/ONAP Model Spec/im/virtualcpudata.rst new file mode 100644 index 0000000..105614f --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualcpudata.rst @@ -0,0 +1,86 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualCpuData +===================== + ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++==================================+=======================+==================+=================+=========================+ +| cpuArchitecture | String | 0..1 | CPU | support: | +| | | | architecture | MANDATORY | +| | | | type. | | +| | | | Examples | | +| | | | are x86, | | +| | | | ARM. The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | CPU | | +| | | | architecture | | +| | | | type is | | +| | | | requested. | | ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| numVirtualCpu | Integer | 1 | Number of | support: | +| | | | virtual | MANDATORY | +| | | | CPUs. | | ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| virtualCpuClock | Number | 0..1 | Minimum | support: | +| | (recommended | | virtual CPU | MANDATORY | +| | DM type: | | clock rate | | +| | Scalar-Unit-Freq) | | (e.g. in | | +| | | | MHz). The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | value is | | +| | | | requested. | | ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| virtualCpuOversubscriptionPolicy | String | 0..1 | The CPU | support: | +| | | | core | MANDATORY | +| | | | oversubscription| | +| | | | policy e.g. | | +| | | | the | | +| | | | relation of | | +| | | | virtual CPU | | +| | | | cores to | | +| | | | physical | | +| | | | CPU | | +| | | | cores/threads. | | +| | | | The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | value is | | +| | | | requested. | | ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| vduCpuRequirements | KeyValuePair | 0..N | Array of | support: | +| | | | key-value | MANDATORY | +| | | | pair | | +| | | | requirements | | +| | | | on the | | +| | | | Compute | | +| | | | (CPU) for | | +| | | | the VDU. | | ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ +| virtualCpuPinning | VirtualCpuPinningData | 0..1 | The virtual | support: | +| | | | CPU pinning | MANDATORY | +| | | | configuration | | +| | | | for the | | +| | | | virtualised | | +| | | | compute | | +| | | | resource. | | ++----------------------------------+-----------------------+------------------+-----------------+-------------------------+ diff --git a/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst b/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst new file mode 100644 index 0000000..e617bfe --- /dev/null +++ b/docs/ONAP Model Spec/im/virtuallinkdescflavour.rst @@ -0,0 +1,18 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualLinkDescFlavour +============================= + ++-------------------+-------------+------------------+---------------------+--------------------------+ +| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++===================+=============+==================+=====================+==========================+ +| flavourId | Identifier | 1 | Identifies | support: | +| | | | a flavour | MANDATORY | +| | | | within a | | +| | | | VnfVirtualLinkDesc. | | ++-------------------+-------------+------------------+---------------------+--------------------------+ +| qos | QoS | 0..1 | QoS of the | support: | +| | | | VL. | MANDATORY | ++-------------------+-------------+------------------+---------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtuallinkprofile.rst b/docs/ONAP Model Spec/im/virtuallinkprofile.rst new file mode 100644 index 0000000..46addd5 --- /dev/null +++ b/docs/ONAP Model Spec/im/virtuallinkprofile.rst @@ -0,0 +1,152 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualLinkProfile +========================= + ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=================================+=================================+==================+=======================+==========================+ +| vnfVirtualLinkDescId | Identifier | 1 | Uniquely | support: | +| | (Reference | | identifies | MANDATORY | +| | to | | a Vnf VLD. | | +| | VnfVirtualLinkDesc) | | | | +| | | | | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| flavourId | Identifier | 1 | Identifies | support: | +| | (Reference | | a flavour | MANDATORY | +| | to | | within the | | +| | VirtualLinkDescFlavour) | | VnfVirtualLinkDesc. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N | Specifies | support: | +| | | | affinity or | MANDATORY | +| | | | anti-affinity | | +| | | | rules | | +| | | | applicable | | +| | | | between the | | +| | | | VLs based | | +| | | | on this | | +| | | | VnfVirtualLinkDesc. | | +| | | | | | +| | | | When the | | +| | | | cardinality | | +| | | | is greater | | +| | | | than 1, | | +| | | | both | | +| | | | affinity | | +| | | | rule(s) and | | +| | | | anti-affinity | | +| | | | rule(s) with | | +| | | | different | | +| | | | scopes are | | +| | | | applicable | | +| | | | to the VLs | | +| | | | based on this | | +| | | | VnfVirtualLinkDesc. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| affinityOrAntiAffinityGroupId | Identifier | 0..N | Identifier(s) | support: | +| | | | of the | MANDATORY | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group(s) the | | +| | | | VnfVirtualLinkDesc | | +| | | | belongs to. | | +| | | | | | +| | | | NOTE: Each | | +| | | | identifier | | +| | | | references | | +| | | | an affinity | | +| | | | or | | +| | | | anti-affinity | | +| | | | group which | | +| | | | expresses | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | relationship | | +| | | | between the | | +| | | | VL(s) using | | +| | | | this | | +| | | | VnfVirtualLinkDesc | | +| | | | and the | | +| | | | VL(s) using | | +| | | | other | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | in the same group. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| maxBitRateRequirements | LinkBitrateRequirements | 1 | Specifies | support: | +| | | | the maximum | MANDATORY | +| | | | bitrate | | +| | | | requirements | | +| | | | for a VL | | +| | | | instantiated | | +| | | | according | | +| | | | to this | | +| | | | profile. | | +| | | | | | +| | | | NOTE: These | | +| | | | attributes | | +| | | | are used to | | +| | | | control | | +| | | | scaling | | +| | | | boundaries. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| minBitRateRequirements | LinkBitrateRequirements | 1 | Specifies | support: | +| | | | the minimum | MANDATORY | +| | | | bitrate | | +| | | | requirements | | +| | | | for a VL | | +| | | | instantiated | | +| | | | according | | +| | | | to this | | +| | | | profile. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| initiationParameters | KeyValuePair | 0..N | Specifies | support: | +| | | | initiation | MANDATORY | +| | | | parameters | | +| | | | for the | valueRange: | +| | | | virtual |  specified | +| | | | link. | values | +| | | | | include: | +| | | | | cidr, | +| | | | | allocationPools | +| | | | | (represented | +| | | | | by | +| | | | | [starting | +| | | | | ip address, | +| | | | | ending ip | +| | | | | address]), | +| | | | | gatewayIp, | +| | | | | networkName, | +| | | | | segmentationId, | +| | | | | physicalNetwork. | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| networkType | Enum | 0..1 | Type of the | support: | +| | | | network. | MANDATORY | +| | | | | | +| | | | | valueRange: | +| | | | | "VLAN", | +| | | | | "VXLAN" | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| dhcpEnabled | Boolean | 0..1 | Indicating | support: | +| | | | whether | MANDATORY | +| | | | DHCP is | | +| | | | enabled. | | +| | | | Default is | | +| | | | "FALSE" if | | +| | | | not | | +| | | | specified | | +| | | | otherwise. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ +| vlanTransparent | Boolean | 0..1 | Indicating | support: | +| | | | whether | MANDATORY | +| | | | "VLAN | | +| | | | Transparent | | +| | | | Mode" is | | +| | | | supported. | | +| | | | Default is | | +| | | | "FALSE" if | | +| | | | not | | +| | | | specified | | +| | | | otherwise. | | ++---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtualmemorydata.rst b/docs/ONAP Model Spec/im/virtualmemorydata.rst new file mode 100644 index 0000000..0719a87 --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualmemorydata.rst @@ -0,0 +1,68 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualMemoryData +======================== + ++----------------------------------+-------------------+------------------+-----------------+-------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++==================================+===================+==================+=================+=========================+ +| virtualMemSize | Number | 1 | Amount of | support: | +| | (recommended | | virtual | MANDATORY | +| | DM type: | | Memory | | +| | Scalar-Unit-Size) | | (e.g. in | | +| | | | MB). | | ++----------------------------------+-------------------+------------------+-----------------+-------------------------+ +| virtualMemOversubscriptionPolicy | String | 0..1 | The memory | support: | +| | | | core | MANDATORY | +| | | | oversubscription| | +| | | | policy in | | +| | | | terms of | | +| | | | virtual | | +| | | | memory to | | +| | | | physical | | +| | | | memory on | | +| | | | the | | +| | | | platform. | | +| | | | The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | value is | | +| | | | requested. | | ++----------------------------------+-------------------+------------------+-----------------+-------------------------+ +| vduMemRequirements | KeyValuePair | 0..N | Array of | support: | +| | | | key-value | MANDATORY | +| | | | pair | | +| | | | requirements | | +| | | | on the | | +| | | | memory for | | +| | | | the VDU. | | ++----------------------------------+-------------------+------------------+-----------------+-------------------------+ +| numaEnabled | Boolean | 0..1 | It | support: | +| | | | specifies | MANDATORY | +| | | | the memory | | +| | | | allocation | | +| | | | to be | | +| | | | cognisant | | +| | | | of the | | +| | | | relevant | | +| | | | process/core | | +| | | | allocation. | | +| | | | The | | +| | | | cardinality | | +| | | | can be 0 | | +| | | | during the | | +| | | | allocation | | +| | | | request, if | | +| | | | no | | +| | | | particular | | +| | | | value is | | +| | | | requested. | | ++----------------------------------+-------------------+------------------+-----------------+-------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst b/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst new file mode 100644 index 0000000..4e13ddd --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualnetworkinterfacerequirements.rst @@ -0,0 +1,90 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualNetworkInterfaceRequirements +========================================== + ++------------------------------+------------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++==============================+==================+==================+=================+==========================+ +| name | String | 0..1 | Provides a | support: | +| | | | human | MANDATORY | +| | | | readable | | +| | | | name for | | +| | | | the | | +| | | | requirement. | | ++------------------------------+------------------+------------------+-----------------+--------------------------+ +| description | String | 0..1 | Provides a | support: | +| | | | human | MANDATORY | +| | | | readable | | +| | | | description | | +| | | | of the | | +| | | | requirement. | | ++------------------------------+------------------+------------------+-----------------+--------------------------+ +| supportMandatory | Boolean | 1 | Indicates | support: | +| | | | whether | MANDATORY | +| | | | fulfilling | | +| | | | the | | +| | | | constraint | | +| | | | is | | +| | | | mandatory | | +| | | | (TRUE) for | | +| | | | successful | | +| | | | operation | | +| | | | or | | +| | | | desirable | | +| | | | (FALSE). | | ++------------------------------+------------------+------------------+-----------------+--------------------------+ +| networkInterfaceRequirements | KeyValuePair | 0..N | The network | support: | +| | | | interface | MANDATORY | +| | | | requirements. | | +| | | | An element | | +| | | | from an | | +| | | | array of | | +| | | | key-value | | +| | | | pairs that | | +| | | | articulate | | +| | | | the network | | +| | | | interface | | +| | | | deployment | | +| | | | requirements. | | ++------------------------------+------------------+------------------+-----------------+--------------------------+ +| nicIoRequirements | Identifier | 0..1 | This | support: | +| | (reference | | references | MANDATORY | +| | to | | (couples) | | +| | logicalNodeData) | | the CPD | | +| | | | with any | | +| | | | logical | | +| | | | node I/O | | +| | | | requirements | | +| | | | (for | | +| | | | network | | +| | | | devices) | | +| | | | that may | | +| | | | have been | | +| | | | created. | | +| | | | Linking | | +| | | | these | | +| | | | attributes | | +| | | | is | | +| | | | necessary | | +| | | | so that so | | +| | | | that I/O | | +| | | | requirements | | +| | | | that need | | +| | | | to be | | +| | | | articulated | | +| | | | at the | | +| | | | logical | | +| | | | node level | | +| | | | can be | | +| | | | associated | | +| | | | with the | | +| | | | network | | +| | | | interface | | +| | | | requirements | | +| | | | associated | | +| | | | with the | | +| | | | CPD. | | ++------------------------------+------------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP Model Spec/im/virtualstoragedesc.rst b/docs/ONAP Model Spec/im/virtualstoragedesc.rst new file mode 100644 index 0000000..4e0370e --- /dev/null +++ b/docs/ONAP Model Spec/im/virtualstoragedesc.rst @@ -0,0 +1,58 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VirtualStorageDesc +========================= + ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++========================+===================+==================+=====================+=========================+ +| id | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this | | +| | | | VirtualStorageDesc | | +| | | | in the | | +| | | | VNFD. | | ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| typeOfStorage | String | 1 | Type of | support: | +| | | | virtualised | MANDATORY | +| | | | storage | | +| | | | resource | | +| | | | (e.g. | | +| | | | volume, | | +| | | | object). | | ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| sizeOfStorage | Number | 1 | Size of | support: | +| | (recommended | | virtualised | MANDATORY | +| | DM type: | | storage | | +| | Scalar-Unit-Size) | | resource | | +| | | | (e.g. size | | +| | | | of volume, | | +| | | | in GB). | | ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| vduStorageRequirements | KeyValuePair | 0..N | An array of | support: | +| | | | key-value | MANDATORY | +| | | | pairs that | | +| | | | articulate | | +| | | | the storage | | +| | | | deployment | | +| | | | requirements. | | ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| rdmaEnabled | Boolean | 0..1 | Indicate if | support: | +| | | | the storage | MANDATORY | +| | | | support | | +| | | | RDMA. | | ++------------------------+-------------------+------------------+---------------------+-------------------------+ +| swImageDesc | Identifier | 0..1 | Software | support: | +| | (Reference | | image to be | MANDATORY | +| | to | | loaded on | | +| | SwImageDesc) | | the | | +| | | | VirtualStorage | | +| | | | resource | | +| | | | created | | +| | | | based on | | +| | | | this | | +| | | | VirtualStorageDesc. | | ++------------------------+-------------------+------------------+---------------------+-------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/vnfd.rst b/docs/ONAP Model Spec/im/vnfd.rst new file mode 100644 index 0000000..5a8d22d --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfd.rst @@ -0,0 +1,309 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: Vnfd +=========== + ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=============================+=============================+==================+=====================+======================================================+ +| vnfdId | Identifier | 1 | Identifier | support: | +| | | | of this | MANDATORY | +| | | | VNFD | | +| | | | information | | +| | | | element. | | +| | | | This | | +| | | | attribute | | +| | | | shall be | | +| | | | globally | | +| | | | unique. | | +| | | | | | +| | | | NOTE: The | | +| | | | VNFD | | +| | | | Identifier | | +| | | | shall be | | +| | | | used as the | | +| | | | unique | | +| | | | identifier | | +| | | | of the VNF | | +| | | | Package | | +| | | | that | | +| | | | contains | | +| | | | this VNFD. | | +| | | | | | +| | | | Any | | +| | | | modification | | +| | | | of the | | +| | | | content of | | +| | | | the VNFD or | | +| | | | the VNF | | +| | | | Package | | +| | | | shall | | +| | | | result in a | | +| | | | new VNFD | | +| | | | Identifier. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProvider | String | 1 | Provider of | support: | +| | | | the VNF and | MANDATORY | +| | | | of the | | +| | | | VNFD. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductName | String | 1 | Name to | support: | +| | | | identify | MANDATORY | +| | | | the VNF | | +| | | | Product. | | +| | | | Invariant | | +| | | | for the VNF | | +| | | | Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfSoftwareVersion | String | 1 | Software | support: | +| | | | version of | MANDATORY | +| | | | the VNF. | | +| | | | This is | | +| | | | changed | | +| | | | when there | | +| | | | is any | | +| | | | change to | | +| | | | the | | +| | | | software | | +| | | | that is | | +| | | | included in | | +| | | | the VNF | | +| | | | Package. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfdVersion | String | 1 | Identifies | support: | +| | | | the version | MANDATORY | +| | | | of the | | +| | | | VNFD. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductInfoName | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | name for | | +| | | | the VNF | | +| | | | Product. | | +| | | | Can change | | +| | | | during the | | +| | | | VNF Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfProductInfoDescription | String | 0..1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the VNF | | +| | | | Product. | | +| | | | Can change | | +| | | | during the | | +| | | | VNF Product | | +| | | | lifetime. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfmInfo | String | 0..N | Identifies | support: | +| | | | VNFM(s) | MANDATORY | +| | | | compatible | | +| | | | with the | valueRange: | +| | | | VNF | use the | +| | | | described | name of | +| | | | in this | micro-service | +| | | | version of | of the vnfm | +| | | | the VNFD. | drive. For | +| | | | | vendor | +| | | | | specific | +| | | | | VNFM, the | +| | | | | value | +| | | | | composes of | +| | | | | "vendorname" | +| | | | | and | +| | | | | "vnfmdriver", | +| | | | | e.g. | +| | | | | "mycompanyvnfmdriver"; | +| | | | | for generic | +| | | | | VNFM, the | +| | | | | value is | +| | | | | "gvnfmdriver". | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| localizationLanguage | String | 0..N | Information | support: | +| | | | about | MANDATORY | +| | | | localization | | +| | | | languages | valueRange: | +| | | | | refer to | +| | | | of the VNF | ISO936 \ | +| | | | (includes | `https://www.iso.org/iso-639-language-codes.html | +| | | | e.g. | `__ | +| | | | strings in | | +| | | | the VNFD). | | +| | | | | | +| | | | NOTE: This | | +| | | | allows to | | +| | | | provide one | | +| | | | or more | | +| | | | localizatio | | +| | | | n | | +| | | | languages | | +| | | | to support | | +| | | | selecting a | | +| | | | specific | | +| | | | localizatio | | +| | | | n | | +| | | | language at | | +| | | | VNF | | +| | | | instantiati | | +| | | | on | | +| | | | time. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| defaultLocalizationLanguage | String | 0..1 | Default | support: | +| | | | localization | MANDATORY | +| | | | language | | +| | | | that is | valueRange: | +| | | | instantiated | refer to | +| | | | if no | ISO936 \ | +| | | | information | `https://www.iso.org/iso-639-language-codes.html | +| | | | about | `__ | +| | | | selected | | +| | | | localization | condition: | +| | | | language is | Shall be | +| | | | available. | present if | +| | | | | "localizationLanguage" | +| | | | | is present | +| | | | | and shall | +| | | | | be absent | +| | | | | otherwise. | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vdu | Vdu | 1..N | Virtualisation | support: | +| | | | Deployment | MANDATORY | +| | | | Unit. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| virtualComputeDesc | VirtualComputeDesc | 1..N | Defines | support: | +| | | | descriptors | MANDATORY | +| | | | of virtual | | +| | | | compute | | +| | | | resources | | +| | | | to be used | | +| | | | by the VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| virtualStorageDesc | VirtualStorageDesc | 0..N | Defines | support: | +| | | | descriptors | MANDATORY | +| | | | of virtual | | +| | | | storage | | +| | | | resources | | +| | | | to be used | | +| | | | by the VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| intVirtualLinkDesc | VirtualLinkDesc | 0..N | Represents | support: | +| | | | the type of | MANDATORY | +| | | | network | | +| | | | connectivity | | +| | | | mandated by | | +| | | | the VNF | | +| | | | provider | | +| | | | between two | | +| | | | or more CPs | | +| | | | which | | +| | | | includes at | | +| | | | least one | | +| | | | internal | | +| | | | CP. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfReservedCpd | VduCpd | 0..N | Reserved IP | support: | +| | | | Address for | MANDATORY | +| | | | VNF which | | +| | | | is not | | +| | | | bounded to | | +| | | | any | | +| | | | specific | | +| | | | VNFC, but | | +| | | | assigned | | +| | | | manually | | +| | | | from | | +| | | | outside and | | +| | | | potentially | | +| | | | shared as a | | +| | | | floating IP | | +| | | | among | | +| | | | VNFCs. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfExtCpd | VnfExtCpd | 1..N | Describes | support: | +| | | | external | MANDATORY | +| | | | interface(s) | | +| | | | exposed by | | +| | | | this VNF | | +| | | | enabling | | +| | | | connection | | +| | | | with a VL. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| deploymentFlavour | VnfDf | 1..N | Describes | support: | +| | | | specific | MANDATORY | +| | | | DF(s) of a | | +| | | | VNF with | | +| | | | specific | | +| | | | requirements | | +| | | | for | | +| | | | capacity | | +| | | | and | | +| | | | performance. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| configurableProperties | VnfConfigurableProperties | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | | configurable | | +| | | | properties | | +| | | | of the VNF | | +| | | | (e.g. | | +| | | | related to | | +| | | | auto | | +| | | | scaling and | | +| | | | auto | | +| | | | healing). | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| modifiableAttributes | VnfInfoModifiableAttributes | 0..1 | Describes | support: | +| | | | the | MANDATORY | +| | | | modifiable | | +| | | | attributes | | +| | | | of the VNF. | | +| | | | | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| lifeCycleManagementScript | LifeCycleManagementScript | 0..N | Includes a | support: | +| | | | list of | MANDATORY | +| | | | events and | | +| | | | corresponding | | +| | | | management | | +| | | | scripts | | +| | | | performed | | +| | | | for the | | +| | | | VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| elementGroup | VnfdElementGroup | 0..N | Describes | support: | +| | | | the | MANDATORY | +| | | | associated | | +| | | | elements of | | +| | | | a VNFD for | | +| | | | a certain | | +| | | | purpose | | +| | | | during VNF | | +| | | | lifecycle | | +| | | | management. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| vnfIndicator | VnfIndicator | 0..N | Declares | support: | +| | | | the VNF | MANDATORY | +| | | | indicators | | +| | | | that are | | +| | | | supported | | +| | | | by this | | +| | | | VNF. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| logo | String | 0..1 | File path | support: | +| | | | of the | MANDATORY | +| | | | vendor | | +| | | | specified | | +| | | | logo. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ +| guide | String | 0..1 | UUID of the | support: | +| | | | vendor | MANDATORY | +| | | | guide/documentation | | +| | | | which is | | +| | | | attached to | | +| | | | VNF and can | | +| | | | be | | +| | | | downloaded | | +| | | | from the | | +| | | | model. | | ++-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ diff --git a/docs/ONAP Model Spec/im/vnfdf.rst b/docs/ONAP Model Spec/im/vnfdf.rst new file mode 100644 index 0000000..c78de9f --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfdf.rst @@ -0,0 +1,210 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfDf +============ + ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++============================+=============================+==================+=======================+==========================+ +| flavorId | Identifier | 1 | Identifier | support: | +| | | | of this DF | MANDATORY | +| | | | within the | | +| | | | VNFD. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| description | String | 1 | Human | support: | +| | | | readable | MANDATORY | +| | | | description | | +| | | | of the DF. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| vduProfile | VduProfile | 1..N | Describes | support: | +| | | | additional | MANDATORY | +| | | | instantiation | | +| | | | data for | | +| | | | the VDUs | | +| | | | used in | | +| | | | this | | +| | | | flavor. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| virtualLinkProfile | VirtualLinkProfile | 0..N | Defines the | support: | +| | | | internal | MANDATORY | +| | | | VLD along | | +| | | | with | | +| | | | additional | | +| | | | data which | | +| | | | is used in | | +| | | | this DF. | | +| | | | | | +| | | | NOTE 1: | | +| | | | This allows | | +| | | | for | | +| | | | different | | +| | | | VNF | | +| | | | internal | | +| | | | topologies | | +| | | | between | | +| | | | DFs. | | +| | | | | | +| | | | NOTE 2: | | +| | | | virtualLink | | +| | | | Profile | | +| | | | needs to be | | +| | | | provided | | +| | | | for all VLs | | +| | | | that the | | +| | | | CPs of the | | +| | | | VDUs in the | | +| | | | VDU | | +| | | | profiles | | +| | | | connect to. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| instantiationLevel | InstantiationLevel | 1..N | Describes | support: | +| | | | the various | MANDATORY | +| | | | levels of | | +| | | | resources | | +| | | | that can be | | +| | | | used to | | +| | | | instantiate | | +| | | | the VNF | | +| | | | using this | | +| | | | flavour. | | +| | | | | | +| | | | Examples: | | +| | | | Small, | | +| | | | Medium, | | +| | | | Large. | | +| | | | | | +| | | | If there is | | +| | | | only one | | +| | | | "instantiationLevel" | | +| | | | entry, it | | +| | | | shall be | | +| | | | treated as | | +| | | | the default | | +| | | | instantiation | | +| | | | level for | | +| | | | this DF. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| affinityOrAntiAffinityGroup| AffinityOrAntiAffinityGroup | 0..N | Specifies | support: | +| | | | affinity or | MANDATORY | +| | | | anti-affinity | | +| | | | relationship | | +| | | | applicable | | +| | | | between the | | +| | | | virtualisation | | +| | | | containers | | +| | | | (e.g. | | +| | | | virtual | | +| | | | machines) | | +| | | | to be | | +| | | | created | | +| | | | using | | +| | | | different | | +| | | | VDUs or | | +| | | | internal | | +| | | | VLs to be | | +| | | | created | | +| | | | using | | +| | | | different | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | in the same | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group. | | +| | | | | | +| | | | NOTE: | | +| | | | In the | | +| | | | present | | +| | | | specification, | | +| | | | including | | +| | | | either | | +| | | | VDU(s) or | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | into the | | +| | | | same | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group is | | +| | | | supported. | | +| | | | Extension | | +| | | | to support | | +| | | | including | | +| | | | both VDU(s) | | +| | | | and | | +| | | | VnfVirtualLinkDesc(s) | | +| | | | into the | | +| | | | same | | +| | | | affinity or | | +| | | | anti-affinity | | +| | | | group is | | +| | | | left for | | +| | | | future | | +| | | | specification. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| scalingAspect | ScalingAspect | 0..N | The scaling | support: | +| | | | aspects | MANDATORY | +| | | | supported | | +| | | | by this DF | | +| | | | of the VNF. | | +| | | | scalingAspect | | +| | | | shall be | | +| | | | present if | | +| | | | the VNF | | +| | | | supports | | +| | | | scaling. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| placementGroup | PlacementGroup | 0..N | Determine | support: | +| | | | where | EXPERIMENTAL | +| | | | VNFC's | | +| | | | (VDU's) are | | +| | | | placed with | | +| | | | respect to | | +| | | | the VNF | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| baseConfigGroup | BaseConfigGroup | 0..1 |- BaseConfigGroup | support: | +| | | | may set | EXPERIMENTAL | +| | | | Access | | +| | | | Control | | +| | | | Lists | | +| | | | (ACL's) | | +| | | | and | | +| | | | establish | | +| | | | security | | +| | | | groups | | +| | | | and | | +| | | | server | | +| | | | groups. | | +| | | | | | +| | | |- BaseConfigGroup | | +| | | | creates/establishs | | +| | | | storage for the | | +| | | | VM's (OpenStack | | +| | | | Cinder). | | +| | | | | | +| | | |- BaseConfigGroup | | +| | | | may | | +| | | | establish | | +| | | | internal | | +| | | | networks | | +| | | | such as | | +| | | | OAM (VNF | | +| | | | Mgmt) or | | +| | | | MNS | | +| | | | (Maintenance & | | +| | | | Surveillance) | | +| | | | established. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ +| deploymentGroup | DeploymentGroup | 1..N | DeploymentGroup | support: | +| | | | provides | EXPERIMENTAL | +| | | | the minimum | | +| | | | viable VDU | | +| | | | and | | +| | | | associated | | +| | | | VNFC | | +| | | | configuration | | +| | | | for a | | +| | | | useable | | +| | | | VNF. | | ++----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/vnfextcpd.rst b/docs/ONAP Model Spec/im/vnfextcpd.rst new file mode 100644 index 0000000..8a34c7c --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfextcpd.rst @@ -0,0 +1,61 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfExtCpd +================ + ++-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=====================================+=====================================+==================+=====================================+==========================+ +| intCpd | Identifier | 0..1 | Reference | support: | +| | (Reference | | to the | MANDATORY | +| | to VduCpd) | | internal | | +| | | | VDU CPD | | +| | | | which is | | +| | | | used to | | +| | | | instantiate | | +| | | | internal | | +| | | | CPs. These | | +| | | | internal | | +| | | | CPs are, in | | +| | | | turn, | | +| | | | exposed as | | +| | | | external | | +| | | | CPs defined | | +| | | | by this | | +| | | | external | | +| | | | CPD. | | ++-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ +| virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..N | Specifies | support: | +| | | | requirements | MANDATORY | +| | | | on a | | +| | | | virtual | | +| | | | network | | +| | | | interface | | +| | | | realising | | +| | | | the CPs | | +| | | | instantiated | | +| | | | from this | | +| | | | CPD. | | +| | | | | | +| | | | NOTE: In | | +| | | | case of | | +| | | | referencing | | +| | | | an intCpd | | +| | | | via its | | +| | | | identifier, | | +| | | | the | | +| | | | virtualNetworkInterfaceRequirements | | +| | | | attribute | | +| | | | of the | | +| | | | referenced | | +| | | | intCpd | | +| | | | applies. | | ++-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ +| (inherited | | | All | | +| attributes) | | | attributes | | +| | | | inherited | | +| | | | from Cpd. | | ++-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst b/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst new file mode 100644 index 0000000..c818fa1 --- /dev/null +++ b/docs/ONAP Model Spec/im/vnfvirtuallinkdesc.rst @@ -0,0 +1,62 @@ +.. Copyright 2018 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Class: VnfVirtualLinkDesc +========================= + ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | ++=======================+=======================+==================+=================+==========================+ +| virtualLinkDescId | Identifier | 1 | Unique | support: | +| | | | identifier | MANDATORY | +| | | | of this | | +| | | | internal | | +| | | | VLD in | | +| | | | VNFD. | | ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| virtualLinkDescFlavour| VirtualLinkDescFlavour| 1..N | Describes a | support: | +| | | | specific | MANDATORY | +| | | | flavour of | | +| | | | the VL with | | +| | | | specific | | +| | | | bitrate | | +| | | | requirements. | | ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| connectivityType | ConnectivityType | 1 | | support: | +| | | | | MANDATORY | ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| testAccess | String | 0..N | Specifies | support: | +| | | | test access | MANDATORY | +| | | | facilities | | +| | | | expected on | | +| | | | the VL | | +| | | | (e.g. none, | | +| | | | passive | | +| | | | monitoring, | | +| | | | or active | | +| | | | (intrusive) | | +| | | | loopbacks | | +| | | | at | | +| | | | endpoints). | | ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| description | String | 0..1 | Provides | support: | +| | | | human-readable | MANDATORY | +| | | | information | | +| | | | on the | | +| | | | purpose of | | +| | | | the VL | | +| | | | (e.g. | | +| | | | control | | +| | | | plane | | +| | | | traffic). | | ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ +| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: | +| | | | virtualised | MANDATORY | +| | | | resources | | +| | | | monitoring | | +| | | | parameters | | +| | | | on VLD | | +| | | | level.  | | ++-----------------------+-----------------------+------------------+-----------------+--------------------------+ + \ No newline at end of file diff --git a/docs/ONAP Model Spec/index.rst b/docs/ONAP Model Spec/index.rst new file mode 100644 index 0000000..e09d341 --- /dev/null +++ b/docs/ONAP Model Spec/index.rst @@ -0,0 +1,17 @@ +.. Copyright 2017 (China Mobile) +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +.. onap-documentation documentation master file, created by + sphinx-quickstart on Mon Sep 18 15:12:14 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +ONAP R2 Modeling Specifications +============================================== + +.. toctree:: + :titlesonly: + + im/index + dm/index + diff --git a/docs/ONAP release 1 spec/Usecase/VoLTE/e2e.rst b/docs/ONAP release 1 spec/Usecase/VoLTE/e2e.rst deleted file mode 100644 index bad589e..0000000 --- a/docs/ONAP release 1 spec/Usecase/VoLTE/e2e.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -====================================== -VoLTE Usecase Service CSAR (Amsterdam) -====================================== - -E2E-VoLTE_ are the Service CSAR output from SDC as result of combination of vEPC_, vIMS_, and other resources Onboarded in VoLTE use case for demonstrating ONAP Amsterdam. - -.. _E2E-VoLTE: https://wiki.onap.org/download/attachments/6593603/service-VoLTE.csar?version=1&modificationDate=1510724431540&api=v2 - -.. _vEPC: https://wiki.onap.org/download/attachments/6593603/ns-EPC.csar?version=1&modificationDate=1510724379481&api=v2 - -.. _vIMS: https://wiki.onap.org/download/attachments/6593603/ns-IMS.csar?version=1&modificationDate=1510724447075&api=v2 diff --git a/docs/ONAP release 1 spec/Usecase/VoLTE/index.rst b/docs/ONAP release 1 spec/Usecase/VoLTE/index.rst deleted file mode 100644 index de736fd..0000000 --- a/docs/ONAP release 1 spec/Usecase/VoLTE/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP R1 Modeling Example: VoLTE -============================================== - -.. toctree:: - :titlesonly: - - vnfs.rst - ns.rst - e2e.rst - - diff --git a/docs/ONAP release 1 spec/Usecase/VoLTE/ns.rst b/docs/ONAP release 1 spec/Usecase/VoLTE/ns.rst deleted file mode 100644 index 5d65d19..0000000 --- a/docs/ONAP release 1 spec/Usecase/VoLTE/ns.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=============================================== -VoLTE Usecase Network Service CSARs (Amsterdam) -=============================================== - -vEPC_ and vIMS_ are two illustrative Network Service CSARs output from SDC as result of combination of commercial VNFs onboarded in VoLTE use case for demonstrating ONAP Amsterdam. - -.. _vEPC: https://wiki.onap.org/download/attachments/6593603/ns-EPC.csar?version=1&modificationDate=1510724379481&api=v2 - -.. _vIMS: https://wiki.onap.org/download/attachments/6593603/ns-IMS.csar?version=1&modificationDate=1510724447075&api=v2 diff --git a/docs/ONAP release 1 spec/Usecase/VoLTE/vnfs.rst b/docs/ONAP release 1 spec/Usecase/VoLTE/vnfs.rst deleted file mode 100644 index aff94d1..0000000 --- a/docs/ONAP release 1 spec/Usecase/VoLTE/vnfs.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=================================== -VoLTE Usecase VNF CSARs (Amsterdam) -=================================== - -The following are VNF CSARs from three vendors for commercial VNF onboarding in VoLTE use case for demonstrating ONAP Amsterdam. - -+------------+-------------------+----------------+ -| VNFs | VNF Provider | VNF CSAR | -+------------+-------------------+----------------+ -| vSBC | Huawei | vSBC.csar_ | -+------------+-------------------+----------------+ -| vPCSCF | Huawei | vPCSCF.csar_| -+------------+-------------------+----------------+ -| vSPGW | ZTE | vSPGW.csar_ | -+------------+-------------------+----------------+ -| vPCRF | Huawei | vPCRF.csar_ | -+------------+-------------------+----------------+ -| VI-SCSCF | Nokia | VI-SCSCF.csar_ | -+------------+-------------------+----------------+ -| vTAS | Nokia | N/A | -+------------+-------------------+----------------+ -| vHSS | Huawei | vHSS.csar_ | -+------------+-------------------+----------------+ -| vMME | Huawei | vMME.csar_ | -+------------+-------------------+----------------+ - - -.. _vSBC.csar: https://wiki.onap.org/download/attachments/6593603/vSBC_aligned.csar?version=1&modificationDate=1510644971324&api=v2 - -.. _vPCSCF.csar: https://wiki.onap.org/download/attachments/6593603/Huawei_vPCRF_aligned_fixed.csar?version=2&modificationDate=1510645106445&api=v2 - -.. _vSPGW.csar: https://wiki.onap.org/download/attachments/6593603/ZteEpcSpgwVf-csar.csar?version=1&modificationDate=1510645058137&api=v2 - -.. _vPCRF.csar: https://wiki.onap.org/download/attachments/6593603/Huawei_vPCRF_aligned_fixed.csar?version=2&modificationDate=1510645106445&api=v2 - -.. _VI-SCSCF.csar: https://wiki.onap.org/download/attachments/6593603/cscf_si.csar?version=1&modificationDate=1510645132399&api=v2 - -.. _vHSS.csar: https://wiki.onap.org/download/attachments/6593603/Huawei_vHSS.csar?version=1&modificationDate=1510645179035&api=v2 - -.. _vMME.csar: https://wiki.onap.org/download/attachments/6593603/Huawei_vMME.csar?version=1&modificationDate=1510645201231&api=v2 - diff --git a/docs/ONAP release 1 spec/Usecase/index.rst b/docs/ONAP release 1 spec/Usecase/index.rst deleted file mode 100644 index d38904e..0000000 --- a/docs/ONAP release 1 spec/Usecase/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP R1 Modeling Artifacts Examples -============================================== - -.. toctree:: - :titlesonly: - - VoLTE/index - vCPE/index - diff --git a/docs/ONAP release 1 spec/Usecase/vCPE/index.rst b/docs/ONAP release 1 spec/Usecase/vCPE/index.rst deleted file mode 100644 index 3915cd4..0000000 --- a/docs/ONAP release 1 spec/Usecase/vCPE/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP R1 Modeling Example: vCPE -============================================== - -.. toctree:: - :titlesonly: - - diff --git a/docs/ONAP release 1 spec/csar/csar-sdc-input.JPG b/docs/ONAP release 1 spec/csar/csar-sdc-input.JPG deleted file mode 100644 index 13efe40..0000000 Binary files a/docs/ONAP release 1 spec/csar/csar-sdc-input.JPG and /dev/null differ diff --git a/docs/ONAP release 1 spec/csar/csar-sdc-output-service.JPG b/docs/ONAP release 1 spec/csar/csar-sdc-output-service.JPG deleted file mode 100644 index d15a65a..0000000 Binary files a/docs/ONAP release 1 spec/csar/csar-sdc-output-service.JPG and /dev/null differ diff --git a/docs/ONAP release 1 spec/csar/csar-sdc-output-vf.JPG b/docs/ONAP release 1 spec/csar/csar-sdc-output-vf.JPG deleted file mode 100644 index 1450c0a..0000000 Binary files a/docs/ONAP release 1 spec/csar/csar-sdc-output-vf.JPG and /dev/null differ diff --git a/docs/ONAP release 1 spec/csar/csar.rst b/docs/ONAP release 1 spec/csar/csar.rst deleted file mode 100644 index e48fca7..0000000 --- a/docs/ONAP release 1 spec/csar/csar.rst +++ /dev/null @@ -1,140 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=================================== -ONAP CSAR Specification (Amsterdam) -=================================== - -CSAR for VNF Onboarding ------------------------ -This is the currently expected structure supported by SDC, which is provided by VNF Vendor directly or via VNF Market (through VNF SDK) to SDC for VNF onboarding in design time. - - -|image0| - -\ **Figure 1. CSAR for VNF Onboarding** - - -The files/directories under the root of CSAR include: - -* **MainServiceTemplate.mf** is a map representing the different parts of the CSAR structure. -* **MainServiceTemplate.yaml** is a copy of the main service template located under Definitions directory. -* **TOSCA-Metadate** is a directory which contains **TOSCA.meta** file, the metadata regarding the CSAR structure. -* **Artifacts** is a directory which contains all the recoginzable artifacts (except those of type *Other*). It should be noted that images are not supported in ONAP Amsterdam as artifacts in CSAR. And all the artifacts are further classified as either *Informational* or *Deployment*, and are located in the sub-directories respectively. Artifacts located in the root directory or un-recognized folders will be classified as *Other*. -* **Definitions** is a directory which contains all the TOSCA YAML files. - -The files/directories under the *Artifacts* directory further include: - -* **Informational** directory which holds all the informative artifacts supported directly by SDC. -* **Deployment** directory which holds all the deployment artifacts supported directly by SDC. -* (Optional) **VFC TOSCA ** directory for each VFC (i.e. VF Component) which holds all the artifacts for the VFC ****. - -The files/directories under each **VFC TOSCA ** sub-directory further include: - -* **Informational** directory which holds all the informative artifacts at the VFC level. -* **Deployment** directory which holds all the deployment artifacts at the VFC level. - - -CSAR for VNF Life Cycle Management ----------------------------------- -This section describes the CSAR generated by SDC for VNF and to be consumed by SO/VF-C/etc. for VNF life cycle management in run-time. - -|image1| - -\ **Figure 2. CSAR for VNF LCM** - -The files/directories under the root of CSAR include: - -* **TOSCA-Metadate** is a directory which contains **TOSCA.meta** file, the metadata regarding the CSAR structure. -* **Artifacts** is a directory which contains all the recoginzable artifacts (except those of type *Other*). All the artifacts are further classified as either *Informational* or *Deployment*, and are located in the sub-directories respectively. Artifacts located in the root directory or un-recognized folders will be classified as *Other*. -* **Resources** is a directory which contains a sub-directory **node_template ** per each node_template that has specific artifacts (artifacts that were added to the instance/customized for the instance or generated for the instance. This folder should **NOT** include artifacts of the type of the instance. (e.g. HEAT should be in the folder of the VF and not in the folder of the VF instance, HEAT_ENV will be in the folder of the instance.) -* **Definitions** is a directory which contains all the TOSCA yaml files. - -The files/directories under the *Artifacts* directory further include: - -* **Informational** directory which holds all the informative artifacts supported directly by SDC. -* **Deployment** directory which holds all the deployment artifacts supported directly by SDC. -* (Optional) **VFC TOSCA ** directory for each VFC (i.e. VF Component) which holds all the artifacts for the VFC ****. - -The files/directories under each **VFC TOSCA ** sub-directory further include: - -* **Informational** directory which holds all the informative artifacts at the VFC level. -* **Deployment** directory which holds all the deployment artifacts at the VFC level. - -CSAR for Service Life Cyclem Management ---------------------------------------- -This section describes the CSAR generated by SDC for Network Service or End-to-End Service orchestration in run time. - -|image2| - -\ **Figure 3. CSAR for Service LCM** - -The files/directories under the root of CSAR include: - -* **TOSCA-Metadate** is a directory which contains **TOSCA.meta** file, the metadata regarding the CSAR structure. -* **Artifacts** is a directory which contains all the recoginzable artifacts (except those of type *Other*). All the artifacts are further classified as either *Informational* or *Deployment*, and are located in the sub-directories respectively. Artifacts located in the root directory or un-recognized folders will be classified as *Other*. -* **Resources** is a directory which contains a sub-directory **node_template ** per each node_template that has specific artifacts (artifacts that were added to the instance/customized for the instance or generated for the instance. This folder should **NOT** include artifacts of the type of the instance. (e.g. HEAT should be in the folder of the VF and not in the folder of the VF instance, HEAT_ENV will be in the folder of the instance.) -* **Definitions** is a directory which contains all the TOSCA YAML files. - -The files/directories under the *Artifacts* directory further include: - -* **Informational** directory which holds all the informative artifacts supported directly by SDC. -* **Deployment** directory which holds all the deployment artifacts supported directly by SDC. -* (Optional) **VF TOSCA ** directory for each VF which holds all the artifacts for the VF ****. - -The files/directories under each **VF TOSCA ** sub-directory further include: - -* **Informational** directory which holds all the informative artifacts at the VF level. -* **Deployment** directory which holds all the deployment artifacts at the VF level. - -Artifacts supported by SDC --------------------------- -This section enumerates the artifacts types supported by SDC. -Artifacts at the root directory or unrecognized folder(s) will be classified as type Other. - -+------------------------+-------------+---------------------------------+------------------+ -| Type | Category | Description |Component Types | -+========================+=============+=================================+==================+ -| HEAT | Deployment | HEAT Base Template (YAML) | VF | -+------------------------+-------------+---------------------------------+------------------+ -| HEAT_VOL | Deployment | HEAT Template for volumes (YAML)| VF | -+------------------------+-------------+---------------------------------+------------------+ -| HEAT_NET | Deployment | HEAT Template for network (YAML)| VF | -+------------------------+-------------+---------------------------------+------------------+ -| HEAT_ENV | Deployment |HEAT Environment artifacts (YAML)| VF | -+------------------------+-------------+---------------------------------+------------------+ -| HEAT_ARTIFACT | Deployment | Supplementary artifacts in HEAT | VF | -+------------------------+-------------+---------------------------------+------------------+ -| HEAT_NESTED | Deployment | HEAT refered by another HEAT | VF | -+------------------------+-------------+---------------------------------+------------------+ -| YANG_XML |Informational| YANG asset based XML |Service/VF/VFC | -+------------------------+-------------+---------------------------------+------------------+ -| VNF_CATALOG |Informational| YANG asset based XML |Service/VF/VFC | -+------------------------+-------------+---------------------------------+------------------+ -|MODEL_INVENTORY_PROFILE |Informational| Inventory asset (XML) |Service/VF/VFC | -+------------------------+-------------+---------------------------------+------------------+ -|MODEL_INVENTORY_PROFILE |Informational| Inventory asset named query spec|Service/VF/VFC | -+------------------------+-------------+---------------------------------+------------------+ -| VF_LICENSE |Informational| VF License artifact | VF | -+------------------------+-------------+---------------------------------+------------------+ -| VENDOR_LICENSE |Informational| Vendor License artifact | VF | -+------------------------+-------------+---------------------------------+------------------+ -| APPC_CONFIG |Informational| Configuration artifact for APPC | VF | -+------------------------+-------------+---------------------------------+------------------+ -| VF_MODULES_METADATA |Informational| JSON artifact for VF Modules |Component instance| -+------------------------+-------------+---------------------------------+------------------+ -| DCAE_TOSCA |Deployment | DCAE TOSCA Template (YAML) | VF/VFCMT | -+------------------------+-------------+---------------------------------+------------------+ -| DCAE_JSON |Deployment | JSON for DCAE component/template| VF/VFCMT | -+------------------------+-------------+---------------------------------+------------------+ -| Other | | Artifacts at the Root or other | Service/VF/VFC | -| | | unrecognized folders. | | -+------------------------+-------------+---------------------------------+------------------+ - -.. |image0| image:: csar-sdc-input.JPG - -.. |image1| image:: csar-sdc-output-vf.JPG - -.. |image2| image:: csar-sdc-output-service.JPG - diff --git a/docs/ONAP release 1 spec/csar/index.rst b/docs/ONAP release 1 spec/csar/index.rst deleted file mode 100644 index ce1b6c0..0000000 --- a/docs/ONAP release 1 spec/csar/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - - -ONAP CSAR Specification -======================= - -.. toctree:: - :titlesonly: - - csar diff --git a/docs/ONAP release 1 spec/dm/dm.rst b/docs/ONAP release 1 spec/dm/dm.rst deleted file mode 100644 index 35f2ee6..0000000 --- a/docs/ONAP release 1 spec/dm/dm.rst +++ /dev/null @@ -1,1161 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -ONAP Release 1 Data Models -============================ - -| Document version: 1.0 -| Last changed: October 30, 2017 - -System Architect: Marina Leybman -Modeling subcommittee - -Table - Revision History - -+------------------+------------------+-------------+----------------------+-------------------+ -| Version Number | Owner | Approvers | Date | Version Notes | -| | | | | | -| | | | Approved | (Changes Made) | -+==================+==================+=============+======================+===================+ -| 1.00 | Marina Leybman | | September 10, 2017 | Document issued | -+------------------+------------------+-------------+----------------------+-------------------+ -| 1.00 | Hui Deng | | October 30, 2017 | Document issued | -+------------------+------------------+-------------+----------------------+-------------------+ - - -Introduction ------------- - -This document provides ONAP Release 1 Data Models for nodes, data types, -capabilities, groups. - -Purpose of the document ------------------------ - -To define ONAP Release 1 Data Models (nodes, data types, capabilities, groups) in -high level including relation to derived from elements, references to -elements and requirements specific node requires. - -References ----------- - -1. nodes.yml - -2. data.yml - -3. capabilities.yml - -4. groups.yml - -1. .. rubric:: Nodes – Data Model - :name: nodes-data-model - -2. .. rubric:: Data Types Model - :name: data-types-model - -3. .. rubric:: Capabilities Data Model - :name: capabilities-data-model - -4. .. rubric:: Groups Data Model - :name: groups-data-model - -5. .. rubric:: Appendix - :name: appendix - - 1. .. rubric:: SDC – Nodes (information from yml) - :name: sdc-nodes-information-from-yml - -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| node\_types [] | properties | attributes | requirements | capabilities | interfaces | -+==========================================================================================================+================================================================================================================================================================================+================================================================================================================+==============================================================================================================================================================================+==================================================================================================+==============+ -| {derived\_from, node\_type, properties [],attributes [],requirements [],capabilities [],Interfaces []} | {type, description, default, status, entry\_schema} | {type, description, default, status, entry\_schema} | {capability, node, relationship, occurrences} | {type, description, properties, attributes, valid\_source\_types, occurrences} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **BlockStorage** | size {type,constraints} | | | **attachment**\ {tosca.capabilities.Attachment} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | volume\_id {type,required) | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | snapshot\_id {type,required) | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **Compute**: | | private\_address  {type} | local\_storage{capability:tosca.capabilities.Attachment,node:tosca.nodes.BlockStorage, relationship: org.openecomp.relationships.AttachesTo, occurrences} | host{type: tosca.capabilities.Container, valid\_source\_types} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | public\_address{type} | | endpoint{type: tosca.capabilities.Endpoint.Admin} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | networks{type, entry\_schema(type: tosca.datatypes.network.NetworkInfo)}; | | os{type: tosca.capabilities.OperatingSystem} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | ports{type, entry\_schema(type: tosca.datatypes.network.PortInfo)} | | scalable{type:tosca.capabilities.Scalable}, scalable{type:tosca.capabilities.network.Bindable} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **Container.Application**: | | | host{capability: tosca.capabilities.\ **Container**,node: tosca.nodes.\ **Container**, relationship: tosca.relationships.HostedOn } | | | -| | | | | | | -|     derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **Container.Runtime**: | | | | host{type: tosca.capabilities.Container} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **SoftwareComponent** | | | | scalable{type:tosca.capabilities.Scalable} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **Database**: | name{type,description} | | host{capability:tosca.capabilities.Container,node:tosca.nodes.DBMS, relationship: tosca.relationships.HostedOn } | database\_endpoint{type: tosca.capabilities.Endpoint.Database} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | port{type,description,required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | user{type,description,required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | password{type,description,required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **DBMS**: | root\_password{type,description,required} | | | host{type: tosca.capabilities.Container, valid\_source\_types: tosca.nodes.Database} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **SoftwareComponent** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | port{type,description,required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **LoadBalancer**: | algorithm{type, required, status} | | application{capability:tosca.capabilities.Endpoint, relationship: tosca.relationships.RoutesTo, occurrences} | client{type:tosca.capabilities.Endpoint.Public, occurrences, description} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **network.Network**: | ip\_version{type,required,default,consraints(valid\_values)} | | | link{type:tosca.capabilities.network.Linkable} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | cidr{type,required} | | | | | -| | | | | | | -| | start\_ip{type,required} | | | | | -| | | | | | | -| | end\_ip{type,required} | | | | | -| | | | | | | -| | gateway\_ip{type,required} | | | | | -| | | | | | | -| | network\_name{type,required} | | | | | -| | | | | | | -| | network\_id{type,required} | | | | | -| | | | | | | -| | segmentation\_id{type,required} | | | | | -| | | | | | | -| | network\_type{type,required} | | | | | -| | | | | | | -| | physical\_network{type,required} | | | | | -| | | | | | | -| | dhcp\_enabled{type,required,default} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **ObjectStorage**: | name{type} | | | storage\_endpoint{type:tosca.capabilities.Endpoint} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | size {type,constraints(greater\_or\_equal)} | | | | | -| | | | | | | -| | maxsize {type,constraints(greater\_or\_equal)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **network.Port**: | ip\_address{type,required} | | link{capability:tosca.capabilities.network.Linkable,relationship: tosca.relationships.network.LinksTo} | | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | order{type,required,default,constraints} | | binding{capability:tosca.capabilities.network.Bindable,relationship: tosca.relationships.network.BindsTo} | | | -| | | | | | | -| | is\_default{type,required,default} | | | | | -| | | | | | | -| | is\_range\_start{type,required,default} | | | | | -| | | | | | | -| | is\_range\_end{type,required,default} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **Root** | | toska\_id{type} | dependency {capability: tosca.capabilities.Node, node:tosca.nodes.\ **Root**, relationship: tosca.relationships.DependsOn, occurrences} | feature{type: tosca.capabilities.Node} | | -| | | | | | | -| | | toska\_name{type} | | | | -| | | | | | | -| | | state{type} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **SoftwareComponent**: | component\_version{type, required} | | host{capability:tosca.capabilities.Node, node:tosca.nodes.Compute, relationship: tosca.relationships.HostedOn} | | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | admin\_credential {type: tosca.datatypes.Credential, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **WebApplication**: | context\_root{type} | | host{capability:tosca.capabilities.Container,node:tosca.nodes.WebServer, relationship: tosca.relationships.HostedOn } | app\_endpoint{type:tosca.capabilities.Endpoint} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **WebServer**: | | | | data\_endpoint{tosca.capabilities.Endpoint} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **SoftwareComponent** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | admin\_endpoint{tosca.capabilities.Endpoint.Admin} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | | | host{type:tosca.capabilities.Container, valid\_source\_types:tosca.nodes. WebApplication} | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **AbstractSubstitute**: | service\_template\_filter{type, description, required, status} | | | | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| **heat.cinder.Volume**: | availability\_zone{type, description, required, status} | | | | | -| | | | | | | -| derived\_from: org.openecomp.resource.vfc.nodes.\ **volume** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | image{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | image{type, description, entry\_schema(type,required)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.abstract.nodes.\ **AbstractSubstitute**: | service\_template\_filter {type: org.openecomp.datatypes.heat.substitution.SubstitutionFiltering, description, required, status} | | | | | -| | | | | | | -|     derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.vfc.nodes.\ **heat.cinder.Volume**: | availability\_zone {type, description, required, status} | | | | | -| | | | | | | -| derived\_from: org.openecomp.resource.vfc.nodes.\ **volume** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | image {type, description, required, status} | display\_description{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | metadata {type, description, required, status, entry\_schema(type)} | attachments{type, description, status, entry\_schema(type)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | volume\_type{type, description, required, status} | encrypted {type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | description{type, description, required, status} | show {type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | device\_type{type, description, required, status, constraints} | created\_at {type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | disk\_bus{type, description, required, status, constraints} | display\_name {type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | backup\_id{type, description, required, status} | metadata\_values {type, description, status, entry\_schema(type)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | source\_volid{type, description, required, status} | bootable {type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | boot\_index{type, description, required, status} | status {type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | size{type, description, required, status, constraints} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | read\_only {type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | name {type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | scheduler\_hints {type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | swap\_size {type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | delete\_on\_termination {type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | multiattach {type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | availability\_zone{type, description, required, status} | fq\_name{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | static\_routes\_list{type, description, required, status, entry\_schema(type)} | service\_template\_name{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | availability\_zone\_enable{type, description, required, status, default} | show{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_template\_name{type, description, required, status} | active\_vms{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | ordered\_interfaces{type, description, required, status, default} | service\_instance\_name{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | flavor {type, description, required, status} | virtual\_machines{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | image\_name {type, description, required, status} | status{type, description,status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_type {type, description, required, status, constraints} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_interface\_type\_list {type, description, required, status, entry\_schema (type, constraints(valid\_values))} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_instance\_name {type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_mode {type, description, required, status, constraints(valid\_values)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | shared\_ip\_list {type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | image\_name{type, description, required, status} | fq\_name{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | availability\_zone{type, description, required, status} | show{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_type{type, description, required, status, constraints(valid\_values)} | active\_vms{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | availability\_zone\_enable{type, description, required, status, default} | virtual\_machines{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_template\_name{type, description, required, status} | status{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_instance\_name{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | service\_mode{type, description, required, status, constraints(valid\_values)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | name{type, description, required, status} | tenant\_id{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | fq\_name{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | show{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | | rules{type, description, status, entry\_schema(type)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | virtual\_network{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | static\_route{type, description, required, status,default} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | shared\_ip{type, description, required, status,default} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | ip\_address{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | interface\_type{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | security\_group\_refs{type, description, required, status, entry\_schema(type)} | show{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | virtual\_network\_refs{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | port\_tuple\_refs{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | virtual\_machine\_interface\_mac\_addresses{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_ipam\_refs{type, description, required, status, entry\_schema(type)} | subnets\_show{type, description, status, entry\_schema(type)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_policy\_refs{type, description, required, status, entry\_schema(type)} | subnets{type, description, status, entry\_schema(type: org.openecomp.datatypes.heat.network.neutron.Subnet)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | subnets{type, description, required, status, entry\_schema(type: org.openecomp.datatypes.heat.network.neutron.Subnet)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | name{type, description, required, status} | show{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | virtual\_network\_refs{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | security\_group\_refs{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | port\_tuple\_refs{type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | forwarding\_mode {type, description, required, status} | show{type, description, status} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | external {type, description, required, status} | subnets\_name{type, description, status, entry\_schema(type)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | allow\_transit {type, description, required, status} | subnets\_show{type, description, status, entry\_schema(type)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | flood\_unknown\_unicast{type, description, required, status} | subnets{type, description, status, entry\_schema(type org.openecomp.datatypes.heat.network.neutron.Subnet)} | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | route\_targets {type, description, required, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | subnets{type, description, required, status, entry\_schema(type: org.openecomp.datatypes.heat.network.neutron.Subnet)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.vl.ELine | | | | virtual\_linkable{type: tosca.capabilities.network. Linkable, occurrences} | | -| | | | | | | -| derived\_from: org.openecomp.resource.vl.VL | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.cp.\ **extCP**: | network\_role{type, description, required} | | virtualLink{capability:tosca.capabilities.network.Linkable, relationship: tosca.relationships.network.LinksTo} | internal\_connectionPoint{type:tosca.capabilities.Node, valid\_source\_type} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -| | | | | | | -| description: The SDC Connection Point base type all other CP derive from | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | order{type, description, required} | | virtualBinding{capability:tosca.capabilities.network.Bindable, relationship: tosca.relationships.network.BindsTo} | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_role\_tag{type, description, required} | | external\_virtualLink{capability:tosca.capabilities.network.Bindable, relationship: tosca.relationships.network.LinksTo, node: org.openecomp.resource.vl.VL} | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | mac\_requirements{type: org.openecomp.datatypes.network.MacRequirements, description, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | vlan\_requirements{type, description, required, entry\_schema(type: org.openecomp.datatypes.network.VlanRequirements)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | ip\_requirements{type, description, required, entry\_schema(type: org.openecomp.datatypes.network.IpRequirements)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | exCP\_naming{type: org.openecomp.datatypes.Naming} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.vl.\ **extVL**: | network\_type {type, description, required} | | | virtual\_linkable{type:tosca.capabilities.network.Linkable} | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -| | | | | | | -| description: VF Tenant oam protected network | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_role {type, description, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_scope {type, description, constraints} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_technology {type, description, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | exVL\_naming {type: org.openecomp.datatypes.Naming, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_homing {type: org.openecomp.datatypes.EcompHoming, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_assignments {type: org.openecomp.datatypes.network.NetworkAssignments, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | provider\_network{type: org.openecomp.datatypes.network.ProviderNetwork, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | network\_flows {type: org.openecomp.datatypes.network.NetworkFlows, required} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.abstract.nodes.\ **PNF**: | nf\_function{type} | | | | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nf\_role{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nf\_type{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.abstract.nodes.\ **service**: | | | | | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.abstract.nodes.\ **VF**: | nf\_function{type} | | | | | -| | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nf\_role{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nf\_naming\_code{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nf\_type{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nf\_naming{type: org.openecomp.datatypes.Naming, default} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | availability\_zone\_max\_count{type, default, constraints(valid\_values)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | min\_instances{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | max\_instances{type} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| resource.abstract.nodes.\ **VFC**: | nfc\_function{type} | | | | | -| | | | | | | -| derived\_from: org.openecomp.resource.abstract.nodes.\ **AbstractSubstitute** | | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | high\_availablity{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | vm\_image\_name{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | vm\_flavor\_name{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nfc\_naming\_code{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | vm\_type\_tag{type, description, required, status} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | nfc\_naming{type: org.openecomp.datatypes.Naming, description} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | min\_instances{type, description, required, status, constraints(greater\_or\_equal)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ -| | max\_instances{type, description, required, status, constraints(greater\_or\_equal)} | | | | | -+----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+--------------+ - -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| node\_types [] | properties | attributes | requirements | capabilities | Capabilities[properties] | Capabilities[other parameters] | -+==========================================================================================================+=================================================================+=======================================================+=================================================+====================================================================================================+===================================================================+==================================+ -| {derived\_from, node\_type, properties [],attributes [],requirements [],capabilities [],Interfaces []} | {type, description, default, status, required, entry\_schema} | {type, description, default, status, entry\_schema} | {capability, node, relationship, occurrences} | {type, description, properties, attributes, valid\_source\_types, occurrences} | | | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vfc.nodes.\ **Compute**: | | | | disk.ephemeral.size{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -| | | | | | | | -| derived\_from: tosca.nodes.\ **Compute** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | instance{type: org.openecomp.capabilities.metric.Ceilometer, description} | Capabilities [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | memory{type: org.openecomp.capabilities.metric.Ceilometer, description} | Capabilities [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.iops{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.read.requests{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | cpu.delta{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.capacity{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.read.bytes{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.write.bytes{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.latency{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.read.bytes.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.usage{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | cpu\_util{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.allocation{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.write.requests.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.write.bytes.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.latency{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | cpu{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.write.requests{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.write.bytes{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.read.requests:{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.root.size{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.write.bytes.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | vcpus{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.iops{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.usage{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.read.requests.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.write.requests.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.allocation{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.read.bytes.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.read.bytes{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | memory.usage{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.device.capacity{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | memory.resident{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | | | | disk.write.requests{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+-------------------------------------------------------+-------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ - -+-------------------------------------------------------------------+ -| CapabilitiesProperties [unit,name, description, type, category] | -+===================================================================+ -| unit{type, description, required, default, status} | -+-------------------------------------------------------------------+ -| name{type, description, required, default, status} | -+-------------------------------------------------------------------+ -| description{type, description, required, default, status} | -+-------------------------------------------------------------------+ -| type{type, description, required, default, status} | -+-------------------------------------------------------------------+ -| category{type, description, required, default, status} | -+-------------------------------------------------------------------+ - -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| node\_types [] | properties | attributes | requirements | capabilities | Capabilities[properties] | Capabilities[other parameters] | -+==========================================================================================================+=====================================================================================================================================+==========================================================================================================================+============================================================================================================================+==================================================================================================+===================================================================+==================================+ -| {derived\_from, node\_type, properties [],attributes [],requirements [],capabilities [],Interfaces []} | {type, description, default, status, required, entry\_schema} | {type, description, default, status, entry\_schema} | {capability, node, relationship, occurrences} | {type, description, properties, attributes, valid\_source\_types, occurrences} | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vl.nodes.\ **network.Network**: | vendor{type,required} | | | end\_point{type:tosca.capabilities.Endpoint} | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **network.Network** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | vl\_name{type,required) | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.cp.nodes.\ **network.Port**: | network\_role{type, description, required} | | | network.incoming.packets.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -| | | | | | | | -| derived\_from: tosca.nodes.\ **network.Port** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | order{type, description, required} | | | network.outgoing.bytes{type: org.openecomp.capabilities.metric.Ceilometer, description} | Capabilities [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | network\_role\_tag{type, description, required} | | | network.outgoing.packets.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | Capabilities [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | mac\_requirements{type: org.openecomp.datatypes.network.MacRequirements, description, required} | | | network.outpoing.packets{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | vlan\_requirements{type, description, required, entry\_schema(type: org.openecomp.datatypes.network.VlanRequirements)} | | | network.incoming.bytes.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | ip\_requirements {type, description, required, entry\_schema(type: org.openecomp.datatypes.network.IpRequirements)} | | | network.incoming.bytes{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | exCP\_naming{type: org.openecomp.datatypes.Naming } | | | network.outgoing.bytes.rate{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | subnetpoolid{type} | | | network.incoming.packets{type: org.openecomp.capabilities.metric.Ceilometer, description} | CapabilitiesProperties [unit,name, description, type, category] | occurrences | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vl.\ **internalVL**: | | | | | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **network.Network** | | | | | | | -| | | | | | | | -| description: The AT&T internal (VF-level) Virtual Link | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.abstract.nodes.\ **MultiFlavorVFC**: | images{type, required, entry\_schema(type: org.openecomp.datatypes.ImageInfo)} | | | | | | -| | | | | | | | -| derived\_from: org.openecomp.resource.abstract.nodes.\ **VFC** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vl.nodes.\ **heat.network.neutron.Net**: | dhcp\_agent\_ids{type, description, required,status, entry\_schema(type)} | qos\_policy\_id{type, description, status, entry\_schema(type)} | | attachment{type: tosca.capabilities.Attachment, occurrences} | | | -| | | | | | | | -| derived\_from: org.openecomp.resource.vl.nodes.\ **network.Network** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | tenant\_id{type, description, required,status} | show{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | port\_security\_enabled{type, description, required, status} | subnets\_name{type, description, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | shared{type, description, required,default,status} | subnets{type, description, status, entry\_schema(type: org.openecomp.datatypes.heat.network.neutron.Subnet)} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | admin\_state\_up{type, description, required,default,status} | mtu{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | qos\_policy{type, description, required ,status} | status{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | subnets{type, description, required ,status, entry\_schema(type: org.openecomp.datatypes.heat.network.neutron.Subnet)} | {type, description, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | value\_specs{type, description, required,default,status, entry\_schema(type)} | {type, description, status, entry\_schema(type)} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.cp.nodes.\ **heat.network.neutron.Port**: | port\_security\_enabled{type, description, required,status} | tenant\_id{type, description, status} | | attachment{type: tosca.capabilities.Attachment, occurrences} | | | -| | | | | | | | -| derived\_from: org.openecomp.resource.cp.nodes.\ **network.Port** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | device\_id{type, description, required,status} | network\_id{type, description, status} | | binding{type: tosca.capabilities.network.Bindable, valid\_source\_types, occurrences} | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | qos\_policy{type, description, required,status} | qos\_policy\_id{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | allowed\_address\_pairs{type, description, required,status, entry\_schema(type org.openecomp.datatypes.heat.network.AddressPair)} | show{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | binding{type, description, required,status, constraints(valid\_values)} | subnets{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | value\_specs{type, description, required,default, status, entry\_schema(type)} | status{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | device\_owner{type, description, required,status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | network{type, description, required,status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | replacement\_policy{type, description, required, default, status, constraints(valid\_values)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | security\_groups{type, description, required, status, entry\_schema(type)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | fixed\_ips{type, description, required, status, entry\_schema(type: org.openecomp.datatypes.heat.neutron.port.FixedIps)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | mac\_address{type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | admin\_state\_up{type, description, required, default, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | name{type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vfc.nodes.\ **heat.nova.Server**: | admin\_pass{type, description, required, status} | accessIPv4{type, description, status} | | | | | -| | | | | | | | -| derived\_from: org.openecomp.resource.vfc.nodes.\ **Compute** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | availability\_zone{type, description, required, status} | addresses{type, description, status, entry\_schema(type: org.openecomp.datatypes.heat.novaServer.network.AddressInfo)} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | image{type, description, required, status} | accessIPv6{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | image\_update\_policy{type, description, required, default, status, constraints(valid\_values)} | instance\_name{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | metadata{type, description, required, status} | name{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | user\_data\_update\_policy{type, description, required, default, status, constraints(valid\_values)} | console\_urls{type, description, status} | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | flavor\_update\_policy{type, description, required, default, status, constraints(valid\_values)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | user\_data{type, description, required, default, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | flavor {type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | key\_name {type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | reservation\_id {type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | security\_groups {type, description, required, default, status, entry\_schema(type)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | config\_drive{type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | personality {type, description, required, default, status, entry\_schema(type)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | software\_config\_transport{type, description, required, default, status, constraints(valid\_values)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | user\_data\_format{type, description, required, default, status, constraints(valid\_values)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | diskConfig{type, description, required, status, constraints(valid\_values)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | name{type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | scheduler\_hints{type, description, required, status, entry\_schema(type)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vfc.rules.nodes.\ **heat.network.neutron.SecurityRules**: | description{type, description, required, status} | show{type, description, status} | port{capability: tosca.capabilities.Attachment, node, relationship: org.openecomp.relationships.AttachesTo, occurrences} | | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | name{type, description, required, status} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | rules{type, description, required, status, entry\_schema(type: org.openecomp.datatypes.heat.network.neutron.SecurityRules.Rule)} | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.cp.nodes.\ **network.SubInterface**: | | | | | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **network.Port** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.\ **vl.VL**: | vendor{type, required} | | | virtual\_linkable{type: tosca.capabilities.network.Linkable} | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **network.Network** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| | vl\_name{type, required} | | | end\_point{type:tosca.capabilities.Endpoint} | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.abstract.nodes.\ **VnfConfiguration**: | allowed\_flavors{type, description, entry\_schema(type: org.openecomp.datatypes.flavors.DeploymentFlavor)} | | | | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **Root** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vfc.nodes.\ **volume**: | | | | | | | -| | | | | | | | -| derived\_from: tosca.nodes.\ **BlockStorage** | | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ -| resource.vfc.AllottedResource | depending\_service\_uuid{type, description, required} | | service\_dependency(capability: org.openecomp.capabilities.AllottedResource,relationship,node:tosca.services.Root} | | | | -| | | | | | | | -| derived\_from: tosca.nodes.Root | role{type, description, required} | | | | | | -| | | | | | | | -| description: ECOMP Allotted Resource base type all other allotted resources node types derive from | ecomp\_homing{type: org.openecomp.datatypes.EcompHoming, required} | | | | | | -| | | | | | | | -| | ecomp\_naming{type: org.openecomp.datatypes.EcompNaming, required} | | | | | | -| | | | | | | | -| | min\_instances{type, default} | | | | | | -| | | | | | | | -| | max\_instances{type, default} | | | | | | -| | | | | | | | -| | providing\_service\_uuid | | | | | | -| | | | | | | | -| | providing\_service\_invariant\_uuid | | | | | | -| | | | | | | | -| | providing\_service\_name | | | | | | -| | | | | | | | -| | target\_network\_role | | | | | | -| | | | | | | | -| | role | | | | | | -| | | | | | | | -| | ecomp\_naming | | | | | | -| | | | | | | | -| | min\_instances | | | | | | -| | | | | | | | -| | max\_instances | | | | | | -+----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+----------------------------------+ - -The new list of the metadata fields for each of the node template: - -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter Name | Parameter Type | Description | -+=====================+==================+=================================================================================================================================================================================================+ -| invariantUUID | String | Constant identifier of the resource model. | -| | | | -| | | Ex.: AA97B177-9383-4934-8543-0F91A7A02836 | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| uuid | String | Versioned identifier of the resource model (this uuid is changed for every major version of the resource) | -| | | | -| | | Ex.: b8ff69ca-786d-479e-9f9c-217a90ee0ebc | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| customizationUUID | String | Identifier of the resource instance (uuid of the specific use of the resource model in this service). This identifier is regenerated whenever a user makes a change on the resource instance. | -| | | | -| | | Ex.: 38e5fb81-5e8c-479b-9140-38786db19967 | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| version | String | The resource version in ONAP Release 1 catalog. Two digit blocks separated by a dot (“.”). | -| | | | -| | | Ex. : “2.0” | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| name | String | The name of the resource. | -| | | | -| | | Ex. “vMME” | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| description | String | Description of the resource | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| type | String | The type of resource. Resource type can be either VF, VFC, VFCMT, CP or VL. | -| | | | -| | | Ex. “VF” | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| category | String | Category of the resource. | -| | | | -| | | Ex. “Application L4+” | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| subcategory | String | Sub-category of the resource. | -| | | | -| | | Ex. “Load Balancer” | -+---------------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Appendix - SDC – Data Types (information from yml) --------------------------------------------------- - -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| data\_types [] | properties | -+=========================================================================================================================+============================================================================================================================================================================================+ -| { date\_type, derived\_from, description, properties [] | {type, description, default, status, required, entry\_schema} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tosca.datatypes.\ **Root** | | -| | | -| description: The TOSCA root Data Type all other TOSCA base Data Types derive from | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **network.NetworkInfo** | network\_name{type} | -| | | -| derived\_from: tosca.datatypes.Root | network\_id{type} | -| | | -| | addresses {type, entry\_schema(type)} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **network.PortInfo** | port\_name{type} | -| | | -| derived\_from: tosca.datatypes.Root | port\_id{type} | -| | | -| | network\_id{type} | -| | | -| | mac\_address{type} | -| | | -| | addresses{type, entry\_schema(type)} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp.heat.substitution.SubstitutionFiltering** | substitute\_service\_template{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | index\_value{type, description, required, default, status, constraints (greater\_or\_equal)} | -| | | -| description: Substitution Filter | count{type, description, required, status} | -| | | -| | scaling\_enabled{type, description, required, default, status} | -| | | -| | mandatory{type, description, required, default, status} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **heat.network.neutron.Subnet** | tenant\_id{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | enable\_dhcp{type, description, required, status, constraints(valid\_values)} | -| | | -| description: A subnet represents an IP address block that can be used for assigning IP addresses to virtual instances | ipv6\_ra\_mode{type, description, required, status, constraints(valid\_values)} | -| | | -| | value\_specs{type, description, required, default, status, entry\_schema (type)} | -| | | -| | allocation\_pools{type, description, required, status, entry\_schema (type: org.openecomp.datatypes.heat.network.AllocationPool)} | -| | | -| | subnetpool{type, description, required, status} | -| | | -| | dns\_nameservers{type, description, required, default, status, entry\_schema (type)} | -| | | -| | host\_routes{type, description, required, status, entry\_schema (type: org.openecomp.datatypes.heat.network.subnet.HostRoute)} | -| | | -| | ip\_version{type, description, required, default, status, constraints(valid\_values)} | -| | | -| | name{type, description, required, status} | -| | | -| | prefixlen{type, description, required, status, constraints(greater\_or\_equal)} | -| | | -| | cidr{type, description, required, status} | -| | | -| | gateway\_ip{type, description, required, status} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp.heat.network.AllocationPool:** | start{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | end{type, description, required, status} | -| | | -| description: The start and end addresses for the allocation pool | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **heat.network.subnet.HostRoute** | destination{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | nexthop{type, description, required, status} | -| | | -| description: Host route info for the subnet | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.MacRequirements** | mac\_range\_plan{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | mac\_count{type, description, required} | -| | | -| | mac\_count\_required{description, type: org.openecomp.datatypes.AssignmentRequirements} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp.Root** | supplemental\_data{type, entry\_schema {description, type}} | -| | | -| derived\_from: tosca.datatypes.Root | | -| | | -| description: \| | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **AssignmentRequirements** | is\_required{type, description, default, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | count{type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.VlanRequirements** | vlan\_range\_plan{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | vlan\_type{type, description, required, constraints(valid\_values)} | -| | | -| | vlan\_count {type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.IpRequirements** | ip\_version {type, required, constraints(valid\_values)} | -| | | -| derived\_from: org.openecomp.datatypes.Root | ip\_count{type, description, required} | -| | | -| | floating\_ip\_count{type: org.openecomp.datatypes.AssignmentRequirements, required} | -| | | -| | subnet\_role{type, required} | -| | | -| | assingment\_method{type, required, constraints(valid\_values)} | -| | | -| | dhcp\_enabled{type, required} | -| | | -| | ip\_count\_required{type, description, required} | -| | | -| | floating\_ip\_count\_required{type, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **Naming** | ecomp\_generated\_naming{type, description, default, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | naming\_policy{type, description, required} | -| | | -| | instance\_name{type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp.EcompHoming** | ecomp\_selected\_instance\_node\_target{type, description, default, required} | -| | | -| | homing\_policy{type, description, required} | -| | | -| | instance\_node\_target{type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.NetworkAssignments** | ecomp\_generated\_network\_assignment{type, description, default, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | is\_shared\_network{type, description, required} | -| | | -| | is\_external\_network{type, description, default, required} | -| | | -| | ipv4\_subnet\_default\_assignment{type: org.openecomp.datatypes.network.IPv4SubnetAssignments, description, required} | -| | | -| | ipv6\_subnet\_default\_assignment{type: org.openecomp.datatypes.network.IPv6SubnetAssignments, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.IPv4SubnetAssignments** | use\_ipv4{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.network.SubnetAssignments | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.SubnetAssignments** | ip\_network\_address\_plan{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | dhcp\_enabled{type, description, required} | -| | | -| | ip\_version{type, description, required, constraints(valid\_values)} | -| | | -| | cidr\_mask{type, description, required} | -| | | -| | min\_subnets\_count{type, description, default, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.IPv6SubnetAssignments** | use\_ipv6{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.network.SubnetAssignments | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.ProviderNetwork** | is\_provider\_network{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | physical\_network\_name{type, description, required, constraints(valid\_values)} | -| | | -| | numa{type, description, required, constraints(valid\_values)} | -| | | -| | pnic\_instance{type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **network.NetworkFlows** | is\_network\_policy{type, description, default, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | network\_policy{type, description, required} | -| | | -| | is\_bound\_to\_vpn{type, description, default , required} | -| | | -| | vpn\_binding {type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **ImageInfo** | software\_version{type} | -| | | -| derived\_from: tosca.datatypes.Root | file\_name{type} | -| | | -| | file\_hash{type, description} | -| | | -| | file\_hash\_type{type, default, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **heat.network.AddressPair** | mac\_address{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | ip\_address{type, description, required, status} | -| | | -| description: MAC/IP address pairs | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **heat.neutron.port.FixedIps** | subnet{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | ip\_address{type, description, required, status} | -| | | -| description: subnet/ip\_address | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **heat.novaServer.network.AddressInfo** | port\_id{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.network.NetworkInfo | | -| | | -| description: Network addresses with corresponding port id | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **heat.network.neutron.SecurityRules.Rule** | remote\_group\_id{type, description, required, status} | -| | | -| derived\_from: tosca.datatypes.Root | protocol{type, description, required, status, constraints(valid\_values)} | -| | | -| description: Rules Pairs | ethertype{type, description, default, required, status, constraints(valid\_values)} | -| | | -| | port\_range\_max{type, description, required, status, constraints(in\_range)} | -| | | -| | remote\_ip\_prefix{type, description, required, status} | -| | | -| | remote\_mode{type, description, default, required, status, constraints(valid\_values)} | -| | | -| | direction{type, description, default, required, status, constraints(valid\_values)} | -| | | -| | port\_range\_min{type, description, required, status, constraints(in\_range)} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp.flavors.DeploymentFlavor** | sp\_part\_number{type} | -| | | -| derived\_from: tosca.datatypes.Root | vendor\_info{type: org.openecomp.datatypes.flavors.VendorInfo} | -| | | -| | compute\_flavor{type: org.openecomp.datatypes.flavors.ComputeFlavor} | -| | | -| | license\_flavor{type: org.openecomp.datatypes.flavors.LicenseFlavor,required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **flavors.VendorInfo** | manufacturer\_reference\_number{type} | -| | | -| derived\_from: tosca.datatypes.Root | vendor\_model{type} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **flavors.ComputeFlavor** | num\_cpus{type} | -| | | -| derived\_from: tosca.datatypes.Root | disk\_size{type} | -| | | -| | mem\_size{type} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **flavors.LicenseFlavor** | feature\_group\_uuid{type} | -| | | -| derived\_from: tosca.datatypes.Root | | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp**.\ **EcompNaming** | ecomp\_generated\_naming{type, description, default, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | naming\_policy {type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **ecomp.network.MacAssignments** | mac\_range\_plan{type, description, required} | -| | | -| derived\_from: org.openecomp.datatypes.Root | mac\_count{type, description, required} | -+-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Appendix - SDC – Capabilities (information from yml) ----------------------------------------------------- - -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| capabilities [] | properties | attributes | -+=====================================================================================================================+========================================================================+=================================================================+ -| { date\_type, derived\_from, description, properties [] | {type, description, default, status, required, entry\_schema} | {type, description, default, status, required, entry\_schema} | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Root | | | -| | | | -| description: The TOSCA root Capability Type all other TOSCA base Capability Types derive from | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Attachment | | | -| | | | -| derived\_from: tosca.capabilities.Root | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Container | num\_cpus{type, required, constraints(greater\_or\_equal)} | | -| | | | -| derived\_from: tosca.capabilities.Root | cpu\_frequency{type, required, constraints(greater\_or\_equal)} | | -| | | | -| | disk\_size{type, required, constraints(greater\_or\_equal)} | | -| | | | -| | mem\_size{type, required, constraints(greater\_or\_equal)} | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Endpoint.Admin | secure | | -| | | | -| derived\_from: tosca.capabilities.Endpoint | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Endpoint | protocol{type, default} | ip\_address{type} | -| | | | -| derived\_from: tosca.capabilities.Root | port{type, required} | | -| | | | -| | secure{type, default} | | -| | | | -| | url\_path{type, required} | | -| | | | -| | port\_name{type, required} | | -| | | | -| | network\_name{type, required, default} | | -| | | | -| | initiator{type, default, constraints(valid\_values)} | | -| | | | -| | ports{type, required, constraints(min\_values), entry\_schema(type)} | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.OperatingSystem | architecture{type, required} | | -| | | | -| derived\_from: tosca.capabilities.Root | type{type, required} | | -| | | | -| | distribution{type, required} | | -| | | | -| | version{type, required} | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Scalable | min\_instances{type, default} | | -| | | | -| derived\_from: tosca.capabilities.Root | max\_instances{type, default} | | -| | | | -| | default\_instances{type} | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.network.Bindable | | | -| | | | -| derived\_from: tosca.capabilities.Node | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Node | | | -| | | | -| derived\_from: tosca.capabilities.Root | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Endpoint.Database | | | -| | | | -| derived\_from: tosca.capabilities.Endpoint | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.Endpoint.Public | network\_name | | -| | | | -| derived\_from: tosca.capabilities.Endpoint | floating{type, description, default, status} | | -| | | | -| | dns\_name{type, description, required, status} | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.network.Linkable | | | -| | | | -| derived\_from: tosca.capabilities.Root | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| org.openecomp.capabilities.metric.Ceilometer | name{type, description, required, status} | | -| | | | -| derived\_from: org.openecomp.capabilities.Metric | | | -| | | | -| description: A node type that includes the Metric capability indicates that it can be monitored using ceilometer. | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| org.openecomp.capabilities.Metric | unit{type, description, required, status} | value{type, description, status} | -| | | | -| derived\_from: tosca.capabilities.nfv.Metric | description{type, description, required, status} | | -| | | | -| description: A node type that includes the Metric capability indicates that it can be monitored. | type{type, description, required, status} | | -| | | | -| | category{type, description, required, status} | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.capabilities.nfv.Metric | | | -| | | | -| derived\_from: tosca.capabilities.Endpoint | | | -+---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+-----------------------------------------------------------------+ - -Appendix - SDC – Groups (information from yml) ----------------------------------------------- - -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| groups [] | properties | metadta | -+====================================================================================+=================================================================+=================================================================+ -| {date\_type, derived\_from, description, properties [], interfaces[], metadata[] | {type, description, default, status, required, entry\_schema} | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| tosca.groups.Root: | | | -| | | | -| description: The TOSCA Group Type all other TOSCA Group Types derive from | | | -| | | | -| interfaces:Standard{type: tosca.interfaces.node.lifecycle.Standard} | | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| org.openecomp.groups.heat.HeatStack: | heat\_file{type, description, required} | | -| | | | -| derived\_from: tosca.groups.Root | status type, description, required} | | -| | | | -| description: Grouped all heat resources which are in the same heat stack | | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| org.openecomp.groups.VfModule: | isBase{type, description, default, status, required} | vfModuleModelName | -| | | | -| derived\_from: tosca.groups.Root | vf\_module\_label{type, description, required} | vfModuleModelInvariantUUID | -| | | | -| description: Grouped all heat resources which are in the same VF Module | vf\_module\_description{type, description, required} | vfModuleModelUUID | -| | | | -| | min\_vf\_module\_instances{type, description, required} | vfModuleModelVersion | -| | | | -| | max\_vf\_module\_instances{type, description, required} | vfModuleCustomizationUUID | -| | | | -| | initial\_count{type, description, required} | | -| | | | -| | vf\_module\_type{type, required, constraint(valid\_values)} | | -| | | | -| | volume\_group{type, description, default, required} | | -| | | | -| | availability\_zone\_count{type, description, required} | | -| | | | -| | vfc\_list{type, description, entry\_schema(description)} | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| | | {type, description, default, status, required, entry\_schema} | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| | | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| | | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ -| | | | -+------------------------------------------------------------------------------------+-----------------------------------------------------------------+-----------------------------------------------------------------+ diff --git a/docs/ONAP release 1 spec/dm/index.rst b/docs/ONAP release 1 spec/dm/index.rst deleted file mode 100644 index 7e4690c..0000000 --- a/docs/ONAP release 1 spec/dm/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP Data Model Specifications -================================ - -.. toctree:: - :titlesonly: - - dm diff --git a/docs/ONAP release 1 spec/im/index.rst b/docs/ONAP release 1 spec/im/index.rst deleted file mode 100644 index 3820ed6..0000000 --- a/docs/ONAP release 1 spec/im/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP Information Model Specifications -============================================== - -.. toctree:: - :titlesonly: - - service-im - ns-im - overlay-im diff --git a/docs/ONAP release 1 spec/im/ns-im.rst b/docs/ONAP release 1 spec/im/ns-im.rst deleted file mode 100644 index c7bb8a4..0000000 --- a/docs/ONAP release 1 spec/im/ns-im.rst +++ /dev/null @@ -1,200 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=========================================================================== -ONAP Network Service Descriptor Information Model Specification (Amsterdam) -=========================================================================== - -Scope ------ - -The scope of the present document is to describe the Network Service Descriptor (NSD) Information Model. - - -Terms, Definitions and Abbreviations ------------------------------------- - -For the purposes of the present document, the following abbreviations apply: - -+------------+--------------------------------------------+ -|Abbreviation| Definition | -+------------+--------------------------------------------+ -| CM | Conditional Mandatory | -+------------+--------------------------------------------+ -| CO | Conditional Optional | -+------------+--------------------------------------------+ -| CP | Connection Point | -+------------+--------------------------------------------+ -| CPD | Connection Point Description | -+------------+--------------------------------------------+ -| DSL | Domain Specific Language | -+------------+--------------------------------------------+ -| NCT | Network Connectivity Topology | -+------------+--------------------------------------------+ -| NF | Network Function | -+------------+--------------------------------------------+ -| NFVO | NFV Orchestrator | -+------------+--------------------------------------------+ -| NSD | Network Service Descriptor | -+------------+--------------------------------------------+ -| UML | Unified Modeling Language | -+------------+--------------------------------------------+ -| VL | Virtual Link | -+------------+--------------------------------------------+ -| VNF | Virtual Network Function | -+------------+--------------------------------------------+ - -NSD Information Model Overview ------------------------------- - -Network Service (NS) is a set of functions with unspecified connectivity between them or according to one or more forwarding graphs. - -The Network Service Descriptor (NSD) is a deployment template which consists of information used by the NFV Orchestrator (NFVO) for life cycle management of an NS. - -As illustrated in the following figure, the description of a NS used to deploy an NS instance includes or references the description of its constituent objects: - -* Zero, one or more Virtualized Network Function Nodes Descriptors; -* Zero, one or more Physical Network connect PNFs to VLs; -* Zero, one or more nested NSD; -* Zero, one or more Virtual Link Description used by the NFVO to deploy Virtual Links (VL) ; and -* Zero, one or more VNF Forwarding Graph Descriptions. - -Functional Requirements ------------------------ - -The following table specifies requirements to the templates for NSD instances in R1. - -+-----------------+-----------------------------------------------------------------+ -| Numbering | Requirement Description | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD001 | The NSD shall reference the VNF Node description of constituent | -| | VNFs. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD002 | The NSD shall include the VLDs applicable to the VLs used by the| -| | NS to interconnect its constituent NFs. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD003 | The NSD shall include a globally unique identifier for identify-| -| | ing each descriptor instance. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD004 | The NSD shall include an identifier to select the controller co-| -| | mpatible with the NSD. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD005 | The NSD shall support the capability to include or reference NS | -| | life cycle management scripts describing how to react upon spec-| -| | ific life cycle events, fault detection, performance threshold | -| | crossing detection and other events. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD006 | The NSD shall support the capability to provide monitoring para-| -| | meters to be tracked during the lifetime of a NS instance. | -+-----------------+-----------------------------------------------------------------+ - - -The following table specifies requirements to the templates for VLD instances. - -+-----------------+-----------------------------------------------------------------+ -| Numbering | Requirement Description | -+-----------------+-----------------------------------------------------------------+ -| NST_VLD001 | A VLD shall enable specifying the type of connectivity provided | -| | by the link between VNFs. | -| | In the R1, the VL should support ELAN type at least. | -+-----------------+-----------------------------------------------------------------+ - - - -NSD Information Model Definitions ---------------------------------- - -NSD -^^^ - -The NSD information element is a template whose instances are used by the VF-C for the lifecycle management of NSs. Note that NSD is actually defined as a special type of service descriptor, whose serviceType is set to "Network". In the same time, NSD can be included into an End-to-End service descriptor, as a resource or in other words, nested service. - -+---------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this NSD information element.| -| | | | | It globally uniquely identifies an instance| -| | | | | of the NSD. | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| name | M | 1 | String | The name of the NSD. | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| serviceType | M | 1 | String | Identifies the type of the SD, which is set| -| | | | | to "Network" for NSD. | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| vnfd | M | 0..N | VNF id | Consituent VNF node information of this NSD| -+---------------+-----------+-------------+----------+--------------------------------------------+ -|virtualLinkDesc| M | 0..N | VLD | Speficies the constituent VLDs. | -+---------------+-----------+-------------+----------+--------------------------------------------+ - -VL Description -^^^^^^^^^^^^^^ - -The VL information element provides general information enabling the instantiation of virtual links. - -+------------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this VirtualLinkDesc informa-| -| | | | | tion element. It globally uniquely identif-| -| | | | | ies a VL Description. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| name | M | 1 | String | Specifies the name of the VL Description. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| description | M | 0..1 | String | Specifies human-readable information on the| -| | | | | purpose of the VL (e.g. control plane traf-| -| | | | | fic). | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| isExternalNetwork| M | 1 | Boolean | Whether the VL is external network. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| shared | O | 0..1 | Boolean | Whether the VL is shared. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| network_type | O | 0..1 | String | Network type of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| segmentation_id | O | 0..1 | String | Network segmentation id of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| physical_network | O | 0..1 | String | Physical network of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| mtu | O | 0..1 | Integer | Network MTU of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| cidr | O | 0..1 | String | Subnetwork cidr of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| ip_version | O | 0..1 | String | Subnetwork IP protocol version of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| enable_dhcp | O | 0..1 | Boolean | Whether or not th subnetwork enables DHCP. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| gateway_ip | O | 0..1 | String | Subnetwork gateway IP address. | -+------------------+-----------+-------------+----------+--------------------------------------------+ - -VNF Node Description Information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this VNF Descriptjion. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| name | M | 1 | String | Specifies the name of the VNF Description. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| description | M | 0..1 | String | Specifies human-readable information on the| -| | | | | purpose of the VNF. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| vnfminfo | M | 0..1 | String | Identifies VNFM(s) compatible with the VNF | -| | | | | described in the VNF Description. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| vnfExtCpd | M | 0..N | vnfExtCpd| VNF External Connection Points. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ - - -vnfExtCpd -^^^^^^^^^ - -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| cpdid | M | 1..N |Identifier| Reference to the correspondent internal CPD| -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| vldid | M | 1..N |Identifier| Reference to the external VLD(s).(TBD) | -+-----------------+-----------+-------------+----------+--------------------------------------------+ - - diff --git a/docs/ONAP release 1 spec/im/overlay-im.rst b/docs/ONAP release 1 spec/im/overlay-im.rst deleted file mode 100644 index be7419c..0000000 --- a/docs/ONAP release 1 spec/im/overlay-im.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=========================================================================== -ONAP VoLTE Overlay Descriptor Information Model Specification (Amsterdam) -=========================================================================== - -Scope ------ - -The scope of the present document is to describe the Overlay VPN Descriptor Information Model. -For Amsterdam release, this descriptor is currently leveraged by VoLTE usecase to provision the L2/L2 VPN tunnel between the core DC and edage DC, but it is in nature a generic descriptor which could be used by other usecase for L2/L3 VPN tunnel provision as well. - - -Terms, Definitions and Abbreviations ------------------------------------- - -For the purposes of the present document, the following abbreviations apply: - -+------------+--------------------------------------------+ -|Abbreviation| Definition | -+------------+--------------------------------------------+ -| L3-DCI | Layer-3 Data Center Interconnection | -+------------+--------------------------------------------+ -| L2-DCI | Layer-2 Data Center Interconnectio | -+------------+--------------------------------------------+ - - -Overlay Descriptor Infomration Model Overview ---------------------------------------------- - -This document defines the configuration information model for overlay descriptor that enables user to input configuration -parameters required to associate local network within dataceter to a VXLAN tunnel between data centers. - -For example, VoLTE use case contains a VXLAN tunnel between edge and core datacenters. -Local network within data center is created dynamically while provisioning either vIMS or vEPC services. This model enables configuration of VXLAN gateways to forward local network traffic through inter-DC VXLAN tunnel. - -From the perspective of deployment, the overlay descriptor is actually a specific type of resource, a special type of Virtual Link (VL) in precise, as defined by Service Descriptor. - -Functional Requirements ------------------------ - -The following table specifies requirements to the templates for Overlay descriptor in R1. - -+-----------------+-----------------------------------------------------------------+ -| Numbereing | Requirement Description | -+-----------------+-----------------------------------------------------------------+ -| NST_OVED001 | The Overlay VPN Descriptor shall reference to its constituent 2 | -| | sites. | -+-----------------+-----------------------------------------------------------------+ -| NST_OVED002 | The Overlay VPN Descriptor shall enable L2/L3 VxLAN VPN options.| -+-----------------+-----------------------------------------------------------------+ - - -Overlay VPN Descriptor Information Model Definitions ----------------------------------------------------- - -The Overlay VPN Descriptor information element is a template whose instances are used by the Service Orchestrator (SO) and SDN-C (Network Controller) for the deployment and configuration of L2/L3 VxLAN -VPN for DCI connections. - -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of the Tunnel Endpoint node. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| name | O | 1 | String | Overlay tunnel name. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| version | O | 1 | String | Overlay tunnel template version. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| description | O | 1 | String | Addtional comments/information about the | -| | | | | the overlay tunnel. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| tunneltype | M | 1 | Enum | The type of overlay tunnel. | -| | | | | Valid values include 'L3-DCI' and 'L2-DCI'.| -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_id | M | 1 | String | Identifies site1. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_description | O | 1 | String | Information about overlay tunnel endpoint. | -| | | | | Identifies local domain controller. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_networkName | M | 1 | String | A comma seperated list of network names | -| | | | | associated with tunnel in site1. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_routerId | O | 1 | String | Router ID connected to L3 end point. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_importRT1 | M | 1 | String | Imported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_exportRT1 | M | 1 | String | Exported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_vni | M | 1 | Integer | Tunnel local VXLAN Identfier in site1 | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_fireWallEnable | O | 1 | Boolean | Identifies if firewall is in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_fireWallId | O | 1 | String | Firewall Id, if exists in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_localNetworkAll| O | 1 | Boolean | Identifies if all local networks associate | -| | | | | with the VXLAN tunnel. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_id | M | 1 | String | Identifies site2. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_description | O | 1 | String | Information about tunnel site2 endpoint. | -| | | | | Identifies local domain controller. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_networkName | M | 1 | String | A comma seperated list of network names | -| | | | | associated with tunnel in site2. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_routerId | O | 1 | String | Router ID connected to L3 end point. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_importRT1 | M | 1 | String | Imported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_exportRT1 | M | 1 | String | Exported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_vni | M | 1 | Integer | Tunnel local VXLAN Identfier in site2 | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_fireWallEnable | O | 1 | Boolean | Identifies if firewall is in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_fireWallId | O | 1 | String | Firewall Id, if exists in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_localNetworkAll| O | 1 | Boolean | Identifies if all local networks associate | -| | | | | with the VXLAN tunnel. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ diff --git a/docs/ONAP release 1 spec/im/service-im.rst b/docs/ONAP release 1 spec/im/service-im.rst deleted file mode 100644 index b183de4..0000000 --- a/docs/ONAP release 1 spec/im/service-im.rst +++ /dev/null @@ -1,85 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=================================================================== -ONAP Service Descriptor Information Model Specification (Amsterdam) -=================================================================== - -Scope ------ - -The scope of the present document is to describe the Service Descriptor (SD) Information Model Specification. - -Terms, Definitions and Abbreviations ------------------------------------- - -For the purposes of the present document, the following abbreviations apply: - -+-----------------+---------------------------------------------------------------------+ -| Abbreviation | Definition | -+-----------------+---------------------------------------------------------------------+ -| RD | Resource Descriptor | -+-----------------+---------------------------------------------------------------------+ -| SD | Service Descriptor | -+-----------------+---------------------------------------------------------------------+ -| SO | Service Orchestrator | -+-----------------+---------------------------------------------------------------------+ -| VF | Virtual Function | -+-----------------+---------------------------------------------------------------------+ -| VL | Virtual Link | -+-----------------+---------------------------------------------------------------------+ - -SD Information Model Overview ------------------------------ - -The Service Descriptor (SD) is a deployment template which consists of information used by the Service Orchestrator (SO) for life cycle management of a service. -A service is a composition of resources. The description of a service as used by the Service Orchestration (SO) to deploy a service instance includes or references the descriptors of its constituent objects: one or more resources; -A resource could be a VL, VF, WAN Descriptor etc. - -Functional Requirements ------------------------ - -The following table specifies requirements to the templates for SD instances. - -+------------------+-------------------------------------------------------+ -| Numbering | Requirement Description | -+------------------+-------------------------------------------------------+ -| NST_SD001 | The SD shall reference the resource applicable to its | -| | constituent services. | -+------------------+-------------------------------------------------------+ - -SD Information Model Definitions --------------------------------- -The SD information element is a template whose instances are used by the SO for the lifecycle management of Services. - -+-----------+-----------+-------------+----------+-------------------------------------------+ -|Attribute | Qualifier | Cardinality | Content | Description | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this SD information element.| -| | | | | It globally uniquely identifies an | -| | | | | instance of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| designer | M | 1 | String | Designer of this SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| name | M | 1 | String | The name of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| version | M | 1 | String | The vesion of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -|description| M | 1 | String | The description of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| vendor | M | 1 | String | The vendor of the SD. (TBD) | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| type | M | 1 | String | Value set to "Service". | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| category | M | 1 | String | Value set to either "E2E" or "NS". | -+-----------+-----------+-------------+----------+-------------------------------------------+ -|serviceType| M | 1 | String | The service type of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -|ServiceRole| M | 1 | String | The service role of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| resource | M | 1..N | RD | The consituent RDs of the SD. | -| | | | | It could be VF/WAN Descriptor etc. | -+-----------+-----------+-------------+----------+-------------------------------------------+ - - diff --git a/docs/ONAP release 1 spec/index.rst b/docs/ONAP release 1 spec/index.rst deleted file mode 100644 index decccd2..0000000 --- a/docs/ONAP release 1 spec/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP R1 Modeling Specifications -============================================== - -.. toctree:: - :titlesonly: - - csar/index - im/index - dm/index - Usecase/index diff --git a/docs/ONAP release 2 spec/dm/ArtifactTypes.rst b/docs/ONAP release 2 spec/dm/ArtifactTypes.rst deleted file mode 100644 index 36a9759..0000000 --- a/docs/ONAP release 2 spec/dm/ArtifactTypes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Artifact Types -============== - -| tosca.artifacts.nfv.SwImage: #don't need move to clean version -| derived_from: tosca.artifacts.Deployment.Image \ No newline at end of file diff --git a/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst b/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst deleted file mode 100644 index d8ed14e..0000000 --- a/docs/ONAP release 2 spec/dm/CapabilitiesTypes.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Capabilities Types -================== - -| **tosca.capabilities.nfv.VirtualBindable:** -| derived_from: tosca.capabilities.root - -| **tosca.capabilities.nfv.VirtualCompute:** -| derived_from: tosca.capabilities.Root -| properties: -| logical_node: -| type: tosca.datatypes.nfv.LogicalNodeData -| required: false -| compute_requirements: -| type: map -| required: false -| requested_additional_capabilities: -| type: map -| entry_schema: -| type: tosca.datatypes.nfv.RequestedAdditionalCapability -| required: false -| virtual_memory: -| type: tosca.datatypes.nfv.VirtualMemory -| required: true -| virtual_cpu: -| type: tosca.datatypes.nfv.VirtualCpu -| required: true - -| **tosca.capabilities.nfv.VirtualLinkable:** -| derived_from: tosca.capabilities.root - -| **tosca.capabilities.nfv.ExtVirtualLinkable:** -| derived_from: tosca.capabilities.root - -| **tosca.capabilities.nfv.VirtualStorage:** -| derived_from: tosca.capabilities.root diff --git a/docs/ONAP release 2 spec/dm/DataTypes.rst b/docs/ONAP release 2 spec/dm/DataTypes.rst deleted file mode 100644 index 3821cf5..0000000 --- a/docs/ONAP release 2 spec/dm/DataTypes.rst +++ /dev/null @@ -1,466 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Data Types -========== - -| **tosca.datatypes.nfv.L2AddressData:** -| derived_from: tosca.datatypes.Root -| properties: -| mac_address_assignment: -| type: Boolean -| required: true -| -| -| **tosca.datatypes.nfv.injectFile: #used for vCPE usecase** -| derived_from: tosca.datatypes.Root -| properties: -| source_path: -| type: string -| required: true -| dest_path: -| type:string -| required: true -| -| -| **tosca.datatypes.nfv.L3AddressData:** -| derived_from: tosca.datatypes.Root -| properties: -| ip_address_assignment: -| type: Boolean -| required: true -| floating_ip_activated: -| type: Boolean -| required: true -| ip_address_type: -| type: string -| required: false -| constraints: -| - valid_values: [ipv4, ipv6] -| number_of_ip_address: -| type: integer -| required: false -| fixed_ip_address: #used for vCPE usecase -| type:list -| entry_schema: -| type:string -| required: false -| -| -| **tosca.datatypes.nfv.AddressData:** -| derived_from: tosca.datatypes.Root -| properties: -| address_type: -| type: string -| required: true -| constraints: -| - valid_values: [mac_address, ip_address] -| l2_address_data: -| type: tosca.datatypes.nfv.L2AddressData # empty in "GS NFV IFA011 V0.7.3" -| required: false -| l3_address_data: -| type: tosca.datatypes.nfv.L3AddressData -| required: false -| -| -| **tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:** -| derived_from: tosca.datatypes.Root -| properties: -| name: -| type: string -| required: false -| description: -| type: string -| required: false -| support_mandatory: -| type: boolean -| required: true -| network_interface_requirements: -| type: Map -| required: true -| nic_io_requirements: -| type: tosca.datatypes.nfv.LogicalNodeData -| required: false -| -| -| **tosca.datatypes.nfv.ConnectivityType:** -| derived_from: tosca.datatypes.Root -| properties: -| layer_protocol: -| type: string -| required: true -| constraints: -| - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ] -| flow_pattern: -| type: string -| required: false -| constraints: # not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| - valid_values: [Line, Tree, Mesh] -| -| -| **tosca.datatypes.nfv.RequestedAdditionalCapability:** -| derived_from: tosca.datatypes.Root -| properties: -| #name: -| # key of containing map -| support_mandatory: -| type: boolean -| required: true -| min_requested_additional_capability_version: -| type: string -| required: false -| preferred_requested_additional_capability_version: -| type: string -| required: false -| requested_additional_capability_name: -| type: string -| required: true -| target_performance_parameters: -| type: map -| entry_schema: -| type: string -| required: true -| -| -| **tosca.datatypes.nfv.VirtualMemory:** -| derived_from: tosca.datatypes.Root -| properties: -| virtual_mem_size: -| type: scalar-unit.size # Number -| required: true -| virtual_mem_oversubscription_policy: -| type: string -| required: false -| vdu_memory_requirements: -| type: map -| required: false -| numa_enabled: -| type: boolean -| required: false -| -| -| **tosca.datatypes.nfv.VirtualCpu:** -| derived_from: tosca.datatypes.Root -| properties: -| cpu_architecture: -| type: string -| required: false -| num_virtual_cpu: -| type: integer -| required: true -| virtual_cpu_clock: -| type: scalar-unit.frequency -| required: false -| virtual_cpu_oversubscription_policy: -| type: string -| required: false -| vdu_cpu_requirements: -| type: map -| required: false -| virtual_cpu_pinning: -| type: tosca.datatypes.nfv.VirtualCpuPinning -| required: false -| -| -| **tosca.datatypes.nfv.VirtualCpuPinning:** -| derived_from: tosca.datatypes.Root -| properties: -| cpu_pinning_policy: -| type: string # CpuPinningPolicy -| constraints: -| - valid_values: [ static, dynamic ] -| required: false -| cpu_pinning_map: -| type: map -| entry_schema: -| type: string -| required: false -| -| -| **tosca.datatypes.nfv.VnfcConfigurableProperties:** -| derived_from: tosca.datatypes.Root -| properties: -| additional_vnfc_configurable_properties: -| type: map -| entry_schema: -| type: string -| required: false -| -| -| **tosca.datatypes.nfv.VduProfile:** -| derived_from: tosca.datatypes.Root -| properties: -| min_number_of_instances: -| type: integer -| required: true -| max_number_of_instances: -| type: integer -| required: true -| #localAffinityOrAntiAffinityRule: # not defined in SOL001 v.6.0 -| # type: tosca.datatypes.nfv.LocalAffinityOrAntiAffinityRule -| # required: true -| #affinityOrAntiAffinityGroupId: # not defined in SOL001 v.6.0 -| # type: string -| # required: true -| watchdog: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: string -| required: true -| vmBootUpTimeOut: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: integer -| required: optional -| -| -| **tosca.datatypes.nfv.VlProfile:** -| derived_from: tosca.datatypes.Root -| properties: -| max_bit_rate_requirements: -| type: tosca.datatypes.nfv.LinkBitRateRequirements -| required: true -| min_bit_rate_requirements: -| type: tosca.datatypes.nfv.LinkBitRateRequirements -| required: true -| qos: -| type: tosca.datatypes.nfv.Qos -| required: false -| initiationParameters: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: map -| entry_schema: -| type: string -| required: false -| cidr: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| networkName: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| startIp: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| endIp: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| gatewayIp: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| segmentationId: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: Integer -| required: false -| physicalNetwork: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| networkType: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: String -| required: false -| constraints: -| - valid_values: [VLAN, VXLAN] -| dhcpEnabled: # not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: Boolean -| required: false -| vlanTransparent: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0 -| type: Boolean -| required: false -| -| -| **tosca.datatypes.nfv.InstantiationLevel:** -| derived_from: tosca.datatypes.Root -| properties: -| description: -| type: string -| required: true -| vdu_levels: -| type: map # key: vduId -| required: true -| entry_schema: -| type: tosca.datatypes.nfv.VduLevel -| scale_info: -| type: map # key: aspectId -| required: false -| entry_schema: -| type: tosca.datatypes.nfv.ScaleInfo -| -| -| **tosca.datatypes.nfv.VduLevel:** -| derived_from: tosca.datatypes.Root -| properties: -| number_of_instances: -| type: integer -| required: true - -| **tosca.datatypes.nfv.VnfLcmOperationsConfiguration:** -| derived_from: tosca.datatypes.Root -| properties: -| instantiate: -| type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration -| scale: -| type: tosca.datatypes.nfv.VnfScaleOperationConfiguration -| scale_to_level: -| type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration -| heal: -| type: tosca.datatypes.nfv.VnfHealOperationConfiguratin -| terminate: -| type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration -| operate: -| type: tosca.datatypes.nfv.VnfOperateOperationConfiguration -| -| -| **tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:** -| derived_from: tosca.datatypes.Root -| properties: -| #parameters: -| #modeled as part of operation parameter list -| -| -| **tosca.datatypes.nfv.VnfScaleOperationConfiguration:** -| derived_from: tosca.datatypes.Root -| properties: -| #parameters: -| #modeled as part of the operation parameter list -| scaling_by_more_than_one_step_supported: -| type: boolean -| -| -| **tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:** -| derived_from: tosca.datatypes.Root -| properties: -| #parameters: -| #modeled as part of the operation parameter list -| arbitrary_target_levels_supported: -| type: boolean -| -| -| **tosca.datatypes.nfv.VnfHealOperationConfiguration** -| derived_from: tosca.datatypes.Root -| properties: -| #parameters: -| #modeled as part of the operation parameter list -| causes: -| type: list -| entry_schema: -| type: string -| -| -| **tosca.datatypes.nfv.VnfTerminateOperationConfiguration** -| derived_from: tosca.datatypes.Root -| properties: -| min_graceful_termination_timeout: -| type: integer -| max_recommended_graceful_termination_timeout: -| type: integer -| -| -| -| **tosca.datatypes.nfv.VnfOperateOperationConfiguration** -| derived_from: tosca.datatypes.Root -| properties: -| min_graceful_termination_timeout: -| type: integer -| max_recommended_graceful_termination_timeout: -| type: integer -| -| -| **tosca.datatypes.nfv.ScaleInfo** -| derived_from: tosca.datatypes.Root -| properties: -| scaleLevel: -| type: integer -| required: true -| -| -| **tosca.datatypes.nfv.ScaleAspect:** -| derived_from: tosca.datatypes.Root -| properties: -| name: -| type: string -| required: true -| description: -| type: string -| required: true -| associated_group: -| type: string #Identifier -| required: false -| max_scale_level: -| type: integer #PositiveInteger -| required: true -| -| -| **tosca.datatypes.nfv.LinkBitRateRequirements:** -| derived_from: tosca.datatypes.Root -| properties: -| root: -| type: integer -| required: true -| leaf: -| type: integer -| required: true -| -| -| **tosca.datatypes.nfv.Qos:** -| derived_from: tosca.datatypes.Root -| properties: -| latency: -| type: integer #Number [ms] -| required: true -| packet_delay_variation: -| type: integer #Number [ms] -| required: true -| packet_loss_ratio: -| type: Scalar #Number [0 ..1] -| required: false -| -| -| **tosca.datatypes.nfv.CpProtocolData:** -| derived_from: tosca.datatypes.Root -| properties: -| asscociated_layer_protocol: -| type: string -| constraints: -| - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] -| required: true -| address_data: -| type: tosca.datatypes.nfv.AddressData -| required: false -| -| -| **tosca.datatypes.nfv.VnfConfigurableProperties:** -| derived_from: tosca.datatypes.Root -| properties: -| is_autoscale_enabled: -| type: boolean -| required: false -| is_autoheal_enabled: -| type: boolean -| required: false -| additional_configurable_properties: -| type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties -| required: false - -| **tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:** -| derived_from: tosca.datatypes.Root -| -| -| **tosca.datatypes.nfv.VnfInfoModifiableAttributes:** -| derived_from: tosca.datatypes.Root -| properties: -| extensions: -| type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions -| required: false -| metadata: -| type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata -| required: false -| -| -| **tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:** -| derived_from: tosca.datatypes.Root -| -| -| **tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:** -| derived_from: tosca.datatypes.Root -| -| -| **tosca.datatypes.nfv.LogicalNodeData:** -| derived_from: tosca.datatypes.Root -| properties: -| logical_node_requirements: -| type: map # not defined in SOL001 v.6.0 -| required: false \ No newline at end of file diff --git a/docs/ONAP release 2 spec/dm/InterfaceTypes.rst b/docs/ONAP release 2 spec/dm/InterfaceTypes.rst deleted file mode 100644 index f4783a9..0000000 --- a/docs/ONAP release 2 spec/dm/InterfaceTypes.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Interface Types -=============== - -| **tosca.interfaces.nfv.vnf.lifecycle.Nfv** -| derived_from: tosca.interfaces.Root -| instantiate: -| description: Invoked upon receipt of an Instantiate VNF request -| instantiate_start: -| description: Invoked before instantiate -| instantiate_end: -| description: Invoked after instantiate -| terminate: -| description: Invoked upon receipt Terminate VNF request -| terminate_start: -| description: Invoked before terminate -| terminate_end: -| description: Invoked after terminate -| modify_information: -| description: Invoked upon receipt of a Modify VNF Information request -| modify_information_start: -| description: Invoked before modify_information -| modify_information_end: -| description: Invoked after modify_information -| change_flavour: -| description: Invoked upon receipt of a Change VNF Flavour request -| change_flavour_start: -| description: Invoked before change_flavour -| change_flavour_end: -| description: Invoked after change_flavour -| change_external_connectivity: -| description: Invoked upon receipt of a Change External VNF Connectivity request -| change_external_connectivity_start: -| description: Invoked before change_external_connectivity -| change_external_connectivity_end: -| description: Invoked after change_external_connectivity -| operate: -| description: Invoked upon receipt of an Operate VNF request -| operate_start: -| description: Invoked before operate -| operate_end: -| description: Invoked after operate -| heal: -| description: Invoked upon receipt of a Heal VNF request -| heal_start: -| description: Invoked before heal -| heal_end: -| description: Invoked after heal -| scale: -| description: Invoked upon receipt of a Scale VNF request -| scale_start: -| description: Invoked before scale -| scale_end: -| description: Invoked after scale -| scale_to_level: -| description: Invoked upon receipt of a Scale VNF to Level request -| scale_to_level_start: -| description: Invoked before scale_to_level -| scale_to_level_end: -| description: Invoked after scale_to_level -| # indicator_changed: -| # description: On receiving a VNF indicator value change notification \ No newline at end of file diff --git a/docs/ONAP release 2 spec/dm/NodeTypes.rst b/docs/ONAP release 2 spec/dm/NodeTypes.rst deleted file mode 100644 index bdbdce5..0000000 --- a/docs/ONAP release 2 spec/dm/NodeTypes.rst +++ /dev/null @@ -1,263 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Node Types -========== - -| **tosca.nodes.nfv.Vdu.Compute:** -| derived_from: tosca.nodes.Root -| properties: -| #id: -| # node name -| name: # align with the IM, please refer to https://wiki.onap.org/display/DW/Design+Time+Model+Clean+Version#DesignTimeModelCleanVersion-Class:VDU/VDUDesc -| type: string -| required: true -| description: -| type: string -| required: true -| boot_order: -| type: map # explicit index (boot index) not necessary, contrary to IFA011. In the IM, it shoul be a array of KeyValuePair/NameValuePair -| entry_schema: -| type: string -| required: false -| nfvi_constraints: -| type: map # Align with IM, it shoul be a array of KeyValuePair/NameValuePair -| entry_schema: -| type: string -| required: false -| configurable_properties: -| type: map #In the IM, the multipilicity of VnfcConfigurableProperties is 1, not a map. -| entry_schema: -| type: tosca.datatypes.nfv.VnfcConfigurableProperties -| required: true -| vdu_profile: -| type: tosca.datatypes.nfv.VduProfile -| required: true -| inject_files: # Used for vCPE usecase Aligned with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v0.6.0. -| type: tosca.datatypes.nfv.injectFile -| required: false #Aligned with ONAP R2 IM. it should be false. -| meta_data: #metadata attached to the VM or container -| type: map -| entry_schema: -| type: string -| required: false -| user_data: #cloudinit userdata script support -| type: string -| required: false -| #attributes: NOT DEFINED IN ONAP IM and SOL001 -| #private_address: -| # status: deprecated -| #public_address: -| # status: deprecated -| #networks: -| # status: deprecated -| #ports: -| # status: deprecated -| capabilities: -| virtual_compute: -| type: tosca.capabilities.nfv.VirtualCompute -| virtual_binding: -| type: tosca.capabilities.nfv.VirtualBindable -| occurrences: [1, UNBOUND] -| monitoring_parameter: -| type: tosca.capabilities.nfv.Metric # this is not a very clear data structure enough to be coded, suggest to be annotated. -| occurrences: [0,UNBOUND] -| requirements: -| - virtual_storage: -| capability: tosca.capabilities.nfv.VirtualStorage -| relationship: tosca.relationships.nfv.Vdu.AttachedTo -| node: tosca.nodes.nfv.VDU.VirtualStorage -| occurences: [ 0, UNBOUNDED ] -| artifacts: -| - sw_image: -| file: -| type: tosca.artifacts.nfv.SwImage -| -| -| **tosca.nodes.nfv.Vdu.VirtualStorage:** -| derived_from: tosca.nodes.Root -| properties: -| #id: -| # node name -| type_of_storage: -| type: string -| constraints: -| - valid_values: [volume, object, root, block] -| required: true -| size_of_storage: -| type: scalar-unit.size -| required: true -| vdu_storage_requirements: -| type: map -| required: false -| rdma_enabled: -| type: boolean -| required: false -| capabilities: -| virtual_storage: -| type: tosca.capabilities.nfv.VirtualStorage -| artifacts: -| - sw_image: -| file: -| type: tosca.artifacts.Deployment.Image -| #interfaces: # not needed for virtualstroage. it doesn't support cloudinit. -| # cloudinit: -| # type:tosca.interfaces.nfv.vdu.cloudinit -| -| -| **tosca.nodes.nfv.Cp:** -| derived_from: tosca.nodes.Root -| properties: -| layer_protocol: -| type:list -| entry_schema: -| constraints: -| - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ] -| required:true -| role: #Name in ETSI NFV IFA011 v0.7.3 cpRole -| type:string -| constraints: -| - valid_values: [ root, leaf ] -| required:false -| description: -| type: string -| required: false -| protocol_data: -| type: list -| entry_schema: -| type: tosca.datatypes.nfv.CpProtocolData -| required:true -| trunk_mode: -| type: boolean -| required: true -| allowed_address_data: # Aligned with ONAP R2 Im.not defined in IFA011 v2.4.1 and SOL001 v0.6.0. -| type: tosca.datatypes.nfv.AddressData # In the IM, it is a array, but here it is not a array. TBD. -| required: false -| -| -| **tosca.nodes.nfv.VduCp:** -| derived_from: tosca.nodes.nfv.Cp -| properties: -| bitrate_requirement: -| type: integer -| required:false -| vnic_name: # Aligned with ONAP R2 Im.not defined in IFA011 v2.4.1 and SOL001 v0.6.0. -| type: string -| required:false -| vnic_order: # Aligned with ONAP R2 Im. not defined in IFA011 v2.4.1 and SOL001 v0.6.0. -| type: integer -| required:false -| vnic_type: # Aligned with ONAP R2 Im. not defined in IFA011 v2.4.1 and SOL001 v0.6.0 -| type: string -| constraints: -| - valid_values: [normal, macvtap, direct, baremetal, direct-physical, virtio-forwarder] -| required:false -| virtual_network_interface_requirements: -| type: list -| entry_schema: -| type: VirtualNetworkInterfaceRequirements -| required:false -| # order: #there is no this attribute in IM. -| # type: integer -| # required: false -| # constraints: -| # - greater_or_equal: 0 -| requirements: -| - virtual_link: -| capability: tosca.capabilities.nfv.VirtualLinkable -| relationship: tosca.relationships.nfv.VirtualLinksTo -| node: tosca.nodes.nfv.VnfVirtualLink -| - virtual_binding: -| capability: tosca.capabilities.nfv.VirtualBindable -| relationship: tosca.relationships.nfv.VirtualBindsTo -| node: tosca.nodes.nfv.Vdu.Compute -| -| -| **tosca.nodes.nfv.VnfVirtualLink:** -| derived_from: tosca.nodes.Root -| properties: -| connectivity_type: -| type: tosca.datatypes.nfv.ConnectivityType -| required: true -| description: -| type: string -| required: false -| test_access: -| type: list -| entry_schema: -| type: string -| required: false -| vl_profile: -| type: tosca.datatypes.nfv.VlProfile -| required: true -| capabilities: -| monitoring_parameter: # this is not a very clear data structure enough to be coded, suggest to be annotated. -| type: tosca.capabilities.nfv.Metric -| occurrences: [0,UNBOUND] -| virtual_linkable: -| type: tosca.capabilities.nfv.VirtualLinkable -| -| -| **tosca.nodes.nfv.VNF:** -| derived_from: tosca.nodes.Root -| properties: -| descriptor_id: # instead of vnfd_id -| type: string # GUID -| required: true -| descriptor_version: # instead of vnfd_version -| type: string -| required: true -| provider: # instead of vnf_provider -| type: string -| required: true -| product_name: # instead of vnf_product_name -| type: string -| required: true -| software_version: # instead of vnf_software_version -| type: string -| required: true -| product_info_name: # instead of vnf_product_info_name -| type: string -| required: false -| product_info_description: # instead of vnf_product_info_description -| type: string -| required: false -| vnfm_info: -| type: list -| entry_schema: -| type: string -| required: true -| localization_languages: -| type: list -| entry_schema: -| type: string -| required: false -| default_localization_language: -| type: string -| required: false -| configurable_properties: -| type: tosca.datatypes.nfv.VnfConfigurableProperties -| required: false -| modifiable_attributes: -| type: tosca.datatypes.nfv.VnfInfoModifiableAttributes -| required: false # true in IFA011, but all of members are false. Align with the IM, it is false -| flavour_id: -| type: string -| required: true -| flavour_description: -| type: string -| required: true -| capabilities: -| # monitoring_parameter: -| # modelled as ad hoc capabilities in the VNF node template -| requirements: -| - virtual_link: -| capability: tosca.capabilities.nfv.VirtualLinkable -| relationship: tosca.relationships.nfv.VirtualLinksTo -| node: tosca.nodes.nfv.VnfVirtualLink -| occurrences: [ 0, UNBOUNDED ] -| interfaces: -| Nfv: -| type: tosca.interfaces.nfv.vnf.lifecycle.Nfv -| \ No newline at end of file diff --git a/docs/ONAP release 2 spec/dm/RelationshipTypes.rst b/docs/ONAP release 2 spec/dm/RelationshipTypes.rst deleted file mode 100644 index 1c9965b..0000000 --- a/docs/ONAP release 2 spec/dm/RelationshipTypes.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Relationships Types -=================== - -| **tosca.relationships.nfv.VirtualBindsTo:** -| derived_from: tosca.relationships.DependsOn -| valid_target_types: [ tosca.capabilities.nfv.VirtualBindable] -| -| -| **tosca.relationships.nfv.VirtualLinksTo:** -| derived_from: tosca.relationships.DependsOn -| valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable] diff --git a/docs/ONAP release 2 spec/dm/index.rst b/docs/ONAP release 2 spec/dm/index.rst deleted file mode 100644 index bc44519..0000000 --- a/docs/ONAP release 2 spec/dm/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP Data Model Specifications -============================== - -.. toctree:: - :titlesonly: - - ArtifactTypes - CapabilitiesTypes - DataTypes - InterfaceTypes - NodeTypes - RelationshipTypes diff --git a/docs/ONAP release 2 spec/im/AddressData.rst b/docs/ONAP release 2 spec/im/AddressData.rst deleted file mode 100644 index a3e703d..0000000 --- a/docs/ONAP release 2 spec/im/AddressData.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: AddressData -================== - -+---------------+---------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===============+===============+==================+=================+===============+ -| addressType | Identifier | 1 | Describes | support: | -| | | | the type of | MANDATORY | -| | | | the address to | | -| | | | be assigned to | | -| | | | the CP | | -| | | | instantiated | | -| | | | from the | | -| | | | parent CPD. | | -| | | | The content | | -| | | | type shall | | -| | | | be aligned | | -| | | | with the | | -| | | | address type | | -| | | | supported | | -| | | | by the | | -| | | | layerProtocol | | -| | | | attribute | | -| | | | of the | | -| | | | parent CPD. | | -+---------------+---------------+------------------+-----------------+---------------+ -| l2AddressData | L2AddressData | 0..1 | Provides the | support: | -| | | | information on | MANDATORY | -| | | | the MAC | | -| | | | addresses to be | | -| | | | assigned to | | -| | | | the CP(s) | | -| | | | instantiated | | -| | | | from the | | -| | | | parent CPD. | | -| | | | | | -| | | | Shall be present| | -| | | | when the | | -| | | | addressType is | | -| | | | MAC address. | | -+---------------+---------------+------------------+-----------------+---------------+ -| l3AddressData | L3AddressData | 0..1 | Provides the | support: | -| | | | information on | MANDATORY | -| | | | the IP addresses| | -| | | | to be assigned | | -| | | | to the CP | | -| | | | instantiated | | -| | | | from the | | -| | | | parent CPD. | | -| | | | | | -| | | | Shall be | | -| | | | present when | | -| | | | the addressType | | -| | | | is IP address. | | -+---------------+---------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst b/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst deleted file mode 100644 index a2c8d72..0000000 --- a/docs/ONAP release 2 spec/im/AffinityOrAntiAffinityGroup.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: AffinityOrAntiAffinityGroup -================================== - -+-------------+-------------+------------------+-----------------+-----------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=============+=============+==================+=================+=================+ -| groupId | Identifier | 1 | Identifies | support: | -| | | | an affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | group to which | | -| | | | the affinity or | | -| | | | anti-affinity | | -| | | | rule applies. | | -+-------------+-------------+------------------+-----------------+-----------------+ -| type | Enum | 1 | Specifies | support: | -| | | | whether the rule| MANDATORY | -| | | | is an affinity | | -| | | | rule or an | valueRange: | -| | | | anti-affinity | "Affinity", | -| | | | rule. | "Anti-Affinity" | -+-------------+-------------+------------------+-----------------+-----------------+ -| scope | Enum | 1 | Specifies | support: | -| | | | the scope | MANDATORY | -| | | | of the rule. | | -| | | | | valueRange: | -| | | | | "NFVI-PoP", | -| | | | | "Zone", | -| | | | | "ZoneGroup", | -| | | | | "NFVI-node" | -+-------------+-------------+------------------+-----------------+-----------------+ diff --git a/docs/ONAP release 2 spec/im/BaseConfigGroup.rst b/docs/ONAP release 2 spec/im/BaseConfigGroup.rst deleted file mode 100644 index 2397c0e..0000000 --- a/docs/ONAP release 2 spec/im/BaseConfigGroup.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: BaseConfigGroup (Experimental) -===================================== diff --git a/docs/ONAP release 2 spec/im/ConnectivityType.rst b/docs/ONAP release 2 spec/im/ConnectivityType.rst deleted file mode 100644 index d47a1be..0000000 --- a/docs/ONAP release 2 spec/im/ConnectivityType.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: ConnectivityType -======================= - -+---------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===============+=============+==================+=================+===============+ -| layerProtocol | Enum | 1 | Identifies | support: | -| | | | the protocol | MANDATORY | -| | | | this VL gives | | -| | | | access to | | -| | | | (Ethernet, | | -| | | | MPLS, ODU2, | | -| | | | IPV4, IPV6, | | -| | | | Pseudo-Wire). | | -+---------------+-------------+------------------+-----------------+---------------+ -| flowPattern | String | 0..1 | Identifies | support: | -| | | | the flow | MANDATORY | -| | | | pattern of the | | -| | | | the connectivity| | -| | | | (Line, Tree, | | -| | | | Mesh). | | -+---------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/CpProtocolData.rst b/docs/ONAP release 2 spec/im/CpProtocolData.rst deleted file mode 100644 index c9cf840..0000000 --- a/docs/ONAP release 2 spec/im/CpProtocolData.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: CpProtocolData -===================== - -+-------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+=========================+=============+==================+=================+===============+ -| associatedLayerProtocol | Enum | 1 | One of the | support: | -| | | | values of the | MANDATORY | -| | | | attribute | | -| | | | layerProtocol | | -| | | | of the Cpd IE. | | -+-------------------------+-------------+------------------+-----------------+---------------+ -| addressData | AddressData | 0..N | Provides | support: | -| | | | information | MANDATORY | -| | | | on the addresses| | -| | | | to be | | -| | | | assigned to | | -| | | | the CP(s) | | -| | | | instantiated | | -| | | | from the CPD. | | -+-------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/DeploymentGroup.rst b/docs/ONAP release 2 spec/im/DeploymentGroup.rst deleted file mode 100644 index 4dd8b1e..0000000 --- a/docs/ONAP release 2 spec/im/DeploymentGroup.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: DeploymentGroup (Experimental) -===================================== - -This class is experimental and the detailed definition is for further discussion. diff --git a/docs/ONAP release 2 spec/im/L2AddressData.rst b/docs/ONAP release 2 spec/im/L2AddressData.rst deleted file mode 100644 index d4620df..0000000 --- a/docs/ONAP release 2 spec/im/L2AddressData.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: L2AddressData -==================== - -+----------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+======================+=============+==================+=================+===============+ -| macAddressAssignment | Boolean | 1 | Specify if | support: | -| | | | the MAC address | MANDATORY | -| | | | assignment | | -| | | | is the | | -| | | | responsibility | | -| | | | of management | | -| | | | and | | -| | | | orchestration | | -| | | | function or not.| | -| | | | | | -| | | | If it is set to | | -| | | | True, it is the | | -| | | | management and | | -| | | | orchestration | | -| | | | function | | -| | | | responsibility. | | -| | | | | | -| | | | If it is set to | | -| | | | False, it will | | -| | | | be provided by | | -| | | | an external | | -| | | | entity, e.g. | | -| | | | OSS/BSS.  | | -+----------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/L3AddressData.rst b/docs/ONAP release 2 spec/im/L3AddressData.rst deleted file mode 100644 index ccb651f..0000000 --- a/docs/ONAP release 2 spec/im/L3AddressData.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: L3AddressData -==================== - -+---------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=====================+=============+==================+=================+===============+ -| iPAddressAssignment | Boolean | 1 | Specify if | support: | -| | | | the address | MANDATORY | -| | | | assignment | | -| | | | is the | | -| | | | responsibility | | -| | | | of management | | -| | | | and | | -| | | | orchestration | | -| | | | function or not.| | -| | | | | | -| | | | If it is set to | | -| | | | True, it is the | | -| | | | management and | | -| | | | orchestration | | -| | | | function | | -| | | | responsibility. | | -+---------------------+-------------+------------------+-----------------+---------------+ -| floatingIpActivated | Boolean | 1 | Specify if the | support: | -| | | | floating IP | MANDATORY | -| | | | scheme is | | -| | | | activated on | | -| | | | the CP or not. | | -+---------------------+-------------+------------------+-----------------+---------------+ -| iPAddressType | Enum | 0..1 | Define address | support: | -| | | | type. | MANDATORY | -| | | | | | -| | | | NOTE: The | valueRange: | -| | | | address type | "IPv4", | -| | | | should be | "IPv6" | -| | | | aligned with | | -| | | | the address type| | -| | | | supported by the| | -| | | | layerProtocol | | -| | | | attribute of | | -| | | | the parent Cpd. | | -+---------------------+-------------+------------------+-----------------+---------------+ -| numberOfIpAddress | Integer | 0..1 | Minimum | support: | -| | | | number of IP | MANDATORY | -| | | | addresses to be | | -| | | | assigned based | | -| | | | on this | | -| | | | L3AddressData | | -| | | | information | | -| | | | element. | | -+---------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst b/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst deleted file mode 100644 index b7ce432..0000000 --- a/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst +++ /dev/null @@ -1,165 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: LifecycleManagementScript -================================ - -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+===================+=====================================+ -| event | Enum | 0..N | Describes | support: | -| | | | VNF | MANDATORY | -| | | | lifecycle | | -| | | | event(s) or | valueRange: | -| | | | an external | for | -| | | | stimulus | lifecycle | -| | | | detected on | events, | -| | | | a VNFM | include: | -| | | | reference | "EVENT_START_INSTANTIATION", | -| | | | point. | "EVENT_END_INSTANTIATION", | -| | | | | "EVENT_START_SCALING", | -| | | | NOTE: At | "EVENT_END_SCALING", | -| | | | least one | "EVENT_START_SCALING_TO_LEVEL", | -| | | | of these | "EVENT_END_SCALING_TO_LEVEL", | -| | | | two | "EVENT_START_HEALING", | -| | | | attributes | "EVENT_END_HEALING", | -| | | | shall be | "EVENT_START_TERMINATION", | -| | | | included. | "EVENT_END_TERMINATION", | -| | | | | "EVENT_START_VNF_FLAVOR_CHANGE", | -| | | | | "EVENT_END_VNF_FLAVOR_CHANGE", | -| | | | | "EVENT_START_VNF_OPERATION_CHANGE", | -| | | | | "EVENT_END_VNF_OPERATION_CHANGE", | -| | | | | "EVENT_START_VNF_EXT_CONN_CHANGE", | -| | | | | "EVENT_END_VNF_EXT_CONN_CHANGE", | -| | | | | "EVENT_START_VNFINFO_MODIFICATION", | -| | | | | "EVENT_END_VNFINFO_MODIFICATION"; | -| | | | | for | -| | | | | external | -| | | | | stimulus, | -| | | | | include: | -| | | | | receipt of | -| | | | | request | -| | | | | message of | -| | | | | instantiation, | -| | | | | scaling, | -| | | | | healing, | -| | | | | termination, | -| | | | | change of | -| | | | | VNF | -| | | | | flavour, | -| | | | | change of | -| | | | | the | -| | | | | operation | -| | | | | state of | -| | | | | the VNF, | -| | | | | change of | -| | | | | external | -| | | | | VNF | -| | | | | connectivity, | -| | | | | modification | -| | | | | of VNF | -| | | | | information | -| | | | | or the | -| | | | | receipt of | -| | | | | a | -| | | | | notification | -| | | | | regarding | -| | | | | the change | -| | | | | of a VNF | -| | | | | indicator | -| | | | | value. | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| lcmTransitionEvent | String | 0..N | Describes | support: | -| | | | the | MANDATORY | -| | | | transition | | -| | | | VNF | | -| | | | lifecycle | | -| | | | event(s) | | -| | | | that cannot | | -| | | | be mapped | | -| | | | to any of | | -| | | | the | | -| | | | enumerated | | -| | | | values | | -| | | | defined for | | -| | | | the event | | -| | | | attribute. | | -| | | | | | -| | | | NOTE: At | | -| | | | least one | | -| | | | of these | | -| | | | two | | -| | | | attributes | | -| | | | shall be | | -| | | | included. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| script | String | 1 | Information | support: | -| | | | to locate a | MANDATORY | -| | | | VNF LCM | | -| | | | script | | -| | | | (e.g. | | -| | | | written in | | -| | | | a DSL as | | -| | | | specified | | -| | | | in | | -| | | | requirement | | -| | | | VNF_PACK.LCM.001) | | -| | | | triggered | | -| | | | to react to | | -| | | | one of the | | -| | | | events | | -| | | | listed in | | -| | | | the event | | -| | | | attribute. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| scriptDsl | String | 1 | Defines the | support: | -| | | | domain | MANDATORY | -| | | | specific | | -| | | | language | | -| | | | (i.e. the | | -| | | | type) of | | -| | | | script that | | -| | | | is | | -| | | | provided. | | -| | | | Types of | | -| | | | scripts | | -| | | | could | | -| | | | include | | -| | | | bash, | | -| | | | python, | | -| | | | etc. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ -| scriptInput | KeyValuePair| 0..N | Array of | support: | -| | | | KVP | MANDATORY | -| | | | requirements | | -| | | | with the | | -| | | | key as the | | -| | | | parameter | | -| | | | name and | | -| | | | the value | | -| | | | as the | | -| | | | parameter | | -| | | | that need | | -| | | | to be | | -| | | | passed as | | -| | | | an input to | | -| | | | the script. | | -| | | | | | -| | | | NOTE: The | | -| | | | scriptInput | | -| | | | values are | | -| | | | passed to | | -| | | | the scripts | | -| | | | in addition | | -| | | | to the | | -| | | | parameters | | -| | | | received in | | -| | | | the | | -| | | | operation | | -| | | | invocation | | -| | | | request or | | -| | | | indicator | | -| | | | value | | -| | | | change. | | -+--------------------+-------------+------------------+-------------------+-------------------------------------+ diff --git a/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst b/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst deleted file mode 100644 index 57d1f63..0000000 --- a/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: LocalAffinityOrAntiAffinityRule -====================================== - -+-------------+-------------+------------------+-----------------+----------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=============+=============+==================+=================+================+ -| type | Enum | 1 | Specifies | support: | -| | | | whether the rule| MANDATORY | -| | | | is an affinity | | -| | | | rule or an | valueRange: | -| | | | anti-affinity | "Affinity", | -| | | | rule. | "Anti-Affinity"| -+-------------+-------------+------------------+-----------------+----------------+ -| scope | Enum | 1 | Specifies the | support: | -| | | | scope of the | MANDATORY | -| | | | rule. | | -| | | | | valueRange: | -| | | | | "NFVI-PoP", | -| | | | | "Zone", | -| | | | | "ZoneGroup", | -| | | | | "NFVI-node" | -+-------------+-------------+------------------+-----------------+----------------+ diff --git a/docs/ONAP release 2 spec/im/MonitoringParameter.rst b/docs/ONAP release 2 spec/im/MonitoringParameter.rst deleted file mode 100644 index 9dfc5b9..0000000 --- a/docs/ONAP release 2 spec/im/MonitoringParameter.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: MonitoringParameter -========================== - -+-------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===================+=============+==================+=================+===============+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of the | | -| | | | monitoring | | -| | | | parameter. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| name | String | 0..1 | Human | support: | -| | | | readable | MANDATORY | -| | | | name of the | | -| | | | monitoring | | -| | | | parameter. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| performanceMetric | String | 1 | Identifies | support: | -| | | | the | MANDATORY | -| | | | virtualised | | -| | | | resource | | -| | | | performance | | -| | | | metric. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| collectionPeriod | Not | 0..1 | An | support: | -| | specified | | attribute | MANDATORY | -| | | | that | | -| | Editor's | | describes | | -| | note: need | | the | | -| | to be | | recommended | | -| | specified | | periodicity | | -| | | | at which to | | -| | | | collect the | | -| | | | performance | | -| | | | information. | | -| | | | | | -| | | | VNFM | | -| | | | determines | | -| | | | if this | | -| | | | parameter | | -| | | | is | | -| | | | considered. | | -| | | | | | -| | | | The vendor | | -| | | | may provide | | -| | | | this | | -| | | | information | | -| | | | as a | | -| | | | guidance | | -| | | | for | | -| | | | creating | | -| | | | PmJobs if | | -| | | | needed. | | -| | | | | | -| | | | NOTE: The | | -| | | | MANO or | | -| | | | NFVI may | | -| | | | not support | | -| | | | the | | -| | | | recommended | | -| | | | collectionPeriod| | -| | | | based on | | -| | | | their | | -| | | | functionalities,| | -| | | | and can | | -| | | | reject the | | -| | | | requests | | -| | | | based on | | -| | | | the | | -| | | | recommended | | -| | | | collectionPeriod| | -| | | | in this | | -| | | | case. | | -+-------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/PlacementGroup.rst b/docs/ONAP release 2 spec/im/PlacementGroup.rst deleted file mode 100644 index db8008b..0000000 --- a/docs/ONAP release 2 spec/im/PlacementGroup.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: PlacementGroup (Experimental) -==================================== - -+-------------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+===================+=============+==================+=================+===============+ -| elementGroupId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | group in | | -| | | | the VNFD. | | -+-------------------+-------------+------------------+-----------------+---------------+ -| placementStrategy | Enum | 1 | Determine | support: | -| | | | where | MANDATORY | -| | | | VNFC's | | -| | | | (VDU's) are | valueRange: | -| | | | placed with | "co-location",| -| | | | respect to | "isolation", | -| | | | the VNF. | "exclusively" | -| | | | | | -| | | | | NOTE: | -| | | | | | -| | | | | - Co-location| -| | | | | - | -| | | | | members | -| | | | | of the | -| | | | | group | -| | | | | share | -| | | | | the same | -| | | | | physical | -| | | | | host or | -| | | | | rack. | -| | | | | | -| | | | | - isolation | -| | | | | - | -| | | | | members | -| | | | | of the | -| | | | | group do | -| | | | | not | -| | | | | share | -| | | | | the same | -| | | | | physical | -| | | | | host or | -| | | | | rack. | -| | | | | | -| | | | | - Exclusively| -| | | | | - | -| | | | | members | -| | | | | have | -| | | | | sole use | -| | | | | of a | -| | | | | given | -| | | | | physical | -| | | | | host or | -| | | | | rack | -| | | | | (not | -| | | | | shared | -| | | | | with any | -| | | | | vnfcs | -| | | | | outside | -| | | | | the | -| | | | | group). | -+-------------------+-------------+------------------+-----------------+---------------+ -| vnfcMembers | Not | 0..N | References | support: | -| | specified | | to Vdus | MANDATORY | -| | | | that are | | -| | | | part of | | -| | | | this group. | | -| | | | | | -| | | | | | -| | | | | | -+-------------------+-------------+------------------+-----------------+---------------+ -| strategyScope | Enum | 1 | indicate if | support: | -| | | | the | MANDATORY | -| | | | strategy is | | -| | | | applied at | valueRange: | -| | | | the host or | "host", | -| | | | rack level | "rack" | -+-------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/QoS.rst b/docs/ONAP release 2 spec/im/QoS.rst deleted file mode 100644 index 8f64127..0000000 --- a/docs/ONAP release 2 spec/im/QoS.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: QoS -========== - -+--------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+====================+=============+==================+=================+===============+ -|latency | Number | 1 | Maximum | support: | -| | | | latency in ms. | MANDATORY | -+--------------------+-------------+------------------+-----------------+---------------+ -|packetDelayVariation| Number | 1 | Maximum | support: | -| | | | jitter in ms. | MANDATORY | -+--------------------+-------------+------------------+-----------------+---------------+ -|packetLossRatio | Number | 0..1 | Maximum | support: | -| | | | packet loss | MANDATORY | -| | | | ratio. | | -| | | | Cardinality | | -| | | | is 0 if no | | -| | | | packetLossRatio | | -| | | | requirement | | -| | | | exists. | | -+--------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst b/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst deleted file mode 100644 index ce9ab2f..0000000 --- a/docs/ONAP release 2 spec/im/RequestedAdditionalCapabilityData.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: RequestedAdditionalCapabilityData -======================================== - -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+===============================================+=============+==================+=================+===============+ -| requestedAdditionalCapabilityName | String | 1 | Identifies | support: | -| | | | a requested | MANDATORY | -| | | | additional | | -| | | | capability | valueRange: | -| | | | for the | For | -| | | | VDU. | acceleration | -| | | | | capabilities, | -| | | | | reference | -| | | | | to ETSI GS | -| | | | | NFV-IFA | -| | | | | 002. | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| supportMandatory | Boolean | 1 | Indicates | support: | -| | | | whether the | MANDATORY | -| | | | requested | | -| | | | additional | | -| | | | capability | | -| | | | is | | -| | | | mandatory | | -| | | | for | | -| | | | successful | | -| | | | operation. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| minRequestedAdditionalCapabilityVersion | String | 0..1 | Identifies | support: | -| | | | the minimum | MANDATORY | -| | | | version of | | -| | | | the | | -| | | | requested | | -| | | | additional | | -| | | | capability. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| preferredRequestedAdditionalCapabilityVersion | String | 0..1 | Identifies | support: | -| | | | the | MANDATORY | -| | | | preferred | | -| | | | version of | | -| | | | the | | -| | | | requested | | -| | | | additional | | -| | | | capability. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ -| targetPerformanceParameters | KeyValuePair| 1..N | Identifies | support: | -| | | | specific | MANDATORY | -| | | | attributes, | | -| | | | dependent | | -| | | | on the | | -| | | | requested | | -| | | | additional | | -| | | | capability | | -| | | | type. | | -+-----------------------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/ScaleInfo.rst b/docs/ONAP release 2 spec/im/ScaleInfo.rst deleted file mode 100644 index 14f74cf..0000000 --- a/docs/ONAP release 2 spec/im/ScaleInfo.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: ScaleInfo -================ - -+--------------------+----------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+================+==================+=================+==========================+ -| aspectId | Identifier | 1 | Reference | support: | -| | (Reference | | to the | MANDATORY | -| | to | | scaling | | -| | ScalingAspect) | | aspect. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| scaleLevel | Integer | 1 | The scale | support: | -| | | | level, | MANDATORY | -| | | | greater | | -| | | | than or | | -| | | | equal to 0. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/SwImageDesc.rst b/docs/ONAP release 2 spec/im/SwImageDesc.rst deleted file mode 100644 index 2add32f..0000000 --- a/docs/ONAP release 2 spec/im/SwImageDesc.rst +++ /dev/null @@ -1,144 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: SwImageDesc -================== - -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================================+===================+==================+===================+==========================+ -| id | Identifier | 1 | The | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| name | String | 1 | The name of | support: | -| | | | this | MANDATORY | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| version | String | 1 | The version | support: | -| | | | of this | MANDATORY | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| checksum | String | 1 | The | support: | -| | | | checksum of | MANDATORY | -| | | | the | | -| | | | software | | -| | | | image file. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| containerFormat | String | 1 | The | support: | -| | | | container | MANDATORY | -| | | | format | | -| | | | describes | | -| | | | the | | -| | | | container | | -| | | | file format | | -| | | | in which | | -| | | | software | | -| | | | image is | | -| | | | provided. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| diskFormat | String | 1 | The disk | support: | -| | | | format of a | MANDATORY | -| | | | software | | -| | | | image is | | -| | | | the format | | -| | | | of the | | -| | | | underlying | | -| | | | disk image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| minDisk | Number | 1 | The minimal | support: | -| | (recommended | | disk size | MANDATORY | -| | DM type: | | requirement | | -| | Scalar-Unit-Size) | | for this | | -| | | | software | | -| | | | image. The | | -| | | | value of | | -| | | | the "size | | -| | | | of storage" | | -| | | | attribute | | -| | | | of the | | -| | | | VirtualStorageDesc| | -| | | | referencing | | -| | | | this | | -| | | | SwImageDesc | | -| | | | shall not | | -| | | | be smaller | | -| | | | than the | | -| | | | value of | | -| | | | minDisk. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| minRam | Number | 0..1 | The minimal | support: | -| | (recommended | | RAM | MANDATORY | -| | DM type: | | requirement | | -| | Scalar-Unit-Size) | | for this | | -| | | | software | | -| | | | image. The | | -| | | | value of | | -| | | | the "size" | | -| | | | attribute | | -| | | | of | | -| | | | VirtualMemoryData | | -| | | | of the Vdu | | -| | | | referencing | | -| | | | this | | -| | | | SwImageDesc | | -| | | | shall not | | -| | | | be smaller | | -| | | | than the | | -| | | | value of | | -| | | | minRam. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| size | Number | 1 | The size of | support: | -| | (recommended | | this | MANDATORY | -| | DM type: | | software | | -| | Scalar-Unit-Size) | | image. | | -| | | | | | -| | | | | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| swImage | Identifier | 1 | This is a | support: | -| | (Reference | | reference | MANDATORY | -| | to a | | to the | | -| | SwImage) | | actual | | -| | | | software | | -| | | | image. The | | -| | | | reference | | -| | | | can be | | -| | | | relative to | | -| | | | the root of | | -| | | | the VNF | | -| | | | Package or | | -| | | | can be a | | -| | | | URL. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| operatingSystem | String | 0..1 | Identifies | support: | -| | | | the | MANDATORY | -| | | | operating | | -| | | | system used | | -| | | | in the | | -| | | | software | | -| | | | image. This | | -| | | | attribute | | -| | | | may also | | -| | | | identify if | | -| | | | a 32 bit or | | -| | | | 64 bit | | -| | | | software | | -| | | | image is | | -| | | | used. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ -| supportedVirtualisationEnvironment| String | 0..N | Identifies | support: | -| | | | the | MANDATORY | -| | | | virtualisation | | -| | | | environments | | -| | | | (e.g. | | -| | | | hypervisor) | | -| | | | compatible | | -| | | | with this | | -| | | | software | | -| | | | image. | | -+-----------------------------------+-------------------+------------------+-------------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/VduLevel.rst b/docs/ONAP release 2 spec/im/VduLevel.rst deleted file mode 100644 index 8d86ba4..0000000 --- a/docs/ONAP release 2 spec/im/VduLevel.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VduLevel -=============== - -+-----------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=================+=============+==================+=================+===============+ -| vduId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to Vdu) | | a VDU. | | -+-----------------+-------------+------------------+-----------------+---------------+ -|numberOfInstances| Integer | 1 | Number of | support: | -| | | | instances | MANDATORY | -| | | | of VNFC based on| | -| | | | this VDU to | | -| | | | deploy for an | | -| | | | instantiation | | -| | | | level or for a | | -| | | | scaling delta. | | -+-----------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst b/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst deleted file mode 100644 index d1876bc..0000000 --- a/docs/ONAP release 2 spec/im/VirtualCpuPinningData.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualCpuPinningData -============================ - -+-------------------------+-------------+------------------+-------------------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+=========================+=============+==================+=========================+===============+ -| virtualCpuPinningPolicy | Enum | 0..1 | The policy | support: | -| | | | can take | MANDATORY | -| | | | values of | | -| | | | "static" or | valueRange: | -| | | | "dynamic". | "static", | -| | | | In case of | "dynamic" | -| | | | "static" the virtual | | -| | | | CPU cores are | | -| | | | requested to be | | -| | | | allocated to logical | | -| | | | CPU cores according | | -| | | | to the rules defined in | | -| | | | virtualCpuPinningRules. | | -| | | | In case of "dynamic" | | -| | | | the allocation | | -| | | | of virtual CPU cores | | -| | | | to logical CPU cores | | -| | | | is decided by the VIM. | | -| | | | (e.g.: SMT | | -| | | | (Simultaneous | | -| | | | Multi-Threading) | | -| | | | requirements). | | -+-------------------------+-------------+------------------+-------------------------+---------------+ -| virtualCpuPinningRule | Not | 0..1 | A list of | support: | -| | specified | | rules that | MANDATORY | -| | | | should be | | -| | Editor's | | considered | | -| | note: need | | during the | | -| | to be | | allocation | | -| | specified | | of the | | -| | | | virtual CPUs to | | -| | | | logical CPUs in case of | | -| | | | "static" | | -| | | | virtualCpuPinningPolicy.| | -+-------------------------+-------------+------------------+-------------------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst b/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst deleted file mode 100644 index 3dd6c92..0000000 --- a/docs/ONAP release 2 spec/im/VnfConfigurableProperties.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfConfigurableProperties -================================ - -+--------------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+================================+=============+==================+=================+===============+ -| isAutoscaleEnabled | Boolean | 0..1 | It permits | support: | -| | | | to enable | MANDATORY | -| | | | (TRUE)/disable | | -| | | | (FALSE) the | | -| | | | auto-scaling | | -| | | | functionality. | | -| | | | | | -| | | | NOTE: A | | -| | | | cardinality | | -| | | | of "0" | | -| | | | indicates | | -| | | | that | | -| | | | configuring | | -| | | | this | | -| | | | present VNF | | -| | | | property is | | -| | | | not | | -| | | | supported. | | -+--------------------------------+-------------+------------------+-----------------+---------------+ -| isAutohealEnabled | Boolean | 0..1 | It permits | support: | -| | | | to enable | MANDATORY | -| | | | (TRUE)/disable | | -| | | | (FALSE) the | | -| | | | auto-healing | | -| | | | functionality. | | -| | | | | | -| | | | NOTE: A | | -| | | | cardinality | | -| | | | of "0" | | -| | | | indicates | | -| | | | that | | -| | | | configuring | | -| | | | this | | -| | | | present VNF | | -| | | | property is | | -| | | | not | | -| | | | supported. | | -+--------------------------------+-------------+------------------+-----------------+---------------+ -| additionalConfigurableProperty | String | 0..N | It provides | support: | -| | | | VNF | MANDATORY | -| | | | specific | | -| | | | configurable | | -| | | | properties | | -| | | | that can be | | -| | | | modified | | -| | | | using the | | -| | | | ModifyVnfInfo | | -| | | | operation. | | -+--------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/VnfIndicator.rst b/docs/ONAP release 2 spec/im/VnfIndicator.rst deleted file mode 100644 index d06bdf6..0000000 --- a/docs/ONAP release 2 spec/im/VnfIndicator.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfIndicator -=================== - -+----------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+================+=============+==================+=================+===============+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier. | MANDATORY | -+----------------+-------------+------------------+-----------------+---------------+ -| name | String | 0..1 | The human | support: | -| | | | readable | MANDATORY | -| | | | name of the | | -| | | | VnfIndicator. | | -+----------------+-------------+------------------+-----------------+---------------+ -| indicatorValue | String | 1..N | Defines the | support: | -| | | | allowed | MANDATORY | -| | | | values or | | -| | | | value | | -| | | | ranges of | | -| | | | this | | -| | | | indicator. | | -+----------------+-------------+------------------+-----------------+---------------+ -| source | Enum | 1 | Describe | support: | -| | | | the source | MANDATORY | -| | | | of the | | -| | | | indicator. | valueRange: | -| | | | This tells | "VNF", | -| | | | the | "EM", | -| | | | consumer | "Both" | -| | | | where to | | -| | | | send the | | -| | | | subscription | | -| | | | request. | | -+----------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst b/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst deleted file mode 100644 index 94bb5cd..0000000 --- a/docs/ONAP release 2 spec/im/VnfInfoModifiableAttributes.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfInfoModifiableAttributes -================================== - -+-------------+-------------+------------------+-----------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+=============+=============+==================+=================+===============+ -| extension | Not | 0..N | "Extension" | support: | -| | specified | | attributes | MANDATORY | -| | | | of VnfInfo | | -| | Editor's | | that are | | -| | note: need | | writeable. | | -| | to be | | | | -| | specified | | | | -+-------------+-------------+------------------+-----------------+---------------+ -| metadata | Not | 0..N | "Metadata" | support: | -| | specified | | attributes | MANDATORY | -| | | | of VnfInfo | | -| | Editor's | | that are | | -| | note: need | | writeable. | | -| | to be | | | | -| | specified | | | | -+-------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst b/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst deleted file mode 100644 index 5676b25..0000000 --- a/docs/ONAP release 2 spec/im/VnfcConfigurableProperties.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfcConfigurableProperties -================================= - -+------------------------------------+-------------+------------------+-----------------+---------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied | -| | | | | Stereotypes** | -+====================================+=============+==================+=================+===============+ -| additionalVnfcConfigurableProperty | String | 0..N | It provides | support: | -| | | | VNFC | MANDATORY | -| | | | configurable | | -| | | | properties | | -| | | | that can be | | -| | | | modified | | -| | | | using the | | -| | | | ModifyVnfInfo | | -| | | | operation. | | -| | | | | | -| | | | NOTE: A | | -| | | | cardinality | | -| | | | of "0" | | -| | | | indicates | | -| | | | that | | -| | | | configuring | | -| | | | this | | -| | | | present VNF | | -| | | | property is | | -| | | | not | | -| | | | supported. | | -+------------------------------------+-------------+------------------+-----------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/VnfdElementGroup.rst b/docs/ONAP release 2 spec/im/VnfdElementGroup.rst deleted file mode 100644 index 89c6125..0000000 --- a/docs/ONAP release 2 spec/im/VnfdElementGroup.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfdElementGroup -======================= - -+--------------------+---------------------+------------------+--------------------+---------------+ -| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied | -| Name** | | | | Stereotypes** | -+====================+=====================+==================+====================+===============+ -| vnfdElementGroupId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | group in | | -| | | | the VNFD. | | -+--------------------+---------------------+------------------+--------------------+---------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the | | -| | | | group. | | -+--------------------+---------------------+------------------+--------------------+---------------+ -| vdu | Identifier | 0..N | References | support: | -| | (Reference | | to Vdus | MANDATORY | -| | to Vdu) | | that are | | -| | | | part of | | -| | | | this group. | | -+--------------------+---------------------+------------------+--------------------+---------------+ -| virtualLinkDesc | Identifier | 0..N | References | support: | -| | (Reference | | to | MANDATORY | -| | to | | VnfVirtualLinkDesc | | -| | VnfVirtualLinkDesc) | | that are part of | | -| | | | this group. | | -+--------------------+---------------------+------------------+--------------------+---------------+ diff --git a/docs/ONAP release 2 spec/im/cpd.rst b/docs/ONAP release 2 spec/im/cpd.rst deleted file mode 100644 index be0177e..0000000 --- a/docs/ONAP release 2 spec/im/cpd.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: Cpd -========== - -+--------------------+----------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+================+==================+=================+==========================+ -| cpdId | Identifier | 1 | Identifier | support: | -| | | | of this Cpd | MANDATORY | -| | | | information | | -| | | | element. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| cpRole | String | 0..1 | Identifies | support: | -| | | | the role of | MANDATORY | -| | | | the port in | | -| | | | the context | | -| | | | of the | | -| | | | traffic | | -| | | | flow | | -| | | | patterns in | | -| | | | the VNF or | | -| | | | parent NS. | | -| | | | | | -| | | | For example | | -| | | | a VNF with | | -| | | | a tree flow | | -| | | | pattern | | -| | | | within the | | -| | | | VNF will | | -| | | | have legal | | -| | | | cpRoles of | | -| | | | ROOT and | | -| | | | LEAF. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| description | String | 0..1 | Provides | support: | -| | | | human-readable | MANDATORY | -| | | | information | | -| | | | on the | | -| | | | purpose of | | -| | | | the CP | | -| | | | (e.g. CP | | -| | | | for control | | -| | | | plane | | -| | | | traffic). | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| cpProtocol | CpProtocolData | 1..N | Identifies | support: | -| | | | the | MANDATORY | -| | | | protocol | | -| | | | layering | | -| | | | information | | -| | | | the CP uses | | -| | | | for | | -| | | | connectivity | | -| | | | purposes | | -| | | | and | | -| | | | associated | | -| | | | information. | | -| | | | There shall | | -| | | | be one | | -| | | | cpProtocol | | -| | | | for each | | -| | | | layer | | -| | | | protocol as | | -| | | | indicated | | -| | | | by the | | -| | | | attribute | | -| | | | layerProtocol. | | -| | | | | | -| | | | Editor's | | -| | | | note: the | | -| | | | attribute | | -| | | | "layerProto | | -| | | | col" | | -| | | | still needs | | -| | | | further | | -| | | | discussion | | -| | | | and not | | -| | | | included in | | -| | | | this table. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| trunkMode | Boolean | 1 | Information | support: | -| | | | about | MANDATORY | -| | | | whether the | | -| | | | CP | | -| | | | instantiated | | -| | | | from this | | -| | | | CPD is in | | -| | | | Trunk mode | | -| | | | (802.1Q or | | -| | | | other). | | -+--------------------+----------------+------------------+-----------------+--------------------------+ -| allowedAddressData | AddressData | 0..N | For | support: | -| | | | specifying | MANDATORY | -| | | | floating | | -| | | | IP(s) to be | | -| | | | shared | | -| | | | among Cpds, | | -| | | | which are | | -| | | | reserved | | -| | | | for | | -| | | | vnfReserved | | -| | | | Cpd | | -| | | | described | | -| | | | in the | | -| | | | VNFD. | | -+--------------------+----------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/index.rst b/docs/ONAP release 2 spec/im/index.rst deleted file mode 100644 index e38744d..0000000 --- a/docs/ONAP release 2 spec/im/index.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP Information Model Specifications -===================================== - -.. toctree:: - :titlesonly: - - AddressData - AffinityOrAntiAffinityGroup - BaseConfigGroup - ConnectivityType - cpd - CpProtocolData - DeploymentGroup - instantiationlevel - L2AddressData - L3AddressData - LifecycleManagementScript - linkbitraterequirements - LocalAffinityOrAntiAffinityRule - logicalnodedata - MonitoringParameter - PlacementGroup - QoS - RequestedAdditionalCapabilityData - ScaleInfo - SwImageDesc - vdu - vducpd - VduLevel - vduprofile - virtualcomputedesc - virtualcpudata - VirtualCpuPinningData - virtuallinkdescflavour - virtuallinkprofile - virtualmemorydata - virtualnetworkinterfacerequirements - virtualstoragedesc - VnfcConfigurableProperties - VnfConfigurableProperties - vnfd - VnfdElementGroup - vnfdf - vnfextcpd - VnfIndicator - VnfInfoModifiableAttributes - vnfvirtuallinkdesc diff --git a/docs/ONAP release 2 spec/im/instantiationlevel.rst b/docs/ONAP release 2 spec/im/instantiationlevel.rst deleted file mode 100644 index a36998a..0000000 --- a/docs/ONAP release 2 spec/im/instantiationlevel.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: InstantiationLevel -========================= - -+------------------------+-------------------------+------------------+-------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+========================+=========================+==================+===================+==========================+ -| levelId | Identifier | 1 | Uniquely | support: | -| | | | identifies | MANDATORY | -| | | | a level | | -| | | | with the DF. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the level. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ -| vduLevel | VduLevel | 1..N | Indicates | support: | -| | | | the number | MANDATORY | -| | | | of instance | | -| | | | of this VDU | | -| | | | to deploy | | -| | | | for this level. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ -| virtualLinkBitRateLevel| VirtualLinkBitRateLevel | 0..N | Specifies | support: | -| | | | bitrate | MANDATORY | -| | | | requirements | | -| | | | applicable | | -| | | | to virtual links | | -| | | | created from | | -| | | | particular | | -| | | | virtual link | | -| | | | descriptors | | -| | | | for this level. | | -| | | | | | -| | | | NOTE: If not | | -| | | | present, it | | -| | | | is assumed | | -| | | | that the bitrate | | -| | | | requirements | | -| | | | can be derived | | -| | | | from those | | -| | | | specified in the | | -| | | | VduCpd instances | | -| | | | applicable | | -| | | | to the internal | | -| | | | VL. If | | -| | | | present in | | -| | | | both the | | -| | | | InstantiationLevel| | -| | | | and the VduCpd | | -| | | | instances | | -| | | | applicable | | -| | | | to the | | -| | | | internal VL, the | | -| | | | highest | | -| | | | value takes | | -| | | | precedence. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ -| scaleInfo | ScaleInfo | 0..N | Represents | support: | -| | | | for each | MANDATORY | -| | | | aspect the | | -| | | | scale level that | | -| | | | corresponds | | -| | | | to this | | -| | | | instantiation | | -| | | | level. | | -| | | | scaleInfo | | -| | | | shall be | | -| | | | present if | | -| | | | the VNF | | -| | | | supports scaling. | | -+------------------------+-------------------------+------------------+-------------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/linkbitraterequirements.rst b/docs/ONAP release 2 spec/im/linkbitraterequirements.rst deleted file mode 100644 index ab2c497..0000000 --- a/docs/ONAP release 2 spec/im/linkbitraterequirements.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: LinkBitrateRequirements -============================== - -+--------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================+=============+==================+=================+==========================+ -| root | Number | 1 | Throughput | support: | -| | | | requirement | MANDATORY | -| | | | of the | | -| | | | link (e.g. | | -| | | | bitrate of | | -| | | | E-Line, | | -| | | | root | | -| | | | bitrate of | | -| | | | E-Tree, | | -| | | | aggregate | | -| | | | capacity of | | -| | | | E-LAN). | | -+--------------------+-------------+------------------+-----------------+--------------------------+ -| leaf | Number | 0..1 | Throughput | support: | -| | | | requirement | MANDATORY | -| | | | of leaf | | -| | | | connections | | -| | | | to the link | | -| | | | when | | -| | | | applicable | | -| | | | to the | | -| | | | connectivity | | -| | | | type (e.g. | | -| | | | for E-Tree | | -| | | | and E-LAN | | -| | | | branches). | | -| | | | | | -| | | | NOTE: The | | -| | | | present | | -| | | | document | | -| | | | does not | | -| | | | specify the | | -| | | | means to | | -| | | | declare | | -| | | | different | | -| | | | bitrate | | -| | | | requirements | | -| | | | for leaf | | -| | | | connections | | -| | | | (e.g. E-LAN | | -| | | | leaves). | | -+--------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/logicalnodedata.rst b/docs/ONAP release 2 spec/im/logicalnodedata.rst deleted file mode 100644 index a0981de..0000000 --- a/docs/ONAP release 2 spec/im/logicalnodedata.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: LogicalNodeData -====================== - -+-------------------------+-------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=========================+=============+==================+=================+==========================+ -| logicalNodeRequirements | KeyValuePair| 0..N | The logical | support: | -| | | | node-level | MANDATORY | -| | | | compute, | | -| | | | memory and | | -| | | | I/O | | -| | | | requirements. | | -| | | | An array of | | -| | | | key-value | | -| | | | pairs that | | -| | | | articulate | | -| | | | the | | -| | | | deployment | | -| | | | requirements. | | -| | | | | | -| | | | This could | | -| | | | include the | | -| | | | number of | | -| | | | CPU cores | | -| | | | on this | | -| | | | logical | | -| | | | node, a | | -| | | | memory | | -| | | | configuration | | -| | | | specific to | | -| | | | a logical | | -| | | | node (e.g. | | -| | | | such as | | -| | | | available | | -| | | | in the | | -| | | | Linux | | -| | | | kernel via | | -| | | | the libnuma | | -| | | | library) or | | -| | | | a | | -| | | | requirement | | -| | | | related to | | -| | | | the | | -| | | | association | | -| | | | of an I/O | | -| | | | device with | | -| | | | the logical | | -| | | | node. | | -+-------------------------+-------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/vdu.rst b/docs/ONAP release 2 spec/im/vdu.rst deleted file mode 100644 index f83ed43..0000000 --- a/docs/ONAP release 2 spec/im/vdu.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: Vdu -========== - -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=======================+===========================+==================+====================+=========================+ -| vduId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this Vdu | | -| | | | in VNFD. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| name | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | name of the | | -| | | | Vdu. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the Vdu. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| vduCpd | VduCpd | 1..N | Describes | support: | -| | | | network | MANDATORY | -| | | | connectivity | | -| | | | between a | | -| | | | VNFC | | -| | | | instance | | -| | | | (based on | | -| | | | this Vdu) | | -| | | | and an | | -| | | | Virtual | | -| | | | Link (VL). | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| virtualComputeDesc | Identifier | 1 | Describes | support: | -| | (reference | | CPU, Memory | MANDATORY | -| | to | | and | | -| | VirtualComputeDesc) | | acceleration | | -| | | | requirements | | -| | | | of the | | -| | | | Virtualisation | | -| | | | Container | | -| | | | realising | | -| | | | this Vdu. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| virtualStorageDesc | Identifier | 0..N | Describes | support: | -| | (reference | | storage | MANDATORY | -| | to | | requirements | | -| | VirtualStorageDesc) | | for a | | -| | | | VirtualStorage | | -| | | | instance | | -| | | | attached to | | -| | | | the | | -| | | | virtualisation | | -| | | | container | | -| | | | created | | -| | | | from | | -| | | | virtualComputeDesc | | -| | | | defined for | | -| | | | this Vdu. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| bootOrder | KeyValuePair | 0..N | Boot order | support: | -| | | | of valid | MANDATORY | -| | | | boot | | -| | | | devices. | valueRange: | -| | | | | "key/name" | -| | | | NOTE: If no | indicates | -| | | | boot order | the the | -| | | | is defined | boot index | -| | | | the default | (lowest | -| | | | boot order | index | -| | | | defined in | defines | -| | | | the VIM or | highest | -| | | | NFVI shall | boot | -| | | | be used. | priority). | -| | | | | "value" | -| | | | | references | -| | | | | a | -| | | | | descriptor | -| | | | | from which | -| | | | | a valid | -| | | | | boot device | -| | | | | is created | -| | | | | e.g. | -| | | | | VirtualStorageDesc | -| | | | | from which | -| | | | | a | -| | | | | VirtualStorage | -| | | | | instance is | -| | | | | created. | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| swImageDesc | SwImageDesc | 0..1 | Describes | support: | -| | | | the | MANDATORY | -| | | Editor's | software | | -| | | note: the | image which | | -| | | scenario of | is directly | | -| | | using "0" | loaded on | | -| | | needs to be | the | | -| | | clarified. | virtualisation | | -| | | | container | | -| | | | realising | | -| | | | this Vdu. | | -| | | | | | -| | | | NOTE: More | | -| | | | software | | -| | | | images can | | -| | | | be attached | | -| | | | to the | | -| | | | virtualisation | | -| | | | container | | -| | | | using | | -| | | | VirtualStorage | | -| | | | resources. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| nfviConstraint | KeyValuePair | 0..N | Describes | support: | -| | | | constraints | MANDATORY | -| | | | on the NFVI | | -| | | | for the | valueRange: | -| | | | VNFC | "key/name" | -| | | | instance(s) | includes | -| | | | created | "AvailabilityZone", | -| | | | from this | "HostAggregates". | -| | | | Vdu. For | | -| | | | example, | | -| | | | aspects of | | -| | | | a secure | | -| | | | hosting | | -| | | | environment | | -| | | | for the | | -| | | | VNFC | | -| | | | instance | | -| | | | that | | -| | | | involve | | -| | | | additional | | -| | | | entities or | | -| | | | processes. | | -| | | | | | -| | | | NOTE: These | | -| | | | are | | -| | | | constraints | | -| | | | other than | | -| | | | stipulating | | -| | | | that a VNFC | | -| | | | instance | | -| | | | has access | | -| | | | to a | | -| | | | certain | | -| | | | resource, | | -| | | | as a | | -| | | | prerequisite | | -| | | | to | | -| | | | instantiation. | | -| | | | The | | -| | | | attributes | | -| | | | virtualComputeDesc | | -| | | | and | | -| | | | virtualStorageDesc | | -| | | | define the | | -| | | | resources | | -| | | | required | | -| | | | for | | -| | | | instantiation | | -| | | | of the VNFC | | -| | | | instance. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: | -| | | | virtualised | MANDATORY | -| | | | resources | | -| | | | monitoring | | -| | | | parameters | | -| | | | on VDU | | -| | | | level. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| configurableProperties| VnfcConfigurableProperties| 1 | Describes | support: | -| | | | the | MANDATORY | -| | | | configurable | | -| | | | properties | | -| | | | of all VNFC | | -| | | | instances | | -| | | | based on | | -| | | | this VDU. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ -| injectFiles | String | 0..N | Describes | support: | -| | | | the | MANDATORY | -| | | | information | | -| | | | (e.g. URL) | | -| | | | about the | | -| | | | scripts, | | -| | | | config | | -| | | | drive | | -| | | | metadata, | | -| | | | etc. which | | -| | | | can be used | | -| | | | during Vdu | | -| | | | booting | | -| | | | process. | | -+-----------------------+---------------------------+------------------+--------------------+-------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/vducpd.rst b/docs/ONAP release 2 spec/im/vducpd.rst deleted file mode 100644 index e0247d4..0000000 --- a/docs/ONAP release 2 spec/im/vducpd.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VduCpd -============= - -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+====================================+====================================+==================+==================+==========================+ -| bitrateRequirement | Number | 0..1 | Bitrate | support: | -| | (recommended | | requirement | MANDATORY | -| | DM type: Scalar-Unit-Rate) | | on this CP. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| vnicName | String | 0..1 | Describes | support: | -| | | | the name of | MANDATORY | -| | | | the vNIC | | -| | | | this CP | | -| | | | attaches | | -| | | | to, e.g. | | -| | | | eth0. It | | -| | | | will be | | -| | | | configured | | -| | | | during the | | -| | | | Vdu booting | | -| | | | process. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| vnicOrder | Integer | 0..1 | Describes | support: | -| | | | the order | MANDATORY | -| | | | to create | | -| | | | the vNIC | | -| | | | within the | | -| | | | scope of | | -| | | | this Vdu. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| vnicType | Enum | 0..1 | Describes | support: | -| | | | the type of | MANDATORY | -| | | | the vNIC | | -| | | | this CP | valueRange: | -| | | | attaches | normal, | -| | | | to. | macvtap, | -| | | | | direct, | -| | | | | baremetal, | -| | | | | direct-physical | -| | | | | and | -| | | | | virtio-forwarder | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| virtualNetworkInterfaceRequirements| VirtualNetworkInterfaceRequirements| 0..N | Specifies | support: | -| | | | requirements | MANDATORY | -| | | | on a | | -| | | | virtual | | -| | | | network | | -| | | | interface | | -| | | | realising | | -| | | | the CPs | | -| | | | instantiated | | -| | | | from this | | -| | | | CPD. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ -| (inherited | | | All | | -| attributes) | | | attributes | | -| | | | inherited | | -| | | | from Cpd. | | -+------------------------------------+------------------------------------+------------------+------------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/vduprofile.rst b/docs/ONAP release 2 spec/im/vduprofile.rst deleted file mode 100644 index 2d7e64a..0000000 --- a/docs/ONAP release 2 spec/im/vduprofile.rst +++ /dev/null @@ -1,152 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VduProfile -================= - -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=================================+=================================+===================+=================+==========================+ -| vduId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to Vdu) | | a VDU. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| minNumberOfInstances | Integer | 1 | Minimum | support: | -| | | | number of | MANDATORY | -| | | | instances | | -| | | | of the VNFC | | -| | | | based on | | -| | | | this VDU | | -| | | | that is | | -| | | | permitted | | -| | | | to exist | | -| | | | for this | | -| | | | flavour. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| maxNumberOfInstances | Integer | 1 | Maximum | support: | -| | | | number of | MANDATORY | -| | | | instances | | -| | | | of the VNFC | | -| | | | based on | | -| | | | this VDU | | -| | | | that is | | -| | | | permitted | | -| | | | to exist | | -| | | | for this | | -| | | | flavour. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N | Specifies | support: | -| | | | affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | rules | | -| | | | applicable | | -| | | | between the | | -| | | | virtualisation | | -| | | | containers | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machines) | | -| | | | to be | | -| | | | created | | -| | | | based on | | -| | | | this VDU. | | -| | | | | | -| | | | When the | | -| | | | cardinality | | -| | | | is greater | | -| | | | than 1, | | -| | | | both | | -| | | | affinity | | -| | | | rule(s) and | | -| | | | anti-affinity | | -| | | | rule(s) | | -| | | | with | | -| | | | different | | -| | | | scopes | | -| | | | (e.g. | | -| | | | "Affinity | | -| | | | with the | | -| | | | scope | | -| | | | resource | | -| | | | zone and | | -| | | | anti-affinity | | -| | | | with the | | -| | | | scope NFVI | | -| | | | node") are | | -| | | | applicable | | -| | | | to the | | -| | | | virtualisation | | -| | | | containers | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machines) | | -| | | | to be | | -| | | | created | | -| | | | based on | | -| | | | this VDU. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| affinityOrAntiAffinityGroupId | Identifier | 0..N | Identifier(s) | support: | -| | | | of the | MANDATORY | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group(s) | | -| | | | the VDU | | -| | | | belongs to. | | -| | | | | | -| | | | NOTE: Each | | -| | | | identifier | | -| | | | references | | -| | | | an affinity | | -| | | | or | | -| | | | anti-affinity | | -| | | | group which | | -| | | | expresses | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | relationships | | -| | | | between the | | -| | | | virtualisation | | -| | | | container(s) | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machine(s)) | | -| | | | to be | | -| | | | created | | -| | | | using this | | -| | | | VDU and the | | -| | | | virtualisation | | -| | | | container(s) | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machine(s)) | | -| | | | to be | | -| | | | created | | -| | | | using other | | -| | | | VDU(s) in | | -| | | | the same | | -| | | | group. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| watchdog | String | 0..1 | Watchdog | support: | -| | | | action to | MANDATORY | -| | | | be | | -| | | | triggered | | -| | | | by the VIM | | -| | | | for the VNF | | -| | | | in case the | | -| | | | heart beat | | -| | | | fails, e.g. | | -| | | | reset or | | -| | | | hard | | -| | | | shutdown, | | -| | | | etc. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ -| vmBootUpTimeOut | Integer | 0..1 | Timeout | support: | -| | | | value for | OPTIONAL | -| | | | the VNFM to | | -| | | | wait before | | -| | | | the | | -| | | | successful | | -| | | | booting up | | -| | | | of the VDU. | | -+---------------------------------+---------------------------------+-------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtualcomputedesc.rst b/docs/ONAP release 2 spec/im/virtualcomputedesc.rst deleted file mode 100644 index 081f90b..0000000 --- a/docs/ONAP release 2 spec/im/virtualcomputedesc.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualComputeDesc -========================= - -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===============================+===================================+==================+===================+==========================+ -| virtualComputeDescId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | VirtualComputeDesc| | -| | | | in the | | -| | | | VNFD. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| logicalNode | LogicalNodeData | 1..N | The logical | support: | -|   | | | Node | MANDATORY | -| | | | requirements. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| requestAdditionalCapabilities | RequestedAdditionalCapabilityData | 0..N | Specifies | support: | -| | | | requirements | MANDATORY | -| | | | for | | -| | | | additional | | -| | | | capabilities. | | -| | | | These may | | -| | | | be for a | | -| | | | range of | | -| | | | purposes. | | -| | | | One example | | -| | | | is | | -| | | | acceleration | | -| | | | related | | -| | | | capabilities. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| computeRequirements | KeyValuePair | 0..N | Specifies | support: | -| | | | compute | MANDATORY | -| | | | requirements. | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| virtualMemory | VirtualMemoryData | 1 | The virtual | support: | -| | | | memory of | MANDATORY | -| | | | the | | -| | | | virtualised | | -| | | | compute. | | -| | | | | | -| | | | | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ -| virtualCpu | VirtualCpuData | 1 | The virtual | support: | -| | | | CPU(s) of | MANDATORY | -| | | | the | | -| | | | virtualised | | -| | | | compute. | | -| | | | | | -+-------------------------------+-----------------------------------+------------------+-------------------+--------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/virtualcpudata.rst b/docs/ONAP release 2 spec/im/virtualcpudata.rst deleted file mode 100644 index 105614f..0000000 --- a/docs/ONAP release 2 spec/im/virtualcpudata.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualCpuData -===================== - -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+==================================+=======================+==================+=================+=========================+ -| cpuArchitecture | String | 0..1 | CPU | support: | -| | | | architecture | MANDATORY | -| | | | type. | | -| | | | Examples | | -| | | | are x86, | | -| | | | ARM. The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | CPU | | -| | | | architecture | | -| | | | type is | | -| | | | requested. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| numVirtualCpu | Integer | 1 | Number of | support: | -| | | | virtual | MANDATORY | -| | | | CPUs. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| virtualCpuClock | Number | 0..1 | Minimum | support: | -| | (recommended | | virtual CPU | MANDATORY | -| | DM type: | | clock rate | | -| | Scalar-Unit-Freq) | | (e.g. in | | -| | | | MHz). The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| virtualCpuOversubscriptionPolicy | String | 0..1 | The CPU | support: | -| | | | core | MANDATORY | -| | | | oversubscription| | -| | | | policy e.g. | | -| | | | the | | -| | | | relation of | | -| | | | virtual CPU | | -| | | | cores to | | -| | | | physical | | -| | | | CPU | | -| | | | cores/threads. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| vduCpuRequirements | KeyValuePair | 0..N | Array of | support: | -| | | | key-value | MANDATORY | -| | | | pair | | -| | | | requirements | | -| | | | on the | | -| | | | Compute | | -| | | | (CPU) for | | -| | | | the VDU. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ -| virtualCpuPinning | VirtualCpuPinningData | 0..1 | The virtual | support: | -| | | | CPU pinning | MANDATORY | -| | | | configuration | | -| | | | for the | | -| | | | virtualised | | -| | | | compute | | -| | | | resource. | | -+----------------------------------+-----------------------+------------------+-----------------+-------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst b/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst deleted file mode 100644 index e617bfe..0000000 --- a/docs/ONAP release 2 spec/im/virtuallinkdescflavour.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualLinkDescFlavour -============================= - -+-------------------+-------------+------------------+---------------------+--------------------------+ -| **Attribute Name**| **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+===================+=============+==================+=====================+==========================+ -| flavourId | Identifier | 1 | Identifies | support: | -| | | | a flavour | MANDATORY | -| | | | within a | | -| | | | VnfVirtualLinkDesc. | | -+-------------------+-------------+------------------+---------------------+--------------------------+ -| qos | QoS | 0..1 | QoS of the | support: | -| | | | VL. | MANDATORY | -+-------------------+-------------+------------------+---------------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtuallinkprofile.rst b/docs/ONAP release 2 spec/im/virtuallinkprofile.rst deleted file mode 100644 index 46addd5..0000000 --- a/docs/ONAP release 2 spec/im/virtuallinkprofile.rst +++ /dev/null @@ -1,152 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualLinkProfile -========================= - -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=================================+=================================+==================+=======================+==========================+ -| vnfVirtualLinkDescId | Identifier | 1 | Uniquely | support: | -| | (Reference | | identifies | MANDATORY | -| | to | | a Vnf VLD. | | -| | VnfVirtualLinkDesc) | | | | -| | | | | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| flavourId | Identifier | 1 | Identifies | support: | -| | (Reference | | a flavour | MANDATORY | -| | to | | within the | | -| | VirtualLinkDescFlavour) | | VnfVirtualLinkDesc. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| localAffinityOrAntiAffinityRule | LocalAffinityOrAntiAffinityRule | 0..N | Specifies | support: | -| | | | affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | rules | | -| | | | applicable | | -| | | | between the | | -| | | | VLs based | | -| | | | on this | | -| | | | VnfVirtualLinkDesc. | | -| | | | | | -| | | | When the | | -| | | | cardinality | | -| | | | is greater | | -| | | | than 1, | | -| | | | both | | -| | | | affinity | | -| | | | rule(s) and | | -| | | | anti-affinity | | -| | | | rule(s) with | | -| | | | different | | -| | | | scopes are | | -| | | | applicable | | -| | | | to the VLs | | -| | | | based on this | | -| | | | VnfVirtualLinkDesc. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| affinityOrAntiAffinityGroupId | Identifier | 0..N | Identifier(s) | support: | -| | | | of the | MANDATORY | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group(s) the | | -| | | | VnfVirtualLinkDesc | | -| | | | belongs to. | | -| | | | | | -| | | | NOTE: Each | | -| | | | identifier | | -| | | | references | | -| | | | an affinity | | -| | | | or | | -| | | | anti-affinity | | -| | | | group which | | -| | | | expresses | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | relationship | | -| | | | between the | | -| | | | VL(s) using | | -| | | | this | | -| | | | VnfVirtualLinkDesc | | -| | | | and the | | -| | | | VL(s) using | | -| | | | other | | -| | | | VnfVirtualLinkDesc(s) | | -| | | | in the same group. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| maxBitRateRequirements | LinkBitrateRequirements | 1 | Specifies | support: | -| | | | the maximum | MANDATORY | -| | | | bitrate | | -| | | | requirements | | -| | | | for a VL | | -| | | | instantiated | | -| | | | according | | -| | | | to this | | -| | | | profile. | | -| | | | | | -| | | | NOTE: These | | -| | | | attributes | | -| | | | are used to | | -| | | | control | | -| | | | scaling | | -| | | | boundaries. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| minBitRateRequirements | LinkBitrateRequirements | 1 | Specifies | support: | -| | | | the minimum | MANDATORY | -| | | | bitrate | | -| | | | requirements | | -| | | | for a VL | | -| | | | instantiated | | -| | | | according | | -| | | | to this | | -| | | | profile. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| initiationParameters | KeyValuePair | 0..N | Specifies | support: | -| | | | initiation | MANDATORY | -| | | | parameters | | -| | | | for the | valueRange: | -| | | | virtual |  specified | -| | | | link. | values | -| | | | | include: | -| | | | | cidr, | -| | | | | allocationPools | -| | | | | (represented | -| | | | | by | -| | | | | [starting | -| | | | | ip address, | -| | | | | ending ip | -| | | | | address]), | -| | | | | gatewayIp, | -| | | | | networkName, | -| | | | | segmentationId, | -| | | | | physicalNetwork. | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| networkType | Enum | 0..1 | Type of the | support: | -| | | | network. | MANDATORY | -| | | | | | -| | | | | valueRange: | -| | | | | "VLAN", | -| | | | | "VXLAN" | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| dhcpEnabled | Boolean | 0..1 | Indicating | support: | -| | | | whether | MANDATORY | -| | | | DHCP is | | -| | | | enabled. | | -| | | | Default is | | -| | | | "FALSE" if | | -| | | | not | | -| | | | specified | | -| | | | otherwise. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ -| vlanTransparent | Boolean | 0..1 | Indicating | support: | -| | | | whether | MANDATORY | -| | | | "VLAN | | -| | | | Transparent | | -| | | | Mode" is | | -| | | | supported. | | -| | | | Default is | | -| | | | "FALSE" if | | -| | | | not | | -| | | | specified | | -| | | | otherwise. | | -+---------------------------------+---------------------------------+------------------+-----------------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtualmemorydata.rst b/docs/ONAP release 2 spec/im/virtualmemorydata.rst deleted file mode 100644 index 0719a87..0000000 --- a/docs/ONAP release 2 spec/im/virtualmemorydata.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualMemoryData -======================== - -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+==================================+===================+==================+=================+=========================+ -| virtualMemSize | Number | 1 | Amount of | support: | -| | (recommended | | virtual | MANDATORY | -| | DM type: | | Memory | | -| | Scalar-Unit-Size) | | (e.g. in | | -| | | | MB). | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| virtualMemOversubscriptionPolicy | String | 0..1 | The memory | support: | -| | | | core | MANDATORY | -| | | | oversubscription| | -| | | | policy in | | -| | | | terms of | | -| | | | virtual | | -| | | | memory to | | -| | | | physical | | -| | | | memory on | | -| | | | the | | -| | | | platform. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| vduMemRequirements | KeyValuePair | 0..N | Array of | support: | -| | | | key-value | MANDATORY | -| | | | pair | | -| | | | requirements | | -| | | | on the | | -| | | | memory for | | -| | | | the VDU. | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ -| numaEnabled | Boolean | 0..1 | It | support: | -| | | | specifies | MANDATORY | -| | | | the memory | | -| | | | allocation | | -| | | | to be | | -| | | | cognisant | | -| | | | of the | | -| | | | relevant | | -| | | | process/core | | -| | | | allocation. | | -| | | | The | | -| | | | cardinality | | -| | | | can be 0 | | -| | | | during the | | -| | | | allocation | | -| | | | request, if | | -| | | | no | | -| | | | particular | | -| | | | value is | | -| | | | requested. | | -+----------------------------------+-------------------+------------------+-----------------+-------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst b/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst deleted file mode 100644 index 4e13ddd..0000000 --- a/docs/ONAP release 2 spec/im/virtualnetworkinterfacerequirements.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualNetworkInterfaceRequirements -========================================== - -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+==============================+==================+==================+=================+==========================+ -| name | String | 0..1 | Provides a | support: | -| | | | human | MANDATORY | -| | | | readable | | -| | | | name for | | -| | | | the | | -| | | | requirement. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| description | String | 0..1 | Provides a | support: | -| | | | human | MANDATORY | -| | | | readable | | -| | | | description | | -| | | | of the | | -| | | | requirement. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| supportMandatory | Boolean | 1 | Indicates | support: | -| | | | whether | MANDATORY | -| | | | fulfilling | | -| | | | the | | -| | | | constraint | | -| | | | is | | -| | | | mandatory | | -| | | | (TRUE) for | | -| | | | successful | | -| | | | operation | | -| | | | or | | -| | | | desirable | | -| | | | (FALSE). | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| networkInterfaceRequirements | KeyValuePair | 0..N | The network | support: | -| | | | interface | MANDATORY | -| | | | requirements. | | -| | | | An element | | -| | | | from an | | -| | | | array of | | -| | | | key-value | | -| | | | pairs that | | -| | | | articulate | | -| | | | the network | | -| | | | interface | | -| | | | deployment | | -| | | | requirements. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ -| nicIoRequirements | Identifier | 0..1 | This | support: | -| | (reference | | references | MANDATORY | -| | to | | (couples) | | -| | logicalNodeData) | | the CPD | | -| | | | with any | | -| | | | logical | | -| | | | node I/O | | -| | | | requirements | | -| | | | (for | | -| | | | network | | -| | | | devices) | | -| | | | that may | | -| | | | have been | | -| | | | created. | | -| | | | Linking | | -| | | | these | | -| | | | attributes | | -| | | | is | | -| | | | necessary | | -| | | | so that so | | -| | | | that I/O | | -| | | | requirements | | -| | | | that need | | -| | | | to be | | -| | | | articulated | | -| | | | at the | | -| | | | logical | | -| | | | node level | | -| | | | can be | | -| | | | associated | | -| | | | with the | | -| | | | network | | -| | | | interface | | -| | | | requirements | | -| | | | associated | | -| | | | with the | | -| | | | CPD. | | -+------------------------------+------------------+------------------+-----------------+--------------------------+ diff --git a/docs/ONAP release 2 spec/im/virtualstoragedesc.rst b/docs/ONAP release 2 spec/im/virtualstoragedesc.rst deleted file mode 100644 index 4e0370e..0000000 --- a/docs/ONAP release 2 spec/im/virtualstoragedesc.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VirtualStorageDesc -========================= - -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+========================+===================+==================+=====================+=========================+ -| id | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | VirtualStorageDesc | | -| | | | in the | | -| | | | VNFD. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| typeOfStorage | String | 1 | Type of | support: | -| | | | virtualised | MANDATORY | -| | | | storage | | -| | | | resource | | -| | | | (e.g. | | -| | | | volume, | | -| | | | object). | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| sizeOfStorage | Number | 1 | Size of | support: | -| | (recommended | | virtualised | MANDATORY | -| | DM type: | | storage | | -| | Scalar-Unit-Size) | | resource | | -| | | | (e.g. size | | -| | | | of volume, | | -| | | | in GB). | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| vduStorageRequirements | KeyValuePair | 0..N | An array of | support: | -| | | | key-value | MANDATORY | -| | | | pairs that | | -| | | | articulate | | -| | | | the storage | | -| | | | deployment | | -| | | | requirements. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| rdmaEnabled | Boolean | 0..1 | Indicate if | support: | -| | | | the storage | MANDATORY | -| | | | support | | -| | | | RDMA. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ -| swImageDesc | Identifier | 0..1 | Software | support: | -| | (Reference | | image to be | MANDATORY | -| | to | | loaded on | | -| | SwImageDesc) | | the | | -| | | | VirtualStorage | | -| | | | resource | | -| | | | created | | -| | | | based on | | -| | | | this | | -| | | | VirtualStorageDesc. | | -+------------------------+-------------------+------------------+---------------------+-------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/vnfd.rst b/docs/ONAP release 2 spec/im/vnfd.rst deleted file mode 100644 index 5a8d22d..0000000 --- a/docs/ONAP release 2 spec/im/vnfd.rst +++ /dev/null @@ -1,309 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: Vnfd -=========== - -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=============================+=============================+==================+=====================+======================================================+ -| vnfdId | Identifier | 1 | Identifier | support: | -| | | | of this | MANDATORY | -| | | | VNFD | | -| | | | information | | -| | | | element. | | -| | | | This | | -| | | | attribute | | -| | | | shall be | | -| | | | globally | | -| | | | unique. | | -| | | | | | -| | | | NOTE: The | | -| | | | VNFD | | -| | | | Identifier | | -| | | | shall be | | -| | | | used as the | | -| | | | unique | | -| | | | identifier | | -| | | | of the VNF | | -| | | | Package | | -| | | | that | | -| | | | contains | | -| | | | this VNFD. | | -| | | | | | -| | | | Any | | -| | | | modification | | -| | | | of the | | -| | | | content of | | -| | | | the VNFD or | | -| | | | the VNF | | -| | | | Package | | -| | | | shall | | -| | | | result in a | | -| | | | new VNFD | | -| | | | Identifier. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfProvider | String | 1 | Provider of | support: | -| | | | the VNF and | MANDATORY | -| | | | of the | | -| | | | VNFD. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfProductName | String | 1 | Name to | support: | -| | | | identify | MANDATORY | -| | | | the VNF | | -| | | | Product. | | -| | | | Invariant | | -| | | | for the VNF | | -| | | | Product | | -| | | | lifetime. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfSoftwareVersion | String | 1 | Software | support: | -| | | | version of | MANDATORY | -| | | | the VNF. | | -| | | | This is | | -| | | | changed | | -| | | | when there | | -| | | | is any | | -| | | | change to | | -| | | | the | | -| | | | software | | -| | | | that is | | -| | | | included in | | -| | | | the VNF | | -| | | | Package. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfdVersion | String | 1 | Identifies | support: | -| | | | the version | MANDATORY | -| | | | of the | | -| | | | VNFD. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfProductInfoName | String | 0..1 | Human | support: | -| | | | readable | MANDATORY | -| | | | name for | | -| | | | the VNF | | -| | | | Product. | | -| | | | Can change | | -| | | | during the | | -| | | | VNF Product | | -| | | | lifetime. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfProductInfoDescription | String | 0..1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the VNF | | -| | | | Product. | | -| | | | Can change | | -| | | | during the | | -| | | | VNF Product | | -| | | | lifetime. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfmInfo | String | 0..N | Identifies | support: | -| | | | VNFM(s) | MANDATORY | -| | | | compatible | | -| | | | with the | valueRange: | -| | | | VNF | use the | -| | | | described | name of | -| | | | in this | micro-service | -| | | | version of | of the vnfm | -| | | | the VNFD. | drive. For | -| | | | | vendor | -| | | | | specific | -| | | | | VNFM, the | -| | | | | value | -| | | | | composes of | -| | | | | "vendorname" | -| | | | | and | -| | | | | "vnfmdriver", | -| | | | | e.g. | -| | | | | "mycompanyvnfmdriver"; | -| | | | | for generic | -| | | | | VNFM, the | -| | | | | value is | -| | | | | "gvnfmdriver". | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| localizationLanguage | String | 0..N | Information | support: | -| | | | about | MANDATORY | -| | | | localization | | -| | | | languages | valueRange: | -| | | | | refer to | -| | | | of the VNF | ISO936 \ | -| | | | (includes | `https://www.iso.org/iso-639-language-codes.html | -| | | | e.g. | `__ | -| | | | strings in | | -| | | | the VNFD). | | -| | | | | | -| | | | NOTE: This | | -| | | | allows to | | -| | | | provide one | | -| | | | or more | | -| | | | localizatio | | -| | | | n | | -| | | | languages | | -| | | | to support | | -| | | | selecting a | | -| | | | specific | | -| | | | localizatio | | -| | | | n | | -| | | | language at | | -| | | | VNF | | -| | | | instantiati | | -| | | | on | | -| | | | time. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| defaultLocalizationLanguage | String | 0..1 | Default | support: | -| | | | localization | MANDATORY | -| | | | language | | -| | | | that is | valueRange: | -| | | | instantiated | refer to | -| | | | if no | ISO936 \ | -| | | | information | `https://www.iso.org/iso-639-language-codes.html | -| | | | about | `__ | -| | | | selected | | -| | | | localization | condition: | -| | | | language is | Shall be | -| | | | available. | present if | -| | | | | "localizationLanguage" | -| | | | | is present | -| | | | | and shall | -| | | | | be absent | -| | | | | otherwise. | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vdu | Vdu | 1..N | Virtualisation | support: | -| | | | Deployment | MANDATORY | -| | | | Unit. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| virtualComputeDesc | VirtualComputeDesc | 1..N | Defines | support: | -| | | | descriptors | MANDATORY | -| | | | of virtual | | -| | | | compute | | -| | | | resources | | -| | | | to be used | | -| | | | by the VNF. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| virtualStorageDesc | VirtualStorageDesc | 0..N | Defines | support: | -| | | | descriptors | MANDATORY | -| | | | of virtual | | -| | | | storage | | -| | | | resources | | -| | | | to be used | | -| | | | by the VNF. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| intVirtualLinkDesc | VirtualLinkDesc | 0..N | Represents | support: | -| | | | the type of | MANDATORY | -| | | | network | | -| | | | connectivity | | -| | | | mandated by | | -| | | | the VNF | | -| | | | provider | | -| | | | between two | | -| | | | or more CPs | | -| | | | which | | -| | | | includes at | | -| | | | least one | | -| | | | internal | | -| | | | CP. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfReservedCpd | VduCpd | 0..N | Reserved IP | support: | -| | | | Address for | MANDATORY | -| | | | VNF which | | -| | | | is not | | -| | | | bounded to | | -| | | | any | | -| | | | specific | | -| | | | VNFC, but | | -| | | | assigned | | -| | | | manually | | -| | | | from | | -| | | | outside and | | -| | | | potentially | | -| | | | shared as a | | -| | | | floating IP | | -| | | | among | | -| | | | VNFCs. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfExtCpd | VnfExtCpd | 1..N | Describes | support: | -| | | | external | MANDATORY | -| | | | interface(s) | | -| | | | exposed by | | -| | | | this VNF | | -| | | | enabling | | -| | | | connection | | -| | | | with a VL. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| deploymentFlavour | VnfDf | 1..N | Describes | support: | -| | | | specific | MANDATORY | -| | | | DF(s) of a | | -| | | | VNF with | | -| | | | specific | | -| | | | requirements | | -| | | | for | | -| | | | capacity | | -| | | | and | | -| | | | performance. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| configurableProperties | VnfConfigurableProperties | 0..1 | Describes | support: | -| | | | the | MANDATORY | -| | | | configurable | | -| | | | properties | | -| | | | of the VNF | | -| | | | (e.g. | | -| | | | related to | | -| | | | auto | | -| | | | scaling and | | -| | | | auto | | -| | | | healing). | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| modifiableAttributes | VnfInfoModifiableAttributes | 0..1 | Describes | support: | -| | | | the | MANDATORY | -| | | | modifiable | | -| | | | attributes | | -| | | | of the VNF. | | -| | | | | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| lifeCycleManagementScript | LifeCycleManagementScript | 0..N | Includes a | support: | -| | | | list of | MANDATORY | -| | | | events and | | -| | | | corresponding | | -| | | | management | | -| | | | scripts | | -| | | | performed | | -| | | | for the | | -| | | | VNF. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| elementGroup | VnfdElementGroup | 0..N | Describes | support: | -| | | | the | MANDATORY | -| | | | associated | | -| | | | elements of | | -| | | | a VNFD for | | -| | | | a certain | | -| | | | purpose | | -| | | | during VNF | | -| | | | lifecycle | | -| | | | management. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| vnfIndicator | VnfIndicator | 0..N | Declares | support: | -| | | | the VNF | MANDATORY | -| | | | indicators | | -| | | | that are | | -| | | | supported | | -| | | | by this | | -| | | | VNF. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| logo | String | 0..1 | File path | support: | -| | | | of the | MANDATORY | -| | | | vendor | | -| | | | specified | | -| | | | logo. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ -| guide | String | 0..1 | UUID of the | support: | -| | | | vendor | MANDATORY | -| | | | guide/documentation | | -| | | | which is | | -| | | | attached to | | -| | | | VNF and can | | -| | | | be | | -| | | | downloaded | | -| | | | from the | | -| | | | model. | | -+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+ diff --git a/docs/ONAP release 2 spec/im/vnfdf.rst b/docs/ONAP release 2 spec/im/vnfdf.rst deleted file mode 100644 index c78de9f..0000000 --- a/docs/ONAP release 2 spec/im/vnfdf.rst +++ /dev/null @@ -1,210 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfDf -============ - -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+============================+=============================+==================+=======================+==========================+ -| flavorId | Identifier | 1 | Identifier | support: | -| | | | of this DF | MANDATORY | -| | | | within the | | -| | | | VNFD. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| description | String | 1 | Human | support: | -| | | | readable | MANDATORY | -| | | | description | | -| | | | of the DF. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| vduProfile | VduProfile | 1..N | Describes | support: | -| | | | additional | MANDATORY | -| | | | instantiation | | -| | | | data for | | -| | | | the VDUs | | -| | | | used in | | -| | | | this | | -| | | | flavor. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| virtualLinkProfile | VirtualLinkProfile | 0..N | Defines the | support: | -| | | | internal | MANDATORY | -| | | | VLD along | | -| | | | with | | -| | | | additional | | -| | | | data which | | -| | | | is used in | | -| | | | this DF. | | -| | | | | | -| | | | NOTE 1: | | -| | | | This allows | | -| | | | for | | -| | | | different | | -| | | | VNF | | -| | | | internal | | -| | | | topologies | | -| | | | between | | -| | | | DFs. | | -| | | | | | -| | | | NOTE 2: | | -| | | | virtualLink | | -| | | | Profile | | -| | | | needs to be | | -| | | | provided | | -| | | | for all VLs | | -| | | | that the | | -| | | | CPs of the | | -| | | | VDUs in the | | -| | | | VDU | | -| | | | profiles | | -| | | | connect to. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| instantiationLevel | InstantiationLevel | 1..N | Describes | support: | -| | | | the various | MANDATORY | -| | | | levels of | | -| | | | resources | | -| | | | that can be | | -| | | | used to | | -| | | | instantiate | | -| | | | the VNF | | -| | | | using this | | -| | | | flavour. | | -| | | | | | -| | | | Examples: | | -| | | | Small, | | -| | | | Medium, | | -| | | | Large. | | -| | | | | | -| | | | If there is | | -| | | | only one | | -| | | | "instantiationLevel" | | -| | | | entry, it | | -| | | | shall be | | -| | | | treated as | | -| | | | the default | | -| | | | instantiation | | -| | | | level for | | -| | | | this DF. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| affinityOrAntiAffinityGroup| AffinityOrAntiAffinityGroup | 0..N | Specifies | support: | -| | | | affinity or | MANDATORY | -| | | | anti-affinity | | -| | | | relationship | | -| | | | applicable | | -| | | | between the | | -| | | | virtualisation | | -| | | | containers | | -| | | | (e.g. | | -| | | | virtual | | -| | | | machines) | | -| | | | to be | | -| | | | created | | -| | | | using | | -| | | | different | | -| | | | VDUs or | | -| | | | internal | | -| | | | VLs to be | | -| | | | created | | -| | | | using | | -| | | | different | | -| | | | VnfVirtualLinkDesc(s) | | -| | | | in the same | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group. | | -| | | | | | -| | | | NOTE: | | -| | | | In the | | -| | | | present | | -| | | | specification, | | -| | | | including | | -| | | | either | | -| | | | VDU(s) or | | -| | | | VnfVirtualLinkDesc(s) | | -| | | | into the | | -| | | | same | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group is | | -| | | | supported. | | -| | | | Extension | | -| | | | to support | | -| | | | including | | -| | | | both VDU(s) | | -| | | | and | | -| | | | VnfVirtualLinkDesc(s) | | -| | | | into the | | -| | | | same | | -| | | | affinity or | | -| | | | anti-affinity | | -| | | | group is | | -| | | | left for | | -| | | | future | | -| | | | specification. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| scalingAspect | ScalingAspect | 0..N | The scaling | support: | -| | | | aspects | MANDATORY | -| | | | supported | | -| | | | by this DF | | -| | | | of the VNF. | | -| | | | scalingAspect | | -| | | | shall be | | -| | | | present if | | -| | | | the VNF | | -| | | | supports | | -| | | | scaling. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| placementGroup | PlacementGroup | 0..N | Determine | support: | -| | | | where | EXPERIMENTAL | -| | | | VNFC's | | -| | | | (VDU's) are | | -| | | | placed with | | -| | | | respect to | | -| | | | the VNF | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| baseConfigGroup | BaseConfigGroup | 0..1 |- BaseConfigGroup | support: | -| | | | may set | EXPERIMENTAL | -| | | | Access | | -| | | | Control | | -| | | | Lists | | -| | | | (ACL's) | | -| | | | and | | -| | | | establish | | -| | | | security | | -| | | | groups | | -| | | | and | | -| | | | server | | -| | | | groups. | | -| | | | | | -| | | |- BaseConfigGroup | | -| | | | creates/establishs | | -| | | | storage for the | | -| | | | VM's (OpenStack | | -| | | | Cinder). | | -| | | | | | -| | | |- BaseConfigGroup | | -| | | | may | | -| | | | establish | | -| | | | internal | | -| | | | networks | | -| | | | such as | | -| | | | OAM (VNF | | -| | | | Mgmt) or | | -| | | | MNS | | -| | | | (Maintenance & | | -| | | | Surveillance) | | -| | | | established. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ -| deploymentGroup | DeploymentGroup | 1..N | DeploymentGroup | support: | -| | | | provides | EXPERIMENTAL | -| | | | the minimum | | -| | | | viable VDU | | -| | | | and | | -| | | | associated | | -| | | | VNFC | | -| | | | configuration | | -| | | | for a | | -| | | | useable | | -| | | | VNF. | | -+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/vnfextcpd.rst b/docs/ONAP release 2 spec/im/vnfextcpd.rst deleted file mode 100644 index 8a34c7c..0000000 --- a/docs/ONAP release 2 spec/im/vnfextcpd.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfExtCpd -================ - -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=====================================+=====================================+==================+=====================================+==========================+ -| intCpd | Identifier | 0..1 | Reference | support: | -| | (Reference | | to the | MANDATORY | -| | to VduCpd) | | internal | | -| | | | VDU CPD | | -| | | | which is | | -| | | | used to | | -| | | | instantiate | | -| | | | internal | | -| | | | CPs. These | | -| | | | internal | | -| | | | CPs are, in | | -| | | | turn, | | -| | | | exposed as | | -| | | | external | | -| | | | CPs defined | | -| | | | by this | | -| | | | external | | -| | | | CPD. | | -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -| virtualNetworkInterfaceRequirements | VirtualNetworkInterfaceRequirements | 0..N | Specifies | support: | -| | | | requirements | MANDATORY | -| | | | on a | | -| | | | virtual | | -| | | | network | | -| | | | interface | | -| | | | realising | | -| | | | the CPs | | -| | | | instantiated | | -| | | | from this | | -| | | | CPD. | | -| | | | | | -| | | | NOTE: In | | -| | | | case of | | -| | | | referencing | | -| | | | an intCpd | | -| | | | via its | | -| | | | identifier, | | -| | | | the | | -| | | | virtualNetworkInterfaceRequirements | | -| | | | attribute | | -| | | | of the | | -| | | | referenced | | -| | | | intCpd | | -| | | | applies. | | -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ -| (inherited | | | All | | -| attributes) | | | attributes | | -| | | | inherited | | -| | | | from Cpd. | | -+-------------------------------------+-------------------------------------+------------------+-------------------------------------+--------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst b/docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst deleted file mode 100644 index c818fa1..0000000 --- a/docs/ONAP release 2 spec/im/vnfvirtuallinkdesc.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -Class: VnfVirtualLinkDesc -========================= - -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** | -+=======================+=======================+==================+=================+==========================+ -| virtualLinkDescId | Identifier | 1 | Unique | support: | -| | | | identifier | MANDATORY | -| | | | of this | | -| | | | internal | | -| | | | VLD in | | -| | | | VNFD. | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| virtualLinkDescFlavour| VirtualLinkDescFlavour| 1..N | Describes a | support: | -| | | | specific | MANDATORY | -| | | | flavour of | | -| | | | the VL with | | -| | | | specific | | -| | | | bitrate | | -| | | | requirements. | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| connectivityType | ConnectivityType | 1 | | support: | -| | | | | MANDATORY | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| testAccess | String | 0..N | Specifies | support: | -| | | | test access | MANDATORY | -| | | | facilities | | -| | | | expected on | | -| | | | the VL | | -| | | | (e.g. none, | | -| | | | passive | | -| | | | monitoring, | | -| | | | or active | | -| | | | (intrusive) | | -| | | | loopbacks | | -| | | | at | | -| | | | endpoints). | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| description | String | 0..1 | Provides | support: | -| | | | human-readable | MANDATORY | -| | | | information | | -| | | | on the | | -| | | | purpose of | | -| | | | the VL | | -| | | | (e.g. | | -| | | | control | | -| | | | plane | | -| | | | traffic). | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ -| monitoringParameter | MonitoringParameter | 0..N | Defines the | support: | -| | | | virtualised | MANDATORY | -| | | | resources | | -| | | | monitoring | | -| | | | parameters | | -| | | | on VLD | | -| | | | level.  | | -+-----------------------+-----------------------+------------------+-----------------+--------------------------+ - \ No newline at end of file diff --git a/docs/ONAP release 2 spec/index.rst b/docs/ONAP release 2 spec/index.rst deleted file mode 100644 index e09d341..0000000 --- a/docs/ONAP release 2 spec/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP R2 Modeling Specifications -============================================== - -.. toctree:: - :titlesonly: - - im/index - dm/index - diff --git a/docs/index.rst b/docs/index.rst index edbc983..ff803cf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,18 +7,12 @@ ONAP 2nd release defines the resource IM/DM based on ETSI specifications and OAS .. toctree:: :maxdepth: 1 - ONAP release 2 spec/index + ONAP Model Spec/index -ONAP 1st release is mostly the merge of ECOMP and OPEN-O, the modeling specs are also the merge from two of them, but most of them come from SDC implementation - -.. toctree:: - :maxdepth: 1 - - ONAP release 1 spec/index - Release Notes .. toctree:: :maxdepth: 1 + Release-notes/index -- cgit 1.2.3-korg