From e9d4fc1e6ea5f43811d068db48c3f6847cf0dd66 Mon Sep 17 00:00:00 2001 From: yxpoke Date: Sun, 24 May 2020 22:56:59 +0800 Subject: R6 Model Spec Update Change-Id: I569b33a64bbae425eaec5fa939c57f69ea7e1ed8 Issue-ID: MODELING-363 Signed-off-by: yxpoke --- ONAP Information Model/.project | 11 - ONAP Information Model/Common.di | 2 - ONAP Information Model/Common.notation | 9266 ---------------- ONAP Information Model/Common.uml | 5015 --------- .../GenDoc/ONAP GenDoc Template.docx | Bin 43907 -> 0 bytes ...ONAP Model GenDoc Template-Landscape-v4-00.docx | Bin 50286 -> 0 bytes ...odel Glossary Template-Landscape-v4-00 V13.docx | Bin 36942 -> 0 bytes ...plate-Landscape-v4-00 V16 with Stereotypes.docx | Bin 38748 -> 0 bytes .../GenDoc/ONAP Model Structure.docx | Bin 44790 -> 0 bytes ONAP Information Model/Infrastructure.di | 2 - ONAP Information Model/Infrastructure.notation | 3087 ------ ONAP Information Model/Infrastructure.uml | 1052 -- ONAP Information Model/License.di | 2 - ONAP Information Model/License.notation | 3645 ------- ONAP Information Model/License.uml | 862 -- .../ModelStructure/OnapModelStructure.docx | Bin 46348 -> 0 bytes ONAP Information Model/Nf.di | 2 - ONAP Information Model/Nf.notation | 243 - ONAP Information Model/Nf.uml | 137 - ONAP Information Model/Ns.di | 2 - ONAP Information Model/Ns.notation | 2614 ----- ONAP Information Model/Ns.uml | 743 -- ONAP Information Model/Onap_Profile.profile.di | 2 - .../Onap_Profile.profile.notation | 109 - ONAP Information Model/Onap_Profile.profile.uml | 156 - .../OpenModel_Profile.profile.di | 2 - .../OpenModel_Profile.profile.notation | 2212 ---- .../OpenModel_Profile.profile.uml | 10447 ------------------ ONAP Information Model/Party.di | 2 - ONAP Information Model/Party.notation | 1577 --- ONAP Information Model/Party.uml | 267 - ONAP Information Model/Pnf.di | 2 - ONAP Information Model/Pnf.notation | 592 -- ONAP Information Model/Pnf.uml | 224 - ONAP Information Model/Policy.di | 2 - ONAP Information Model/Policy.notation | 2 - ONAP Information Model/Policy.uml | 647 -- ONAP Information Model/Resource.di | 2 - ONAP Information Model/Resource.notation | 97 - ONAP Information Model/Resource.uml | 44 - ONAP Information Model/Service.di | 2 - ONAP Information Model/Service.notation | 8294 --------------- ONAP Information Model/Service.uml | 2268 ---- .../StyleSheets/ClassDiagramStyleSheet.css | 16 - .../StyleSheets/CompartmentRestrictions.css | 11 - .../StyleSheets/NoStereotypesDiagram.css | 4 - ONAP Information Model/Ves.di | 2 - ONAP Information Model/Ves.notation | 7985 -------------- ONAP Information Model/Ves.uml | 5599 ---------- ONAP Information Model/Vnf.di | 2 - ONAP Information Model/Vnf.notation | 10642 ------------------- ONAP Information Model/Vnf.uml | 3883 ------- ONAP Information Model/model.di | 2 - ONAP Information Model/model.notation | 2 - ONAP Information Model/model.uml | 37 - ONAP_Information_Model/.project | 11 + ONAP_Information_Model/Common.di | 2 + ONAP_Information_Model/Common.notation | 9266 ++++++++++++++++ ONAP_Information_Model/Common.uml | 5015 +++++++++ .../GenDoc/ONAP GenDoc Template.docx | Bin 0 -> 37783 bytes ...ONAP Model GenDoc Template-Landscape-v4-00.docx | Bin 0 -> 50286 bytes ...odel Glossary Template-Landscape-v4-00 V13.docx | Bin 0 -> 36942 bytes ...plate-Landscape-v4-00 V16 with Stereotypes.docx | Bin 0 -> 38748 bytes .../GenDoc/ONAP Model Structure.docx | Bin 0 -> 44790 bytes ONAP_Information_Model/Infrastructure.di | 2 + ONAP_Information_Model/Infrastructure.notation | 3087 ++++++ ONAP_Information_Model/Infrastructure.uml | 1052 ++ ONAP_Information_Model/License.di | 2 + ONAP_Information_Model/License.notation | 3645 +++++++ ONAP_Information_Model/License.uml | 862 ++ .../ModelStructure/OnapModelStructure.docx | Bin 0 -> 46348 bytes ONAP_Information_Model/Nf.di | 2 + ONAP_Information_Model/Nf.notation | 243 + ONAP_Information_Model/Nf.uml | 137 + ONAP_Information_Model/Ns.di | 2 + ONAP_Information_Model/Ns.notation | 2614 +++++ ONAP_Information_Model/Ns.uml | 743 ++ ONAP_Information_Model/Onap_Profile.profile.di | 2 + .../Onap_Profile.profile.notation | 109 + ONAP_Information_Model/Onap_Profile.profile.uml | 156 + .../OpenModel_Profile.profile.di | 2 + .../OpenModel_Profile.profile.notation | 2212 ++++ .../OpenModel_Profile.profile.uml | 10447 ++++++++++++++++++ ONAP_Information_Model/Party.di | 2 + ONAP_Information_Model/Party.notation | 1577 +++ ONAP_Information_Model/Party.uml | 267 + ONAP_Information_Model/Pnf.di | 2 + ONAP_Information_Model/Pnf.notation | 592 ++ ONAP_Information_Model/Pnf.uml | 224 + ONAP_Information_Model/Policy.di | 2 + ONAP_Information_Model/Policy.notation | 2 + ONAP_Information_Model/Policy.uml | 647 ++ ONAP_Information_Model/Resource.di | 2 + ONAP_Information_Model/Resource.notation | 97 + ONAP_Information_Model/Resource.uml | 44 + ONAP_Information_Model/Service.di | 2 + ONAP_Information_Model/Service.notation | 8294 +++++++++++++++ ONAP_Information_Model/Service.uml | 2268 ++++ .../StyleSheets/ClassDiagramStyleSheet.css | 16 + .../StyleSheets/CompartmentRestrictions.css | 11 + .../StyleSheets/NoStereotypesDiagram.css | 4 + ONAP_Information_Model/Ves.di | 2 + ONAP_Information_Model/Ves.notation | 7985 ++++++++++++++ ONAP_Information_Model/Ves.uml | 5599 ++++++++++ ONAP_Information_Model/Vnf.di | 2 + ONAP_Information_Model/Vnf.notation | 10642 +++++++++++++++++++ ONAP_Information_Model/Vnf.uml | 3883 +++++++ ONAP_Information_Model/model.di | 2 + ONAP_Information_Model/model.notation | 2 + ONAP_Information_Model/model.uml | 37 + docs/ONAP Model Spec/im/BusinessInteraction.rst | 574 - .../im/Common/BusinessInteraction.png | Bin 0 -> 144917 bytes .../im/Common/BusinessInteraction.rst | 582 + .../im/Common/DynamicParameters.png | Bin 0 -> 456495 bytes .../im/Common/DynamicParameters.rst | 492 + .../im/Common/SelectionCriteria.png | Bin 0 -> 375760 bytes .../im/Common/SelectionCriteria.rst | 252 + docs/ONAP Model Spec/im/License/Entitlements.png | Bin 0 -> 42189 bytes docs/ONAP Model Spec/im/License/License.png | Bin 0 -> 50476 bytes docs/ONAP Model Spec/im/License/LicenseKey.png | Bin 0 -> 39933 bytes docs/ONAP Model Spec/im/License/LicenseModel.rst | 1033 ++ docs/ONAP Model Spec/im/License/RootHierarchy.png | Bin 0 -> 48264 bytes docs/ONAP Model Spec/im/License/RootingLicense.png | Bin 0 -> 41320 bytes docs/ONAP Model Spec/im/NSD.rst | 686 -- docs/ONAP Model Spec/im/NSD/NSD.png | Bin 0 -> 159420 bytes docs/ONAP Model Spec/im/NSD/NSD.rst | 688 ++ docs/ONAP Model Spec/im/NSDR4.PNG | Bin 159420 -> 0 bytes .../im/Nested Service final for Rst.PNG | Bin 179392 -> 0 bytes docs/ONAP Model Spec/im/PNF/PNFD.rst | 388 + docs/ONAP Model Spec/im/PNFD.rst | 384 - docs/ONAP Model Spec/im/Root.rst | 751 -- docs/ONAP Model Spec/im/Root/Root.png | Bin 0 -> 421897 bytes docs/ONAP Model Spec/im/Root/Root.rst | 751 ++ docs/ONAP Model Spec/im/Service/NestedService.png | Bin 0 -> 240092 bytes .../im/Service/ServiceModel-Nested Service.rst | 1380 +++ .../im/Service/ServiceModel-Service order.rst | 395 + docs/ONAP Model Spec/im/Service/ServiceOrder.png | Bin 0 -> 349690 bytes .../im/ServiceModel-Nested Service.rst | 613 -- .../im/ServiceModel-Service order.rst | 393 - docs/ONAP Model Spec/im/ServiceOrderR4.PNG | Bin 349690 -> 0 bytes docs/ONAP Model Spec/im/VES index.rst | 14 - docs/ONAP Model Spec/im/VES/VES index.rst | 14 + docs/ONAP Model Spec/im/VNF/VNF-DF.png | Bin 0 -> 1319975 bytes docs/ONAP Model Spec/im/VNF/VNFD-topo.png | Bin 0 -> 2033901 bytes docs/ONAP Model Spec/im/VNF/VNFD.png | Bin 0 -> 1474238 bytes docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst | 3927 +++++++ docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst | 3909 ------- docs/ONAP Model Spec/im/index.rst | 21 +- docs/ONAP Model Spec/index.rst | 2 +- docs/Release-notes/index.rst | 15 - docs/Release-notes/release-notes.rst | 45 +- docs/index.rst | 2 +- 152 files changed, 91773 insertions(+), 89178 deletions(-) delete mode 100644 ONAP Information Model/.project delete mode 100644 ONAP Information Model/Common.di delete mode 100644 ONAP Information Model/Common.notation delete mode 100644 ONAP Information Model/Common.uml delete mode 100644 ONAP Information Model/GenDoc/ONAP GenDoc Template.docx delete mode 100644 ONAP Information Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx delete mode 100644 ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx delete mode 100644 ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx delete mode 100644 ONAP Information Model/GenDoc/ONAP Model Structure.docx delete mode 100644 ONAP Information Model/Infrastructure.di delete mode 100644 ONAP Information Model/Infrastructure.notation delete mode 100644 ONAP Information Model/Infrastructure.uml delete mode 100644 ONAP Information Model/License.di delete mode 100644 ONAP Information Model/License.notation delete mode 100644 ONAP Information Model/License.uml delete mode 100644 ONAP Information Model/ModelStructure/OnapModelStructure.docx delete mode 100644 ONAP Information Model/Nf.di delete mode 100644 ONAP Information Model/Nf.notation delete mode 100644 ONAP Information Model/Nf.uml delete mode 100644 ONAP Information Model/Ns.di delete mode 100644 ONAP Information Model/Ns.notation delete mode 100644 ONAP Information Model/Ns.uml delete mode 100644 ONAP Information Model/Onap_Profile.profile.di delete mode 100644 ONAP Information Model/Onap_Profile.profile.notation delete mode 100644 ONAP Information Model/Onap_Profile.profile.uml delete mode 100644 ONAP Information Model/OpenModel_Profile.profile.di delete mode 100644 ONAP Information Model/OpenModel_Profile.profile.notation delete mode 100644 ONAP Information Model/OpenModel_Profile.profile.uml delete mode 100644 ONAP Information Model/Party.di delete mode 100644 ONAP Information Model/Party.notation delete mode 100644 ONAP Information Model/Party.uml delete mode 100644 ONAP Information Model/Pnf.di delete mode 100644 ONAP Information Model/Pnf.notation delete mode 100644 ONAP Information Model/Pnf.uml delete mode 100644 ONAP Information Model/Policy.di delete mode 100644 ONAP Information Model/Policy.notation delete mode 100644 ONAP Information Model/Policy.uml delete mode 100644 ONAP Information Model/Resource.di delete mode 100644 ONAP Information Model/Resource.notation delete mode 100644 ONAP Information Model/Resource.uml delete mode 100644 ONAP Information Model/Service.di delete mode 100644 ONAP Information Model/Service.notation delete mode 100644 ONAP Information Model/Service.uml delete mode 100644 ONAP Information Model/StyleSheets/ClassDiagramStyleSheet.css delete mode 100644 ONAP Information Model/StyleSheets/CompartmentRestrictions.css delete mode 100644 ONAP Information Model/StyleSheets/NoStereotypesDiagram.css delete mode 100644 ONAP Information Model/Ves.di delete mode 100644 ONAP Information Model/Ves.notation delete mode 100644 ONAP Information Model/Ves.uml delete mode 100644 ONAP Information Model/Vnf.di delete mode 100644 ONAP Information Model/Vnf.notation delete mode 100644 ONAP Information Model/Vnf.uml delete mode 100644 ONAP Information Model/model.di delete mode 100644 ONAP Information Model/model.notation delete mode 100644 ONAP Information Model/model.uml create mode 100644 ONAP_Information_Model/.project create mode 100644 ONAP_Information_Model/Common.di create mode 100644 ONAP_Information_Model/Common.notation create mode 100644 ONAP_Information_Model/Common.uml create mode 100644 ONAP_Information_Model/GenDoc/ONAP GenDoc Template.docx create mode 100644 ONAP_Information_Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx create mode 100644 ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx create mode 100644 ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx create mode 100644 ONAP_Information_Model/GenDoc/ONAP Model Structure.docx create mode 100644 ONAP_Information_Model/Infrastructure.di create mode 100644 ONAP_Information_Model/Infrastructure.notation create mode 100644 ONAP_Information_Model/Infrastructure.uml create mode 100644 ONAP_Information_Model/License.di create mode 100644 ONAP_Information_Model/License.notation create mode 100644 ONAP_Information_Model/License.uml create mode 100644 ONAP_Information_Model/ModelStructure/OnapModelStructure.docx create mode 100644 ONAP_Information_Model/Nf.di create mode 100644 ONAP_Information_Model/Nf.notation create mode 100644 ONAP_Information_Model/Nf.uml create mode 100644 ONAP_Information_Model/Ns.di create mode 100644 ONAP_Information_Model/Ns.notation create mode 100644 ONAP_Information_Model/Ns.uml create mode 100644 ONAP_Information_Model/Onap_Profile.profile.di create mode 100644 ONAP_Information_Model/Onap_Profile.profile.notation create mode 100644 ONAP_Information_Model/Onap_Profile.profile.uml create mode 100644 ONAP_Information_Model/OpenModel_Profile.profile.di create mode 100644 ONAP_Information_Model/OpenModel_Profile.profile.notation create mode 100644 ONAP_Information_Model/OpenModel_Profile.profile.uml create mode 100644 ONAP_Information_Model/Party.di create mode 100644 ONAP_Information_Model/Party.notation create mode 100644 ONAP_Information_Model/Party.uml create mode 100644 ONAP_Information_Model/Pnf.di create mode 100644 ONAP_Information_Model/Pnf.notation create mode 100644 ONAP_Information_Model/Pnf.uml create mode 100644 ONAP_Information_Model/Policy.di create mode 100644 ONAP_Information_Model/Policy.notation create mode 100644 ONAP_Information_Model/Policy.uml create mode 100644 ONAP_Information_Model/Resource.di create mode 100644 ONAP_Information_Model/Resource.notation create mode 100644 ONAP_Information_Model/Resource.uml create mode 100644 ONAP_Information_Model/Service.di create mode 100644 ONAP_Information_Model/Service.notation create mode 100644 ONAP_Information_Model/Service.uml create mode 100644 ONAP_Information_Model/StyleSheets/ClassDiagramStyleSheet.css create mode 100644 ONAP_Information_Model/StyleSheets/CompartmentRestrictions.css create mode 100644 ONAP_Information_Model/StyleSheets/NoStereotypesDiagram.css create mode 100644 ONAP_Information_Model/Ves.di create mode 100644 ONAP_Information_Model/Ves.notation create mode 100644 ONAP_Information_Model/Ves.uml create mode 100644 ONAP_Information_Model/Vnf.di create mode 100644 ONAP_Information_Model/Vnf.notation create mode 100644 ONAP_Information_Model/Vnf.uml create mode 100644 ONAP_Information_Model/model.di create mode 100644 ONAP_Information_Model/model.notation create mode 100644 ONAP_Information_Model/model.uml delete mode 100644 docs/ONAP Model Spec/im/BusinessInteraction.rst create mode 100644 docs/ONAP Model Spec/im/Common/BusinessInteraction.png create mode 100644 docs/ONAP Model Spec/im/Common/BusinessInteraction.rst create mode 100644 docs/ONAP Model Spec/im/Common/DynamicParameters.png create mode 100644 docs/ONAP Model Spec/im/Common/DynamicParameters.rst create mode 100644 docs/ONAP Model Spec/im/Common/SelectionCriteria.png create mode 100644 docs/ONAP Model Spec/im/Common/SelectionCriteria.rst create mode 100644 docs/ONAP Model Spec/im/License/Entitlements.png create mode 100644 docs/ONAP Model Spec/im/License/License.png create mode 100644 docs/ONAP Model Spec/im/License/LicenseKey.png create mode 100644 docs/ONAP Model Spec/im/License/LicenseModel.rst create mode 100644 docs/ONAP Model Spec/im/License/RootHierarchy.png create mode 100644 docs/ONAP Model Spec/im/License/RootingLicense.png delete mode 100644 docs/ONAP Model Spec/im/NSD.rst create mode 100644 docs/ONAP Model Spec/im/NSD/NSD.png create mode 100644 docs/ONAP Model Spec/im/NSD/NSD.rst delete mode 100644 docs/ONAP Model Spec/im/NSDR4.PNG delete mode 100644 docs/ONAP Model Spec/im/Nested Service final for Rst.PNG create mode 100644 docs/ONAP Model Spec/im/PNF/PNFD.rst delete mode 100644 docs/ONAP Model Spec/im/PNFD.rst delete mode 100644 docs/ONAP Model Spec/im/Root.rst create mode 100644 docs/ONAP Model Spec/im/Root/Root.png create mode 100644 docs/ONAP Model Spec/im/Root/Root.rst create mode 100644 docs/ONAP Model Spec/im/Service/NestedService.png create mode 100644 docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst create mode 100644 docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst create mode 100644 docs/ONAP Model Spec/im/Service/ServiceOrder.png delete mode 100644 docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst delete mode 100644 docs/ONAP Model Spec/im/ServiceModel-Service order.rst delete mode 100644 docs/ONAP Model Spec/im/ServiceOrderR4.PNG delete mode 100644 docs/ONAP Model Spec/im/VES index.rst create mode 100644 docs/ONAP Model Spec/im/VES/VES index.rst create mode 100644 docs/ONAP Model Spec/im/VNF/VNF-DF.png create mode 100644 docs/ONAP Model Spec/im/VNF/VNFD-topo.png create mode 100644 docs/ONAP Model Spec/im/VNF/VNFD.png create mode 100644 docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst delete mode 100644 docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst delete mode 100644 docs/Release-notes/index.rst diff --git a/ONAP Information Model/.project b/ONAP Information Model/.project deleted file mode 100644 index dcd9a6c..0000000 --- a/ONAP Information Model/.project +++ /dev/null @@ -1,11 +0,0 @@ - - - ONAP Information Model - - - - - - - - diff --git a/ONAP Information Model/Common.di b/ONAP Information Model/Common.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Common.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Common.notation b/ONAP Information Model/Common.notation deleted file mode 100644 index b7b99e1..0000000 --- a/ONAP Information Model/Common.notation +++ /dev/null @@ -1,9266 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - multiplicity - visibility - name - type - modifiers - derived - - - - - - - - - - - - multiplicity - visibility - name - type - modifiers - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Common.uml b/ONAP Information Model/Common.uml deleted file mode 100644 index d3720eb..0000000 --- a/ONAP Information Model/Common.uml +++ /dev/null @@ -1,5015 +0,0 @@ - - - - - - - - - - - - - - - - - The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature. - - - - Provides the signature of the signed part of the descriptor. - - - - - - Identifies the algorithm used to compute the signature. - - - - - - Provides a certificate or a reference to a certificate to validate the signature. -NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD - - - - - - - - This primitive type defines the version of an element. - - - - - type string { - pattern - '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; } - -A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. - -The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6 "; - reference - "RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace" - - - - - type string; - -The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66. - -Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1. - -The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent. - -Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate. - -A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required. - -In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017. - reference - "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax - RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations - RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs)" - - - - - Primitive type describing a rule. - - - - - This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real. - - - - - priority - processing priority. - - - - - - - - - - object - objects are model elements that represent instances of a class or of classes - - - - - key - the key datatype is a tuple which provides the name of a key along with its value and relative order. - - - - - keyName - Name of the key. - - - - - - - keyOrder - Relative sequence or order of the key (with respect to other keys). - - - - - - - - - keyValue - Value of the key. - - - - - - - - - - Specifies the type of rule. - - - - - - - Defines the scope of the rule. - - - - - - - - - A base / value business entity used to represent a period of time, between two timepoints - - - - An instant of time, starting at the TimePeriod - -Notes: -If null, then represents to the beginning of time - - - - - An instant of time, ending at the TimePeriod: - -Notes: -If null, then represents to the end of time - - - - - - DateTime - RFC 2822 standard date/time format. - -RFC 2822 format -day-of-week, dd MM yyyy HH’:’mm’:’ss ‘GMT’ - -e.g. Tue, 21 Jun 2016 14:05:20 GMT - - - - - the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds - - - - - A primitive Type - - - - - - - Legend -Blue - Review Complete -Green - Ready for Review -White - Not Ready for Review - - - configurableProperties is a datatype - - - Does NF have a direct asociation to elementgroups, or would that be through a df? - - - Onboarding?? - - - Onboarding - - - Abstract - - - Concrete - - - Design Time - - - Runtime - - - Attributes in Pink are adds (not in IFA 01 - - - - -
- - - - - - - - - - - - Common part of the various VLDs. - - - - - Uniquely identifies a VLD in the parent descriptor. -For VnfVirtualLinkDesc, the parent descriptor is the VNFD. -For NsVirtualLinkDesc, the parent descriptor is the NSD. -Note: the description of this class are different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition merges the 2 definitions. - - - - - Specifies the protocol exposed by a VL and the flow pattern supported by the VL. - - - - - Provides human-readable information on the purpose of the VL (e.g. control plane traffic). - - - - - - - - - A set of connection points along with the connectivity relationship between them and any associated target performance metrics (e.g. bandwidth, latency, QoS). NOTE: The Virtual Link can interconnect two or more entities (VNF components, VNFs, or PNFs) and it is supported by a Virtual Network (VN) of the NFVI. - - - - Link ports of this VL. - - - - - - - Identifier of the virtual link instance. - - - - - An intelligent or human readable name of the virtual link instance. - - - - - - Additional intelligent or human readable name of the virtual link instance. - - - - - - Generic description of the type of Virtual Link - - - - - - Role in the network this virtual link will be providing - - - - - - English description of the function this specific virtual link will be providing - - - - - - virtual link assigned (actual) bandwidth - - - - - - provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED - - - - - - Administrative status of the virtual link - - - - - - Specifies the minimum bitrate requirements for the virtual link - - - - - Specifies the maximum bitrate requirements for the virtual link - - - - - Indicates whether DHCP is enabled - - - - - - Indicates whether VLAn transparent mode is supported - - - - - - Indicates whether Trunk Mode is enabled - - - - - - Outer vlan tag - - - - - - - Inner vlan tag - - - - - - Identified the layerProtocol and flowPattern used by the virtual link - - - - - - Represents the port of the link. - - - - CP to be connected to this link port. - - - - - - - - Parent for all connection point classes. - - - - Identifier of the connection point instance. - - - - - Name of the Cp instance. - - - - - - alternative name of the Cp instance. - - - - - - Generic description of the type of Cp - - - - - - Role in the network this Cp will be providing - - - - - - English description of the function this specific Cp will be providing - - - - - - Cp description - - - - - - Cp (max? assigned?) bandwidth - - - Cp assigned (actual) bandwidth - - - - - - provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED - - - - - - Administrative status of the connection point. - - - - - - Protocol used by the Cp - - - - - - Indicator whether the Cp is in trunk mode - - - - - - Type of address: MAC address or IP address - - - - - - Only present when addressType is MAC address - - - - - - - Only present when addressType is IP address - - - - - - - - The Cpd class specifies the characteristics of connection points attached to NFs and NSs. This is an abstract class used as parent for the various Cpd classes. - -Note 1: the description of this class is different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition uses the definition in ETSI GS NFV IFA 014 as it is the more general. - - - - Identifier of this Cpd information element. - - - - - - Identifies the role of 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. - - - - - - - - - Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). - - - - - - - - - Identifies the 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 "layerProtocol" still needs further discussion and not included in this table. - - - - - - - - Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). - - - - - - - Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.). - - - - - - - Reference of the security group rules bound to this CPD. - - - - - - - - The AffinityOrAntiAffinityGroup class describes the affinity or anti-affinity relationship. For NSs, those rules are applicable between the VNF instances created using different VnfProfiles, the Virtual Link instances created using different VlProfiles or the nested NS instances created using different NsProfiles. - -For VNFs, those rules are applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s). - - - - Identifies an affinity or anti-affinity group to which the affinity or anti-affinity rule applies. - - - - - - Specifies whether the rule is an affinity rule or an anti-affinity rule. - - - - - Specifies the scope of the rule. - - - - - - - - - - - PlatformDescriptor is an abstract class that extends Descriptor to represent classes of objects that represent platofrm or internal descriptors. - - - - - ID that spans multiple versions of the same descriptor. - - - - - Type/Role/Function (a datatype). Classification may be a base type. - - - - - - - - - - - - - OnboardingNfDescriptor is an abstract class that extends Descriptor to represent classes of objects that represent onboarded network function descriptors. - - - - - Provider of the NF and of the NFD being onboarded. - - - - Provider of the NF and of the NFD being onboarded. - - - - - - - Human readable name for the NF Product. Can change during the NF Product lifetime. - - - - - - - - - Software version of the NF. This is changed when there is any change to the software that is included in the NF Package. - - - - - - - Information about localization languages of the NF (includes e.g. strings in the NFD). - -NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at NF instantiation time. - - - - valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html - - - - - - - - - Human readable description of the NF Product. Can change during the NF Product lifetime. - - - - - - - - - Default localization language that is instantiated if no information about selected localization language is available. - - - - valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html - - - condition: Shall be present if "localizationLanguage" is present and shall be absent otherwise. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - PlatformNfDescriptor is an abstract class that extends PlatformDescriptor to represent classes of design time objects that represent internal, or platform network function descriptors. - - - - - - - - - - - - - - - - - The VirtualLinkProfile class specifies a profile for instantiating VLs of a particular NS DF according to a specific VLD and VL DF. - - - - Uniquely identifies this VirtualLinkProfile class. - - - - - Identifies a flavour within the VLD. - - - - - - Specifies affinity and anti-affinity rules applicable between VLs instantiated from the referenced VLD. - - - - - - - Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. -NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group. - - - - - - - Specifies the maximum bitrate requirements for a VL instantiated according to this profile. -NOTE: These attributes are used to control scaling boundaries. - - - - - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. -NOTE: These attributes are used to control scaling boundaries. - - - - - Uniquely references a VLD. - - - - - - - - - - The CpdPool class specifies a pool of descriptors of connection points and service access points. - - - - Identifier of this CpdPool class. It identifies a pool of descriptors of connection points and NS SAPs. - - - - - - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - -
- - - - - -
- - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - -
- - - - - - - - The AddressData information element supports providing information about the addressing scheme and parameters applicable to a CP. - - - - Describes the type of 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. - - - - - - Provides the information on the MAC addresses to be assigned to the CP(s) instantiated from the parent CPD. -Shall be present when the addressType is MAC address. - - - - - - - Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD. -Shall be present when the addressType is IP address. - - - - - - - - The ConnectivityType datatype specifies the protocol exposed by a VL and the flow pattern supported by the VL.The top layer protocol of the VL protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers. - - - - Identifies the protocols to which this VL gives access (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire). - - - - - - Identifies the flow pattern of the connectivity (Line, Tree, Mesh). - - - - - - - - - A CpProtocolData information element describes and associates the protocol layer that a CP uses together with other protocol and connection point information. - - - - One of the values of the attribute layerProtocol of the Cpd IE. - - - - - - Provides information on the address to be assigned to the CP(s) instantiated from the CPD. - - - - - - - - The L2AddressData information element supports providing information about Layer 2 level addressing applicable to a CP. - - - - Specify if the MAC address 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. - - - - - - - - The L3AddressData information element supports providing information about Layer 3 level addressing scheme and parameters applicable to a CP. - - - - Specify if the address 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. - - - - - - - Specify if the floating IP scheme is activated on the CP or not. - - - - - - Define address type. - -NOTE: The address type should be aligned with the address type supported by the layerProtocol attribute of the parent Cpd. - - - - - - - - Minimum number of IP addresses to be assigned based on this L3AddressData information element. - - - - - - - - - Identifies the protocol to which this VL gives access. - - - - - - - - - - - The LinkBitrateRequirements information element describes the requirements in terms of bitrate for a VL. - - - - Throughput requirement of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN). - - - - - - Throughput requirement 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). - - - - - - - - - The LocalAffinityOrAntiAffinityRule describes the affinity or anti-affinity rule applicable between the virtualization containers to be created based on a particular VDU, or between internal VLs to be created based on a particular VnfVirtualLinkDesc. -Per VNF, the affinity/anti-affinity rules defined using this information element, using the AffinityOrAntiAffinityGroup information element, and using the placement constraints in the GrantLifecycleOperation as defined in ETSI GS NFV IFA 007 [i.3] should be conflict-free. In case of conflicts, the placement constraints in the GrantLifecycleOperation shall take precedence. - - - - - Specifies whether the rule is an affinity rule or an anti-affinity rule. - - - - - - Specifies the scope of the rule. - - - - - - The L2ProtocolData information element describes the L2 protocol related data for a virtual link. - - - The L2ProtocolData information element describes the L2 protocol related data for a virtual link. - - - - Network name associated with this L2 -protocol. - - - - - - - - Specifies the network type for this L2 -protocol. Possible values: FLAT, VLAN, -VXLAN, GRE. - -Note: If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value -is provided at design time in the VNFD. If a default value is provided at design-time, this value may be -overridden at run-time. - - - - - - - Specifies whether to support VLAN -transparency for this L2 protocol or not. - - - - - - - - Specifies the maximum transmission unit -(MTU) value for this L2 protocol. - - - - - - - - Network segment ID. - - - - - - - - The connected physical network of network type (VLAN or VxLAN) . - - - - - - - - Specify if a vrouter comes from an external network. - - - - - - - - - Specifies the network type for this L2 protocol. - - - - - - - - - The L3ProtocolData information element describes the L3 protocol related data for a virtual link. - - - The L3ProtocolData information element describes the L3 protocol related data for a virtual link. - - - - Network name associated with this L3 -protocol. - - - - - - - - Specifies IP version of this L3 protocol. -Value: -• IPV4. -• IPV6. - -NOTE : The value of the ipVersion attribute shall be consistent with the value of the layerProtocol attribute of the -ConnectivityType IE . - - - - - Specifies the CIDR (Classless Inter- -Domain Routing) of this L3 protocol. - -NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value -is provided at design time in the VNFD. If a default value is provided at design-time, this value may be -overridden at run-time. - - - - - - Specifies the allocation pools -with start and end IP addresses for this L3 -protocol. - -NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value -is provided at design time in the VNFD. If a default value is provided at design-time, this value may be -overridden at run-time. - - - - - - - Specifies the gateway IP address for this -L3 protocol. - -NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value -is provided at design time in the VNFD. If a default value is provided at design-time, this value may be -overridden at run-time. - - - - - - - - Indicates whether DHCP (Dynamic Host -Configuration Protocol) is enabled or -disabled for this L3 protocol. - -NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value -is provided at design time in the VNFD. If a default value is provided at design-time, this value may be -overridden at run-time. - - - Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. - - - - - - - - Specifies IPv6 address mode. Possible -values: -• SLAAC. -• DHCPV6-STATEFUL. -• DHCPV6-STATELESS. -May be present when the value of the -ipVersion attribute is "IPV6" and shall be -absent otherwise. - -NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value -is provided at design time in the VNFD. If a default value is provided at design-time, this value may be -overridden at run-time. - - - - - - - Specifies IPv6 address mode for vrouter. Possible values: - -• SLAAC. - -• DHCPV6-STATEFUL. - -• DHCPV6-STATELESS. - -May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. Must be present when the VLAN/VXLAN connects to one or more vrouters. - -Note: The value of ipv6RaMode and ipv6AddressMode must be same. - - - - - - - - Static routing list, including estination and nexthop information. - - - - - - - DNS server list. - - - - - - - - - Specifies IPv6 address mode. -May be present when the value of the -ipVersion attribute is IPV6 and shall be -absent otherwise. - - - - - - - - Specifies IP version of this L3 protocol. -Value: -• IPV4. -• IPV6. - - - - - - - The QoS datatype specifies quality of service parameters applicable to a VL. -It is the asbstract parent of the NsQos and VnfQos datatypes, as the NsQoS (QoS in ETSI GS NFV IFA 014) includes a priority attribute, while VnfQoS (QoS in ETSI GS NFV IFA 011) does not. - - - - - Maximum latency in ms. - - - - - - Maximum jitter in ms. - - - - - Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. - - - - - - - Qos ID. - - - - - Human readable Qos name. - - - - - - Detailed requirements of Qos, including maximum bandwidth limitation{max_kbps}、maximum burst bandwidth limitation{max_burst_kbps} 、direction{egress|ingress}，etc. - - - - - - - - Type of address - - - - - - - - - A set of common business entities that collectively serve as the foundation of the ONAP Information Model.. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence. - - - - -
- - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters. - - - - - - - - - - - - -
- - - - -
- - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - Perhaps all these attributes can be moved up to OnboardingNfDescriptor - - - Add tosca.nodes.nfvl.nf attributes here (from https://wiki.onap.org/pages/viewpage.action?pageId=45303981) - - - - defaultLocalizationLangauge- string, not required (*) goes to OnboardingNfDescriptor - - - Perhaps put Polilcy, Descriptor under Entity - - - Should ManagedEntity be a subclass or an aggregation? - - - Do we root business interaction - - - can digitally communicate - - - Mgmt Domain - - - Note: This concept has some basis on the TMF SID Characteristic Pattern. - - - Colored classes are examples in the context of tis proposal. - - - - - - - valueMin<valueMax - - - - - This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment. - - - - Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). - - - - - - - - Defines a textual free-form description of the object. - - - - - - - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - - - Identifier of this information element. This attribute shall be globally unique. - - - - - - - This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment. - - - - - - - Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain - - - - - - A ManagedEntity is used to specify that an Entity is manageable by electronic means. - - - - This is an enumerated integer that defines the particular type of management method that is currently being used. - -Permitted Values: - 0: Unknown - 1: None - 2: CLI - 3: SNMP - 4: TL1 - 5: CMIP - 6: Proprietary - - - - - - This is an array of integers that define the different management methods that are supported by this object. - -Permitted Values: - - 0: Unknown - 1: None - 2: CLI - 3: SNMP - 4: TL1 - 5: CMIP - 6: Proprietary - - - - - - - - - A template which describes an OperationalEntity in terms of deployment and operational behavior requirements. - - - Note: The only fields being used in this class are Name and MRN (manufactureReferenceNumber. The rest are optional. - - - - - The period during which the design entity is valid. - - - - - - - The condition of the specification, such s active, inactive, or planned. - - - - - - Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). - - - - - - Defines a textual free-form description of the object. - - - - - - - An OperationalEntity is a deployment in a NFV environment of a DesignEntity. - - - - - - SelectionCriteria finds descriptors and instances according to specific properties of those entities. - - - - Unique indentifier of this SelectionCriteria. - - - - - - - A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations. - - - - - Logical operation for filters composition, e.g. logical AND, OR, XOR. - - - - - - A simple (atomic) selection criteria that holds a specific attribute comparision expression. - - - - - Name of compared parameter or attribute. - - - - Name of compared parameter or attribute. - - - - - - - Comparison operator, e.g. equal, less than, greater or etc. - - - - - - Compared value (can be a name of a parameter in referenced class). - - - - - - The type of the value property (String, Integer, Real, ...). - - - - - - - A group of parameters that somehow relate or work together. - - - - Name of ParameterGroup - - - - - - Description of ParameterGroup. - - - - - - ID of ParameterGroup. - - - - - - Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime). - - - - Name of parameter. - - - - - - Boolean that specifices if this parameter is an input parameter. - - - - - - Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). - - - - - - - Bolean that specifices if the value can be modified or changed during the life of this parameter. - - - - - - The type of this parameter (integer, string, ...). - - - - - - A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. - - - - - - - - Description of the parameter. - - - - - - - The actual value of Parameter (runtime). - - - - Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. - - - - - The actual value of Parameter (runtime). - - - - - - - RangeValueSpec is generally expected to be of valueType integer or - - - RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter. - - - valueTo should be greater than valueFrom - - - rangeStep should be greater than zero. - - - - - rangeStep>0 - - - - - - The minimum value that a Parameter can take on. - - - - - - The maximum value that the parameter can take on. - - - - - - The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and valueTo attributes. - - - - - - - - - - DiscreteValueSpec represents a specific valid value that a given Parameter can take on. - - - - - A discrete value that the Parameter can take on. - - - - - - - A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec). - - - - - - - The operator being applied to to some group of selectoin critiera. - - - - - - - - The operator being applied to some atomic selection critera. - - - - - - - - Dynamic, configurable properites of some entity. - - - - The specific configurable properties of some entity. - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - Associates a business interction that is referenced by a business interction - - - - - - - - - -
- - - Associates a business interaction that references - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - - - PolicyEvent is part of another effort, and is NOT agreed to at this time. - - - ServiceOrder and VesEvent are part of other contributions, and have already been accepted. - - - - - - A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law. - - - - - A reference number assigned to an Agreement that follows a prescribed numbering system. - - - - - - An overview and goals of the Agreement. - - - - - - - A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements. - - - - - Date interaction initiated - - - - - The date on which an interaction is closed or completed. - - - - - The current condition of an interaction, such as open, in research, closed, and so forth - - - - - - - - - The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource. - - - - Quantity of an interaction item involved in an interaction. - - - - - - The action to take for an InteractionItem, such as add, change, remove. - - - - - - - The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec. - - - - - Version of the business interaction. - - - - - The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction. - - - - - - A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction. - - - - - - A reply to a Request - - - - - - - An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement. - - - - A categorization of the relationship, such as bulk, parent/child, and so forth. - - - - - - Time period for which the relationship is valid - - - - - - - The type of relationship such as contains, relies on. - - - - - - Time period for which the relationship is valid - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/GenDoc/ONAP GenDoc Template.docx b/ONAP Information Model/GenDoc/ONAP GenDoc Template.docx deleted file mode 100644 index 587fbb0..0000000 Binary files a/ONAP Information Model/GenDoc/ONAP GenDoc Template.docx and /dev/null differ diff --git a/ONAP Information Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx b/ONAP Information Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx deleted file mode 100644 index d791ec3..0000000 Binary files a/ONAP Information Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx and /dev/null differ diff --git a/ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx b/ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx deleted file mode 100644 index fe4e301..0000000 Binary files a/ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx and /dev/null differ diff --git a/ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx b/ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx deleted file mode 100644 index 3b8b427..0000000 Binary files a/ONAP Information Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx and /dev/null differ diff --git a/ONAP Information Model/GenDoc/ONAP Model Structure.docx b/ONAP Information Model/GenDoc/ONAP Model Structure.docx deleted file mode 100644 index 5fac349..0000000 Binary files a/ONAP Information Model/GenDoc/ONAP Model Structure.docx and /dev/null differ diff --git a/ONAP Information Model/Infrastructure.di b/ONAP Information Model/Infrastructure.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Infrastructure.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Infrastructure.notation b/ONAP Information Model/Infrastructure.notation deleted file mode 100644 index bc2aecd..0000000 --- a/ONAP Information Model/Infrastructure.notation +++ /dev/null @@ -1,3087 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Infrastructure.uml b/ONAP Information Model/Infrastructure.uml deleted file mode 100644 index a1f6eca..0000000 --- a/ONAP Information Model/Infrastructure.uml +++ /dev/null @@ -1,1052 +0,0 @@ - - - - - - -
- - - - - - - - -
- - - Public cloud providers may not provide all their flavours in all of their regions. - - - - - - - - - - - - -
- - - - - -
- - - - - - - - - -
- - - The public cloud provider provides global API end points from which a user can manage their leased resources in any of the regions. - - - - - - - - - - -
- - - - - - -
- - - - - - - - - -
- - - - - - -
- - - - - - - - - - - - -
- - - The physical data center has various compute flavours defined. These flavours may be universal across all the physical data centers, or may be local. - - - - - - - - - - - - -
- - - The provider may support various transport options for access to the cloud and for inter-region transport. - - - - - - -
- - - If regional availability zones are provided, they may be run by remote control planes (alternatively via the federated cloud control plane). - - - - - - - - -
- - - Physical data centers may be organized into regional availability zones. - - - - - - - - -
- - - If the physical data center isn't run by a remote control plane, it has a local control plane, or may be partitioned into several local control planes. - - - - - - - - - - -
- - - If Network Zone is defined, the Local Control Plane belongs to a Network Zone. - - - - - - - - - -
- - - The Network Zone is created as part of the physical design of the data center. Only large data centers are likely to have more than one Network Zone. - - - - - - - - - - -
- - - Like OpenStack, the local control plane may configure one or more local availability zones. These help with placement requirements. - - - - - -
- - - - - - - - - - - - -
- - - A Compute Node is made a member of a local control plane. - - - - - - - - - -
- - - The compute node is made into a member of a local availability zone. - - - - - - - - - - -
- - - The Resource Profile describes the physical hardware and hypervisor of the compute node. - - - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - -
- - - - - - -
- - - If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. - - - - - - -
- - - If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. - - - - - - -
- - - If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. - - - - - - -
- - - - - - - - - -
- - - If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. - - - - - - -
- - - This relationship is part of the physical design of the data center. - - - - - - - - -
- - - This relationship is part of the physical design of the data center. - - - - - - - - - - REMINDER: This is an information model, which identifies all the key entities, relations and attributes in the (cloud) Infrastructure domain. This is not a data model for implementation. - - - The information elements for a public cloud. - - - Should the model include the possibility of a network latency and jitter map, e.g., that could be instrumented by ONAP between the public cloud regions and availability zones that it plans to use? - - - A&AI: complex - - - A&AI: cloud-region - - - A&AI: pserver - - - XOR - - - - -
-
-
-
-
- - - - - - - - -
-
-
-
-
- - - - - - - - - - - - PublicCloud Region is a public cloud provider's set of cloud data centers in a limited geography (e.g., a metropolitan area) and within a single jurisdictional boundary. - - - - - - - - The public cloud provider's name for the region. -Example, Microsoft Azure has regions "East US" and "East US 2". - - - - - - The city, and/or state or province, and country where the PublicCloudRegion is.  Note that the public cloud providers typically at best provide a city name for where the PublicCloudRegion and its availability zones are located. -E.g., Amazon AWS "US West" is in Northern California; "EU-West-2" is in London, "EU-West-3" is in Paris. -E.g., Microsoft Azure "US Central" is in Iowa; "US East 2" is in Virginia; one has to search through non-Microsoft public records to find out that "US East 2" may be in Boydton, Virginia. - - - - - - - - A distinct location within a PublicCloudRegion that is insulated from failures in other Availability Zones, and provides inexpensive, low-latency network connectivity to other Availability Zones in the same region. - - - - - - - - VirtualComputeFlavour represents the virtual machine sizes made available by the cloud provider (called vmSize in Azure, Instance Type in AWS, Machine Type in Google Cloud). - - - - The name that the cloud provider uses for this flavour. -E.g., Azure has a Standard_H8m with specifications like 8 vCPU, 112 GiB memory, 1000 GiB SSD ephemeral storage and a maximum of 2 NICs. - - - - - - Human readable description of the flavour. - - - - - - Number of virtual CPUs. -(implicitly assumes a "standard" or normalized vCPU). - - - - - - Virtual memory size in some units (e.g., MB, GB, GiB). - - - - - - The maximum size, in some units, of the root disk allowed for this flavour. If not specified, it may default to the size of the software image used in constructing the virtual machine. - - - - - - - Name-value pairs for additional information about the flavour, typically specific to a cloud-provider. Some examples include: swap disk size, maximum attachable disk count, maximum NICs, maximum cached throughput IOPs. - - - - - - - Hardware Platform Awareness attributes available in this flavour. - - - - - - - - - - The variety of cloud orchestration. - - - - - The ONAP instance has an account and credentials with the PublicCloudProvider. - - - - - The ONAP instance has an Account and Credentials with the PublicCloudProvider. - - - - - - - - - - - - There may be various options for transport to the cloud and between regions in the cloud. - - - - - The public cloud provider typically supports some virtualization file formats natively and provides translation utilities for other image formats. Software images and data disk images use these formats. -The image formats include: -- AMI - Amazon Machine Image -- VHD/VHDX - Virtual Hard Disk -- VMDK - ESX Virtual Machine Disk -- Raw -- QCOW2 -- ISO -- Docker container format - - - - List of native virtualization file formats supported by the cloudtype. - - - - - - - - The set of virtualization file formats for which the cloud provider makes translation-support available. - - - - - - - - - - Types of storage provided by the cloud provider. - - - - - The networking capabilities afforded by the cloud, e.g., are packet-forwarding VNFs allowed? e.g., is Ethernet VPN supported?, etc. - - - - - - - - - - - - - - - - Typically anti-IP-spoofing blocks packet forwarding, and in some clouds it may not be permitted/possible to turn this off. - - - - - - - The cloud provider (owner) may provide a federated view of the cloud data centers, e.g., provide global API endpoints. To facilitate operation in the cloud, identity, authentication and authorization should be federated. - - - - The variety of cloud orchestration. - - - - - The ONAP instance has an account and credentials with the PublicCloudProvider. - - - - - The ONAP instance has an Account and Credentials with the PublicCloudProvider. - - - - - - - - - - - The cloud may have a control plane that is remote - i.e., apart from agents, not co-located with the physical data center. This opens the possibility of a single remote control plane managing several physical data centers. - - - - - - - - - The control plane for the data center may be local rather than remote. The data center itself may be divided up among more than one local control plane. - - - - - - - - - - The physical data center in the owner operated cloud is at precisely known coordinates, unlike the public cloud region. The physical data center can range from a large installation to a rack of servers in a road-side cabinet. - - - - - - - - - - - - - - - - - - - - - - - Several edge physical data centers may be grouped together into a regional availability zone; e.g., these may be associated with a single instance of a remote control plane. - - - - - - - - - - The physical data center may be partitioned into local availability zones, one or more per local control plane. - - - - - This is the physical compute server, or in OpenStack parlance, a host. These are visible in the OpenStack Compute API to users with the administrative role. They may be similarly be visible in other implementations of an Owner-Operated Cloud. - - - - - - - - - - Total, used and available vCPUs, memory, local storage; -SR-IOV VFs? E.g., in OpenStack, this is visible in the Compute API to users with the administrative role, and similarly may be visible in other owner-operated cloud implementations. The compute node capacity measure can be rolled up to availability zone, or other levels of aggregation. - - - - - - A hardware and hypervisor profile for the Compute Node. This will include HPA attributes. A profile will typically apply to many Compute Nodes. - - - - Hardware Platform Awareness attributes available in this flavour. - - - - - - - - Network Zone reflects the organization of the network fabric and the WAN edges of the data center. Network Zone information goes beyond what e..g, OpenStack APIs expose to users with the administrative role; in fact, this information is not in OpenStack. One can think of implementations where this information is made available from the cloud to ONAP for the purpose of very precise placement. - - - - - Data center rack. - - - - - - - - - - - The list of cloud providers that the ONAP instance is configured to use, including any owner-operated (private) clouds. -ONAP should provide a default list, that the ONAP operator can customize. - - - - - - - - Element representing an owner-operated cloud. - - - - - - The major variety of cloud orchestration. ONAP should have a default list that the ONAP operator can customizie. - - - - Microsoft Azure - - - - - Amazon Web Services EC2 - - - - - VMWare Integrated OpenStack - - - - - - - - -
-
-
-
-
- - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/License.di b/ONAP Information Model/License.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/License.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/License.notation b/ONAP Information Model/License.notation deleted file mode 100644 index 6ffcb20..0000000 --- a/ONAP Information Model/License.notation +++ /dev/null @@ -1,3645 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/License.uml b/ONAP Information Model/License.uml deleted file mode 100644 index 7a2cae7..0000000 --- a/ONAP Information Model/License.uml +++ /dev/null @@ -1,862 +0,0 @@ - - - - - - VLM is really just a Party - -'Simplified' attributes for this Vendor are VendorName, and Description, which can be gotten from the Party model (PartyRole) - - - Only EntitlementPool attributes currently being used are Name and MRN. - - - Only attributes presently used are name, metric type and metric value. - - - Only name and type are required. -MRN should also be provided, but is not required. - - - Entitlement and key instances and their association to pools are in a license management system that is outside of ONAP - - - A&AI stores the entitlement asset tag as an attribute of the Vnf Instance - - - - An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family. - - - - - - - - Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. - - - - Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. - - - - - - - - - Term of the license: --fixed term --perpetual --unlimited --subscription - - - - - - - - -
- - - A licenseKeyPool can contain some number of LicenseKeys. - - - - - LicenseKeyPool can contain some number of LicenseKeyInstances. - - - - - - - -
- - - LicenseKey can have some number of service provider based limits applied to it. - - - - lLicenseKeyPool can have some number of service provider specified PoolLimits - - - - - -
- - - LicenseKey can have some number of vendor based limits applied to it. - - - - - -
- - - An EntitlementPool and the associated Entitlements can have some number of Service Provider based limits. - - - - EntitlementPool can have some number of service provider specified limits. - - - - - -
- - - An EntitlementPool and the associated Entitlements can have some number of Vendor based limits. - - - - The EntitlementPool can have some number of Vendor specified limits. - - - - - -
- - - A FeatureGroup can have one or more EntitlementPools associated with it. - - - - The EntitlementPool can be related to one FeatureGroup - - - - - - - FeatureGroup can be related to some number of EntitlementPools. - - - - - - - -
- - - FeatureGroup can have 1 or more LicenseKeyPools and related LicenseKeys related to it. - - - - LicenseKeyPool is related to one FeatureGroup - - - - - - - A feature group can be related to some number of LicenseKeyPools - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - - - -
- - - - A Vendor can have some number of LicenseAgreements. - - - - - - A LicenseAgreement is related to some vendor. - - - - - - - -
- - - - EntitlementPool can contain some number of EntitlementInstances - - - - - EntitlementPool can contain some number of EntitlementInstances. - - - - - - - -
- - - A Vnf can have some number of feature groups. A feature group can apply to one or more Vnfs. - - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - A License Key Pool is created for each type of License Key that is required for the VNF. -Each License Key Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the License Key Pool are defined. - -The license key Pool model provides a description to interested systems for the license keys that are provided by a vendor. -A license key Pool is not specific to a feature group. A license key Pool may be related to multiple feature groups that a VNF belongs to or even to multiple VNFs. - - - - - - - - Pool limits applied by the service provider - - - - - - - Pool limits applied by the vendor. - - - - - - - The license key may be ‘universal’ or ‘unique’ or ‘one-time’. -- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. - -- A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. - -- A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. - - - - - - - - Units can be either absolute or a percentage (%). - - - - - - - Specified threshold value for the license key pool. - - - - - - - - Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000. - - - - - - - - Identifier that stays the same irrespective of version. - - - - - - The version of this entity. - - - - - - Identifier for the entitlement as described by the vendor in their price list / catalog /contract. - - - - - - - - - Represents an instance of a license key. -NOTE: This is an experimental class and is NOT currently used by the ONAP Platform - - - - - - - Vendor provided license key value that is entered into the vendor VNF to activiate / unlock it. - - - - - - - - The assignment status of the license (assigned, available, ...). - - - - - - The date the license key was assigned. - - - - - - Vendor provided license key file that is entered into the vendor VNF to activiate / unlock it. - - - - - - - - - A variable set of values that identify the limits that may be imposed by an entitlement instance in the pool. Multiple constraints may be applicable for an instance of entitlement in the pool. For example, an entitlement based on GB and number of sessions. Increments, aggregation function, time scope, threshold value may repeat for each metric in the list. - -Limits can be applied by the vendor or the service provider. - - - - Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc. - - - - - - The value of some limit being applied. - - - - - - Type of aggregation being performed (Peak or Average) - - - - - - - The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, ...) - - - - - Units time is specified in (day, month, hour, minute, second, millisecond. - - - - - - - - - LimitMetricType if Other enumeration is selected. - - - - - - - - - Represents an instance of a Entitlement -Specifies the use rights for the VNFs as described by the license. - -NOTE: This is an experimental class and is NOT currently used by the ONAP Platform - - - - - - - - The assignment status of the entitlement (assigned, available, ...). - - - - - - The date the entitlement was assigned. -NOTE; This is experimental and not currently used by ONAP - - - - - - - - - - - - An EntitlementPool is created for each type of Entitlement that is required for the VNFs. Each Entitlement Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the Entitlement Pool are defined. - -An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups containing a VNF or even to multiple VNFs. -Purchased entitlements are inventoried in the Entitlement Pools. - -Multiple pools for the same type of entitlement may be created based on the constraints. - - - - - - - - - - - - - Note: description is required according to the inherited attribute, but it presently is optional. - - - - - - - Pool limits applied by the service provider - - - - - - - Pool limits applied by the vendor. - - - - - - - Reference number for the entitlement as described by the vendor in their price list / catalog /contract. - - - - - - - - This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000. - - - - - - - - - A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: -when 90% of the pool is in-use, trigger an additional purchase of inventory. - - - - A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: -when 90% of the pool is in-use, trigger an additional purchase of inventory. - - - - - - - - - Specifies the Units for the ThresholdValue. - - - - - - - Identifier that stays the same irrespective of version. - - - Identifier that stays the same irrespective of version. - - - - - - The version of this entity. - - - - - - The license key may be ‘universal’ or ‘unique’ or ‘one-time’. -- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. - -- A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. - -- A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. - - - - - - - Feature groups represent a set of the features of one or more VNFs. Feature groups may be defined by the vendor and/or by the service provider. A VNF may be related to multiple feature groups. At least one feature group will be related to a VNF. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the VNF(s) in it. -If an Entitlement Pool or License Key Group is associated with a particular Feature Group, the Feature Group becomes a “constraint” for the pool/group. - - - - - Name of the feature group - - - - - - Description of the feature group. - - - - - - - - The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to. - - - The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to. - - - - - - - An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family. - - - - - - - - Free form text. Includes information such as operating system or hypervisor required for the VNF instance. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. - - - - Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. - - - - - - - - - Term of the license: --fixed term --perpetual --unlimited --subscription - - - - - - - - - - - - - - - - - - Valid values: -year, quarter, month, day. -Not applicable when license type is Perpetual. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Units of the entitlement/license term. Valid values: year, quarter, month, day. - - - - - - - - - - - - - LicenseInventory and Purchasing outside the scope of ONAP - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/ModelStructure/OnapModelStructure.docx b/ONAP Information Model/ModelStructure/OnapModelStructure.docx deleted file mode 100644 index 999af9b..0000000 Binary files a/ONAP Information Model/ModelStructure/OnapModelStructure.docx and /dev/null differ diff --git a/ONAP Information Model/Nf.di b/ONAP Information Model/Nf.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Nf.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Nf.notation b/ONAP Information Model/Nf.notation deleted file mode 100644 index 6429384..0000000 --- a/ONAP Information Model/Nf.notation +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Nf.uml b/ONAP Information Model/Nf.uml deleted file mode 100644 index c55c998..0000000 --- a/ONAP Information Model/Nf.uml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - Deleted some duplicate attributes that are inherited from RootEntity (id, description, etc) - - - - - - A NetworkFunctionDesc is the descriptor for some functional block within a network infrastructure that has well-defined external interfaces and well-defined functional behaviour. - - - - - - - Indicates whether the NetworkFunction can be shared. - - - - - - - A functional block within a network infrastructure that has well-defined external interfaces and well-defined functional behaviour. NOTE: In practical terms, a Network Function is today often a network node or physical appliance - - - - - - - Description of the type of network function - - - - - - Role the network function will be providing. - - - - - - - - The NfIndicator class defines the indicator the NF supports - - - - - - - The human readable name of the NfIndicator. - - - - - - - - Defines the allowed values or value ranges of this indicator. - - - - - - - - Describe the source of the indicator. The possible values are: -• VNF, -• EM, -• Both. -This tells the consumer where to send the subscription request. - - - - - - - - - Describe the source of an indicator. - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Ns.di b/ONAP Information Model/Ns.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Ns.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Ns.notation b/ONAP Information Model/Ns.notation deleted file mode 100644 index 78b448d..0000000 --- a/ONAP Information Model/Ns.notation +++ /dev/null @@ -1,2614 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Ns.uml b/ONAP Information Model/Ns.uml deleted file mode 100644 index 57021e8..0000000 --- a/ONAP Information Model/Ns.uml +++ /dev/null @@ -1,743 +0,0 @@ - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - - - - -
- - - - - -
- - - - - - - - - - - - The NSD class is a deployment template whose instances are used by the NFVO for the lifecycle management of NSs. -For all attributes in this class, the Producer is SDC and the Consumer is SDC/UUI/VFC - - - - - Identifier of this NSD class. It globally uniquely identifies an instance of the NSD - - - - - - Identifies the designer of the NSD. - - - - - - Identifies the version of the NSD. - - - - - - Provides the human readable name of the NSD. - - - - - - Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. - - - - - - Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD. -NOTE 1: The rule is based on a combination of assertions on the values of virtualised resource-related performance metrics and VNF Indicators identified by the monitoredInfo attribute. -NOTE 2: There may be multiple data sources (each identified as monitoredInfo) per rule - - - - - - - - - Identifies either a virtualised resource-related performance metric or a VNF Indicator. - - - - - - - Provides a life cycle management script written in a Domain Specific Language (DSL). - - - - - - - Provides the constituent VLDs. -Cardinality of 0 means that the NS is a NF set with unspecified connectivity. - - - - - - - - References the VNFD of a constituent VNF. - - - - - - - - References the PNFD of a constituent PNF. - - - - - - - - - The NsVirtualLinkDesc class provides general information enabling the instantiation of virtual links. -For all attributes in this class the Producer is SDC and the Consumer is SDC/UUI/VFC. - - - - - - - Defines the organization generating the VLD. - - - - - - - - Specifies the version of the VLD. - - - - - - Specifies properties for instantiating a VL according to a specific flavour. - - - - - - - - The NsDf class specifies the properties of a variant of an NS. -NOTE: Every VNF, VL and nested NS whose descriptor is referenced by the NS DF shall be involved in an NS instantiation level of the parent NS. If no instances of a given VNF/nested NS have to be deployed at NS instantiation time, the numberOfInstances attribute in the corresponding VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. - - - - Identifies this NsDf class. It identifies a NS DF within the NSD. - - - - - - Assurance parameter against which this flavour is being described. The key can be a combination of multiple assurance parameters with a logical relationship between them. The parameters should be present as a monitoredInfo attribute in the NSD. - - - - - - Identifies either a virtualised resource-related performance metric or a VNF Indicator. - - - - - - - Describes the details of an NS level. -NOTE: Every VNF, VL and nested NS whose descriptor is referenced by the NS DF shall be involved in an NS instantiation level of the parent NS. If no instances of a given VNF/nested NS have to be deployed at NS instantiation time, the numberOfInstances attribute in the corresponding VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. - - - - - - - - - - - - Specifies affinity or anti-affinity relationship applicable between the VNF instances created using different VNFDs, the Virtual Link instances created using different NsVirtualLinkDescs or the nested NS instances created using different NSDs in the same affinity or anti-affinity group. - - - - - - - - The scaling aspects supported by this DF of the NS. - - - - - - - PNF profile to be used for the NS flavour. - - - - - - - - Specifies a NS Profile supported by this NS DF. - - - - - - - VNF profile to be used for the NS flavour. - - - - - - - - Specifies the order in which instances of the VNFs and/or nested NSs have to be created. - - - - - - - - VL profile to be used for the NS flavour. - - - - - - - - - The NsScalingAspect class describes the details of an NS scaling aspect. An NS scaling aspect is an abstraction representing a particular "dimension" or "property" along which a given NS can be scaled. - Defining NS levels, in this context also known as NS scale levels, within an NS scaling aspect allows to scale NS instances "by steps", i.e. to increase/decrease their capacity in a discrete manner moving from one NS scale level to another. -Scaling by a single step does not imply that exactly one instance of each entity involved in the NS scale level is created or removed. - - - - Identifier of this NsScalingAspect class. It Uniquely identifies the NS scaling aspect in an NSD. - - - - - - Provides a human readable name of the NS scaling aspect. - - - - - - Provides a human readable description of the NS scaling aspect. - - - - - - Describes the details of an NS level. -NOTE: Only a subset of the VNFs, VLs and nested NSs whose descriptor is referenced by the NS DF may be involved in an NS scale level of the parent NS. - - - - - - - - - The NsLevel class describes the details of an NS level. An NS level consists of a list of involved entities, i.e. VNFs, VLs and/or nested NSs. -For each involved VNF/nested NS, the number of instances required by the NS level is specified. For each involved VL, the bitrate requirements corresponding to the NS level are specified. -NS levels shall be used in the context of NS instantiation and in this case they are referred to as NS instantiation levels. -Every VNF, VL and nested NS whose descriptor is referenced by the NS DF shall be involved in an NS instantiation level of the parent NS. If no instances of a given VNF/nested NS have to be deployed at NS instantiation time, the numberOfInstances attribute in the corresponding VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. -NS levels may be used in the context of NS scaling and in this case they are referred to as NS scale levels. - Only a subset of the VNFs, VLs and nested NSs whose descriptor is referenced by the NS DF may be involved in an NS scale level of the parent NS. - - - - - Identifier of this NsLevel class. It uniquely identifies an NS level within the DF. - - - - - - Human readable description of the NS level. - - - - - - Specifies the profile of the VNFs involved in this NS level and, for each of them, the required number of instances. - - - - - - - - Specifies the profile of the VLs involved in this NS level and, for each of them, the needed bandwidth. - - - - - - - - Specifies the profile of the nested NSs involved in this NS level and, for each of them, the required number of instances. - - - - - - - - The NsProfile class specifies the profile to be used for a nested NS. - - - - - - - Identifies an NS profile. - - - - - - Minimum number of nested NS instances based on the referenced NSD that is permitted to exist for this NsProfile. - - - - - - Maximum number of nested NS instances based on the referenced NSD that is permitted to exist for this NsProfile. - - - - - - Identifies an affinity or anti-affinity group the NSs created according to this NsProfile belong to. - - - - - - - - Identifies the applicable NS DF within the scope of the NSD. - - - - - - - Identifies the NS level within the referenced NS DF to be used in the context of the parent NS instantiation. If not present, the default NS instantiation level as declared in the referenced NSD shall be used. - - - - - - - Identifies the NSD applicable to NS instantiated according to this profile. - - - - - - - - This class provides run-time information about an NS VL instance. - - - - - - - Virtualised network resource(s) realizing this VL. - - - - - - Respresents the port of a NS VL. - - - - - - - The LifeCycleManagementScript information element specifies a script for the NS. - - - - Describes NS lifecycle event(s) or an external stimulus detected on an NFVO reference point. -NOTE 1: A minimum set of NS lifecycle events triggered internally by the NFVO includes: start instantiation, end instantiation, start scaling, end scaling, start healing, end healing, start termination, end termination, start update, end update. -NOTE 2: A minimum set of external stimulus includes: the receipt of request message of instantiation, scaling, healing, termination, update of NS. - - - - - - - - Includes an NS LCM script (e.g., written in a DSL) triggered to react to one of the events listed in the event attribute. - - - - - - - The VirtualLinkDf datatype specifies properties for instantiating a VL according to a specific flavour. - - - - Identifies this VirtualLinkDF datatype within a VLD. - - - - - - Specifies quality of service parameters applicable to a VL. - - - - - - - Specifies one of the three levels defined in ETSI GS NFV-REL 001: -• Level 1 -• Level 2 -• Level 3 - - - - - - - - The NsQoS datatype specifies quality of service parameters applicable to a NS VL. - - - - - - - Specifies the priority level in case of congestion on the underlying physical links. - - - - - - - - - Specifies one of the three levels defined in ETSI GS NFV-REL 001: -• Level 1 -• Level 2 -• Level 3 - - - - - - - - - The MonitoredData datatype identifies information to be monitored during the lifetime of a network service instance. - - - - - The NsToLevelMapping datatype specifies the profile to be used for a nested NS involved in a given NS level and the required number of instances. - - - - Identifies the profile to be used for a nested NS involved in the NS level. - - - - - Specifies the number of nested NS instances required for the NS scale level. -NOTE 1: It shall be in the range of minNumberOfInstances-maxNumberOfInstances, as specified in the referenced NsProfile. -NOTE 2: When the corresponding NS level is used in the context of NS instantiation, the numberOfInstances attribute specifies the number of nested NS instances to be deployed. -NOTE 3: When the corresponding NS level is used in the context of NS scaling, the numberOfInstances attribute does not specify the number of nested NS instances to be added/removed when reaching that NS scale level. The actual number of nested NS instances to be added/removed can be derived by subtracting the numberOfInstances declared in the source NS scale level from the numberOfInstances declared in the target NS level of the scaling request. - - - - - - - - The NsVirtuallLinkConnectivity datatype describes connection information between a connection point and a NS virtual Link. - - - - Reference an NS VL profile. - - - - - References the descriptor of a connection point on a VNF/PNF or a SAP which connects to virtual links instantiated from the profile identified in the virtualLinkProfileId attribute. - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Onap_Profile.profile.di b/ONAP Information Model/Onap_Profile.profile.di deleted file mode 100644 index 4f26340..0000000 --- a/ONAP Information Model/Onap_Profile.profile.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Onap_Profile.profile.notation b/ONAP Information Model/Onap_Profile.profile.notation deleted file mode 100644 index b2f6835..0000000 --- a/ONAP Information Model/Onap_Profile.profile.notation +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Onap_Profile.profile.uml b/ONAP Information Model/Onap_Profile.profile.uml deleted file mode 100644 index d8265c7..0000000 --- a/ONAP Information Model/Onap_Profile.profile.uml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - This profile contains stereotypes applicable to ONAP - - - - - - - - - - - - - - - - - - - This stereotype is used to determine the model element lifecycle state. - - - - This is the current model development state of the element. - - - - - - - - - - - - - - - - - This represents the various development states of an ONAP model element - - - - The model element is input for a discussion. - - - - - The model element is under discussion. - - - - - The model element has been agreed upon by a project team. - - - - - The model element has been officially reviewed and approved by the modeling subcommittee. - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/OpenModel_Profile.profile.di b/ONAP Information Model/OpenModel_Profile.profile.di deleted file mode 100644 index 4f26340..0000000 --- a/ONAP Information Model/OpenModel_Profile.profile.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/OpenModel_Profile.profile.notation b/ONAP Information Model/OpenModel_Profile.profile.notation deleted file mode 100644 index 171f5da..0000000 --- a/ONAP Information Model/OpenModel_Profile.profile.notation +++ /dev/null @@ -1,2212 +0,0 @@ - - - - - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - multiplicity - visibility - defaultValue - name - type - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
- - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
- - - - - - - -
- - -
- - -
- - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
- - - - - - - -
- - -
- - -
- - - - - - - -
- - -
- - -
- - - - - - - -
- - -
- - -
- - - - - - - -
- - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - visibility - name - derived - multiplicity - defaultValue - type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/OpenModel_Profile.profile.uml b/ONAP Information Model/OpenModel_Profile.profile.uml deleted file mode 100644 index 544a053..0000000 --- a/ONAP Information Model/OpenModel_Profile.profile.uml +++ /dev/null @@ -1,10447 +0,0 @@ - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - OpenModel Profile v0.2.13: -ProfileLifecycle Profile v0.0.4 applied. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -
- - This stereotype defines the Open Model specific enhancements for attributes. - - - -
- - - - - - This property indicates if the attribute is part of the object key or not. -Value = 0 (default) means the attribute is not part of the object key. -Values > 0 indicate that the attribute is part of the object key and the value defines the order of the attribute in case the key is composed of more than one attribute. - - - - - - - This property defines if the attribute is part of a set of attributes which together (i.e., their values) have to be unique among all instances within a defined context. -No value means no uniqueness constraint. -An integer value identifies the uniqueness set. -An attribute may participate in more than one uniqueness sets. - - - - - - - -
- - - -
- - This property defines at which time the attribute can be set. -true = attribute can only be set at creation time; false = attribute can be set at any time. - - - - -
- - - - - - -
- - - -
- - This property provides the restriction on the attribute values. - - - - - - - - This optional property indicates if the attribute type is unsigned (value = true) or signed (value = false); if applicable, otherwise ignored. - - - - - - - - - This optional property defines the counter type of the attribute type; if applicable. - - - - - - - - This optional property contains a textual definition of the unit associated with the attribute value. -The spelling of the unit (not only SI units) shall be in accordance to the NIST Publication 811 “Guide for the Use of the International System of Units (SI)” (http://www.nist.gov/pml/pubs/sp811/index.cfm), section 9 “Rules and Style Conventions for Spelling Unit Names”. - - - - - - - -
- - - -
- - This property qualifies the support of the attribute at the management interface. - - - -
- - - - - -
- - - -
- - This attribute contains the condition for the condition-related support qualifiers. - - - - - - - - -
- - - required - - - -
- - - -
- - - - - - -
- - - -
- - This stereotype defines the Open Model specific enhancements for data object classes. - - - -
- - - - - -
- - - -
- - This property qualifies the support of the object class at the management interface. - - - -
- - - - - -
- - - -
- - This attribute contains the condition for the condition-related support qualifiers. - - - - - - - - -
- - - required - - - -
- - - -
- - - - - - -
- - - -
- - This stereotype defines the Open Model specific enhancements for operations. - - - -
- - - - - -
- - - -
- - This property defines whether the operation is idempotent or not. -Example: When an operation is going to create an object instance which does already exist, an idempotent operation would return success and a non-idempotent operation would return an exception. - - - - -
- - - - - - -
- - - This property identifies if the operation is best effort or is successful / not successful as a whole. - - - - -
- - - - - - -
- - - -
- - This property qualifies the support of the operation at the management interface. - - - -
- - - - - -
- - - -
- - This attribute contains the condition for the condition-related support qualifiers. - - - - - - - - -
- - - required - - - -
- - - -
- - - - - - -
- - - -
- - This stereotype defines the Open Model specific enhancements for parameters. - - - -
- - - - - -
- - - -
- - This property provides the restriction on the parameter value. - - - - - - - -
- - - -
- - This property qualifies the support of the parameter at the management interface. - - - -
- - - - - -
- - - -
- - This attribute contains the condition for the condition-related support qualifiers. - - - - - - - - -
- - - required - - - -
- - - -
- - - - - - -
- - - -
- - This enumeration defines if a notification (of a specific type) has to be raised when the event occurs. - - - -
- - - -
- - This literal means that this kind of Notification makes no sense for this object class, e.g., when it is abstract. - - - - -
- - - -
- - This literal means that the object class shall not send this kind of notification. - - - - -
- - - -
- - This literal means that the object class must send this kind of notification. - - - - - -
- - - -
- - This stereotype identifies that the association is used to define the naming. - - - -
- - - - - - -
- - - -
- - - - - -
- - - -
- - This enumeration defines the list of support qualifiers as defined in ITU-T Recommendation M.3020. - - - -
- - - -
- - The model element shall be supported. - - - - -
- - - -
- - The model element may, but needs not to, be supported. - - - - -
- - - -
- - The model element shall be supported under certain conditions. If the specified conditions are met then the model element shall be supported. - - - - -
- - - -
- - The model element may, but needs not to, be supported under certain conditions. If the specified conditions are met then the model element may, but needs not to, be supported. If the specified conditions are not met then the model element shall be supported. - - - - -
- - - -
- - Used for model elements that have multiple constraints. Each constraint is worded as a condition for one kind of support, such as mandatory support, optional support or "no support". All constraints must be related to the same kind of support. Specifically: Each model element with C qualification shall have the corresponding multiple constraints defined in the specification. If all specified constraints are met and are related to mandatory, then the model element shall be supported. If all the specified constraints are met and are related to optional, then the model element may, but needs not to, be supported. If all the specified constraints are met and are related to "no support", then the model element shall not be supported. - - - - - -
- - - -
- - This stereotype identifies an object class or a data type as a choice between different alternatives. - - - -
- - - - - - - - - - - - - -
- - - -
- - - - - -
- - - -
- - This stereotype defines a data type used for an operation exception. - - - -
- - - - - - -
- - - -
- - - - - -
- - - -
- - This stereotype identifies that the dependency is used to define the naming. - - - -
- - - - - - -
- - - -
- - - - - -
- - - This stereotype can only be applied to associations with a composite end (i.e., composite aggregation association). Means that the content of the "parts" classes is part of the "composed" parent class and has no opportunity for independent lifecycle. In this case although an instance of the "parts" classes can be created and deleted anytime, it has to be in the context of the "composed" parent class. In other words, the parent class instance has to exist and it is NOT possible for the "part" instance to move from one parent instance to another (allowed in regular composition). - - - -
- - - - - - -
- - - -
- - - - - -
- - - -
- - This stereotype identifies that the relationship is conditional. - - - -
- - - -
- - This attribute contains the condition. - - - - - - - - - -
- - - This stereotype indicates that the entity is at a very early stage of development and will almost certainly change. The entity is NOT mature enough to be used in implementation. - - - - - - - - - -
- - - This stereotype indicates that although the entity may be mature work in the area has indicated that change will be necessary (e.g. there are new insights in the area or there is now perceived benefit to be had from further rationalization). The entity can still be used in implementation but with caution. - - - - - - - - - -
- - - This stereotype indicates that the entity is at a relatively early stage of development and is likely to change but is mature enough to be used in implementation. - - - - - - - - - -
- - - This stereotype indicates that the entity should not be used in new implementation and that attempts should be made to remove it from existing implementation. - - - - - - - - - -
- - - This stereotype indicates that the entity is NOT to be used in implementation and is in the model simply to assist in the understanding of the model (e.g., a specialization of a generalized class where the generalized class is to be used as is and the specialization is simply offered to more easily illustrate an application of the generalized class). - - - - - - - - - -
- - - This stereotype indicates that the entity should not be used in new implementation and that attempts should be made to remove it from existing implementation as there is a problem with the entity. An update to the model with corrections will be released. - - - - - - - - - -
- - - -
- - This stereotype defines the Open Model specific enhancements for interfaces. - - - -
- - - - - -
- - - -
- - This property qualifies the support of the interface at the management interface. - - - -
- - - - - -
- - - -
- - This attribute contains the condition for the condition-related support qualifiers. - - - - - - - - -
- - - required - - - -
- - - -
- - - - - - - - - - This stereotype defines the Open Model specific enhancements for notifications. - - - -
- - - -
- - This property provides the list of conditions that cause the notification. - - - - - - - -
- - - -
- - This property qualifies the support of the notification at the management interface. - - - -
- - - - - -
- - - -
- - This attribute contains the condition for the condition-related support qualifiers. - - - - - - - - - - - - required - - - - - - - - - This stereotype identifies that the realization association is used to identify pruning and refactoring. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This stereotype indicates that the entity may become obsolete in the near future. It may still be used in new implementation. - - - - - - - - - - - This stereotype indicates that the entity is fully developed and can be used in implementations without any constraints. - - - - - - - - - - - This optional stereotype contains a reference upon which the UML artefact is based. A reference to a standard is preferred. - - - - - - - - - - - - - - This enumeration contains the defined bit length values. - - - - - - - - - - This enumeration contains the defined counter types. - - - - - - - - - This enumeration contains the defined encoding types. - - - - - - - - - This steoreotype indicates a more restrictive form of "StrictComposite" where the "extending" classes will never be explictly instantiated, but that the attributes defined by the “extending” class will be transferred to the class being “extended” at runtime, much like the UML “Generalization” relationship. In other words the "extending" classes are essentially carrying attributes of the “extended” class in a grouping-pack and often referred to as "_Pacs". - - - - - - The “Specify” stereotype is applied on the UML “Abstraction” relationship to indicate that the definition of the more abstract entity class in the abstraction relationship is augmented by the "specification" class definition at runtime. Furthermore there is a potential for an entity class definition to be augmented by more than one "specification" class definitions. In others words, one of the specification classes adds-to and expands the runtime-definition of the entity class. This also implies that the entity class cannot be aware of the existence of specification classes at design time. Since the “Specify” relationship is defined to support runtime code/schema generation and dependency injection, a stereotype-property “target” is defined to point to the actual node being augmented within the object/instance schema. The "target" value should be in the following format: -[/<ModelName>:<ClassName>]+:<AttributeName>. -Example: TopologyContext in TapiTopology augments Context in TapiCommon -target=/TapiCommon:Context:_context -Example: NodeEdgePointLpSpec in TapiOdu specifies LayerProtocol definition for NodeEdgePoint in TapiTopology -target=/TapiTopology:TopologyContext/TapiTopology:Topology/TapiTopology:Node/Tapi:Topology:NodeEdgePoint/_layerProtocol - - - - - - - This property indicates the target of the "Specification". It is recommended that this information is set as the “default” value in the concrete “Specification” class at design/modeling time. - - - - - - - - - - - - - - - This property shall only be applied to attributes or parameters that have an object class as their type. -The stereotype identifies that the attribute or the parameter that has the stereotype associated, contains only the identifier(s) of the referred object instance(s) when being transferred across the interface. -Otherwise the attribute/parameter contains the complete information of the object instance(s) when being transferred across the interface. - - - - - - - - - - - - - - - - - - - - - This optional stereotype can extend a shared aggregation and indicates a lifecycle dependency between the group instance and the shared part instances; similar to the lifecycle dependency of a composite aggregation. -This option is intended to be used only when the shared part object class has another stronger lifecycle dependency (such as composition). -The multiplicity at the grouping side of the «LifecycleAggregate» relationship defines the mode: single = exclusive mode, one or more = shared mode. -In exclusive mode, a shared part object instance must not be aggregated by more than one group instance via a «LifecycleAggregate» relationship. -In shared mode, a shared part object instance can be aggregated by more than one group instance via a «LifecycleAggregate» relationship. In this case, a shared part instance is automatically deleted when the last group instance aggregated the part instance is deleted. - - - - - - - - - - - This is used by ONAP to indicate that the artifact will be in a Future release. - - - - - - - - - - - This is used by ONAP to represent a proposal to a model. The "note" must contain the name of the person making the proposal and the associated contribution. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Party.di b/ONAP Information Model/Party.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Party.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Party.notation b/ONAP Information Model/Party.notation deleted file mode 100644 index 5738a00..0000000 --- a/ONAP Information Model/Party.notation +++ /dev/null @@ -1,1577 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
-
-
-
-
-
- - - - - - - - - - - - - - - -
- - -
-
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
-
- - - - - - - - - - - - - - - -
- - -
-
-
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Party.uml b/ONAP Information Model/Party.uml deleted file mode 100644 index 10cbb79..0000000 --- a/ONAP Information Model/Party.uml +++ /dev/null @@ -1,267 +0,0 @@ - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - - - A Party represents an individual, an organization, or an organization unit that is of interest, involved or that provides value, directly or indirectly, from an enterprise perspective (Enterprise is to be understood here as provider, service provider or operator). - - - - - - - The time period that the Party is valid for - - - - - - - Represents a single human being (a man, woman or child). -The individual could be a customer, an employee or any other person that the organization needs to store information about. An Individual is a type of Party. - - - - - - A group of people identified by shared interests or purpose. Examples include business, department, enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same business entity in this model. An Organization is a type of Party. -An Organization might be composite or atomic. - - - - - - The OrganizationDecompositionComponent specifies the valid period for the relationship between CompositeOrganization and Organization. - - - - The period during which the OrganizationDecompostionComponent is applicable. - - - - - - - AtomicOrganization is a type of Organization that does not have any subordinate Organization. That is, an AtomicOrganization is a leaf-level Organization. - - - - - - CompositeOrganizaiton is a type of Organization that is formed by aggregating other Organizations, which may be atomic or composite Organizations. - - - - - - The part played by a party in a given context with any characteristics, such as expected pattern of behavior, attributes, and/or associations that it entails.PartyRole is an abstract concept that should be used in places where the business refers to a Party playing a Role - - - - - - - Used to track the lifecycle status, e.g. existing, prospective or former customers. - - - - - - The time period that the PartyRole is valid for - - - - - - - A person or organization that buys products and services from the enterprise or receives free offers or services. This is modeled as a Party playing the role of Customer. A Customer is a type of PartyRole. Customers can also be other service providers who resell the enterprises products, other service providers that lease the enterprise's resources for utilization by the other service provider's products and services, and so forth. - - - - - - An individual or organization that sells goods or services to somone else in the value fabric. - - - - - - An organization or individual which offers services and products to others in exchange for payment in some form. - - - - - - The definition of a role a party may play. - - - - - A word, term, or phrase by which an organization is known and distinguished from other organizations.A name is an informal way of identifying an object [Fowler]An OrganizationName is a type of PartyName. - - - - - - A word, term, or phrase by which a party (individual or organization) is known and distinguished from other parties.A name is an informal way of identifying an object [Fowler].PartyName is an abstract concept that should be used in places where the business refers to an organization name, organization unit name or individual name - - - - - A word, term, or phrase by which an individual is known and distinguished from other individuals.A name is an informal way of identifying an object [Fowler]This entity allows for international naming variations. An IndividualName is a type of PartyName. - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Pnf.di b/ONAP Information Model/Pnf.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Pnf.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Pnf.notation b/ONAP Information Model/Pnf.notation deleted file mode 100644 index 4aa2aa2..0000000 --- a/ONAP Information Model/Pnf.notation +++ /dev/null @@ -1,592 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Pnf.uml b/ONAP Information Model/Pnf.uml deleted file mode 100644 index 30e7f5e..0000000 --- a/ONAP Information Model/Pnf.uml +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - -
- - - - - -
- - - - - - - - - The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. - - - - - - - Identifier of this Pnfd class. It uniquely identifies the PNFD. - - - - - - Identifies the provider of the PNFD. -NOTE: The provider of the PNFD might be different from the provider of the PNF. - - - - - - Identifies the version of the PNFD - - - - - - Provides a signature to prevent tampering. - - - - - - - - Describes the PNF function. - - - - - - Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. - - - - - - Provides the human readable name of the PNFD. - - - - - - Specifies the characteristics of one or more connection points where to connect the PNF to a VL. - - - - - - - - A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. - - - - - - - - - An implementation of a NF via a tightly coupled software and hardware system. - - - - - - - External CP of the PNF. - - - - - - - - External CP of the PNF. - - - - - - - Cpd used to deploy this PNF CP. - - - - - - The PnfProfile class describes additional data for a given PNF instance used in a DF. - - - - Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. - - - - - - Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. - - - - - - - - - - - - The software versions associated with the pnfd - - - - The active software - - - - - - The passive software - - - - - - - - The recovery software - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Policy.di b/ONAP Information Model/Policy.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Policy.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Policy.notation b/ONAP Information Model/Policy.notation deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Policy.notation +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Policy.uml b/ONAP Information Model/Policy.uml deleted file mode 100644 index 07fbe78..0000000 --- a/ONAP Information Model/Policy.uml +++ /dev/null @@ -1,647 +0,0 @@ - - - - Presently the scope of policy is imperitive (event, condition, action) only - not declaritive or intent. - -Approach will be pragmatic in nature, establishing a model that meets the Policy team's near term needs, and then evolve from that base. - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - This is an abstract base class that represents how to form the action clause of a PolicyRule. - -Certain actions will take place if the condition clause is TRUE, others if the condition clause is FALSE. - - - - - - - - Additional metadata pertinant to the action. - - - - - - Defines the strategy to be used when executing the aggregated actions - - - - - - A PolicyEvent is an occurrence of an important event, and can be used to trigger the evaluation of a PolicyCondition or PolicyCondition clause in a PolicyRule. - - - - - - - - eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors). - - - - - - The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center). - - - - - - The payload for the event. - - - - - - Classification that captures the symantics of that particular event categorization (enodeb, vnf) - - - - - - - This class is a generalized aggregation container. It enables PolicyRules and/or PolicyGroups to be aggregated in a single container. Note that loops, including the degenerate case of a PolicyGroup that contains itself, are not allowed when PolicyGroups contain other PolicyGroups. - - - - - - This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored. - -Notes: -Not present in the ITU or CIM specs. - - - - - - This is a free-form string attribute that recommends how this policy object should be used. - -Notes: Not present in the ITU or CIM specs. - - - - - - This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined: - -Permitted Values: -Unknown InstallPermissions - ConfigChange InstallMethod - Default Error - Usage InternalError - Security ExternalError - Authentication Notification - Authorization Publish - Accounting Subscribe - Auditing Publish-Subscribe - Service Exception - CustomerFacingService - ResourceFacingService - -Notes: Not present in the ITU specs; the CIM defines a PolicyKeyword attribute, but its semantics are very different. - - - - - - This is a generic naming attribute that can be used to identify different policy entities. This enables commonName to be used to enforce enterprise or service provider generic naming and this attribute to be used to fine tune the naming of policy entities. Thus, commonName is public in scope and policyName is private to policy. - -Notes: -Not present in the ITU specs or CIM specs. - - - - - - Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). - - - - - - This is a string, and defines a textual free-form description of the object. - -Notes: -This attribute doesn’t exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description. - - - - - - Unambiguously distinguishes different object instances. It is the naming attribute of the object. - - - - - - - This is a concrete base class for realizing the "event-condition-passaction-failaction" semantics that form a policy rule. The semantics of this rule are that the rule is evaluated when an event occurs. If the condition clause is satisfied, then the pass-action clause will be executed (otherwise, the fail-action clause will be executed). - -PolicyRules may be nested within PolicyRules. This is often needed in networking (e.g., bandwidth allocation). - - - - - This is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs). - -This attribute controls the setting of how multiple condition clauses (as represented by multiple PolicyConditionComposite objects) are treated in the PolicyRule. As such, it is different from the attribute PolicyConditionComposite.IsCNF, which controls how multiple PolicyConditionAtomic objects are treated in a (single) PolicyConditionComposite object. - - - - - - - - - This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored. - -Notes: -Not present in the ITU or CIM specs. - - - - - - This is a free-form string attribute that recommends how this policy object should be used. - -Notes: Not present in the ITU or CIM specs. - - - - - - This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined: - -Permitted Values: -Unknown InstallPermissions - ConfigChange InstallMethod - Default Error - Usage InternalError - Security ExternalError - Authentication Notification - Authorization Publish - Accounting Subscribe - Auditing Publish-Subscribe - Service Exception - CustomerFacingService - ResourceFacingService - -Notes: Not present in the ITU specs; the CIM defines a PolicyKeyword attribute, but its semantics are very different. - - - - - - Version of the policy as defined by the developer. - - - - - - his is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs). - -This attribute controls the setting of how multiple condition clauses (as represented by multiple PolicyConditionComposite objects) are treated in the PolicyRule. As such, it is different from the attribute PolicyConditionComposite.IsCNF, which controls how multiple PolicyConditionAtomic objects are treated in a (single) PolicyConditionComposite object. - - - - - - - This is a concrete base class that is used to define the invariant characteristics (attributes, methods, constraints and relationships) of a PolicyRule entity. - - - - This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: - - 0: Unknown - 1: Do Until Success - 2: Do All - 3: Do Until Failure - 4: Do All Without Failure or Do Nothing - -"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). - -"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. - -"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. - -Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered. - - - - - This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted. - -Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule). - - - - - - This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. - -Notes: Not present in the ITU or CIM specs. - - - - - - This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. - -Notes: Not present in the ITU or CIM specs. - - - - - - This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. - -Notes: Not present in the ITU or CIM specs. - - - - - - This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. - -Permitted Values: - - 0: Unknown - 1: MatchFirst - 2: MatchAll - -MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. - -MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute. - - - - - List of Event Types to be considered by this event. - - - - - - - - - This is the base class for all simple PolicyActions. A simple PolicyAction consists of a single Boolean clause, which is used to perform a single action. This consists of a single occurrence of a PolicyStatement, which is of the form: - - {SET | CLEAR} PolicyVariable to PolicyValue - -This is distinctly different from the PolicyActionVendor, which does not use a PolicyStatement. - -PolicyActionAtomic objects can also be used to form more complex action structures. A PolicyActionComposite object can be used to contain a group of PolicyActionAtomic objects - this grouping enables multiple PolicyActionAtomic objects to be executed as a group. Alternatively, a PolicyActionAtomic object can contain one or more PolicyActionAtomic objects (and also PolicyActionComposite groups if desired) to provide the semantics of a compound PolicyAction. In either case, the aggregation is done using the containedPolicyActions aggregation. - - - - - - This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. This will allow a policy engine to reference externally supplied arguments to this object as it is executed. - -Notes: Not present in the ITU specs; CIM 2.7 has a subset of these values. - - - - - - Tthe entity that is executing the policy. - - - - - - he set of entities that are affect-ed by the policy. - - - - - - This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction. - -Permited Values: - 0: not yet executed - 1: executed with no errors - 2: executed with errors but successfully rolled back - 3: executed with errors and did not roll back - 4: did not complete execution but successfully rolled back - 5: did not complete execution and did not roll back - -Notes: -Not present in the ITU or CIM specs. - - - - - - - This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. -For example if a composite is part of another composite policy structure. - -Notes: default is “1” - - - - - This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. -For example if a composite is part of another composite policy structure. - -Notes: default is “1” - - - - - - This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of sub-actions that they contain. - -Notes: Not present in the ITU or CIM specs. - - - - - - Specifies if the action is in confunctive normal form. - - - - - - Execution Strategy that applies to the entire workflow. - - - - - - - - - - - Composite event has events - - - - - - - - - - - - - - - - - This is an abstract base class that represents how to form the condition clause of a PolicyRule. This class can be used to represent rule-specific or reusable policy conditions. - -Policy conditions are of the form: - - {variable, operator, value} - -where the operator is usually the MATCH operator, but could be another type (e.g., compare) of operator. This gives the semantics of "IF the condition is TRUE (or FALSE)". - -The subclasses of PolicyCondition, along with its recursive aggregation, enable simple and compound (e.g., nested) PolicyConditions to be supported by the same structure. - - - - - - - - - - - - - This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. - -Permitted Values: - - 0: Unknown - 1: MatchFirst - 2: MatchAll - -MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. - -MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute. - - - - - - - - This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: - - 0: Unknown - 1: Do Until Success - 2: Do All - 3: Do Until Failure - 4: Do All Without Failure or Do Nothing - -"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). - -"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. - -"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. - -Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered. - - - - - - - - - - This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction. - -Permited Values: - 0: not yet executed - 1: executed with no errors - 2: executed with errors but successfully rolled back - 3: executed with errors and did not roll back - 4: did not complete execution but successfully rolled back - 5: did not complete execution and did not roll back - -Notes: -Not present in the ITU or CIM specs. - - - - - - - - - - - PolicyEvents can include a state chnage, a VES Event, or a configuration request. - - - Model Based Strongly On the TMF SID - - - Rooted PolicyEvent - - - Some rules may not be created from a template - - - "Guard" Policies - serve as overarching conditions. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Resource.di b/ONAP Information Model/Resource.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Resource.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Resource.notation b/ONAP Information Model/Resource.notation deleted file mode 100644 index 5944fa1..0000000 --- a/ONAP Information Model/Resource.notation +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Resource.uml b/ONAP Information Model/Resource.uml deleted file mode 100644 index 34a728a..0000000 --- a/ONAP Information Model/Resource.uml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - ResourceDesc represents physical and non-physical (virtual) components which are owned / managed by the business or provided by a Supplier and are used (directly or indirectly) to construct services. - -In this context, a resource is something that goes into a resource catalog from which services are composed. - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - diff --git a/ONAP Information Model/Service.di b/ONAP Information Model/Service.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Service.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Service.notation b/ONAP Information Model/Service.notation deleted file mode 100644 index 1221c51..0000000 --- a/ONAP Information Model/Service.notation +++ /dev/null @@ -1,8294 +0,0 @@ - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - -
- - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - -
- - - - - - - - - - - - - -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
- - - - - - - - - - - - - - -
- - -
-
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - -
- - - - - - - - - - -
-
-
-
- - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - -
-
-
-
- - - - - - -
-
-
-
- - - - - - -
-
-
-
- - - - - - -
-
-
-
- - - - - - -
-
-
-
- - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Service.uml b/ONAP Information Model/Service.uml deleted file mode 100644 index ddd0913..0000000 --- a/ONAP Information Model/Service.uml +++ /dev/null @@ -1,2268 +0,0 @@ - - - - - NSST -(Network Slice Subnet Template) - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - -
- - - - - - - - - - - - -
- - - - - -
- - - - sbnd f - - - - - -
- - - - dbfb - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - -
- - - Enables specifying any kind of relationships between ServiceOrderItems - - - - The type of relationship such as contains, relies on. - - - - - - - - - -
- - - - - -
- - - An association between two ServiceOrders. - - - - A categorization of the relationship, such as bulk, parent/child, and so forth. - - - - - - - - -
- - - - - - - - - - - - - - -
- - - - - - - - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - An implementation of composite Service corresponding to a ServiceCompositeDescriptor. - - - - - - - - - -
- - - Describe the nested relationship between multiple Serive Descriptors. - - - - - - - - - - - - -
- - - An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. - - - - - - - - - -
- - - Resource components of constituting a serivce descriptor. - - - - - - - - - -
- - - Resource instance components of constituting a serivce instance. - - - - - - - - -
- - - Resource instance components of constituting a serivce instance. - - - - - - - - - -
- - - Resource components of constituting a serivce descriptor. - - - - - - - - - -
- - - - - -
- - - - - - - Some Questions: -1. Do we have a business need to have multiple service catalogs? -- -2. Do we have a need to have a service descriptor in a given catalog multiple times for different time periods? -- -3. How do we handle moving a descriptor from a test catalog to a production catalog? -- -4. What is the attachment class? - - - Presently, SDC stores the descriptor directly in the catalog. - - - I don't think SDC uses the SID Characteristic patern. - - - Removed recursive associations, given we are using the composite/atomic pattern. - - - Do we need this diagram? - - - Option 1 - - - Option 2 - - - -NST -(Network Slice Template) - - - - - - - - - - The Nfpd class associates traffic flow criteria to a list of descriptors associated to the connection points and service access points to be visited by traffic flows matching these criteria. - - - - Identifies this nfpd class within a VNFFGD. - - - - - Provides an NFP classification and selection rule. -The rule may be expressed as a criteria constructed out of atomic assertions linked by Boolean operators AND, OR and NOT. -NOTE: Examples of atomic assertions are assertions on packet header fields’ values, date and time ranges, etc. - - - - - References the descriptor of a connection point to be traversed by the traffic flows matching the criteria. This shall be a connection point attached to one of the constituent VNFs and PNFs of the parent VNFFG, or a SAP of one of the constituent nested NSs of the parent VNFFG. -NOTE: When multiple values are provided, the order is significant and specifies the sequence of connection points to be traversed. - - - - - - This is an abstract proxy class, allowing to provide reference to either NsProfile or VnfProfile. - - - - - The Dependencies class provides indications on the order in which VNFs associated to different VNF Profiles and/or nested NSs associated to different NS Profiles are to be instantiated. - - - - References a VnfProfile or NsProfile. -NOTE: NFV Management and Orchestration functions shall instantiate VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the primary attribute before instantiating VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the secondary attribute. - - - - - - - - References a VnfProfile or NsProfile. -NOTE: NFV Management and Orchestration functions shall instantiate VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the primary attribute before instantiating VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the secondary attribute - - - - - - - - - Provides information on a Service Access Point (SAP) of a NS - - - - - - - - ServiceDescriptor is used to model the design time representation of a service. - - - - - - - Constant identifier of the service model. - - - - - - Versioned identifier of the service model (this uuid is changed for every major version of the service) - - - - - - The name of the service model designed. - - - - - - The description of the service model designed. - - - - - - A predefined list which identifies the construct's category. There is a predefined list of service categories. - - - - - - - - The service model version. - - - - - - An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. - - - - - - - - An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. - - - - - - - - The icon path of the service. - - - - - - - - - - Describe whether this service descriptor is shared or not in the service design. - - - - - - Includes a list of events and corresponding management scripts performed for the -Service. - - - - - - - - - - - - - - - - - ServiceInstance is used to model the run time representation of a service. - - - - - - - Uniquely identifies this instance of a service. - - - Uniquely identifies this instance of a service. - - - - - - The name assigned to the service-instance. - - - - - - - - An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. - - - - - - - - An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. - - - - - - URL to endpoint where more details can be gotten. - - - - - - Orchestration status of the service instance. - - - - - - Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - - - - - Record the number of services that are using this service instance. -Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. - - - - - - - - - - - - ServcieCompositeDescriptor is used to model the design time representation of a service component or network service. - - - - - - Describe the nested relationship between multiple Service Descriptors. - - - - - - - An implementation of composite Service corresponding to a ServiceCompositeDescriptor. - - - - - - - Resource components of constituting a serivce descriptor. - - - - - - - - - A type of Request that represents a Customer Order's products decomposed into the services through which the products are realized. - - - - - - - Unique identifier for Interaction. - - - - - - ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) - - - - - - A way that can be used by order requester to prioritize orders in Service Order - - - - - Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. - - - - - - Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option”,). - - - - - - State of the order - - - - - The date on which an interaction is closed or completed. - - - - - - The date that was requested to start processing the order. - - - - - - The date on which an interaction is closed or completed. - - - - - - The date on which an interaction is expected to be completed. - - - - - - The date on which an interaction is started. - - - - - - Contact attached to the order to send back information regarding this order - - - - - - Reference to ServiceOrderItem - - - - - - - The date the order was placed. - - - - - - - The purpose for the ServiceOrder expressed in terms of a ServiceSpecification or a Service. - - - - Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). - - - - - - - - The action to take for an InteractionItem, such as add, change, remove. - - - - - State of the order item: described in the state machine diagram. This is the requested state. - - - - - Quantity of an interaction item involved in an interaction. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. - - - - - - - Resource components of constituting a serivce descriptor. - - - - - - - - - - - Resource instance components of constituting a service instance. - - - - - - - - - A ServiceCandidate (ServiceCatalogItem) is an entity that makes a ServiceSpecification available to a catalog. A ServiceCandidate and its associated ServiceSpecification may be “published” (made visible) in any number of ServiceCatalogs, or in none. One ServiceSpecification can be composed of other ServiceSpecifications. These ServiceSpecifications may also be published. - - - - A unique identifier for the ServiceCandidate - - - - - - A word or phrase that a ServiceCandidate is known and distinguished from other ServiceCandidates. - - - - - - - A narrative that explains the ServiceCandidate. - - - - - - The period of time during which the ServiceCandidate is applicable. - - - - - - The condition at which the ServiceCandidate exists such as planned, active and Obsolete. - - - - - - - A ServiceCatalog is a collection of ServiceCandidates representing ServiceSpecifications. ServiceCandidates define the underlying services that support a ProductOffering. ServiceCandidates are exposed to one or more Product Catalogs to be utilized to configure one or more ProductOfferings. ServiceCandidates can be exposed to one or more Service Catalogs to be utilized or incorporated in one or more ServiceCandidates. A collection may consist of similar ServiceCandidates, such as a collection of broadband ServiceCatalogCandidates or a collection of wireless ServiceCatalogCandidates. A Service Catalog contents can expose a collection of ServiceCandidates to be utilized internal/external to an enterprise. - - - - - - - Resource instance components of constituting a service instance. - - - - - - - - - A quality or distinctive feature that defines an entity, including the name of this feature (attribute), and the type of the actual value. - - - - Name of dynamic characteristic (attribute). - - - - - - Type of the dynamic characteristic value. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The value of a given ServiceCharacteristic - - - The value of a given ServiceCharacteristic - - - - - - - The SAPD class specifies the information used to instantiate the service access points of an NS. A Sapd inherits from the Cpd class. All attributes of the Cpd are also attributes of the Sapd. - - - - - - - Specify whether the SAP address assignment is under the responsibility of management and orchestration functions or not. -If it is set to True, management and orchestration functions are responsible for assigning addresses to the access points instantiated from this SAPD. - - - - - - References the descriptor of VNF or PNF external connection points the SAPs instantiated from this SAPD are mapped to. - - - - - - - - References the descriptor of the NS VL instance to which the SAP instantiated from this SAPD connects to. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constant identifier of the service model. - - - - - - Versioned identifier of the service model (this uuid is changed for every major version of the service) - - - - - - The name of the service model designed. - - - - - - The description of the service model designed. - - - - - - A predefined list which identifies the construct's category. There is a predefined list of service categories. - - - - - - - - The service model version. - - - - - - An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. - - - - - - An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. - - - - - - - - The icon path of the service. - - - - - - - - - - - - - - - - - - - - - - - - Identifier of this NSD class. It globally uniquely identifies an instance of the NSD - - - - - - Identifies the designer of the NSD. - - - - - - Identifies the version of the NSD. - - - - - - Provides the human readable name of the NSD. - - - - - - Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. - - - - - - Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD. -NOTE 1: The rule is based on a combination of assertions on the values of virtualised resource-related performance metrics and VNF Indicators identified by the monitoredInfo attribute. -NOTE 2: There may be multiple data sources (each identified as monitoredInfo) per rule - - - - - - - - - Identifies either a virtualised resource-related performance metric or a VNF Indicator. - - - - - - - - Provides a life cycle management script written in a Domain Specific Language (DSL). - - - - - - - - - - - - - - - - A composition of Network Functions and defined by its functional and behavioural specification. -NOTE: The Network Service (NS) contributes to the behaviour of the higher layer service, which is characterized by at least performance, dependability, and security specifications. The end-to-end network service behaviour is the result of the combination of the individual network function behaviours as well as the behaviours of the network infrastructure composition mechanism. - - - - Identifier of this NetworkService, identifying the NS instance. - - - - - - Human readable name of the NS instance. - - - - - - Human readable description of the NS instance - - - - - - Reference to consistituent VNFs and PNFs on this NS. -NOTE: Cardinality of zero is only valid for a non-instantiated NS. - - - - - - - - - Information on the VLs of this NS. -NOTE: Cardinality of zero is only valid for a non-instantiated NS. - - - - - - - - - Information on the SAPs of this NS. - - - - - - - Reference to information on nested NSs of this NS. - - - - - - - Information on the VNFFGs of this NS. - - - - - - - - - A set of BBS case specific properties information, which are needed for BBS service with the function realization. - - - - - A set of Slicing case specific properties information, which are needed for network slicing service with the function realization. - - - - A unique identifier of property of network slice related requirement should be supported by the network slice instance. - - - - - - This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density. - - - It is a structure containing the following elements: -- list of perfRequirements -Depending on the sST value, the list of perfRequirements will be -- list of eMBBPerfReq -or -- list of uRLLCPerfReq -or -- list of mIoTPerfReq -NOTE: the list of mIoTPerfReq is not addressed in the present document. - - - - - - - - This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used. - - - - - An attribute specifies whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s). -AllowedValues: shared, non-shared. - - - - - - An attribute specifies the maximum number of UEs may simultaneously access the network slice instance. - - - - - - - - This parameter specifies the slice/service type for a ServiceProfile. - - - - - - - - An attribute specifies the packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance. See clause 6.3.1 of 28.554. - - - - - - List of unique identities for PLMN. - - - - - - - An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. -AllowedValues: stationary, nomadic, restricted mobility, fully mobility. - - - - - An attribute specifies a list of TrackingAreas where the NSI can be selected. - - - - - - - - This parameter specifies the availability requirement for an network slice instance, expressed as a percentage. - - - - - - - - - The set of GSMA defined GST properties for network slicing service fuction realization. - - - - - - The set of 3GPP defined SliceProfile for network slicing subnet service fuction realization. - - - - - A unique identifier of the property of network slice subnet related requirement should be supported by the network slice subnet instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - An attribute specifies whether the resources to be allocated to the network slice subnet instance may be shared with another network slice subnet instance(s). -AllowedValues: shared, non-shared. - - - - - - - The set of 3GPP defined ServiceProfile for network slicing service function realization. - - - - - A unique identifier of property of network slice related requirement should be supported by the network slice instance. - - - - - - This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used. - - - - - List of unique identities for PLMN. - - - - - - - This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density. - - - It is a structure containing the following elements: -- list of perfRequirements -Depending on the sST value, the list of perfRequirements will be -- list of eMBBPerfReq -or -- list of uRLLCPerfReq -or -- list of mIoTPerfReq -NOTE: the list of mIoTPerfReq is not addressed in the present document. - - - - - - - - An attribute specifies the maximum number of UEs may simultaneously access the network slice instance. - - - - - - - - An attribute specifies a list of TrackingAreas where the NSI can be selected. - - - - - - - - An attribute specifies the packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance. See clause 6.3.1 of 28.554. - - - - - - An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. -AllowedValues: stationary, nomadic, restricted mobility, fully mobility. - - - - - An attribute specifies whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s). -AllowedValues: shared, non-shared. - - - - - - This parameter specifies the slice/service type for a ServiceProfile. - - - - - - This parameter specifies the availability requirement for an network slice instance, expressed as a percentage. - - - - - - - - - A set of CCVPN case specific properties information, which are needed for CCVPN service with the function realization. - - - - - A set of CCVPN case specific properties information, which are needed for CCVPN service with the function realization. - - - - - - - - - - - - - - - - - - - - - - - - - - - The VirtualLinkToLevelMapping datatype specifies the profile to be used for a VL involved in a given NS level and bitrate requirements. - - - - Identifies the profile to be used for a VL involved in an NS level. - - - - - Specifies the bit rate requirements for the NS level. -NOTE: It shall be in the range of minBitrateRequirements - maxBitrateRequirements, as specified in the referenced VirtualLinkProfile. - - - - - - - - - - - - - - - - - A base / value business entity used to represent a period of time, between two timepoints - - - - An instant of time, starting at the TimePeriod - -Notes: -If null, then represents to the beginning of time - - - - - - An instant of time, ending at the TimePeriod: - -Notes: -If null, then represents to the end of time - - - - - - - - - - - - - - - A way that can be used by order requester to prioritize orders in Service Order Management system (from 0 to 4: 0 is the highest priority, and 4 the lowest). It could be for example valued by BSS based on customer order requested priority. - - - - - - - - - - - - - - - - The LifeCycleManagementScript information element specifies a script for the service. - - - - Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator -reference point. - - - Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator -reference point. - - - - - - - Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. - - - - - - - - Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. - - - - - - Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. - - - - - - Array of KVP 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/ONAP Information Model/StyleSheets/ClassDiagramStyleSheet.css b/ONAP Information Model/StyleSheets/ClassDiagramStyleSheet.css deleted file mode 100644 index 5f4a775..0000000 --- a/ONAP Information Model/StyleSheets/ClassDiagramStyleSheet.css +++ /dev/null @@ -1,16 +0,0 @@ -Class > Compartment[kind="nestedclassifiers"] { - visible:false; -} - -Class > Compartment[kind="operations"] { - visible:false; -} - -DataType > Compartment[kind="operations"] { - visible:false; -} - -Property { maskLabel: name type multiplicity defaultValue;} - -Label[type=StereotypeLabel]{ - visible:false;} \ No newline at end of file diff --git a/ONAP Information Model/StyleSheets/CompartmentRestrictions.css b/ONAP Information Model/StyleSheets/CompartmentRestrictions.css deleted file mode 100644 index f70f23f..0000000 --- a/ONAP Information Model/StyleSheets/CompartmentRestrictions.css +++ /dev/null @@ -1,11 +0,0 @@ -Class > Compartment[kind="nestedclassifiers"] { - visible:false; -} - -Class > Compartment[kind="operations"] { - visible:false; -} - -DataType > Compartment[kind="operations"] { - visible:false; -} \ No newline at end of file diff --git a/ONAP Information Model/StyleSheets/NoStereotypesDiagram.css b/ONAP Information Model/StyleSheets/NoStereotypesDiagram.css deleted file mode 100644 index 9ebc245..0000000 --- a/ONAP Information Model/StyleSheets/NoStereotypesDiagram.css +++ /dev/null @@ -1,4 +0,0 @@ -Property { maskLabel: name type multiplicity defaultValue;} - -Label[type=StereotypeLabel]{ - visible:false;} \ No newline at end of file diff --git a/ONAP Information Model/Ves.di b/ONAP Information Model/Ves.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Ves.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Ves.notation b/ONAP Information Model/Ves.notation deleted file mode 100644 index 505cc47..0000000 --- a/ONAP Information Model/Ves.notation +++ /dev/null @@ -1,7985 +0,0 @@ - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - multiplicity - visibility - name - type - derived - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - multiplicity - visibility - name - type - modifiers - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - multiplicity - visibility - name - type - modifiers - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - multiplicity - visibility - name - type - modifiers - derived - - - - - - -
- - - - - - - - multiplicity - visibility - name - type - derived - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Ves.uml b/ONAP Information Model/Ves.uml deleted file mode 100644 index f805bc7..0000000 --- a/ONAP Information Model/Ves.uml +++ /dev/null @@ -1,5599 +0,0 @@ - - - - - - - An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. - -ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc... Appropriate schemas will be supplied. - - - - - - - - Event domain enumeration: 'cmNotify',‘fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ - - - Update in definition only - - - - - For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ - - - - - - - - the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds - - - - - - - Network function component type: 3 characters (aligned with vfc naming standards) - - - - - - - - Network function type: 4 characters (aligned with vnf and pnf naming standards) - - - - - - - - Network function vendor name - - - - - - Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ - - - - - - reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. - -Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - - - - UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. - - - - - - - - reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - - - - Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - - - - - - sequence - Ordering of events communicated by an event source instance (or 0 if not needed) - - - - Ordering of events communicated by an event source instance (or 0 if not needed) - - - - - - sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity - -Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - - - - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. - - - - - - - - sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - - - - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - - - - - - startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). - -For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). - - - - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) - - - - - - - Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples - - - - - - - - Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). - - - - - - - - - - - Fields specific to fault events - - - - - Additional alarm information. -• Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). -• Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’. -Could contain managed object instance as separate key:value; could add probable cause as separate key:value. - - - - - - - - Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) - - - - - - Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. - - - - - - - - Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’ - - - - - - - - Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. - - - - - Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class. - - - - - - Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field. - - - - - - Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ - - - - - - The heartbeatFields datatype is an optional field block for fields specific to heartbeat events. - - - - - Additional expansion fields if needed. - - - - - - - - Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Current heartbeatInterval in seconds. - - - - - - - - Fields specific to measurement events - - - - - Additional measurement fields if needed. - - - - - - - - - Array of named hashMap if needed. - - - - - - - - Array of Schema objects described by name, schema and other meta-information, if needed. - - - - - - - - Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. - - - - - - - - - Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF - - - - - - - - - The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. - - - - - - - - Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. - - - - - - - - - Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Interval over which measurements are being reported in seconds - - - - - - Represents busy-ness of the network function from 0 to 100 as reported by the nfc. - - - - - - - - - Number of media ports in use. - - - - - - - Peak request rate per second, for the VM over the measurementInterval - - - - - - - Array of metrics on hugePages - - - - - - - Array of codecs in use - - - - - - - Usage of an array of CPUs - - - - - - - Usage of an array of disks - - - - - - - Filesystem usage of the VM on which the xNFC reporting the event is running - - - - - - - Array of intelligent platform management interface metrics - - - - - - - Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. - - - - - - - Array of system load metrics - - - - - - - Array of machine check exceptions - - - - - - - Memory usage of an array of VMs - - - - - - - Performance metrics of an array of network interface cards - - - - - - - Array of metrics on system processes - - - - - - - - Fields specific to mobility flow events - - - - - additionalFields - Additional mobileFlow fields if needed. - - - - - - - - applicationType - Application type inferred - - - - - - - - - applProtocolType - Application protocol. - - - - - - - - - applProtocolVersion - Application version. - - - - - - - - - cid - Cell Id. - - - - - - - - - connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. - - - - - - - - - ecgi - Evolved Cell Global Id. - - - - - - - - flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. - - - - - - - - - gtpProtocolType - GTP protocol - - - - - - - - - gtpVersion - GTP protocol version. - - - - - - - - - httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. - - - - - - - - - imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. - - - - - - - - - imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device - - - - - - - - - ipProtocolType - IP protocol type e.g., TCP, UDP, RTP... - - - - - - - - - ipVersion - IP protocol version e.g., IPv4, IPv6 - - - - - - - - - lac - Location area code. - - - - - - - - - mcc - Mobile country code. - - - - - - - - - mnc - Mobile network code. - - - - - - - - - mobileFlowFieldsVersion - Version of the mobileFlowFields block. - - - - - - - - - msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device. - - - - - - - - - otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. - -Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - - - - - - - - otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on - - - - - - - - - otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... - - - - - - - - - rac - Routing area code - - - - - - - - - radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) - - - - - - - - - reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. - -Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - - - - - - - - - reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. - - - - - - - - - sac - Service area code - - - - - - - - - samplingAlgorithm - Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied. - - - - - - - - - tac - Transport area code - - - - - - - - - tunnelId - Tunnel identifier - - - - - - - - - vlanId - VLAN identifier used by this flow - - - - - - - - - Mobility GTP Protocol per flow metrics - - - - - - - - Fields specific to notification events - - - - - Additional notification fields if needed. - - - - - - - - arrayOfNamedHashMap - Array of named hashMaps - - - - - - - - Identifier for a contact related to the change. - - - - - - - - - System or session identifier associated with the change. - - - - - - - Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… - - - - - - New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ - - - - - - - - Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Previous state of the entity. - -For example: "inService", "outOfService", "maintenance" - - - - - - - - - Card or port name of the entity that changed state. - - - - - - - - - - The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration. - - - - - Array of named hashMaps - - - - - - - Array of name-value pairs. - - - - - - - - Array of schema objects described by name, schema and other meta-information. - - - - - - - - Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - - The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain enumeration; it consists of the following fields: - - - - - Additional pnfRegistration fields if needed - - - - - - - TS 32.692 dateOfLastService = date of last service; e.g. 15022017 - - - - - - - - MAC address of OAM interface of the unit - - - - - - - - TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 - - - - - - - - TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model - - - - - - - - IPv4 m-plane IP address to be used by the manager to contact the PNF - - - - - - - - IPv6 m-plane IP address to be used by the manager to contact the PNF - - - - - - - - Version of the registrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - - - TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 - - - - - - - - TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 - - - - - - - - TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU - - - - - - - - TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale - - - - - - - - TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor - - - - - - - - - sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state. - - - - - - zdditionalInformation - Additional sipSignalling fields. - - - - - - - - compressedSip - The full SIP request/response including headers and bodies. - - - - - - - - - correlator - Constant across all events on this call. - - - - - - - localIpAddress - IP address on VNF. - -Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - - - - - - - localPort - Port on VNF. - - - - - - - remoteIpAddress - IP address of peer endpoint. - -Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= - - - - - - - - remotePort - Port of peer endpoint - - - - - - - sipSignalingFieldsVersion - Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - - summarySip - The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc). - - - - - - - - - Vendor, NF and nfModule names - - - - - - - - Fields specific to state change events. - - - - - Additional stateChange fields if needed - - - - - - - New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ - - - - - Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ - - - - - Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Card or port name of the entity that changed state - - - - - - - Syslog’s can be classified as either Control or Session/Traffic. They differ by message content and expected volume: -• Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. -• Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). -VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution. - - - - - - Additional syslog fields if needed Ex: {“name1”: ”value1”, “name2: “value2” … } - - - - - - - Hostname of the device - - - - - - - - Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’ - - - - - - - - 0-32 char in format name@number, -i.e., ourSDID@32473 - - - - - - - - - Numeric code from 0 to 23 for facility: - 0 kernel messages - 1 user-level messages - 2 mail system - 3 system daemons - 4 security/authorization messages - 5 messages generated internally by syslogd - 6 line printer subsystem - 7 network news subsystem - 8 UUCP subsystem - 9 clock daemon - 10 security/authorization messages - 11 FTP daemon - 12 NTP subsystem - 13 log audit - 14 log alert - 15 clock daemon (note 2) - 16 local use 0 (local0) - 17 local use 1 (local1) - 18 local use 2 (local2) - 19 local use 3 (local3) - 20 local use 4 (local4) - 21 local use 5 (local5) - 22 local use 6 (local6) - 23 local use 7 (local7 ) - - - - - - - - Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - Syslog message - - - - - - Hostname parsed from non-VES syslog message - - - - - - - - 0-192 -Combined Severity and Facility (see rfc5424) - - - - - - - - - Identifies the application that originated the message - - - - - - - - The process number assigned by the OS when the application was started - - - - - - - - A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT. - -Deprecated -The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs - - - - - - - - - Level-of-severity text enumeration defined below: -Text Sev Description -Emergency 0 system is unusable -Alert 1 action must be taken immediately -Critical 2 critical conditions -Error 3 error conditions -Warning 4 warning conditions -Notice 5 normal but significant condition -Info 6 Informational messages -Debug 7 debug-level messages - - - - - - - - Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP_STATUS_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided - - - - - - - - Timestamp parsed from non-VES syslog message - - - - - - - - IANA assigned version of the syslog protocol specification: - 0: VES - 1: IANA RFC5424 - - - - - - - - - - - - - - The diskUsage datatype defines the usage of a disk device. - - - - The number of bus resets in the performance interval. - - - - - - - - - Number of disk commands aborted over the measurementInterval. - - - - - - - - - Average number of commands per second over the measurementInterval. - - - - - - - - - Total flush requests of the disk cache over the measurementInterval. - - - - - - - - - Milliseconds spent on disk cache flushing over the measurementInterval. - - - - - - - - - Disk Identifier. - - - - - - - Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval - - - - - - Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval. - - - - - - - - - Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval - - - - - - - - Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval. - - - - - - - - - Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval. - - - - - - - - - Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval. - - - - - - - - - Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval. - - - - - - - - - Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval. - - - - - - - - - Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval - - - - - - - - - Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval. - - - - - - - - - Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval. - - - - - - - - - Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval. - - - - - - - - - Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. - - - - - - - - - Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval - - - - - - - - - Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. - - - - - - - - - Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. - - - - - - - - - Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. - - - - - - - - - Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. - - - - - - - - - Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. - - - - - - - - - Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. - - - - - - - - - Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. - - - - - - - - - Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. - - - - - - - - - Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. - - - - - - - - - Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. - - - - - - - - - Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. - - - - - - - - - Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. - - - - - - - - - Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. - - - - - - - - - Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. - - - - - - - - - Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. - - - - - - - - - Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. - - - - - - - - - Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. - - - - - - - - - diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. - - - - - - - - - Average number of read commands issued per second to the disk over the measurementInterval. - - - - - - - - - Nanoseconds spent on disk cache reads/writes within the measurementInterval. - - - - - - - - - Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. - - - - - - - - Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. - - - - - - - - - Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. - - - - - - - - - Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. - - - - - - - - - Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. - - - - - - - - - Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. - - - - - - - - - Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. - - - - - - - - - Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. - - - - - - - - - The average amount of time taken for a read from the perspective of a Guest OS. This is the sum of Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval. - - - - - - - - - The average amount of time taken for a write from the perspective of a Guest OS. This is the sum of Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval. - - - - - - - - - Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. - - - - - - - - Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. - - - - - - - - Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. - - - - - - - - Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. - - - - - - - - Average number of write commands issued per second to the disk over the measurementInterval - - - - - - - - - The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval - - - - - Description of the codec. - - - - - - - Number of such codecs in use. - - - - - - - - The thresholdCrossingAlertFields datatype consists of the following fields: - - - - - additionalFields - Additional pnfRegistration fields if needed. - - - - - - - - Array of performance counters - - - - - - - Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ - - - - - Unique short alert description (e.g., NE-CPUMEM) - - - - - - Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’ - - - - - Calculated API value (if applicable) - - - - - - - - List of eventIds associated with the event being reported - - - - - - - - Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ - - - - - - Specific performance collector instance used - - - - - - - - Type of network element (internal AT&T field) - - - - - - - - Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’ - - - - - Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ - - - - - - Physical or logical port or card (if applicable - - - - - - - - Network name (internal AT&T field) - - - - - - - - Reserved for future use - - - - - - - - Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - - The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields: - - - - - Additional voice quality fields - - - - - - - Callee codec for the call - - - - - - Caller codec for the call - - - - - - Constant across all events on this call - - - - - - Phone number associated with the correlator - - - - - - - - Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) - - - - - - Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. - - - - - - End of call voice quality metric summaries - - - - - - - Vendor, NF and nfModule names - - - - - - - - The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: - - - - The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval - - - - - - - - - The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval - - - - - - - - - CPU demand in MHz - - - - - - - - - CPU demand as a percentage of the provisioned capacity - - - - - - - - CPU Identifier - - - - - - - Percentage of CPU time spent in the idle task - - - - - - - - - cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. - - - - - - - - - The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval - - - - - - - - - Swap wait time, in milliseconds over the measurementInterval - - - - - - - - - Percentage of time spent servicing interrupts - - - - - - - - - Percentage of time spent running user space processes that have been niced - - - - - - - - - -Percentage of time spent handling soft irq interrupts - - - - - - - - Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing - - - - - - - - Percentage of time spent on system tasks running the kernel - - - - - - - - Percentage of time spent running un-niced user space processes - - - - - - - - Percentage of CPU time spent waiting for I/O operations to complete - - - - - - - - Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running - - - - - - - - - The filesystemUsage datatype consists of the following fields: - - - - Configured block storage capacity in GB. - - - - - - - Block storage input-output operations per second. - - - - - - - Used block storage capacity in GB. - - - - - - - Configured ephemeral storage capacity in GB. - - - - - - - Ephemeral storage input-output operations per second. - - - - - - - Used ephemeral storage capacity in GB. - - - - - - - File system name. - - - - - - - - The hugePages datatype provides metrics on system hugePages - - - - Number of free hugePages in bytes. - - - - - - - - - Number of used hugePages in bytes. - - - - - - - - - HugePages identifier - - - - - - - - - Number of free hugePages in percent. - - - - - - - - - Number of used hugePages in percent. - - - - - - - - - Number of free hugePages in numbers. - - - - - - - - - Number of used hugePages in numbers. - - - - - - - - - - The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields: - - - - System fan exit air flow temperature in Celsius - - - - - - - - Front panel temp in Celsius - - - - - - - - Io module temp in Celsius - - - - - - - - Airflow in cubic feet per minute (cfm) - - - - - - - - Array of ipmiBaseboard Temperature objects - - - - - - - Array of ipmiBaseboard VoltageRegulator objects - - - - - - - Array of ipmiBattery objects - - - - - - - Array of ipmiFan objects - - - - - - - ipmi global aggregate temperature margin - - - - - - - Array of ipmiHsbp objects - - - - - - - Array of ipmiNic objects - - - - - - - Array of ipmiPowerSupply objects - - - - - - - Array of ipmiProcessor objects - - - - - - - - The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: -Field Type Required? Description - - - - - Baseboard temperature in celsius - - - - - - - - Identifier for the location where the temperature is taken - - - - - - - - - The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: - - - - Identifier for the baseboard voltage regulator - - - - - - Voltage regulator temperature in celsius - - - - - - - - - The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: - - - - Identifier for the battery - - - - - - Type of battery - - - - - - - - Battery voltage level - - - - - - - - - The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: - - - - Identifier for the fan - - - - - - Fan speed in revolutions per minute (rpm) - - - - - - - - - The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: - - - - Temperature margin in Celsius relative to a throttling thermal trip point - - - - - - - - Identifier for the ipmi global aggregate temperature margin metrics - - - - - - - The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: - - - - Identifier for the hot swap backplane power unit - - - - - - Hot swap backplane power temperature in celsius - - - - - - - - - The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: - - - - Identifier for the network interface control card - - - - - - nic temperature in Celsius - - - - - - - - - The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: - - - - Current output voltage as a percentage of the design specified level - - - - - - - - Identifier for the power supply - - - - - - Input power in watts - - - - - - - - Power supply temperature in Celsius - - - - - - - - - The ipmiProcessor datatype provides ipmi processor metrics - - - - Io module temperatue in celsius - - - - - - - - Front panel temperature in celsius - - - - - - - - Array of processorDimmAggregate ThermalMargin objects - - - - - - - Identifier for the power supply - - - - - - - The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket - - - - Number of counts falling within a defined latency bucket - - - - - - High end of bucket range (typically in ms) - - - - - - - - Low end of bucket range (typically in ms) - - - - - - - - - The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg - - - - number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg - - - - - - - - number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg - - - - - - - - number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg - - - - - - - - - The machineCheckException datatype describes machine check exceptions - - - - Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis - - - - - - - - Total hardware errors that were corrected by the hardware over the last one hour - - - - - - - - processIdentifier - - - - - - Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. - - - - - - - - Total uncorrected hardware errors that were detected by the hardware over the last one hour - - - - - - - - - The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: - - - - Kibibytes of temporary storage for raw disk blocks - - - - - - - - Kibibytes of memory used for cache - - - - - - - - Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running - - - - - - - - Host demand in kibibytes - - - - - - - - Kibibytes of physical RAM left unused by the system - - - - - - - - Percentage of time the VM is waiting to access swapped or compressed memory - - - - - - - - Shared memory in kilobytes - - - - - - - - The part of the slab that can be reclaimed such as caches measured in kibibytes - - - - - - - - The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes - - - - - - - - Amount of memory swapped-in from host cache in kibibytes - - - - - - - - Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second - - - - - - - - Amount of memory swapped-out to host cache in kibibytes - - - - - - - - Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second - - - - - - - - Space used for caching swapped pages in the host cache in kibibytes - - - - - - - - Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes - - - - - - - - Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. - - - - - - - - Virtual Machine identifier associated with the memory metrics - - - - - - - - - The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card - - - - Administrative state: enum: ‘inService’, ‘outOfService’ - - - - - - - Network interface card identifier - - - - - - Operational state: enum: ‘inService’, ‘outOfService’ - - - - - - - Cumulative count of broadcast packets received as read at the end of the measurement interval - - - - - - - - Count of broadcast packets received within the measurement interval - - - - - - - - Cumulative count of discarded packets received as read at the end of the measurement interval - - - - - - - - Count of discarded packets received within the measurement interval - - - - - - - - Cumulative count of error packets received as read at the end of the measurement interval - - - - - - - - Count of error packets received within the measurement interval - - - - - - - - Cumulative count of multicast packets received as read at the end of the measurement interval - - - - - - - - Count of multicast packets received within the measurement interval - - - - - - - - Cumulative count of octets received as read at the end of the measurement interval - - - - - - - - Count of octets received within the measurement interval - - - - - - - - Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. - - - - - - - - Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. - - - - - - - - Cumulative count of all packets received as read at the end of the measurement interval - - - - - - - - Count of all packets received within the measurement interval - - - - - - - - Cumulative count of unicast packets received as read at the end of the measurement interval - - - - - - - - Count of unicast packets received within the measurement interval - - - - - - - - Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. - - - - - - - - Speed configured in mbps. - - - - - - - - Cumulative count of broadcast packets transmitted as read at the end of the measurement interval - - - - - - - - Count of broadcast packets transmitted within the measurement interval - - - - - - - - Cumulative count of discarded packets transmitted as read at the end of the measurement interval - - - - - - - - Count of discarded packets transmitted within the measurement interval - - - - - - - - Cumulative count of error packets transmitted as read at the end of the measurement interval - - - - - - - - Count of error packets transmitted within the measurement interval - - - - - - - - Cumulative count of multicast packets transmitted as read at the end of the measurement interval - - - - - - - - Count of multicast packets transmitted within the measurement interval - - - - - - - - Cumulative count of octets transmitted as read at the end of the measurement interval - - - - - - - - Count of octets transmitted within the measurement interval - - - - - - - - Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. - - - - - - - - Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. - - - - - - - - Cumulative count of all packets transmitted as read at the end of the measurement interval - - - - - - - - Count of all packets transmitted within the measurement interval - - - - - - - - Cumulative count of unicast packets transmitted as read at the end of the measurement interval - - - - - - - - Count of unicast packets transmitted within the measurement interval - - - - - - - - Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. - - - - - - - - Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. - - - - - - - - - The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields: - - - - identifier for the aggregate thermal margin metrics from the processor dual inline memory module - - - - - - the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point - - - - - - - The processStats datatype provides metrics on system processes; it consists of the following fields: - - - - The number of threads created since the last reboot - - - - - - - - processIdentifier - - - - - - The number of processes in a blocked state - - - - - - - - The number of processes in a paging state - - - - - - - - The number of processes in a running state - - - - - - - - The number of processes in a sleeping state - - - - - - - - The number of processes in a stopped state - - - - - - - - The number of processes in a zombie state - - - - - - - - - - Average bit error rate - - - - - - Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets - - - - - - Average delivery latency - - - - - - Average receive throughput - - - - - - Average transmit throughput - - - - - - Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval - - - - - - - - Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval - - - - - - - - Endpoint activating the flow - - - - - - - - Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available - - - - - - Integer microseconds for the start of the flow connection - - - - - - Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ - - - - - - - - Endpoint deactivating the flow - - - - - - - - Time for the start of the flow connection, in integer UTC epoch time aka UNIX time - - - - - - Integer microseconds for the start of the flow connection - - - - - - Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ - - - - - - Connection status at reporting time as a working / inactive / failed indicator value - - - - - - Current connection state at reporting time - - - - - - - - Current tunnel state at reporting time - - - - - - - - Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow - - - - - - - Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' - - - - - - - - large packet round trip time - - - - - - - - large packet threshold being applied - - - - - - - - Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets - - - - - - - - maximum receive bit rate" - - - - - - - - maximum transmit bit rate - - - - - - - - array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow - - - - - - - Array of unique LTE QCI or UMTS class-of-service values observed in the flow - - - - - - - - Number of failed activation requests, as observed by the reporting node - - - - - - number of errored bits - - - number of errored bits - - - - - - number of bytes received, including retransmissions - - - - - - number of bytes transmitted, including retransmissions - - - - - - number of received packets dropped due to errors per virtual interface - - - - - - Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 - - - - - - - - Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 - - - - - - - - Http error count - - - - - - - - number of tunneled layer 7 bytes received, including retransmissions - - - - - - number of tunneled layer 7 bytes received, including retransmissions - - - - - - number of tunneled layer 7 bytes received, including retransmissions - - - - - - number of out-of-order packets - - - - - - number of errored packets - - - - - - number of packets received, excluding retransmission - - - - - - number of packets received, including retransmission - - - - - - number of packets transmitted, including retransmissions - - - - - - number of packet retrie - - - - - - number of packet timeouts - - - - - - number of tunneled layer 7 bytes received, excluding retransmissions - - - - - - Round Trip time - - - - - - Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow - - - - - - - Array of unique TCP Flags observed in the flow - - - - - - - - Time in milliseconds between the connection activation and first byte received - - - - - - - - Adjacency name - - - - - - Endpoint average jitter - - - - - - - - Enumeration: ‘Caller’, ‘Callee’ - - - - - Endpoint maximum jitter - - - - - - - - Endpoint RTP octets discarded - - - - - - - - Endpoint RTP octets lost - - - - - - - - Endpoint RTP octets received - - - - - - - - Endpoint RTP octets sent - - - - - - - - Endpoint RTP packets discarded - - - - - - - - Endpoint RTP packets lost - - - - - - - - Endpoint RTP packets received - - - - - - - - Endpoint RTP packets sent - - - - - - - - Local average jitter - - - - - - - - Local average jitter buffer delay - - - - - - - - Local maximum jitter - - - - - - - - Local max jitter buffer delay - - - - - - - - Local RTP octets discarded - - - - - - - - Local RTP octets lost - - - - - - - - Local RTP octets received - - - - - - - - Local RTP octets sent - - - - - - - - Local RTP packets discarded - - - - - - - - Local RTP packets lost - - - - - - - - Local RTP packets received - - - - - - - - Local RTP packets sent - - - - - - - - Decimal range from 1 to 5 (1 decimal place) - - - - - - - - one-way path delay in milliseconds - - - - - - - - Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) - - - - - - - - rFactor from 0 to 100 - - - - - - - - Round trip delay in milliseconds - - - - - - - - - vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information. - - - - nfModuleName - Name of the nfModule generating the event. - - - - - - - - - nfName - Name of the network function generating the event - - - - - - - - - vendorName - Network function vendor name. - - - - - - - - - - Additional key-value pairs if needed - - - - - - - Version of the perf3gpp event - - - - - - 3GPP measurement collection structure - - - - - - - - The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format - - - - 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 - - - - - - - - Granularity period for the PM report in seconds - - - - - - - - Array of monitored object local distinguished name ids per 3GPP TS 32.300 - - - - - - - - Distinguished name per 3GPP TS 28.550 - - - - - - - - Software version for the NF providing the PM data as specified in 3GPP TS 28.550 - - - - - - - - User Definable name for the measured object per 3GPP TS 28.550 - - - - - - - - Array of monitored object local distinguished name ids per 3GPP TS 32.300 - - - - - - - - - Name of the measurement job - - - - - - - - Measurement group Identifier - - - - - - - Measurement group Identifier - - - - - - - Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings - - - - - - - Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings - - - - - - - Array of measValues - - - - - - - - The measInfoIdInteger datatype provides an integer measurement group identifier; - - - - Integer measurement group Identifier - - - - - - - The measInfoIdString datatype provides a string measurement group identifier; - - - - String measurement group Identifier - - - - - - - The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results - - - - Array of integer measurement identifiers associated with the measurement results - - - - - - - - - The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results - - - - Array of string measurement identifiers associated with the measurement results - - - - - - - - - The measValues datatype provides 3GPP measurement values - - - - Additional key-value pairs if needed - - - - - - - Enumeration: ‘true’, ‘false’. Indicates if the values are suspect - - - VES 7.1 Spec has this attribute as a string. - - - - - - Array of results - - - - - - - Array of results - - - - - - - Array of results - - - - - - - Array of results - - - - - - - - The measResultInteger datatype provides an integer 3GPP PM measurement result; - - - - Integer reference to the counter - - - - - - Integer counter value - - - - - - - The measResultNull datatype provides a null 3GPP PM measurement result - - - - Integer reference to the counter - - - - - - Enumeration: ‘true’ or ‘false’ - - - The VES 7.1 Spec has this attribute as a string. - - - - - - - The measResultNumber datatype provides a number 3GPP PM measurement result - - - - Integer reference to the counter - - - - - - Number counter value - - - - - - - The measResultString datatype provides a string 3GPP PM measurement result; - - - - Integer reference to the counter - - - - - - String counter value - - - - - - - - - The hashMap datatype is an ‘associative array’, which is an unordered collection of key-value pairs of the form “key”: “value”, where each key and value are strings. Keys must use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized. - - - - A given entry in the hashmap, which is a key/value pair. - - - - - - - - - Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. - - - - - - - - - - Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ - - - - - - - - - - Array of named hashMaps - - - - Array of named hashMaps - - - - - - - - SchemaObject - The SchemaObject datatype provides an object schema, name and other meta-information along with one or more object instances that conform to the schema. - - - - Note: The VES Spec has this as a Json based object. - - - - objectInstances - Contains one or more instances of the SchemaObjectInstance object. - - - - - - - - objectName - Name of the object. - - - - - - - objectSchema - schema for the object. - - - - - - - - - objectSchemaUrl - URL to the schema for the object. - - - - - - - - - nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. - - - - - - - - - nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. - - - - - - - - - - SchemaObjectInstance [ ] - The SchemabjectInstance datatype provides meta-information about an instance of a SchemaObject along with the actual object instance. - - - - Note: The VES Spec has this as a Json based object. - - - - SchemaObject - Optional recursive specification on SchemaObject - - - - - - - - objectInstance - Contains an instance conforming to the SchemaObject schema - - - - - - - - - objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds. - - - - - - - - - objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). - - - - - - - - - - domain - Event domain enumeration: - -‘fault’, ‘heartbeat’, ‘measurementsForVfScaling’, ‘mobileFlow’, ‘other’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ - - - - - - - - - - - - - - - - - - - - Enumeration: ‘CRIT’, ‘MAJ’ - - - - - Key is the name of the counter and value is the current value of the counter - - - - - Last threshold that was crossed - - - - - - - arrayOfSchemaObject - The arrayOfSchemaObject datatype provides an array of json objects, each of which is described by name, schema and other meta-information. - - - - Note: The VES Spec has this as a Json based object. - - - - arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. - - - - - - - - - - - - - - - - - - Possible alertActions within thresholdCrossingAlertFields - - - - - - - - Possible values for ThresholdCrossingAlertFIelds alertType attribute. - - - - - - - - - - - - - namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name. - - - - - name - Name for the array of name-value pairs. - - - - - - - hashMap - One or more key:value pairs. - -Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. - - - - - - - - - Level-of-severity text enumeration defined below: -Text Sev Description -Emergency 0 system is unusable -Alert 1 action must be taken immediately -Critical 2 critical conditions -Error 3 error conditions -Warning 4 warning conditions -Notice 5 normal but significant condition -Info 6 Informational messages -Debug 7 debug-level messages - - - - - system is unusable - - - 0 - - - - - action must be taken immediately - - - 1 - - - - - critical conditions - - - 2 - - - - - error conditions - - - 3 - - - - - warning conditions - - - - - - 4 - - - - - normal but significant condition - - - 5 - - - - - Informational messages - - - 6 - - - - - debug-level messages - - - 7 - - - - - - Numeric code from 0 to 23 for facility: - 0 kernel messages - 1 user-level messages - 2 mail system - 3 system daemons - 4 security/authorization messages - 5 messages generated internally by syslogd - 6 line printer subsystem - 7 network news subsystem - 8 UUCP subsystem - 9 clock daemon - 10 security/authorization messages - 11 FTP daemon - 12 NTP subsystem - 13 log audit - 14 log alert - 15 clock daemon (note 2) - 16 local use 0 (local0) - 17 local use 1 (local1) - 18 local use 2 (local2) - 19 local use 3 (local3) - 20 local use 4 (local4) - 21 local use 5 (local5) - 22 local use 6 (local6) - 23 local use 7 (local7) - - - - - kernel messages - - - - - user-level messages - - - - - mail system - - - - - system daemons - - - - - security/authorization messages - - - - - messages generated internally by syslogd - - - - - line printer subsystem - - - - - network news subsystem - - - - - UUCP subsystem - - - - - clock daemon - - - - - security/authorization messages - - - - - FTP daemon - - - - - NTP subsystem - - - - - log audit - - - - - log alert - - - - - clock daemon - - - - - local use 0 (local0) - - - - - local use 1 (local1) - - - - - local use 2 (local2) - - - - - local use 3 (local3) - - - - - local use 4 (local4) - - - - - local use 5 (local5) - - - - - local use 6 (local6) - - - - - local use 7 (local7 ) - - - - - - Threshold Crossing Alert counter criticality - possible values of CRIT and MAJ. - - - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - Array of ipmiBaseboard VoltageRegulator objects - - - - - -
- - - - - -
- - - Array of ipmiBaseboard Temperature objects - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - - - Fill in attribute defs and check attribute multiplicity - - - - Fields specific to fault events. - - - syslogFacility and syslogSev as enums? - - - Treated associatedAlertList as a String with multiplicity of * - - - measValues to measVlauesList - - - cmNotif as class or datatype. Given the complexity, I opted for a class - - - Not sure how to model correlatedNotifications. Looking for ITUT doc referenced. - - - event time - no type specified. - - - - - - Additional information nf provider wants to convey. - - - - - - - Version of the cmNotify - - - - - - Notifications to which this notification is considered to be correlated - - - - - - - Time of the cmNotify event. - - - - - - Unique Identifier for the source of this occurrence of the notification. For 3GPP devices this is the notification identifier as defined by ITUT - - - - - - Indicates the source of the operation that led to the generation of the notification. - - - - - - - DN of the management service provider - - - - - - - - Array of cmNotif notificatons - - - - - - - - Indicates the source of the operation - - - - internal operation of resource - - - - - response to management operation - - - - - result of SON - - - - - can’t determine why - - - - - - - Type of notification. This is an enum (managedObjectCreation, managedObjectDeletion, managedObjectAttributeValueChanged) - - - - - - - - Managed Object Instance that is the subject of this notification. In 3GPP devices this is the Distinguished Name (DN) which is used to uniquely identify a MO within a name space as defined by ITU-T - - - - - - - - Type of object identifier (Ynag, or ....) - - - - - - - - [R1] Attribute Name and values (attributeName(string), newAttributeValue(any type), oldAttributeValue(any type) -[R2] This is Mandatory for notifyMOIAttributeValueChange. 3GPP defines it as options for Creation and Deletion. - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Vnf.di b/ONAP Information Model/Vnf.di deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/Vnf.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/Vnf.notation b/ONAP Information Model/Vnf.notation deleted file mode 100644 index f3c3caf..0000000 --- a/ONAP Information Model/Vnf.notation +++ /dev/null @@ -1,10642 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/Vnf.uml b/ONAP Information Model/Vnf.uml deleted file mode 100644 index c8316ac..0000000 --- a/ONAP Information Model/Vnf.uml +++ /dev/null @@ -1,3883 +0,0 @@ - - - - - - -
- - - Defines descriptors of virtual compute resources to be used by the VNF. - - - - - -
- - - References to Vdus that are part of this group. - - - - - -
- - - - - -
- - - Describes external interface(s) exposed by this VNF enabling connection with a VL. - - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - -
- - - - - -
- - - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. - - - - - - - - -
- - - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. support: - - - - - - - - -
- - - Describes the software image which is directly loaded on the virtualisation container realising this Vdu. - -NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. - - - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - -
- - - Identifies a flavour within a VnfVirtualLinkDesc. - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - -
- - - - - - - - -
- - - Defines the internal VLD along with additional data which is used in this DF. - -NOTE 1: This allows for different VNF internal topologies between DFs. - -NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. - - - - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - - - - -
- - - - - -
- - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - - - -
- - - Uniquely references a VLD. - - - - - -
- - - - - -
- - - - - -
- - - Reference to the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect. - - - - - -
- - - - - - - - -
- - - - - -
- - - - - - - - -
- - - - - -
- - - Specify instantiation priority and dependencies of VDU. - - - - - - - - -
- - - - - -
- - - - - - - - - - - - - - -
- - - - - - - - - - - - - - -
- - - - - -
- - - An Anfd (Allotted Network Function Descriptor) is designed to run on top of some sharable NetworkFunction. It si therefore related to the NfD at design time. - -The NetworkFunctionDesc can be designed to have some number (zero to many). - - - - - - - - - - - -
- - - An AnfInstance (Allotted Network Function Instance) runs on top of some sharable NetworkFunction. The NetworkFunctionInstance can have some number (zero to many) of AnfInstances running on it. - - - - - - - - - - - - - Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management. - - - A few quick observations -1. Using integer for number. Jessie: Created a primitive called Number which is a superset of integer and real. -2. created a datatype called enum. Deleted enum. Created "enums" where needed. -3. Seems like we are just using ETSI (beyound what we have in the works). Jessie: It appears that way. -4. Is monitoring param a class or a data type? Jessie: It is a datatype. Due to it's relationship to event, maybe a class?? -5. Class versus datatype?? - - - - ResourceDesc??? - - - -. -can protocol be enumerated? - yes. Values? - -Change addrestype to enumeration -. -Change L2addressData and l3addressData to 0..1 given "only present...." definition - - - - orchestration Status - Pending, Created, Active... - Christina will query. -. -onboardedVnfPkgInfoId - need class for VnfPkg? Yes - probably need more discussion - tied to vnf model and internal model. Vnf Instance related to vnf descriptor or onboarding pkg descriptor - - - Will not try to push this out into R3 - save for R4 - - - ONAP has a VirtualLinkDesc, not NetworkLink or LinkDesc - -This will probably need to move to common - - - Attributes in violet - not necessary in Infomodell - can be retrieved from Vnfd. - - - Attributes in beige - added or changed - - - AnfInstanceRunsOnSharableNfInstance represents the "ProvidedBy". - -The Uses relationship is covered by the service instance expressing the sharable infrasturcture capability which has a relationship to the sharable resource. The ANF instance also has a relationship to the same sharable resource. - - - - Pnfs cannot run on a Vnf or Anf - -- Pnfs cannot run on Pnfs, etc. - - - - - - - The Virtualisation Deployment Unit (VDU) is a construct supporting the description of the deployment and operational behavior of a VNFC. - -A VNFC instance created based on the VDU maps to a single virtualisation container (e.g. a VM). - -A VNFC will only be in one VNFDesc. If a vendor wants to use the VNFC in mupliple VNFDesc (their product) they can do so, but it will be 'repeated'. - - - - - - - - Unique identifier of this Vdu in VNFD. - - - - - - - Human readable name of the Vdu. - - - - - - Human readable description of the Vdu. - - - - - - Boot order of valid boot devices. "key/name" indicates the the boot index "value" references a descriptor from which a valid boot device is created e.g. VirtualStorageDesc from which a VirtualStorage instance is created. - -NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. - - - - - - - - - Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment for the VNFC instance that involve additional entities or processes. "key/name" includes "AvailabilityZone", "HostAggregates". - -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. - - - - - - - - - Defines the virtualised resources monitoring parameters on VDU level. - - - - - - - Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. - - - - - - - - Describes the configurable properties of all VNFC instances based on this VDU. - - - - - Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. -NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as "volatile" parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as "persistent" parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental - - - - - - - Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. -NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as "volatile" parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as "persistent" parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental - - - - - - - - - - - - Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL). - - - - - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. - - - - - - - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. - - - - - - - Describes the software image which is directly loaded on the virtualisation container realising this Vdu. - -NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. - - - - - - - - - - - - - A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of deployment and operational behaviour requirements. It also contains connectivity, interface and virtualised resource requirements. - - - - - - - - - Provider of the VNF and of the VNFD. - - - - - - Name to identify the VNF Product. Invariant for the VNF Product lifetime. - - - - - - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package. - - - - - - Identifies the version of the VNFD. - - - - - - Human readable name for the VNF Product. Can change during the VNF Product lifetime. - - - - - - - - Human readable description of the VNF Product. Can change during the VNF Product lifetime. - - - - - - - - Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. Use the name of micro-service of the vnfm drive. For vendor specific VNFM, the value composes of "vendorname" and "vnfmdriver", e.g. "mycompanyvnfmdriver"; for generic VNFM, the value is "gvnfmdriver". - - - - - - - - Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html - -NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time. - - - - - - - - - Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation. - - - - - - - - Identifier of this 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. - - - - - - Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html - -NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time. - - - - - - - - - Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). - - - - - - - Includes a list of events and corresponding management scripts performed for the VNF. - - - - - - - File path of the vendor specified logo. - - - - - - - - UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. - - - - - - - - Virtualisation Deployment Unit. - - - - - - - Describes external interface(s) exposed by this VNF enabling connection with a VL. - - - - - - - Describes specific DF(s) of a VNF with specific requirements for capacity and performance. - - - - - - - Declares the VNF indicators that are supported by this VNF. - - - - - - - Defines descriptors of virtual compute resources to be used by the VNF. - - - - - - - Defines descriptors of virtual storage resources to be used by the VNF. - - - - - - - Reserved IP Address for VNF which is not bounded to any specific VNFC, but assigned manually from outside and potentially shared as a floating IP among VNFCs. - - - - - - - Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management. - - - - - - - Defines descriptors of software images to be used by the VNF. -NOTE: This shall be used to describe both the software image loaded on the virtualization container used to realize a VDU and the software images to be stored on VirtualStorage resources (e.g., volumes) attached to a virtualization container. - - - - - - - - Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP. - - - - - - - Defines security group rules to be used by the VNF. - - - - - - - - The SwImageDesc information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks. Storage not necessarily related to the compute, may be Network Attached Storage (NAS) - - - - - - - The identifier of this software image. - - - - - - The name of this software image. - - - - - - The version of this software image. - - - - - - The checksum of the software image file. - - - - - - The container format describes the container file format in which software image is provided. - - - - - - The disk format of a software image is the format of the underlying disk image. - - - - - - The minimal RAM requirement 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. - - - - - - - - The minimal disk size requirement 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. - - - - - - The size of the software image. - - - - - - Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. - - - - - - - - - Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. - - - - - - - - This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL - - - - - - - - The VduProfile describes additional instantiation data for a given VDU used in a DF. - - - - Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater. - - - - - - - Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater. - - - - - - - Specifies affinity or anti-affinity rules applicable between the virtualization 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 virtualization 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 virtualization containers (e.g. virtual machines) to be created based on this VDU. - - - - - - - - Identifier(s) of the 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 action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc. - - - - - - - - Timeout value for the VNFM to wait before the successful booting up of the VDU. - - - - - - - - VNFD needs to specify the security group name {security_groups} for each VDU. - - - - - - - - Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate ). - - - - - - - - - - - - - The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources. - - - - Unique identifier of this VirtualComputeDesc in the VNFD - - - - - - Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities. - - - - - - - Specifies compute requirements. - - - - - - - - The virtual memory of the virtualised compute. - - - - - The virtual CPU(s) of the virtualised compute. - - - - - The associated logical node requirements. - - - - - - - The local or ephemeral disk(s) of the virtualised compute. - - - - - - - - The VirtualStorageDesc information element supports the specifications of requirements related to persistent virtual storage resources. Ephemeral virtual storage is specified in VirtualComputeDesc information element. - - - - Unique identifier of this VirtualStorageDesc in the VNFD. - - - - - - - Type of virtualised storage resource (BLOCK, OBJECT, FILE). - - - - - - - Size of virtualised storage resource -(e.g. size of volume, in GB). - - - - - - - Specifies the details of block storage. It shall be present when the "typeOfStorage" attribute is set to "BLOCK". It shall be absent otherwise. - - - - - - - Specifies the details of object storage. It shall be present when the "typeOfStorage" attribute is set to "OBJECT". It shall be absent - - - - - - - Specifies the details of file storage. It shall be present when the "typeOfStorage" attribute is set to "FILE". It shall be absent otherwise. - - - - - - - Indicating whether a vDisk is a shared volume in VNFD. - - - - - - - - Describe storage Qos requirements. - - - - - - - Describe volume type. - - - - - - - - A VduCpd information element is a type of Cpd and describes network connectivity between a VNFC instance (based on this VDU) and an internal VL. - - - - - - - Bitrate requirement on this CP. - - - - - - - - - Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. - - - - - - - - - Describes the order to create the vNIC within the scope of this Vdu. - - - - - - - - - Describes the type of the vNIC this CP attaches to. - - - - - - - - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. - - - - - - - Define the port anti-affinity group ID for each SR-IOV type vNIC. Multiple vNICs in the same anti-affinity group must belong to the same virtual network, and the number of vNICs in the same anti-affinity group cannot exceed two. - - - - - - - - VNFD needs to specify the security group name {security_groups} for each vNic. - - - - - - - - VNFD needs to specify whether to enable security group for the vNic. - - - - - - - - Describe the Qos requirements of the VduCpd. - - - - - - - - Reference(s) of the Virtual Link Descriptor to which this Connection Point Descriptor(s) connects. - - - - - - - For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. - - - - - - - - - - The VnfDf describes a specific deployment version of a VNF. - - - - Identifier of this DF within the VNFD. - - - - - - - Human readable description of the DF. - - - - - - This attribute references the "instantiationLevel" entry which defines the default instantiation level for this DF. It shall be present if there are multiple "instantiationLevel" entries. - - - - - - - - Specifies the virtualised resource related performance metrics to be tracked by the VNFM. - - - - - - - Defines the internal VLD along with additional data which is used in this DF. - -NOTE 1: This allows for different VNF internal topologies between DFs. - -NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. - - - - - - - - Describes the various 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. - - - - - - - - Specifies affinity or 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. - - - - - - - - - The scaling aspects supported by this DF of the VNF. scalingAspect shall be present if the VNF supports scaling. - - - - - - - Describes additional instantiation data for the VDUs used in this flavor. - - - - - - - Determine where VNFC's (VDU's) are placed with respect to the VNF - - - - - - - BaseConfigGroup may set 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 provides the minimum viable VDU and associated VNFC configuration for a useable VNF. - - - - - - - Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. - - - - - - - Declares the VNF indicators that are supported by this VNF (specific to this DF). - - - - - - - - A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL. -When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements. - - - - - Specifies requirements 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. - - - - - - - - A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL. -When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements. - - - - - - - - - - - - - The VnfIndicator information element defines the indicator the VNF supports. - - - - Unique identifier. - - - - - - The human readable name of the VnfIndicator. - - - - - - - - Defines the allowed values or value ranges of this indicator. - - - - - - - - Describe the source of the indicator. This tells the consumer where to send the subscription request. - - - - - - The VirtualLinkDescFlavour describes additional instantiation data for a given internal VL used in a DF. - - - - QoS of the VL. - - - - - - - Identifies a flavour within a VnfVirtualLinkDesc. - - - - - - - - - This class specifies requirements on a virtual network interface. - - - - Provides a human readable name for the requirement. - - - - - - - - - Provides a human readable description of the requirement. - - - - - - - - - Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE). - - - - - - The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements - - - - - - - - This references (couples) 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. - - - - - - - - The InstantiationLevel class describes a given level of resources to be instantiated within a DF in term of the number of VNFC instances to be created from each VDU. -All the VDUs referenced in the level shall be part of the corresponding DF and their number shall be within the range (min/max) for this DF. - - - - - - - Uniquely identifies a level with the DF. - - - - - - Human readable description of the level. - - - - - - Represents for each aspect the scale level that corresponds to this instantiation level. scaleInfo shall be present if the VNF supports scaling. - - - - - - - Indicates the number of instance of this VDU to deploy for this level. - - - - - - - Specifies bitrate 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. - - - - - - - - - The VduLevel information element indicates for a given VDU in a given level the number of instances to deploy. - - - - Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. - - - - - - Uniquely identifies a VDU. - - - - - - - - A VNFD Element Group is a mechanism for associating elements of a VNFD (Vdus and VnfVirtualLinkDesc(s)) for a -certain purpose, for example, scaling aspects. - -A given element can belong to multiple groups. - - - - Unique identifier of this group in the VNFD. - - - - - - Human readable description of the group. - - - - - - References to Vdus that are part of this group. - - - - - - - References to VnfVirtualLinkDesc that are part of this group. - - - - - - - - - Every Vnf contains a BaseConfigGroup. - -BaseConfigGroup may set Access Control Lists (ACL's) and establish security groups and server groups. -BaseConfigGroup reates/establishs storage for the VM's (OpenStack Cinder). -BaseConfigGroup may establish internal networks such as OAM (VNF Mgmt) or MNS (Maintenance & Surveillance) established. - -A very simple VNF may only have a BaseConfig VnfElementGroup. - - - - - - - DeploymentGroup provides the minimum viable VDU and associated VNFC configuration for a useable VNF. I can have a small, medium, large deployment configuration. - - - - - - - Homing selects what cloud selection strategy will be used. - -HomingGroup is used to determine where VNF's within a given group are placed with respect to a service component. - -Homing strategy is as follows: -Colocation - members of the group share the same cloud region (VIM Domain) -isolation - members of the group do not share the same cloud region. - - - - - - - - The homing strategy can be one of the following: - -Exclusivity - Resources within the cloud region are exclusive to the group -Inclusively - Resources are co-located in the same cloud-region. -Diversity - Resources are geo-diverse ( cannot be co-located). - - - - - - - - - - - - - - Describes an external CP exposed by a VNF. - - - - - - - - An implementation of an NF that can be deployed on a Network Function Virtualisation Infrastructure (NFVI). - - - - - - - name to identify the VNF Product, invariant for the VNF Product lifetime - - - - - - - - provider of the VNF model - - - - - - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package - - - - - - identifier of the specific VNF package on which the VNF instance is based - - - - - - availability zone information of the VNF instance - - - - - - indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. - - - - - - - whether the VNF instance is instantiated - - - - - oam ip address, ipv4 - - - - - - - - oam ip address, ipv6 - - - - - - - - information specific to an instantiated VNF instance, e.g., vm information - - - - - - - - whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. - - - - - - - - Indicates whether the closed loop function is enabled or disabled. - - - - - - - - whether this VNF is accessed using SSH - - - - - - - - indicator for whether autoHeal and autoScale is enabled - - - - - - - Identifier of the policy which has the naming logic for this VNF instance - - - - - - Identifier of the policy which provides homing conditions. - - - - - - Relatonship to the VNF components that are part of this VNF. - - - - - - - Relationship to the VNF descriptor - - - - - - - Relationship to VnfVirtualLink - - - - - - - IP address between VNF and VNFM. - - - - - - - - - - - - - - - - - - - - - - - - - - An internal component of a VNF providing a VNF Provider a defined sub-set of that VNF's functionality, with the main characteristic that a single instance of this component maps 1:1 against a single Virtualisation Container. - - - - identifier of the NFC instance - - - - - - short code of the NFC instance - - - - - - - - description of the NFC instance - - - - - - - identifier of the model of the NFC instance - - - - - - layer-3 interface addresses, ipv4 - - - - - - - layer-3 interface addresses, ipv6 - - - - - - - operating status of the VM - valid value example: STARTED (POWER_ON), STOPPED (POWER_OFF) - - - - - - - whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. - - - - - - - - whether closed loop function is enabled - - - - - - - - An intelligent or human readable name of the vnfc instance. Multiple names are possible. - - - - - - - - Reference to the connection points of the vnfc - - - - - - - Identifier of the policy which has the naming logic for this VNFC instance - - - - - - English description of network function component that the specific VNFC deployment is providing. - - - - - - indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. - - - - - whether the VNFC instance is instantiated - - - - - Whether closed loop capabilities are enabled for this or not. - - - - - Reference to the VDU - - - - - - - - - - - - - An Anfd is the (Allotted Network Function) is a template which describes an ANF in terms of deploymnet and operational behaviour requiremnets. - - - - - - - - - The VirtualLinkProfile describes additional instantiation data for a given VL used in a DF. - - - - Uniquely identifies this VirtualLinkProfile class - - - - - - Specifies affinity or 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. - - - - - - - - - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. - - - - - - - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. - - - - - - - Identifies a flavour within the VnfVirtualLinkDesc. - - - - - Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. -NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group. - - - - - - - - - Uniquely references a VLD. - - - - - - - Specifies the protocol data for a VL instantiated according to this profile. Cardinality 0 is used when no protocol data needs to be specified. - - - - - - - - The ScalingAspect class describes the details of an aspect used for horizontal scaling. - - - - Unique identifier of this aspect in the VNFD. - - - - - - Human readable name of the aspect. - - - - - - Human readable description of the aspect. - - - - - - - A ScalingGroup determines which VNFC's (VDU's) are scaled together based on demand. - - - - - - - - - The Vnffgd class specifies a topology of connectivity of a NS and optionally forwarding rules applicable to the traffic conveyed over this topology. - - - - Identifier of this Vnffgd information element. It uniquely identifies a VNFFGD. - - - - - - References the VNFD of a constituent VNF. -NOTE 1: The list of constituent VNFs, PNFs, and nested NS SAPs of a VNFFG can be identical to the list of constituent VNFs, PNFs and nested NSs of the parent NSD, or can be a subset of it. -NOTE 2: The presence of a VNFD or PNFD identifier in a VNFFGD does not imply that all connection points instantiated from all embedded CPDs are connected to the VNFFG instantiated using the VNFFGD. - - - - - - - A reference to a pool of descriptors of connection points attached to one of the constituent VNFs and PNFs and/or one of the SAPs of the parent NS or of a nested NS. - - - - - - - - The network forwarding path associated to the VNFFG. - - - - - - - - References the PNFD of a constituent PNF. -NOTE 1 : The list of constituent VNFs, PNFs, and nested NS SAPs of a VNFFG can be identical to the list of constituent VNFs, PNFs and nested NSs of the parent NSD, or can be a subset of it. -NOTE 2: The presence of a VNFD or PNFD identifier in a VNFFGD does not imply that all connection points instantiated from all embedded CPDs are connected to the VNFFG instantiated using the VNFFGD. - - - - - - - - - - The VnfProfile class specifies a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF. - - - - - - - Identifier of this vnfProfile class. It uniquely identifies a VnfProfile. - - - - - - Identifier of the instantiation level of the VNF DF to be used for instantiation. -If not present, the default instantiation level as declared in the VNFD shall be used. - - - - - - - - Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. - - - - - - Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. - - - - - - Specifies affinity and anti-affinity rules applicable between VNF instances created from this profile. - - - - - - - Identifier(s) of the affinity or anti-affinity group(s) the VnfProfile belongs to. -NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationships between the VNF instance(s) created using this VnfProfile and the VNF instance(s) created using other VnfProfile(s) in the same group. - - - - - Defines the connection information of the VNF, it contains connection relationship between a VNF connection point and a NS virtual Link. - - - - - - - - Identifies a flavour within the VNFD. - - - - - - - Reference to the VNFD. - - - - - - - - A graph of logical links connecting NF nodes,where at least one node is a VNF, for the purpose of describing traffic flow between these network functions - - - - Identier of this Vnffg class. - - - - - Identifier of the constituent NFs of the VNFFG - - - - - Identifier(s) of the constituent VL instance(s) of the VNFFG. - - - - - - - Identifiers of the CP instances attached to the constituent VNFs and PNFs or the sap instances of the VNFFG. -NOTE: It indicates an exhaustive list of all the CP instances and SAP instances of the VNFFG. - - - - - Information on the NFPs of this VNFFG. - - - - - - A software image - - - - - This information element describes compute, memory and I/O requirements that are to be associated with the logical node of infrastructure. The logical node requirements are a sub-component of the VDU level requirements. As an example for illustration purposes, a logical node correlates to the concept of a NUMA cell in libvirt terminology. - - - - Identifies this set of logical node requirements. - - - - - - The logical node-level 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. - - - - - - - - - - Represents the type of network connectivity mandated by the VNF vendor between two or more Connection Points which includes at least one Internal Connection Point. - - - - - - - Specifies the virtualised resource related performance metrics on VLD level to be tracked by the VNFM. - - - - - - - Describes a specific flavour of the VL with specific bitrate requirements. - - - - - - - - Security group rule specifies the matching criteria for the ingress and/or egress traffic to/from the visited connection points. If an ingress traffic is accepted, the corresponding egress response shall be allowed, regardless of the security group rules on the egress direction. If an egress traffic is allowed, the corresponding ingress response shall be accepted, regardless of the security group rules on the ingress direction. The design of security group rule follows a permissive model where all security group rules applied to a CP are dealt with in an "OR" logic fashion, i.e. the traffic is allowed if it matches any security group rule applied to this CP. - - - - Identifier of the security group rule. - - - - - - Human readable description of the security group rule - - - - - - - - The direction in which the security group rule is applied. - - - - - - - - Indicates the protocol carried over the Ethernet layer. - - - - - - - - - Indicates the protocol carried over the IP layer. Permitted values: any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc. -See https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml -Note: IFA011 defines this as an enum, but as the list is not complete, made this a string. - - - - - - - - Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. - - - - - - - - - Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. - - - - - - - - - - An Allotted Network Function Instance is a network function provided (or allotted) by some service instance. The allotted network function may be incorporated into the topology of some consuming service like other network functions. - - - - - - - Link back to more information in the controller - - - - - - Concurrency value - - - - - - Orchestration status - - - - - - Indicator for whether the resource is considered operational - - - - - - Store the id of the access provider of this allotted-resource. - - - - - - Store the id of the access client of this allotted-resource. - - - - - - Store the id of the access topology of this allotted-resource. - - - - - - Store the id of the access node of this allotted-resource. - - - - - - Store the id of the access ltp of this allotted-resource. - - - - - - Store the cvlan of this allotted-resource. - - - - - - Store the vpn-name of this allotted-resource. - - - - - - - - - - - - - - - This information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks. - - - - Indicates whether the requested additional capability is mandatory for successful operation. - - - - - - Identifies a requested additional capability for the VDU. - - - - - - - Identifies the minimum version of the requested additional capability. - - - - - - - - Identifies the preferred version of the requested additional capability. - - - - - - - - Identifies specific attributes, dependent on the requested additional capability type. - - - - - - - - - The VirtualMemoryData information element supports the specification of requirements related to virtual memory of a virtual compute resource. - - - - Amount of virtual Memory (e.g. in MB). - - - - - - The memory core 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. - - - - - - - - Array of key-value pair requirements on the memory for the VDU. - - - - - - - - It specifies 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. - - - - - - - - - - The VirtualCpuData information element supports the specification of requirements related to virtual CPU(s) of a virtual compute resource. - - - - CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested. - - - - - - - - Number of virtual CPUs. - - - - - - Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. - - - - - - - - The CPU core 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. - - - - - - - - Array of key-value pair requirements on the Compute (CPU) for the VDU. - - - - - - - - The virtual CPU pinning configuration for the virtualised compute resource. - - - - - - - - The VirtualCpuPinningData information element supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource. - - - - The policy can take values of "static" or "dynamic". In case of "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). - - - - - - - - A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. - - - - - - - - This datatype defines the configurable properties of a VNF (e.g. related to auto scaling and auto healing). For a VNF instance, the value of these properties can be modified by the VNFM - - - - It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. - -NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. - - - - - - - - - It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. - -NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. - - - - - - - - - - - - - - - This datatype defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation. - - - - - - "Extension" attributes of VnfInfo that are writeable. NOTE: The exact data structure describing the attribute is left for data model solution specification, but it should include: name, and any constraints on the values, such as ranges, predefined values, etc. - - - - - - - Metadata" attributes of VnfInfo that are writeable. NOTE: The exact data structure describing the attribute is left for data model solution specification, but it should include: name, and any constraints on the values, such as ranges, predefined values, etc. - - - - - - - - - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. - - - - - - - Describes the 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. - - - - - - - - - Information to locate a 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. - - - - - - Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. - - - - - - Array of KVP 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. - - - - - - - - - - Specifies the virtualized resource related performance metric to be tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects the values of performance metrics identified by this information element from the VIM(s) using one or more locally initiated PM Jobs. These values can be used as inputs to auto-scaling rules. - - - - Unique identifier of the monitoring parameter. - - - - - - Human readable name of the monitoring parameter. - - - - - - - - Identifies the virtualized resource performance metric. - - - - - - An attribute that describes the recommended 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. - - - - - - - - - - - - - - This datatype defines the configurable properties of a VNFC. For a VNFC instance, the value of these properties can be modified through the VNFM. - - - - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. - - - - - - - - - Describes the type of VNIC to which a CP attaches. - - - - - - - - - - - The ScaleInfo information element represents a scale level for a particular scaling aspect. - - - - Reference to the scaling aspect. - - - - - The scale level, greater than or equal to 0 - - - - - - - Defines the CPU pinning policy. - - - - - - - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. - - - - - - - - - - - - - - - - - - - - - - - Describes the source of the indicator. - - - - - - - - Specifies the periodicity at which the producer will collect performance information. Note: at the end of each reportingPeriod, the producer will inform the consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. While the exact definition of the types for collectionPeriod and reportingPeriod is left for further specification, it is recommended that the reportingPeriod be equal or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period would be reported together. - - - - - - - - - - - - - - The VirtualLinkBitRateLevel information element specifies bitrate requirements applicable to a virtual link instantiated from a particular VnfVirtualLinkDesc. - - - - Uniquely identifies a VnfVirtualLinkDesc - - - - - Bitrate requirements for an instantiation level or bitrate delta for a scaling step. - - - - - - - Provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems. - - - - - - - - Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. - - - - - - - - - - - - - - - - - The VnfIndicatorData datatype identifies a VNF indicator in a VNFD. - - - - Identifies a VNFD. - - - - - Identifies a VNF indicator within the VNFD. - - - - - - The VnfToLevelMapping datatype specifies the profile to be used for a VNF involved in a given NS level and the required number of instances. - - - - Identifies the profile to be used for a VNF involved in an NS level. - - - - - Specifies the number of VNF instances required for an NS level. -NOTE 1: It shall be in the range of minNumberOfInstances-maxNumberOfInstances, as specified in the referenced VnfProfile. -NOTE 2: When the corresponding NS level is used in the context of NS instantiation, the numberOfInstances attribute specifies the number of VNF instances to be deployed. -NOTE 3: When the corresponding NS level is used in the context of NS scaling, the numberOfInstances attribute does not specify the number of VNF instances to be added/removed when reaching that NS scale level. The actual number of VNF instances to be added/removed can be derived by subtracting the numberOfInstances declared in the source NS scale level from the numberOfInstances declared in the target NS level of the scaling request. - - - - - - - Specifies the details of the block storage resource. - - - - Size of virtualised storage resource in GB. - - - - - - An array of key-value pairs that articulate the storage deployment requirements. - - - - - - - - Indicates if the storage supports rdma. - - - - - - - - Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. -Shall be absent when used for virtual disks. - - - - - - - - - The ObjectStorageData information element specifies the details of object storage resource. - - - - Max size of virtualised storage resource in GB. - - - - - - - - - The FileStorageData information element specifies the details of file storage resource. - - - - Size of virtualised storage resource in GB. - - - - - - The shared file system protocol (e.g. NFS, CIFS). - - - - - - Reference of the internal VLD which this file storage connects to. -The attached VDUs shall connect to the same internal VLD. - - - - - - - - Unique identifier of the storage Qos in VNFD. - - - - - - Name of storage QoS. - - - - - - Consumer type. - - - - - Describe qualities of Qos：total_bytes_sec、total_iops_sec. - - - - - - - - - - Unique identifier of volume type in VNFD. - - - - - - Name of volume type. - - - - - - Backend volume name of cinder. - - - - - - - The VirtualLinkProtocolData describes the protocol layer and associated protocol data for a virtual link - - - - One of the values of the attribute layerProtocol of the ConnectivityType IE. - - - - - - Specifies the L2 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise. - - - - - - - - Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise. - - - - - - - - - The QoS as applied to the vnf. - - - - - - - - Ingress or egress traffic - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ONAP Information Model/model.di b/ONAP Information Model/model.di deleted file mode 100644 index 0812886..0000000 --- a/ONAP Information Model/model.di +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/model.notation b/ONAP Information Model/model.notation deleted file mode 100644 index 8634d4c..0000000 --- a/ONAP Information Model/model.notation +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/ONAP Information Model/model.uml b/ONAP Information Model/model.uml deleted file mode 100644 index 9ad38b9..0000000 --- a/ONAP Information Model/model.uml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - - - - - - - - - - -
-
-
-
-
- - - - - - - - - - - - - diff --git a/ONAP_Information_Model/.project b/ONAP_Information_Model/.project new file mode 100644 index 0000000..29e168b --- /dev/null +++ b/ONAP_Information_Model/.project @@ -0,0 +1,11 @@ + + + ONAP Information Model + + + + + + + + diff --git a/ONAP_Information_Model/Common.di b/ONAP_Information_Model/Common.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Common.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Common.notation b/ONAP_Information_Model/Common.notation new file mode 100644 index 0000000..3f5f3ae --- /dev/null +++ b/ONAP_Information_Model/Common.notation @@ -0,0 +1,9266 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + multiplicity + visibility + name + type + modifiers + derived + + + + + + + + + + + + multiplicity + visibility + name + type + modifiers + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Common.uml b/ONAP_Information_Model/Common.uml new file mode 100644 index 0000000..4575357 --- /dev/null +++ b/ONAP_Information_Model/Common.uml @@ -0,0 +1,5015 @@ + + + + + + + + + + + + + + + + + The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature. + + + + Provides the signature of the signed part of the descriptor. + + + + + + Identifies the algorithm used to compute the signature. + + + + + + Provides a certificate or a reference to a certificate to validate the signature. +NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD + + + + + + + + This primitive type defines the version of an element. + + + + + type string { + pattern + '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; } + +A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. + +The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6 "; + reference + "RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace" + + + + + type string; + +The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66. + +Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1. + +The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent. + +Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate. + +A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required. + +In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017. + reference + "RFC 3986: Uniform Resource Identifier (URI): Generic Syntax + RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations + RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs)" + + + + + Primitive type describing a rule. + + + + + This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real. + + + + + priority - processing priority. + + + + + + + + + + object - objects are model elements that represent instances of a class or of classes + + + + + key - the key datatype is a tuple which provides the name of a key along with its value and relative order. + + + + + keyName - Name of the key. + + + + + + + keyOrder - Relative sequence or order of the key (with respect to other keys). + + + + + + + + + keyValue - Value of the key. + + + + + + + + + + Specifies the type of rule. + + + + + + + Defines the scope of the rule. + + + + + + + + + A base / value business entity used to represent a period of time, between two timepoints + + + + An instant of time, starting at the TimePeriod + +Notes: +If null, then represents to the beginning of time + + + + + An instant of time, ending at the TimePeriod: + +Notes: +If null, then represents to the end of time + + + + + + DateTime - RFC 2822 standard date/time format. + +RFC 2822 format +day-of-week, dd MM yyyy HH’:’mm’:’ss ‘GMT’ + +e.g. Tue, 21 Jun 2016 14:05:20 GMT + + + + + the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds + + + + + A primitive Type + + + + + + + Legend +Blue - Review Complete +Green - Ready for Review +White - Not Ready for Review + + + configurableProperties is a datatype + + + Does NF have a direct asociation to elementgroups, or would that be through a df? + + + Onboarding?? + + + Onboarding + + + Abstract + + + Concrete + + + Design Time + + + Runtime + + + Attributes in Pink are adds (not in IFA 01 + + + + +
+ + + + + + + + + + + + Common part of the various VLDs. + + + + + Uniquely identifies a VLD in the parent descriptor. +For VnfVirtualLinkDesc, the parent descriptor is the VNFD. +For NsVirtualLinkDesc, the parent descriptor is the NSD. +Note: the description of this class are different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition merges the 2 definitions. + + + + + Specifies the protocol exposed by a VL and the flow pattern supported by the VL. + + + + + Provides human-readable information on the purpose of the VL (e.g. control plane traffic). + + + + + + + + + A set of connection points along with the connectivity relationship between them and any associated target performance metrics (e.g. bandwidth, latency, QoS). NOTE: The Virtual Link can interconnect two or more entities (VNF components, VNFs, or PNFs) and it is supported by a Virtual Network (VN) of the NFVI. + + + + Link ports of this VL. + + + + + + + Identifier of the virtual link instance. + + + + + An intelligent or human readable name of the virtual link instance. + + + + + + Additional intelligent or human readable name of the virtual link instance. + + + + + + Generic description of the type of Virtual Link + + + + + + Role in the network this virtual link will be providing + + + + + + English description of the function this specific virtual link will be providing + + + + + + virtual link assigned (actual) bandwidth + + + + + + provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED + + + + + + Administrative status of the virtual link + + + + + + Specifies the minimum bitrate requirements for the virtual link + + + + + Specifies the maximum bitrate requirements for the virtual link + + + + + Indicates whether DHCP is enabled + + + + + + Indicates whether VLAn transparent mode is supported + + + + + + Indicates whether Trunk Mode is enabled + + + + + + Outer vlan tag + + + + + + + Inner vlan tag + + + + + + Identified the layerProtocol and flowPattern used by the virtual link + + + + + + Represents the port of the link. + + + + CP to be connected to this link port. + + + + + + + + Parent for all connection point classes. + + + + Identifier of the connection point instance. + + + + + Name of the Cp instance. + + + + + + alternative name of the Cp instance. + + + + + + Generic description of the type of Cp + + + + + + Role in the network this Cp will be providing + + + + + + English description of the function this specific Cp will be providing + + + + + + Cp description + + + + + + Cp (max? assigned?) bandwidth + + + Cp assigned (actual) bandwidth + + + + + + provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED + + + + + + Administrative status of the connection point. + + + + + + Protocol used by the Cp + + + + + + Indicator whether the Cp is in trunk mode + + + + + + Type of address: MAC address or IP address + + + + + + Only present when addressType is MAC address + + + + + + + Only present when addressType is IP address + + + + + + + + The Cpd class specifies the characteristics of connection points attached to NFs and NSs. This is an abstract class used as parent for the various Cpd classes. + +Note 1: the description of this class is different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition uses the definition in ETSI GS NFV IFA 014 as it is the more general. + + + + Identifier of this Cpd information element. + + + + + + Identifies the role of 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. + + + + + + + + + Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). + + + + + + + + + Identifies the 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 "layerProtocol" still needs further discussion and not included in this table. + + + + + + + + Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). + + + + + + + Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.). + + + + + + + Reference of the security group rules bound to this CPD. + + + + + + + + The AffinityOrAntiAffinityGroup class describes the affinity or anti-affinity relationship. For NSs, those rules are applicable between the VNF instances created using different VnfProfiles, the Virtual Link instances created using different VlProfiles or the nested NS instances created using different NsProfiles. + +For VNFs, those rules are applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s). + + + + Identifies an affinity or anti-affinity group to which the affinity or anti-affinity rule applies. + + + + + + Specifies whether the rule is an affinity rule or an anti-affinity rule. + + + + + Specifies the scope of the rule. + + + + + + + + + + + PlatformDescriptor is an abstract class that extends Descriptor to represent classes of objects that represent platofrm or internal descriptors. + + + + + ID that spans multiple versions of the same descriptor. + + + + + Type/Role/Function (a datatype). Classification may be a base type. + + + + + + + + + + + + + OnboardingNfDescriptor is an abstract class that extends Descriptor to represent classes of objects that represent onboarded network function descriptors. + + + + + Provider of the NF and of the NFD being onboarded. + + + + Provider of the NF and of the NFD being onboarded. + + + + + + + Human readable name for the NF Product. Can change during the NF Product lifetime. + + + + + + + + + Software version of the NF. This is changed when there is any change to the software that is included in the NF Package. + + + + + + + Information about localization languages of the NF (includes e.g. strings in the NFD). + +NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at NF instantiation time. + + + + valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html + + + + + + + + + Human readable description of the NF Product. Can change during the NF Product lifetime. + + + + + + + + + Default localization language that is instantiated if no information about selected localization language is available. + + + + valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html + + + condition: Shall be present if "localizationLanguage" is present and shall be absent otherwise. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + PlatformNfDescriptor is an abstract class that extends PlatformDescriptor to represent classes of design time objects that represent internal, or platform network function descriptors. + + + + + + + + + + + + + + + + + The VirtualLinkProfile class specifies a profile for instantiating VLs of a particular NS DF according to a specific VLD and VL DF. + + + + Uniquely identifies this VirtualLinkProfile class. + + + + + Identifies a flavour within the VLD. + + + + + + Specifies affinity and anti-affinity rules applicable between VLs instantiated from the referenced VLD. + + + + + + + Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. +NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group. + + + + + + + Specifies the maximum bitrate requirements for a VL instantiated according to this profile. +NOTE: These attributes are used to control scaling boundaries. + + + + + Specifies the minimum bitrate requirements for a VL instantiated according to this profile. +NOTE: These attributes are used to control scaling boundaries. + + + + + Uniquely references a VLD. + + + + + + + + + + The CpdPool class specifies a pool of descriptors of connection points and service access points. + + + + Identifier of this CpdPool class. It identifies a pool of descriptors of connection points and NS SAPs. + + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + The AddressData information element supports providing information about the addressing scheme and parameters applicable to a CP. + + + + Describes the type of 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. + + + + + + Provides the information on the MAC addresses to be assigned to the CP(s) instantiated from the parent CPD. +Shall be present when the addressType is MAC address. + + + + + + + Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD. +Shall be present when the addressType is IP address. + + + + + + + + The ConnectivityType datatype specifies the protocol exposed by a VL and the flow pattern supported by the VL.The top layer protocol of the VL protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers. + + + + Identifies the protocols to which this VL gives access (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire). + + + + + + Identifies the flow pattern of the connectivity (Line, Tree, Mesh). + + + + + + + + + A CpProtocolData information element describes and associates the protocol layer that a CP uses together with other protocol and connection point information. + + + + One of the values of the attribute layerProtocol of the Cpd IE. + + + + + + Provides information on the address to be assigned to the CP(s) instantiated from the CPD. + + + + + + + + The L2AddressData information element supports providing information about Layer 2 level addressing applicable to a CP. + + + + Specify if the MAC address 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. + + + + + + + + The L3AddressData information element supports providing information about Layer 3 level addressing scheme and parameters applicable to a CP. + + + + Specify if the address 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. + + + + + + + Specify if the floating IP scheme is activated on the CP or not. + + + + + + Define address type. + +NOTE: The address type should be aligned with the address type supported by the layerProtocol attribute of the parent Cpd. + + + + + + + + Minimum number of IP addresses to be assigned based on this L3AddressData information element. + + + + + + + + + Identifies the protocol to which this VL gives access. + + + + + + + + + + + The LinkBitrateRequirements information element describes the requirements in terms of bitrate for a VL. + + + + Throughput requirement of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN). + + + + + + Throughput requirement 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). + + + + + + + + + The LocalAffinityOrAntiAffinityRule describes the affinity or anti-affinity rule applicable between the virtualization containers to be created based on a particular VDU, or between internal VLs to be created based on a particular VnfVirtualLinkDesc. +Per VNF, the affinity/anti-affinity rules defined using this information element, using the AffinityOrAntiAffinityGroup information element, and using the placement constraints in the GrantLifecycleOperation as defined in ETSI GS NFV IFA 007 [i.3] should be conflict-free. In case of conflicts, the placement constraints in the GrantLifecycleOperation shall take precedence. + + + + + Specifies whether the rule is an affinity rule or an anti-affinity rule. + + + + + + Specifies the scope of the rule. + + + + + + The L2ProtocolData information element describes the L2 protocol related data for a virtual link. + + + The L2ProtocolData information element describes the L2 protocol related data for a virtual link. + + + + Network name associated with this L2 +protocol. + + + + + + + + Specifies the network type for this L2 +protocol. Possible values: FLAT, VLAN, +VXLAN, GRE. + +Note: If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value +is provided at design time in the VNFD. If a default value is provided at design-time, this value may be +overridden at run-time. + + + + + + + Specifies whether to support VLAN +transparency for this L2 protocol or not. + + + + + + + + Specifies the maximum transmission unit +(MTU) value for this L2 protocol. + + + + + + + + Network segment ID. + + + + + + + + The connected physical network of network type (VLAN or VxLAN) . + + + + + + + + Specify if a vrouter comes from an external network. + + + + + + + + + Specifies the network type for this L2 protocol. + + + + + + + + + The L3ProtocolData information element describes the L3 protocol related data for a virtual link. + + + The L3ProtocolData information element describes the L3 protocol related data for a virtual link. + + + + Network name associated with this L3 +protocol. + + + + + + + + Specifies IP version of this L3 protocol. +Value: +• IPV4. +• IPV6. + +NOTE : The value of the ipVersion attribute shall be consistent with the value of the layerProtocol attribute of the +ConnectivityType IE . + + + + + Specifies the CIDR (Classless Inter- +Domain Routing) of this L3 protocol. + +NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value +is provided at design time in the VNFD. If a default value is provided at design-time, this value may be +overridden at run-time. + + + + + + Specifies the allocation pools +with start and end IP addresses for this L3 +protocol. + +NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value +is provided at design time in the VNFD. If a default value is provided at design-time, this value may be +overridden at run-time. + + + + + + + Specifies the gateway IP address for this +L3 protocol. + +NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value +is provided at design time in the VNFD. If a default value is provided at design-time, this value may be +overridden at run-time. + + + + + + + + Indicates whether DHCP (Dynamic Host +Configuration Protocol) is enabled or +disabled for this L3 protocol. + +NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value +is provided at design time in the VNFD. If a default value is provided at design-time, this value may be +overridden at run-time. + + + Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. + + + + + + + + Specifies IPv6 address mode. Possible +values: +• SLAAC. +• DHCPV6-STATEFUL. +• DHCPV6-STATELESS. +May be present when the value of the +ipVersion attribute is "IPV6" and shall be +absent otherwise. + +NOTE : If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value +is provided at design time in the VNFD. If a default value is provided at design-time, this value may be +overridden at run-time. + + + + + + + Specifies IPv6 address mode for vrouter. Possible values: + +• SLAAC. + +• DHCPV6-STATEFUL. + +• DHCPV6-STATELESS. + +May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. Must be present when the VLAN/VXLAN connects to one or more vrouters. + +Note: The value of ipv6RaMode and ipv6AddressMode must be same. + + + + + + + + Static routing list, including estination and nexthop information. + + + + + + + DNS server list. + + + + + + + + + Specifies IPv6 address mode. +May be present when the value of the +ipVersion attribute is IPV6 and shall be +absent otherwise. + + + + + + + + Specifies IP version of this L3 protocol. +Value: +• IPV4. +• IPV6. + + + + + + + The QoS datatype specifies quality of service parameters applicable to a VL. +It is the asbstract parent of the NsQos and VnfQos datatypes, as the NsQoS (QoS in ETSI GS NFV IFA 014) includes a priority attribute, while VnfQoS (QoS in ETSI GS NFV IFA 011) does not. + + + + + Maximum latency in ms. + + + + + + Maximum jitter in ms. + + + + + Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. + + + + + + + Qos ID. + + + + + Human readable Qos name. + + + + + + Detailed requirements of Qos, including maximum bandwidth limitation{max_kbps}、maximum burst bandwidth limitation{max_burst_kbps} 、direction{egress|ingress}，etc. + + + + + + + + Type of address + + + + + + + + + A set of common business entities that collectively serve as the foundation of the ONAP Information Model.. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence. + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters. + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + Perhaps all these attributes can be moved up to OnboardingNfDescriptor + + + Add tosca.nodes.nfvl.nf attributes here (from https://wiki.onap.org/pages/viewpage.action?pageId=45303981) + + + + defaultLocalizationLangauge- string, not required (*) goes to OnboardingNfDescriptor + + + Perhaps put Polilcy, Descriptor under Entity + + + Should ManagedEntity be a subclass or an aggregation? + + + Do we root business interaction + + + can digitally communicate + + + Mgmt Domain + + + Note: This concept has some basis on the TMF SID Characteristic Pattern. + + + Colored classes are examples in the context of tis proposal. + + + + + + + valueMin<valueMax + + + + + This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment. + + + + Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + + + + + + + Defines a textual free-form description of the object. + + + + + + + + Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + + Identifier of this information element. This attribute shall be globally unique. + + + + + + + This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment. + + + + + + + Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain + + + + + + A ManagedEntity is used to specify that an Entity is manageable by electronic means. + + + + This is an enumerated integer that defines the particular type of management method that is currently being used. + +Permitted Values: + 0: Unknown + 1: None + 2: CLI + 3: SNMP + 4: TL1 + 5: CMIP + 6: Proprietary + + + + + + This is an array of integers that define the different management methods that are supported by this object. + +Permitted Values: + + 0: Unknown + 1: None + 2: CLI + 3: SNMP + 4: TL1 + 5: CMIP + 6: Proprietary + + + + + + + + + A template which describes an OperationalEntity in terms of deployment and operational behavior requirements. + + + Note: The only fields being used in this class are Name and MRN (manufactureReferenceNumber. The rest are optional. + + + + + The period during which the design entity is valid. + + + + + + + The condition of the specification, such s active, inactive, or planned. + + + + + + Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + + + + + Defines a textual free-form description of the object. + + + + + + + An OperationalEntity is a deployment in a NFV environment of a DesignEntity. + + + + + + SelectionCriteria finds descriptors and instances according to specific properties of those entities. + + + + Unique indentifier of this SelectionCriteria. + + + + + + + A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations. + + + + + Logical operation for filters composition, e.g. logical AND, OR, XOR. + + + + + + A simple (atomic) selection criteria that holds a specific attribute comparision expression. + + + + + Name of compared parameter or attribute. + + + + Name of compared parameter or attribute. + + + + + + + Comparison operator, e.g. equal, less than, greater or etc. + + + + + + Compared value (can be a name of a parameter in referenced class). + + + + + + The type of the value property (String, Integer, Real, ...). + + + + + + + A group of parameters that somehow relate or work together. + + + + Name of ParameterGroup + + + + + + Description of ParameterGroup. + + + + + + ID of ParameterGroup. + + + + + + Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime). + + + + Name of parameter. + + + + + + Boolean that specifices if this parameter is an input parameter. + + + + + + Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). + + + + + + + Bolean that specifices if the value can be modified or changed during the life of this parameter. + + + + + + The type of this parameter (integer, string, ...). + + + + + + A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. + + + + + + + + Description of the parameter. + + + + + + + The actual value of Parameter (runtime). + + + + Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. + + + + + The actual value of Parameter (runtime). + + + + + + + RangeValueSpec is generally expected to be of valueType integer or + + + RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter. + + + valueTo should be greater than valueFrom + + + rangeStep should be greater than zero. + + + + + rangeStep>0 + + + + + + The minimum value that a Parameter can take on. + + + + + + The maximum value that the parameter can take on. + + + + + + The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and valueTo attributes. + + + + + + + + + + DiscreteValueSpec represents a specific valid value that a given Parameter can take on. + + + + + A discrete value that the Parameter can take on. + + + + + + + A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec). + + + + + + + The operator being applied to to some group of selectoin critiera. + + + + + + + + The operator being applied to some atomic selection critera. + + + + + + + + Dynamic, configurable properites of some entity. + + + + The specific configurable properties of some entity. + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + Associates a business interction that is referenced by a business interction + + + + + + + + + +
+ + + Associates a business interaction that references + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + + + PolicyEvent is part of another effort, and is NOT agreed to at this time. + + + ServiceOrder and VesEvent are part of other contributions, and have already been accepted. + + + + + + A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law. + + + + + A reference number assigned to an Agreement that follows a prescribed numbering system. + + + + + + An overview and goals of the Agreement. + + + + + + + A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements. + + + + + Date interaction initiated + + + + + The date on which an interaction is closed or completed. + + + + + The current condition of an interaction, such as open, in research, closed, and so forth + + + + + + + + + The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource. + + + + Quantity of an interaction item involved in an interaction. + + + + + + The action to take for an InteractionItem, such as add, change, remove. + + + + + + + The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec. + + + + + Version of the business interaction. + + + + + The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction. + + + + + + A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction. + + + + + + A reply to a Request + + + + + + + An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement. + + + + A categorization of the relationship, such as bulk, parent/child, and so forth. + + + + + + Time period for which the relationship is valid + + + + + + + The type of relationship such as contains, relies on. + + + + + + Time period for which the relationship is valid + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/GenDoc/ONAP GenDoc Template.docx b/ONAP_Information_Model/GenDoc/ONAP GenDoc Template.docx new file mode 100644 index 0000000..7d76252 Binary files /dev/null and b/ONAP_Information_Model/GenDoc/ONAP GenDoc Template.docx differ diff --git a/ONAP_Information_Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx b/ONAP_Information_Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx new file mode 100644 index 0000000..d791ec3 Binary files /dev/null and b/ONAP_Information_Model/GenDoc/ONAP Model GenDoc Template-Landscape-v4-00.docx differ diff --git a/ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx b/ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx new file mode 100644 index 0000000..fe4e301 Binary files /dev/null and b/ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V13.docx differ diff --git a/ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx b/ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx new file mode 100644 index 0000000..3b8b427 Binary files /dev/null and b/ONAP_Information_Model/GenDoc/ONAP Model Glossary Template-Landscape-v4-00 V16 with Stereotypes.docx differ diff --git a/ONAP_Information_Model/GenDoc/ONAP Model Structure.docx b/ONAP_Information_Model/GenDoc/ONAP Model Structure.docx new file mode 100644 index 0000000..5fac349 Binary files /dev/null and b/ONAP_Information_Model/GenDoc/ONAP Model Structure.docx differ diff --git a/ONAP_Information_Model/Infrastructure.di b/ONAP_Information_Model/Infrastructure.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Infrastructure.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Infrastructure.notation b/ONAP_Information_Model/Infrastructure.notation new file mode 100644 index 0000000..efbd27e --- /dev/null +++ b/ONAP_Information_Model/Infrastructure.notation @@ -0,0 +1,3087 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Infrastructure.uml b/ONAP_Information_Model/Infrastructure.uml new file mode 100644 index 0000000..4f1ac5d --- /dev/null +++ b/ONAP_Information_Model/Infrastructure.uml @@ -0,0 +1,1052 @@ + + + + + + +
+ + + + + + + + +
+ + + Public cloud providers may not provide all their flavours in all of their regions. + + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + + +
+ + + The public cloud provider provides global API end points from which a user can manage their leased resources in any of the regions. + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + +
+ + + + + + +
+ + + + + + + + + + + + +
+ + + The physical data center has various compute flavours defined. These flavours may be universal across all the physical data centers, or may be local. + + + + + + + + + + + + +
+ + + The provider may support various transport options for access to the cloud and for inter-region transport. + + + + + + +
+ + + If regional availability zones are provided, they may be run by remote control planes (alternatively via the federated cloud control plane). + + + + + + + + +
+ + + Physical data centers may be organized into regional availability zones. + + + + + + + + +
+ + + If the physical data center isn't run by a remote control plane, it has a local control plane, or may be partitioned into several local control planes. + + + + + + + + + + +
+ + + If Network Zone is defined, the Local Control Plane belongs to a Network Zone. + + + + + + + + + +
+ + + The Network Zone is created as part of the physical design of the data center. Only large data centers are likely to have more than one Network Zone. + + + + + + + + + + +
+ + + Like OpenStack, the local control plane may configure one or more local availability zones. These help with placement requirements. + + + + + +
+ + + + + + + + + + + + +
+ + + A Compute Node is made a member of a local control plane. + + + + + + + + + +
+ + + The compute node is made into a member of a local availability zone. + + + + + + + + + + +
+ + + The Resource Profile describes the physical hardware and hypervisor of the compute node. + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + +
+ + + + + + +
+ + + If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. + + + + + + +
+ + + If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. + + + + + + +
+ + + If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. + + + + + + +
+ + + + + + + + + +
+ + + If a federated cloud was certain to exist in all owner-operated clouds, we'd make the association with that, but we're only guaranteed the existence of physical data centers. + + + + + + +
+ + + This relationship is part of the physical design of the data center. + + + + + + + + +
+ + + This relationship is part of the physical design of the data center. + + + + + + + + + + REMINDER: This is an information model, which identifies all the key entities, relations and attributes in the (cloud) Infrastructure domain. This is not a data model for implementation. + + + The information elements for a public cloud. + + + Should the model include the possibility of a network latency and jitter map, e.g., that could be instrumented by ONAP between the public cloud regions and availability zones that it plans to use? + + + A&AI: complex + + + A&AI: cloud-region + + + A&AI: pserver + + + XOR + + + + +
+
+
+
+
+ + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + PublicCloud Region is a public cloud provider's set of cloud data centers in a limited geography (e.g., a metropolitan area) and within a single jurisdictional boundary. + + + + + + + + The public cloud provider's name for the region. +Example, Microsoft Azure has regions "East US" and "East US 2". + + + + + + The city, and/or state or province, and country where the PublicCloudRegion is.  Note that the public cloud providers typically at best provide a city name for where the PublicCloudRegion and its availability zones are located. +E.g., Amazon AWS "US West" is in Northern California; "EU-West-2" is in London, "EU-West-3" is in Paris. +E.g., Microsoft Azure "US Central" is in Iowa; "US East 2" is in Virginia; one has to search through non-Microsoft public records to find out that "US East 2" may be in Boydton, Virginia. + + + + + + + + A distinct location within a PublicCloudRegion that is insulated from failures in other Availability Zones, and provides inexpensive, low-latency network connectivity to other Availability Zones in the same region. + + + + + + + + VirtualComputeFlavour represents the virtual machine sizes made available by the cloud provider (called vmSize in Azure, Instance Type in AWS, Machine Type in Google Cloud). + + + + The name that the cloud provider uses for this flavour. +E.g., Azure has a Standard_H8m with specifications like 8 vCPU, 112 GiB memory, 1000 GiB SSD ephemeral storage and a maximum of 2 NICs. + + + + + + Human readable description of the flavour. + + + + + + Number of virtual CPUs. +(implicitly assumes a "standard" or normalized vCPU). + + + + + + Virtual memory size in some units (e.g., MB, GB, GiB). + + + + + + The maximum size, in some units, of the root disk allowed for this flavour. If not specified, it may default to the size of the software image used in constructing the virtual machine. + + + + + + + Name-value pairs for additional information about the flavour, typically specific to a cloud-provider. Some examples include: swap disk size, maximum attachable disk count, maximum NICs, maximum cached throughput IOPs. + + + + + + + Hardware Platform Awareness attributes available in this flavour. + + + + + + + + + + The variety of cloud orchestration. + + + + + The ONAP instance has an account and credentials with the PublicCloudProvider. + + + + + The ONAP instance has an Account and Credentials with the PublicCloudProvider. + + + + + + + + + + + + There may be various options for transport to the cloud and between regions in the cloud. + + + + + The public cloud provider typically supports some virtualization file formats natively and provides translation utilities for other image formats. Software images and data disk images use these formats. +The image formats include: +- AMI - Amazon Machine Image +- VHD/VHDX - Virtual Hard Disk +- VMDK - ESX Virtual Machine Disk +- Raw +- QCOW2 +- ISO +- Docker container format + + + + List of native virtualization file formats supported by the cloudtype. + + + + + + + + The set of virtualization file formats for which the cloud provider makes translation-support available. + + + + + + + + + + Types of storage provided by the cloud provider. + + + + + The networking capabilities afforded by the cloud, e.g., are packet-forwarding VNFs allowed? e.g., is Ethernet VPN supported?, etc. + + + + + + + + + + + + + + + + Typically anti-IP-spoofing blocks packet forwarding, and in some clouds it may not be permitted/possible to turn this off. + + + + + + + The cloud provider (owner) may provide a federated view of the cloud data centers, e.g., provide global API endpoints. To facilitate operation in the cloud, identity, authentication and authorization should be federated. + + + + The variety of cloud orchestration. + + + + + The ONAP instance has an account and credentials with the PublicCloudProvider. + + + + + The ONAP instance has an Account and Credentials with the PublicCloudProvider. + + + + + + + + + + + The cloud may have a control plane that is remote - i.e., apart from agents, not co-located with the physical data center. This opens the possibility of a single remote control plane managing several physical data centers. + + + + + + + + + The control plane for the data center may be local rather than remote. The data center itself may be divided up among more than one local control plane. + + + + + + + + + + The physical data center in the owner operated cloud is at precisely known coordinates, unlike the public cloud region. The physical data center can range from a large installation to a rack of servers in a road-side cabinet. + + + + + + + + + + + + + + + + + + + + + + + Several edge physical data centers may be grouped together into a regional availability zone; e.g., these may be associated with a single instance of a remote control plane. + + + + + + + + + + The physical data center may be partitioned into local availability zones, one or more per local control plane. + + + + + This is the physical compute server, or in OpenStack parlance, a host. These are visible in the OpenStack Compute API to users with the administrative role. They may be similarly be visible in other implementations of an Owner-Operated Cloud. + + + + + + + + + + Total, used and available vCPUs, memory, local storage; +SR-IOV VFs? E.g., in OpenStack, this is visible in the Compute API to users with the administrative role, and similarly may be visible in other owner-operated cloud implementations. The compute node capacity measure can be rolled up to availability zone, or other levels of aggregation. + + + + + + A hardware and hypervisor profile for the Compute Node. This will include HPA attributes. A profile will typically apply to many Compute Nodes. + + + + Hardware Platform Awareness attributes available in this flavour. + + + + + + + + Network Zone reflects the organization of the network fabric and the WAN edges of the data center. Network Zone information goes beyond what e..g, OpenStack APIs expose to users with the administrative role; in fact, this information is not in OpenStack. One can think of implementations where this information is made available from the cloud to ONAP for the purpose of very precise placement. + + + + + Data center rack. + + + + + + + + + + + The list of cloud providers that the ONAP instance is configured to use, including any owner-operated (private) clouds. +ONAP should provide a default list, that the ONAP operator can customize. + + + + + + + + Element representing an owner-operated cloud. + + + + + + The major variety of cloud orchestration. ONAP should have a default list that the ONAP operator can customizie. + + + + Microsoft Azure + + + + + Amazon Web Services EC2 + + + + + VMWare Integrated OpenStack + + + + + + + + +
+
+
+
+
+ + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/License.di b/ONAP_Information_Model/License.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/License.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/License.notation b/ONAP_Information_Model/License.notation new file mode 100644 index 0000000..05cca35 --- /dev/null +++ b/ONAP_Information_Model/License.notation @@ -0,0 +1,3645 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/License.uml b/ONAP_Information_Model/License.uml new file mode 100644 index 0000000..f9e351e --- /dev/null +++ b/ONAP_Information_Model/License.uml @@ -0,0 +1,862 @@ + + + + + + VLM is really just a Party + +'Simplified' attributes for this Vendor are VendorName, and Description, which can be gotten from the Party model (PartyRole) + + + Only EntitlementPool attributes currently being used are Name and MRN. + + + Only attributes presently used are name, metric type and metric value. + + + Only name and type are required. +MRN should also be provided, but is not required. + + + Entitlement and key instances and their association to pools are in a license management system that is outside of ONAP + + + A&AI stores the entitlement asset tag as an attribute of the Vnf Instance + + + + An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family. + + + + + + + + Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + + + Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + + + + + + + + Term of the license: +-fixed term +-perpetual +-unlimited +-subscription + + + + + + + + +
+ + + A licenseKeyPool can contain some number of LicenseKeys. + + + + + LicenseKeyPool can contain some number of LicenseKeyInstances. + + + + + + + +
+ + + LicenseKey can have some number of service provider based limits applied to it. + + + + lLicenseKeyPool can have some number of service provider specified PoolLimits + + + + + +
+ + + LicenseKey can have some number of vendor based limits applied to it. + + + + + +
+ + + An EntitlementPool and the associated Entitlements can have some number of Service Provider based limits. + + + + EntitlementPool can have some number of service provider specified limits. + + + + + +
+ + + An EntitlementPool and the associated Entitlements can have some number of Vendor based limits. + + + + The EntitlementPool can have some number of Vendor specified limits. + + + + + +
+ + + A FeatureGroup can have one or more EntitlementPools associated with it. + + + + The EntitlementPool can be related to one FeatureGroup + + + + + + + FeatureGroup can be related to some number of EntitlementPools. + + + + + + + +
+ + + FeatureGroup can have 1 or more LicenseKeyPools and related LicenseKeys related to it. + + + + LicenseKeyPool is related to one FeatureGroup + + + + + + + A feature group can be related to some number of LicenseKeyPools + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + + + +
+ + + + A Vendor can have some number of LicenseAgreements. + + + + + + A LicenseAgreement is related to some vendor. + + + + + + + +
+ + + + EntitlementPool can contain some number of EntitlementInstances + + + + + EntitlementPool can contain some number of EntitlementInstances. + + + + + + + +
+ + + A Vnf can have some number of feature groups. A feature group can apply to one or more Vnfs. + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + A License Key Pool is created for each type of License Key that is required for the VNF. +Each License Key Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the License Key Pool are defined. + +The license key Pool model provides a description to interested systems for the license keys that are provided by a vendor. +A license key Pool is not specific to a feature group. A license key Pool may be related to multiple feature groups that a VNF belongs to or even to multiple VNFs. + + + + + + + + Pool limits applied by the service provider + + + + + + + Pool limits applied by the vendor. + + + + + + + The license key may be ‘universal’ or ‘unique’ or ‘one-time’. +- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. + +- A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. + +- A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. + + + + + + + + Units can be either absolute or a percentage (%). + + + + + + + Specified threshold value for the license key pool. + + + + + + + + Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000. + + + + + + + + Identifier that stays the same irrespective of version. + + + + + + The version of this entity. + + + + + + Identifier for the entitlement as described by the vendor in their price list / catalog /contract. + + + + + + + + + Represents an instance of a license key. +NOTE: This is an experimental class and is NOT currently used by the ONAP Platform + + + + + + + Vendor provided license key value that is entered into the vendor VNF to activiate / unlock it. + + + + + + + + The assignment status of the license (assigned, available, ...). + + + + + + The date the license key was assigned. + + + + + + Vendor provided license key file that is entered into the vendor VNF to activiate / unlock it. + + + + + + + + + A variable set of values that identify the limits that may be imposed by an entitlement instance in the pool. Multiple constraints may be applicable for an instance of entitlement in the pool. For example, an entitlement based on GB and number of sessions. Increments, aggregation function, time scope, threshold value may repeat for each metric in the list. + +Limits can be applied by the vendor or the service provider. + + + + Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc. + + + + + + The value of some limit being applied. + + + + + + Type of aggregation being performed (Peak or Average) + + + + + + + The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, ...) + + + + + Units time is specified in (day, month, hour, minute, second, millisecond. + + + + + + + + + LimitMetricType if Other enumeration is selected. + + + + + + + + + Represents an instance of a Entitlement +Specifies the use rights for the VNFs as described by the license. + +NOTE: This is an experimental class and is NOT currently used by the ONAP Platform + + + + + + + + The assignment status of the entitlement (assigned, available, ...). + + + + + + The date the entitlement was assigned. +NOTE; This is experimental and not currently used by ONAP + + + + + + + + + + + + An EntitlementPool is created for each type of Entitlement that is required for the VNFs. Each Entitlement Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the Entitlement Pool are defined. + +An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups containing a VNF or even to multiple VNFs. +Purchased entitlements are inventoried in the Entitlement Pools. + +Multiple pools for the same type of entitlement may be created based on the constraints. + + + + + + + + + + + + + Note: description is required according to the inherited attribute, but it presently is optional. + + + + + + + Pool limits applied by the service provider + + + + + + + Pool limits applied by the vendor. + + + + + + + Reference number for the entitlement as described by the vendor in their price list / catalog /contract. + + + + + + + + This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000. + + + + + + + + + A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: +when 90% of the pool is in-use, trigger an additional purchase of inventory. + + + + A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: +when 90% of the pool is in-use, trigger an additional purchase of inventory. + + + + + + + + + Specifies the Units for the ThresholdValue. + + + + + + + Identifier that stays the same irrespective of version. + + + Identifier that stays the same irrespective of version. + + + + + + The version of this entity. + + + + + + The license key may be ‘universal’ or ‘unique’ or ‘one-time’. +- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. + +- A ‘unique’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. + +- A ‘one-time’ value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. + + + + + + + Feature groups represent a set of the features of one or more VNFs. Feature groups may be defined by the vendor and/or by the service provider. A VNF may be related to multiple feature groups. At least one feature group will be related to a VNF. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the VNF(s) in it. +If an Entitlement Pool or License Key Group is associated with a particular Feature Group, the Feature Group becomes a “constraint” for the pool/group. + + + + + Name of the feature group + + + + + + Description of the feature group. + + + + + + + + The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to. + + + The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to. + + + + + + + An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family. + + + + + + + + Free form text. Includes information such as operating system or hypervisor required for the VNF instance. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + + + Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + + + + + + + + Term of the license: +-fixed term +-perpetual +-unlimited +-subscription + + + + + + + + + + + + + + + + + + Valid values: +year, quarter, month, day. +Not applicable when license type is Perpetual. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Units of the entitlement/license term. Valid values: year, quarter, month, day. + + + + + + + + + + + + + LicenseInventory and Purchasing outside the scope of ONAP + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/ModelStructure/OnapModelStructure.docx b/ONAP_Information_Model/ModelStructure/OnapModelStructure.docx new file mode 100644 index 0000000..999af9b Binary files /dev/null and b/ONAP_Information_Model/ModelStructure/OnapModelStructure.docx differ diff --git a/ONAP_Information_Model/Nf.di b/ONAP_Information_Model/Nf.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Nf.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Nf.notation b/ONAP_Information_Model/Nf.notation new file mode 100644 index 0000000..892ab77 --- /dev/null +++ b/ONAP_Information_Model/Nf.notation @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Nf.uml b/ONAP_Information_Model/Nf.uml new file mode 100644 index 0000000..c9d0d5d --- /dev/null +++ b/ONAP_Information_Model/Nf.uml @@ -0,0 +1,137 @@ + + + + + + + Deleted some duplicate attributes that are inherited from RootEntity (id, description, etc) + + + + + + A NetworkFunctionDesc is the descriptor for some functional block within a network infrastructure that has well-defined external interfaces and well-defined functional behaviour. + + + + + + + Indicates whether the NetworkFunction can be shared. + + + + + + + A functional block within a network infrastructure that has well-defined external interfaces and well-defined functional behaviour. NOTE: In practical terms, a Network Function is today often a network node or physical appliance + + + + + + + Description of the type of network function + + + + + + Role the network function will be providing. + + + + + + + + The NfIndicator class defines the indicator the NF supports + + + + + + + The human readable name of the NfIndicator. + + + + + + + + Defines the allowed values or value ranges of this indicator. + + + + + + + + Describe the source of the indicator. The possible values are: +• VNF, +• EM, +• Both. +This tells the consumer where to send the subscription request. + + + + + + + + + Describe the source of an indicator. + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Ns.di b/ONAP_Information_Model/Ns.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Ns.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Ns.notation b/ONAP_Information_Model/Ns.notation new file mode 100644 index 0000000..e90f27b --- /dev/null +++ b/ONAP_Information_Model/Ns.notation @@ -0,0 +1,2614 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Ns.uml b/ONAP_Information_Model/Ns.uml new file mode 100644 index 0000000..7178e60 --- /dev/null +++ b/ONAP_Information_Model/Ns.uml @@ -0,0 +1,743 @@ + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + The NSD class is a deployment template whose instances are used by the NFVO for the lifecycle management of NSs. +For all attributes in this class, the Producer is SDC and the Consumer is SDC/UUI/VFC + + + + + Identifier of this NSD class. It globally uniquely identifies an instance of the NSD + + + + + + Identifies the designer of the NSD. + + + + + + Identifies the version of the NSD. + + + + + + Provides the human readable name of the NSD. + + + + + + Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. + + + + + + Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD. +NOTE 1: The rule is based on a combination of assertions on the values of virtualised resource-related performance metrics and VNF Indicators identified by the monitoredInfo attribute. +NOTE 2: There may be multiple data sources (each identified as monitoredInfo) per rule + + + + + + + + + Identifies either a virtualised resource-related performance metric or a VNF Indicator. + + + + + + + Provides a life cycle management script written in a Domain Specific Language (DSL). + + + + + + + Provides the constituent VLDs. +Cardinality of 0 means that the NS is a NF set with unspecified connectivity. + + + + + + + + References the VNFD of a constituent VNF. + + + + + + + + References the PNFD of a constituent PNF. + + + + + + + + + The NsVirtualLinkDesc class provides general information enabling the instantiation of virtual links. +For all attributes in this class the Producer is SDC and the Consumer is SDC/UUI/VFC. + + + + + + + Defines the organization generating the VLD. + + + + + + + + Specifies the version of the VLD. + + + + + + Specifies properties for instantiating a VL according to a specific flavour. + + + + + + + + The NsDf class specifies the properties of a variant of an NS. +NOTE: Every VNF, VL and nested NS whose descriptor is referenced by the NS DF shall be involved in an NS instantiation level of the parent NS. If no instances of a given VNF/nested NS have to be deployed at NS instantiation time, the numberOfInstances attribute in the corresponding VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. + + + + Identifies this NsDf class. It identifies a NS DF within the NSD. + + + + + + Assurance parameter against which this flavour is being described. The key can be a combination of multiple assurance parameters with a logical relationship between them. The parameters should be present as a monitoredInfo attribute in the NSD. + + + + + + Identifies either a virtualised resource-related performance metric or a VNF Indicator. + + + + + + + Describes the details of an NS level. +NOTE: Every VNF, VL and nested NS whose descriptor is referenced by the NS DF shall be involved in an NS instantiation level of the parent NS. If no instances of a given VNF/nested NS have to be deployed at NS instantiation time, the numberOfInstances attribute in the corresponding VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. + + + + + + + + + + + + Specifies affinity or anti-affinity relationship applicable between the VNF instances created using different VNFDs, the Virtual Link instances created using different NsVirtualLinkDescs or the nested NS instances created using different NSDs in the same affinity or anti-affinity group. + + + + + + + + The scaling aspects supported by this DF of the NS. + + + + + + + PNF profile to be used for the NS flavour. + + + + + + + + Specifies a NS Profile supported by this NS DF. + + + + + + + VNF profile to be used for the NS flavour. + + + + + + + + Specifies the order in which instances of the VNFs and/or nested NSs have to be created. + + + + + + + + VL profile to be used for the NS flavour. + + + + + + + + + The NsScalingAspect class describes the details of an NS scaling aspect. An NS scaling aspect is an abstraction representing a particular "dimension" or "property" along which a given NS can be scaled. + Defining NS levels, in this context also known as NS scale levels, within an NS scaling aspect allows to scale NS instances "by steps", i.e. to increase/decrease their capacity in a discrete manner moving from one NS scale level to another. +Scaling by a single step does not imply that exactly one instance of each entity involved in the NS scale level is created or removed. + + + + Identifier of this NsScalingAspect class. It Uniquely identifies the NS scaling aspect in an NSD. + + + + + + Provides a human readable name of the NS scaling aspect. + + + + + + Provides a human readable description of the NS scaling aspect. + + + + + + Describes the details of an NS level. +NOTE: Only a subset of the VNFs, VLs and nested NSs whose descriptor is referenced by the NS DF may be involved in an NS scale level of the parent NS. + + + + + + + + + The NsLevel class describes the details of an NS level. An NS level consists of a list of involved entities, i.e. VNFs, VLs and/or nested NSs. +For each involved VNF/nested NS, the number of instances required by the NS level is specified. For each involved VL, the bitrate requirements corresponding to the NS level are specified. +NS levels shall be used in the context of NS instantiation and in this case they are referred to as NS instantiation levels. +Every VNF, VL and nested NS whose descriptor is referenced by the NS DF shall be involved in an NS instantiation level of the parent NS. If no instances of a given VNF/nested NS have to be deployed at NS instantiation time, the numberOfInstances attribute in the corresponding VnfToLevelMapping/NsToLevelMapping datatype shall be set to 0. +NS levels may be used in the context of NS scaling and in this case they are referred to as NS scale levels. + Only a subset of the VNFs, VLs and nested NSs whose descriptor is referenced by the NS DF may be involved in an NS scale level of the parent NS. + + + + + Identifier of this NsLevel class. It uniquely identifies an NS level within the DF. + + + + + + Human readable description of the NS level. + + + + + + Specifies the profile of the VNFs involved in this NS level and, for each of them, the required number of instances. + + + + + + + + Specifies the profile of the VLs involved in this NS level and, for each of them, the needed bandwidth. + + + + + + + + Specifies the profile of the nested NSs involved in this NS level and, for each of them, the required number of instances. + + + + + + + + The NsProfile class specifies the profile to be used for a nested NS. + + + + + + + Identifies an NS profile. + + + + + + Minimum number of nested NS instances based on the referenced NSD that is permitted to exist for this NsProfile. + + + + + + Maximum number of nested NS instances based on the referenced NSD that is permitted to exist for this NsProfile. + + + + + + Identifies an affinity or anti-affinity group the NSs created according to this NsProfile belong to. + + + + + + + + Identifies the applicable NS DF within the scope of the NSD. + + + + + + + Identifies the NS level within the referenced NS DF to be used in the context of the parent NS instantiation. If not present, the default NS instantiation level as declared in the referenced NSD shall be used. + + + + + + + Identifies the NSD applicable to NS instantiated according to this profile. + + + + + + + + This class provides run-time information about an NS VL instance. + + + + + + + Virtualised network resource(s) realizing this VL. + + + + + + Respresents the port of a NS VL. + + + + + + + The LifeCycleManagementScript information element specifies a script for the NS. + + + + Describes NS lifecycle event(s) or an external stimulus detected on an NFVO reference point. +NOTE 1: A minimum set of NS lifecycle events triggered internally by the NFVO includes: start instantiation, end instantiation, start scaling, end scaling, start healing, end healing, start termination, end termination, start update, end update. +NOTE 2: A minimum set of external stimulus includes: the receipt of request message of instantiation, scaling, healing, termination, update of NS. + + + + + + + + Includes an NS LCM script (e.g., written in a DSL) triggered to react to one of the events listed in the event attribute. + + + + + + + The VirtualLinkDf datatype specifies properties for instantiating a VL according to a specific flavour. + + + + Identifies this VirtualLinkDF datatype within a VLD. + + + + + + Specifies quality of service parameters applicable to a VL. + + + + + + + Specifies one of the three levels defined in ETSI GS NFV-REL 001: +• Level 1 +• Level 2 +• Level 3 + + + + + + + + The NsQoS datatype specifies quality of service parameters applicable to a NS VL. + + + + + + + Specifies the priority level in case of congestion on the underlying physical links. + + + + + + + + + Specifies one of the three levels defined in ETSI GS NFV-REL 001: +• Level 1 +• Level 2 +• Level 3 + + + + + + + + + The MonitoredData datatype identifies information to be monitored during the lifetime of a network service instance. + + + + + The NsToLevelMapping datatype specifies the profile to be used for a nested NS involved in a given NS level and the required number of instances. + + + + Identifies the profile to be used for a nested NS involved in the NS level. + + + + + Specifies the number of nested NS instances required for the NS scale level. +NOTE 1: It shall be in the range of minNumberOfInstances-maxNumberOfInstances, as specified in the referenced NsProfile. +NOTE 2: When the corresponding NS level is used in the context of NS instantiation, the numberOfInstances attribute specifies the number of nested NS instances to be deployed. +NOTE 3: When the corresponding NS level is used in the context of NS scaling, the numberOfInstances attribute does not specify the number of nested NS instances to be added/removed when reaching that NS scale level. The actual number of nested NS instances to be added/removed can be derived by subtracting the numberOfInstances declared in the source NS scale level from the numberOfInstances declared in the target NS level of the scaling request. + + + + + + + + The NsVirtuallLinkConnectivity datatype describes connection information between a connection point and a NS virtual Link. + + + + Reference an NS VL profile. + + + + + References the descriptor of a connection point on a VNF/PNF or a SAP which connects to virtual links instantiated from the profile identified in the virtualLinkProfileId attribute. + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Onap_Profile.profile.di b/ONAP_Information_Model/Onap_Profile.profile.di new file mode 100644 index 0000000..247ed5e --- /dev/null +++ b/ONAP_Information_Model/Onap_Profile.profile.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Onap_Profile.profile.notation b/ONAP_Information_Model/Onap_Profile.profile.notation new file mode 100644 index 0000000..744256a --- /dev/null +++ b/ONAP_Information_Model/Onap_Profile.profile.notation @@ -0,0 +1,109 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Onap_Profile.profile.uml b/ONAP_Information_Model/Onap_Profile.profile.uml new file mode 100644 index 0000000..11131ad --- /dev/null +++ b/ONAP_Information_Model/Onap_Profile.profile.uml @@ -0,0 +1,156 @@ + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + This profile contains stereotypes applicable to ONAP + + + + + + + + + + + + + + + + + + + This stereotype is used to determine the model element lifecycle state. + + + + This is the current model development state of the element. + + + + + + + + + + + + + + + + + This represents the various development states of an ONAP model element + + + + The model element is input for a discussion. + + + + + The model element is under discussion. + + + + + The model element has been agreed upon by a project team. + + + + + The model element has been officially reviewed and approved by the modeling subcommittee. + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/OpenModel_Profile.profile.di b/ONAP_Information_Model/OpenModel_Profile.profile.di new file mode 100644 index 0000000..247ed5e --- /dev/null +++ b/ONAP_Information_Model/OpenModel_Profile.profile.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/OpenModel_Profile.profile.notation b/ONAP_Information_Model/OpenModel_Profile.profile.notation new file mode 100644 index 0000000..8e4d51f --- /dev/null +++ b/ONAP_Information_Model/OpenModel_Profile.profile.notation @@ -0,0 +1,2212 @@ + + + + + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + multiplicity + visibility + defaultValue + name + type + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+ + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+ + + + + + + +
+ + +
+ + +
+ + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+ + + + + + + +
+ + +
+ + +
+ + + + + + + +
+ + +
+ + +
+ + + + + + + +
+ + +
+ + +
+ + + + + + + +
+ + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + visibility + name + derived + multiplicity + defaultValue + type + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/OpenModel_Profile.profile.uml b/ONAP_Information_Model/OpenModel_Profile.profile.uml new file mode 100644 index 0000000..542e253 --- /dev/null +++ b/ONAP_Information_Model/OpenModel_Profile.profile.uml @@ -0,0 +1,10447 @@ + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OpenModel Profile v0.2.13: +ProfileLifecycle Profile v0.0.4 applied. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + +
+ + This stereotype defines the Open Model specific enhancements for attributes. + + + +
+ + + + + + This property indicates if the attribute is part of the object key or not. +Value = 0 (default) means the attribute is not part of the object key. +Values > 0 indicate that the attribute is part of the object key and the value defines the order of the attribute in case the key is composed of more than one attribute. + + + + + + + This property defines if the attribute is part of a set of attributes which together (i.e., their values) have to be unique among all instances within a defined context. +No value means no uniqueness constraint. +An integer value identifies the uniqueness set. +An attribute may participate in more than one uniqueness sets. + + + + + + + +
+ + + +
+ + This property defines at which time the attribute can be set. +true = attribute can only be set at creation time; false = attribute can be set at any time. + + + + +
+ + + + + + +
+ + + +
+ + This property provides the restriction on the attribute values. + + + + + + + + This optional property indicates if the attribute type is unsigned (value = true) or signed (value = false); if applicable, otherwise ignored. + + + + + + + + + This optional property defines the counter type of the attribute type; if applicable. + + + + + + + + This optional property contains a textual definition of the unit associated with the attribute value. +The spelling of the unit (not only SI units) shall be in accordance to the NIST Publication 811 “Guide for the Use of the International System of Units (SI)” (http://www.nist.gov/pml/pubs/sp811/index.cfm), section 9 “Rules and Style Conventions for Spelling Unit Names”. + + + + + + + +
+ + + +
+ + This property qualifies the support of the attribute at the management interface. + + + +
+ + + + + +
+ + + +
+ + This attribute contains the condition for the condition-related support qualifiers. + + + + + + + + +
+ + + required + + + +
+ + + +
+ + + + + + +
+ + + +
+ + This stereotype defines the Open Model specific enhancements for data object classes. + + + +
+ + + + + +
+ + + +
+ + This property qualifies the support of the object class at the management interface. + + + +
+ + + + + +
+ + + +
+ + This attribute contains the condition for the condition-related support qualifiers. + + + + + + + + +
+ + + required + + + +
+ + + +
+ + + + + + +
+ + + +
+ + This stereotype defines the Open Model specific enhancements for operations. + + + +
+ + + + + +
+ + + +
+ + This property defines whether the operation is idempotent or not. +Example: When an operation is going to create an object instance which does already exist, an idempotent operation would return success and a non-idempotent operation would return an exception. + + + + +
+ + + + + + +
+ + + This property identifies if the operation is best effort or is successful / not successful as a whole. + + + + +
+ + + + + + +
+ + + +
+ + This property qualifies the support of the operation at the management interface. + + + +
+ + + + + +
+ + + +
+ + This attribute contains the condition for the condition-related support qualifiers. + + + + + + + + +
+ + + required + + + +
+ + + +
+ + + + + + +
+ + + +
+ + This stereotype defines the Open Model specific enhancements for parameters. + + + +
+ + + + + +
+ + + +
+ + This property provides the restriction on the parameter value. + + + + + + + +
+ + + +
+ + This property qualifies the support of the parameter at the management interface. + + + +
+ + + + + +
+ + + +
+ + This attribute contains the condition for the condition-related support qualifiers. + + + + + + + + +
+ + + required + + + +
+ + + +
+ + + + + + +
+ + + +
+ + This enumeration defines if a notification (of a specific type) has to be raised when the event occurs. + + + +
+ + + +
+ + This literal means that this kind of Notification makes no sense for this object class, e.g., when it is abstract. + + + + +
+ + + +
+ + This literal means that the object class shall not send this kind of notification. + + + + +
+ + + +
+ + This literal means that the object class must send this kind of notification. + + + + + +
+ + + +
+ + This stereotype identifies that the association is used to define the naming. + + + +
+ + + + + + +
+ + + +
+ + + + + +
+ + + +
+ + This enumeration defines the list of support qualifiers as defined in ITU-T Recommendation M.3020. + + + +
+ + + +
+ + The model element shall be supported. + + + + +
+ + + +
+ + The model element may, but needs not to, be supported. + + + + +
+ + + +
+ + The model element shall be supported under certain conditions. If the specified conditions are met then the model element shall be supported. + + + + +
+ + + +
+ + The model element may, but needs not to, be supported under certain conditions. If the specified conditions are met then the model element may, but needs not to, be supported. If the specified conditions are not met then the model element shall be supported. + + + + +
+ + + +
+ + Used for model elements that have multiple constraints. Each constraint is worded as a condition for one kind of support, such as mandatory support, optional support or "no support". All constraints must be related to the same kind of support. Specifically: Each model element with C qualification shall have the corresponding multiple constraints defined in the specification. If all specified constraints are met and are related to mandatory, then the model element shall be supported. If all the specified constraints are met and are related to optional, then the model element may, but needs not to, be supported. If all the specified constraints are met and are related to "no support", then the model element shall not be supported. + + + + + +
+ + + +
+ + This stereotype identifies an object class or a data type as a choice between different alternatives. + + + +
+ + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ + + +
+ + This stereotype defines a data type used for an operation exception. + + + +
+ + + + + + +
+ + + +
+ + + + + +
+ + + +
+ + This stereotype identifies that the dependency is used to define the naming. + + + +
+ + + + + + +
+ + + +
+ + + + + +
+ + + This stereotype can only be applied to associations with a composite end (i.e., composite aggregation association). Means that the content of the "parts" classes is part of the "composed" parent class and has no opportunity for independent lifecycle. In this case although an instance of the "parts" classes can be created and deleted anytime, it has to be in the context of the "composed" parent class. In other words, the parent class instance has to exist and it is NOT possible for the "part" instance to move from one parent instance to another (allowed in regular composition). + + + +
+ + + + + + +
+ + + +
+ + + + + +
+ + + +
+ + This stereotype identifies that the relationship is conditional. + + + +
+ + + +
+ + This attribute contains the condition. + + + + + + + + + +
+ + + This stereotype indicates that the entity is at a very early stage of development and will almost certainly change. The entity is NOT mature enough to be used in implementation. + + + + + + + + + +
+ + + This stereotype indicates that although the entity may be mature work in the area has indicated that change will be necessary (e.g. there are new insights in the area or there is now perceived benefit to be had from further rationalization). The entity can still be used in implementation but with caution. + + + + + + + + + +
+ + + This stereotype indicates that the entity is at a relatively early stage of development and is likely to change but is mature enough to be used in implementation. + + + + + + + + + +
+ + + This stereotype indicates that the entity should not be used in new implementation and that attempts should be made to remove it from existing implementation. + + + + + + + + + +
+ + + This stereotype indicates that the entity is NOT to be used in implementation and is in the model simply to assist in the understanding of the model (e.g., a specialization of a generalized class where the generalized class is to be used as is and the specialization is simply offered to more easily illustrate an application of the generalized class). + + + + + + + + + +
+ + + This stereotype indicates that the entity should not be used in new implementation and that attempts should be made to remove it from existing implementation as there is a problem with the entity. An update to the model with corrections will be released. + + + + + + + + + +
+ + + +
+ + This stereotype defines the Open Model specific enhancements for interfaces. + + + +
+ + + + + +
+ + + +
+ + This property qualifies the support of the interface at the management interface. + + + +
+ + + + + +
+ + + +
+ + This attribute contains the condition for the condition-related support qualifiers. + + + + + + + + +
+ + + required + + + +
+ + + +
+ + + + + + + + + + This stereotype defines the Open Model specific enhancements for notifications. + + + +
+ + + +
+ + This property provides the list of conditions that cause the notification. + + + + + + + +
+ + + +
+ + This property qualifies the support of the notification at the management interface. + + + +
+ + + + + +
+ + + +
+ + This attribute contains the condition for the condition-related support qualifiers. + + + + + + + + + + + + required + + + + + + + + + This stereotype identifies that the realization association is used to identify pruning and refactoring. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This stereotype indicates that the entity may become obsolete in the near future. It may still be used in new implementation. + + + + + + + + + + + This stereotype indicates that the entity is fully developed and can be used in implementations without any constraints. + + + + + + + + + + + This optional stereotype contains a reference upon which the UML artefact is based. A reference to a standard is preferred. + + + + + + + + + + + + + + This enumeration contains the defined bit length values. + + + + + + + + + + This enumeration contains the defined counter types. + + + + + + + + + This enumeration contains the defined encoding types. + + + + + + + + + This steoreotype indicates a more restrictive form of "StrictComposite" where the "extending" classes will never be explictly instantiated, but that the attributes defined by the “extending” class will be transferred to the class being “extended” at runtime, much like the UML “Generalization” relationship. In other words the "extending" classes are essentially carrying attributes of the “extended” class in a grouping-pack and often referred to as "_Pacs". + + + + + + The “Specify” stereotype is applied on the UML “Abstraction” relationship to indicate that the definition of the more abstract entity class in the abstraction relationship is augmented by the "specification" class definition at runtime. Furthermore there is a potential for an entity class definition to be augmented by more than one "specification" class definitions. In others words, one of the specification classes adds-to and expands the runtime-definition of the entity class. This also implies that the entity class cannot be aware of the existence of specification classes at design time. Since the “Specify” relationship is defined to support runtime code/schema generation and dependency injection, a stereotype-property “target” is defined to point to the actual node being augmented within the object/instance schema. The "target" value should be in the following format: +[/<ModelName>:<ClassName>]+:<AttributeName>. +Example: TopologyContext in TapiTopology augments Context in TapiCommon +target=/TapiCommon:Context:_context +Example: NodeEdgePointLpSpec in TapiOdu specifies LayerProtocol definition for NodeEdgePoint in TapiTopology +target=/TapiTopology:TopologyContext/TapiTopology:Topology/TapiTopology:Node/Tapi:Topology:NodeEdgePoint/_layerProtocol + + + + + + + This property indicates the target of the "Specification". It is recommended that this information is set as the “default” value in the concrete “Specification” class at design/modeling time. + + + + + + + + + + + + + + + This property shall only be applied to attributes or parameters that have an object class as their type. +The stereotype identifies that the attribute or the parameter that has the stereotype associated, contains only the identifier(s) of the referred object instance(s) when being transferred across the interface. +Otherwise the attribute/parameter contains the complete information of the object instance(s) when being transferred across the interface. + + + + + + + + + + + + + + + + + + + + + This optional stereotype can extend a shared aggregation and indicates a lifecycle dependency between the group instance and the shared part instances; similar to the lifecycle dependency of a composite aggregation. +This option is intended to be used only when the shared part object class has another stronger lifecycle dependency (such as composition). +The multiplicity at the grouping side of the «LifecycleAggregate» relationship defines the mode: single = exclusive mode, one or more = shared mode. +In exclusive mode, a shared part object instance must not be aggregated by more than one group instance via a «LifecycleAggregate» relationship. +In shared mode, a shared part object instance can be aggregated by more than one group instance via a «LifecycleAggregate» relationship. In this case, a shared part instance is automatically deleted when the last group instance aggregated the part instance is deleted. + + + + + + + + + + + This is used by ONAP to indicate that the artifact will be in a Future release. + + + + + + + + + + + This is used by ONAP to represent a proposal to a model. The "note" must contain the name of the person making the proposal and the associated contribution. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Party.di b/ONAP_Information_Model/Party.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Party.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Party.notation b/ONAP_Information_Model/Party.notation new file mode 100644 index 0000000..61a1c56 --- /dev/null +++ b/ONAP_Information_Model/Party.notation @@ -0,0 +1,1577 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+
+ + + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+
+ + + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Party.uml b/ONAP_Information_Model/Party.uml new file mode 100644 index 0000000..60e4e8f --- /dev/null +++ b/ONAP_Information_Model/Party.uml @@ -0,0 +1,267 @@ + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + + + A Party represents an individual, an organization, or an organization unit that is of interest, involved or that provides value, directly or indirectly, from an enterprise perspective (Enterprise is to be understood here as provider, service provider or operator). + + + + + + + The time period that the Party is valid for + + + + + + + Represents a single human being (a man, woman or child). +The individual could be a customer, an employee or any other person that the organization needs to store information about. An Individual is a type of Party. + + + + + + A group of people identified by shared interests or purpose. Examples include business, department, enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same business entity in this model. An Organization is a type of Party. +An Organization might be composite or atomic. + + + + + + The OrganizationDecompositionComponent specifies the valid period for the relationship between CompositeOrganization and Organization. + + + + The period during which the OrganizationDecompostionComponent is applicable. + + + + + + + AtomicOrganization is a type of Organization that does not have any subordinate Organization. That is, an AtomicOrganization is a leaf-level Organization. + + + + + + CompositeOrganizaiton is a type of Organization that is formed by aggregating other Organizations, which may be atomic or composite Organizations. + + + + + + The part played by a party in a given context with any characteristics, such as expected pattern of behavior, attributes, and/or associations that it entails.PartyRole is an abstract concept that should be used in places where the business refers to a Party playing a Role + + + + + + + Used to track the lifecycle status, e.g. existing, prospective or former customers. + + + + + + The time period that the PartyRole is valid for + + + + + + + A person or organization that buys products and services from the enterprise or receives free offers or services. This is modeled as a Party playing the role of Customer. A Customer is a type of PartyRole. Customers can also be other service providers who resell the enterprises products, other service providers that lease the enterprise's resources for utilization by the other service provider's products and services, and so forth. + + + + + + An individual or organization that sells goods or services to somone else in the value fabric. + + + + + + An organization or individual which offers services and products to others in exchange for payment in some form. + + + + + + The definition of a role a party may play. + + + + + A word, term, or phrase by which an organization is known and distinguished from other organizations.A name is an informal way of identifying an object [Fowler]An OrganizationName is a type of PartyName. + + + + + + A word, term, or phrase by which a party (individual or organization) is known and distinguished from other parties.A name is an informal way of identifying an object [Fowler].PartyName is an abstract concept that should be used in places where the business refers to an organization name, organization unit name or individual name + + + + + A word, term, or phrase by which an individual is known and distinguished from other individuals.A name is an informal way of identifying an object [Fowler]This entity allows for international naming variations. An IndividualName is a type of PartyName. + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Pnf.di b/ONAP_Information_Model/Pnf.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Pnf.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Pnf.notation b/ONAP_Information_Model/Pnf.notation new file mode 100644 index 0000000..86ace82 --- /dev/null +++ b/ONAP_Information_Model/Pnf.notation @@ -0,0 +1,592 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Pnf.uml b/ONAP_Information_Model/Pnf.uml new file mode 100644 index 0000000..799f4ce --- /dev/null +++ b/ONAP_Information_Model/Pnf.uml @@ -0,0 +1,224 @@ + + + + + + +
+ + + + + +
+ + + + + + + + + The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. + + + + + + + Identifier of this Pnfd class. It uniquely identifies the PNFD. + + + + + + Identifies the provider of the PNFD. +NOTE: The provider of the PNFD might be different from the provider of the PNF. + + + + + + Identifies the version of the PNFD + + + + + + Provides a signature to prevent tampering. + + + + + + + + Describes the PNF function. + + + + + + Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. + + + + + + Provides the human readable name of the PNFD. + + + + + + Specifies the characteristics of one or more connection points where to connect the PNF to a VL. + + + + + + + + A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. + + + + + + + + + An implementation of a NF via a tightly coupled software and hardware system. + + + + + + + External CP of the PNF. + + + + + + + + External CP of the PNF. + + + + + + + Cpd used to deploy this PNF CP. + + + + + + The PnfProfile class describes additional data for a given PNF instance used in a DF. + + + + Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. + + + + + + Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. + + + + + + + + + + + + The software versions associated with the pnfd + + + + The active software + + + + + + The passive software + + + + + + + + The recovery software + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Policy.di b/ONAP_Information_Model/Policy.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Policy.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Policy.notation b/ONAP_Information_Model/Policy.notation new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Policy.notation @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Policy.uml b/ONAP_Information_Model/Policy.uml new file mode 100644 index 0000000..e043bc7 --- /dev/null +++ b/ONAP_Information_Model/Policy.uml @@ -0,0 +1,647 @@ + + + + Presently the scope of policy is imperitive (event, condition, action) only - not declaritive or intent. + +Approach will be pragmatic in nature, establishing a model that meets the Policy team's near term needs, and then evolve from that base. + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + This is an abstract base class that represents how to form the action clause of a PolicyRule. + +Certain actions will take place if the condition clause is TRUE, others if the condition clause is FALSE. + + + + + + + + Additional metadata pertinant to the action. + + + + + + Defines the strategy to be used when executing the aggregated actions + + + + + + A PolicyEvent is an occurrence of an important event, and can be used to trigger the evaluation of a PolicyCondition or PolicyCondition clause in a PolicyRule. + + + + + + + + eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors). + + + + + + The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center). + + + + + + The payload for the event. + + + + + + Classification that captures the symantics of that particular event categorization (enodeb, vnf) + + + + + + + This class is a generalized aggregation container. It enables PolicyRules and/or PolicyGroups to be aggregated in a single container. Note that loops, including the degenerate case of a PolicyGroup that contains itself, are not allowed when PolicyGroups contain other PolicyGroups. + + + + + + This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored. + +Notes: +Not present in the ITU or CIM specs. + + + + + + This is a free-form string attribute that recommends how this policy object should be used. + +Notes: Not present in the ITU or CIM specs. + + + + + + This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined: + +Permitted Values: +Unknown InstallPermissions + ConfigChange InstallMethod + Default Error + Usage InternalError + Security ExternalError + Authentication Notification + Authorization Publish + Accounting Subscribe + Auditing Publish-Subscribe + Service Exception + CustomerFacingService + ResourceFacingService + +Notes: Not present in the ITU specs; the CIM defines a PolicyKeyword attribute, but its semantics are very different. + + + + + + This is a generic naming attribute that can be used to identify different policy entities. This enables commonName to be used to enforce enterprise or service provider generic naming and this attribute to be used to fine tune the naming of policy entities. Thus, commonName is public in scope and policyName is private to policy. + +Notes: +Not present in the ITU specs or CIM specs. + + + + + + Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + + + + + This is a string, and defines a textual free-form description of the object. + +Notes: +This attribute doesn’t exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description. + + + + + + Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + + + + + + This is a concrete base class for realizing the "event-condition-passaction-failaction" semantics that form a policy rule. The semantics of this rule are that the rule is evaluated when an event occurs. If the condition clause is satisfied, then the pass-action clause will be executed (otherwise, the fail-action clause will be executed). + +PolicyRules may be nested within PolicyRules. This is often needed in networking (e.g., bandwidth allocation). + + + + + This is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs). + +This attribute controls the setting of how multiple condition clauses (as represented by multiple PolicyConditionComposite objects) are treated in the PolicyRule. As such, it is different from the attribute PolicyConditionComposite.IsCNF, which controls how multiple PolicyConditionAtomic objects are treated in a (single) PolicyConditionComposite object. + + + + + + + + + This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored. + +Notes: +Not present in the ITU or CIM specs. + + + + + + This is a free-form string attribute that recommends how this policy object should be used. + +Notes: Not present in the ITU or CIM specs. + + + + + + This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined: + +Permitted Values: +Unknown InstallPermissions + ConfigChange InstallMethod + Default Error + Usage InternalError + Security ExternalError + Authentication Notification + Authorization Publish + Accounting Subscribe + Auditing Publish-Subscribe + Service Exception + CustomerFacingService + ResourceFacingService + +Notes: Not present in the ITU specs; the CIM defines a PolicyKeyword attribute, but its semantics are very different. + + + + + + Version of the policy as defined by the developer. + + + + + + his is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs). + +This attribute controls the setting of how multiple condition clauses (as represented by multiple PolicyConditionComposite objects) are treated in the PolicyRule. As such, it is different from the attribute PolicyConditionComposite.IsCNF, which controls how multiple PolicyConditionAtomic objects are treated in a (single) PolicyConditionComposite object. + + + + + + + This is a concrete base class that is used to define the invariant characteristics (attributes, methods, constraints and relationships) of a PolicyRule entity. + + + + This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: + + 0: Unknown + 1: Do Until Success + 2: Do All + 3: Do Until Failure + 4: Do All Without Failure or Do Nothing + +"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). + +"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. + +"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. + +Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered. + + + + + This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted. + +Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule). + + + + + + This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. + +Notes: Not present in the ITU or CIM specs. + + + + + + This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. + +Notes: Not present in the ITU or CIM specs. + + + + + + This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. + +Notes: Not present in the ITU or CIM specs. + + + + + + This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. + +Permitted Values: + + 0: Unknown + 1: MatchFirst + 2: MatchAll + +MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. + +MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute. + + + + + List of Event Types to be considered by this event. + + + + + + + + + This is the base class for all simple PolicyActions. A simple PolicyAction consists of a single Boolean clause, which is used to perform a single action. This consists of a single occurrence of a PolicyStatement, which is of the form: + + {SET | CLEAR} PolicyVariable to PolicyValue + +This is distinctly different from the PolicyActionVendor, which does not use a PolicyStatement. + +PolicyActionAtomic objects can also be used to form more complex action structures. A PolicyActionComposite object can be used to contain a group of PolicyActionAtomic objects - this grouping enables multiple PolicyActionAtomic objects to be executed as a group. Alternatively, a PolicyActionAtomic object can contain one or more PolicyActionAtomic objects (and also PolicyActionComposite groups if desired) to provide the semantics of a compound PolicyAction. In either case, the aggregation is done using the containedPolicyActions aggregation. + + + + + + This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. This will allow a policy engine to reference externally supplied arguments to this object as it is executed. + +Notes: Not present in the ITU specs; CIM 2.7 has a subset of these values. + + + + + + Tthe entity that is executing the policy. + + + + + + he set of entities that are affect-ed by the policy. + + + + + + This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction. + +Permited Values: + 0: not yet executed + 1: executed with no errors + 2: executed with errors but successfully rolled back + 3: executed with errors and did not roll back + 4: did not complete execution but successfully rolled back + 5: did not complete execution and did not roll back + +Notes: +Not present in the ITU or CIM specs. + + + + + + + This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. +For example if a composite is part of another composite policy structure. + +Notes: default is “1” + + + + + This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. +For example if a composite is part of another composite policy structure. + +Notes: default is “1” + + + + + + This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of sub-actions that they contain. + +Notes: Not present in the ITU or CIM specs. + + + + + + Specifies if the action is in confunctive normal form. + + + + + + Execution Strategy that applies to the entire workflow. + + + + + + + + + + + Composite event has events + + + + + + + + + + + + + + + + + This is an abstract base class that represents how to form the condition clause of a PolicyRule. This class can be used to represent rule-specific or reusable policy conditions. + +Policy conditions are of the form: + + {variable, operator, value} + +where the operator is usually the MATCH operator, but could be another type (e.g., compare) of operator. This gives the semantics of "IF the condition is TRUE (or FALSE)". + +The subclasses of PolicyCondition, along with its recursive aggregation, enable simple and compound (e.g., nested) PolicyConditions to be supported by the same structure. + + + + + + + + + + + + + This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. + +Permitted Values: + + 0: Unknown + 1: MatchFirst + 2: MatchAll + +MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. + +MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute. + + + + + + + + This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: + + 0: Unknown + 1: Do Until Success + 2: Do All + 3: Do Until Failure + 4: Do All Without Failure or Do Nothing + +"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). + +"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. + +"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. + +Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered. + + + + + + + + + + This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction. + +Permited Values: + 0: not yet executed + 1: executed with no errors + 2: executed with errors but successfully rolled back + 3: executed with errors and did not roll back + 4: did not complete execution but successfully rolled back + 5: did not complete execution and did not roll back + +Notes: +Not present in the ITU or CIM specs. + + + + + + + + + + + PolicyEvents can include a state chnage, a VES Event, or a configuration request. + + + Model Based Strongly On the TMF SID + + + Rooted PolicyEvent + + + Some rules may not be created from a template + + + "Guard" Policies - serve as overarching conditions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Resource.di b/ONAP_Information_Model/Resource.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Resource.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Resource.notation b/ONAP_Information_Model/Resource.notation new file mode 100644 index 0000000..3b6d997 --- /dev/null +++ b/ONAP_Information_Model/Resource.notation @@ -0,0 +1,97 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Resource.uml b/ONAP_Information_Model/Resource.uml new file mode 100644 index 0000000..0cf68ae --- /dev/null +++ b/ONAP_Information_Model/Resource.uml @@ -0,0 +1,44 @@ + + + + + + + + + + ResourceDesc represents physical and non-physical (virtual) components which are owned / managed by the business or provided by a Supplier and are used (directly or indirectly) to construct services. + +In this context, a resource is something that goes into a resource catalog from which services are composed. + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + diff --git a/ONAP_Information_Model/Service.di b/ONAP_Information_Model/Service.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Service.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Service.notation b/ONAP_Information_Model/Service.notation new file mode 100644 index 0000000..ce82e5d --- /dev/null +++ b/ONAP_Information_Model/Service.notation @@ -0,0 +1,8294 @@ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + +
+ + +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + +
+ + + + + + + + + + +
+
+
+
+ + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + +
+
+
+
+ + + + + + +
+
+
+
+ + + + + + +
+
+
+
+ + + + + + +
+
+
+
+ + + + + + +
+
+
+
+ + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Service.uml b/ONAP_Information_Model/Service.uml new file mode 100644 index 0000000..a0db9b9 --- /dev/null +++ b/ONAP_Information_Model/Service.uml @@ -0,0 +1,2268 @@ + + + + + NSST +(Network Slice Subnet Template) + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + +
+ + + + + +
+ + + + sbnd f + + + + + +
+ + + + dbfb + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + +
+ + + Enables specifying any kind of relationships between ServiceOrderItems + + + + The type of relationship such as contains, relies on. + + + + + + + + + +
+ + + + + +
+ + + An association between two ServiceOrders. + + + + A categorization of the relationship, such as bulk, parent/child, and so forth. + + + + + + + + +
+ + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + + + + + + + + + +
+ + + Describe the nested relationship between multiple Serive Descriptors. + + + + + + + + + + + + +
+ + + An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + + + + + + + + + +
+ + + Resource components of constituting a serivce descriptor. + + + + + + + + + +
+ + + Resource instance components of constituting a serivce instance. + + + + + + + + +
+ + + Resource instance components of constituting a serivce instance. + + + + + + + + + +
+ + + Resource components of constituting a serivce descriptor. + + + + + + + + + +
+ + + + + +
+ + + + + + + Some Questions: +1. Do we have a business need to have multiple service catalogs? +- +2. Do we have a need to have a service descriptor in a given catalog multiple times for different time periods? +- +3. How do we handle moving a descriptor from a test catalog to a production catalog? +- +4. What is the attachment class? + + + Presently, SDC stores the descriptor directly in the catalog. + + + I don't think SDC uses the SID Characteristic patern. + + + Removed recursive associations, given we are using the composite/atomic pattern. + + + Do we need this diagram? + + + Option 1 + + + Option 2 + + + +NST +(Network Slice Template) + + + + + + + + + + The Nfpd class associates traffic flow criteria to a list of descriptors associated to the connection points and service access points to be visited by traffic flows matching these criteria. + + + + Identifies this nfpd class within a VNFFGD. + + + + + Provides an NFP classification and selection rule. +The rule may be expressed as a criteria constructed out of atomic assertions linked by Boolean operators AND, OR and NOT. +NOTE: Examples of atomic assertions are assertions on packet header fields’ values, date and time ranges, etc. + + + + + References the descriptor of a connection point to be traversed by the traffic flows matching the criteria. This shall be a connection point attached to one of the constituent VNFs and PNFs of the parent VNFFG, or a SAP of one of the constituent nested NSs of the parent VNFFG. +NOTE: When multiple values are provided, the order is significant and specifies the sequence of connection points to be traversed. + + + + + + This is an abstract proxy class, allowing to provide reference to either NsProfile or VnfProfile. + + + + + The Dependencies class provides indications on the order in which VNFs associated to different VNF Profiles and/or nested NSs associated to different NS Profiles are to be instantiated. + + + + References a VnfProfile or NsProfile. +NOTE: NFV Management and Orchestration functions shall instantiate VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the primary attribute before instantiating VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the secondary attribute. + + + + + + + + References a VnfProfile or NsProfile. +NOTE: NFV Management and Orchestration functions shall instantiate VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the primary attribute before instantiating VNFs from the VnfProfile and/or nested NSs from the NsProfile referenced in the secondary attribute + + + + + + + + + Provides information on a Service Access Point (SAP) of a NS + + + + + + + + ServiceDescriptor is used to model the design time representation of a service. + + + + + + + Constant identifier of the service model. + + + + + + Versioned identifier of the service model (this uuid is changed for every major version of the service) + + + + + + The name of the service model designed. + + + + + + The description of the service model designed. + + + + + + A predefined list which identifies the construct's category. There is a predefined list of service categories. + + + + + + + + The service model version. + + + + + + An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. + + + + + + + + An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. + + + + + + + + The icon path of the service. + + + + + + + + + + Describe whether this service descriptor is shared or not in the service design. + + + + + + Includes a list of events and corresponding management scripts performed for the +Service. + + + + + + + + + + + + + + + + + ServiceInstance is used to model the run time representation of a service. + + + + + + + Uniquely identifies this instance of a service. + + + Uniquely identifies this instance of a service. + + + + + + The name assigned to the service-instance. + + + + + + + + An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. + + + + + + + + An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. + + + + + + URL to endpoint where more details can be gotten. + + + + + + Orchestration status of the service instance. + + + + + + Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + + + + + Record the number of services that are using this service instance. +Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + + + + + + + + + + + + ServcieCompositeDescriptor is used to model the design time representation of a service component or network service. + + + + + + Describe the nested relationship between multiple Service Descriptors. + + + + + + + An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + + + + + + + Resource components of constituting a serivce descriptor. + + + + + + + + + A type of Request that represents a Customer Order's products decomposed into the services through which the products are realized. + + + + + + + Unique identifier for Interaction. + + + + + + ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) + + + + + + A way that can be used by order requester to prioritize orders in Service Order + + + + + Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. + + + + + + Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option”,). + + + + + + State of the order + + + + + The date on which an interaction is closed or completed. + + + + + + The date that was requested to start processing the order. + + + + + + The date on which an interaction is closed or completed. + + + + + + The date on which an interaction is expected to be completed. + + + + + + The date on which an interaction is started. + + + + + + Contact attached to the order to send back information regarding this order + + + + + + Reference to ServiceOrderItem + + + + + + + The date the order was placed. + + + + + + + The purpose for the ServiceOrder expressed in terms of a ServiceSpecification or a Service. + + + + Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). + + + + + + + + The action to take for an InteractionItem, such as add, change, remove. + + + + + State of the order item: described in the state machine diagram. This is the requested state. + + + + + Quantity of an interaction item involved in an interaction. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + + + + + + + Resource components of constituting a serivce descriptor. + + + + + + + + + + + Resource instance components of constituting a service instance. + + + + + + + + + A ServiceCandidate (ServiceCatalogItem) is an entity that makes a ServiceSpecification available to a catalog. A ServiceCandidate and its associated ServiceSpecification may be “published” (made visible) in any number of ServiceCatalogs, or in none. One ServiceSpecification can be composed of other ServiceSpecifications. These ServiceSpecifications may also be published. + + + + A unique identifier for the ServiceCandidate + + + + + + A word or phrase that a ServiceCandidate is known and distinguished from other ServiceCandidates. + + + + + + + A narrative that explains the ServiceCandidate. + + + + + + The period of time during which the ServiceCandidate is applicable. + + + + + + The condition at which the ServiceCandidate exists such as planned, active and Obsolete. + + + + + + + A ServiceCatalog is a collection of ServiceCandidates representing ServiceSpecifications. ServiceCandidates define the underlying services that support a ProductOffering. ServiceCandidates are exposed to one or more Product Catalogs to be utilized to configure one or more ProductOfferings. ServiceCandidates can be exposed to one or more Service Catalogs to be utilized or incorporated in one or more ServiceCandidates. A collection may consist of similar ServiceCandidates, such as a collection of broadband ServiceCatalogCandidates or a collection of wireless ServiceCatalogCandidates. A Service Catalog contents can expose a collection of ServiceCandidates to be utilized internal/external to an enterprise. + + + + + + + Resource instance components of constituting a service instance. + + + + + + + + + A quality or distinctive feature that defines an entity, including the name of this feature (attribute), and the type of the actual value. + + + + Name of dynamic characteristic (attribute). + + + + + + Type of the dynamic characteristic value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The value of a given ServiceCharacteristic + + + The value of a given ServiceCharacteristic + + + + + + + The SAPD class specifies the information used to instantiate the service access points of an NS. A Sapd inherits from the Cpd class. All attributes of the Cpd are also attributes of the Sapd. + + + + + + + Specify whether the SAP address assignment is under the responsibility of management and orchestration functions or not. +If it is set to True, management and orchestration functions are responsible for assigning addresses to the access points instantiated from this SAPD. + + + + + + References the descriptor of VNF or PNF external connection points the SAPs instantiated from this SAPD are mapped to. + + + + + + + + References the descriptor of the NS VL instance to which the SAP instantiated from this SAPD connects to. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Constant identifier of the service model. + + + + + + Versioned identifier of the service model (this uuid is changed for every major version of the service) + + + + + + The name of the service model designed. + + + + + + The description of the service model designed. + + + + + + A predefined list which identifies the construct's category. There is a predefined list of service categories. + + + + + + + + The service model version. + + + + + + An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. + + + + + + An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. + + + + + + + + The icon path of the service. + + + + + + + + + + + + + + + + + + + + + + + + Identifier of this NSD class. It globally uniquely identifies an instance of the NSD + + + + + + Identifies the designer of the NSD. + + + + + + Identifies the version of the NSD. + + + + + + Provides the human readable name of the NSD. + + + + + + Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. + + + + + + Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD. +NOTE 1: The rule is based on a combination of assertions on the values of virtualised resource-related performance metrics and VNF Indicators identified by the monitoredInfo attribute. +NOTE 2: There may be multiple data sources (each identified as monitoredInfo) per rule + + + + + + + + + Identifies either a virtualised resource-related performance metric or a VNF Indicator. + + + + + + + + Provides a life cycle management script written in a Domain Specific Language (DSL). + + + + + + + + + + + + + + + + A composition of Network Functions and defined by its functional and behavioural specification. +NOTE: The Network Service (NS) contributes to the behaviour of the higher layer service, which is characterized by at least performance, dependability, and security specifications. The end-to-end network service behaviour is the result of the combination of the individual network function behaviours as well as the behaviours of the network infrastructure composition mechanism. + + + + Identifier of this NetworkService, identifying the NS instance. + + + + + + Human readable name of the NS instance. + + + + + + Human readable description of the NS instance + + + + + + Reference to consistituent VNFs and PNFs on this NS. +NOTE: Cardinality of zero is only valid for a non-instantiated NS. + + + + + + + + + Information on the VLs of this NS. +NOTE: Cardinality of zero is only valid for a non-instantiated NS. + + + + + + + + + Information on the SAPs of this NS. + + + + + + + Reference to information on nested NSs of this NS. + + + + + + + Information on the VNFFGs of this NS. + + + + + + + + + A set of BBS case specific properties information, which are needed for BBS service with the function realization. + + + + + A set of Slicing case specific properties information, which are needed for network slicing service with the function realization. + + + + A unique identifier of property of network slice related requirement should be supported by the network slice instance. + + + + + + This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density. + + + It is a structure containing the following elements: +- list of perfRequirements +Depending on the sST value, the list of perfRequirements will be +- list of eMBBPerfReq +or +- list of uRLLCPerfReq +or +- list of mIoTPerfReq +NOTE: the list of mIoTPerfReq is not addressed in the present document. + + + + + + + + This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used. + + + + + An attribute specifies whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s). +AllowedValues: shared, non-shared. + + + + + + An attribute specifies the maximum number of UEs may simultaneously access the network slice instance. + + + + + + + + This parameter specifies the slice/service type for a ServiceProfile. + + + + + + + + An attribute specifies the packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance. See clause 6.3.1 of 28.554. + + + + + + List of unique identities for PLMN. + + + + + + + An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. +AllowedValues: stationary, nomadic, restricted mobility, fully mobility. + + + + + An attribute specifies a list of TrackingAreas where the NSI can be selected. + + + + + + + + This parameter specifies the availability requirement for an network slice instance, expressed as a percentage. + + + + + + + + + The set of GSMA defined GST properties for network slicing service fuction realization. + + + + + + The set of 3GPP defined SliceProfile for network slicing subnet service fuction realization. + + + + + A unique identifier of the property of network slice subnet related requirement should be supported by the network slice subnet instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + An attribute specifies whether the resources to be allocated to the network slice subnet instance may be shared with another network slice subnet instance(s). +AllowedValues: shared, non-shared. + + + + + + + The set of 3GPP defined ServiceProfile for network slicing service function realization. + + + + + A unique identifier of property of network slice related requirement should be supported by the network slice instance. + + + + + + This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used. + + + + + List of unique identities for PLMN. + + + + + + + This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density. + + + It is a structure containing the following elements: +- list of perfRequirements +Depending on the sST value, the list of perfRequirements will be +- list of eMBBPerfReq +or +- list of uRLLCPerfReq +or +- list of mIoTPerfReq +NOTE: the list of mIoTPerfReq is not addressed in the present document. + + + + + + + + An attribute specifies the maximum number of UEs may simultaneously access the network slice instance. + + + + + + + + An attribute specifies a list of TrackingAreas where the NSI can be selected. + + + + + + + + An attribute specifies the packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance. See clause 6.3.1 of 28.554. + + + + + + An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. +AllowedValues: stationary, nomadic, restricted mobility, fully mobility. + + + + + An attribute specifies whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s). +AllowedValues: shared, non-shared. + + + + + + This parameter specifies the slice/service type for a ServiceProfile. + + + + + + This parameter specifies the availability requirement for an network slice instance, expressed as a percentage. + + + + + + + + + A set of CCVPN case specific properties information, which are needed for CCVPN service with the function realization. + + + + + A set of CCVPN case specific properties information, which are needed for CCVPN service with the function realization. + + + + + + + + + + + + + + + + + + + + + + + + + + + The VirtualLinkToLevelMapping datatype specifies the profile to be used for a VL involved in a given NS level and bitrate requirements. + + + + Identifies the profile to be used for a VL involved in an NS level. + + + + + Specifies the bit rate requirements for the NS level. +NOTE: It shall be in the range of minBitrateRequirements - maxBitrateRequirements, as specified in the referenced VirtualLinkProfile. + + + + + + + + + + + + + + + + + A base / value business entity used to represent a period of time, between two timepoints + + + + An instant of time, starting at the TimePeriod + +Notes: +If null, then represents to the beginning of time + + + + + + An instant of time, ending at the TimePeriod: + +Notes: +If null, then represents to the end of time + + + + + + + + + + + + + + + A way that can be used by order requester to prioritize orders in Service Order Management system (from 0 to 4: 0 is the highest priority, and 4 the lowest). It could be for example valued by BSS based on customer order requested priority. + + + + + + + + + + + + + + + + The LifeCycleManagementScript information element specifies a script for the service. + + + + Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator +reference point. + + + Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator +reference point. + + + + + + + Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. + + + + + + + + Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. + + + + + + Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. + + + + + + Array of KVP 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/ONAP_Information_Model/StyleSheets/ClassDiagramStyleSheet.css b/ONAP_Information_Model/StyleSheets/ClassDiagramStyleSheet.css new file mode 100644 index 0000000..5f4a775 --- /dev/null +++ b/ONAP_Information_Model/StyleSheets/ClassDiagramStyleSheet.css @@ -0,0 +1,16 @@ +Class > Compartment[kind="nestedclassifiers"] { + visible:false; +} + +Class > Compartment[kind="operations"] { + visible:false; +} + +DataType > Compartment[kind="operations"] { + visible:false; +} + +Property { maskLabel: name type multiplicity defaultValue;} + +Label[type=StereotypeLabel]{ + visible:false;} \ No newline at end of file diff --git a/ONAP_Information_Model/StyleSheets/CompartmentRestrictions.css b/ONAP_Information_Model/StyleSheets/CompartmentRestrictions.css new file mode 100644 index 0000000..0372964 --- /dev/null +++ b/ONAP_Information_Model/StyleSheets/CompartmentRestrictions.css @@ -0,0 +1,11 @@ +Class > Compartment[kind="nestedclassifiers"] { + visible:false; +} + +Class > Compartment[kind="operations"] { + visible:false; +} + +DataType > Compartment[kind="operations"] { + visible:false; +} \ No newline at end of file diff --git a/ONAP_Information_Model/StyleSheets/NoStereotypesDiagram.css b/ONAP_Information_Model/StyleSheets/NoStereotypesDiagram.css new file mode 100644 index 0000000..6aaceb0 --- /dev/null +++ b/ONAP_Information_Model/StyleSheets/NoStereotypesDiagram.css @@ -0,0 +1,4 @@ +Property { maskLabel: name type multiplicity defaultValue;} + +Label[type=StereotypeLabel]{ + visible:false;} \ No newline at end of file diff --git a/ONAP_Information_Model/Ves.di b/ONAP_Information_Model/Ves.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Ves.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Ves.notation b/ONAP_Information_Model/Ves.notation new file mode 100644 index 0000000..867da03 --- /dev/null +++ b/ONAP_Information_Model/Ves.notation @@ -0,0 +1,7985 @@ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + multiplicity + visibility + name + type + derived + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + multiplicity + visibility + name + type + modifiers + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + multiplicity + visibility + name + type + modifiers + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + multiplicity + visibility + name + type + modifiers + derived + + + + + + +
+ + + + + + + + multiplicity + visibility + name + type + derived + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Ves.uml b/ONAP_Information_Model/Ves.uml new file mode 100644 index 0000000..fcb6577 --- /dev/null +++ b/ONAP_Information_Model/Ves.uml @@ -0,0 +1,5599 @@ + + + + + + + An ONAP event is an aggregation of a header and a message. Event messages may be published to a message broker by service instances, resource instances, or ONAP platform components. Service or resource instances may be in support of network infrastructure or customer services. Interested platforms may subscribe to events on the message broker (e.g. Centralized Testing Platform CTP) may see an event on a service VNF instance and perform an automated test as part of a closed loop management policy. Events are unique and distinguishable from one another. + +ONAP event messages are serialized as a unicode ASCII character string which may be formatted as JSON, XML, etc... Appropriate schemas will be supplied. + + + + + + + + Event domain enumeration: 'cmNotify',‘fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ + + + Update in definition only + + + + + For example: ‘applicationNf’, ‘guestOS’, ‘hostOS’, ‘platform’ + + + + + + + + the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds + + + + + + + Network function component type: 3 characters (aligned with vfc naming standards) + + + + + + + + Network function type: 4 characters (aligned with vnf and pnf naming standards) + + + + + + + + Network function vendor name + + + + + + Processing priority enumeration: ‘High’, ‘Medium’, ‘Normal’, ‘Low’ + + + + + + reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. + +Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. + + + + UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. + + + + + + + + reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + + + Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. + + + + + + sequence - Ordering of events communicated by an event source instance (or 0 if not needed) + + + + Ordering of events communicated by an event source instance (or 0 if not needed) + + + + + + sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity + +Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. + + + + UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. + + + + + + + + sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + + + Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. + + + + + + startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). + +For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). + + + + the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) + + + + + + + Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples + + + + + + + + Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). + + + + + + + + + + + Fields specific to fault events + + + + + Additional alarm information. +• Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). +• Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’. +Could contain managed object instance as separate key:value; could add probable cause as separate key:value. + + + + + + + + Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) + + + + + + Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. + + + + + + + + Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’ + + + + + + + + Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. + + + + + Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class. + + + + + + Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field. + + + + + + Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ + + + + + + The heartbeatFields datatype is an optional field block for fields specific to heartbeat events. + + + + + Additional expansion fields if needed. + + + + + + + + Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Current heartbeatInterval in seconds. + + + + + + + + Fields specific to measurement events + + + + + Additional measurement fields if needed. + + + + + + + + + Array of named hashMap if needed. + + + + + + + + Array of Schema objects described by name, schema and other meta-information, if needed. + + + + + + + + Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. + + + + + + + + + Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF + + + + + + + + + The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. + + + + + + + + Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. + + + + + + + + + Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Interval over which measurements are being reported in seconds + + + + + + Represents busy-ness of the network function from 0 to 100 as reported by the nfc. + + + + + + + + + Number of media ports in use. + + + + + + + Peak request rate per second, for the VM over the measurementInterval + + + + + + + Array of metrics on hugePages + + + + + + + Array of codecs in use + + + + + + + Usage of an array of CPUs + + + + + + + Usage of an array of disks + + + + + + + Filesystem usage of the VM on which the xNFC reporting the event is running + + + + + + + Array of intelligent platform management interface metrics + + + + + + + Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. + + + + + + + Array of system load metrics + + + + + + + Array of machine check exceptions + + + + + + + Memory usage of an array of VMs + + + + + + + Performance metrics of an array of network interface cards + + + + + + + Array of metrics on system processes + + + + + + + + Fields specific to mobility flow events + + + + + additionalFields - Additional mobileFlow fields if needed. + + + + + + + + applicationType - Application type inferred + + + + + + + + + applProtocolType - Application protocol. + + + + + + + + + applProtocolVersion - Application version. + + + + + + + + + cid - Cell Id. + + + + + + + + + connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. + + + + + + + + + ecgi - Evolved Cell Global Id. + + + + + + + + flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. + + + + + + + + + gtpProtocolType - GTP protocol + + + + + + + + + gtpVersion - GTP protocol version. + + + + + + + + + httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. + + + + + + + + + imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. + + + + + + + + + imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device + + + + + + + + + ipProtocolType - IP protocol type e.g., TCP, UDP, RTP... + + + + + + + + + ipVersion - IP protocol version e.g., IPv4, IPv6 + + + + + + + + + lac - Location area code. + + + + + + + + + mcc - Mobile country code. + + + + + + + + + mnc - Mobile network code. + + + + + + + + + mobileFlowFieldsVersion - Version of the mobileFlowFields block. + + + + + + + + + msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device. + + + + + + + + + otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. + +Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + + + + + + + + + otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on + + + + + + + + + otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... + + + + + + + + + rac - Routing area code + + + + + + + + + radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) + + + + + + + + + reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. + +Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + + + + + + + + + + reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. + + + + + + + + + sac - Service area code + + + + + + + + + samplingAlgorithm - Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied. + + + + + + + + + tac - Transport area code + + + + + + + + + tunnelId - Tunnel identifier + + + + + + + + + vlanId - VLAN identifier used by this flow + + + + + + + + + Mobility GTP Protocol per flow metrics + + + + + + + + Fields specific to notification events + + + + + Additional notification fields if needed. + + + + + + + + arrayOfNamedHashMap - Array of named hashMaps + + + + + + + + Identifier for a contact related to the change. + + + + + + + + + System or session identifier associated with the change. + + + + + + + Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… + + + + + + New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ + + + + + + + + Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Previous state of the entity. + +For example: "inService", "outOfService", "maintenance" + + + + + + + + + Card or port name of the entity that changed state. + + + + + + + + + + The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration. + + + + + Array of named hashMaps + + + + + + + Array of name-value pairs. + + + + + + + + Array of schema objects described by name, schema and other meta-information. + + + + + + + + Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + + The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain enumeration; it consists of the following fields: + + + + + Additional pnfRegistration fields if needed + + + + + + + TS 32.692 dateOfLastService = date of last service; e.g. 15022017 + + + + + + + + MAC address of OAM interface of the unit + + + + + + + + TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 + + + + + + + + TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model + + + + + + + + IPv4 m-plane IP address to be used by the manager to contact the PNF + + + + + + + + IPv6 m-plane IP address to be used by the manager to contact the PNF + + + + + + + + Version of the registrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + + + TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 + + + + + + + + TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 + + + + + + + + TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU + + + + + + + + TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale + + + + + + + + TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor + + + + + + + + + sipSignalingFields - The sipSignalingFields datatype communicates information about SIP signaling messages, parameters and signaling state. + + + + + + zdditionalInformation - Additional sipSignalling fields. + + + + + + + + compressedSip - The full SIP request/response including headers and bodies. + + + + + + + + + correlator - Constant across all events on this call. + + + + + + + localIpAddress - IP address on VNF. + +Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + + + + + + + + localPort - Port on VNF. + + + + + + + remoteIpAddress - IP address of peer endpoint. + +Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= + + + + + + + + remotePort - Port of peer endpoint + + + + + + + sipSignalingFieldsVersion - Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + + summarySip - The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc). + + + + + + + + + Vendor, NF and nfModule names + + + + + + + + Fields specific to state change events. + + + + + Additional stateChange fields if needed + + + + + + + New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ + + + + + Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ + + + + + Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Card or port name of the entity that changed state + + + + + + + Syslog’s can be classified as either Control or Session/Traffic. They differ by message content and expected volume: +• Control logs are generally free-form human-readable text used for reporting errors or warnings supporting the operation and troubleshooting of NFs. The volume of these logs is typically less than 2k per day. +• Session logs use common structured fields to report normal NF processing such as DNS lookups or firewall rules processed. The volume of these logs is typically greater than 1k per hour (and sometimes as high as 10k per second). +VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. High volume session logging should use a file-based transport solution. + + + + + + Additional syslog fields if needed Ex: {“name1”: ”value1”, “name2: “value2” … } + + + + + + + Hostname of the device + + + + + + + + Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’ + + + + + + + + 0-32 char in format name@number, +i.e., ourSDID@32473 + + + + + + + + + Numeric code from 0 to 23 for facility: + 0 kernel messages + 1 user-level messages + 2 mail system + 3 system daemons + 4 security/authorization messages + 5 messages generated internally by syslogd + 6 line printer subsystem + 7 network news subsystem + 8 UUCP subsystem + 9 clock daemon + 10 security/authorization messages + 11 FTP daemon + 12 NTP subsystem + 13 log audit + 14 log alert + 15 clock daemon (note 2) + 16 local use 0 (local0) + 17 local use 1 (local1) + 18 local use 2 (local2) + 19 local use 3 (local3) + 20 local use 4 (local4) + 21 local use 5 (local5) + 22 local use 6 (local6) + 23 local use 7 (local7 ) + + + + + + + + Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + Syslog message + + + + + + Hostname parsed from non-VES syslog message + + + + + + + + 0-192 +Combined Severity and Facility (see rfc5424) + + + + + + + + + Identifies the application that originated the message + + + + + + + + The process number assigned by the OS when the application was started + + + + + + + + A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT. + +Deprecated +The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs + + + + + + + + + Level-of-severity text enumeration defined below: +Text Sev Description +Emergency 0 system is unusable +Alert 1 action must be taken immediately +Critical 2 critical conditions +Error 3 error conditions +Warning 4 warning conditions +Notice 5 normal but significant condition +Info 6 Informational messages +Debug 7 debug-level messages + + + + + + + + Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP_STATUS_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided + + + + + + + + Timestamp parsed from non-VES syslog message + + + + + + + + IANA assigned version of the syslog protocol specification: + 0: VES + 1: IANA RFC5424 + + + + + + + + + + + + + + The diskUsage datatype defines the usage of a disk device. + + + + The number of bus resets in the performance interval. + + + + + + + + + Number of disk commands aborted over the measurementInterval. + + + + + + + + + Average number of commands per second over the measurementInterval. + + + + + + + + + Total flush requests of the disk cache over the measurementInterval. + + + + + + + + + Milliseconds spent on disk cache flushing over the measurementInterval. + + + + + + + + + Disk Identifier. + + + + + + + Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval + + + + + + Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval. + + + + + + + + + Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval + + + + + + + + Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval. + + + + + + + + + Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval. + + + + + + + + + Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval. + + + + + + + + + Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval. + + + + + + + + + Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval. + + + + + + + + + Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval + + + + + + + + + Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval. + + + + + + + + + Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval. + + + + + + + + + Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval. + + + + + + + + + Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. + + + + + + + + + Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval + + + + + + + + + Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. + + + + + + + + + Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. + + + + + + + + + Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. + + + + + + + + + Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. + + + + + + + + + Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. + + + + + + + + + Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. + + + + + + + + + Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. + + + + + + + + + Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. + + + + + + + + + Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. + + + + + + + + + Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. + + + + + + + + + Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. + + + + + + + + + Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. + + + + + + + + + Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. + + + + + + + + + Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. + + + + + + + + + Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. + + + + + + + + + Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. + + + + + + + + + Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. + + + + + + + + + diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. + + + + + + + + + Average number of read commands issued per second to the disk over the measurementInterval. + + + + + + + + + Nanoseconds spent on disk cache reads/writes within the measurementInterval. + + + + + + + + + Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. + + + + + + + + Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. + + + + + + + + + Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. + + + + + + + + + Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. + + + + + + + + + Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. + + + + + + + + + Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. + + + + + + + + + Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. + + + + + + + + + Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. + + + + + + + + + The average amount of time taken for a read from the perspective of a Guest OS. This is the sum of Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval. + + + + + + + + + The average amount of time taken for a write from the perspective of a Guest OS. This is the sum of Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval. + + + + + + + + + Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. + + + + + + + + Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. + + + + + + + + Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. + + + + + + + + Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. + + + + + + + + Average number of write commands issued per second to the disk over the measurementInterval + + + + + + + + + The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval + + + + + Description of the codec. + + + + + + + Number of such codecs in use. + + + + + + + + The thresholdCrossingAlertFields datatype consists of the following fields: + + + + + additionalFields - Additional pnfRegistration fields if needed. + + + + + + + + Array of performance counters + + + + + + + Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ + + + + + Unique short alert description (e.g., NE-CPUMEM) + + + + + + Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’ + + + + + Calculated API value (if applicable) + + + + + + + + List of eventIds associated with the event being reported + + + + + + + + Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ + + + + + + Specific performance collector instance used + + + + + + + + Type of network element (internal AT&T field) + + + + + + + + Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’ + + + + + Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ + + + + + + Physical or logical port or card (if applicable + + + + + + + + Network name (internal AT&T field) + + + + + + + + Reserved for future use + + + + + + + + Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + + The voiceQuality class provides statistics related to customer facing voice products; consists of the following fields: + + + + + Additional voice quality fields + + + + + + + Callee codec for the call + + + + + + Caller codec for the call + + + + + + Constant across all events on this call + + + + + + Phone number associated with the correlator + + + + + + + + Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) + + + + + + Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. + + + + + + End of call voice quality metric summaries + + + + + + + Vendor, NF and nfModule names + + + + + + + + The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: + + + + The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval + + + + + + + + + The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval + + + + + + + + + CPU demand in MHz + + + + + + + + + CPU demand as a percentage of the provisioned capacity + + + + + + + + CPU Identifier + + + + + + + Percentage of CPU time spent in the idle task + + + + + + + + + cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. + + + + + + + + + The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval + + + + + + + + + Swap wait time, in milliseconds over the measurementInterval + + + + + + + + + Percentage of time spent servicing interrupts + + + + + + + + + Percentage of time spent running user space processes that have been niced + + + + + + + + + +Percentage of time spent handling soft irq interrupts + + + + + + + + Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing + + + + + + + + Percentage of time spent on system tasks running the kernel + + + + + + + + Percentage of time spent running un-niced user space processes + + + + + + + + Percentage of CPU time spent waiting for I/O operations to complete + + + + + + + + Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running + + + + + + + + + The filesystemUsage datatype consists of the following fields: + + + + Configured block storage capacity in GB. + + + + + + + Block storage input-output operations per second. + + + + + + + Used block storage capacity in GB. + + + + + + + Configured ephemeral storage capacity in GB. + + + + + + + Ephemeral storage input-output operations per second. + + + + + + + Used ephemeral storage capacity in GB. + + + + + + + File system name. + + + + + + + + The hugePages datatype provides metrics on system hugePages + + + + Number of free hugePages in bytes. + + + + + + + + + Number of used hugePages in bytes. + + + + + + + + + HugePages identifier + + + + + + + + + Number of free hugePages in percent. + + + + + + + + + Number of used hugePages in percent. + + + + + + + + + Number of free hugePages in numbers. + + + + + + + + + Number of used hugePages in numbers. + + + + + + + + + + The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields: + + + + System fan exit air flow temperature in Celsius + + + + + + + + Front panel temp in Celsius + + + + + + + + Io module temp in Celsius + + + + + + + + Airflow in cubic feet per minute (cfm) + + + + + + + + Array of ipmiBaseboard Temperature objects + + + + + + + Array of ipmiBaseboard VoltageRegulator objects + + + + + + + Array of ipmiBattery objects + + + + + + + Array of ipmiFan objects + + + + + + + ipmi global aggregate temperature margin + + + + + + + Array of ipmiHsbp objects + + + + + + + Array of ipmiNic objects + + + + + + + Array of ipmiPowerSupply objects + + + + + + + Array of ipmiProcessor objects + + + + + + + + The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: +Field Type Required? Description + + + + + Baseboard temperature in celsius + + + + + + + + Identifier for the location where the temperature is taken + + + + + + + + + The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: + + + + Identifier for the baseboard voltage regulator + + + + + + Voltage regulator temperature in celsius + + + + + + + + + The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: + + + + Identifier for the battery + + + + + + Type of battery + + + + + + + + Battery voltage level + + + + + + + + + The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: + + + + Identifier for the fan + + + + + + Fan speed in revolutions per minute (rpm) + + + + + + + + + The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: + + + + Temperature margin in Celsius relative to a throttling thermal trip point + + + + + + + + Identifier for the ipmi global aggregate temperature margin metrics + + + + + + + The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: + + + + Identifier for the hot swap backplane power unit + + + + + + Hot swap backplane power temperature in celsius + + + + + + + + + The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: + + + + Identifier for the network interface control card + + + + + + nic temperature in Celsius + + + + + + + + + The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: + + + + Current output voltage as a percentage of the design specified level + + + + + + + + Identifier for the power supply + + + + + + Input power in watts + + + + + + + + Power supply temperature in Celsius + + + + + + + + + The ipmiProcessor datatype provides ipmi processor metrics + + + + Io module temperatue in celsius + + + + + + + + Front panel temperature in celsius + + + + + + + + Array of processorDimmAggregate ThermalMargin objects + + + + + + + Identifier for the power supply + + + + + + + The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket + + + + Number of counts falling within a defined latency bucket + + + + + + High end of bucket range (typically in ms) + + + + + + + + Low end of bucket range (typically in ms) + + + + + + + + + The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg + + + + number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg + + + + + + + + number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg + + + + + + + + number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg + + + + + + + + + The machineCheckException datatype describes machine check exceptions + + + + Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis + + + + + + + + Total hardware errors that were corrected by the hardware over the last one hour + + + + + + + + processIdentifier + + + + + + Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. + + + + + + + + Total uncorrected hardware errors that were detected by the hardware over the last one hour + + + + + + + + + The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: + + + + Kibibytes of temporary storage for raw disk blocks + + + + + + + + Kibibytes of memory used for cache + + + + + + + + Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running + + + + + + + + Host demand in kibibytes + + + + + + + + Kibibytes of physical RAM left unused by the system + + + + + + + + Percentage of time the VM is waiting to access swapped or compressed memory + + + + + + + + Shared memory in kilobytes + + + + + + + + The part of the slab that can be reclaimed such as caches measured in kibibytes + + + + + + + + The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes + + + + + + + + Amount of memory swapped-in from host cache in kibibytes + + + + + + + + Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second + + + + + + + + Amount of memory swapped-out to host cache in kibibytes + + + + + + + + Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second + + + + + + + + Space used for caching swapped pages in the host cache in kibibytes + + + + + + + + Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes + + + + + + + + Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. + + + + + + + + Virtual Machine identifier associated with the memory metrics + + + + + + + + + The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card + + + + Administrative state: enum: ‘inService’, ‘outOfService’ + + + + + + + Network interface card identifier + + + + + + Operational state: enum: ‘inService’, ‘outOfService’ + + + + + + + Cumulative count of broadcast packets received as read at the end of the measurement interval + + + + + + + + Count of broadcast packets received within the measurement interval + + + + + + + + Cumulative count of discarded packets received as read at the end of the measurement interval + + + + + + + + Count of discarded packets received within the measurement interval + + + + + + + + Cumulative count of error packets received as read at the end of the measurement interval + + + + + + + + Count of error packets received within the measurement interval + + + + + + + + Cumulative count of multicast packets received as read at the end of the measurement interval + + + + + + + + Count of multicast packets received within the measurement interval + + + + + + + + Cumulative count of octets received as read at the end of the measurement interval + + + + + + + + Count of octets received within the measurement interval + + + + + + + + Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. + + + + + + + + Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. + + + + + + + + Cumulative count of all packets received as read at the end of the measurement interval + + + + + + + + Count of all packets received within the measurement interval + + + + + + + + Cumulative count of unicast packets received as read at the end of the measurement interval + + + + + + + + Count of unicast packets received within the measurement interval + + + + + + + + Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. + + + + + + + + Speed configured in mbps. + + + + + + + + Cumulative count of broadcast packets transmitted as read at the end of the measurement interval + + + + + + + + Count of broadcast packets transmitted within the measurement interval + + + + + + + + Cumulative count of discarded packets transmitted as read at the end of the measurement interval + + + + + + + + Count of discarded packets transmitted within the measurement interval + + + + + + + + Cumulative count of error packets transmitted as read at the end of the measurement interval + + + + + + + + Count of error packets transmitted within the measurement interval + + + + + + + + Cumulative count of multicast packets transmitted as read at the end of the measurement interval + + + + + + + + Count of multicast packets transmitted within the measurement interval + + + + + + + + Cumulative count of octets transmitted as read at the end of the measurement interval + + + + + + + + Count of octets transmitted within the measurement interval + + + + + + + + Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. + + + + + + + + Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. + + + + + + + + Cumulative count of all packets transmitted as read at the end of the measurement interval + + + + + + + + Count of all packets transmitted within the measurement interval + + + + + + + + Cumulative count of unicast packets transmitted as read at the end of the measurement interval + + + + + + + + Count of unicast packets transmitted within the measurement interval + + + + + + + + Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. + + + + + + + + Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. + + + + + + + + + The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields: + + + + identifier for the aggregate thermal margin metrics from the processor dual inline memory module + + + + + + the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point + + + + + + + The processStats datatype provides metrics on system processes; it consists of the following fields: + + + + The number of threads created since the last reboot + + + + + + + + processIdentifier + + + + + + The number of processes in a blocked state + + + + + + + + The number of processes in a paging state + + + + + + + + The number of processes in a running state + + + + + + + + The number of processes in a sleeping state + + + + + + + + The number of processes in a stopped state + + + + + + + + The number of processes in a zombie state + + + + + + + + + + Average bit error rate + + + + + + Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets + + + + + + Average delivery latency + + + + + + Average receive throughput + + + + + + Average transmit throughput + + + + + + Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval + + + + + + + + Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval + + + + + + + + Endpoint activating the flow + + + + + + + + Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available + + + + + + Integer microseconds for the start of the flow connection + + + + + + Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ + + + + + + + + Endpoint deactivating the flow + + + + + + + + Time for the start of the flow connection, in integer UTC epoch time aka UNIX time + + + + + + Integer microseconds for the start of the flow connection + + + + + + Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ + + + + + + Connection status at reporting time as a working / inactive / failed indicator value + + + + + + Current connection state at reporting time + + + + + + + + Current tunnel state at reporting time + + + + + + + + Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow + + + + + + + Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' + + + + + + + + large packet round trip time + + + + + + + + large packet threshold being applied + + + + + + + + Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets + + + + + + + + maximum receive bit rate" + + + + + + + + maximum transmit bit rate + + + + + + + + array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow + + + + + + + Array of unique LTE QCI or UMTS class-of-service values observed in the flow + + + + + + + + Number of failed activation requests, as observed by the reporting node + + + + + + number of errored bits + + + number of errored bits + + + + + + number of bytes received, including retransmissions + + + + + + number of bytes transmitted, including retransmissions + + + + + + number of received packets dropped due to errors per virtual interface + + + + + + Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 + + + + + + + + Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 + + + + + + + + Http error count + + + + + + + + number of tunneled layer 7 bytes received, including retransmissions + + + + + + number of tunneled layer 7 bytes received, including retransmissions + + + + + + number of tunneled layer 7 bytes received, including retransmissions + + + + + + number of out-of-order packets + + + + + + number of errored packets + + + + + + number of packets received, excluding retransmission + + + + + + number of packets received, including retransmission + + + + + + number of packets transmitted, including retransmissions + + + + + + number of packet retrie + + + + + + number of packet timeouts + + + + + + number of tunneled layer 7 bytes received, excluding retransmissions + + + + + + Round Trip time + + + + + + Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow + + + + + + + Array of unique TCP Flags observed in the flow + + + + + + + + Time in milliseconds between the connection activation and first byte received + + + + + + + + Adjacency name + + + + + + Endpoint average jitter + + + + + + + + Enumeration: ‘Caller’, ‘Callee’ + + + + + Endpoint maximum jitter + + + + + + + + Endpoint RTP octets discarded + + + + + + + + Endpoint RTP octets lost + + + + + + + + Endpoint RTP octets received + + + + + + + + Endpoint RTP octets sent + + + + + + + + Endpoint RTP packets discarded + + + + + + + + Endpoint RTP packets lost + + + + + + + + Endpoint RTP packets received + + + + + + + + Endpoint RTP packets sent + + + + + + + + Local average jitter + + + + + + + + Local average jitter buffer delay + + + + + + + + Local maximum jitter + + + + + + + + Local max jitter buffer delay + + + + + + + + Local RTP octets discarded + + + + + + + + Local RTP octets lost + + + + + + + + Local RTP octets received + + + + + + + + Local RTP octets sent + + + + + + + + Local RTP packets discarded + + + + + + + + Local RTP packets lost + + + + + + + + Local RTP packets received + + + + + + + + Local RTP packets sent + + + + + + + + Decimal range from 1 to 5 (1 decimal place) + + + + + + + + one-way path delay in milliseconds + + + + + + + + Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) + + + + + + + + rFactor from 0 to 100 + + + + + + + + Round trip delay in milliseconds + + + + + + + + + vendorNfNameFields - The vendorNfNameFields provides vendor, nf and nfModule identifying information. + + + + nfModuleName - Name of the nfModule generating the event. + + + + + + + + + nfName - Name of the network function generating the event + + + + + + + + + vendorName - Network function vendor name. + + + + + + + + + + Additional key-value pairs if needed + + + + + + + Version of the perf3gpp event + + + + + + 3GPP measurement collection structure + + + + + + + + The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format + + + + 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 + + + + + + + + Granularity period for the PM report in seconds + + + + + + + + Array of monitored object local distinguished name ids per 3GPP TS 32.300 + + + + + + + + Distinguished name per 3GPP TS 28.550 + + + + + + + + Software version for the NF providing the PM data as specified in 3GPP TS 28.550 + + + + + + + + User Definable name for the measured object per 3GPP TS 28.550 + + + + + + + + Array of monitored object local distinguished name ids per 3GPP TS 32.300 + + + + + + + + + Name of the measurement job + + + + + + + + Measurement group Identifier + + + + + + + Measurement group Identifier + + + + + + + Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings + + + + + + + Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings + + + + + + + Array of measValues + + + + + + + + The measInfoIdInteger datatype provides an integer measurement group identifier; + + + + Integer measurement group Identifier + + + + + + + The measInfoIdString datatype provides a string measurement group identifier; + + + + String measurement group Identifier + + + + + + + The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results + + + + Array of integer measurement identifiers associated with the measurement results + + + + + + + + + The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results + + + + Array of string measurement identifiers associated with the measurement results + + + + + + + + + The measValues datatype provides 3GPP measurement values + + + + Additional key-value pairs if needed + + + + + + + Enumeration: ‘true’, ‘false’. Indicates if the values are suspect + + + VES 7.1 Spec has this attribute as a string. + + + + + + Array of results + + + + + + + Array of results + + + + + + + Array of results + + + + + + + Array of results + + + + + + + + The measResultInteger datatype provides an integer 3GPP PM measurement result; + + + + Integer reference to the counter + + + + + + Integer counter value + + + + + + + The measResultNull datatype provides a null 3GPP PM measurement result + + + + Integer reference to the counter + + + + + + Enumeration: ‘true’ or ‘false’ + + + The VES 7.1 Spec has this attribute as a string. + + + + + + + The measResultNumber datatype provides a number 3GPP PM measurement result + + + + Integer reference to the counter + + + + + + Number counter value + + + + + + + The measResultString datatype provides a string 3GPP PM measurement result; + + + + Integer reference to the counter + + + + + + String counter value + + + + + + + + + The hashMap datatype is an ‘associative array’, which is an unordered collection of key-value pairs of the form “key”: “value”, where each key and value are strings. Keys must use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized. + + + + A given entry in the hashmap, which is a key/value pair. + + + + + + + + + Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. + + + + + + + + + + Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ + + + + + + + + + + Array of named hashMaps + + + + Array of named hashMaps + + + + + + + + SchemaObject - The SchemaObject datatype provides an object schema, name and other meta-information along with one or more object instances that conform to the schema. + + + + Note: The VES Spec has this as a Json based object. + + + + objectInstances - Contains one or more instances of the SchemaObjectInstance object. + + + + + + + + objectName - Name of the object. + + + + + + + objectSchema - schema for the object. + + + + + + + + + objectSchemaUrl - URL to the schema for the object. + + + + + + + + + nfSubscribedObjectName - Name of the object associated with the nfSubscriptionId. + + + + + + + + + nfSubscriptionId - Identifies an OpenConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the SchemaObject. + + + + + + + + + + SchemaObjectInstance [ ] - The SchemabjectInstance datatype provides meta-information about an instance of a SchemaObject along with the actual object instance. + + + + Note: The VES Spec has this as a Json based object. + + + + SchemaObject - Optional recursive specification on SchemaObject + + + + + + + + objectInstance - Contains an instance conforming to the SchemaObject schema + + + + + + + + + objectInstanceEpochMicrosec - the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds. + + + + + + + + + objectKeys - An ordered set of keys that identifies this particular instance of SchemaObject (e.g., that places it in a hierarchy). + + + + + + + + + + domain - Event domain enumeration: + +‘fault’, ‘heartbeat’, ‘measurementsForVfScaling’, ‘mobileFlow’, ‘other’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ + + + + + + + + + + + + + + + + + + + + Enumeration: ‘CRIT’, ‘MAJ’ + + + + + Key is the name of the counter and value is the current value of the counter + + + + + Last threshold that was crossed + + + + + + + arrayOfSchemaObject - The arrayOfSchemaObject datatype provides an array of json objects, each of which is described by name, schema and other meta-information. + + + + Note: The VES Spec has this as a Json based object. + + + + arrayOfSchemaObject - arrayOfSchemaObject datatype provides an array of SchemaObjects, each of which is described by name, schema and other meta-information. + + + + + + + + + + + + + + + + + + Possible alertActions within thresholdCrossingAlertFields + + + + + + + + Possible values for ThresholdCrossingAlertFIelds alertType attribute. + + + + + + + + + + + + + namedHashMap [ ] - The namedHashmap datatype is a hashMap which is associated with and described by a name. + + + + + name - Name for the array of name-value pairs. + + + + + + + hashMap - One or more key:value pairs. + +Note: in ATTServiceSpecification - VesEventListener v5.4.1 type = field []. + + + + + + + + + Level-of-severity text enumeration defined below: +Text Sev Description +Emergency 0 system is unusable +Alert 1 action must be taken immediately +Critical 2 critical conditions +Error 3 error conditions +Warning 4 warning conditions +Notice 5 normal but significant condition +Info 6 Informational messages +Debug 7 debug-level messages + + + + + system is unusable + + + 0 + + + + + action must be taken immediately + + + 1 + + + + + critical conditions + + + 2 + + + + + error conditions + + + 3 + + + + + warning conditions + + + + + + 4 + + + + + normal but significant condition + + + 5 + + + + + Informational messages + + + 6 + + + + + debug-level messages + + + 7 + + + + + + Numeric code from 0 to 23 for facility: + 0 kernel messages + 1 user-level messages + 2 mail system + 3 system daemons + 4 security/authorization messages + 5 messages generated internally by syslogd + 6 line printer subsystem + 7 network news subsystem + 8 UUCP subsystem + 9 clock daemon + 10 security/authorization messages + 11 FTP daemon + 12 NTP subsystem + 13 log audit + 14 log alert + 15 clock daemon (note 2) + 16 local use 0 (local0) + 17 local use 1 (local1) + 18 local use 2 (local2) + 19 local use 3 (local3) + 20 local use 4 (local4) + 21 local use 5 (local5) + 22 local use 6 (local6) + 23 local use 7 (local7) + + + + + kernel messages + + + + + user-level messages + + + + + mail system + + + + + system daemons + + + + + security/authorization messages + + + + + messages generated internally by syslogd + + + + + line printer subsystem + + + + + network news subsystem + + + + + UUCP subsystem + + + + + clock daemon + + + + + security/authorization messages + + + + + FTP daemon + + + + + NTP subsystem + + + + + log audit + + + + + log alert + + + + + clock daemon + + + + + local use 0 (local0) + + + + + local use 1 (local1) + + + + + local use 2 (local2) + + + + + local use 3 (local3) + + + + + local use 4 (local4) + + + + + local use 5 (local5) + + + + + local use 6 (local6) + + + + + local use 7 (local7 ) + + + + + + Threshold Crossing Alert counter criticality - possible values of CRIT and MAJ. + + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + Array of ipmiBaseboard VoltageRegulator objects + + + + + +
+ + + + + +
+ + + Array of ipmiBaseboard Temperature objects + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + Fill in attribute defs and check attribute multiplicity + + + + Fields specific to fault events. + + + syslogFacility and syslogSev as enums? + + + Treated associatedAlertList as a String with multiplicity of * + + + measValues to measVlauesList + + + cmNotif as class or datatype. Given the complexity, I opted for a class + + + Not sure how to model correlatedNotifications. Looking for ITUT doc referenced. + + + event time - no type specified. + + + + + + Additional information nf provider wants to convey. + + + + + + + Version of the cmNotify + + + + + + Notifications to which this notification is considered to be correlated + + + + + + + Time of the cmNotify event. + + + + + + Unique Identifier for the source of this occurrence of the notification. For 3GPP devices this is the notification identifier as defined by ITUT + + + + + + Indicates the source of the operation that led to the generation of the notification. + + + + + + + DN of the management service provider + + + + + + + + Array of cmNotif notificatons + + + + + + + + Indicates the source of the operation + + + + internal operation of resource + + + + + response to management operation + + + + + result of SON + + + + + can’t determine why + + + + + + + Type of notification. This is an enum (managedObjectCreation, managedObjectDeletion, managedObjectAttributeValueChanged) + + + + + + + + Managed Object Instance that is the subject of this notification. In 3GPP devices this is the Distinguished Name (DN) which is used to uniquely identify a MO within a name space as defined by ITU-T + + + + + + + + Type of object identifier (Ynag, or ....) + + + + + + + + [R1] Attribute Name and values (attributeName(string), newAttributeValue(any type), oldAttributeValue(any type) +[R2] This is Mandatory for notifyMOIAttributeValueChange. 3GPP defines it as options for Creation and Deletion. + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Vnf.di b/ONAP_Information_Model/Vnf.di new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/Vnf.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/Vnf.notation b/ONAP_Information_Model/Vnf.notation new file mode 100644 index 0000000..0c098f4 --- /dev/null +++ b/ONAP_Information_Model/Vnf.notation @@ -0,0 +1,10642 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/Vnf.uml b/ONAP_Information_Model/Vnf.uml new file mode 100644 index 0000000..7bb4ef9 --- /dev/null +++ b/ONAP_Information_Model/Vnf.uml @@ -0,0 +1,3883 @@ + + + + + + +
+ + + Defines descriptors of virtual compute resources to be used by the VNF. + + + + + +
+ + + References to Vdus that are part of this group. + + + + + +
+ + + + + +
+ + + Describes external interface(s) exposed by this VNF enabling connection with a VL. + + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + +
+ + + Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. + + + + + + + + +
+ + + Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. support: + + + + + + + + +
+ + + Describes the software image which is directly loaded on the virtualisation container realising this Vdu. + +NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. + + + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + +
+ + + Identifies a flavour within a VnfVirtualLinkDesc. + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + Defines the internal VLD along with additional data which is used in this DF. + +NOTE 1: This allows for different VNF internal topologies between DFs. + +NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. + + + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + + + +
+ + + Uniquely references a VLD. + + + + + +
+ + + + + +
+ + + + + +
+ + + Reference to the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect. + + + + + +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + +
+ + + + + +
+ + + Specify instantiation priority and dependencies of VDU. + + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +
+ + + + + +
+ + + An Anfd (Allotted Network Function Descriptor) is designed to run on top of some sharable NetworkFunction. It si therefore related to the NfD at design time. + +The NetworkFunctionDesc can be designed to have some number (zero to many). + + + + + + + + + + + +
+ + + An AnfInstance (Allotted Network Function Instance) runs on top of some sharable NetworkFunction. The NetworkFunctionInstance can have some number (zero to many) of AnfInstances running on it. + + + + + + + + + + + + + Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management. + + + A few quick observations +1. Using integer for number. Jessie: Created a primitive called Number which is a superset of integer and real. +2. created a datatype called enum. Deleted enum. Created "enums" where needed. +3. Seems like we are just using ETSI (beyound what we have in the works). Jessie: It appears that way. +4. Is monitoring param a class or a data type? Jessie: It is a datatype. Due to it's relationship to event, maybe a class?? +5. Class versus datatype?? + + + + ResourceDesc??? + + + +. +can protocol be enumerated? - yes. Values? + +Change addrestype to enumeration +. +Change L2addressData and l3addressData to 0..1 given "only present...." definition + + + + orchestration Status - Pending, Created, Active... - Christina will query. +. +onboardedVnfPkgInfoId - need class for VnfPkg? Yes - probably need more discussion - tied to vnf model and internal model. Vnf Instance related to vnf descriptor or onboarding pkg descriptor + + + Will not try to push this out into R3 - save for R4 + + + ONAP has a VirtualLinkDesc, not NetworkLink or LinkDesc + +This will probably need to move to common + + + Attributes in violet - not necessary in Infomodell - can be retrieved from Vnfd. + + + Attributes in beige - added or changed + + + AnfInstanceRunsOnSharableNfInstance represents the "ProvidedBy". + +The Uses relationship is covered by the service instance expressing the sharable infrasturcture capability which has a relationship to the sharable resource. The ANF instance also has a relationship to the same sharable resource. + + + - Pnfs cannot run on a Vnf or Anf + +- Pnfs cannot run on Pnfs, etc. + + + + + + + The Virtualisation Deployment Unit (VDU) is a construct supporting the description of the deployment and operational behavior of a VNFC. + +A VNFC instance created based on the VDU maps to a single virtualisation container (e.g. a VM). + +A VNFC will only be in one VNFDesc. If a vendor wants to use the VNFC in mupliple VNFDesc (their product) they can do so, but it will be 'repeated'. + + + + + + + + Unique identifier of this Vdu in VNFD. + + + + + + + Human readable name of the Vdu. + + + + + + Human readable description of the Vdu. + + + + + + Boot order of valid boot devices. "key/name" indicates the the boot index "value" references a descriptor from which a valid boot device is created e.g. VirtualStorageDesc from which a VirtualStorage instance is created. + +NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. + + + + + + + + + Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment for the VNFC instance that involve additional entities or processes. "key/name" includes "AvailabilityZone", "HostAggregates". + +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. + + + + + + + + + Defines the virtualised resources monitoring parameters on VDU level. + + + + + + + Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. + + + + + + + + Describes the configurable properties of all VNFC instances based on this VDU. + + + + + Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. +NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as "volatile" parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as "persistent" parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental + + + + + + + Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. +NOTE: The parameters of each variable part shall be declared in the VnfLcmOperationsConfiguration information element as "volatile" parameters available to the bootData template during the respective VNF lifecycle management operation execution and/or in the extension attribute of the VnfInfoModifiableAttributes information element as "persistent" parameters available to the bootData template during the lifetime of the VNF instance. For VNF lifecycle management operations resulting in multiple VNFC instantiations, the VNFM supports the means to provide the appropriate parameters to appropriate VNFC instances Experimental + + + + + + + + + + + + Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL). + + + + + Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. + + + + + + + Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu. + + + + + + + Describes the software image which is directly loaded on the virtualisation container realising this Vdu. + +NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. + + + + + + + + + + + + + A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of deployment and operational behaviour requirements. It also contains connectivity, interface and virtualised resource requirements. + + + + + + + + + Provider of the VNF and of the VNFD. + + + + + + Name to identify the VNF Product. Invariant for the VNF Product lifetime. + + + + + + Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package. + + + + + + Identifies the version of the VNFD. + + + + + + Human readable name for the VNF Product. Can change during the VNF Product lifetime. + + + + + + + + Human readable description of the VNF Product. Can change during the VNF Product lifetime. + + + + + + + + Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. Use the name of micro-service of the vnfm drive. For vendor specific VNFM, the value composes of "vendorname" and "vnfmdriver", e.g. "mycompanyvnfmdriver"; for generic VNFM, the value is "gvnfmdriver". + + + + + + + + Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html + +NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time. + + + + + + + + + Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation. + + + + + + + + Identifier of this 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. + + + + + + Information about localization languages of the VNF (includes e.g. strings in the VNFD). Refer to ISO936 https://www.iso.org/iso-639-language-codes.html + +NOTE: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time. + + + + + + + + + Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). + + + + + + + Includes a list of events and corresponding management scripts performed for the VNF. + + + + + + + File path of the vendor specified logo. + + + + + + + + UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. + + + + + + + + Virtualisation Deployment Unit. + + + + + + + Describes external interface(s) exposed by this VNF enabling connection with a VL. + + + + + + + Describes specific DF(s) of a VNF with specific requirements for capacity and performance. + + + + + + + Declares the VNF indicators that are supported by this VNF. + + + + + + + Defines descriptors of virtual compute resources to be used by the VNF. + + + + + + + Defines descriptors of virtual storage resources to be used by the VNF. + + + + + + + Reserved IP Address for VNF which is not bounded to any specific VNFC, but assigned manually from outside and potentially shared as a floating IP among VNFCs. + + + + + + + Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management. + + + + + + + Defines descriptors of software images to be used by the VNF. +NOTE: This shall be used to describe both the software image loaded on the virtualization container used to realize a VDU and the software images to be stored on VirtualStorage resources (e.g., volumes) attached to a virtualization container. + + + + + + + + Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP. + + + + + + + Defines security group rules to be used by the VNF. + + + + + + + + The SwImageDesc information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks. Storage not necessarily related to the compute, may be Network Attached Storage (NAS) + + + + + + + The identifier of this software image. + + + + + + The name of this software image. + + + + + + The version of this software image. + + + + + + The checksum of the software image file. + + + + + + The container format describes the container file format in which software image is provided. + + + + + + The disk format of a software image is the format of the underlying disk image. + + + + + + The minimal RAM requirement 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. + + + + + + + + The minimal disk size requirement 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. + + + + + + The size of the software image. + + + + + + Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. + + + + + + + + + Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. + + + + + + + + This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL + + + + + + + + The VduProfile describes additional instantiation data for a given VDU used in a DF. + + + + Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater. + + + + + + + Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. Shall be zero or greater. + + + + + + + Specifies affinity or anti-affinity rules applicable between the virtualization 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 virtualization 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 virtualization containers (e.g. virtual machines) to be created based on this VDU. + + + + + + + + Identifier(s) of the 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 action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc. + + + + + + + + Timeout value for the VNFM to wait before the successful booting up of the VDU. + + + + + + + + VNFD needs to specify the security group name {security_groups} for each VDU. + + + + + + + + Additional expansion requirements for Infrastructure layer, e.g. HA property (Host Aggregate ). + + + + + + + + + + + + + The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources. + + + + Unique identifier of this VirtualComputeDesc in the VNFD + + + + + + Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities. + + + + + + + Specifies compute requirements. + + + + + + + + The virtual memory of the virtualised compute. + + + + + The virtual CPU(s) of the virtualised compute. + + + + + The associated logical node requirements. + + + + + + + The local or ephemeral disk(s) of the virtualised compute. + + + + + + + + The VirtualStorageDesc information element supports the specifications of requirements related to persistent virtual storage resources. Ephemeral virtual storage is specified in VirtualComputeDesc information element. + + + + Unique identifier of this VirtualStorageDesc in the VNFD. + + + + + + + Type of virtualised storage resource (BLOCK, OBJECT, FILE). + + + + + + + Size of virtualised storage resource +(e.g. size of volume, in GB). + + + + + + + Specifies the details of block storage. It shall be present when the "typeOfStorage" attribute is set to "BLOCK". It shall be absent otherwise. + + + + + + + Specifies the details of object storage. It shall be present when the "typeOfStorage" attribute is set to "OBJECT". It shall be absent + + + + + + + Specifies the details of file storage. It shall be present when the "typeOfStorage" attribute is set to "FILE". It shall be absent otherwise. + + + + + + + Indicating whether a vDisk is a shared volume in VNFD. + + + + + + + + Describe storage Qos requirements. + + + + + + + Describe volume type. + + + + + + + + A VduCpd information element is a type of Cpd and describes network connectivity between a VNFC instance (based on this VDU) and an internal VL. + + + + + + + Bitrate requirement on this CP. + + + + + + + + + Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. + + + + + + + + + Describes the order to create the vNIC within the scope of this Vdu. + + + + + + + + + Describes the type of the vNIC this CP attaches to. + + + + + + + + Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. + + + + + + + Define the port anti-affinity group ID for each SR-IOV type vNIC. Multiple vNICs in the same anti-affinity group must belong to the same virtual network, and the number of vNICs in the same anti-affinity group cannot exceed two. + + + + + + + + VNFD needs to specify the security group name {security_groups} for each vNic. + + + + + + + + VNFD needs to specify whether to enable security group for the vNic. + + + + + + + + Describe the Qos requirements of the VduCpd. + + + + + + + + Reference(s) of the Virtual Link Descriptor to which this Connection Point Descriptor(s) connects. + + + + + + + For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. + + + + + + + + + + The VnfDf describes a specific deployment version of a VNF. + + + + Identifier of this DF within the VNFD. + + + + + + + Human readable description of the DF. + + + + + + This attribute references the "instantiationLevel" entry which defines the default instantiation level for this DF. It shall be present if there are multiple "instantiationLevel" entries. + + + + + + + + Specifies the virtualised resource related performance metrics to be tracked by the VNFM. + + + + + + + Defines the internal VLD along with additional data which is used in this DF. + +NOTE 1: This allows for different VNF internal topologies between DFs. + +NOTE 2: virtualLinkProfile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. + + + + + + + + Describes the various 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. + + + + + + + + Specifies affinity or 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. + + + + + + + + + The scaling aspects supported by this DF of the VNF. scalingAspect shall be present if the VNF supports scaling. + + + + + + + Describes additional instantiation data for the VDUs used in this flavor. + + + + + + + Determine where VNFC's (VDU's) are placed with respect to the VNF + + + + + + + BaseConfigGroup may set 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 provides the minimum viable VDU and associated VNFC configuration for a useable VNF. + + + + + + + Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. + + + + + + + Declares the VNF indicators that are supported by this VNF (specific to this DF). + + + + + + + + A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL. +When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements. + + + + + Specifies requirements 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. + + + + + + + + A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL. +When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements. + + + + + + + + + + + + + The VnfIndicator information element defines the indicator the VNF supports. + + + + Unique identifier. + + + + + + The human readable name of the VnfIndicator. + + + + + + + + Defines the allowed values or value ranges of this indicator. + + + + + + + + Describe the source of the indicator. This tells the consumer where to send the subscription request. + + + + + + The VirtualLinkDescFlavour describes additional instantiation data for a given internal VL used in a DF. + + + + QoS of the VL. + + + + + + + Identifies a flavour within a VnfVirtualLinkDesc. + + + + + + + + + This class specifies requirements on a virtual network interface. + + + + Provides a human readable name for the requirement. + + + + + + + + + Provides a human readable description of the requirement. + + + + + + + + + Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE). + + + + + + The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements + + + + + + + + This references (couples) 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. + + + + + + + + The InstantiationLevel class describes a given level of resources to be instantiated within a DF in term of the number of VNFC instances to be created from each VDU. +All the VDUs referenced in the level shall be part of the corresponding DF and their number shall be within the range (min/max) for this DF. + + + + + + + Uniquely identifies a level with the DF. + + + + + + Human readable description of the level. + + + + + + Represents for each aspect the scale level that corresponds to this instantiation level. scaleInfo shall be present if the VNF supports scaling. + + + + + + + Indicates the number of instance of this VDU to deploy for this level. + + + + + + + Specifies bitrate 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. + + + + + + + + + The VduLevel information element indicates for a given VDU in a given level the number of instances to deploy. + + + + Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. + + + + + + Uniquely identifies a VDU. + + + + + + + + A VNFD Element Group is a mechanism for associating elements of a VNFD (Vdus and VnfVirtualLinkDesc(s)) for a +certain purpose, for example, scaling aspects. + +A given element can belong to multiple groups. + + + + Unique identifier of this group in the VNFD. + + + + + + Human readable description of the group. + + + + + + References to Vdus that are part of this group. + + + + + + + References to VnfVirtualLinkDesc that are part of this group. + + + + + + + + + Every Vnf contains a BaseConfigGroup. + +BaseConfigGroup may set Access Control Lists (ACL's) and establish security groups and server groups. +BaseConfigGroup reates/establishs storage for the VM's (OpenStack Cinder). +BaseConfigGroup may establish internal networks such as OAM (VNF Mgmt) or MNS (Maintenance & Surveillance) established. + +A very simple VNF may only have a BaseConfig VnfElementGroup. + + + + + + + DeploymentGroup provides the minimum viable VDU and associated VNFC configuration for a useable VNF. I can have a small, medium, large deployment configuration. + + + + + + + Homing selects what cloud selection strategy will be used. + +HomingGroup is used to determine where VNF's within a given group are placed with respect to a service component. + +Homing strategy is as follows: +Colocation - members of the group share the same cloud region (VIM Domain) +isolation - members of the group do not share the same cloud region. + + + + + + + + The homing strategy can be one of the following: + +Exclusivity - Resources within the cloud region are exclusive to the group +Inclusively - Resources are co-located in the same cloud-region. +Diversity - Resources are geo-diverse ( cannot be co-located). + + + + + + + + + + + + + + Describes an external CP exposed by a VNF. + + + + + + + + An implementation of an NF that can be deployed on a Network Function Virtualisation Infrastructure (NFVI). + + + + + + + name to identify the VNF Product, invariant for the VNF Product lifetime + + + + + + + + provider of the VNF model + + + + + + Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package + + + + + + identifier of the specific VNF package on which the VNF instance is based + + + + + + availability zone information of the VNF instance + + + + + + indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + + + + + + + whether the VNF instance is instantiated + + + + + oam ip address, ipv4 + + + + + + + + oam ip address, ipv6 + + + + + + + + information specific to an instantiated VNF instance, e.g., vm information + + + + + + + + whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + + + + + + + Indicates whether the closed loop function is enabled or disabled. + + + + + + + + whether this VNF is accessed using SSH + + + + + + + + indicator for whether autoHeal and autoScale is enabled + + + + + + + Identifier of the policy which has the naming logic for this VNF instance + + + + + + Identifier of the policy which provides homing conditions. + + + + + + Relatonship to the VNF components that are part of this VNF. + + + + + + + Relationship to the VNF descriptor + + + + + + + Relationship to VnfVirtualLink + + + + + + + IP address between VNF and VNFM. + + + + + + + + + + + + + + + + + + + + + + + + + + An internal component of a VNF providing a VNF Provider a defined sub-set of that VNF's functionality, with the main characteristic that a single instance of this component maps 1:1 against a single Virtualisation Container. + + + + identifier of the NFC instance + + + + + + short code of the NFC instance + + + + + + + + description of the NFC instance + + + + + + + identifier of the model of the NFC instance + + + + + + layer-3 interface addresses, ipv4 + + + + + + + layer-3 interface addresses, ipv6 + + + + + + + operating status of the VM + valid value example: STARTED (POWER_ON), STOPPED (POWER_OFF) + + + + + + + whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + + + + + + + whether closed loop function is enabled + + + + + + + + An intelligent or human readable name of the vnfc instance. Multiple names are possible. + + + + + + + + Reference to the connection points of the vnfc + + + + + + + Identifier of the policy which has the naming logic for this VNFC instance + + + + + + English description of network function component that the specific VNFC deployment is providing. + + + + + + indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + + + + + whether the VNFC instance is instantiated + + + + + Whether closed loop capabilities are enabled for this or not. + + + + + Reference to the VDU + + + + + + + + + + + + + An Anfd is the (Allotted Network Function) is a template which describes an ANF in terms of deploymnet and operational behaviour requiremnets. + + + + + + + + + The VirtualLinkProfile describes additional instantiation data for a given VL used in a DF. + + + + Uniquely identifies this VirtualLinkProfile class + + + + + + Specifies affinity or 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. + + + + + + + + + Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + + + + + + + Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + + + + + + + Identifies a flavour within the VnfVirtualLinkDesc. + + + + + Identifies an affinity or anti-affinity group the VLs instantiated according to the VlProfile belong to. +NOTE : Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationship between the VL(s) using this VirtualLinkProfile and the VL(s) using other VirtualLinkProfile(s) in the same group. + + + + + + + + + Uniquely references a VLD. + + + + + + + Specifies the protocol data for a VL instantiated according to this profile. Cardinality 0 is used when no protocol data needs to be specified. + + + + + + + + The ScalingAspect class describes the details of an aspect used for horizontal scaling. + + + + Unique identifier of this aspect in the VNFD. + + + + + + Human readable name of the aspect. + + + + + + Human readable description of the aspect. + + + + + + + A ScalingGroup determines which VNFC's (VDU's) are scaled together based on demand. + + + + + + + + + The Vnffgd class specifies a topology of connectivity of a NS and optionally forwarding rules applicable to the traffic conveyed over this topology. + + + + Identifier of this Vnffgd information element. It uniquely identifies a VNFFGD. + + + + + + References the VNFD of a constituent VNF. +NOTE 1: The list of constituent VNFs, PNFs, and nested NS SAPs of a VNFFG can be identical to the list of constituent VNFs, PNFs and nested NSs of the parent NSD, or can be a subset of it. +NOTE 2: The presence of a VNFD or PNFD identifier in a VNFFGD does not imply that all connection points instantiated from all embedded CPDs are connected to the VNFFG instantiated using the VNFFGD. + + + + + + + A reference to a pool of descriptors of connection points attached to one of the constituent VNFs and PNFs and/or one of the SAPs of the parent NS or of a nested NS. + + + + + + + + The network forwarding path associated to the VNFFG. + + + + + + + + References the PNFD of a constituent PNF. +NOTE 1 : The list of constituent VNFs, PNFs, and nested NS SAPs of a VNFFG can be identical to the list of constituent VNFs, PNFs and nested NSs of the parent NSD, or can be a subset of it. +NOTE 2: The presence of a VNFD or PNFD identifier in a VNFFGD does not imply that all connection points instantiated from all embedded CPDs are connected to the VNFFG instantiated using the VNFFGD. + + + + + + + + + + The VnfProfile class specifies a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF. + + + + + + + Identifier of this vnfProfile class. It uniquely identifies a VnfProfile. + + + + + + Identifier of the instantiation level of the VNF DF to be used for instantiation. +If not present, the default instantiation level as declared in the VNFD shall be used. + + + + + + + + Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. + + + + + + Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile. + + + + + + Specifies affinity and anti-affinity rules applicable between VNF instances created from this profile. + + + + + + + Identifier(s) of the affinity or anti-affinity group(s) the VnfProfile belongs to. +NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationships between the VNF instance(s) created using this VnfProfile and the VNF instance(s) created using other VnfProfile(s) in the same group. + + + + + Defines the connection information of the VNF, it contains connection relationship between a VNF connection point and a NS virtual Link. + + + + + + + + Identifies a flavour within the VNFD. + + + + + + + Reference to the VNFD. + + + + + + + + A graph of logical links connecting NF nodes,where at least one node is a VNF, for the purpose of describing traffic flow between these network functions + + + + Identier of this Vnffg class. + + + + + Identifier of the constituent NFs of the VNFFG + + + + + Identifier(s) of the constituent VL instance(s) of the VNFFG. + + + + + + + Identifiers of the CP instances attached to the constituent VNFs and PNFs or the sap instances of the VNFFG. +NOTE: It indicates an exhaustive list of all the CP instances and SAP instances of the VNFFG. + + + + + Information on the NFPs of this VNFFG. + + + + + + A software image + + + + + This information element describes compute, memory and I/O requirements that are to be associated with the logical node of infrastructure. The logical node requirements are a sub-component of the VDU level requirements. As an example for illustration purposes, a logical node correlates to the concept of a NUMA cell in libvirt terminology. + + + + Identifies this set of logical node requirements. + + + + + + The logical node-level 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. + + + + + + + + + + Represents the type of network connectivity mandated by the VNF vendor between two or more Connection Points which includes at least one Internal Connection Point. + + + + + + + Specifies the virtualised resource related performance metrics on VLD level to be tracked by the VNFM. + + + + + + + Describes a specific flavour of the VL with specific bitrate requirements. + + + + + + + + Security group rule specifies the matching criteria for the ingress and/or egress traffic to/from the visited connection points. If an ingress traffic is accepted, the corresponding egress response shall be allowed, regardless of the security group rules on the egress direction. If an egress traffic is allowed, the corresponding ingress response shall be accepted, regardless of the security group rules on the ingress direction. The design of security group rule follows a permissive model where all security group rules applied to a CP are dealt with in an "OR" logic fashion, i.e. the traffic is allowed if it matches any security group rule applied to this CP. + + + + Identifier of the security group rule. + + + + + + Human readable description of the security group rule + + + + + + + + The direction in which the security group rule is applied. + + + + + + + + Indicates the protocol carried over the Ethernet layer. + + + + + + + + + Indicates the protocol carried over the IP layer. Permitted values: any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc. +See https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml +Note: IFA011 defines this as an enum, but as the list is not complete, made this a string. + + + + + + + + Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. + + + + + + + + + Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. + + + + + + + + + + An Allotted Network Function Instance is a network function provided (or allotted) by some service instance. The allotted network function may be incorporated into the topology of some consuming service like other network functions. + + + + + + + Link back to more information in the controller + + + + + + Concurrency value + + + + + + Orchestration status + + + + + + Indicator for whether the resource is considered operational + + + + + + Store the id of the access provider of this allotted-resource. + + + + + + Store the id of the access client of this allotted-resource. + + + + + + Store the id of the access topology of this allotted-resource. + + + + + + Store the id of the access node of this allotted-resource. + + + + + + Store the id of the access ltp of this allotted-resource. + + + + + + Store the cvlan of this allotted-resource. + + + + + + Store the vpn-name of this allotted-resource. + + + + + + + + + + + + + + + This information element describes requested additional capability for a particular VDU. Such a capability may be for acceleration or specific tasks. + + + + Indicates whether the requested additional capability is mandatory for successful operation. + + + + + + Identifies a requested additional capability for the VDU. + + + + + + + Identifies the minimum version of the requested additional capability. + + + + + + + + Identifies the preferred version of the requested additional capability. + + + + + + + + Identifies specific attributes, dependent on the requested additional capability type. + + + + + + + + + The VirtualMemoryData information element supports the specification of requirements related to virtual memory of a virtual compute resource. + + + + Amount of virtual Memory (e.g. in MB). + + + + + + The memory core 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. + + + + + + + + Array of key-value pair requirements on the memory for the VDU. + + + + + + + + It specifies 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. + + + + + + + + + + The VirtualCpuData information element supports the specification of requirements related to virtual CPU(s) of a virtual compute resource. + + + + CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested. + + + + + + + + Number of virtual CPUs. + + + + + + Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. + + + + + + + + The CPU core 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. + + + + + + + + Array of key-value pair requirements on the Compute (CPU) for the VDU. + + + + + + + + The virtual CPU pinning configuration for the virtualised compute resource. + + + + + + + + The VirtualCpuPinningData information element supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource. + + + + The policy can take values of "static" or "dynamic". In case of "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). + + + + + + + + A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. + + + + + + + + This datatype defines the configurable properties of a VNF (e.g. related to auto scaling and auto healing). For a VNF instance, the value of these properties can be modified by the VNFM + + + + It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. + +NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. + + + + + + + + + It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. + +NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. + + + + + + + + + + + + + + + This datatype defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the ModifyVnfInfo operation. + + + + + + "Extension" attributes of VnfInfo that are writeable. NOTE: The exact data structure describing the attribute is left for data model solution specification, but it should include: name, and any constraints on the values, such as ranges, predefined values, etc. + + + + + + + Metadata" attributes of VnfInfo that are writeable. NOTE: The exact data structure describing the attribute is left for data model solution specification, but it should include: name, and any constraints on the values, such as ranges, predefined values, etc. + + + + + + + + + Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. + + + + + + + Describes the 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. + + + + + + + + + Information to locate a 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. + + + + + + Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. + + + + + + Array of KVP 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. + + + + + + + + + + Specifies the virtualized resource related performance metric to be tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects the values of performance metrics identified by this information element from the VIM(s) using one or more locally initiated PM Jobs. These values can be used as inputs to auto-scaling rules. + + + + Unique identifier of the monitoring parameter. + + + + + + Human readable name of the monitoring parameter. + + + + + + + + Identifies the virtualized resource performance metric. + + + + + + An attribute that describes the recommended 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. + + + + + + + + + + + + + + This datatype defines the configurable properties of a VNFC. For a VNFC instance, the value of these properties can be modified through the VNFM. + + + + It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. + + + + + + + + + Describes the type of VNIC to which a CP attaches. + + + + + + + + + + + The ScaleInfo information element represents a scale level for a particular scaling aspect. + + + + Reference to the scaling aspect. + + + + + The scale level, greater than or equal to 0 + + + + + + + Defines the CPU pinning policy. + + + + + + + Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. + + + + + + + + + + + + + + + + + + + + + + + Describes the source of the indicator. + + + + + + + + Specifies the periodicity at which the producer will collect performance information. Note: at the end of each reportingPeriod, the producer will inform the consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. While the exact definition of the types for collectionPeriod and reportingPeriod is left for further specification, it is recommended that the reportingPeriod be equal or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period would be reported together. + + + + + + + + + + + + + + The VirtualLinkBitRateLevel information element specifies bitrate requirements applicable to a virtual link instantiated from a particular VnfVirtualLinkDesc. + + + + Uniquely identifies a VnfVirtualLinkDesc + + + + + Bitrate requirements for an instantiation level or bitrate delta for a scaling step. + + + + + + + Provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems. + + + + + + + + Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. + + + + + + + + + + + + + + + + + The VnfIndicatorData datatype identifies a VNF indicator in a VNFD. + + + + Identifies a VNFD. + + + + + Identifies a VNF indicator within the VNFD. + + + + + + The VnfToLevelMapping datatype specifies the profile to be used for a VNF involved in a given NS level and the required number of instances. + + + + Identifies the profile to be used for a VNF involved in an NS level. + + + + + Specifies the number of VNF instances required for an NS level. +NOTE 1: It shall be in the range of minNumberOfInstances-maxNumberOfInstances, as specified in the referenced VnfProfile. +NOTE 2: When the corresponding NS level is used in the context of NS instantiation, the numberOfInstances attribute specifies the number of VNF instances to be deployed. +NOTE 3: When the corresponding NS level is used in the context of NS scaling, the numberOfInstances attribute does not specify the number of VNF instances to be added/removed when reaching that NS scale level. The actual number of VNF instances to be added/removed can be derived by subtracting the numberOfInstances declared in the source NS scale level from the numberOfInstances declared in the target NS level of the scaling request. + + + + + + + Specifies the details of the block storage resource. + + + + Size of virtualised storage resource in GB. + + + + + + An array of key-value pairs that articulate the storage deployment requirements. + + + + + + + + Indicates if the storage supports rdma. + + + + + + + + Software image to be loaded on the VirtualStorage resource created based on this VirtualStorageDesc. +Shall be absent when used for virtual disks. + + + + + + + + + The ObjectStorageData information element specifies the details of object storage resource. + + + + Max size of virtualised storage resource in GB. + + + + + + + + + The FileStorageData information element specifies the details of file storage resource. + + + + Size of virtualised storage resource in GB. + + + + + + The shared file system protocol (e.g. NFS, CIFS). + + + + + + Reference of the internal VLD which this file storage connects to. +The attached VDUs shall connect to the same internal VLD. + + + + + + + + Unique identifier of the storage Qos in VNFD. + + + + + + Name of storage QoS. + + + + + + Consumer type. + + + + + Describe qualities of Qos：total_bytes_sec、total_iops_sec. + + + + + + + + + + Unique identifier of volume type in VNFD. + + + + + + Name of volume type. + + + + + + Backend volume name of cinder. + + + + + + + The VirtualLinkProtocolData describes the protocol layer and associated protocol data for a virtual link + + + + One of the values of the attribute layerProtocol of the ConnectivityType IE. + + + + + + Specifies the L2 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise. + + + + + + + + Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise. + + + + + + + + + The QoS as applied to the vnf. + + + + + + + + Ingress or egress traffic + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP_Information_Model/model.di b/ONAP_Information_Model/model.di new file mode 100644 index 0000000..8c549ee --- /dev/null +++ b/ONAP_Information_Model/model.di @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/model.notation b/ONAP_Information_Model/model.notation new file mode 100644 index 0000000..bf9abab --- /dev/null +++ b/ONAP_Information_Model/model.notation @@ -0,0 +1,2 @@ + + diff --git a/ONAP_Information_Model/model.uml b/ONAP_Information_Model/model.uml new file mode 100644 index 0000000..81e7b96 --- /dev/null +++ b/ONAP_Information_Model/model.uml @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + diff --git a/docs/ONAP Model Spec/im/BusinessInteraction.rst b/docs/ONAP Model Spec/im/BusinessInteraction.rst deleted file mode 100644 index 820c82e..0000000 --- a/docs/ONAP Model Spec/im/BusinessInteraction.rst +++ /dev/null @@ -1,574 +0,0 @@ -.. Copyright 2019 -.. 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 - -Business Interaction Model -========================== - -.. contents:: - :depth: 3 -.. - -Class Definition ----------------- - -BusinessInteractionItemRelationship class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses:: BusinessInteractionItemRelationship - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -**Table** **Attributes for Class BusinessInteractionItemRelationship** - -================== ========== ========= ===================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ========== ========= ===================================================== ===================== -type String 1 The type of relationship such as contains, relies on. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ========== ========= ===================================================== ===================== - -Agreement class -^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::Agreement - -**Description:** - -A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law. - -**Parent class:** BusinessInteraction - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -**Table** **Attributes for class Agreement** - -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -documentNumber String 1 A reference number assigned to an Agreement that follows a prescribed numbering system. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -statementOfIntent String 1 An overview and goals of the Agreement. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -StartDate DateTime 1 Date interaction initiated OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute - - Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== - -BusinessInteraction class -^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteraction - -**Description:** - -A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements. - -This class is abstract. - -**Parent class:** RootEntity - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -**Table** **Attributes for class BusinessInteraction** - -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -StartDate DateTime 1 Date interaction initiated OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute - - Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== - -BusinessInteractionItem class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionItem - -**Description:** - -The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource. - -This class is abstract. - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -**Table** **Attributes for class BusinessInteractionItem** - -================== ======== ========= ======================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ======================================================================= ===================== -quantity Integer 1 Quantity of an interaction item involved in an interaction. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -action String 1 The action to take for an InteractionItem, such as add, change, remove. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ======== ========= ======================================================================= ===================== - -BusinessInteractionRelationship class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship - -**Description:** - -An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement. - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -**Table** **Attributes for class BusinessInteractionRelationship** - -================== ========== ========= =============================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ========== ========= =============================================================================== ===================== -type String 1 A categorization of the relationship, such as bulk, parent/child, and so forth. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ========== ========= =============================================================================== ===================== - -BusinessInteractionSpec class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionSpec - -**Description:** - -The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec. - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -BusinessInteractionVersion class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionVersion - -**Description:** - -Version of the business interaction. - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From TMF SID - -Notification class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::Notification - -**Description:** - -A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction. - -This class is abstract. - -**Parent class:** BusinessInteraction - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From the TMF SID - -Request class -^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::Request - -**Description:** - -The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction. - -This class is abstract. - -**Parent class:** BusinessInteraction - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From the TMF SID - -Response class -^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Business Interaction::ObjectClasses::Response - -**Description:** - -A reply to a Request - -This class is abstract. - -**Parent class:** BusinessInteraction - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -- Reference - -- reference: From the TMF SID diff --git a/docs/ONAP Model Spec/im/Common/BusinessInteraction.png b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png new file mode 100644 index 0000000..08977ed Binary files /dev/null and b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png differ diff --git a/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst new file mode 100644 index 0000000..3f287a8 --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst @@ -0,0 +1,582 @@ +.. Copyright 2019 +.. 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 + +Business Interaction Model +========================== + +.. contents:: + :depth: 3 +.. + +Diagram +------- + +Business Interaction +^^^^^^^^^^^^^^^^^^^^ + +.. image:: BusinessInteraction.png + +Class Definition +---------------- + +BusinessInteractionItemRelationship class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses:: BusinessInteractionItemRelationship + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for Class BusinessInteractionItemRelationship** + +================== ========== ========= ===================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ===================================================== ===================== +type String 1 The type of relationship such as contains, relies on. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ===================================================== ===================== + +Agreement class +^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Agreement + +**Description:** + +A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class Agreement** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +documentNumber String 1 A reference number assigned to an Agreement that follows a prescribed numbering system. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +statementOfIntent String 1 An overview and goals of the Agreement. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +StartDate DateTime 1 Date interaction initiated OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +BusinessInteraction class +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteraction + +**Description:** + +A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements. + +This class is abstract. + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteraction** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +StartDate DateTime 1 Date interaction initiated OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +BusinessInteractionItem class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionItem + +**Description:** + +The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource. + +This class is abstract. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteractionItem** + +================== ======== ========= ======================================================================= ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ======================================================================= ===================== +quantity Integer 1 Quantity of an interaction item involved in an interaction. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +action String 1 The action to take for an InteractionItem, such as add, change, remove. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ======== ========= ======================================================================= ===================== + +BusinessInteractionRelationship class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship + +**Description:** + +An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteractionRelationship** + +================== ========== ========= =============================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= =============================================================================== ===================== +type String 1 A categorization of the relationship, such as bulk, parent/child, and so forth. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= =============================================================================== ===================== + +BusinessInteractionSpec class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionSpec + +**Description:** + +The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +BusinessInteractionVersion class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionVersion + +**Description:** + +Version of the business interaction. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +Notification class +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Notification + +**Description:** + +A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction. + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID + +Request class +^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Request + +**Description:** + +The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction. + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID + +Response class +^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Response + +**Description:** + +A reply to a Request + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID diff --git a/docs/ONAP Model Spec/im/Common/DynamicParameters.png b/docs/ONAP Model Spec/im/Common/DynamicParameters.png new file mode 100644 index 0000000..b7d41f8 Binary files /dev/null and b/docs/ONAP Model Spec/im/Common/DynamicParameters.png differ diff --git a/docs/ONAP Model Spec/im/Common/DynamicParameters.rst b/docs/ONAP Model Spec/im/Common/DynamicParameters.rst new file mode 100644 index 0000000..17d1a7e --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/DynamicParameters.rst @@ -0,0 +1,492 @@ +.. Copyright 2020 +.. 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 + +Dynamic Parameters Model +======================== + +Diagrams +-------- + +.. image:: DynamicParameters.png + +Dynamic Parameters +~~~~~~~~~~~~~~~~~~~ + +Classes +------- + +DiscreteValueSpec +~~~~~~~~~~~~~~~~~ + +DiscreteValueSpec represents a specific valid value that a given Parameter can take on. + +**Parent class:** ParmSpecValue + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ======== ========= ================================== ================================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +value String 1 Preliminary A discrete value that the Parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================ + +Parameter +~~~~~~~~~ + +Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ============== ========= ================================== ================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameterName String 1 Preliminary Name of parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +IsInput Boolean 1 Preliminary Boolean that specifices if this parameter is an input parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +paramvalue ParameterValue 0..\* OpenModelAttribute Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +isModifiable Boolean 1 Preliminary Bolean that specifices if the value can be modified or changed during the life of this parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary The type of this parameter (integer, string, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitOfMeasure String 0..1 Preliminary A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Description of the parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============== ========= ================================== ================================================================================================================================================================================================================================================================================================================== + +ParameterGroup +~~~~~~~~~~~~~~ + +A group of parameters that somehow relate or work together. + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +========================= ========== ========= ================================== ============================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameterGroupName String 1 Preliminary Name of ParameterGroup + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +parameterGroupDescription String 1 Preliminary Description of ParameterGroup. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +parameterGroupId Identifier 1 Preliminary ID of ParameterGroup. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ========== ========= ================================== ============================== + +ParameterValue +~~~~~~~~~~~~~~ + +The actual value of Parameter (runtime). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ========= ========= ================================== =========================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameter Parameter 1 OpenModelAttribute Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 Preliminary The actual value of Parameter (runtime). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========= ========= ================================== =========================================================================================================================== + +ParmSpecValue +~~~~~~~~~~~~~ + +A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +RangeValueSpec +~~~~~~~~~~~~~~ + +RangeValueSpec is generally expected to be of valueType integer or + +RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter. + +rangeStep should be greater than zero. + +valueTo should be greater than valueFrom + +**Parent class:** ParmSpecValue + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ======== ========= ================================== ============================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +valueMin String 1 Preliminary The minimum value that a Parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueMax String 1 Preliminary The maximum value that the parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +rangeStep String 0..1 Preliminary The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and valueTo attributes. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================================================================================================================================================================================================================== + +Associations +------------ + +ParameterGroupHasParameter +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters. + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +parameter shared Not navig. 1..\* Parameter OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +dynamicparameter none Not navig. 0..\* ParameterGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParameterHasInstanceValue +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== ================================================================================================================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +paramvalue composite Navig. 0..\* ParameterValue Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parameter none Navig. 1 Parameter Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================================================================================================================================================== ===================== + +OperationalEntityFurtherDefinedByParam +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +dynamicparamvalue none Not navig. 0..\* ParameterValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +operationalentity none Not navig. 1 OperationalEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================= =============== ===================== + +DesignEntityFurtherDefinedByParmGroup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +dynamicparameter none Not navig. 0..\* ParameterGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +designentity none Not navig. 0..\* DesignEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParmSpecValueIntantiatedAsDynamicParmValue +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_parametervalue none Not navig. 0..\* ParameterValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parmspecvalueii none Not navig. 0..1 ParmSpecValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParameterEnumeratedBy SpecValue +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +parameter none Not navig. 1 Parameter OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parmspecvalueii composite Not navig. 0..\* ParmSpecValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============= =============== ===================== diff --git a/docs/ONAP Model Spec/im/Common/SelectionCriteria.png b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png new file mode 100644 index 0000000..70d709a Binary files /dev/null and b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png differ diff --git a/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst b/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst new file mode 100644 index 0000000..5452faa --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst @@ -0,0 +1,252 @@ +.. Copyright 2020 +.. 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 + +Selection Criteria Model +======================== + +Diagrams +-------- + +SelectionCriteria +~~~~~~~~~~~~~~~~~~ + +.. image:: SelectionCriteria.png + +Classes +------- + +.. _selectioncriteria-1: + +SelectionCriteria +~~~~~~~~~~~~~~~~~ + +SelectionCriteria finds descriptors and instances according to specific properties of those entities. + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ========== ========= ================================== ============================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ============================================= + +SelectionCriteriaAtomic +~~~~~~~~~~~~~~~~~~~~~~~ + +A simple (atomic) selection criteria that holds a specific attribute comparision expression. + +**Parent class:** SelectionCriteria + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ========== ========= ================================== ================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +metricName String 1 Preliminary Name of compared parameter or attribute. + + OpenModelAttribute Name of compared parameter or attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +operator Operator 1 Preliminary Comparison operator, e.g. equal, less than, greater or etc. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 Preliminary Compared value (can be a name of a parameter in referenced class). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary The type of the value property (String, Integer, Real, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ================================================================== + +SelectionCriteriaComposite +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations. + +**Parent class:** SelectionCriteria + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ================= ========= ================================== ===================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +compositeOperator CompositeOperator 1 Preliminary Logical operation for filters composition, e.g. logical AND, OR, XOR. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================= ========= ================================== ===================================================================== + +Associations +------------ + +DesignEntityHasSelectionCriteria +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +designentity none Not navig. 0..\* DesignEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +selectioncriteria none Not navig. 0..\* SelectionCriteria OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================= =============== ===================== + +SelectionCriteriaCompositeComprisedOfSelectionCriteria +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +selectioncriteria shared Not navig. 2..\* SelectionCriteria OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +selectioncriteriacomposite none Not navig. 0..\* SelectionCriteriaComposite OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ========================== =============== ===================== + +Enumerations +------------ + +CompositeOperator +~~~~~~~~~~~~~~~~~ + +The operator being applied to to some group of selectoin critiera. + +Contains Enumeration Literals: + +- AND: + +- OR: + +- XOR: + +Operator +~~~~~~~~ + +The operator being applied to some atomic selection critera. + +Contains Enumeration Literals: + +- MORETHAN: + +- LESSTHAN: + +- EQUAL: diff --git a/docs/ONAP Model Spec/im/License/Entitlements.png b/docs/ONAP Model Spec/im/License/Entitlements.png new file mode 100644 index 0000000..a5289f6 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/Entitlements.png differ diff --git a/docs/ONAP Model Spec/im/License/License.png b/docs/ONAP Model Spec/im/License/License.png new file mode 100644 index 0000000..6832518 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/License.png differ diff --git a/docs/ONAP Model Spec/im/License/LicenseKey.png b/docs/ONAP Model Spec/im/License/LicenseKey.png new file mode 100644 index 0000000..157abae Binary files /dev/null and b/docs/ONAP Model Spec/im/License/LicenseKey.png differ diff --git a/docs/ONAP Model Spec/im/License/LicenseModel.rst b/docs/ONAP Model Spec/im/License/LicenseModel.rst new file mode 100644 index 0000000..533dd2f --- /dev/null +++ b/docs/ONAP Model Spec/im/License/LicenseModel.rst @@ -0,0 +1,1033 @@ +.. Copyright 2020 +.. 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 + +License Management Model +======================== + +Diagrams +-------- + +Root Entity Hierarchy +~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: RootHierarchy.png + +License +~~~~~~~~ + +.. image:: License.png + +Rooting License +~~~~~~~~~~~~~~~~ + +.. image:: RootingLicense.png + +License Keys +~~~~~~~~~~~~ + +.. image:: LicenseKey.png + +Entitlements +~~~~~~~~~~~~~ + +.. image:: Entitlements.png + +Classes +------- + +EntitlementPool +~~~~~~~~~~~~~~~ + +Note: description is required according to the inherited attribute, but it presently is optional. + +An EntitlementPool is created for each type of Entitlement that is required for the VNFs. Each Entitlement Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the Entitlement Pool are defined. +An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups containing a VNF or even to multiple VNFs. +Purchased entitlements are inventoried in the Entitlement Pools. +Multiple pools for the same type of entitlement may be created based on the constraints. + +**Parent class:** DesignEntity + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +===================================== ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_spPoolLimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the service provider + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendorPoolLimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the vendor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +entitlementManufactureReferenceNumber String 0..1 OpenModelAttribute Reference number for the entitlement as described by the vendor in their price list / catalog /contract. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +entitlementPurchaseIncrements Integer 0..1 OpenModelAttribute This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +entitlementPoolThresholdValue Integer 0..1 OpenModelAttribute A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: + when 90% of the pool is in-use, trigger an additional purchase of inventory. + - isInvariant: false + A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: + - valueRange: no range constraint when 90% of the pool is in-use, trigger an additional purchase of inventory. + + - support: MANDATORY + + Preliminary +entitlementPoolThresholdUnits ThresholdUnitType 0..1 OpenModelAttribute Specifies the Units for the ThresholdValue. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +invariantId Identifier 1 OpenModelAttribute Identifier that stays the same irrespective of version. + + - isInvariant: false Identifier that stays the same irrespective of version. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +Version String 1 OpenModelAttribute The version of this entity. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +poolType LicenseGroupType 1 OpenModelAttribute The license key may be 'universal' or 'unique' or 'one-time'. + - A 'universal' value indicates that the same exact license key (string) may be associated with all instances of the VNF. + - isInvariant: false - A 'unique' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. + - A 'one-time' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +validFor TimePeriod 0..1 Preliminary The period during which the design entity is valid. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +status String 1 Preliminary The condition of the specification, such s active, inactive, or planned. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Defines a textual free-form description of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +===================================== ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +FeatureGroup +~~~~~~~~~~~~ + +Feature groups represent a set of the features of one or more VNFs. Feature groups may be defined by the vendor and/or by the service provider. A VNF may be related to multiple feature groups. At least one feature group will be related to a VNF. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the VNF(s) in it. +If an Entitlement Pool or License Key Group is associated with a particular Feature Group, the Feature Group becomes a "constraint" for the pool/group. + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +======================= ======== ========= ================================== ====================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +featureGroupName String 1 OpenModelAttribute Name of the feature group + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +featureGroupDescription String 0..1 OpenModelAttribute Description of the feature group. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +featureGroupPartNumber String 1 OpenModelAttribute The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to. + + - isInvariant: false The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +======================= ======== ========= ================================== ====================================================================================================================================== + +LicenseAgreement +~~~~~~~~~~~~~~~~ + +An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family. + +**Parent class:** Agreement + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +========================== =========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +requirementsAndConstraints String 1..\* OpenModelAttribute Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + - isInvariant: false Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +licenseTerm LicenseTerm 1 OpenModelAttribute Term of the license: + -fixed term + - isInvariant: false -perpetual + -unlimited + - valueRange: no range constraint -subscription + + - support: MANDATORY + + Preliminary +documentNumber String 1 Preliminary A reference number assigned to an Agreement that follows a prescribed numbering system. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +statementOfIntent String 1 Preliminary An overview and goals of the Agreement. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +StartDate DateTime 1 Preliminary Date interaction initiated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endDate DateTime 1 Preliminary The date on which an interaction is closed or completed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 0..1 Preliminary Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== =========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +LicenseKeyPool +~~~~~~~~~~~~~~ + +A License Key Pool is created for each type of License Key that is required for the VNF. +Each License Key Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the License Key Pool are defined. +The license key Pool model provides a description to interested systems for the license keys that are provided by a vendor. +A license key Pool is not specific to a feature group. A license key Pool may be related to multiple feature groups that a VNF belongs to or even to multiple VNFs. + +**Parent class:** DesignEntity + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================================= ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_spPooLlimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the service provider + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendorPoollimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the vendor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +poolType LicenseGroupType 1 OpenModelAttribute The license key may be 'universal' or 'unique' or 'one-time'. + - A 'universal' value indicates that the same exact license key (string) may be associated with all instances of the VNF. + - isInvariant: false - A 'unique' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. + - A 'one-time' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +thresholdUnits ThresholdUnitType 0..1 OpenModelAttribute Units can be either absolute or a percentage (%). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +thresholdValue Integer 0..1 OpenModelAttribute Specified threshold value for the license key pool. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +keyPurchaseIncrements String 0..1 OpenModelAttribute Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +invariantId Identifier 1 OpenModelAttribute Identifier that stays the same irrespective of version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +Version String 1 OpenModelAttribute The version of this entity. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +licenseManufactureReferenceNumber String 0..1 OpenModelAttribute Identifier for the entitlement as described by the vendor in their price list / catalog /contract. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +validFor TimePeriod 0..1 Preliminary The period during which the design entity is valid. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +status String 1 Preliminary The condition of the specification, such s active, inactive, or planned. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Defines a textual free-form description of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================================= ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +PoolLimit +~~~~~~~~~ + +A variable set of values that identify the limits that may be imposed by an entitlement instance in the pool. Multiple constraints may be applicable for an instance of entitlement in the pool. For example, an entitlement based on GB and number of sessions. Increments, aggregation function, time scope, threshold value may repeat for each metric in the list. +Limits can be applied by the vendor or the service provider. + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +=================== ================ ========= ================================== =================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +limitMetricType EPMetricType 1 OpenModelAttribute Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +limitMetricValue Integer 1 OpenModelAttribute The value of some limit being applied. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +aggregationFunction AggregationTypes 0..1 OpenModelAttribute Type of aggregation being performed (Peak or Average) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +limitUnits LimitUnits 1 OpenModelAttribute The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, ...) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +time DateTime 0..1 OpenModelAttribute Units time is specified in (day, month, hour, minute, second, millisecond. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +poolMetricTypeOther String 0..1 OpenModelAttribute LimitMetricType if Other enumeration is selected. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +=================== ================ ========= ================================== =================================================================================================================================================== + +Associations +------------ + +LicenseKeyPoolHasSPLimits +~~~~~~~~~~~~~~~~~~~~~~~~~ + +LicenseKey can have some number of service provider based limits applied to it. + +Applied stereotypes: + +================== =========== ========== ========= ============== ============================================================================= ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_spPooLlimit composite Navig. 0..\* PoolLimit Pool limits applied by the service provider OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licencekeypool none Not navig. 1 LicenseKeyPool lLicenseKeyPool can have some number of service provider specified PoolLimits OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ============================================================================= ===================== + +LicenseKeyPoolHasVendorLimits +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +LicenseKey can have some number of vendor based limits applied to it. + +Applied stereotypes: + +================== =========== ========== ========= ============== ================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_vendorPoollimit composite Navig. 0..\* PoolLimit Pool limits applied by the vendor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licencekeypooldesc none Not navig. 1 LicenseKeyPool OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================== ===================== + +EntitlementPoolHasSPPoolLimits +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An EntitlementPool and the associated Entitlements can have some number of Service Provider based limits. + +Applied stereotypes: + +================== =========== ========== ========= =============== ========================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_spPoolLimit composite Navig. 0..\* PoolLimit Pool limits applied by the service provider OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +entitlementpool none Not navig. 1 EntitlementPool EntitlementPool can have some number of service provider specified limits. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= =============== ========================================================================== ===================== + +EntitlementPoolHasVendorPoolLimits +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An EntitlementPool and the associated Entitlements can have some number of Vendor based limits. + +Applied stereotypes: + +================== =========== ========== ========= =============== ==================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_vendorPoolLimit composite Navig. 0..\* PoolLimit Pool limits applied by the vendor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +entitlementpool none Not navig. 1 EntitlementPool The EntitlementPool can have some number of Vendor specified limits. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= =============== ==================================================================== ===================== + +FeatureGroupHasEntitlementPool +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A FeatureGroup can have one or more EntitlementPools associated with it. + +Applied stereotypes: + +================== =========== ========== ========= =============== =============================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +entitlementpool none Not navig. 1..\* EntitlementPool The EntitlementPool can be related to one FeatureGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +featuregroup none Not navig. 0..\* FeatureGroup FeatureGroup can be related to some number of EntitlementPools. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= =============== =============================================================== ===================== + +FeatureGroupHasLicenceKeyPool +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +FeatureGroup can have 1 or more LicenseKeyPools and related LicenseKeys related to it. + +Applied stereotypes: + +================== =========== ========== ========= ============== ================================================================ ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +licencekeypool none Not navig. 0..\* LicenseKeyPool LicenseKeyPool is related to one FeatureGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +featuregroup none Not navig. 0..\* FeatureGroup A feature group can be related to some number of LicenseKeyPools OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================================================ ===================== + +LicenseAgreementHasFeatureGroup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +================== =========== ========== ========= ================ =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +featuregroup none Not navig. 1..\* FeatureGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licenseagreement none Not navig. 1..\* LicenseAgreement OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================ =============== ===================== + +VendorHasVnfd +~~~~~~~~~~~~~ + +Applied stereotypes: + +================== =========== ========== ========= ======== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +vendor none Not navig. 1 Vendor +vnfd none Not navig. 0..\* Vnfd OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ======== =============== ===================== + +VendorHasLicenseAgreement +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +================== =========== ========== ========= ================ =================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +vendor none Not navig. 1 Vendor A Vendor can have some number of LicenseAgreements. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licenseagreement none Not navig. 0..\* LicenseAgreement A LicenseAgreement is related to some vendor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================ =================================================== ===================== + +VnfHasFeatureGroup +~~~~~~~~~~~~~~~~~~ + +A Vnf can have some number of feature groups. A feature group can apply to one or more Vnfs. + +Applied stereotypes: + +================== =========== ========== ========= ============ =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +featuregroup none Not navig. 0..\* FeatureGroup +vnfd none Not navig. 1..\* Vnfd OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============ =============== ===================== + +Data Types +---------- + +Enumerations +------------ + +AggregationTypes +~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- PEAK: + +- AVERAGE: + +EPMetricType +~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- BWTH: + +- COUNTRY: + +- SESSION: + +- LOB: + +- SITE: + +- USAGE: + +- OTHER: + +LicenseDuration +~~~~~~~~~~~~~~~ + +Units of the entitlement/license term. Valid values: year, quarter, month, day. + +Contains Enumeration Literals: + +- YEAR: + +- QUARTER: + +- MONTH: + +- DAY: + +LicenseGroupType +~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- UNIVERSAL: + +- UNIQUE: + +- ONE_TIME: + +LicenseTerm +~~~~~~~~~~~ + +Valid values: +year, quarter, month, day. +Not applicable when license type is Perpetual. + +Contains Enumeration Literals: + +- FIXED_TERM: + +- PERPETUAL: + +- UNLIMITED: + +- OTHER: + +- TRIAL: + +- SUBSCRIPTION: + +LimitUnits +~~~~~~~~~~ + +Contains Enumeration Literals: + +- TRUNKS: + +- USERS: + +- SUBSCRIBERS: + +- SESSIONS: + +- TENANTS: + +- TOKENS: + +- SEATS: + +- TB: + +- GB: + +- MB: + +- OTHER: + +ThresholdUnitType +~~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- ABSOLUTE: + +- %: diff --git a/docs/ONAP Model Spec/im/License/RootHierarchy.png b/docs/ONAP Model Spec/im/License/RootHierarchy.png new file mode 100644 index 0000000..b5accd3 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/RootHierarchy.png differ diff --git a/docs/ONAP Model Spec/im/License/RootingLicense.png b/docs/ONAP Model Spec/im/License/RootingLicense.png new file mode 100644 index 0000000..e01ff53 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/RootingLicense.png differ diff --git a/docs/ONAP Model Spec/im/NSD.rst b/docs/ONAP Model Spec/im/NSD.rst deleted file mode 100644 index 2d4469a..0000000 --- a/docs/ONAP Model Spec/im/NSD.rst +++ /dev/null @@ -1,686 +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 - -.. contents:: - :depth: 3 -.. - -|image0| - -NetworkServiceDescriptorModel -=============================== - - -NetworkServiceDescriptor ------------------------- - -The NSD class is a deployment template whose instances are used by the -NFVO for the lifecycle management of NSs. For all attributes in this -class, the Producer is SDC and the Consumer is SDC/UUI/VFC - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Preliminaryry - -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| **AttributeName** | **Type** | **Mult.** | **Stereotypes** | **Description**| -| | | | | | -+==========================+============================+=============+===================+================+ -| nsdIdentifier | Identifier | 1 | Preliminary | Identifier | -| | | | | of this NSD | -| | | | OpenModelAttribute| class. It | -| | | | | globally | -| | | | | uniquely | -| | | | - isInvariant: | identifies | -| | | | true | an instance | -| | | | | of the NSD. | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| designer | String | 1 | Preliminary | Identifies | -| | | | | the | -| | | | OpenModelAttribute| designer of | -| | | | | the NSD. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| version | Version | 1 | Preliminary | Identifies | -| | | | | the version | -| | | | OpenModelAttribute| of the NSD. | -| | | | | | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| nsdName | String | 1 | Preliminary | Provides | -| | | | | the human | -| | | | OpenModelAttribute| readable | -| | | | | name of the | -| | | | | NSD. | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| nsdInvariantId | Identifier | 1 | Preliminary | Identifies | -| | | | | an NSD in a | -| | | | OpenModelAttribute| version | -| | | | | independent | -| | | | | manner. | -| | | | - isInvariant: | This | -| | | | false | attribute is | -| | | | | invariant | -| | | | - valueRange: | across | -| | | | no | versions of | -| | | | range | NSD. | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| autoScalingRule | Rule | 0..\* | Preliminary | Specifies a | -| | | | | rule to | -| | | | OpenModelAttribute| trigger a | -| | | | | scaling | -| | | | | action on a | -| | | | - isInvariant: | NS | -| | | | false | instantiated | -| | | | | according | -| | | | - valueRange: | to the NSD. | -| | | | no | NOTE 1: The | -| | | | range | rule is | -| | | | constraint | based on a | -| | | | | combination | -| | | | | of | -| | | | | assertions | -| | | | - support: | on the | -| | | | MANDATORY | values of | -| | | | | virtualised | -| | | | | resource- | -| | | | | related | -| | | | | performance | -| | | | | metrics and | -| | | | | VNF | -| | | | | Indicators | -| | | | | identified | -| | | | | by the | -| | | | | monitoredInfo | -| | | | | attribute. | -| | | | | NOTE 2: | -| | | | | There may | -| | | | | be multiple | -| | | | | data | -| | | | | sources | -| | | | | (each | -| | | | | identified | -| | | | | as | -| | | | | monitoredInfo) | -| | | | | per rule | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| monitoredInfo | MonitoredData | 0..\* | Preliminary | Identifies | -| | | | | either a | -| | | | OpenModelAttribute| virtualised | -| | | | | resource- | -| | | | | related | -| | | | - isInvariant: | performance | -| | | | false | metric or a | -| | | | | VNF | -| | | | | Indicator. | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| lifeCycleManagementScript| NsLifeCycleManagementScript| 0..\* | Preliminary | Provides a | -| | | | | life cycle | -| | | | OpenModelAttribute| management | -| | | | | script | -| | | | | written in | -| | | | - isInvariant: | a Domain | -| | | | false | Specific | -| | | | | Language | -| | | | - valueRange: | (DSL). | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| \_virtualLinkDesc | NsVirtualLinkDesc | 0..\* | Preliminary | Provides | -| | | | | the | -| | | | OpenModelAttribute| constituent | -| | | | | VLDs. | -| | | | | Cardinality | -| | | | - isInvariant: | of 0 means | -| | | | false | that the NS | -| | | | | is a NF set | -| | | | | with | -| | | | - valueRange: | unspecified | -| | | | no | connectivity. | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| \_vnfdId | Vnfd | 0..\* | Preliminary | References | -| | | | | the VNFD of | -| | | | OpenModelAttribute| a | -| | | | | constituent | -| | | | | VNF. | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -| | | | | | -| | | | PassedByReference | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| \_pnfdId | Pnfd | 0..\* | Experimental | References | -| | | | | the PNFD of | -| | | | | a | -| | | | OpenModelAttribute| constituent | -| | | | | PNF. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -| | | | | | -| | | | PassedByReference | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ - -NsVirtualLinkDesc ------------------ - -The NsVirtualLinkDesc class provides general information enabling the -instantiation of virtual links. For all attributes in this class the -Producer is SDC and the Consumer is SDC/UUI/VFC. - -**Parent class:** VirtualLinkDesc - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Preliminaryry - -+------------------------+-----------------+-------------+-------------------+----------------+ -| **Attribute Name** | **Type** | **Mult.** | **Stereotypes** | **Description**| -+========================+=================+=============+===================+================+ -| vitualLinkDescProvider | String | 0..1 | Preliminary | Defines the | -| | | | | organization | -| | | | OpenModelAttribute| generating | -| | | | | the VLD. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| virtuaLinkDescVersion | Version | 1 | Preliminary | Specifies | -| | | | | the version | -| | | | OpenModelAttribute| of the VLD. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| VirtualLinkDf | VirtualLinkDf | 1 | Preliminary | Specifies | -| | | | | properties | -| | | | OpenModelAttribute| for | -| | | | | instantiating | -| | | | - isInvariant: | a VL | -| | | | false | according | -| | | | | to a | -| | | | | specific | -| | | | - valueRange: | flavour. | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| virtualLinkDescId | Identifier | 1 | Preliminary | Uniquely | -| | | | | identifies | -| | | | OpenModelAttribute| a VLD in | -| | | | | the parent | -| | | | | descriptor. | -| | | | - isInvariant: | For | -| | | | false | VnfVirtualL | -| | | | | inkDesc, | -| | | | | the parent | -| | | | | descriptor | -| | | | - valueRange: | is the | -| | | | no | VNFD. For | -| | | | range | NsVirtualLi- | -| | | | constraint | nkDesc, | -| | | | | the parent | -| | | | | descriptor | -| | | | - support: | is the NSD. | -| | | | MANDATORY | Note: the | -| | | | | description | -| | | | | of this | -| | | | | class are | -| | | | | different | -| | | | | in ETSI GS | -| | | | | NFV IFA 011 | -| | | | | and ETSI GS | -| | | | | NFV IFA | -| | | | | 014. The | -| | | | | present | -| | | | | definition | -| | | | | merges the 2 | -| | | | | definitions. | -+------------------------+-----------------+-------------+-------------------+----------------+ -| connectivityType | ConnectivityType| 1 | Preliminary | Specifies | -| | | | | the | -| | | | OpenModelAttribute| protocol | -| | | | | exposed by | -| | | | | a VL and | -| | | | - isInvariant: | the flow | -| | | | false | pattern | -| | | | | supported | -| | | | | by the VL. | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| description | String | 0..1 | Preliminary | Provides | -| | | | | human-readable | -| | | | OpenModelAttribute| information | -| | | | | on the | -| | | | - isInvariant: | purpose of | -| | | | false | the VL | -| | | | | (e.g. | -| | | | | control | -| | | | - valueRange: | plane | -| | | | no | traffic). | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ - -Pnfd ----- - -The Pnfd class is a deployment template enabling on-boarding PNFs and -referencing them from an NSD. It focuses on connectivity aspects only. - -**Parent class:** NetworkFunctionDesc - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Experimental - - - -Vnfd ----- - -The Vnfd class is a deployment template enabling on-boarding VNFs and -referencing them from an NSD. - - -ConnectivityType ----------------- - -The ConnectivityType datatype specifies the protocol exposed by a VL and -the flow pattern supported by the VL. - -+--------------+--------------+-----------+-----------+-------------------+----------------+ -| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| -| Name** | | | | | | -+==============+==============+===========+===========+===================+================+ -| layerProtocol| LayerProtocol| 1 | RW | Preliminary | identifies | -| | | | | | the | -| | | | | OpenModelAttribute| protocol | -| | | | | | this VL | -| | | | | | gives | -| | | | | - isInvariant: | access to | -| | | | | false | (IPV4, IPV6). | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+--------------+--------------+-----------+-----------+-------------------+----------------+ -| flowPatternrn| String | 0..1 | RW | Preliminary | Identifies | -| | | | | | the flow | -| | | | | OpenModelAttribute| pattern | -| | | | | | of the | -| | | | | - isInvariant: | connectivity | -| | | | | false | (Line, | -| | | | | | Tree, | -| | | | | | Mesh). | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+--------------+--------------+-----------+-----------+-------------------+----------------+ - -MonitoredData(TBD) ------------------- - -The MonitoredData datatype identifies information to be monitored during -the lifetime of a network service instance. - -NsLifeCycleManagementScript ---------------------------- - -The LifeCycleManagementScript information element specifies a script for -the NS. - -+-------------+-----------+-----------+-----------+-------------------+----------------+ -| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| -| Name** | | | | | | -+=============+===========+===========+===========+===================+================+ -| event | String | 1..\* | RW | OpenModelAttribute| Describes NS | -| | | | | | lifecycle | -| | | | | - isInvarriant: | event(s) | -| | | | | false | or an | -| | | | | | external | -| | | | | | stimulus | -| | | | | | detected | -| | | | | | on an | -| | | | | - valueRange: | NFVO | -| | | | | no | reference | -| | | | | range | point. | -| | | | | constraint | NOTE 1: A | -| | | | | | minimum | -| | | | | | set of NS | -| | | | | | lifecycle | -| | | | | - support: | events | -| | | | | | triggered | -| | | | | MANDATORY | internally | -| | | | | | by the NFVO | -| | | | | | includes: | -| | | | | | start | -| | | | | | instantiation, | -| | | | | | end | -| | | | | | instantiation, | -| | | | | | start | -| | | | | | scaling, | -| | | | | | end | -| | | | | | scaling, | -| | | | | | start | -| | | | | | healing, | -| | | | | | end | -| | | | | | healing, | -| | | | | | start | -| | | | | | termination, | -| | | | | | end | -| | | | | | termination, | -| | | | | | start | -| | | | | | update, | -| | | | | | end | -| | | | | | update. | -| | | | | | NOTE 2: A | -| | | | | | minimum | -| | | | | | set of | -| | | | | | external | -| | | | | | stimulus | -| | | | | | includes: | -| | | | | | the | -| | | | | | receipt | -| | | | | | of | -| | | | | | request | -| | | | | | message | -| | | | | | of | -| | | | | | instantiation, | -| | | | | | scaling, | -| | | | | | healing, | -| | | | | | termination, | -| | | | | | update of NS. | -+-------------+-----------+-----------+-----------+-------------------+----------------+ -| script | String | 1 | RW | OpenModelAttribute| Includes | -| | | | | | an NS LCM | -| | | | | | script | -| | | | | - isInvarriant: | (e.g., | -| | | | | false | written | -| | | | | | in a DSL) | -| | | | | | triggered | -| | | | | | to react | -| | | | | - valueRange: | to one of the | -| | | | | no | events | -| | | | | range | listed in | -| | | | | constraint | the event | -| | | | | | attribute. | -| | | | | - support: | | -| | | | | MANDATORY | | -+-------------+-----------+-----------+-----------+-------------------+----------------+ - -NsQoS ------ - -The NsQoS datatype specifies quality of service parameters applicable to -a NS VL. - -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| -+=====================+===========+===========+===========+===================+================+ -| priority | Integer | 0..1 | RW | Preliminary | Specifies | -| | | | | | the | -| | | | | | priority | -| | | | | OpenModelAttribute| level in | -| | | | | | case of | -| | | | | | congestion | -| | | | | - isInvariant: | on the | -| | | | | false | underlying | -| | | | | | physical | -| | | | | - valueRange: | links. | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| latency | Number | 1 | RW | Preliminary | Maximum | -| | | | | | latency | -| | | | | | in ms. | -| | | | | OpenModelAttribute| | -| | | | | | | -| | | | | - isInvariant: | | -| | | | | false | | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| packetDelayVariation| Number | 1 | RW | Preliminary | Maximum | -| | | | | | jitter in | -| | | | | | ms. | -| | | | | OpenModelAttribute| | -| | | | | | | -| | | | | - isInvariant: | | -| | | | | false | | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| packetLossRatio | Number | 0..1 | RW | Preliminary | Maximum | -| | | | | | packet | -| | | | | | loss | -| | | | | OpenModelAttribute| ratio. | -| | | | | | Cardinality | -| | | | | - isInvariant: | is 0 if | -| | | | | false | no | -| | | | | | packetLossRatio| -| | | | | | requirement | -| | | | | - valueRange: | exists. | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ - -VirtualLinkDf -------------- - -The VirtualLinkDf datatype specifies properties for instantiating a VL -according to a specific flavour. - -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ -| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| -+=======================+==========================+===========+===========+===================+================+ -| flavourId | Identifier | 1 | RW | Preliminary | Identifies | -| | | | | | this | -| | | | | OpenModelAttribute| VirtualLinkDF | -| | | | | | datatype | -| | | | | - isInvariant: | within a | -| | | | | false | VLD. | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ -| qos | NsQoS | 0..1 | RW | Preliminary | Specifies | -| | | | | | quality | -| | | | | | of | -| | | | | OpenModelAttribute| service | -| | | | | | parameters | -| | | | | - isInvariant: | applicable | -| | | | | false | to a VL. | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ -| serviceAvaibilityLevel| ServiceAvailabilityLevel | 0..1 | RW | Preliminary | Specifies | -| | | | | | one of | -| | | | | | the three | -| | | | | OpenModelAttribute| levels | -| | | | | | defined | -| | | | | | in ETSI | -| | | | | - isInvariant: | GS NFV-REL | -| | | | | false | 001: | -| | | | | | | -| | | | | | - Level1 | -| | | | | | | -| | | | | - valueRange: | - Level2 | -| | | | | no | | -| | | | | range | - Level3 | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ - - - -ServiceAvailabilityLevel ------------------------- - -Specifies one of the three levels defined in ETSI GS NFV-REL 001: -Level 1 Level 2 Level 3 - -Contains Enumeration Literals: - -- LEVEL_1: - -- LEVEL_2: - -- LEVEL_3: - -.. |image0| image:: NSD1.PNG diff --git a/docs/ONAP Model Spec/im/NSD/NSD.png b/docs/ONAP Model Spec/im/NSD/NSD.png new file mode 100644 index 0000000..acd2c5d Binary files /dev/null and b/docs/ONAP Model Spec/im/NSD/NSD.png differ diff --git a/docs/ONAP Model Spec/im/NSD/NSD.rst b/docs/ONAP Model Spec/im/NSD/NSD.rst new file mode 100644 index 0000000..f8ce8df --- /dev/null +++ b/docs/ONAP Model Spec/im/NSD/NSD.rst @@ -0,0 +1,688 @@ +.. 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 + +NetworkServiceDescriptorModel +=============================== + +.. contents:: + :depth: 3 +.. + +Diagram +------- + +.. image:: NSD.png + +NetworkServiceDescriptor +------------------------ + +The NSD class is a deployment template whose instances are used by the +NFVO for the lifecycle management of NSs. For all attributes in this +class, the Producer is SDC and the Consumer is SDC/UUI/VFC + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminaryry + ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| **AttributeName** | **Type** | **Mult.** | **Stereotypes** | **Description**| +| | | | | | ++==========================+============================+=============+===================+================+ +| nsdIdentifier | Identifier | 1 | Preliminary | Identifier | +| | | | | of this NSD | +| | | | OpenModelAttribute| class. It | +| | | | | globally | +| | | | | uniquely | +| | | | - isInvariant: | identifies | +| | | | true | an instance | +| | | | | of the NSD. | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| designer | String | 1 | Preliminary | Identifies | +| | | | | the | +| | | | OpenModelAttribute| designer of | +| | | | | the NSD. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| version | Version | 1 | Preliminary | Identifies | +| | | | | the version | +| | | | OpenModelAttribute| of the NSD. | +| | | | | | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| nsdName | String | 1 | Preliminary | Provides | +| | | | | the human | +| | | | OpenModelAttribute| readable | +| | | | | name of the | +| | | | | NSD. | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| nsdInvariantId | Identifier | 1 | Preliminary | Identifies | +| | | | | an NSD in a | +| | | | OpenModelAttribute| version | +| | | | | independent | +| | | | | manner. | +| | | | - isInvariant: | This | +| | | | false | attribute is | +| | | | | invariant | +| | | | - valueRange: | across | +| | | | no | versions of | +| | | | range | NSD. | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| autoScalingRule | Rule | 0..\* | Preliminary | Specifies a | +| | | | | rule to | +| | | | OpenModelAttribute| trigger a | +| | | | | scaling | +| | | | | action on a | +| | | | - isInvariant: | NS | +| | | | false | instantiated | +| | | | | according | +| | | | - valueRange: | to the NSD. | +| | | | no | NOTE 1: The | +| | | | range | rule is | +| | | | constraint | based on a | +| | | | | combination | +| | | | | of | +| | | | | assertions | +| | | | - support: | on the | +| | | | MANDATORY | values of | +| | | | | virtualised | +| | | | | resource- | +| | | | | related | +| | | | | performance | +| | | | | metrics and | +| | | | | VNF | +| | | | | Indicators | +| | | | | identified | +| | | | | by the | +| | | | | monitoredInfo | +| | | | | attribute. | +| | | | | NOTE 2: | +| | | | | There may | +| | | | | be multiple | +| | | | | data | +| | | | | sources | +| | | | | (each | +| | | | | identified | +| | | | | as | +| | | | | monitoredInfo) | +| | | | | per rule | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| monitoredInfo | MonitoredData | 0..\* | Preliminary | Identifies | +| | | | | either a | +| | | | OpenModelAttribute| virtualised | +| | | | | resource- | +| | | | | related | +| | | | - isInvariant: | performance | +| | | | false | metric or a | +| | | | | VNF | +| | | | | Indicator. | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| lifeCycleManagementScript| NsLifeCycleManagementScript| 0..\* | Preliminary | Provides a | +| | | | | life cycle | +| | | | OpenModelAttribute| management | +| | | | | script | +| | | | | written in | +| | | | - isInvariant: | a Domain | +| | | | false | Specific | +| | | | | Language | +| | | | - valueRange: | (DSL). | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| \_virtualLinkDesc | NsVirtualLinkDesc | 0..\* | Preliminary | Provides | +| | | | | the | +| | | | OpenModelAttribute| constituent | +| | | | | VLDs. | +| | | | | Cardinality | +| | | | - isInvariant: | of 0 means | +| | | | false | that the NS | +| | | | | is a NF set | +| | | | | with | +| | | | - valueRange: | unspecified | +| | | | no | connectivity. | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| \_vnfdId | Vnfd | 0..\* | Preliminary | References | +| | | | | the VNFD of | +| | | | OpenModelAttribute| a | +| | | | | constituent | +| | | | | VNF. | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | +| | | | | | +| | | | PassedByReference | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| \_pnfdId | Pnfd | 0..\* | Experimental | References | +| | | | | the PNFD of | +| | | | | a | +| | | | OpenModelAttribute| constituent | +| | | | | PNF. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | +| | | | | | +| | | | PassedByReference | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ + +NsVirtualLinkDesc +----------------- + +The NsVirtualLinkDesc class provides general information enabling the +instantiation of virtual links. For all attributes in this class the +Producer is SDC and the Consumer is SDC/UUI/VFC. + +**Parent class:** VirtualLinkDesc + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminaryry + ++------------------------+-----------------+-------------+-------------------+----------------+ +| **Attribute Name** | **Type** | **Mult.** | **Stereotypes** | **Description**| ++========================+=================+=============+===================+================+ +| vitualLinkDescProvider | String | 0..1 | Preliminary | Defines the | +| | | | | organization | +| | | | OpenModelAttribute| generating | +| | | | | the VLD. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| virtuaLinkDescVersion | Version | 1 | Preliminary | Specifies | +| | | | | the version | +| | | | OpenModelAttribute| of the VLD. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| VirtualLinkDf | VirtualLinkDf | 1 | Preliminary | Specifies | +| | | | | properties | +| | | | OpenModelAttribute| for | +| | | | | instantiating | +| | | | - isInvariant: | a VL | +| | | | false | according | +| | | | | to a | +| | | | | specific | +| | | | - valueRange: | flavour. | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| virtualLinkDescId | Identifier | 1 | Preliminary | Uniquely | +| | | | | identifies | +| | | | OpenModelAttribute| a VLD in | +| | | | | the parent | +| | | | | descriptor. | +| | | | - isInvariant: | For | +| | | | false | VnfVirtualL | +| | | | | inkDesc, | +| | | | | the parent | +| | | | | descriptor | +| | | | - valueRange: | is the | +| | | | no | VNFD. For | +| | | | range | NsVirtualLi- | +| | | | constraint | nkDesc, | +| | | | | the parent | +| | | | | descriptor | +| | | | - support: | is the NSD. | +| | | | MANDATORY | Note: the | +| | | | | description | +| | | | | of this | +| | | | | class are | +| | | | | different | +| | | | | in ETSI GS | +| | | | | NFV IFA 011 | +| | | | | and ETSI GS | +| | | | | NFV IFA | +| | | | | 014. The | +| | | | | present | +| | | | | definition | +| | | | | merges the 2 | +| | | | | definitions. | ++------------------------+-----------------+-------------+-------------------+----------------+ +| connectivityType | ConnectivityType| 1 | Preliminary | Specifies | +| | | | | the | +| | | | OpenModelAttribute| protocol | +| | | | | exposed by | +| | | | | a VL and | +| | | | - isInvariant: | the flow | +| | | | false | pattern | +| | | | | supported | +| | | | | by the VL. | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| description | String | 0..1 | Preliminary | Provides | +| | | | | human-readable | +| | | | OpenModelAttribute| information | +| | | | | on the | +| | | | - isInvariant: | purpose of | +| | | | false | the VL | +| | | | | (e.g. | +| | | | | control | +| | | | - valueRange: | plane | +| | | | no | traffic). | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ + +Pnfd +---- + +The Pnfd class is a deployment template enabling on-boarding PNFs and +referencing them from an NSD. It focuses on connectivity aspects only. + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Experimental + + + +Vnfd +---- + +The Vnfd class is a deployment template enabling on-boarding VNFs and +referencing them from an NSD. + + +ConnectivityType +---------------- + +The ConnectivityType datatype specifies the protocol exposed by a VL and +the flow pattern supported by the VL. + ++--------------+--------------+-----------+-----------+-------------------+----------------+ +| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| +| Name** | | | | | | ++==============+==============+===========+===========+===================+================+ +| layerProtocol| LayerProtocol| 1 | RW | Preliminary | identifies | +| | | | | | the | +| | | | | OpenModelAttribute| protocol | +| | | | | | this VL | +| | | | | | gives | +| | | | | - isInvariant: | access to | +| | | | | false | (IPV4, IPV6). | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++--------------+--------------+-----------+-----------+-------------------+----------------+ +| flowPatternrn| String | 0..1 | RW | Preliminary | Identifies | +| | | | | | the flow | +| | | | | OpenModelAttribute| pattern | +| | | | | | of the | +| | | | | - isInvariant: | connectivity | +| | | | | false | (Line, | +| | | | | | Tree, | +| | | | | | Mesh). | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++--------------+--------------+-----------+-----------+-------------------+----------------+ + +MonitoredData(TBD) +------------------ + +The MonitoredData datatype identifies information to be monitored during +the lifetime of a network service instance. + +NsLifeCycleManagementScript +--------------------------- + +The LifeCycleManagementScript information element specifies a script for +the NS. + ++-------------+-----------+-----------+-----------+-------------------+----------------+ +| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| +| Name** | | | | | | ++=============+===========+===========+===========+===================+================+ +| event | String | 1..\* | RW | OpenModelAttribute| Describes NS | +| | | | | | lifecycle | +| | | | | - isInvarriant: | event(s) | +| | | | | false | or an | +| | | | | | external | +| | | | | | stimulus | +| | | | | | detected | +| | | | | | on an | +| | | | | - valueRange: | NFVO | +| | | | | no | reference | +| | | | | range | point. | +| | | | | constraint | NOTE 1: A | +| | | | | | minimum | +| | | | | | set of NS | +| | | | | | lifecycle | +| | | | | - support: | events | +| | | | | | triggered | +| | | | | MANDATORY | internally | +| | | | | | by the NFVO | +| | | | | | includes: | +| | | | | | start | +| | | | | | instantiation, | +| | | | | | end | +| | | | | | instantiation, | +| | | | | | start | +| | | | | | scaling, | +| | | | | | end | +| | | | | | scaling, | +| | | | | | start | +| | | | | | healing, | +| | | | | | end | +| | | | | | healing, | +| | | | | | start | +| | | | | | termination, | +| | | | | | end | +| | | | | | termination, | +| | | | | | start | +| | | | | | update, | +| | | | | | end | +| | | | | | update. | +| | | | | | NOTE 2: A | +| | | | | | minimum | +| | | | | | set of | +| | | | | | external | +| | | | | | stimulus | +| | | | | | includes: | +| | | | | | the | +| | | | | | receipt | +| | | | | | of | +| | | | | | request | +| | | | | | message | +| | | | | | of | +| | | | | | instantiation, | +| | | | | | scaling, | +| | | | | | healing, | +| | | | | | termination, | +| | | | | | update of NS. | ++-------------+-----------+-----------+-----------+-------------------+----------------+ +| script | String | 1 | RW | OpenModelAttribute| Includes | +| | | | | | an NS LCM | +| | | | | | script | +| | | | | - isInvarriant: | (e.g., | +| | | | | false | written | +| | | | | | in a DSL) | +| | | | | | triggered | +| | | | | | to react | +| | | | | - valueRange: | to one of the | +| | | | | no | events | +| | | | | range | listed in | +| | | | | constraint | the event | +| | | | | | attribute. | +| | | | | - support: | | +| | | | | MANDATORY | | ++-------------+-----------+-----------+-----------+-------------------+----------------+ + +NsQoS +----- + +The NsQoS datatype specifies quality of service parameters applicable to +a NS VL. + ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| ++=====================+===========+===========+===========+===================+================+ +| priority | Integer | 0..1 | RW | Preliminary | Specifies | +| | | | | | the | +| | | | | | priority | +| | | | | OpenModelAttribute| level in | +| | | | | | case of | +| | | | | | congestion | +| | | | | - isInvariant: | on the | +| | | | | false | underlying | +| | | | | | physical | +| | | | | - valueRange: | links. | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| latency | Number | 1 | RW | Preliminary | Maximum | +| | | | | | latency | +| | | | | | in ms. | +| | | | | OpenModelAttribute| | +| | | | | | | +| | | | | - isInvariant: | | +| | | | | false | | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| packetDelayVariation| Number | 1 | RW | Preliminary | Maximum | +| | | | | | jitter in | +| | | | | | ms. | +| | | | | OpenModelAttribute| | +| | | | | | | +| | | | | - isInvariant: | | +| | | | | false | | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| packetLossRatio | Number | 0..1 | RW | Preliminary | Maximum | +| | | | | | packet | +| | | | | | loss | +| | | | | OpenModelAttribute| ratio. | +| | | | | | Cardinality | +| | | | | - isInvariant: | is 0 if | +| | | | | false | no | +| | | | | | packetLossRatio| +| | | | | | requirement | +| | | | | - valueRange: | exists. | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ + +VirtualLinkDf +------------- + +The VirtualLinkDf datatype specifies properties for instantiating a VL +according to a specific flavour. + ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ +| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| ++=======================+==========================+===========+===========+===================+================+ +| flavourId | Identifier | 1 | RW | Preliminary | Identifies | +| | | | | | this | +| | | | | OpenModelAttribute| VirtualLinkDF | +| | | | | | datatype | +| | | | | - isInvariant: | within a | +| | | | | false | VLD. | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ +| qos | NsQoS | 0..1 | RW | Preliminary | Specifies | +| | | | | | quality | +| | | | | | of | +| | | | | OpenModelAttribute| service | +| | | | | | parameters | +| | | | | - isInvariant: | applicable | +| | | | | false | to a VL. | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ +| serviceAvaibilityLevel| ServiceAvailabilityLevel | 0..1 | RW | Preliminary | Specifies | +| | | | | | one of | +| | | | | | the three | +| | | | | OpenModelAttribute| levels | +| | | | | | defined | +| | | | | | in ETSI | +| | | | | - isInvariant: | GS NFV-REL | +| | | | | false | 001: | +| | | | | | | +| | | | | | - Level1 | +| | | | | | | +| | | | | - valueRange: | - Level2 | +| | | | | no | | +| | | | | range | - Level3 | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ + + + +ServiceAvailabilityLevel +------------------------ + +Specifies one of the three levels defined in ETSI GS NFV-REL 001: +Level 1 Level 2 Level 3 + +Contains Enumeration Literals: + +- LEVEL_1: + +- LEVEL_2: + +- LEVEL_3: + +.. |image0| image:: NSD1.PNG diff --git a/docs/ONAP Model Spec/im/NSDR4.PNG b/docs/ONAP Model Spec/im/NSDR4.PNG deleted file mode 100644 index acd2c5d..0000000 Binary files a/docs/ONAP Model Spec/im/NSDR4.PNG and /dev/null differ diff --git a/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG b/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG deleted file mode 100644 index 1c58c42..0000000 Binary files a/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG and /dev/null differ diff --git a/docs/ONAP Model Spec/im/PNF/PNFD.rst b/docs/ONAP Model Spec/im/PNF/PNFD.rst new file mode 100644 index 0000000..76eb837 --- /dev/null +++ b/docs/ONAP Model Spec/im/PNF/PNFD.rst @@ -0,0 +1,388 @@ +.. Copyright 2019 +.. 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 + +PnfdModel +~~~~~~~~~ + +Classes +------- + +Pnf +~~~ + +An implementation of a NF via a tightly coupled software and hardware system. + +**Parent class:** NetworkFunction + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== ============================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== ============================================ +\_pnfExtCp PnfExtCp 1..\* OpenModelAttribute External CP of the PNF. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id String 1 Experimental Identifier of the network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 0..1 Experimental + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +type String 1 Experimental Description of the type of network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Experimental Description of the network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +role String 1 Experimental Role the network function will be providing. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================================ + +PnfExtCp +~~~~~~~~ + +External CP of the PNF. + +**Parent class:** Cp + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +================== ============= ========= ================================== ======================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ============= ========= ================================== ======================================================================================================================================================================== +cpd invalid 1 OpenModelAttribute Cpd used to deploy this PNF CP. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpId Identifier 1 OpenModelAttribute Identifier of the connection point instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpName String 1 OpenModelAttribute Name of the Cp instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpNameAlt String 1 OpenModelAttribute alternative name of the Cp instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpType String 1 OpenModelAttribute Generic description of the type of Cp + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpRole String 1 OpenModelAttribute Role in the network this Cp will be providing + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpFunction String 1 OpenModelAttribute English description of the function this specific Cp will be providing + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpDescription String 1 OpenModelAttribute Cp description + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpBandwidth String 1 OpenModelAttribute Cp assigned (actual) bandwidth + + - isInvariant: false Cp (max? assigned?) bandwidth + + - valueRange: no range constraint + + - support: MANDATORY +provStatus String 1 OpenModelAttribute provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +adminsStatus String 1 OpenModelAttribute Administrative status of the connection point. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +protocol String 1 OpenModelAttribute Protocol used by the Cp + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +trunkMode Boolean 1 OpenModelAttribute Indicator whether the Cp is in trunk mode + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +addressType String 1 OpenModelAttribute Type of address: MAC address or IP address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +L2addressData L2AddressData 0..1 OpenModelAttribute Only present when addressType is MAC address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +L3addressData L3AddressData 0..1 OpenModelAttribute Only present when addressType is IP address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============= ========= ================================== ======================================================================================================================================================================== + +PnfExtCpd +~~~~~~~~~ + +A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. + +**Parent class:** ExtCpd + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +PnfProfile +~~~~~~~~~~ + +The PnfProfile class describes additional data for a given PNF instance used in a DF. + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +========================== ========================= ========= ================================== ======================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +========================== ========================= ========= ================================== ======================================================================================================================================== +pnfProfileId Identifier 1 OpenModelAttribute Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +pnfVirtualLinkConnectivity NsVirtualLinkConnectivity 1..\* OpenModelAttribute Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== ========================= ========= ================================== ======================================================================================================================================== + +Pnfd +~~~~ + +The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ================== ========= ================================== ==================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +=================== ================== ========= ================================== ==================================================================================================================== +pnfdId Identifier 1 OpenModelAttribute Identifier of this Pnfd class. It uniquely identifies the PNFD. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +provider String 1 OpenModelAttribute Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version Version 1 OpenModelAttribute Identifies the version of the PNFD + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +security SecurityParameters 0..1 OpenModelAttribute Provides a signature to prevent tampering. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +functionDescription String 1 OpenModelAttribute Describes the PNF function. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +pnfdInvariantId Identifier 1 OpenModelAttribute Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. + + - isInvariant: true + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute Provides the human readable name of the PNFD. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +\_pnfExtCpd PnfExtCpd 1..\* OpenModelAttribute Specifies the characteristics of one or more connection points where to connect the PNF to a VL. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================== ========= ================================== ==================================================================================================================== + +Data Types +---------- + +SwVersion +~~~~~~~~~ + +The software versions associated with the pnfd + +Applied stereotypes: + +- Future + +================== ======== ========= ========== ================================== ===================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +================== ======== ========= ========== ================================== ===================== +active String 1 RW OpenModelAttribute The active software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +passive String 0..\* RW OpenModelAttribute The passive software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +recovery String 0..\* RW OpenModelAttribute The recovery software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========== ================================== ===================== \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/PNFD.rst b/docs/ONAP Model Spec/im/PNFD.rst deleted file mode 100644 index 1da1ce9..0000000 --- a/docs/ONAP Model Spec/im/PNFD.rst +++ /dev/null @@ -1,384 +0,0 @@ -PnfdModel -~~~~~~~~~ - -Classes -------- - -Pnf -~~~ - -An implementation of a NF via a tightly coupled software and hardware system. - -**Parent class:** NetworkFunction - -Applied stereotypes: - -- Future - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== ============================================ -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== ============================================ -\_pnfExtCp PnfExtCp 1..\* OpenModelAttribute External CP of the PNF. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -id String 1 Experimental Identifier of the network function - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 0..1 Experimental - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -type String 1 Experimental Description of the type of network function - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 0..1 Experimental Description of the network function - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -role String 1 Experimental Role the network function will be providing. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== ============================================ - -PnfExtCp -~~~~~~~~ - -External CP of the PNF. - -**Parent class:** Cp - -Applied stereotypes: - -- Future - -- OpenModelClass - -- **support: MANDATORY** - -================== ============= ========= ================================== ======================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ============= ========= ================================== ======================================================================================================================================================================== -cpd invalid 1 OpenModelAttribute Cpd used to deploy this PNF CP. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpId Identifier 1 OpenModelAttribute Identifier of the connection point instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpName String 1 OpenModelAttribute Name of the Cp instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpNameAlt String 1 OpenModelAttribute alternative name of the Cp instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpType String 1 OpenModelAttribute Generic description of the type of Cp - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpRole String 1 OpenModelAttribute Role in the network this Cp will be providing - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpFunction String 1 OpenModelAttribute English description of the function this specific Cp will be providing - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpDescription String 1 OpenModelAttribute Cp description - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpBandwidth String 1 OpenModelAttribute Cp assigned (actual) bandwidth - - - isInvariant: false Cp (max? assigned?) bandwidth - - - valueRange: no range constraint - - - support: MANDATORY -provStatus String 1 OpenModelAttribute provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -adminsStatus String 1 OpenModelAttribute Administrative status of the connection point. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -protocol String 1 OpenModelAttribute Protocol used by the Cp - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -trunkMode Boolean 1 OpenModelAttribute Indicator whether the Cp is in trunk mode - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -addressType String 1 OpenModelAttribute Type of address: MAC address or IP address - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -L2addressData L2AddressData 0..1 OpenModelAttribute Only present when addressType is MAC address - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -L3addressData L3AddressData 0..1 OpenModelAttribute Only present when addressType is IP address - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ============= ========= ================================== ======================================================================================================================================================================== - -PnfExtCpd -~~~~~~~~~ - -A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. - -**Parent class:** ExtCpd - -Applied stereotypes: - -- OpenModelClass - -- **support: MANDATORY** - -- Preliminary - -PnfProfile -~~~~~~~~~~ - -The PnfProfile class describes additional data for a given PNF instance used in a DF. - -Applied stereotypes: - -- Future - -- OpenModelClass - -- **support: MANDATORY** - -========================== ========================= ========= ================================== ======================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -========================== ========================= ========= ================================== ======================================================================================================================================== -pnfProfileId Identifier 1 OpenModelAttribute Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -pnfVirtualLinkConnectivity NsVirtualLinkConnectivity 1..\* OpenModelAttribute Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -========================== ========================= ========= ================================== ======================================================================================================================================== - -Pnfd -~~~~ - -The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. - -**Parent class:** NetworkFunctionDesc - -Applied stereotypes: - -- OpenModelClass - -- **support: MANDATORY** - -- Preliminary - -=================== ================== ========= ================================== ==================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ================== ========= ================================== ==================================================================================================================== -pnfdId Identifier 1 OpenModelAttribute Identifier of this Pnfd class. It uniquely identifies the PNFD. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -provider String 1 OpenModelAttribute Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -version Version 1 OpenModelAttribute Identifies the version of the PNFD - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -security SecurityParameters 0..1 OpenModelAttribute Provides a signature to prevent tampering. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -functionDescription String 1 OpenModelAttribute Describes the PNF function. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -pnfdInvariantId Identifier 1 OpenModelAttribute Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. - - - isInvariant: true - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute Provides the human readable name of the PNFD. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -\_pnfExtCpd PnfExtCpd 1..\* OpenModelAttribute Specifies the characteristics of one or more connection points where to connect the PNF to a VL. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ================== ========= ================================== ==================================================================================================================== - -Data Types ----------- - -SwVersion -~~~~~~~~~ - -The software versions associated with the pnfd - -Applied stereotypes: - -- Future - -================== ======== ========= ========== ================================== ===================== -**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** -================== ======== ========= ========== ================================== ===================== -active String 1 RW OpenModelAttribute The active software - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -passive String 0..\* RW OpenModelAttribute The passive software - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -recovery String 0..\* RW OpenModelAttribute The recovery software - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ========== ================================== ===================== \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/Root.rst b/docs/ONAP Model Spec/im/Root.rst deleted file mode 100644 index ddda941..0000000 --- a/docs/ONAP Model Spec/im/Root.rst +++ /dev/null @@ -1,751 +0,0 @@ -.. Copyright 2019 -.. 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 - -Root Model -========== - -.. contents:: - :depth: 3 -.. - -Overview --------- - -**Qualified Name:** Common::Root - -**Description:** - -A set of common business entities that collectively serve as the foundation of the ONAP Information Model. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence. - -Class Definition ----------------- - -DesignEntity class -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootObjectClasses::DesignEntity - -**Description:** - -A template which describes an OperationalEntity in terms of deployment and operational behavior requirements. - -This class is abstract. - -**Parent class:** Entity - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -**Table** **Attributes for class DesignEntity** - -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -validFor TimePeriod 1 The period during which the design entity is valid. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -status String 1 The condition of the specification, such s active, inactive, or planned. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -name String 1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute - - Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== - -Domain class -^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootObjectClasses::Domain - -**Description:** - -Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain - -**Parent class:** RootEntity - -**Applied Stereotypes:** - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -Entity class -^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootObjectClasses::Entity - -**Description:** - -This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment. - -This class is abstract. - -**Parent class:** RootEntity - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -ManagedEntity class -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootObjectClasses::ManagedEntity - -**Description:** - -A ManagedEntity is used to specify that an Entity is manageable by electronic means. - -**Applied Stereotypes:** - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -**Table** **Attributes for class ManagedEntity** - -========================= ======== ========= ================================================================================================================= ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -========================= ======== ========= ================================================================================================================= ===================== -managementMethodCurrent Integer 1 This is an enumerated integer that defines the particular type of management method that is currently being used. OpenModelAttribute - Permitted Values: - 0: Unknown - partOfObjectKey: 0 - 1: None - 2: CLI - uniqueSet: - 3: SNMP - 4: TL1 - isInvariant: false - 5: CMIP - 6: Proprietary - unsigned: false - - - counter: NA - - - support: MANDATORY -managementMethodSupported Integer 1..\* This is an array of integers that define the different management methods that are supported by this object. OpenModelAttribute - Permitted Values: - 0: Unknown - partOfObjectKey: 0 - 1: None - 2: CLI - uniqueSet: - 3: SNMP - 4: TL1 - isInvariant: false - 5: CMIP - 6: Proprietary - unsigned: false - - - counter: NA - - - support: MANDATORY -========================= ======== ========= ================================================================================================================= ===================== - -OperationalEntity class -^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootObjectClasses::OperationalEntity - -**Description:** - -An OperationalEntity is a deployment in a NFV environment of a DesignEntity. - -This class is abstract. - -**Parent class:** Entity - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -RootEntity class -^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootObjectClasses::RootEntity - -**Description:** - -This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment. - -This class is abstract. - -**Applied Stereotypes:** - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -**Table** **Attributes for class RootEntity** - -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== -name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute - - - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute - - Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 - - - uniqueSet: - - - isInvariant: false - - - unsigned: false - - - counter: NA - - - support: MANDATORY - - Preliminary -================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== - -Enumeration definition ----------------------- - -CompositeOperator enumeration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootTypeDefinitons::CompositeOperator - -**Description:** - -The operator being applied to to some group of selectoin critiera. - -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** - -- AND - -- OR - -- XOR - -Operator enumeration -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootTypeDefinitons::Operator - -**Description:** - -The operator being applied to some atomic selection critera. - -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** - -- MORETHAN - -- LESSTHAN - -- EQUAL - -Priority enumeration -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Priority - -**Description:** - -priority - processing priority. - -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** - -- HIGH - -- MEDIUM - -- NORMAL - -- LOW - -RuleScope enumeration -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::RuleScope - -**Description:** - -Defines the scope of the rule. - -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** - -- NFVI_POP - -- ZONE - -- ZONE_GROUP - -- NFVI_NODE - -RuleType enumeration -^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::RuleType - -**Description:** - -Specifies the type of rule. - -**Applied Stereotypes:** - -- Preliminary - -**Contains Enumeration Literals:** - -- AFFINITY - -- ANTI_AFFINITY - -Datatype definition -------------------- - -ConfigurableProperties datatype -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::Root::RootTypeDefinitons:: ConfigurableProperties - -**Description:** - -Dynamic, configurable properites of some entity. - -**Applied Stereotypes:** - -- Experimental - -**Table** **Attributes for Data Type ConfigurableProperties** - -================== ============ ========= ==================================================== ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ============ ========= ==================================================== ================================== -properties KeyValuePair 0..\* The specific configurable properties of some entity. Experimental - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ============ ========= ==================================================== ================================== - -DateTime primitive type -^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::DateTime - -**Description:** - -DateTime - RFC 2822 standard date/time format. - -RFC 2822 format - -day-of-week, dd MM yyyy HH':'mm':'ss 'GMT' - -e.g. Tue, 21 Jun 2016 14:05:20 GMT - -File primitive type -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::File - -**Description:** - -A primitive Type - -**Applied Stereotypes:** - -- Experimental - -Identifier datatype -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Identifier - -**Applied Stereotypes:** - -- Preliminary - -Key datatype -^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Key - -**Description:** - -key - the key datatype is a tuple which provides the name of a key along with its value and relative order. - -**Applied Stereotypes:** - -- Preliminary - -**Table** **Attributes for Data Type Key** - -================== ======== ========= ============================================================================== ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ============================================================================== ================================== -keyName String 1 keyName - Name of the key. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -keyOrder Integer 0..1 keyOrder - Relative sequence or order of the key (with respect to other keys). OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -keyValue String 0..1 keyValue - Value of the key. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ============================================================================== ================================== - -KeyValuePair datatype -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::KeyValuePair - -**Applied Stereotypes:** - -- Preliminary - -**Table** **Attributes for Data Type KeyValuePair** - -================== ======== ========= =============== ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= =============== ================================== -key String 1 OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -value String 1 OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= =============== ================================== - -Number primitive type -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Number - -**Description:** - -This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real. - -**Applied Stereotypes:** - -- Preliminary - -Object primitive type -^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Object - -**Description:** - -object - objects are model elements that represent instances of a class or of classes - -**Applied Stereotypes:** - -- Preliminary - -Rule primitive type -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Rule - -**Description:** - -Primitive type describing a rule. - -**Applied Stereotypes:** - -- Preliminary - -SecurityParameters datatype -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::SecurityParameters - -**Description:** - -The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature. - -**Applied Stereotypes:** - -- Preliminary - -**Table** **Attributes for Data Type SecurityParameters** - -================== ======== ========= ========================================================================================================= ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ========================================================================================================= ================================== -signature String 1 Provides the signature of the signed part of the descriptor. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -algorithm String 1 Identifies the algorithm used to compute the signature. OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -certificate 0..1 Provides a certificate or a reference to a certificate to validate the signature. OpenModelAttribute - NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ========================================================================================================= ================================== - -TimePeriod datatype -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::TimePeriod - -**Description:** - -A base / value business entity used to represent a period of time, between two timepoints - -**Applied Stereotypes:** - -- Preliminary - -**Table** **Attributes for Data Type TimePeriod** - -================== ======== ========= ================================================= ================================== -**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** -================== ======== ========= ================================================= ================================== -startDateTime DateTime 1 An instant of time, starting at the TimePeriod OpenModelAttribute - Notes: - If null, then represents to the beginning of time - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -endDateTime DateTime 1 An instant of time, ending at the TimePeriod: OpenModelAttribute - Notes: - If null, then represents to the end of time - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================================= ================================== - -UnixEpoch primitive type -^^^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::UnixEpoch - -**Description:** - -the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds - -Uri primitive type -^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Uri - -**Description:** - -type string; - -The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66. - -Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1. - -The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent. - -Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate. - -A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required. - -In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017. - -reference - -RFC 3986: Uniform Resource Identifier (URI): Generic Syntax - -RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations - -RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs); - -**Applied Stereotypes:** - -- Preliminary - -Uuid primitive type -^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Uuid - -**Description:** - -type string { - -pattern - -'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; } - -A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. - -The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6; - -reference - -RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace; - -**Applied Stereotypes:** - -- Preliminary - -Version primitive type -^^^^^^^^^^^^^^^^^^^^^^ - -**Qualified Name:** Common::TypeDefinitions::Version - -**Description:** - -This primitive type defines the version of an element. - -**Applied Stereotypes:** - -- Preliminary \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/Root/Root.png b/docs/ONAP Model Spec/im/Root/Root.png new file mode 100644 index 0000000..171c715 Binary files /dev/null and b/docs/ONAP Model Spec/im/Root/Root.png differ diff --git a/docs/ONAP Model Spec/im/Root/Root.rst b/docs/ONAP Model Spec/im/Root/Root.rst new file mode 100644 index 0000000..ddda941 --- /dev/null +++ b/docs/ONAP Model Spec/im/Root/Root.rst @@ -0,0 +1,751 @@ +.. Copyright 2019 +.. 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 + +Root Model +========== + +.. contents:: + :depth: 3 +.. + +Overview +-------- + +**Qualified Name:** Common::Root + +**Description:** + +A set of common business entities that collectively serve as the foundation of the ONAP Information Model. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence. + +Class Definition +---------------- + +DesignEntity class +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::DesignEntity + +**Description:** + +A template which describes an OperationalEntity in terms of deployment and operational behavior requirements. + +This class is abstract. + +**Parent class:** Entity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**Table** **Attributes for class DesignEntity** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +validFor TimePeriod 1 The period during which the design entity is valid. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +status String 1 The condition of the specification, such s active, inactive, or planned. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +name String 1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +Domain class +^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::Domain + +**Description:** + +Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +Entity class +^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::Entity + +**Description:** + +This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment. + +This class is abstract. + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +ManagedEntity class +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::ManagedEntity + +**Description:** + +A ManagedEntity is used to specify that an Entity is manageable by electronic means. + +**Applied Stereotypes:** + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +**Table** **Attributes for class ManagedEntity** + +========================= ======== ========= ================================================================================================================= ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +========================= ======== ========= ================================================================================================================= ===================== +managementMethodCurrent Integer 1 This is an enumerated integer that defines the particular type of management method that is currently being used. OpenModelAttribute + Permitted Values: + 0: Unknown - partOfObjectKey: 0 + 1: None + 2: CLI - uniqueSet: + 3: SNMP + 4: TL1 - isInvariant: false + 5: CMIP + 6: Proprietary - unsigned: false + + - counter: NA + + - support: MANDATORY +managementMethodSupported Integer 1..\* This is an array of integers that define the different management methods that are supported by this object. OpenModelAttribute + Permitted Values: + 0: Unknown - partOfObjectKey: 0 + 1: None + 2: CLI - uniqueSet: + 3: SNMP + 4: TL1 - isInvariant: false + 5: CMIP + 6: Proprietary - unsigned: false + + - counter: NA + + - support: MANDATORY +========================= ======== ========= ================================================================================================================= ===================== + +OperationalEntity class +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::OperationalEntity + +**Description:** + +An OperationalEntity is a deployment in a NFV environment of a DesignEntity. + +This class is abstract. + +**Parent class:** Entity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +RootEntity class +^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::RootEntity + +**Description:** + +This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment. + +This class is abstract. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**Table** **Attributes for class RootEntity** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +name String 0..1 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +Enumeration definition +---------------------- + +CompositeOperator enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootTypeDefinitons::CompositeOperator + +**Description:** + +The operator being applied to to some group of selectoin critiera. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- AND + +- OR + +- XOR + +Operator enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootTypeDefinitons::Operator + +**Description:** + +The operator being applied to some atomic selection critera. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- MORETHAN + +- LESSTHAN + +- EQUAL + +Priority enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Priority + +**Description:** + +priority - processing priority. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- HIGH + +- MEDIUM + +- NORMAL + +- LOW + +RuleScope enumeration +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::RuleScope + +**Description:** + +Defines the scope of the rule. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- NFVI_POP + +- ZONE + +- ZONE_GROUP + +- NFVI_NODE + +RuleType enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::RuleType + +**Description:** + +Specifies the type of rule. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- AFFINITY + +- ANTI_AFFINITY + +Datatype definition +------------------- + +ConfigurableProperties datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootTypeDefinitons:: ConfigurableProperties + +**Description:** + +Dynamic, configurable properites of some entity. + +**Applied Stereotypes:** + +- Experimental + +**Table** **Attributes for Data Type ConfigurableProperties** + +================== ============ ========= ==================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ============ ========= ==================================================== ================================== +properties KeyValuePair 0..\* The specific configurable properties of some entity. Experimental + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============ ========= ==================================================== ================================== + +DateTime primitive type +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::DateTime + +**Description:** + +DateTime - RFC 2822 standard date/time format. + +RFC 2822 format + +day-of-week, dd MM yyyy HH':'mm':'ss 'GMT' + +e.g. Tue, 21 Jun 2016 14:05:20 GMT + +File primitive type +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::File + +**Description:** + +A primitive Type + +**Applied Stereotypes:** + +- Experimental + +Identifier datatype +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Identifier + +**Applied Stereotypes:** + +- Preliminary + +Key datatype +^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Key + +**Description:** + +key - the key datatype is a tuple which provides the name of a key along with its value and relative order. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type Key** + +================== ======== ========= ============================================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ============================================================================== ================================== +keyName String 1 keyName - Name of the key. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +keyOrder Integer 0..1 keyOrder - Relative sequence or order of the key (with respect to other keys). OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +keyValue String 0..1 keyValue - Value of the key. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ============================================================================== ================================== + +KeyValuePair datatype +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::KeyValuePair + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type KeyValuePair** + +================== ======== ========= =============== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= =============== ================================== +key String 1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= =============== ================================== + +Number primitive type +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Number + +**Description:** + +This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real. + +**Applied Stereotypes:** + +- Preliminary + +Object primitive type +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Object + +**Description:** + +object - objects are model elements that represent instances of a class or of classes + +**Applied Stereotypes:** + +- Preliminary + +Rule primitive type +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Rule + +**Description:** + +Primitive type describing a rule. + +**Applied Stereotypes:** + +- Preliminary + +SecurityParameters datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::SecurityParameters + +**Description:** + +The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type SecurityParameters** + +================== ======== ========= ========================================================================================================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ========================================================================================================= ================================== +signature String 1 Provides the signature of the signed part of the descriptor. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +algorithm String 1 Identifies the algorithm used to compute the signature. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +certificate 0..1 Provides a certificate or a reference to a certificate to validate the signature. OpenModelAttribute + NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========================================================================================================= ================================== + +TimePeriod datatype +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::TimePeriod + +**Description:** + +A base / value business entity used to represent a period of time, between two timepoints + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type TimePeriod** + +================== ======== ========= ================================================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ================================================= ================================== +startDateTime DateTime 1 An instant of time, starting at the TimePeriod OpenModelAttribute + Notes: + If null, then represents to the beginning of time - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endDateTime DateTime 1 An instant of time, ending at the TimePeriod: OpenModelAttribute + Notes: + If null, then represents to the end of time - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================================= ================================== + +UnixEpoch primitive type +^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::UnixEpoch + +**Description:** + +the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds + +Uri primitive type +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Uri + +**Description:** + +type string; + +The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66. + +Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1. + +The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent. + +Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate. + +A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required. + +In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017. + +reference + +RFC 3986: Uniform Resource Identifier (URI): Generic Syntax + +RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations + +RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs); + +**Applied Stereotypes:** + +- Preliminary + +Uuid primitive type +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Uuid + +**Description:** + +type string { + +pattern + +'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; } + +A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. + +The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6; + +reference + +RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace; + +**Applied Stereotypes:** + +- Preliminary + +Version primitive type +^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Version + +**Description:** + +This primitive type defines the version of an element. + +**Applied Stereotypes:** + +- Preliminary \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/Service/NestedService.png b/docs/ONAP Model Spec/im/Service/NestedService.png new file mode 100644 index 0000000..0e6f992 Binary files /dev/null and b/docs/ONAP Model Spec/im/Service/NestedService.png differ diff --git a/docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst b/docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst new file mode 100644 index 0000000..ffae213 --- /dev/null +++ b/docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst @@ -0,0 +1,1380 @@ +Enhanced Nested Service Model +============================= + +Diagrams +-------- + +Enhanced Nested Service Model +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: NestedService.png + +Classes +------- + +ServiceAtomicDescriptor +~~~~~~~~~~~~~~~~~~~~~~~ + +**Parent class:** ServiceDescriptor + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_serviceAtomicInstance ServiceAtomicInstance 0..\* OpenModelAttribute An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_resourceDesc (resourcespecification) ResourceDesc 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInvariantId Identifier 1 OpenModelAttribute Constant identifier of the service model. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceId Identifier 1 OpenModelAttribute Versioned identifier of the service model (this uuid is changed for every major version of the service) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute The name of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute The description of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1..\* OpenModelAttribute A predefined list which identifies the construct's category. There is a predefined list of service categories. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version String 1 OpenModelAttribute The service model version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 0..1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +icon String 1 OpenModelAttribute The icon path of the service. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +attachment Attachment 0..\* OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +isShared Boolean 1 OpenModelAttribute Describe whether this service descriptor is shared or not in the service design. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +lifecycleManagementScript ServiceLifecycleManagementScript 0..\* OpenModelAttribute Includes a list of events and corresponding management scripts performed for the + Service. + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +class8 CustomizedKPIGroup 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SNSSAIId Identifier 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Experimental +validFor TimePeriod 0..1 OpenModelAttribute The period during which the design entity is valid. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +status String 1 OpenModelAttribute The condition of the specification, such s active, inactive, or planned. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceAtomicInstance +~~~~~~~~~~~~~~~~~~~~~ + +**Parent class:** ServiceInstance + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceId Identifier 1 OpenModelAttribute Uniquely identifies this instance of a service. + + - isInvariant: false Uniquely identifies this instance of a service. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceInstanceName String 0..1 OpenModelAttribute The name assigned to the service-instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +selfLink Uri 1 OpenModelAttribute URL to endpoint where more details can be gotten. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +orchestrationStatus String 1 OpenModelAttribute Orchestration status of the service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nsStatus String 1 OpenModelAttribute Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +instanceSharingNumber Integer 0..1 OpenModelAttribute Record the number of services that are using this service instance. + Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 0..1 OpenModelAttribute Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 0..1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceCompositeDescriptor +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ServcieCompositeDescriptor is used to model the design time representation of a service component or network service. + +**Parent class:** ServiceDescriptor + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_serviceDescriptor ServiceDescriptor 0..\* OpenModelAttribute Describe the nested relationship between multiple Service Descriptors. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_serviceCompositeInstance ServiceCompositeInstance 0..\* OpenModelAttribute An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_resourceDesc (resourcespecification) ResourceDesc 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInvariantId Identifier 1 OpenModelAttribute Constant identifier of the service model. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceId Identifier 1 OpenModelAttribute Versioned identifier of the service model (this uuid is changed for every major version of the service) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute The name of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute The description of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1..\* OpenModelAttribute A predefined list which identifies the construct's category. There is a predefined list of service categories. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version String 1 OpenModelAttribute The service model version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 0..1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +icon String 1 OpenModelAttribute The icon path of the service. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +attachment Attachment 0..\* OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +isShared Boolean 1 OpenModelAttribute Describe whether this service descriptor is shared or not in the service design. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +lifecycleManagementScript ServiceLifecycleManagementScript 0..\* OpenModelAttribute Includes a list of events and corresponding management scripts performed for the + Service. + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +class8 CustomizedKPIGroup 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SNSSAIId Identifier 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Experimental +validFor TimePeriod 0..1 OpenModelAttribute The period during which the design entity is valid. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +status String 1 OpenModelAttribute The condition of the specification, such s active, inactive, or planned. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceCompositeInstance +~~~~~~~~~~~~~~~~~~~~~~~~ + +**Parent class:** ServiceInstance + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceId Identifier 1 OpenModelAttribute Uniquely identifies this instance of a service. + + - isInvariant: false Uniquely identifies this instance of a service. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceInstanceName String 0..1 OpenModelAttribute The name assigned to the service-instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +selfLink Uri 1 OpenModelAttribute URL to endpoint where more details can be gotten. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +orchestrationStatus String 1 OpenModelAttribute Orchestration status of the service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nsStatus String 1 OpenModelAttribute Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +instanceSharingNumber Integer 0..1 OpenModelAttribute Record the number of services that are using this service instance. + Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 0..1 OpenModelAttribute Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 0..1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceDescriptor +~~~~~~~~~~~~~~~~~ + +ServiceDescriptor is used to model the design time representation of a service. + +**Parent class:** DesignEntity + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +========================= ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +serviceInvariantId Identifier 1 OpenModelAttribute Constant identifier of the service model. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceId Identifier 1 OpenModelAttribute Versioned identifier of the service model (this uuid is changed for every major version of the service) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute The name of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute The description of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1..\* OpenModelAttribute A predefined list which identifies the construct's category. There is a predefined list of service categories. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version String 1 OpenModelAttribute The service model version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 0..1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +icon String 1 OpenModelAttribute The icon path of the service. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +attachment Attachment 0..\* OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +isShared Boolean 1 OpenModelAttribute Describe whether this service descriptor is shared or not in the service design. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +lifecycleManagementScript ServiceLifecycleManagementScript 0..\* OpenModelAttribute Includes a list of events and corresponding management scripts performed for the + Service. + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +class8 CustomizedKPIGroup 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SNSSAIId Identifier 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Experimental +validFor TimePeriod 0..1 OpenModelAttribute The period during which the design entity is valid. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +status String 1 OpenModelAttribute The condition of the specification, such s active, inactive, or planned. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +========================= ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceInstance +~~~~~~~~~~~~~~~ + +ServiceInstance is used to model the run time representation of a service. + +**Parent class:** OperationalEntity + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +===================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +serviceInstanceId Identifier 1 OpenModelAttribute Uniquely identifies this instance of a service. + + - isInvariant: false Uniquely identifies this instance of a service. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceInstanceName String 0..1 OpenModelAttribute The name assigned to the service-instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +selfLink Uri 1 OpenModelAttribute URL to endpoint where more details can be gotten. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +orchestrationStatus String 1 OpenModelAttribute Orchestration status of the service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nsStatus String 1 OpenModelAttribute Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +instanceSharingNumber Integer 0..1 OpenModelAttribute Record the number of services that are using this service instance. + Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 0..1 OpenModelAttribute Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 0..1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +Associations +------------ + +ServiceCompositeInstanceHasServiceInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ======================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceInstance shared Not navig. 1..\* ServiceInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_servicecompositeinstance none Not navig. 1..\* ServiceCompositeInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ======================== =============== ===================== + +SerivceCompositeDescriptorMadeAvailableAsServiceCompositeInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + +Applied stereotypes: + +- Preliminary + +============================ =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceCompositeInstance shared Not navig. 0..\* ServiceCompositeInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_servicecompositedescriptor none Not navig. 1 ServiceCompositeDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +============================ =========== ========== ========= ========================== =============== ===================== + +ServiceCompositeDescriptorComprisedOfServiceDescriptor +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Describe the nested relationship between multiple Serive Descriptors. + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceDescriptor shared Not navig. 0..\* ServiceDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +servicecompositedescriptor none Not navig. 0..\* ServiceCompositeDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ========================== =============== ===================== + +ServiceAtomicDescriptorMadeAvailableAsServiceAtomicInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + +Applied stereotypes: + +- Preliminary + +========================= =========== ========== ========= ======================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceAtomicInstance shared Not navig. 0..\* ServiceAtomicInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_serviceatomicdescriptor none Not navig. 1 ServiceAtomicDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================= =========== ========== ========= ======================= =============== ===================== + +ServiceAtomicDescriptorReferencesResourceDesc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource components of constituting a serivce descriptor. + +Applied stereotypes: + +- Preliminary + +====================================== =========== ========== ========= ======================= ========================================================= ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceDesc (resourcespecification) none Navig. 0..\* ResourceDesc Resource components of constituting a serivce descriptor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_serviceatomicdescriptor none Not navig. 0..\* ServiceAtomicDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +====================================== =========== ========== ========= ======================= ========================================================= ===================== + +ServiceAtomicInstanceReferencesResourceInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource instance components of constituting a serivce instance. + +Applied stereotypes: + +- Preliminary + +======================= =========== ========== ========= ===================== ================================================================ ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceInstance none Navig. 0..\* ResourceInstance Resource instance components of constituting a service instance. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_serviceatomicinstance none Not navig. 0..\* ServiceAtomicInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +======================= =========== ========== ========= ===================== ================================================================ ===================== + +ServiceCompositeInstanceReferencesResourceInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource instance components of constituting a serivce instance. + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ======================== ================================================================ ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceInstance none Navig. 0..\* ResourceInstance Resource instance components of constituting a service instance. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_servicecompositeinstance none Not navig. 0..\* ServiceCompositeInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ======================== ================================================================ ===================== + +ServiceCompositeDescriptorReferencesResourceDesc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource components of constituting a serivce descriptor. + +Applied stereotypes: + +- Preliminary + +====================================== =========== ========== ========= ========================== ========================================================= ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceDesc (resourcespecification) none Navig. 0..\* ResourceDesc Resource components of constituting a serivce descriptor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_service compositedescriptor none Not navig. 0..\* ServiceCompositeDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +====================================== =========== ========== ========= ========================== ========================================================= ===================== + +Data Types +---------- + +ServiceLifecycleManagementScript +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The LifeCycleManagementScript information element specifies a script for the service. + +Applied stereotypes: + +- Preliminary + +================== =============== ========= ========== ================================== ========================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +event ServiceLcmEvent 0..\* RW OpenModelAttribute Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator + reference point. + - isInvariant: false + Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator + - valueRange: no range constraint reference point. + + - support: MANDATORY + + Preliminary +lcmTransitionEvent String 0..\* RW OpenModelAttribute Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +script String 1 RW OpenModelAttribute Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +scriptDsl String 1 RW OpenModelAttribute Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +scriptInput KeyValuePair 0..\* RW OpenModelAttribute Array of KVP 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. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +================== =============== ========= ========== ================================== ========================================================================================================================================================================================================================================================================================================== + +Enumerations +------------ + +ServiceLcmEvent +~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- EVENT_START_DEPLOYMENT: + +- EVENT_END_DEPLOYMENT: + +- EVENT_START_CONFIGURATION: + +- EVENT_END_CONFIGURATION: + +- EVENT_START_TERMINATION: + +- EVENT_END_TERMINATION: + +- EVENT_START_DEPLOYMENT: + +- EVENT_END_DEPLOYMENT: + +- EVENT_START_CONFIGURATION: + +- EVENT_END_CONFIGURATION: + +- EVENT_START_TERMINATION: + +- EVENT_END_TERMINATION: diff --git a/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst new file mode 100644 index 0000000..c817884 --- /dev/null +++ b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst @@ -0,0 +1,395 @@ +.. Copyright 2020 (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 + +Service Order +~~~~~~~~~~~~~ + +.. contents:: + :depth: 3 +.. + +Diagrams +======== + +.. image:: ServiceOrder.png + +Classes +======= + +OrderItemRelationship +--------------------- + +Enables specifying any kind of relationships between ServiceOrderItems + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== ===================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== ===================================================== +type String 1 Preliminary The type of relationship such as contains, relies on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ===================================================== + +OrderRelationship +----------------- + +An association between two ServiceOrders. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =============================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =============================================================================== +type String 1 Preliminary A categorization of the relationship, such as bulk, parent/child, and so forth. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =============================================================================== + +ServiceCharacteristic +--------------------- + +A quality or distinctive feature that defines an entity, including the +name of this feature (attribute), and the type of the actual value. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =========================================== +name String 1 Preliminary Name of dynamic characteristic (attribute). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary Type of the dynamic characteristic value. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =========================================== + +ServiceOrder +------------ + +A type of Request that represents a Customer Order's products decomposed +into the services through which the products are realized. + +**Parent class:** Request + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +======================= ================ ========= ================================== ============================================================================================================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +======================= ================ ========= ================================== ============================================================================================================================================================================= +id String 1 OpenModelAttribute Unique identifier for Interaction. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +externalId String 1 OpenModelAttribute ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +priority OrderPriority 1 OpenModelAttribute A way that can be used by order requester to prioritize orders in Service Order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1 OpenModelAttribute Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option",). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +state OrderState 1 OpenModelAttribute State of the order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +completionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +requestedStartDate EDate 1 OpenModelAttribute The date that was requested to start processing the order. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +requestedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +expectedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is expected to be completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +startDate EDate 1 OpenModelAttribute The date on which an interaction is started. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +notificationContact String 1 OpenModelAttribute Contact attached to the order to send back information regarding this order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +\_serviceOrderItem ServiceOrderItem 1..\* OpenModelAttribute Reference to ServiceOrderItem + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +OrderDate EDate 1 OpenModelAttribute The date the order was placed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +======================= ================ ========= ================================== ============================================================================================================================================================================= + +ServiceOrderItem +---------------- + +The purpose for the ServiceOrder expressed in terms of a +ServiceSpecification or a Service. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ========== ========= ================================== ============================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ========== ========= ================================== ============================================================================================= +id String 1 Preliminary Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +action Action 1 Preliminary The action to take for an InteractionItem, such as add, change, remove. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +state OrderState 1 Preliminary State of the order item: described in the state machine diagram. This is the requested state. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Quantity Integer 1 Preliminary Quantity of an interaction item involved in an interaction. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========== ========= ================================== ============================================================================================= + +Value +----- + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =========================================== +value String 1 Preliminary The value of a given ServiceCharacteristic. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =========================================== + +Enumerations +============ + +Action +------ + +Contains Enumeration Literals: + +- ADD: + +- MODIFY: + +- DELETE: + +- NO_CHANGE: + +OrderPriority +------------- + +A way that can be used by order requester to prioritize orders in +Service Order Management system (from 0 to 4: 0 is the highest priority, +and 4 the lowest). It could be for example valued by BSS based on +customer order requested priority. + +Contains Enumeration Literals: + +- 0: + +- 1: + +- 2: + +- 3: + +- 4: + +OrderState +---------- + +Contains Enumeration Literals: + +- ACKNOWLEDGED: + +- IN_PROGRESS: + +- PENDING: + +- HELD: + +- CANCELLED: + +- COMPLETED: + +- FAILED: + +- PARTIAL: + +- REJECTED: + +.. |image0| image:: ServiceOrderR4.png diff --git a/docs/ONAP Model Spec/im/Service/ServiceOrder.png b/docs/ONAP Model Spec/im/Service/ServiceOrder.png new file mode 100644 index 0000000..5283fa0 Binary files /dev/null and b/docs/ONAP Model Spec/im/Service/ServiceOrder.png differ diff --git a/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst b/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst deleted file mode 100644 index bf7ba8c..0000000 --- a/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst +++ /dev/null @@ -1,613 +0,0 @@ -.. Copyright 2020 (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 - -Atomic / Composite Service View -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. contents:: - :depth: 3 -.. - - -|image0| - -Classes -======= - -ServiceAtomicDescriptor ------------------------ - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -\_serviceAtomicInstance ServiceAtomicInstance 0..\* OpenModelAttribute An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -\_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 1 Preliminary The name of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 1 Preliminary The description of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -version String 1 Preliminary The service model version. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -icon String 1 Preliminary The icon path of the service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -====================================== ==================================== ========= ================================== ===================================================================================================================================================== - -ServiceAtomicInstance ---------------------- - -**Parent class:** ServiceInstance - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: OPTIONAL -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -orchestrationStatus String 1 Preliminary Orchestration status of the service instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== - -ServiceCompositeDescriptor --------------------------- - -ServcieCompositeDescriptor is used to model the design time -representation of a service component or network service. - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -\_serviceDescriptor ServiceDescriptor 0..\* OpenModelAttribute Describe the nested relationship between multiple Service Descriptors. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -\_serviceCompositeInstance ServiceCompositeInstance 0..\* OpenModelAttribute An implementation of composite Service corresponding to a ServiceCompositeDescriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -\_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 1 Preliminary The name of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 1 Preliminary The description of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -version String 1 Preliminary The service model version. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -icon String 1 Preliminary The icon path of the service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -====================================== ==================================== ========= ================================== ===================================================================================================================================================== - -ServiceCompositeInstance ------------------------- - -**Parent class:** ServiceInstance - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: OPTIONAL -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -orchestrationStatus String 1 Preliminary Orchestration status of the service instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== - -ServiceDescriptor ------------------ - -ServiceDescriptor is used to model the design time representation of a -service. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ========== ========= ================================== ===================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ========== ========= ================================== ===================================================================================================================================================== -serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 1 Preliminary The name of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 1 Preliminary The description of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -version String 1 Preliminary The service model version. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -icon String 1 Preliminary The icon path of the service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ========== ========= ================================== ===================================================================================================================================================== - -ServiceInstance ---------------- - -ServiceInstance is used to model the run time representation of a -service. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== -serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: OPTIONAL -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -orchestrationStatus String 1 Preliminary Orchestration status of the service instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== - -.. |image0| image:: Nested Service final for Rst.png - diff --git a/docs/ONAP Model Spec/im/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/ServiceModel-Service order.rst deleted file mode 100644 index ead6beb..0000000 --- a/docs/ONAP Model Spec/im/ServiceModel-Service order.rst +++ /dev/null @@ -1,393 +0,0 @@ -.. Copyright 2020 (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 - -Service Order -~~~~~~~~~~~~~ - -.. contents:: - :depth: 3 -.. - - -|image0| - -Classes -======= - -OrderItemRelationship ---------------------- - -Enables specifying any kind of relationships between ServiceOrderItems - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== ===================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== ===================================================== -type String 1 Preliminary The type of relationship such as contains, relies on. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== ===================================================== - -OrderRelationship ------------------ - -An association between two ServiceOrders. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== =============================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== =============================================================================== -type String 1 Preliminary A categorization of the relationship, such as bulk, parent/child, and so forth. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== =============================================================================== - -ServiceCharacteristic ---------------------- - -A quality or distinctive feature that defines an entity, including the -name of this feature (attribute), and the type of the actual value. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== =========================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== =========================================== -name String 1 Preliminary Name of dynamic characteristic (attribute). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -valueType String 1 Preliminary Type of the dynamic characteristic value. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== =========================================== - -ServiceOrder ------------- - -A type of Request that represents a Customer Order's products decomposed -into the services through which the products are realized. - -**Parent class:** Request - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -======================= ================ ========= ================================== ============================================================================================================================================================================= -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -======================= ================ ========= ================================== ============================================================================================================================================================================= -id String 1 OpenModelAttribute Unique identifier for Interaction. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -externalId String 1 OpenModelAttribute ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -priority OrderPriority 1 OpenModelAttribute A way that can be used by order requester to prioritize orders in Service Order - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -description String 1 OpenModelAttribute Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -category String 1 OpenModelAttribute Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option",). - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -state OrderState 1 OpenModelAttribute State of the order - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -completionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -requestedStartDate EDate 1 OpenModelAttribute The date that was requested to start processing the order. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -requestedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -expectedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is expected to be completed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -startDate EDate 1 OpenModelAttribute The date on which an interaction is started. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -notificationContact String 1 OpenModelAttribute Contact attached to the order to send back information regarding this order - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -\_serviceOrderItem ServiceOrderItem 1..\* OpenModelAttribute Reference to ServiceOrderItem - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -OrderDate EDate 1 OpenModelAttribute The date the order was placed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -======================= ================ ========= ================================== ============================================================================================================================================================================= - -ServiceOrderItem ----------------- - -The purpose for the ServiceOrder expressed in terms of a -ServiceSpecification or a Service. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ========== ========= ================================== ============================================================================================= -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ========== ========= ================================== ============================================================================================= -id String 1 Preliminary Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -action Action 1 Preliminary The action to take for an InteractionItem, such as add, change, remove. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -state OrderState 1 Preliminary State of the order item: described in the state machine diagram. This is the requested state. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -Quantity Integer 1 Preliminary Quantity of an interaction item involved in an interaction. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ========== ========= ================================== ============================================================================================= - -Value ------ - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== =========================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== =========================================== -value String 1 Preliminary The value of a given ServiceCharacteristic. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== =========================================== - -Enumerations -============ - -Action ------- - -Contains Enumeration Literals: - -- ADD: - -- MODIFY: - -- DELETE: - -- NO_CHANGE: - -OrderPriority -------------- - -A way that can be used by order requester to prioritize orders in -Service Order Management system (from 0 to 4: 0 is the highest priority, -and 4 the lowest). It could be for example valued by BSS based on -customer order requested priority. - -Contains Enumeration Literals: - -- 0: - -- 1: - -- 2: - -- 3: - -- 4: - -OrderState ----------- - -Contains Enumeration Literals: - -- ACKNOWLEDGED: - -- IN_PROGRESS: - -- PENDING: - -- HELD: - -- CANCELLED: - -- COMPLETED: - -- FAILED: - -- PARTIAL: - -- REJECTED: - -.. |image0| image:: ServiceOrderR4.png diff --git a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG b/docs/ONAP Model Spec/im/ServiceOrderR4.PNG deleted file mode 100644 index 5283fa0..0000000 Binary files a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG and /dev/null differ diff --git a/docs/ONAP Model Spec/im/VES index.rst b/docs/ONAP Model Spec/im/VES index.rst deleted file mode 100644 index 2440f38..0000000 --- a/docs/ONAP Model Spec/im/VES index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. Copyright 2019 -.. 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 - -VES Model -============= - -.. toctree:: - :maxdepth: 2 - - VES-class-1 - VES-class-2 - VES-datatype - VES-enumeration \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VES/VES index.rst b/docs/ONAP Model Spec/im/VES/VES index.rst new file mode 100644 index 0000000..2440f38 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES index.rst @@ -0,0 +1,14 @@ +.. Copyright 2019 +.. 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 + +VES Model +============= + +.. toctree:: + :maxdepth: 2 + + VES-class-1 + VES-class-2 + VES-datatype + VES-enumeration \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VNF/VNF-DF.png b/docs/ONAP Model Spec/im/VNF/VNF-DF.png new file mode 100644 index 0000000..e5e9d0a Binary files /dev/null and b/docs/ONAP Model Spec/im/VNF/VNF-DF.png differ diff --git a/docs/ONAP Model Spec/im/VNF/VNFD-topo.png b/docs/ONAP Model Spec/im/VNF/VNFD-topo.png new file mode 100644 index 0000000..c03aa05 Binary files /dev/null and b/docs/ONAP Model Spec/im/VNF/VNFD-topo.png differ diff --git a/docs/ONAP Model Spec/im/VNF/VNFD.png b/docs/ONAP Model Spec/im/VNF/VNFD.png new file mode 100644 index 0000000..9832d0a Binary files /dev/null and b/docs/ONAP Model Spec/im/VNF/VNFD.png differ diff --git a/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst new file mode 100644 index 0000000..6bb88e4 --- /dev/null +++ b/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst @@ -0,0 +1,3927 @@ +.. Copyright 2019 +.. 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 Vnfd and VnfInstance Model +=============================== + +.. contents:: + :depth: 3 +.. + +Diagrams +-------- + +Vnfd View +~~~~~~~~~ + +.. image:: VNFD.png + +Vnfd Topology View +~~~~~~~~~~~~~~~~~~ + +.. image:: VNFD-topo.png + +Vnfd Deployment Flavor +~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: VNFD-DF.png + +Class Definition +---------------- + +BaseConfigGroup +~~~~~~~~~~~~~~~ + +Every Vnf contains a BaseConfigGroup. BaseConfigGroup may set Access +Control Lists (ACL's) and establish security groups and server groups. +BaseConfigGroup reates/establishs storage for the VM's (OpenStack +Cinder). BaseConfigGroup may establish internal networks such as OAM +(VNF Mgmt) or MNS (Maintenance & Surveillance) established. A very +simple VNF may only have a BaseConfig VnfElementGroup. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +DeploymentGroup +~~~~~~~~~~~~~~~ + +DeploymentGroup provides the minimum viable VDU and associated VNFC +configuration for a useable VNF. I can have a small, medium, large +deployment configuration. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +HomingGroup +~~~~~~~~~~~ + +Homing selects what cloud selection strategy will be used. HomingGroup +is used to determine where VNF's within a given group are placed with +respect to a service component. Homing strategy is as follows: +Colocation - members of the group share the same cloud region (VIM +Domain) isolation - members of the group do not share the same cloud +region. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - homingStrategy + - HomingStrategy + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - The homing strategy can be one of the following: + Exclusivity + - Resources within the cloud region are exclusive to the group + Inclusively + - Resources are co-located in the same cloud-region. + Diversity + - Resources are geo-diverse (cannot be co-located). + + * - vnfdMembers + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +InstantiationLevel +~~~~~~~~~~~~~~~~~~ + +The InstantiationLevel class describes a given level of resources to be +instantiated within a DF in term of the number of VNFC instances to be +created from each VDU. All the VDUs referenced in the level shall be +part of the corresponding DF and their number shall be within the range +(min/max) for this DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - levelId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a level with the DF. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the level. + + * - scaleInfo + - ScaleInfo + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Represents for each aspect the scale level that corresponds to this instantiationlevel. + scaleInfo shall be present if the VNF supports scaling. + + * - \_vduLevel + - VduLevel + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicates the number of instance of this VDU to deploy for this level. + + * - virtualLinkBitRateLevel + - VirtualLinkBitRateLevel + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies bitrate 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. + +LinkDesc +~~~~~~~~ + +A communication channel that connects two or more devices, nodes, or entities. + +**Parent class:** ResourceDesc (ResourceSpecification) + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - virtualLinkDescId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Unique identifier of this internal VLD in VNFD. + + * - connectivityType + - ConnectivityType + - 1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Specifies the protocol exposed by a VL and the flow pattern supported by the VL. + + * - testAccess + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints). + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Provides human-readable information on the purpose of the VL (e.g. control plane traffic). + + * - monitoringParameter + - MonitoringParameter + - 0..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Defines the virtualised resources monitoring parameters on VLD level. + + * - \_virtuaLlinkDescFlavour + - VirtualLinkDescFlavour + - 1..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Describes a specific flavour of the VL with specific bitrate requirements. + + +PlacementGroup +~~~~~~~~~~~~~~ + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - placementStrategy + - PlacementStrategy + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - strategScope + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +ScalingAspect +~~~~~~~~~~~~~ + +The ScalingAspect class describes the details of an aspect used for +horizontal scaling. + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +ScalingGroup +~~~~~~~~~~~~ + +A ScalingGroup determines which VNFC's (VDU's) are scaled together based +on demand. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +SwImageDesc +~~~~~~~~~~~ + +The SwImageDesc information element describes requested additional +capability for a particular VDU. Such a capability may be for +acceleration or specific tasks. Storage not necessarily related to the +compute, may be Network Attached Storage (NAS) References: +tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The identifier of this software image. + + * - name + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The name of this software image. + + * - version + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The version of this software image. + + * - checksum + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The checksum of the software image file. + + * - containerFormat + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The container format describes the container file format in which software image is provided. + + * - diskFormat + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The disk format of a software image is the format of the underlying disk image. + + * - minRam + - Number + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal RAM requirement 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. + + * - minDisk + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal disk size requirement 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. + + * - size + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The size of the software image. + + * - operatingSystem + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. + support: + + * - supportedVirtualisationEnvironment + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. + + * - swImage + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal disk size requirement 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. + + +Vdu +~~~ + +The Virtualisation Deployment Unit (VDU) is a construct supporting the +description of the deployment and operational behavior of a VNFC. A VNFC +instance created based on the VDU maps to a single virtualisation +container (e.g. a VM). A VNFC will only be in one VNFDesc. If a vendor +wants to use the VNFC in mupliple VNFDesc (their product) they can do +so, but it will be 'repeated'. References: +tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 + +Applied stereotypes: + +- Preliminary +- OpenModelClass +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vduId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this Vdu in VNFD. + + * - name + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name of the Vdu. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the Vdu. + + * - bootOrder + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Boot order of valid boot devices. + NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. + + * - nfviConstraint + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes constraints on the NFVI for the VNFC instance(s) created from this 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the virtualised resources monitoring parameters on VDU level. + + * - injectFiles + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. + + * - configurableProperties + - VnfcConfigurableProperties + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the configurable properties of all VNFC instances based on this VDU. + + * - \_vduCpd + - VduCpd + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL). + + * - \_virtualComputeDesc + - VirtualComputeDesc + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. + + * - \_virtualStorageDesc + - VirtualStorageDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from + virtualComputeDesc defined for this Vdu. + + * - \_swImageDesc + - SwImageDesc + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the software image which is directly loaded on the virtualisation + container realising this Vdu. + NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. + + +VduCpd +~~~~~~ + +A VduCpd information element is a type of Cpd and describes network +connectivity between a VNFC instance (based on this VDU) and an internal +VL. + +**Parent class:** Cpd + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - bitrateRequirement + - Number + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Bitrate requirement on this CP. + + * - vnicName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. + + * - vnicOrder + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the order to create the vNIC within the scope of this Vdu. + + * - vnicType + - VnicType + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the type of the vNIC this CP attaches to. + + * - \_virtualNetworkInterfaceRequirements + - VirtualNetworkInterfaceRequirements + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. + + * - cpdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this Cpd information element. + + * - cpRole + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the role of 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 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). + + * - cpProtocol + - CpProtocolData + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the 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 "layerProtocol" still needs further discussion and not included in this table. + + * - trunkMode + - Boolean + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). + + * - allowedAddressData + - AddressData + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. + + +VduLevel +~~~~~~~~ + +The VduLevel information element indicates for a given VDU in a given +level the number of instances to deploy. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vduId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a VDU. + + * - numberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. + + +VduProfile +~~~~~~~~~~ + +The VduProfile describes additional instantiation data for a given VDU +used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vdudId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a VDU. + + * - minNumberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. + + * - maxNumberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. + + * - localAffinityOrAntiAffinityRule + - LocalAffinityOrAntiAffinityRule + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) + to be created based on this VDU. + + * - affinityOrAntiAffinityGroupId + - Identifier + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier(s) of the 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 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Watchdog action to 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 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Timeout value for the VNFM to wait before the successful booting up of the VDU. + + +VirtualComputeDesc +~~~~~~~~~~~~~~~~~~ + +The VirtualComputeDesc information element supports the specification of +requirements related to virtual compute resources. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - virtualComputeDescId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this VirtualComputeDesc in the VNFD + + * - logicalNode + - LogicalNodeData + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The logical Node requirements. + + * - requestAdditionalCapabilities + - RequestedAdditionalCapabilityData + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Specifies requirements for additional capabilities. These may be for a range of purposes. + One example is acceleration related capabilities. + + * - computeRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies compute requirements. + + * - virtualMemory + - VirtualMemoryData + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The virtual memory of the virtualised compute. + + * - virtualCpu + - VirtualCpuData + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The virtual CPU(s) of the virtualised compute. + + +VirtualLinkDescFlavour +~~~~~~~~~~~~~~~~~~~~~~ + +The VirtualLinkDescFlavour describes additional instantiation data for a +given internal VL used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - qos + - QoS + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - QoS of the VL. + + * - flavourId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies a flavour within a VnfVirtualLinkDesc. + + +VirtualLinkProfile +~~~~~~~~~~~~~~~~~~ + +The VirtualLinkProfile describes additional instantiation data for a +given VL used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - localAffinityOrAntiAffinityRule + - LocalAffinityOrAntiAffinityRule + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier(s) of the 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 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies the minimum bitrate requirements for a VL instantiated + according to this profile. + + * - minBitRateRequirements + - LinkBitrateRequirements + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + + * - initiationParameters + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies initiation parameters for the virtual link. + + * - networkType + - NetworkType + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Type of the network + + * - dhcpEnabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. + + * - vlanTransparent + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicating whether "VLAN Transparent Mode" is supported. + Default is "FALSE" if not specified otherwise. + + * - \_virtualLinkDescFlavour + - VirtualLinkDescFlavour + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies a flavour within the VnfVirtualLinkDesc. + + * - \_virtualLinkDesc + - LinkDesc + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a Vnf VLD. + + +VirtualNetworkInterfaceRequirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This class specifies requirements on a virtual network interface. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - name + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides a human readable name for the requirement. + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides a human readable description of the requirement. + + * - supportMandatory + - Boolean + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or + desirable (FALSE). + + * - networkInterfaceRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The network interface requirements. An element from an array of key-value pairs that + articulate the network interface deployment requirements + + * - nicIoRequirements + - LogicalNodeData + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - This references (couples) 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. + + +VirtualStorageDesc +~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this VirtualStorageDesc in the VNFD. + + * - typeOfStorage + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Type of virtualised storage resource (e.g. volume, object). + + * - sizeOfStorage + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Size of virtualised storage resource (e.g. size of volume, in GB). + + * - vduStorageRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - An array of key-value pairs that articulate the storage deployment requirements. + + * - rdmaEnabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Indicate if the storage support RDMA. + + * - swImageDesc + - Identifier + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Software image to be loaded on the VirtualStorage resource created + based on this VirtualStorageDesc. + +Vnf +~~~ + +An implementation of an NF that can be deployed on a Network Function +Virtualisation Infrastructure (NFVI). + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfInstanceId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the VNF instance + + * - vnfInstanceName + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - name of the VNF instance. Multiple names are possible. + + * - vnfProductName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - name to identify the VNF Product, invariant for the VNF Product lifetime + + * - description + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - description of the VNF instance + + * - vnfProvider + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - provider of the VNF model + + * - vnfdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the VNF model + + * - vnfdVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - version of the VNF model + + * - vnfSoftwareVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package + + * - onboardedVnfPkgInfoId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the specific VNF package on which the VNF instance is based + + * - availabilityZone + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - availability zone information of the VNF instance + + * - operationalStatus + - OperationalStatus + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether the resource is considered operational. + Valid values are in-service-path and out-of-service-path. + + * - orchestrationStatus + - OrchestrationStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNF instance is instantiated + + * - oamlpv4Address + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - oam ip address, ipv4 + + * - oamlpv6Address + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - oam ip address, ipv6 + + * - instantiatedVnfInfo + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - information specific to an instantiated VNF instance, e.g., vm information + + * - inMaint + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + * - isClosedLoopDisabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether closed loop function is enabled + + * - encryptedAccessFlag + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether this VNF is accessed using SSH + + * - vnfConfigurableProperty + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether autoHeal and autoScale is enabled + + * - nfNamingCode + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - String assigned to this model used for naming purpose. + + * - vnfNamingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which has the naming logic for this VNF instance + + * - vnfHomingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which provides homing conditions. + + * - nfType + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Generic description of the type of network function + + * - nfFunction + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - English description of network function that the specific VNF deployment is providing. + + * - nfRole + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Role in the network this model will be providing + + * - closedLoopStatus + - ClosedLoopStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Whether closed loop capabilities are enabled for this or not. + + * - \_nfc(vnfcinstance) + - Vnfc + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relatonship to the NF components that are part of this VNF. + + * - \_vnfd + - Vnfd + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relationship to the VNF descriptor + + * - \_vnfvirtuallink + - VnfVirtualL ink + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relationship to VnfVirtualLink + + +VnfDf +~~~~~ + +The VnfDf describes a specific deployment version of a VNF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - flavorId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this DF within the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the DF. + + * - \_virtuaLlinkProfile + - VirtualLinkProfile + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the internal 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the various 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or 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..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The scaling aspects supported by this DF of the VNF. + scalingAspect shall be present if the VNF supports scaling. + + * - \_vduProfile + - VduProfile + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes additional instantiation data for the VDUs used in this flavor. + + * - \_placementGroup + - PlacementGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Determine where VNFC's (VDU's) are placed with respect to the VNF + + * - \_baseConfigGroup + - BaseConfigGroup + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - BaseConfigGroup may set 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 + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - DeploymentGroup provides the minimum viable VDU and associated VNFC configuration + for a useable VNF. + + * - \_scalinggroup + - ScalingGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. + + +VnfExtCp +~~~~~~~~ + +Describes an external CP exposed by a VNF. + +**Parent class:** Cp + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +VnfExtCpd +~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - \_virtualNetworkInterfaceRequirements + - VirtualNetworkInterfaceRequirements + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies requirements 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. + + * - \_vduCpd + - VduCpd + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reference to the 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. + + +VnfIndicator +~~~~~~~~~~~~ + +The VnfIndicator information element defines the indicator the VNF +supports. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier. + + * - name + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The human readable name of the VnfIndicator. + + * - indicatorValue + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the allowed values or value ranges of this indicator. + + * - source + - VnfSource + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describe the source of the indicator. This tells the consumer where to send the + subscription request. + + +VnfVirtualLink +~~~~~~~~~~~~~~ + +**Parent class:** VirtualLink + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +Vnfc +~~~~ + +An internal component of a VNF providing a VNF Provider a defined +sub-set of that VNF's functionality, with the main characteristic that a +single instance of this component maps 1:1 against a single +Virtualisation Container. + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfcInstanceId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the NFC instance + + * - nfcNamingCode + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - short code of the NFC instance + + * - description + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - description of the NFC instance + + * - vdudId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the model of the NFC instance + + * - l3InterfaceIpv4AddressList + - invalid + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - layer-3 interface addresses, ipv4 + + * - l3InterfaceIpv6AddressList + - invalid + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - layer-3 interface addresses, ipv6 + + * - vnfcState + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - operating status of the VM valid value example: + STARTED (POWER_ON), + STOPPED (POWER_OFF) + + * - inMaint + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + * - isClosedLoopDisabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether closed loop function is enabled + + * - vnfcInstanceName + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - An intelligent or human readable name of the vnfc instance. Multiple names are possible. + + * - \_vnfcCp + - VnfcCp + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Reference to the connection points of the vnfc + + * - vnfcNamingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which has the naming logic for this VNFC instance + + * - nfcFunction + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - English description of network function component that the specific VNFC deployment is providing. + + * - operationalStatus + - OperationalStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether the resource is considered operational. + Valid values are in-service-path and out-of-service-path. + + * - orchestrationStatus + - OrchestrationStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNFC instance is instantiated + + * - closedLoopStatus + - ClosedLoopStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Whether closed loop capabilities are enabled for this or not. + + * - \_vdu + - Vdu + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Reference to the VDU + + +VnfcCp +~~~~~~ + +**Parent class:** Cp + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +Vnfd +~~~~ + +A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of +deployment and operational behaviour requirements. It also contains +connectivity, interface and virtualised resource requirements. +References: tosca-nfv-YAML-v1.0-wd05-rev02 (tosca.nodes.nfv.vnfd, but +node details are not defined) ETSI GS NFV-IFA 011 V2.1.3 (VNFD) + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfProvider + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provider of the VNF and of the VNFD. + + * - vnfProductName + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Name to identify the VNF Product. + Invariant for the VNF Product lifetime. + + * - vnfSoftwareVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Software version of the VNF. + This is changed when there is any change to the + software that is included in the VNF Package. + + * - vnfdVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the version of the VNFD. + + * - vnfProductInfoName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name for the VNF Product. + Can change during the VNF Product lifetime. + + * - vnfProductInfoDescription + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the VNF Product. + Can change during the VNF Product lifetime. + + * - vnfmInfo + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. + + * - localizationLanguage + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about localization languages of the VNF (includes e.g. strings in the VNFD). + NOTE: This allows to provide one or more localization languages to support selecting a + specific localization language at VNF instantiation time. + + * - modifiableAttributes + - VnfInfoModifiableAttributes + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the + ModifyVnfInfo operation. + + * - vnfdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this 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. + + * - defaultLocalizationLanguage + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about localization languages of the VNF (includes e.g. strings in the VNFD). + NOTE: This allows to provide one or more localization languages to support selecting a + specific localization language at VNF instantiation time. + + * - configurableProperties + - VnfConfigurableProperties + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). + + * - lifecycleManagementScript + - LifecycleManagementScript + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Includes a list of events and corresponding management scripts performed for the VNF. + + * - logo + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - File path of the vendor specified logo. + + * - guide + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. + + * - \_vdu + - Vdu + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Virtualisation Deployment Unit. + + * - \_vnfExtCpd + - VnfExtCpd + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes external interface(s) exposed by this VNF enabling connection with a VL. + + * - \_deploymentFlavour + - VnfDf + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes specific DF(s) of a VNF with specific requirements for capacity and performance. + + * - \_vnfIndicator + - VnfIndicator + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Declares the VNF indicators that are supported by this VNF. + + * - \_virtualComputeDesc + - VirtualComputeDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines descriptors of virtual compute resources to be used by the VNF. + + * - \_virtualStorageDesc + - VirtualStorageDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines descriptors of virtual storage resources to be used by the VNF. + + * - \_intVirtuallinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Represents the type of network connectivity mandated by the VNF provider + between two or more CPs which includes at least one internal CP. + + * - \_vnfReservedCpd + - VduCpd + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reserved IP Address for VNF which is not bounded to any + specific VNFC, but assigned manually from outside and potentially + shared as a floating IP among VNFCs. + + * - \_elementGroup + - VnfdElementGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the associated elements of a VNFD for a certain purpose + during VNF lifecycle management. + + +VnfdElementGroup +~~~~~~~~~~~~~~~~ + +A VNFD Element Group is a mechanism for associating elements of a VNFD +(Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, +scaling aspects. A given element can belong to multiple groups. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +Data Type definition +-------------------- + +LifecycleManagementScript +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - event + - LcmEvent + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. + + * - icmTransitionEvent + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the 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 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information to locate a 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 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the domain specific language (i.e. the type) of script that is provided. + Types of scripts could include bash, python, etc. + + * - scriptInput + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of KVP 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. + + +LogicalNodeData +~~~~~~~~~~~~~~~ + +This information element describes compute, memory and I/O requirements +that are to be associated with the logical node of infrastructure. The +logical node requirements are a sub-component of the VDU level +requirements. As an example for illustration purposes, a logical node +correlates to the concept of a NUMA cell in libvirt terminology. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - logicalNodeRequirement + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The logical node-level 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. + + +MonitoringParameter +~~~~~~~~~~~~~~~~~~~ + +Specifies the virtualised resource related performance metric to be +tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects +the values of performance metrics identified by this information element +from the VIM(s) using one or more locally initiated PM Jobs. These +values can be used as inputs to auto-scaling rules. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of the monitoring parameter. + + * - name + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name of the monitoring parameter. + + * - performanceMetric + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - + + * - collectionPeriod + - invalid + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - An attribute that describes the recommended 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. + + +QoS +~~~ + +The QoS information element describes QoS data for a given VL used in a +DF. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - latency + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum latency in ms. + + * - packetDelayVariation + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum jitter in ms. + + * - packetLossRatio + - Number + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. + + +RequestedAdditionalCapabilityData +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This information element describes requested additional capability for a +particular VDU. Such a capability may be for acceleration or specific +tasks. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - supportMandatory + - Boolean + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Indicates whether the requested additional capability is mandatory for successful operation. + + * - requestedAdditionalCapabilityName + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies a requested additional capability for the VDU. + + * - minRequestedAdditionalCapabilityVersion + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies the minimum version of the requested additional capability. + + * - preferredRequestedAdditionalCapabilityVersion + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies the preferred version of the requested additional capability. + + * - targetPerformanceParameters + - KeyValuePair + - 1..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies specific attributes, dependent on the requested additional capability type. + + +ScaleInfo +~~~~~~~~~ + +The ScaleInfo information element represents a scale level for a +particular scaling aspect. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - aspectId + - Identifier + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reference to the scaling aspect. + + * - scaleLevel + - Integer + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The scale level, greater than or equal to 0 + + +VirtualCpuData +~~~~~~~~~~~~~~ + +The VirtualCpuData information element supports the specification of +requirements related to virtual CPU(s) of a virtual compute resource. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - cpuArchitecture + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - CPU architecture 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 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Number of virtual CPUs. + + * - virtualCpuClock + - Number + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - virtualCpuOversubscriptionPolicy + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The CPU core 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..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of key-value pair requirements on the Compute (CPU) for the VDU. + + * - virtualCpuPinning + - VirtualCpuPinningData + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The virtual CPU pinning configuration for the virtualised compute resource. + + +VirtualCpuPinningData +~~~~~~~~~~~~~~~~~~~~~ + +The VirtualCpuPinningData information element supports the specification +of requirements related to the virtual CPU pinning configuration of a +virtual compute resource. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - virtualCpuPinningPolicy + - PinningPolicy + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The policy can take values of "static" or "dynamic". In case of "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 + - invalid + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. + + +VirtualLinkBitRateLevel +~~~~~~~~~~~~~~~~~~~~~~~ + +The VirtualLinkBitRateLevel information element specifies bitrate +requirements applicable to a virtual link instantiated from a particular +VnfVirtualLinkDesc. + +VirtualMemoryData +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - virtualMemSize + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Amount of virtual Memory (e.g. in MB). + + * - virtualMemOversubscriptionPolicy + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + + Obsolete + - The memory core 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..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of key-value pair requirements on the memory for the VDU. + + * - numaEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - It specifies 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. + + +VnfConfigurableProperties +~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the configurable properties of a VNF (e.g. related +to auto scaling and auto healing). For a VNF instance, the value of +these properties can be modified by the VNFM + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - isAutoscaleEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It permits to enable (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 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It permits to enable (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..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - + + +VnfInfoModifiableAttributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the VNF-specific extension and metadata attributes +of the VnfInfo that are writeable via the ModifyVnfInfo operation. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - extension + - invalid + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - "Extension" attributes of VnfInfo that are writeable. + + * - metadata + - invalid + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Metadata" attributes of VnfInfo that are writeable + + +VnfcConfigurableProperties +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the configurable properties of a VNFC. For a VNFC +instance, the value of these properties can be modified through the +VNFM. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - additionalVnfcConfigurableProperty + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. + + +Enumeration definition +---------------------- + +AddressType +~~~~~~~~~~~ + +Type of address + +Contains Enumeration Literals: + +- MAC: + +- IP: + +ClosedLoopStatus +~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- ENABLED: + +- DISABLED: + +CollectionPeriod +~~~~~~~~~~~~~~~~ + +Specifies the periodicity at which the producer will collect performance +information. + +Contains Enumeration Literals: + +HomingStrategy +~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- Colocation: + +- isolation: + +LcmEvent +~~~~~~~~ + +Describes VNF lifecycle event(s) or an external stimulus detected on a +VNFM reference point. + +Contains Enumeration Literals: + +- EVENT_START_INSTANTIATION: + +- EVENT_END_INSTANTIATION: + +- EVENT_START_SCALING: + +- EVENT_END_SCALING: + +- EVENT_START_SCALING_TO_LEVEL: + +- EVENT_END_SCALING_TO_LEVEL: + +- EVENT_START_HEALING: + +- EVENT_END_HEALING: + +- EVENT_START_TERMINATION: + +- 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: + +OperationalStatus +~~~~~~~~~~~~~~~~~ + +Indicator for whether the resource is considered operational. Valid +values are in-service-path and out-of-service-path. + +Contains Enumeration Literals: + +- IN-SERVICE-PATH: + +- OUT-OF-SERVICE-PATH: + +OrchestrationStatus +~~~~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- INVENTORIED: + +- ASSIGNED: + +- CREATED: + +- ACTIVE: + +PinningPolicy +~~~~~~~~~~~~~ + +Defines the CPU pinning policy. + +Contains Enumeration Literals: + +- STATIC: + +- DYNAMIC: + +PlacementStrategy +~~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- COLOCATION: + +- ISOLATION: + +- EXCLUSIVITY: + +ProvStatus +~~~~~~~~~~ + +Provisioning status, used as a trigger for operational monitoring of +this resource by service assurance systems. + +Contains Enumeration Literals: + +- PROVISIONED: + +- PREPROVISIONED: + +- CAPPED: + +VnfSource +~~~~~~~~~ + +Describes the source of the indicator. + +Contains Enumeration Literals: + +- VNF: + +- EM: + +- BOTH: + +VnicType +~~~~~~~~ + +Describes the type of VNIC to which a CP attaches. + +Contains Enumeration Literals: + +- NORMAL: + +- MACVTAP: + +- DIRECT: + +- BAREMETAL: + +- DIRECT_PHYSICAL: + +- VIRTIO_FORWARDER: \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst deleted file mode 100644 index 7d0ba0c..0000000 --- a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst +++ /dev/null @@ -1,3909 +0,0 @@ -.. Copyright 2019 -.. 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 Vnfd and VnfInstance Model -=============================== - -.. contents:: - :depth: 3 -.. - -Class Definition ----------------- - -BaseConfigGroup -~~~~~~~~~~~~~~~ - -Every Vnf contains a BaseConfigGroup. BaseConfigGroup may set Access -Control Lists (ACL's) and establish security groups and server groups. -BaseConfigGroup reates/establishs storage for the VM's (OpenStack -Cinder). BaseConfigGroup may establish internal networks such as OAM -(VNF Mgmt) or MNS (Maintenance & Surveillance) established. A very -simple VNF may only have a BaseConfig VnfElementGroup. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -DeploymentGroup -~~~~~~~~~~~~~~~ - -DeploymentGroup provides the minimum viable VDU and associated VNFC -configuration for a useable VNF. I can have a small, medium, large -deployment configuration. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -HomingGroup -~~~~~~~~~~~ - -Homing selects what cloud selection strategy will be used. HomingGroup -is used to determine where VNF's within a given group are placed with -respect to a service component. Homing strategy is as follows: -Colocation - members of the group share the same cloud region (VIM -Domain) isolation - members of the group do not share the same cloud -region. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - homingStrategy - - HomingStrategy - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - The homing strategy can be one of the following: - Exclusivity - - Resources within the cloud region are exclusive to the group - Inclusively - - Resources are co-located in the same cloud-region. - Diversity - - Resources are geo-diverse (cannot be co-located). - - * - vnfdMembers - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - - - * - vnfdElementGroupId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this group in the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the group. - - * - \_vdu - - Vdu - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to Vdus that are part of this group. - - * - \_vnfVirtualLinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to VnfVirtualLinkDesc that are part of this group. - - -InstantiationLevel -~~~~~~~~~~~~~~~~~~ - -The InstantiationLevel class describes a given level of resources to be -instantiated within a DF in term of the number of VNFC instances to be -created from each VDU. All the VDUs referenced in the level shall be -part of the corresponding DF and their number shall be within the range -(min/max) for this DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - levelId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a level with the DF. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the level. - - * - scaleInfo - - ScaleInfo - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Represents for each aspect the scale level that corresponds to this instantiationlevel. - scaleInfo shall be present if the VNF supports scaling. - - * - \_vduLevel - - VduLevel - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicates the number of instance of this VDU to deploy for this level. - - * - virtualLinkBitRateLevel - - VirtualLinkBitRateLevel - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies bitrate 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. - -LinkDesc -~~~~~~~~ - -A communication channel that connects two or more devices, nodes, or entities. - -**Parent class:** ResourceDesc (ResourceSpecification) - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - virtualLinkDescId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Unique identifier of this internal VLD in VNFD. - - * - connectivityType - - ConnectivityType - - 1 - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Specifies the protocol exposed by a VL and the flow pattern supported by the VL. - - * - testAccess - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints). - - * - description - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Provides human-readable information on the purpose of the VL (e.g. control plane traffic). - - * - monitoringParameter - - MonitoringParameter - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Defines the virtualised resources monitoring parameters on VLD level. - - * - \_virtuaLlinkDescFlavour - - VirtualLinkDescFlavour - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Describes a specific flavour of the VL with specific bitrate requirements. - - -PlacementGroup -~~~~~~~~~~~~~~ - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - placementStrategy - - PlacementStrategy - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - - - * - strategScope - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - - - * - vnfdElementGroupId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this group in the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the group. - - * - \_vdu - - Vdu - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to Vdus that are part of this group. - - * - \_vnfVirtualLinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to VnfVirtualLinkDesc that are part of this group. - - -ScalingAspect -~~~~~~~~~~~~~ - -The ScalingAspect class describes the details of an aspect used for -horizontal scaling. - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -ScalingGroup -~~~~~~~~~~~~ - -A ScalingGroup determines which VNFC's (VDU's) are scaled together based -on demand. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -SwImageDesc -~~~~~~~~~~~ - -The SwImageDesc information element describes requested additional -capability for a particular VDU. Such a capability may be for -acceleration or specific tasks. Storage not necessarily related to the -compute, may be Network Attached Storage (NAS) References: -tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The identifier of this software image. - - * - name - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The name of this software image. - - * - version - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The version of this software image. - - * - checksum - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The checksum of the software image file. - - * - containerFormat - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The container format describes the container file format in which software image is provided. - - * - diskFormat - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The disk format of a software image is the format of the underlying disk image. - - * - minRam - - Number - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The minimal RAM requirement 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. - - * - minDisk - - Number - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The minimal disk size requirement 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. - - * - size - - Number - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The size of the software image. - - * - operatingSystem - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. - support: - - * - supportedVirtualisationEnvironment - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. - - * - swImage - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The minimal disk size requirement 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. - - -Vdu -~~~ - -The Virtualisation Deployment Unit (VDU) is a construct supporting the -description of the deployment and operational behavior of a VNFC. A VNFC -instance created based on the VDU maps to a single virtualisation -container (e.g. a VM). A VNFC will only be in one VNFDesc. If a vendor -wants to use the VNFC in mupliple VNFDesc (their product) they can do -so, but it will be 'repeated'. References: -tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 - -Applied stereotypes: - -- Preliminary -- OpenModelClass -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vduId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this Vdu in VNFD. - - * - name - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable name of the Vdu. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the Vdu. - - * - bootOrder - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Boot order of valid boot devices. - NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. - - * - nfviConstraint - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes constraints on the NFVI for the VNFC instance(s) created from this 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..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the virtualised resources monitoring parameters on VDU level. - - * - injectFiles - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. - - * - configurableProperties - - VnfcConfigurableProperties - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the configurable properties of all VNFC instances based on this VDU. - - * - \_vduCpd - - VduCpd - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL). - - * - \_virtualComputeDesc - - VirtualComputeDesc - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. - - * - \_virtualStorageDesc - - VirtualStorageDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from - virtualComputeDesc defined for this Vdu. - - * - \_swImageDesc - - SwImageDesc - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the software image which is directly loaded on the virtualisation - container realising this Vdu. - NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. - - -VduCpd -~~~~~~ - -A VduCpd information element is a type of Cpd and describes network -connectivity between a VNFC instance (based on this VDU) and an internal -VL. - -**Parent class:** Cpd - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - bitrateRequirement - - Number - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Bitrate requirement on this CP. - - * - vnicName - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. - - * - vnicOrder - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the order to create the vNIC within the scope of this Vdu. - - * - vnicType - - VnicType - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the type of the vNIC this CP attaches to. - - * - \_virtualNetworkInterfaceRequirements - - VirtualNetworkInterfaceRequirements - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. - - * - cpdId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier of this Cpd information element. - - * - cpRole - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the role of 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 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). - - * - cpProtocol - - CpProtocolData - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the 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 "layerProtocol" still needs further discussion and not included in this table. - - * - trunkMode - - Boolean - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). - - * - allowedAddressData - - AddressData - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. - - -VduLevel -~~~~~~~~ - -The VduLevel information element indicates for a given VDU in a given -level the number of instances to deploy. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vduId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a VDU. - - * - numberOfInstances - - Integer - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. - - -VduProfile -~~~~~~~~~~ - -The VduProfile describes additional instantiation data for a given VDU -used in a DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vdudId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a VDU. - - * - minNumberOfInstances - - Integer - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. - - * - maxNumberOfInstances - - Integer - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. - - * - localAffinityOrAntiAffinityRule - - LocalAffinityOrAntiAffinityRule - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) - to be created based on this VDU. - - * - affinityOrAntiAffinityGroupId - - Identifier - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier(s) of the 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 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Watchdog action to 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 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Timeout value for the VNFM to wait before the successful booting up of the VDU. - - -VirtualComputeDesc -~~~~~~~~~~~~~~~~~~ - -The VirtualComputeDesc information element supports the specification of -requirements related to virtual compute resources. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - virtualComputeDescId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this VirtualComputeDesc in the VNFD - - * - logicalNode - - LogicalNodeData - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The logical Node requirements. - - * - requestAdditionalCapabilities - - RequestedAdditionalCapabilityData - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Specifies requirements for additional capabilities. These may be for a range of purposes. - One example is acceleration related capabilities. - - * - computeRequirements - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies compute requirements. - - * - virtualMemory - - VirtualMemoryData - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The virtual memory of the virtualised compute. - - * - virtualCpu - - VirtualCpuData - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The virtual CPU(s) of the virtualised compute. - - -VirtualLinkDescFlavour -~~~~~~~~~~~~~~~~~~~~~~ - -The VirtualLinkDescFlavour describes additional instantiation data for a -given internal VL used in a DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - qos - - QoS - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - QoS of the VL. - - * - flavourId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies a flavour within a VnfVirtualLinkDesc. - - -VirtualLinkProfile -~~~~~~~~~~~~~~~~~~ - -The VirtualLinkProfile describes additional instantiation data for a -given VL used in a DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - localAffinityOrAntiAffinityRule - - LocalAffinityOrAntiAffinityRule - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies affinity or 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..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier(s) of the 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 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies the minimum bitrate requirements for a VL instantiated - according to this profile. - - * - minBitRateRequirements - - LinkBitrateRequirements - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. - - * - initiationParameters - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies initiation parameters for the virtual link. - - * - networkType - - NetworkType - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Type of the network - - * - dhcpEnabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. - - * - vlanTransparent - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicating whether "VLAN Transparent Mode" is supported. - Default is "FALSE" if not specified otherwise. - - * - \_virtualLinkDescFlavour - - VirtualLinkDescFlavour - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies a flavour within the VnfVirtualLinkDesc. - - * - \_virtualLinkDesc - - LinkDesc - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a Vnf VLD. - - -VirtualNetworkInterfaceRequirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This class specifies requirements on a virtual network interface. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - name - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provides a human readable name for the requirement. - - * - description - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provides a human readable description of the requirement. - - * - supportMandatory - - Boolean - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or - desirable (FALSE). - - * - networkInterfaceRequirements - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The network interface requirements. An element from an array of key-value pairs that - articulate the network interface deployment requirements - - * - nicIoRequirements - - LogicalNodeData - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - This references (couples) 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. - - -VirtualStorageDesc -~~~~~~~~~~~~~~~~~~ - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this VirtualStorageDesc in the VNFD. - - * - typeOfStorage - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Type of virtualised storage resource (e.g. volume, object). - - * - sizeOfStorage - - Number - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Size of virtualised storage resource (e.g. size of volume, in GB). - - * - vduStorageRequirements - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - An array of key-value pairs that articulate the storage deployment requirements. - - * - rdmaEnabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Indicate if the storage support RDMA. - - * - swImageDesc - - Identifier - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Software image to be loaded on the VirtualStorage resource created - based on this VirtualStorageDesc. - -Vnf -~~~ - -An implementation of an NF that can be deployed on a Network Function -Virtualisation Infrastructure (NFVI). - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfInstanceId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the VNF instance - - * - vnfInstanceName - - String - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - name of the VNF instance. Multiple names are possible. - - * - vnfProductName - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - name to identify the VNF Product, invariant for the VNF Product lifetime - - * - description - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - description of the VNF instance - - * - vnfProvider - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - provider of the VNF model - - * - vnfdId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the VNF model - - * - vnfdVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - version of the VNF model - - * - vnfSoftwareVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package - - * - onboardedVnfPkgInfoId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the specific VNF package on which the VNF instance is based - - * - availabilityZone - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - availability zone information of the VNF instance - - * - operationalStatus - - OperationalStatus - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - indicator for whether the resource is considered operational. - Valid values are in-service-path and out-of-service-path. - - * - orchestrationStatus - - OrchestrationStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the VNF instance is instantiated - - * - oamlpv4Address - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - oam ip address, ipv4 - - * - oamlpv6Address - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - oam ip address, ipv6 - - * - instantiatedVnfInfo - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - information specific to an instantiated VNF instance, e.g., vm information - - * - inMaint - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. - - * - isClosedLoopDisabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether closed loop function is enabled - - * - encryptedAccessFlag - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether this VNF is accessed using SSH - - * - vnfConfigurableProperty - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - indicator for whether autoHeal and autoScale is enabled - - * - nfNamingCode - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - String assigned to this model used for naming purpose. - - * - vnfNamingPolicyId - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Identifier of the policy which has the naming logic for this VNF instance - - * - vnfHomingPolicyId - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Identifier of the policy which provides homing conditions. - - * - nfType - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Generic description of the type of network function - - * - nfFunction - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - English description of network function that the specific VNF deployment is providing. - - * - nfRole - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Role in the network this model will be providing - - * - closedLoopStatus - - ClosedLoopStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Whether closed loop capabilities are enabled for this or not. - - * - \_nfc(vnfcinstance) - - Vnfc - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Relatonship to the NF components that are part of this VNF. - - * - \_vnfd - - Vnfd - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Relationship to the VNF descriptor - - * - \_vnfvirtuallink - - VnfVirtualL ink - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Relationship to VnfVirtualLink - - -VnfDf -~~~~~ - -The VnfDf describes a specific deployment version of a VNF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - flavorId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier of this DF within the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the DF. - - * - \_virtuaLlinkProfile - - VirtualLinkProfile - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the internal 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..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the various 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..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies affinity or 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..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The scaling aspects supported by this DF of the VNF. - scalingAspect shall be present if the VNF supports scaling. - - * - \_vduProfile - - VduProfile - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes additional instantiation data for the VDUs used in this flavor. - - * - \_placementGroup - - PlacementGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Determine where VNFC's (VDU's) are placed with respect to the VNF - - * - \_baseConfigGroup - - BaseConfigGroup - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - BaseConfigGroup may set 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 - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - DeploymentGroup provides the minimum viable VDU and associated VNFC configuration - for a useable VNF. - - * - \_scalinggroup - - ScalingGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. - - -VnfExtCp -~~~~~~~~ - -Describes an external CP exposed by a VNF. - -**Parent class:** Cp - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -VnfExtCpd -~~~~~~~~~ - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - \_virtualNetworkInterfaceRequirements - - VirtualNetworkInterfaceRequirements - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies requirements 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. - - * - \_vduCpd - - VduCpd - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Reference to the 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. - - -VnfIndicator -~~~~~~~~~~~~ - -The VnfIndicator information element defines the indicator the VNF -supports. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier. - - * - name - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The human readable name of the VnfIndicator. - - * - indicatorValue - - String - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the allowed values or value ranges of this indicator. - - * - source - - VnfSource - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describe the source of the indicator. This tells the consumer where to send the - subscription request. - - -VnfVirtualLink -~~~~~~~~~~~~~~ - -**Parent class:** VirtualLink - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -Vnfc -~~~~ - -An internal component of a VNF providing a VNF Provider a defined -sub-set of that VNF's functionality, with the main characteristic that a -single instance of this component maps 1:1 against a single -Virtualisation Container. - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfcInstanceId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the NFC instance - - * - nfcNamingCode - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - short code of the NFC instance - - * - description - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - description of the NFC instance - - * - vdudId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the model of the NFC instance - - * - l3InterfaceIpv4AddressList - - invalid - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - layer-3 interface addresses, ipv4 - - * - l3InterfaceIpv6AddressList - - invalid - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - layer-3 interface addresses, ipv6 - - * - vnfcState - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - operating status of the VM valid value example: - STARTED (POWER_ON), - STOPPED (POWER_OFF) - - * - inMaint - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. - - * - isClosedLoopDisabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether closed loop function is enabled - - * - vnfcInstanceName - - String - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - An intelligent or human readable name of the vnfc instance. Multiple names are possible. - - * - \_vnfcCp - - VnfcCp - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Reference to the connection points of the vnfc - - * - vnfcNamingPolicyId - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Identifier of the policy which has the naming logic for this VNFC instance - - * - nfcFunction - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - English description of network function component that the specific VNFC deployment is providing. - - * - operationalStatus - - OperationalStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - indicator for whether the resource is considered operational. - Valid values are in-service-path and out-of-service-path. - - * - orchestrationStatus - - OrchestrationStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the VNFC instance is instantiated - - * - closedLoopStatus - - ClosedLoopStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Whether closed loop capabilities are enabled for this or not. - - * - \_vdu - - Vdu - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Reference to the VDU - - -VnfcCp -~~~~~~ - -**Parent class:** Cp - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -Vnfd -~~~~ - -A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of -deployment and operational behaviour requirements. It also contains -connectivity, interface and virtualised resource requirements. -References: tosca-nfv-YAML-v1.0-wd05-rev02 (tosca.nodes.nfv.vnfd, but -node details are not defined) ETSI GS NFV-IFA 011 V2.1.3 (VNFD) - -**Parent class:** NetworkFunctionDesc - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfProvider - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provider of the VNF and of the VNFD. - - * - vnfProductName - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Name to identify the VNF Product. - Invariant for the VNF Product lifetime. - - * - vnfSoftwareVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Software version of the VNF. - This is changed when there is any change to the - software that is included in the VNF Package. - - * - vnfdVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the version of the VNFD. - - * - vnfProductInfoName - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable name for the VNF Product. - Can change during the VNF Product lifetime. - - * - vnfProductInfoDescription - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the VNF Product. - Can change during the VNF Product lifetime. - - * - vnfmInfo - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. - - * - localizationLanguage - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information about localization languages of the VNF (includes e.g. strings in the VNFD). - NOTE: This allows to provide one or more localization languages to support selecting a - specific localization language at VNF instantiation time. - - * - modifiableAttributes - - VnfInfoModifiableAttributes - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the - ModifyVnfInfo operation. - - * - vnfdId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier of this 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. - - * - defaultLocalizationLanguage - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information about localization languages of the VNF (includes e.g. strings in the VNFD). - NOTE: This allows to provide one or more localization languages to support selecting a - specific localization language at VNF instantiation time. - - * - configurableProperties - - VnfConfigurableProperties - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). - - * - lifecycleManagementScript - - LifecycleManagementScript - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Includes a list of events and corresponding management scripts performed for the VNF. - - * - logo - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - File path of the vendor specified logo. - - * - guide - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. - - * - \_vdu - - Vdu - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Virtualisation Deployment Unit. - - * - \_vnfExtCpd - - VnfExtCpd - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes external interface(s) exposed by this VNF enabling connection with a VL. - - * - \_deploymentFlavour - - VnfDf - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes specific DF(s) of a VNF with specific requirements for capacity and performance. - - * - \_vnfIndicator - - VnfIndicator - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Declares the VNF indicators that are supported by this VNF. - - * - \_virtualComputeDesc - - VirtualComputeDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines descriptors of virtual compute resources to be used by the VNF. - - * - \_virtualStorageDesc - - VirtualStorageDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines descriptors of virtual storage resources to be used by the VNF. - - * - \_intVirtuallinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Represents the type of network connectivity mandated by the VNF provider - between two or more CPs which includes at least one internal CP. - - * - \_vnfReservedCpd - - VduCpd - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Reserved IP Address for VNF which is not bounded to any - specific VNFC, but assigned manually from outside and potentially - shared as a floating IP among VNFCs. - - * - \_elementGroup - - VnfdElementGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the associated elements of a VNFD for a certain purpose - during VNF lifecycle management. - - -VnfdElementGroup -~~~~~~~~~~~~~~~~ - -A VNFD Element Group is a mechanism for associating elements of a VNFD -(Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, -scaling aspects. A given element can belong to multiple groups. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfdElementGroupId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this group in the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the group. - - * - \_vdu - - Vdu - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to Vdus that are part of this group. - - * - \_vnfVirtualLinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to VnfVirtualLinkDesc that are part of this group. - - -Data Type definition --------------------- - -LifecycleManagementScript -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - event - - LcmEvent - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. - - * - icmTransitionEvent - - String - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the 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 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information to locate a 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 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the domain specific language (i.e. the type) of script that is provided. - Types of scripts could include bash, python, etc. - - * - scriptInput - - KeyValuePair - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Array of KVP 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. - - -LogicalNodeData -~~~~~~~~~~~~~~~ - -This information element describes compute, memory and I/O requirements -that are to be associated with the logical node of infrastructure. The -logical node requirements are a sub-component of the VDU level -requirements. As an example for illustration purposes, a logical node -correlates to the concept of a NUMA cell in libvirt terminology. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - logicalNodeRequirement - - KeyValuePair - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The logical node-level 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. - - -MonitoringParameter -~~~~~~~~~~~~~~~~~~~ - -Specifies the virtualised resource related performance metric to be -tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects -the values of performance metrics identified by this information element -from the VIM(s) using one or more locally initiated PM Jobs. These -values can be used as inputs to auto-scaling rules. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of the monitoring parameter. - - * - name - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable name of the monitoring parameter. - - * - performanceMetric - - String - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - - - * - collectionPeriod - - invalid - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - An attribute that describes the recommended 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. - - -QoS -~~~ - -The QoS information element describes QoS data for a given VL used in a -DF. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - latency - - Number - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum latency in ms. - - * - packetDelayVariation - - Number - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum jitter in ms. - - * - packetLossRatio - - Number - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. - - -RequestedAdditionalCapabilityData -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This information element describes requested additional capability for a -particular VDU. Such a capability may be for acceleration or specific -tasks. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - supportMandatory - - Boolean - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Indicates whether the requested additional capability is mandatory for successful operation. - - * - requestedAdditionalCapabilityName - - String - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies a requested additional capability for the VDU. - - * - minRequestedAdditionalCapabilityVersion - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies the minimum version of the requested additional capability. - - * - preferredRequestedAdditionalCapabilityVersion - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies the preferred version of the requested additional capability. - - * - targetPerformanceParameters - - KeyValuePair - - 1..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies specific attributes, dependent on the requested additional capability type. - - -ScaleInfo -~~~~~~~~~ - -The ScaleInfo information element represents a scale level for a -particular scaling aspect. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - aspectId - - Identifier - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Reference to the scaling aspect. - - * - scaleLevel - - Integer - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The scale level, greater than or equal to 0 - - -VirtualCpuData -~~~~~~~~~~~~~~ - -The VirtualCpuData information element supports the specification of -requirements related to virtual CPU(s) of a virtual compute resource. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - cpuArchitecture - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - CPU architecture 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 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Number of virtual CPUs. - - * - virtualCpuClock - - Number - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. - - * - virtualCpuOversubscriptionPolicy - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - The CPU core 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..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Array of key-value pair requirements on the Compute (CPU) for the VDU. - - * - virtualCpuPinning - - VirtualCpuPinningData - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - The virtual CPU pinning configuration for the virtualised compute resource. - - -VirtualCpuPinningData -~~~~~~~~~~~~~~~~~~~~~ - -The VirtualCpuPinningData information element supports the specification -of requirements related to the virtual CPU pinning configuration of a -virtual compute resource. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - virtualCpuPinningPolicy - - PinningPolicy - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - The policy can take values of "static" or "dynamic". In case of "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 - - invalid - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. - - -VirtualLinkBitRateLevel -~~~~~~~~~~~~~~~~~~~~~~~ - -The VirtualLinkBitRateLevel information element specifies bitrate -requirements applicable to a virtual link instantiated from a particular -VnfVirtualLinkDesc. - -VirtualMemoryData -~~~~~~~~~~~~~~~~~ - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - virtualMemSize - - Number - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Amount of virtual Memory (e.g. in MB). - - * - virtualMemOversubscriptionPolicy - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Obsolete - - The memory core 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..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Array of key-value pair requirements on the memory for the VDU. - - * - numaEnabled - - Boolean - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - It specifies 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. - - -VnfConfigurableProperties -~~~~~~~~~~~~~~~~~~~~~~~~~ - -This datatype defines the configurable properties of a VNF (e.g. related -to auto scaling and auto healing). For a VNF instance, the value of -these properties can be modified by the VNFM - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - isAutoscaleEnabled - - Boolean - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - It permits to enable (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 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - It permits to enable (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..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - - - -VnfInfoModifiableAttributes -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This datatype defines the VNF-specific extension and metadata attributes -of the VnfInfo that are writeable via the ModifyVnfInfo operation. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - extension - - invalid - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - "Extension" attributes of VnfInfo that are writeable. - - * - metadata - - invalid - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Metadata" attributes of VnfInfo that are writeable - - -VnfcConfigurableProperties -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This datatype defines the configurable properties of a VNFC. For a VNFC -instance, the value of these properties can be modified through the -VNFM. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - additionalVnfcConfigurableProperty - - String - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. - - -Enumeration definition ----------------------- - -AddressType -~~~~~~~~~~~ - -Type of address - -Contains Enumeration Literals: - -- MAC: - -- IP: - -ClosedLoopStatus -~~~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- ENABLED: - -- DISABLED: - -CollectionPeriod -~~~~~~~~~~~~~~~~ - -Specifies the periodicity at which the producer will collect performance -information. - -Contains Enumeration Literals: - -HomingStrategy -~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- Colocation: - -- isolation: - -LcmEvent -~~~~~~~~ - -Describes VNF lifecycle event(s) or an external stimulus detected on a -VNFM reference point. - -Contains Enumeration Literals: - -- EVENT_START_INSTANTIATION: - -- EVENT_END_INSTANTIATION: - -- EVENT_START_SCALING: - -- EVENT_END_SCALING: - -- EVENT_START_SCALING_TO_LEVEL: - -- EVENT_END_SCALING_TO_LEVEL: - -- EVENT_START_HEALING: - -- EVENT_END_HEALING: - -- EVENT_START_TERMINATION: - -- 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: - -OperationalStatus -~~~~~~~~~~~~~~~~~ - -Indicator for whether the resource is considered operational. Valid -values are in-service-path and out-of-service-path. - -Contains Enumeration Literals: - -- IN-SERVICE-PATH: - -- OUT-OF-SERVICE-PATH: - -OrchestrationStatus -~~~~~~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- INVENTORIED: - -- ASSIGNED: - -- CREATED: - -- ACTIVE: - -PinningPolicy -~~~~~~~~~~~~~ - -Defines the CPU pinning policy. - -Contains Enumeration Literals: - -- STATIC: - -- DYNAMIC: - -PlacementStrategy -~~~~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- COLOCATION: - -- ISOLATION: - -- EXCLUSIVITY: - -ProvStatus -~~~~~~~~~~ - -Provisioning status, used as a trigger for operational monitoring of -this resource by service assurance systems. - -Contains Enumeration Literals: - -- PROVISIONED: - -- PREPROVISIONED: - -- CAPPED: - -VnfSource -~~~~~~~~~ - -Describes the source of the indicator. - -Contains Enumeration Literals: - -- VNF: - -- EM: - -- BOTH: - -VnicType -~~~~~~~~ - -Describes the type of VNIC to which a CP attaches. - -Contains Enumeration Literals: - -- NORMAL: - -- MACVTAP: - -- DIRECT: - -- BAREMETAL: - -- DIRECT_PHYSICAL: - -- VIRTIO_FORWARDER: \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst index 6645f46..ba25226 100644 --- a/docs/ONAP Model Spec/im/index.rst +++ b/docs/ONAP Model Spec/im/index.rst @@ -12,13 +12,14 @@ ONAP Information Model Specifications .. toctree:: :titlesonly: - Root - VnfdAndVnfInstance - NSD - BusinessInteraction - VES index - ServiceModel-Nested Service - ServiceModel-Service order - NSDR4 - Nested Service final for Rst - ServiceOrderR4 \ No newline at end of file + Root/Root + VNF/VnfdAndVnfInstance + PNF/PNFD + NSD/NSD + Common/BusinessInteraction + VES/VES index + Service/ServiceModel-Nested Service + Service/ServiceModel-Service order + Common/DynamicParameters + Common/SelectionCriteria + License/LicenseModel diff --git a/docs/ONAP Model Spec/index.rst b/docs/ONAP Model Spec/index.rst index 6536ee6..602f7ab 100644 --- a/docs/ONAP Model Spec/index.rst +++ b/docs/ONAP Model Spec/index.rst @@ -6,7 +6,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -ONAP R5 Modeling Specifications +ONAP Modeling Specifications ============================================== .. toctree:: diff --git a/docs/Release-notes/index.rst b/docs/Release-notes/index.rst deleted file mode 100644 index 4ff7ff4..0000000 --- a/docs/Release-notes/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. Copyright 2019 (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. - -Modeling Release Notes -============================================== - -.. toctree:: - :maxdepth: 1 - - release-notes diff --git a/docs/Release-notes/release-notes.rst b/docs/Release-notes/release-notes.rst index 9dc1889..95a18e9 100644 --- a/docs/Release-notes/release-notes.rst +++ b/docs/Release-notes/release-notes.rst @@ -6,6 +6,41 @@ Modeling Spec Release Notes =========================== +Version: 6.0.0 +-------------- + +:Release Date: 2020-05-24 + +**New Features** + +Introduce the following new information models: + +- dynamic parameters +- selection criteria +- license management + +Enhance service information model for nested and shared service. + +**Bug Fixes** + +**Security Notes** + +MODELLING code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. + +Quick Links: + - `MODELLING project page `_ + + - `Passing Badge information for MODELLING `_ + +**Known Issues** + None + +**Upgrade Notes** + Update root hierarchy information model. + +**Other** + None + Version: 5.0.0 -------------- @@ -35,7 +70,7 @@ Quick Links: None **Other** - + None Version: 4.0.0 -------------- @@ -66,14 +101,13 @@ Quick Links: Update VNFD information and data model to align with ETSI NFV IFA011/SOL001 v2.5.1 specifications. **Other** + None Version: 3.1.1 -------------- :Release Date: 2018-11-07 - - **New Features** Define design time VNFD model information model and onboarding data model specifications based on ETSI NFV specifications IFA011 and SOL001. @@ -96,7 +130,4 @@ Quick Links: None **Other** - -=========== - -End of Release Notes + None diff --git a/docs/index.rst b/docs/index.rst index 5bf7327..a821e4f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,4 +18,4 @@ The changes can be found in the Release Notes: .. toctree:: :maxdepth: 1 - Release-notes/index + Release-notes/release-notes -- cgit 1.2.3-korg