VNFRQTS - Updating monitor reqt for Casablanca
[vnfrqts/requirements.git] / docs / Chapter7 / VNF-On-boarding-and-package-management.rst
old mode 100644 (file)
new mode 100755 (executable)
index 226efd6..bd49838
@@ -1,6 +1,16 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
+.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
+
+.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
+   (the "License"); you may not use this documentation except in compliance
+   with the License. You may obtain a copy of the License at
+
+.. https://creativecommons.org/licenses/by/4.0/
+
+.. Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
 
 
 VNF On-boarding and package management
@@ -29,7 +39,7 @@ Resource Description
 
 
 .. req::
-    :id: R-77707    
+    :id: R-77707
     :target: XNF
     :keyword: MUST
 
@@ -37,7 +47,7 @@ Resource Description
     contains a list of all the components in the xNF package.
 
 .. req::
-    :id: R-66070    
+    :id: R-66070
     :target: XNF
     :keyword: MUST
 
@@ -47,7 +57,7 @@ Resource Description
     given by the xNF provider, xNF description, xNF provider, and version.
 
 .. req::
-    :id: R-69565    
+    :id: R-69565
     :target: XNF
     :keyword: MUST
 
@@ -59,7 +69,7 @@ Resource Description
     after xNF instantiation.
 
 .. req::
-    :id: R-00156    
+    :id: R-00156
     :target: XNF
     :keyword: MUST
 
@@ -69,7 +79,7 @@ Resource Description
     healing and/or scaling responses).
 
 .. req::
-    :id: R-00068    
+    :id: R-00068
     :target: XNF
     :keyword: MUST
 
@@ -79,7 +89,7 @@ Resource Description
     plane, etc.) generated by the xNF after instantiation.
 
 .. req::
-    :id: R-12678    
+    :id: R-12678
     :target: XNF
     :keyword: MUST
 
@@ -88,7 +98,7 @@ Resource Description
     control responses, tests) which can be performed for the xNF.
 
 .. req::
-    :id: R-84366    
+    :id: R-84366
     :target: XNF
     :keyword: MUST
 
@@ -99,7 +109,7 @@ Resource Description
     format and protocols supported.
 
 .. req::
-    :id: R-36280    
+    :id: R-36280
     :target: XNF
     :keyword: MUST
 
@@ -108,19 +118,29 @@ Resource Description
     xNF and compose complex services.
 
 .. req::
-    :id: R-98617    
+    :id: R-98617
     :target: XNF
     :keyword: MUST
 
     The xNF provider **MUST** provide information regarding any
     dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
 
+.. req::
+    :id: R-22346
+    :target: VNF PACKAGE
+    :keyword: MUST
+    :introduced: casablanca
+    :validation_mode: static
+
+    The VNF package MUST provide `VES Event Registration <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventRegistration.html>`_ for all VES events provided by that xNF.
+
+
 Resource Configuration
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 
 .. req::
-    :id: R-89571    
+    :id: R-89571
     :target: XNF
     :keyword: MUST
 
@@ -137,7 +157,7 @@ Configuration Management via NETCONF/YANG
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. req::
-    :id: R-30278    
+    :id: R-30278
     :target: XNF
     :keyword: MUST
 
@@ -151,7 +171,7 @@ Configuration Management via Chef
 
 
 .. req::
-    :id: R-13390    
+    :id: R-13390
     :target: XNF
     :keyword: MUST
 
@@ -159,7 +179,7 @@ Configuration Management via Chef
     on the appropriate Chef Server.
 
 .. req::
-    :id: R-18525    
+    :id: R-18525
     :target: XNF
     :keyword: MUST
 
@@ -177,7 +197,7 @@ Configuration Management via Ansible
 
 
 .. req::
-    :id: R-75608    
+    :id: R-75608
     :target: XNF
     :keyword: MUST
 
@@ -185,7 +205,7 @@ Configuration Management via Ansible
     on the appropriate Ansible Server.
 
 .. req::
-    :id: R-16777    
+    :id: R-16777
     :target: XNF
     :keyword: MUST
 
@@ -196,7 +216,7 @@ Configuration Management via Ansible
     in the Appendix.
 
 .. req::
-    :id: R-46567    
+    :id: R-46567
     :target: XNF
     :keyword: MUST
 
@@ -204,7 +224,7 @@ Configuration Management via Ansible
     for boot sequence and configuration.
 
 .. req::
-    :id: R-16065    
+    :id: R-16065
     :target: XNF
     :keyword: MUST
 
@@ -218,7 +238,7 @@ Resource Control Loop
 
 
 .. req::
-    :id: R-22888    
+    :id: R-22888
     :target: XNF
     :keyword: MUST
 
@@ -228,7 +248,7 @@ Resource Control Loop
     are implemented in the xNF.
 
 .. req::
-    :id: R-01556    
+    :id: R-01556
     :target: XNF
     :keyword: MUST
 
@@ -237,7 +257,7 @@ Resource Control Loop
     that are made available by the xNF.
 
 .. req::
-    :id: R-16875    
+    :id: R-16875
     :target: XNF
     :keyword: MUST
 
@@ -247,7 +267,7 @@ Resource Control Loop
     Root Cause Analysis and resolve the issue.
 
 .. req::
-    :id: R-35960    
+    :id: R-35960
     :target: XNF
     :keyword: MUST
 
@@ -256,16 +276,16 @@ Resource Control Loop
     descriptions including causes/fixes if applicable for the event.
 
 .. req::
-    :id: R-42018    
+    :id: R-42018
     :target: XNF
     :keyword: MUST
 
     The xNF Package **MUST** include documentation which must include
     all events (fault, measurement for xNF Scaling, Syslogs, State Change
-    and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF.
+    and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html>`__ ) and for the overall xNF.
 
 .. req::
-    :id: R-27711    
+    :id: R-27711
     :target: XNF
     :keyword: MUST
 
@@ -274,7 +294,7 @@ Resource Control Loop
     causes/corrective action.
 
 .. req::
-    :id: R-01478    
+    :id: R-01478
     :target: XNF
     :keyword: MUST
 
@@ -284,7 +304,7 @@ Resource Control Loop
     collected for reporting purposes.
 
 .. req::
-    :id: R-73560    
+    :id: R-73560
     :target: XNF
     :keyword: MUST
 
@@ -293,7 +313,7 @@ Resource Control Loop
     application management.
 
 .. req::
-    :id: R-90632    
+    :id: R-90632
     :target: XNF
     :keyword: MUST
 
@@ -302,7 +322,7 @@ Resource Control Loop
     and performance management purposes.
 
 .. req::
-    :id: R-86235    
+    :id: R-86235
     :target: XNF
     :keyword: MUST
 
@@ -313,7 +333,7 @@ Resource Control Loop
     its function.
 
 .. req::
-    :id: R-33904    
+    :id: R-33904
     :target: XNF
     :keyword: MUST
 
@@ -321,7 +341,7 @@ Resource Control Loop
     lower and upper limits.
 
 .. req::
-    :id: R-53598    
+    :id: R-53598
     :target: XNF
     :keyword: MUST
 
@@ -330,7 +350,7 @@ Resource Control Loop
     significance of the threshold crossing.
 
 .. req::
-    :id: R-69877    
+    :id: R-69877
     :target: XNF
     :keyword: MUST
 
@@ -339,7 +359,7 @@ Resource Control Loop
     threshold crossing alert event is recorded.
 
 .. req::
-    :id: R-22680    
+    :id: R-22680
     :target: XNF
     :keyword: MUST
 
@@ -349,7 +369,7 @@ Resource Control Loop
     of the xNF.
 
 .. req::
-    :id: R-33694    
+    :id: R-33694
     :target: XNF
     :keyword: MUST
 
@@ -358,7 +378,7 @@ Resource Control Loop
     artifacts.
 
 .. req::
-    :id: R-56815    
+    :id: R-56815
     :target: XNF
     :keyword: MUST
 
@@ -367,7 +387,7 @@ Resource Control Loop
     of users, bandwidth, throughput, concurrent calls).
 
 .. req::
-    :id: R-48596    
+    :id: R-48596
     :target: XNF
     :keyword: MUST
 
@@ -375,7 +395,7 @@ Resource Control Loop
     the characteristics for the xNF reliability and high availability.
 
 .. req::
-    :id: R-74763    
+    :id: R-74763
     :target: XNF
     :keyword: MUST
 
@@ -383,14 +403,14 @@ Resource Control Loop
     all of the xNF Event Records supported. The artifact should include
     reference to the specific release of the xNF Event Stream Common Event
     Data Model document it is based on. (e.g.,
-    `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__)
+    `VES Event Listener <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__)
 
 Compute, Network, and Storage Requirements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
 .. req::
-    :id: R-35851    
+    :id: R-35851
     :target: XNF
     :keyword: MUST
 
@@ -400,7 +420,7 @@ Compute, Network, and Storage Requirements
     applicable) for each interface.
 
 .. req::
-    :id: R-97102    
+    :id: R-97102
     :target: VNF
     :keyword: MUST
 
@@ -409,7 +429,7 @@ Compute, Network, and Storage Requirements
     for all VNF components - for hypervisor, CPU, memory, storage.
 
 .. req::
-    :id: R-20204    
+    :id: R-20204
     :target: VNF
     :keyword: MUST
 
@@ -418,7 +438,7 @@ Compute, Network, and Storage Requirements
     interface connections, internal and external to VNF.
 
 .. req::
-    :id: R-44896    
+    :id: R-44896
     :target: VNF
     :keyword: MUST
 
@@ -427,7 +447,7 @@ Compute, Network, and Storage Requirements
     redundancy model.
 
 .. req::
-    :id: R-55802    
+    :id: R-55802
     :target: VNF
     :keyword: MUST
 
@@ -438,7 +458,7 @@ Compute, Network, and Storage Requirements
     Note: Must comply with the *Heat requirements in 5.b*.
 
 .. req::
-    :id: R-26881    
+    :id: R-26881
     :target: XNF
     :keyword: MUST
 
@@ -446,7 +466,7 @@ Compute, Network, and Storage Requirements
     needed to instantiate the xNF (xNF and VNFC images).
 
 .. req::
-    :id: R-96634    
+    :id: R-96634
     :target: XNF
     :keyword: MUST
 
@@ -458,15 +478,15 @@ Testing
 
 
 .. req::
-    :id: R-43958    
+    :id: R-43958
     :target: XNF
     :keyword: MUST
 
     The xNF Package **MUST** include documentation describing
-    the tests that were conducted by the xNF providor and the test results.
+    the tests that were conducted by the xNF provider and the test results.
 
 .. req::
-    :id: R-04298    
+    :id: R-04298
     :target: XNF
     :keyword: MUST
 
@@ -474,7 +494,7 @@ Testing
     support testing.
 
 .. req::
-    :id: R-58775    
+    :id: R-58775
     :target: XNF
     :keyword: MUST
 
@@ -489,7 +509,7 @@ Licensing Requirements
 
 
 .. req::
-    :id: R-85653    
+    :id: R-85653
     :target: XNF
     :keyword: MUST
 
@@ -498,7 +518,7 @@ Licensing Requirements
     every license.
 
 .. req::
-    :id: R-44125    
+    :id: R-44125
     :target: XNF
     :keyword: MUST
 
@@ -507,7 +527,7 @@ Licensing Requirements
     shall define the reporting process and the available reporting tools.
 
 .. req::
-    :id: R-40827    
+    :id: R-40827
     :target: XNF
     :keyword: MUST
 
@@ -515,7 +535,7 @@ Licensing Requirements
     source licenses their xNF(s) incorporate.
 
 .. req::
-    :id: R-97293    
+    :id: R-97293
     :target: XNF
     :keyword: MUST NOT
 
@@ -523,7 +543,7 @@ Licensing Requirements
     of Service Provider's business.
 
 .. req::
-    :id: R-44569    
+    :id: R-44569
     :target: XNF
     :keyword: MUST NOT
 
@@ -532,7 +552,7 @@ Licensing Requirements
     functions and metrics.
 
 .. req::
-    :id: R-13613    
+    :id: R-13613
     :target: VNF
     :keyword: MUST
 
@@ -540,7 +560,7 @@ Licensing Requirements
     purposes to allow automated scale up/down by the management system.
 
 .. req::
-    :id: R-27511    
+    :id: R-27511
     :target: VNF
     :keyword: MUST
 
@@ -550,7 +570,7 @@ Licensing Requirements
     restrictions based upon VNF provider permissions.
 
 .. req::
-    :id: R-85991    
+    :id: R-85991
     :target: XNF
     :keyword: MUST
 
@@ -562,7 +582,7 @@ Licensing Requirements
     be resolved without interrupting in-service xNFs.
 
 .. req::
-    :id: R-47849    
+    :id: R-47849
     :target: XNF
     :keyword: MUST
 
@@ -578,19 +598,3 @@ Licensing Requirements
     Note: License metadata support in ONAP is not currently available
     and planned for 1Q 2018.
 
-
-.. |image0| image:: Data_Model_For_Event_Records.png
-      :width: 7in
-      :height: 8in
-
-.. |image1| image:: VES_JSON_Driven_Model.png
-      :width: 5in
-      :height: 3in
-
-.. |image2| image:: YANG_Driven_Model.png
-      :width: 5in
-      :height: 3in
-
-.. |image3| image:: Protocol_Buffers_Driven_Model.png
-      :width: 4.74in
-      :height: 3.3in