Updating the docs to include NST selection enhancements

Issue-ID: OPTFRA-942
Signed-off-by: hariharan97 <rh20085046@wipro.com>
Change-Id: Ic1e059d1ce31591ee4ac7b1d0884f2d68107b064

diff --git a/docs/sections/example.rst b/docs/sections/example.rst
index c2254e0..a511e8e 100644 (file)
--- a/docs/sections/example.rst
+++ b/docs/sections/example.rst
@@ -312,6 +312,73 @@ constraint specifies that the latency of the the subnets must be less
 than a particular threshold.
 
 
+Example 4
+---------
+
+.. code:: json
+
+       {
+               "name":"urllc_sample",
+               "files":{
+ 
+               },
+               "limit":10,
+               "num_solution":"1",
+               "timeout":1200,
+               "template":{
+                       "homing_template_version":"2020-08-13",
+                       "demands":{
+                       "nst_demand":[
+                               {
+               "inventory_provider":"aai",
+               "inventory_type":"nst",
+               "unique":"true",
+               "region":"RegionOne",
+               "filtering_attributes":{
+                  "model-role":"nst"
+                                       }
+                               }
+                       ]
+               },
+               "constraints":{
+                       "nst_Threshold":{
+            "type":"threshold",
+            "demands":[
+               "nst_demand"
+            ],
+            "properties":{
+               "evaluate":[
+                  {
+                     "attribute":"latency",
+                     "operator":"lte",
+                     "threshold":30,
+                     "unit":"ms"
+                  }
+               ]
+             }
+           }
+           },
+               "optimization":{
+                       "goal": "minimize",
+                       "operation_function": {
+                               "operator": "sum",
+                               "operands": [{
+                               "function": "attribute",
+                               "params": {
+                  "demand": "nst_demand",
+                  "attribute": "latency"
+                               }
+                               }]
+                       }
+           }
+         }
+       }
+
+This template is for the selecting the NST templates for Network
+Slicing use case. The demand here is the slice templates and the threshold
+constraint specifies that the latency of the the templates must be less
+than a particular threshold.
+
 Contact
 -------
 

diff --git a/docs/sections/homingspecification.rst b/docs/sections/homingspecification.rst
index 4950a9a..ae09208 100644 (file)
--- a/docs/sections/homingspecification.rst
+++ b/docs/sections/homingspecification.rst
@@ -249,8 +249,9 @@ Demand criteria is dependent upon the inventory provider in use.
 |                             | existing service instances),       |
 |                             | ``vfmodule`` (for vf instances),   |
 |                             | ``nssi`` (for slice subnet         |
-|                             | instances). Exactly one inventory  |
-|                             | type may be specified.             |
+|                             | instances), ``nst`` (for slice     | 
+|                             | templates). Exactly one            |
+|                            | inventory type may be specified.   |                                   
 +-----------------------------+------------------------------------+
 | ``filtering_attributes``    | A list of key-value pairs, that is |
 | (Optional)                  | used to select inventory           |
@@ -328,8 +329,9 @@ for ONAP.
 |                             | existing service instances),       |
 |                             | ``vfmodule`` (for vf instances),   |
 |                             | ``nssi`` (for slice subnet         |
-|                             | instances). Exactly one inventory  |
-|                             | type may be specified.             |
+|                             | instances), ``nst`` (for slice     |
+|                             | templates). Exactly one            |
+|                            | inventory type may be specified.   |
 +-----------------------------+------------------------------------+
 | ``filtering attributes``    | A list of key-value pairs to match |
 |  (Optional)                 | against inventory when drawing     |