VNFRQTS - Fixing Doc8 errors 87/58087/1
authorBozawglanian, Hagop (hb755d) <hb755d@att.com>
Mon, 30 Jul 2018 20:26:07 +0000 (20:26 +0000)
committerBozawglanian, Hagop (hb755d) <hb755d@att.com>
Mon, 30 Jul 2018 20:27:19 +0000 (20:27 +0000)
Reviewing all files to make sure no doc8 errors are present.

Change-Id: Ic073a7fb4096269d6b1781cecfdb2c4c8aa7b552
Issue-ID: VNFRQTS-281
Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
30 files changed:
docs/Chapter1/index.rst
docs/Chapter2/index.rst
docs/Chapter3/index.rst
docs/Chapter4/Design.rst
docs/Chapter4/Develop-Steps.rst
docs/Chapter4/Devops.rst
docs/Chapter4/Modularity.rst
docs/Chapter4/Resiliency.rst
docs/Chapter4/Security.rst
docs/Chapter4/index.rst
docs/Chapter5/Creating-Vendor-Specific-VNFM-Adaptor-Microservices.rst
docs/Chapter5/Heat.rst
docs/Chapter5/Tosca.rst
docs/Chapter5/VNFM-Driver-Development-Steps.rst
docs/Chapter5/index.rst
docs/Chapter6/index.rst
docs/Chapter7/Configuration-Management.rst
docs/Chapter7/Monitoring-And-Management.rst
docs/Chapter7/Service-Design.rst
docs/Chapter7/VNF-On-boarding-and-package-management.rst
docs/Chapter7/index.rst
docs/Chapter8/Ansible-JSON-Key-Value-Description.rst
docs/Chapter8/Ansible-Playbook-Examples.rst
docs/Chapter8/Chef-JSON-Key-Value-Description.rst
docs/Chapter8/TOSCA-model.rst
docs/Chapter8/VNF-License-Information-Guidelines.rst
docs/Chapter8/index.rst
docs/Chapter9/index.rst
docs/index.rst
docs/release-notes.rst

index f738542..7b3f3e5 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index eab491d..5114653 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index d63023e..85c8c49 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index a4288d0..583c752 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 30fe07e..6e55bef 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 589e382..e8329e4 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 7238a1b..2e0b222 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 8c4bb75..cd20c2f 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 972d41c..a420e39 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 15fd8df..46d627a 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index d8b2c5e..6c5b91d 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 646aa2b..fe8532e 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -1545,10 +1545,12 @@ Contrail Heat Resources.
     :keyword: MUST
 
     If a VNF's port is connected to an internal network and the
-    port is created in an Incremental Module and the internal network is created
-    in the Base Module then the UUID of the internal network **MUST** be exposed
+    port is created in an Incremental Module and the internal
+    network is created in the Base Module then the UUID of the
+    internal network **MUST** be exposed
     as a parameter in the 'outputs:' section of the Base Module and the port
     resource **MUST** use a 'get_param' to obtain the network UUID.
+
 ONAP does not programmatically enforce a naming convention for
 parameters for internal network. However, a naming convention is
 provided that must be followed.
@@ -3879,35 +3881,37 @@ YAML File
 
 .. code-block:: yaml
 
-  parameters:
-    vf_module_index:
-      type: number
-      description: Unique index for this VNF Module instance
-    oam_vm_name_0:
-      type: string
-      description: VM Name for lb VM 0
-    int_ctrl_net_id:
-      type: string
-      description: Neutron UUID for the internal control network
-    oam_vm_int_ctrl_ips:
-      type: comma_delimited_list
-      description: Fixed IP assignments for oam VMs on the internal control
-      network
-  resources:
-    oam_vm_server_0:
-      type: OS::Nova::Server
-      properties:
-        name: { get_param: oam_vm_name_0 }
-        networks:
-          - port: { get_resource: oam_vm_0_int_ctrl_port_0 }
-        . . .
-        metadata:
-          vf_module_index: { get_param: vf_module_index }
-    oam_vm_0_int_ctrl_port_0:
-      type: OS::Neutron::Port
-      properties:
-        network: { get_param: int_ctrl_net_id }
-        fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index]}}}]
+ parameters:
+   vf_module_index:
+     type: number
+     description: Unique index for this VNF Module instance
+   oam_vm_name_0:
+     type: string
+     description: VM Name for lb VM 0
+   int_ctrl_net_id:
+     type: string
+     description: Neutron UUID for the internal control network
+   oam_vm_int_ctrl_ips:
+     type: comma_delimited_list
+     description: Fixed IP assignments for oam VMs on the internal control
+     network
+ resources:
+   oam_vm_server_0:
+     type: OS::Nova::Server
+     properties:
+       name: { get_param: oam_vm_name_0 }
+       networks:
+         port: { get_resource: oam_vm_0_int_ctrl_port_0 }
+
+       . . .
+
+       metadata:
+         vf_module_index: { get_param: vf_module_index }
+   oam_vm_0_int_ctrl_port_0:
+     type: OS::Neutron::Port
+     properties:
+       network: { get_param: int_ctrl_net_id }
+       fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index}]}}]
 
 workload\_context
 ++++++++++++++++++
@@ -4854,14 +4858,14 @@ database.
       type: OS::Neutron::Port
       properties:
         network: { get_param: oam_net_id }
-        fixed_ips: [ { "ip_address": {get_param: db_oam_ip_0}}, { "ip_address": {get_param: db_oam_v6_ip_0 ]}}]
+        fixed_ips: [ { "ip_address": {get_param: db_oam_ip_0}}, { "ip_address": {get_param: db_oam_v6_ip_0 }}]
     db_1_oam_port_0:
       type: OS::Neutron::Port
       properties:
         network: { get_param: oam_net_id }
         fixed_ips:
-          - "ip_address": {get_param: db_oam_ip_1}}]
-          - "ip_address": {get_param: db_oam_v6_ip_1}}]
+          - "ip_address": {get_param: db_oam_ip_1}
+          - "ip_address": {get_param: db_oam_v6_ip_1}
 
 
 *Example: comma_delimited_list parameters for IPv4 and IPv6 Address
@@ -4933,14 +4937,14 @@ The {vm-type} has been defined as db for database.
       properties:
         network: { get_param: int_oam_int_net_id }
         fixed_ips: [ { "ip_address": {get_param: db_oam_int_ip_0}}, {
-        "ip_address": {get_param: db_oam_int_v6_ip_0 ]}}]
+        "ip_address": {get_param: db_oam_int_v6_ip_0 }}]
     db_1_int_ctrl_port_0:
       type: OS::Neutron::Port
       properties:
         network: { get_param: int_oam_int_net_id }
         fixed_ips:
-          - "ip_address": {get_param: db_oam_int_ip_1}}]
-          - "ip_address": {get_param: db_oam_int_v6_ip_1}}]
+          - "ip_address": {get_param: db_oam_int_ip_1}
+          - "ip_address": {get_param: db_oam_int_v6_ip_1}
 
 
 Property: fixed\_ips, Map Property: subnet\_id
@@ -7560,7 +7564,7 @@ OS::Heat::ResourceGroup:
    resource_def:
      type: my_nested_vm_template.yaml
      properties:
-       name: {get_param: [vm_name_list, %index%]}
+       name: {get_param: [vm_name_list, "%index%"]}
 
 Although this appears to use the nth entry of the vm_name_list list for
 the nth element of the OS::Heat::ResourceGroup, it will in fact result
@@ -7579,7 +7583,7 @@ ResourceGroup:
      type: my_nested_vm_template.yaml
      properties:
        names: {get_param: vm_name_list}
-       index: %index%
+       index: "%index%"
 
 You can then reference within the nested template as:
 
index 51c36bb..4ded8da 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index ac06e9c..b106dbc 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index e5babb5..6dc2940 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index f393135..7a801ec 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index c650f7a..225e8be 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -77,42 +77,42 @@ configuration update) is audited against the running configuration on the VNF.
 
 
 .. req::
-    :id: R-20741    
+    :id: R-20741
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **Configure** command.
 
 .. req::
-    :id: R-19366    
+    :id: R-19366
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **ConfigModify** command.
 
 .. req::
-    :id: R-32981    
+    :id: R-32981
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **ConfigBackup** command.
 
 .. req::
-    :id: R-48247    
+    :id: R-48247
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **ConfigRestore** command.
 
 .. req::
-    :id: R-94084    
+    :id: R-94084
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **ConfigScaleOut** command.
 
 .. req::
-    :id: R-56385    
+    :id: R-56385
     :target: XNF
     :keyword: MUST
 
@@ -168,63 +168,63 @@ failed).
 
 
 .. req::
-    :id: R-12706    
+    :id: R-12706
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **QuiesceTraffic** command.
 
 .. req::
-    :id: R-07251    
+    :id: R-07251
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **ResumeTraffic** command.
 
 .. req::
-    :id: R-83146    
+    :id: R-83146
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **StopApplication** command.
 
 .. req::
-    :id: R-82811    
+    :id: R-82811
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **StartApplication** command.
 
 .. req::
-    :id: R-19922    
+    :id: R-19922
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **UpgradePrecheck** command.
 
 .. req::
-    :id: R-49466    
+    :id: R-49466
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **UpgradeSoftware** command.
 
 .. req::
-    :id: R-45856    
+    :id: R-45856
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **UpgradePostCheck** command.
 
 .. req::
-    :id: R-97343    
+    :id: R-97343
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support ONAP Controller's **UpgradeBackup** command.
 
 .. req::
-    :id: R-65641    
+    :id: R-65641
     :target: XNF
     :keyword: MUST
 
@@ -249,7 +249,7 @@ must be supported.
 
 
 .. req::
-    :id: R-11790    
+    :id: R-11790
     :target: VNF
     :keyword: MUST
 
@@ -257,7 +257,7 @@ must be supported.
     **Restart (stop/start or reboot)** command.
 
 .. req::
-    :id: R-56218    
+    :id: R-56218
     :target: VNF
     :keyword: MUST
 
@@ -271,14 +271,14 @@ must be supported.
         Compute Node / Physical Server.
 
 .. req::
-    :id: R-38001    
+    :id: R-38001
     :target: VNF
     :keyword: MUST
 
     The VNF **MUST** support ONAP Controller's **Rebuild** command.
 
 .. req::
-    :id: R-76901    
+    :id: R-76901
     :target: VNF
     :keyword: MUST
 
@@ -301,7 +301,7 @@ automated fashion.
 
 
 .. req::
-    :id: R-41430    
+    :id: R-41430
     :target: XNF
     :keyword: MUST
 
@@ -353,7 +353,7 @@ Configuration Management
 
 
 .. req::
-    :id: R-88026    
+    :id: R-88026
     :target: XNF
     :keyword: MUST
 
@@ -361,7 +361,7 @@ Configuration Management
     runtime configuration and lifecycle management capabilities.
 
 .. req::
-    :id: R-95950    
+    :id: R-95950
     :target: XNF
     :keyword: MUST
 
@@ -373,7 +373,7 @@ NETCONF Server Requirements
 
 
 .. req::
-    :id: R-73468    
+    :id: R-73468
     :target: XNF
     :keyword: MUST
 
@@ -383,7 +383,7 @@ NETCONF Server Requirements
     service and SSH port numbers are Heat template parameters.
 
 .. req::
-    :id: R-90007    
+    :id: R-90007
     :target: XNF
     :keyword: MUST
 
@@ -391,7 +391,7 @@ NETCONF Server Requirements
     **close-session()**- Gracefully close the current session.
 
 .. req::
-    :id: R-70496    
+    :id: R-70496
     :target: XNF
     :keyword: MUST
 
@@ -400,7 +400,7 @@ NETCONF Server Requirements
     configuration datastore to the running configuration.
 
 .. req::
-    :id: R-18733    
+    :id: R-18733
     :target: XNF
     :keyword: MUST
 
@@ -409,7 +409,7 @@ NETCONF Server Requirements
     datastore to the running configuration.
 
 .. req::
-    :id: R-44281    
+    :id: R-44281
     :target: XNF
     :keyword: MUST
 
@@ -419,7 +419,7 @@ NETCONF Server Requirements
     replacing, creating, or deleting new config elements.
 
 .. req::
-    :id: R-60106    
+    :id: R-60106
     :target: XNF
     :keyword: MUST
 
@@ -429,7 +429,7 @@ NETCONF Server Requirements
     the list of xNF supported schemas.
 
 .. req::
-    :id: R-29488    
+    :id: R-29488
     :target: XNF
     :keyword: MUST
 
@@ -438,7 +438,7 @@ NETCONF Server Requirements
     a) configuration from the configuration datastore source.
 
 .. req::
-    :id: R-11235    
+    :id: R-11235
     :target: XNF
     :keyword: MUST
 
@@ -446,7 +446,7 @@ NETCONF Server Requirements
     **kill-session(session)** - Force the termination of **session**.
 
 .. req::
-    :id: R-02597    
+    :id: R-02597
     :target: XNF
     :keyword: MUST
 
@@ -454,7 +454,7 @@ NETCONF Server Requirements
     **lock(target)** - Lock the configuration datastore target.
 
 .. req::
-    :id: R-96554    
+    :id: R-96554
     :target: XNF
     :keyword: MUST
 
@@ -462,7 +462,7 @@ NETCONF Server Requirements
     **unlock(target)** - Unlock the configuration datastore target.
 
 .. req::
-    :id: R-29324    
+    :id: R-29324
     :target: XNF
     :keyword: SHOULD
 
@@ -471,7 +471,7 @@ NETCONF Server Requirements
     configuration datastore source to the configuration datastore target.
 
 .. req::
-    :id: R-88031    
+    :id: R-88031
     :target: XNF
     :keyword: SHOULD
 
@@ -480,7 +480,7 @@ NETCONF Server Requirements
     datastore target.
 
 .. req::
-    :id: R-97529    
+    :id: R-97529
     :target: XNF
     :keyword: SHOULD
 
@@ -488,7 +488,7 @@ NETCONF Server Requirements
     **get-schema(identifier, version, format) -** Retrieve the YANG schema.
 
 .. req::
-    :id: R-62468    
+    :id: R-62468
     :target: XNF
     :keyword: MUST
 
@@ -497,7 +497,7 @@ NETCONF Server Requirements
     NETCONF RPCs that make configuration changes are not sufficient.
 
 .. req::
-    :id: R-01382    
+    :id: R-01382
     :target: XNF
     :keyword: MUST
 
@@ -506,7 +506,7 @@ NETCONF Server Requirements
     of whether it was configured via NETCONF or other mechanisms.
 
 .. req::
-    :id: R-28756    
+    :id: R-28756
     :target: XNF
     :keyword: MUST
 
@@ -516,7 +516,7 @@ NETCONF Server Requirements
     part of the <running> configuration at the same time.
 
 .. req::
-    :id: R-83873    
+    :id: R-83873
     :target: XNF
     :keyword: MUST
 
@@ -528,7 +528,7 @@ NETCONF Server Requirements
     request.
 
 .. req::
-    :id: R-68990    
+    :id: R-68990
     :target: XNF
     :keyword: MUST
 
@@ -537,7 +537,7 @@ NETCONF Server Requirements
     database. It can also be locked and unlocked.
 
 .. req::
-    :id: R-68200    
+    :id: R-68200
     :target: XNF
     :keyword: MUST
 
@@ -549,7 +549,7 @@ NETCONF Server Requirements
     schemes allow for remote storage of configuration databases.
 
 .. req::
-    :id: R-20353    
+    :id: R-20353
     :target: XNF
     :keyword: MUST
 
@@ -558,7 +558,7 @@ NETCONF Server Requirements
     **:writable-running** are provided then two locks should be supported.
 
 .. req::
-    :id: R-11499    
+    :id: R-11499
     :target: XNF
     :keyword: MUST
 
@@ -572,14 +572,14 @@ NETCONF Server Requirements
     1.0 specification is supported.
 
 .. req::
-    :id: R-83790    
+    :id: R-83790
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** implement the **:validate** capability.
 
 .. req::
-    :id: R-49145    
+    :id: R-49145
     :target: XNF
     :keyword: MUST
 
@@ -587,7 +587,7 @@ NETCONF Server Requirements
     **:candidate** is supported.
 
 .. req::
-    :id: R-58358    
+    :id: R-58358
     :target: XNF
     :keyword: MUST
 
@@ -595,7 +595,7 @@ NETCONF Server Requirements
     [RFC6243].
 
 .. req::
-    :id: R-59610    
+    :id: R-59610
     :target: XNF
     :keyword: MUST
 
@@ -603,7 +603,7 @@ NETCONF Server Requirements
     download as defined in [RFC6022].
 
 .. req::
-    :id: R-93443    
+    :id: R-93443
     :target: XNF
     :keyword: MUST
 
@@ -611,7 +611,7 @@ NETCONF Server Requirements
     and the mapping to NETCONF shall follow the rules defined in this RFC.
 
 .. req::
-    :id: R-26115    
+    :id: R-26115
     :target: XNF
     :keyword: MUST
 
@@ -620,7 +620,7 @@ NETCONF Server Requirements
     be handled by a built-in automatic upgrade mechanism.
 
 .. req::
-    :id: R-10716    
+    :id: R-10716
     :target: XNF
     :keyword: MUST
 
@@ -628,7 +628,7 @@ NETCONF Server Requirements
     configuration of separate objects within itself.
 
 .. req::
-    :id: R-29495    
+    :id: R-29495
     :target: XNF
     :keyword: MUST
 
@@ -640,7 +640,7 @@ NETCONF Server Requirements
     operation on that same interface parameter).
 
 .. req::
-    :id: R-53015    
+    :id: R-53015
     :target: XNF
     :keyword: MUST
 
@@ -649,7 +649,7 @@ NETCONF Server Requirements
     out all others until completed.
 
 .. req::
-    :id: R-02616    
+    :id: R-02616
     :target: XNF
     :keyword: MUST
 
@@ -661,7 +661,7 @@ NETCONF Server Requirements
     if a non-overlapping parameter on the interface is being configured).
 
 .. req::
-    :id: R-41829    
+    :id: R-41829
     :target: XNF
     :keyword: MUST
 
@@ -669,7 +669,7 @@ NETCONF Server Requirements
     lock via a restricted or full XPath expression.
 
 .. req::
-    :id: R-66793    
+    :id: R-66793
     :target: XNF
     :keyword: MUST
 
@@ -680,7 +680,7 @@ NETCONF Server Requirements
     configuration method out).
 
 .. req::
-    :id: R-54190    
+    :id: R-54190
     :target: XNF
     :keyword: MUST
 
@@ -689,7 +689,7 @@ NETCONF Server Requirements
     is terminated).
 
 .. req::
-    :id: R-03465    
+    :id: R-03465
     :target: XNF
     :keyword: MUST
 
@@ -697,7 +697,7 @@ NETCONF Server Requirements
     when the corresponding <partial-unlock> operation succeeds.
 
 .. req::
-    :id: R-63935    
+    :id: R-63935
     :target: XNF
     :keyword: MUST
 
@@ -707,7 +707,7 @@ NETCONF Server Requirements
     setting of a lock expiration timer).
 
 .. req::
-    :id: R-10173    
+    :id: R-10173
     :target: XNF
     :keyword: MUST
 
@@ -716,7 +716,7 @@ NETCONF Server Requirements
     using the <kill-session> operation to guard against hung NETCONF sessions.
 
 .. req::
-    :id: R-88899    
+    :id: R-88899
     :target: XNF
     :keyword: MUST
 
@@ -724,7 +724,7 @@ NETCONF Server Requirements
     within the context of this locking requirements framework.
 
 .. req::
-    :id: R-07545    
+    :id: R-07545
     :target: XNF
     :keyword: MUST
 
@@ -733,33 +733,33 @@ NETCONF Server Requirements
     the supplied YANG code and associated NETCONF servers.
 
 .. req::
-    :id: R-60656    
+    :id: R-60656
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** support sub tree filtering.
 
 .. req::
-    :id: R-80898    
+    :id: R-80898
     :target: XNF
     :keyword: MUST
 
     TThe xNF **MUST** support heartbeat via a <get> with null filter.
 
 .. req::
-    :id: R-25238    
+    :id: R-25238
     :target: VNF
     :keyword: MUST
 
     The xNF PACKAGE **MUST** validated YANG code using the open
     source pyang [#7.3.1]_ program using the following commands:
 
-    .. code-block:: python
+    .. code-block:: text
 
-        $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!
+      $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!
 
 .. req::
-    :id: R-63953    
+    :id: R-63953
     :target: XNF
     :keyword: MUST
 
@@ -767,7 +767,7 @@ NETCONF Server Requirements
     otherwise the validation has failed.
 
 .. req::
-    :id: R-26508    
+    :id: R-26508
     :target: XNF
     :keyword: MUST
 
@@ -782,7 +782,7 @@ conform, and those where applicable, that suppliers need to use.
 
 
 .. req::
-    :id: R-28545    
+    :id: R-28545
     :target: XNF
     :keyword: MUST
 
@@ -791,7 +791,7 @@ conform, and those where applicable, that suppliers need to use.
     Protocol (NETCONF)".
 
 .. req::
-    :id: R-22700    
+    :id: R-22700
     :target: XNF
     :keyword: MUST
 
@@ -799,7 +799,7 @@ conform, and those where applicable, that suppliers need to use.
     "NETCONF Base Notifications".
 
 .. req::
-    :id: R-10353    
+    :id: R-10353
     :target: XNF
     :keyword: MUST
 
@@ -807,7 +807,7 @@ conform, and those where applicable, that suppliers need to use.
     "An Architecture for Network Management Using NETCONF and YANG".
 
 .. req::
-    :id: R-53317    
+    :id: R-53317
     :target: XNF
     :keyword: MUST
 
@@ -815,7 +815,7 @@ conform, and those where applicable, that suppliers need to use.
     "Guidelines for Authors and Reviewers of YANG Data Model Documents".
 
 .. req::
-    :id: R-33955    
+    :id: R-33955
     :target: XNF
     :keyword: SHOULD
 
@@ -823,7 +823,7 @@ conform, and those where applicable, that suppliers need to use.
     "Common YANG Data Types".
 
 .. req::
-    :id: R-22946    
+    :id: R-22946
     :target: XNF
     :keyword: SHOULD
 
@@ -831,7 +831,7 @@ conform, and those where applicable, that suppliers need to use.
     "NETCONF Access Control Model".
 
 .. req::
-    :id: R-10129    
+    :id: R-10129
     :target: XNF
     :keyword: SHOULD
 
@@ -839,7 +839,7 @@ conform, and those where applicable, that suppliers need to use.
     "A YANG Data Model for Interface Management".
 
 .. req::
-    :id: R-12271    
+    :id: R-12271
     :target: XNF
     :keyword: SHOULD
 
@@ -847,7 +847,7 @@ conform, and those where applicable, that suppliers need to use.
     "IANA Interface Type YANG Module".
 
 .. req::
-    :id: R-49036    
+    :id: R-49036
     :target: XNF
     :keyword: SHOULD
 
@@ -855,7 +855,7 @@ conform, and those where applicable, that suppliers need to use.
     "A YANG Data Model for IP Management".
 
 .. req::
-    :id: R-87564    
+    :id: R-87564
     :target: XNF
     :keyword: SHOULD
 
@@ -863,7 +863,7 @@ conform, and those where applicable, that suppliers need to use.
     "A YANG Data Model for System Management".
 
 .. req::
-    :id: R-24269    
+    :id: R-24269
     :target: XNF
     :keyword: SHOULD
 
@@ -876,7 +876,7 @@ NETCONF RFCs.
 
 
 .. req::
-    :id: R-33946    
+    :id: R-33946
     :target: XNF
     :keyword: MUST
 
@@ -884,7 +884,7 @@ NETCONF RFCs.
     "NETCONF Configuration Protocol".
 
 .. req::
-    :id: R-04158    
+    :id: R-04158
     :target: XNF
     :keyword: MUST
 
@@ -892,7 +892,7 @@ NETCONF RFCs.
     "Using the NETCONF Configuration Protocol over Secure Shell (SSH)".
 
 .. req::
-    :id: R-13800    
+    :id: R-13800
     :target: XNF
     :keyword: MUST
 
@@ -900,7 +900,7 @@ NETCONF RFCs.
     "NETCONF Event Notification".
 
 .. req::
-    :id: R-01334    
+    :id: R-01334
     :target: XNF
     :keyword: MUST
 
@@ -908,15 +908,15 @@ NETCONF RFCs.
     "Partial Lock Remote Procedure Call".
 
 .. req::
-    :id: R-08134    
+    :id: R-08134
     :target: XNF
     :keyword: MUST
 
-    The xNF **MUST** conform to the NETCONF RFC 6241, 
+    The xNF **MUST** conform to the NETCONF RFC 6241,
     "NETCONF Configuration Protocol".
 
 .. req::
-    :id: R-78282    
+    :id: R-78282
     :target: XNF
     :keyword: MUST
 
@@ -952,7 +952,7 @@ REST APIs
 
 
 .. req::
-    :id: R-31809    
+    :id: R-31809
     :target: XNF
     :keyword: MUST
 
@@ -1018,7 +1018,7 @@ Chef Client Requirements
 
 
 .. req::
-    :id: R-79224    
+    :id: R-79224
     :target: XNF
     :keyword: MUST
 
@@ -1027,7 +1027,7 @@ Chef Client Requirements
     Chef Server as part of the installation process.
 
 .. req::
-    :id: R-72184    
+    :id: R-72184
     :target: XNF
     :keyword: MUST
 
@@ -1037,7 +1037,7 @@ Chef Client Requirements
     trigger push jobs against FQDNs of endpoints for a xNF, if required.
 
 .. req::
-    :id: R-47068    
+    :id: R-47068
     :target: XNF
     :keyword: MAY
 
@@ -1045,7 +1045,7 @@ Chef Client Requirements
     responsible for all functionality.
 
 .. req::
-    :id: R-67114    
+    :id: R-67114
     :target: VNF
     :keyword: MUST
 
@@ -1057,7 +1057,7 @@ Chef Roles/Requirements
 
 
 .. req::
-    :id: R-27310    
+    :id: R-27310
     :target: XNF
     :keyword: MUST
 
@@ -1066,7 +1066,7 @@ Chef Roles/Requirements
     ONAP for loading on appropriate Chef Server.
 
 .. req::
-    :id: R-26567    
+    :id: R-26567
     :target: XNF
     :keyword: MUST
 
@@ -1078,7 +1078,7 @@ Chef Roles/Requirements
     in JSON file.
 
 .. req::
-    :id: R-98911    
+    :id: R-98911
     :target: XNF
     :keyword: MUST NOT
 
@@ -1086,7 +1086,7 @@ Chef Roles/Requirements
     for the xNF in roles/cookbooks/recipes invoked for a xNF action.
 
 .. req::
-    :id: R-37929    
+    :id: R-37929
     :target: XNF
     :keyword: MUST
 
@@ -1095,7 +1095,7 @@ Chef Roles/Requirements
     in roles/cookbooks/recipes invoked for a xNF action.
 
 .. req::
-    :id: R-62170    
+    :id: R-62170
     :target: XNF
     :keyword: MUST
 
@@ -1104,7 +1104,7 @@ Chef Roles/Requirements
     cookbooks and recipes.
 
 .. req::
-    :id: R-78116    
+    :id: R-78116
     :target: XNF
     :keyword: MUST
 
@@ -1114,7 +1114,7 @@ Chef Roles/Requirements
     executing a xNF action.
 
 .. req::
-    :id: R-44013    
+    :id: R-44013
     :target: XNF
     :keyword: MUST
 
@@ -1124,7 +1124,7 @@ Chef Roles/Requirements
     chef-client run be made available (e.g., get running configuration).
 
 .. req::
-    :id: R-30654    
+    :id: R-30654
     :target: XNF
     :keyword: MUST
 
@@ -1133,7 +1133,7 @@ Chef Roles/Requirements
     any errors for actions that change state of the xNF (e.g., configure).
 
 .. req::
-    :id: R-65755    
+    :id: R-65755
     :target: XNF
     :keyword: SHOULD
 
@@ -1151,7 +1151,7 @@ Chef Roles/Requirements
        the chef-client run need not post the results back via callback.
 
 .. req::
-    :id: R-15885    
+    :id: R-15885
     :target: XNF
     :keyword: MUST
 
@@ -1197,15 +1197,16 @@ action request against a Chef managed VNF.
 
 .. code-block:: java
 
-   {
-     "command": "chef-client",
-     "run\_timeout": 300,
-     "nodes”: [“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”],
-       "env": {
-                “RequestId”:”8279-abcd-aksdj-19231”,
-                “CallbackUrl”:”<callback>”
-              },
-   }
+  {
+   "command": "chef-client"
+   "run\_timeout": 300
+   "nodes": ["node1.vnf\_a.onap.com", "node2.vnf\_a.onap.com"]
+     "env": {
+              "RequestId":"8279-abcd-aksdj-19231"
+              "CallbackUrl":"<callback>"
+            }
+  }
+
 
 5. If CallbackCapable field in the template is not present or set to
    “False” ONAP will poll the Chef Server to check completion status of
@@ -1238,7 +1239,7 @@ Ansible Client Requirements
 
 
 .. req::
-    :id: R-32217    
+    :id: R-32217
     :target: XNF
     :keyword: MUST
 
@@ -1248,7 +1249,7 @@ Ansible Client Requirements
     for invocation of playbooks against these end points [#7.3.3]_.
 
 .. req::
-    :id: R-54373    
+    :id: R-54373
     :target: XNF
     :keyword: MUST
 
@@ -1256,7 +1257,7 @@ Ansible Client Requirements
     of a xNF on which an Ansible playbook will be executed.
 
 .. req::
-    :id: R-35401    
+    :id: R-35401
     :target: XNF
     :keyword: MUST
 
@@ -1265,7 +1266,7 @@ Ansible Client Requirements
     Cloud Service Provider guidelines for authentication and access.
 
 .. req::
-    :id: R-82018    
+    :id: R-82018
     :target: XNF
     :keyword: MUST
 
@@ -1282,7 +1283,7 @@ Ansible Client Requirements
     (userdata) scripts.
 
 .. req::
-    :id: R-92866    
+    :id: R-92866
     :target: XNF
     :keyword: MUST
 
@@ -1293,7 +1294,7 @@ Ansible Client Requirements
     new SSH keys and new mechanized IDs.
 
 .. req::
-    :id: R-91745    
+    :id: R-91745
     :target: XNF
     :keyword: MUST
 
@@ -1313,7 +1314,7 @@ complete the desired action.
 
 
 .. req::
-    :id: R-40293    
+    :id: R-40293
     :target: XNF
     :keyword: MUST
 
@@ -1321,7 +1322,7 @@ complete the desired action.
     to the ONAP requirement.
 
 .. req::
-    :id: R-49396    
+    :id: R-49396
     :target: XNF
     :keyword: MUST
 
@@ -1331,7 +1332,7 @@ complete the desired action.
     to complete the request.
 
 .. req::
-    :id: R-33280    
+    :id: R-33280
     :target: XNF
     :keyword: MUST NOT
 
@@ -1339,7 +1340,7 @@ complete the desired action.
     in a playbook.
 
 .. req::
-    :id: R-48698    
+    :id: R-48698
     :target: XNF
     :keyword: MUST
 
@@ -1359,7 +1360,7 @@ will be considered to have failed.
 
 
 .. req::
-    :id: R-43253    
+    :id: R-43253
     :target: XNF
     :keyword: MUST
 
@@ -1371,7 +1372,7 @@ will be considered to have failed.
     accordingly (failure for failed tasks).
 
 .. req::
-    :id: R-50252    
+    :id: R-50252
     :target: XNF
     :keyword: MUST
 
@@ -1385,7 +1386,7 @@ will be considered to have failed.
     respective VM/xNF must be written.
 
 .. req::
-    :id: R-51442    
+    :id: R-51442
     :target: XNF
     :keyword: SHOULD
 
@@ -1401,7 +1402,7 @@ will be considered to have failed.
         rollback when soft rollback is feasible.
 
 .. req::
-    :id: R-58301    
+    :id: R-58301
     :target: XNF
     :keyword: SHOULD NOT
 
@@ -1420,7 +1421,7 @@ will be considered to have failed.
     to Event Bus.
 
 .. req::
-    :id: R-02651    
+    :id: R-02651
     :target: XNF
     :keyword: SHOULD
 
@@ -1431,7 +1432,7 @@ will be considered to have failed.
     changes when needed.
 
 .. req::
-    :id: R-43353    
+    :id: R-43353
     :target: XNF
     :keyword: MUST
 
index 4ef2eae..3265e96 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -347,7 +347,7 @@ VNF telemetry via standardized interface
 
 
 .. req::
-    :id: R-51910    
+    :id: R-51910
     :target: XNF
     :keyword: MUST
 
@@ -365,7 +365,7 @@ JSON
 
 
 .. req::
-    :id: R-19624    
+    :id: R-19624
     :target: XNF
     :keyword: MUST
 
@@ -440,7 +440,7 @@ Reporting Frequency
 ~~~~~~~~~~~~~~~~~~~~~
 
 .. req::
-    :id: R-98191    
+    :id: R-98191
     :target: XNF
     :keyword: MUST
 
@@ -480,7 +480,7 @@ streaming, or by host name and landing zone directory for SFTP transfer
 of bulk files.
 
 .. req::
-    :id: R-88482    
+    :id: R-88482
     :target: XNF
     :keyword: SHOULD
 
@@ -489,7 +489,7 @@ of bulk files.
     volume data sets when feasible.
 
 .. req::
-    :id: R-84879    
+    :id: R-84879
     :target: XNF
     :keyword: MUST
 
@@ -503,7 +503,7 @@ of bulk files.
     failure transparently to the xNF.
 
 .. req::
-    :id: R-81777    
+    :id: R-81777
     :target: XNF
     :keyword: MUST
 
@@ -514,7 +514,7 @@ of bulk files.
     will be controlled by policy.
 
 .. req::
-    :id: R-08312    
+    :id: R-08312
     :target: XNF
     :keyword: MAY
 
@@ -522,7 +522,7 @@ of bulk files.
     delivery of binary encoded data sets.
 
 .. req::
-    :id: R-79412    
+    :id: R-79412
     :target: XNF
     :keyword: MAY
 
@@ -532,7 +532,7 @@ of bulk files.
     sets.
 
 .. req::
-    :id: R-01033    
+    :id: R-01033
     :target: XNF
     :keyword: MAY
 
@@ -543,7 +543,7 @@ of bulk files.
     data sets, and deliver these by REST or TCP as appropriate.)
 
 .. req::
-    :id: R-63229    
+    :id: R-63229
     :target: XNF
     :keyword: MAY
 
@@ -551,7 +551,7 @@ of bulk files.
     for synchronous data, using RESTCONF (e.g., for xNF state polling).
 
 .. req::
-    :id: R-03070    
+    :id: R-03070
     :target: XNF
     :keyword: MUST
 
@@ -565,7 +565,7 @@ Asynchronous and Synchronous Data Delivery
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. req::
-    :id: R-06924    
+    :id: R-06924
     :target: XNF
     :keyword: MUST
 
@@ -573,7 +573,7 @@ Asynchronous and Synchronous Data Delivery
     available, or according to the configured frequency.
 
 .. req::
-    :id: R-73285    
+    :id: R-73285
     :target: XNF
     :keyword: MUST
 
@@ -581,7 +581,7 @@ Asynchronous and Synchronous Data Delivery
     as described in the previous paragraphs.
 
 .. req::
-    :id: R-42140    
+    :id: R-42140
     :target: XNF
     :keyword: MUST
 
@@ -589,7 +589,7 @@ Asynchronous and Synchronous Data Delivery
     as those requests are received, as a synchronous response.
 
 .. req::
-    :id: R-34660    
+    :id: R-34660
     :target: XNF
     :keyword: MUST
 
@@ -597,7 +597,7 @@ Asynchronous and Synchronous Data Delivery
     the ONAP configuration subsystem for synchronous communication.
 
 .. req::
-    :id: R-86586    
+    :id: R-86586
     :target: XNF
     :keyword: MUST
 
@@ -605,7 +605,7 @@ Asynchronous and Synchronous Data Delivery
     [RFC8040] (https://tools.ietf.org/html/rfc8040).
 
 .. req::
-    :id: R-11240    
+    :id: R-11240
     :target: XNF
     :keyword: MUST
 
@@ -614,7 +614,7 @@ Asynchronous and Synchronous Data Delivery
     synchronous communication will be consistent with Avro.
 
 .. req::
-    :id: R-70266    
+    :id: R-70266
     :target: XNF
     :keyword: MUST
 
@@ -627,7 +627,7 @@ Asynchronous and Synchronous Data Delivery
     in the future as they become standardized and are made available.)
 
 .. req::
-    :id: R-46290    
+    :id: R-46290
     :target: XNF
     :keyword: MUST
 
@@ -636,7 +636,7 @@ Asynchronous and Synchronous Data Delivery
     configuration model for the xNF by returning the requested data elements.
 
 .. req::
-    :id: R-43327    
+    :id: R-43327
     :target: XNF
     :keyword: SHOULD
 
@@ -650,7 +650,7 @@ Security
 ~~~~~~~~~~
 
 .. req::
-    :id: R-42366    
+    :id: R-42366
     :target: XNF
     :keyword: MUST
 
@@ -661,7 +661,7 @@ Security
     `RFC7525 <https://tools.ietf.org/html/rfc7525>`_.
 
 .. req::
-    :id: R-44290    
+    :id: R-44290
     :target: XNF
     :keyword: MUST
 
@@ -669,14 +669,14 @@ Security
     of connections, through secure credentials, log-on and exchange mechanisms.
 
 .. req::
-    :id: R-47597    
+    :id: R-47597
     :target: XNF
     :keyword: MUST
 
     The xNF **MUST** carry data in motion only over secure connections.
 
 .. req::
-    :id: R-68165    
+    :id: R-68165
     :target: XNF
     :keyword: MUST
 
index 472badc..bb0f9f7 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 0d23911..26ecf8e 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -29,7 +29,7 @@ Resource Description
 
 
 .. req::
-    :id: R-77707    
+    :id: R-77707
     :target: XNF
     :keyword: MUST
 
@@ -37,7 +37,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 +47,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 +59,7 @@ Resource Description
     after xNF instantiation.
 
 .. req::
-    :id: R-00156    
+    :id: R-00156
     :target: XNF
     :keyword: MUST
 
@@ -69,7 +69,7 @@ Resource Description
     healing and/or scaling responses).
 
 .. req::
-    :id: R-00068    
+    :id: R-00068
     :target: XNF
     :keyword: MUST
 
@@ -79,7 +79,7 @@ Resource Description
     plane, etc.) generated by the xNF after instantiation.
 
 .. req::
-    :id: R-12678    
+    :id: R-12678
     :target: XNF
     :keyword: MUST
 
@@ -88,7 +88,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 +99,7 @@ Resource Description
     format and protocols supported.
 
 .. req::
-    :id: R-36280    
+    :id: R-36280
     :target: XNF
     :keyword: MUST
 
@@ -108,7 +108,7 @@ Resource Description
     xNF and compose complex services.
 
 .. req::
-    :id: R-98617    
+    :id: R-98617
     :target: XNF
     :keyword: MUST
 
@@ -120,7 +120,7 @@ Resource Configuration
 
 
 .. req::
-    :id: R-89571    
+    :id: R-89571
     :target: XNF
     :keyword: MUST
 
@@ -137,7 +137,7 @@ Configuration Management via NETCONF/YANG
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. req::
-    :id: R-30278    
+    :id: R-30278
     :target: XNF
     :keyword: MUST
 
@@ -151,7 +151,7 @@ Configuration Management via Chef
 
 
 .. req::
-    :id: R-13390    
+    :id: R-13390
     :target: XNF
     :keyword: MUST
 
@@ -159,7 +159,7 @@ Configuration Management via Chef
     on the appropriate Chef Server.
 
 .. req::
-    :id: R-18525    
+    :id: R-18525
     :target: XNF
     :keyword: MUST
 
@@ -177,7 +177,7 @@ Configuration Management via Ansible
 
 
 .. req::
-    :id: R-75608    
+    :id: R-75608
     :target: XNF
     :keyword: MUST
 
@@ -185,7 +185,7 @@ Configuration Management via Ansible
     on the appropriate Ansible Server.
 
 .. req::
-    :id: R-16777    
+    :id: R-16777
     :target: XNF
     :keyword: MUST
 
@@ -196,7 +196,7 @@ Configuration Management via Ansible
     in the Appendix.
 
 .. req::
-    :id: R-46567    
+    :id: R-46567
     :target: XNF
     :keyword: MUST
 
@@ -204,7 +204,7 @@ Configuration Management via Ansible
     for boot sequence and configuration.
 
 .. req::
-    :id: R-16065    
+    :id: R-16065
     :target: XNF
     :keyword: MUST
 
@@ -218,7 +218,7 @@ Resource Control Loop
 
 
 .. req::
-    :id: R-22888    
+    :id: R-22888
     :target: XNF
     :keyword: MUST
 
@@ -228,7 +228,7 @@ Resource Control Loop
     are implemented in the xNF.
 
 .. req::
-    :id: R-01556    
+    :id: R-01556
     :target: XNF
     :keyword: MUST
 
@@ -237,7 +237,7 @@ Resource Control Loop
     that are made available by the xNF.
 
 .. req::
-    :id: R-16875    
+    :id: R-16875
     :target: XNF
     :keyword: MUST
 
@@ -247,7 +247,7 @@ Resource Control Loop
     Root Cause Analysis and resolve the issue.
 
 .. req::
-    :id: R-35960    
+    :id: R-35960
     :target: XNF
     :keyword: MUST
 
@@ -256,7 +256,7 @@ Resource Control Loop
     descriptions including causes/fixes if applicable for the event.
 
 .. req::
-    :id: R-42018    
+    :id: R-42018
     :target: XNF
     :keyword: MUST
 
@@ -265,7 +265,7 @@ Resource Control Loop
     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.
 
 .. req::
-    :id: R-27711    
+    :id: R-27711
     :target: XNF
     :keyword: MUST
 
@@ -274,7 +274,7 @@ Resource Control Loop
     causes/corrective action.
 
 .. req::
-    :id: R-01478    
+    :id: R-01478
     :target: XNF
     :keyword: MUST
 
@@ -284,7 +284,7 @@ Resource Control Loop
     collected for reporting purposes.
 
 .. req::
-    :id: R-73560    
+    :id: R-73560
     :target: XNF
     :keyword: MUST
 
@@ -293,7 +293,7 @@ Resource Control Loop
     application management.
 
 .. req::
-    :id: R-90632    
+    :id: R-90632
     :target: XNF
     :keyword: MUST
 
@@ -302,7 +302,7 @@ Resource Control Loop
     and performance management purposes.
 
 .. req::
-    :id: R-86235    
+    :id: R-86235
     :target: XNF
     :keyword: MUST
 
@@ -313,7 +313,7 @@ Resource Control Loop
     its function.
 
 .. req::
-    :id: R-33904    
+    :id: R-33904
     :target: XNF
     :keyword: MUST
 
@@ -321,7 +321,7 @@ Resource Control Loop
     lower and upper limits.
 
 .. req::
-    :id: R-53598    
+    :id: R-53598
     :target: XNF
     :keyword: MUST
 
@@ -330,7 +330,7 @@ Resource Control Loop
     significance of the threshold crossing.
 
 .. req::
-    :id: R-69877    
+    :id: R-69877
     :target: XNF
     :keyword: MUST
 
@@ -339,7 +339,7 @@ Resource Control Loop
     threshold crossing alert event is recorded.
 
 .. req::
-    :id: R-22680    
+    :id: R-22680
     :target: XNF
     :keyword: MUST
 
@@ -349,7 +349,7 @@ Resource Control Loop
     of the xNF.
 
 .. req::
-    :id: R-33694    
+    :id: R-33694
     :target: XNF
     :keyword: MUST
 
@@ -358,7 +358,7 @@ Resource Control Loop
     artifacts.
 
 .. req::
-    :id: R-56815    
+    :id: R-56815
     :target: XNF
     :keyword: MUST
 
@@ -367,7 +367,7 @@ Resource Control Loop
     of users, bandwidth, throughput, concurrent calls).
 
 .. req::
-    :id: R-48596    
+    :id: R-48596
     :target: XNF
     :keyword: MUST
 
@@ -375,7 +375,7 @@ Resource Control Loop
     the characteristics for the xNF reliability and high availability.
 
 .. req::
-    :id: R-74763    
+    :id: R-74763
     :target: XNF
     :keyword: MUST
 
@@ -390,7 +390,7 @@ Compute, Network, and Storage Requirements
 
 
 .. req::
-    :id: R-35851    
+    :id: R-35851
     :target: XNF
     :keyword: MUST
 
@@ -400,7 +400,7 @@ Compute, Network, and Storage Requirements
     applicable) for each interface.
 
 .. req::
-    :id: R-97102    
+    :id: R-97102
     :target: VNF
     :keyword: MUST
 
@@ -409,7 +409,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 +418,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 +427,7 @@ Compute, Network, and Storage Requirements
     redundancy model.
 
 .. req::
-    :id: R-55802    
+    :id: R-55802
     :target: VNF
     :keyword: MUST
 
@@ -438,7 +438,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 +446,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,7 +458,7 @@ Testing
 
 
 .. req::
-    :id: R-43958    
+    :id: R-43958
     :target: XNF
     :keyword: MUST
 
@@ -466,7 +466,7 @@ Testing
     the tests that were conducted by the xNF providor and the test results.
 
 .. req::
-    :id: R-04298    
+    :id: R-04298
     :target: XNF
     :keyword: MUST
 
@@ -474,7 +474,7 @@ Testing
     support testing.
 
 .. req::
-    :id: R-58775    
+    :id: R-58775
     :target: XNF
     :keyword: MUST
 
@@ -489,7 +489,7 @@ Licensing Requirements
 
 
 .. req::
-    :id: R-85653    
+    :id: R-85653
     :target: XNF
     :keyword: MUST
 
@@ -498,7 +498,7 @@ Licensing Requirements
     every license.
 
 .. req::
-    :id: R-44125    
+    :id: R-44125
     :target: XNF
     :keyword: MUST
 
@@ -507,7 +507,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 +515,7 @@ Licensing Requirements
     source licenses their xNF(s) incorporate.
 
 .. req::
-    :id: R-97293    
+    :id: R-97293
     :target: XNF
     :keyword: MUST NOT
 
@@ -523,7 +523,7 @@ Licensing Requirements
     of Service Provider's business.
 
 .. req::
-    :id: R-44569    
+    :id: R-44569
     :target: XNF
     :keyword: MUST NOT
 
@@ -532,7 +532,7 @@ Licensing Requirements
     functions and metrics.
 
 .. req::
-    :id: R-13613    
+    :id: R-13613
     :target: VNF
     :keyword: MUST
 
@@ -540,7 +540,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 +550,7 @@ Licensing Requirements
     restrictions based upon VNF provider permissions.
 
 .. req::
-    :id: R-85991    
+    :id: R-85991
     :target: XNF
     :keyword: MUST
 
@@ -562,7 +562,7 @@ Licensing Requirements
     be resolved without interrupting in-service xNFs.
 
 .. req::
-    :id: R-47849    
+    :id: R-47849
     :target: XNF
     :keyword: MUST
 
index e5c1462..d8f7b33 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 4fd051c..764010c 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -83,17 +83,17 @@ Ansible JSON file example:
 
   {
 
-    “Action”:”Configure”,
+    "Action":"Configure",
 
     "PlaybookName": "<VNFCode>/<Version>/ansible/configure/site.yml",
 
-    "NodeList": ["test1.vnf\_b.onap.com", “test2.vnf\_b.onap.com”],
+    "NodeList": ["test1.vnf_b.onap.com", "test2.vnf_b.onap.com"],
 
     "Timeout": 60,
 
-    "EnvParameters": {"Retry": 3, "Wait": 5, “ConfigFile”:”config.txt”},
+    "EnvParameters": {"Retry": 3, "Wait": 5, "ConfigFile":"config.txt"},
 
-    “FileParameters”:{“config.txt”:”db\_ip=10.1.1.1, sip\_timer=10000”}
+    "FileParameters": {"config.txt":"db_ip=10.1.1.1, sip_timer=10000"}
 
   }
 
index 4be9944..ed685ba 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -18,7 +18,7 @@ values are kept or created in separate directories.
 Example of an Ansible command (after pwd) to run playbook again
 vfdb9904v VNF instance:
 
-.. code-block:: none
+.. code-block:: text
 
  $ pwd
  /storage/vfdb/V16.1/ansible/configure
@@ -37,7 +37,7 @@ Specifications:
 An example of a curl request simulating a Rest API POST requesting execution
 of configure Playbook (using playbook relative path):
 
-.. code-block:: none
+.. code-block:: text
 
  curl -u APIUser:APIPassword -H "Content-type:application/json" -X POST
  -d '{"Id": "8412", "PlaybookName": "vfdb/V5.x.x/ansible/configure/site.yml",
@@ -47,7 +47,7 @@ of configure Playbook (using playbook relative path):
 Rest API GET request to obtain response/results for prior request
 (same Id as POST request above):
 
-.. code-block:: none
+.. code-block:: text
 
  curl -u APIUser:APIPassword -H 'Content-type: application/json' -X GET
  'http://ansible.server.com:5000/Dispatch/?Id=8412&Type=GetResult'
@@ -68,7 +68,7 @@ Ansible Playbooks will use the VNF instance name (passed using
 to run the playbook(s) against the target VNF instance. Same example as
 above:
 
-.. code-block:: none
+.. code-block:: text
 
  $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v"
 
@@ -78,7 +78,7 @@ SSH keys that may be rotated regularly. Here hosts file, no longer referencing
 file with SSH key credentials, to run ansible-playbook listed in this example
 above (IP addresses were scrubbed):
 
-.. code-block:: none
+.. code-block:: text
 
  $ more ../inventory/vfdb9904v/hosts
  [host]
@@ -110,7 +110,7 @@ from other sources, inventory database, etc.
 And here the scrubbed default arguments for this VNF instance(originated
 from previously re-factored playbooks now being phased out):
 
-.. code-block:: none
+.. code-block:: text
 
  vnf_instance=vfdb9904v
 
@@ -125,7 +125,7 @@ vm\_config\_oam\_vnfc\_name, as an example, is derived from vm\_config
 array structure (list) in the CSAR package ENV file, with dots replaced
 by underscore:
 
-.. code-block:: none
+.. code-block:: text
 
  vm_config:
 
@@ -144,7 +144,7 @@ used as defaults. For parameterized playbooks attribute-value pairs
 passed down by APPC to Ansible Server always take precedence over
 template or VNF instance specific defaults stored in defaults file(s).
 
-.. code-block:: none
+.. code-block:: text
 
  $ pwd
  /storage/vfdb/latest/ansible
@@ -184,7 +184,7 @@ instance specific set of attribute-value pairs to be used for the run, in
 INI format. Here is an excerpt from such a file that should look
 somewhat similar to ENV files:
 
-.. code-block:: none
+.. code-block:: text
 
  $ more tmp/vfdb9904v/all.yml
 
@@ -201,7 +201,7 @@ somewhat similar to ENV files:
 
 # logins list contain 'login name', 'login group', 'login password'
 
-.. code-block:: none
+.. code-block:: text
 
  logins:
  - { name: 'm99999', group: 'm99999', password: 'abcdefgha' }
@@ -377,47 +377,47 @@ Ansible Servers. Generic directory structure:
 
 Ansible Playbooks – Function directory and main playbook:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/<Playbook Function>/site.yml
 
 Example – Post-instantiation (bulk) configuration –APPC Function -
 Configure:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/configure/site.yml
 
 Example – Post-instantiation (bulk) configuration –APPC Function
 – Configure – VNF software version 16.1:
 
-.. code-block:: none
+.. code-block:: text
 
  vfdb/V16.1/ansible/configure/site.yml
 
 Example – Health-check –APPC Function - HealthCheck:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/healthcheck/site.yml
 
 OR (Function directory name does not need to match APPC function name)
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/check/site.yml
 
 Ansible Directories for other artifacts – VNF inventory hosts file -
 Required:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/inventory/<VNF instance name>hosts
 
 Ansible Directories for other artifacts – VNF instance specific default
 arguments – Optional:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/group_vars/<VNF instance name>
 
@@ -431,7 +431,7 @@ management mechanisms/tools/solutions.
 Ansible Directories for other artifacts – VNF (special) groups –
 Optional:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/inventory/group_vars/<VNF instance name>
 
@@ -441,7 +441,7 @@ on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, 
 Ansible Directories for other artifacts – VNF (special) other files –
 Optional – Example – License file:
 
-.. code-block:: none
+.. code-block:: text
 
  <VNF type>/<Version>/ansible/<Other directory(s)>
 
@@ -459,7 +459,7 @@ CAUTION: On referenced files used/required by playbooks.
 -  This is the ansible (root) directory referenced on this
    note (Ansible Server mount point not included):
 
-.. code-block:: none
+.. code-block:: text
 
      <VNF type>/<Version>/ansible/
 
@@ -515,14 +515,14 @@ Ansible Server.
    c. Include generic ansible root directory. Creating full directory
       path as an example:
 
-.. code-block:: none
+.. code-block:: text
 
      $ mkdir –p /storage/vfdb/V16.1/ansible**/**
 
 3. Make this directory (VNF ansible root directory) current directory
    for next few steps:
 
-.. code-block:: none
+.. code-block:: text
 
      cd /storage/vfdb/V16.1/ansible/
 
@@ -530,7 +530,7 @@ Ansible Server.
    the playbooks onto the ansible directory. Command depends on the type
    of file uploaded, examples would be:
 
-.. code-block:: none
+.. code-block:: text
 
      tar xvf ..
      unzip …
@@ -540,7 +540,7 @@ Ansible Server.
    OA&M IP addresses for all VNF instances with known OA&M IP addresses
    for respective VMs, example:
 
-.. code-block:: none
+.. code-block:: text
 
     $ mkdir inventory
 
@@ -563,7 +563,7 @@ Ansible Server.
 arguments for each VNF instance,
 example:
 
-.. code-block:: none
+.. code-block:: text
 
    $ mkdir –p vars/vfdb9904v
    $ touch vars/vfdb9904v/default\_args.yml
@@ -615,7 +615,7 @@ playbooks are run.
 
 UpgradePreCheck:
 
-.. code-block:: none
+.. code-block:: text
 
  $ pwd
  /storage/comx/V5.3.1.3/ansible/upgradeprecheck
@@ -661,7 +661,7 @@ UpgradePreCheck:
 
 UpgradePostCheck:
 
-.. code-block:: none
+.. code-block:: text
 
  $ pwd
  /storage/comx/V5.3.1.3/ansible/upgradepostcheck
index 8a51a85..e74cf55 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -79,7 +79,7 @@ Table A1. Chef JSON File key value description
 
 Chef Template example:
 
-.. code-block:: chef
+.. code-block:: erb
 
  “Environment”:{
       "name": "HAR",
index 6cdad72..4a680c4 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index d571173..836df62 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index dfe2255..7fcbcac 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
index 9556a16..4d41533 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -8,4 +8,6 @@ Requirement List
 
 .. needtable::
    :style: datatables
-   :columns: id;content;target;keyword;section_name
\ No newline at end of file
+   :columns: id;content;target;keyword;section_name
+
+
index ef0d8f5..b5ca332 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
 
@@ -18,4 +18,5 @@ VNF Requirements Documentation
     Chapter6/index
     Chapter7/index
     Chapter8/index
-    Chapter9/index
\ No newline at end of file
+    Chapter9/index
+
index a537d44..d3da38e 100644 (file)
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.