RIFT-14692 : Feedback on nsd.yang comments

Signed-off-by: Anurag Dwivedi <anurag.dwivedi@riftio.com>

diff --git a/models/plugins/yang/mano-types.yang b/models/plugins/yang/mano-types.yang
index ab234be..4ec602c 100644 (file)
--- a/models/plugins/yang/mano-types.yang
+++ b/models/plugins/yang/mano-types.yang
@@ -227,7 +227,7 @@ module mano-types
 
             leaf protocol {
               description
 
             leaf protocol {
               description

-                  "Protocol to use for NETCONF such as ssh";
+                  "Protocol to use for NETCONF, such as ssh";

               type enumeration {
                 enum None;
                 enum ssh;
               type enumeration {
                 enum None;
                 enum ssh;


@@ -313,7 +313,7 @@ module mano-types
         leaf config-priority {
           description
               "Configuration priority - order of configuration
         leaf config-priority {
           description
               "Configuration priority - order of configuration

-               to be applied to each VNF in this NS ,A low
+               to be applied to each VNF in this NS. A low

                number takes precedence over a high number";
           type uint64;
         }
                number takes precedence over a high number";
           type uint64;
         }


@@ -1252,14 +1252,17 @@ module mano-types
       key id;
 
       leaf id {
       key id;
 
       leaf id {

+        description "Identifier for control parameter";

         type string;
       }
 
       leaf name {
         type string;
       }
 
       leaf name {

+        description "Name of a control parameter";

         type string;
       }
 
       leaf description {
         type string;
       }
 
       leaf description {

+        description "A description of the control parameter";

         type string;
       }
 
         type string;
       }
 

diff --git a/models/plugins/yang/nsd.yang b/models/plugins/yang/nsd.yang
index 15cd2e3..7818391 100644 (file)
--- a/models/plugins/yang/nsd.yang
+++ b/models/plugins/yang/nsd.yang
@@ -148,8 +148,8 @@ module nsd
 
     leaf logo {
       description
 
     leaf logo {
       description

-        "File path for  the vendor specific logo. For example icons/mylogo.png.
-         The logo  should be part of the network service";
+        "File path for the vendor-specific logo. For example, icons/mylogo.png.
+         The logo should be part of the network service";

       type string;
     }
 
       type string;
     }
 


@@ -166,16 +166,11 @@ module nsd
     list connection-point {
       description
           "List for external connection points.
     list connection-point {
       description
           "List for external connection points.

-          Each NS has one or more external connection
-          points. As the name implies that external
-          connection points are used for connecting
-          the NS to other NS or to external networks.
-          Each NS exposes these connection points to
-          the orchestrator. The orchestrator can
-          construct network service chains by
-          connecting the connection points between
-          different NS.";
-
+          Each network service (NS) has one or more external connection
+          points that connect the NS to other NSs or to external networks.
+          Each NS exposes connection points to the orchestrator, which can
+          construct network service chains by connecting the connection
+          points between different NSs.";

       key "name";
       leaf name {
         description
       key "name";
       leaf name {
         description


@@ -190,12 +185,12 @@ module nsd
       }
     }
 
       }
     }
 

-    /* Still having issues modelling this,
+    /* Model Limitations,

        see the comments under vnfd-connection-point-ref
      */
     list vld {
       description
        see the comments under vnfd-connection-point-ref
      */
     list vld {
       description

-          "List of Virtual Link Descriptors.";
+          "List of Virtual Link Descriptors (VLDs).";

 
       key "id";
 
 
       key "id";
 


@@ -262,7 +257,7 @@ module nsd
 
         leaf vnfd-id-ref {
           description
 
         leaf vnfd-id-ref {
           description

-              "A reference to a vnfd";
+              "A reference to a VNFD";

           type leafref {
             path "../../../constituent-vnfd" +
                  "[member-vnf-index = current()/../member-vnf-index-ref]" +
           type leafref {
             path "../../../constituent-vnfd" +
                  "[member-vnf-index = current()/../member-vnf-index-ref]" +


@@ -321,8 +316,8 @@ module nsd
       leaf member-vnf-index {
         description
           "Identifier/index for the VNFD. This separate id
       leaf member-vnf-index {
         description
           "Identifier/index for the VNFD. This separate id

-           is required to ensure that multiple VNFs can be
-           part of single NS";
+           is required so that multiple VNFs can be part of 
+           single NS";

         type uint64;
       }
 
         type uint64;
       }
 


@@ -344,7 +339,7 @@ module nsd
 
     list scaling-group-descriptor {
       description
 
     list scaling-group-descriptor {
       description

-          "scaling group descriptor within this network service.
+          "Scaling group descriptor within this network service.

            The scaling group defines a group of VNFs,
            and the ratio of VNFs in the network service
            that is used as target for scaling action";
            The scaling group defines a group of VNFs,
            and the ratio of VNFs in the network service
            that is used as target for scaling action";


@@ -392,7 +387,7 @@ module nsd
           description
               "Operation to be applied to check between scaling criterias to 
                check if the scale out threshold condition has been met.
           description
               "Operation to be applied to check between scaling criterias to 
                check if the scale out threshold condition has been met.

-               Defauls to OR";
+               Defaults to OR";

           type scaling-criteria-operation;
           default OR;
         }
           type scaling-criteria-operation;
           default OR;
         }


@@ -407,7 +402,7 @@ module nsd
         leaf cooldown-time {
           description
             "The duration after a scaling-in/scaling-out action has been
         leaf cooldown-time {
           description
             "The duration after a scaling-in/scaling-out action has been

-            triggered, for which there will be no further optional";
+            triggered, for which there will be no further scaling activity";

           type uint32;
           mandatory true;
         }
           type uint32;
           mandatory true;
         }


@@ -419,18 +414,21 @@ module nsd
           key "name";
 
           leaf name {
           key "name";
 
           leaf name {

+            description "Name of the scaling criteria";

             type string;
           }
 
           leaf scale-in-threshold {
             description
             type string;
           }
 
           leaf scale-in-threshold {
             description

-                "Value below which scale-in requests are generated";
+                "Value below which scale-in requests are generated
+                 (depends on monitoring parameters)";

             type uint64;
           }
 
           leaf scale-out-threshold {
             description
             type uint64;
           }
 
           leaf scale-out-threshold {
             description

-                "Value above which scale-out requests are generated";
+                "Value above which scale-out requests are generated
+                 (depends on monitoring parameters)";

             type uint64;
           }
 
             type uint64;
           }
 


@@ -450,7 +448,7 @@ module nsd
         key "member-vnf-index-ref";
 
         leaf member-vnf-index-ref {
         key "member-vnf-index-ref";
 
         leaf member-vnf-index-ref {

-          description "member VNF index of this member VNF";
+          description "Member VNF index of this member VNF";

           type leafref {
             path "../../../constituent-vnfd/member-vnf-index";
           }
           type leafref {
             path "../../../constituent-vnfd/member-vnf-index";
           }


@@ -458,9 +456,9 @@ module nsd
 
         leaf count {
           description
 
         leaf count {
           description

-            "count of this member VNF  within this scaling group.
-             The count allows to define  the number of instances
-             when a scaling action targets this scaling group";
+            "Count of this member VNF  within this scaling group.
+             The count defines the number of instances when a
+             scaling action targets this scaling group.";

           type uint32;
           default 1;
         }
           type uint32;
           default 1;
         }


@@ -468,19 +466,20 @@ module nsd
 
       leaf min-instance-count {
         description
 
       leaf min-instance-count {
         description

-          "Minimum instances of the scaling group which are allowed.
-          These instances are created by default when the network service
-          is instantiated.";
+          "Minimum number of instances of the scaling group that
+          are allowed in a single network service. These instances
+          are created by default when the network service is 
+          instantiated.";

         type uint32;
         default 0;
       }
 
       leaf max-instance-count {
         description
         type uint32;
         default 0;
       }
 
       leaf max-instance-count {
         description

-          "Maximum instances of this scaling group that are allowed
-           in a single network service. The network service scaling
-           will fail, when the number of service group instances
-           exceed the max-instance-count specified.";
+          "Maximum number of instances of this scaling group that
+          are allowed in a single network service. The network 
+          service scaling fails when the number of service group
+          instances exceeds the max-instance-count specified.";

         type uint32;
         default 10;
       }
         type uint32;
         default 10;
       }


@@ -490,7 +489,7 @@ module nsd
         key "trigger";
 
         leaf trigger {
         key "trigger";
 
         leaf trigger {

-          description "scaling trigger";
+          description "Scaling trigger";

           type scaling-trigger;
         }
 
           type scaling-trigger;
         }
 


@@ -516,7 +515,7 @@ module nsd
         key "member-vnf-index-ref";
 
         leaf member-vnf-index-ref {
         key "member-vnf-index-ref";
 
         leaf member-vnf-index-ref {

-          description "member VNF index of this member VNF";
+          description "Member VNF index of this member VNF";

           type leafref {
             path "../../../constituent-vnfd/member-vnf-index";
           }
           type leafref {
             path "../../../constituent-vnfd/member-vnf-index";
           }


@@ -547,7 +546,7 @@ module nsd
       }
       leaf vnf-depends-on-ref {
         description
       }
       leaf vnf-depends-on-ref {
         description

-            "Reference to VNF that sorce VNF depends.";
+            "Reference to VNF on which the source VNF depends.";

         type leafref {
           path "../../constituent-vnfd/vnfd-id-ref";
         }
         type leafref {
           path "../../constituent-vnfd/vnfd-id-ref";
         }


@@ -686,7 +685,7 @@ module nsd
 
         leaf vnfd-id-ref {
           description
 
         leaf vnfd-id-ref {
           description

-              "A reference to a vnfd";
+              "A reference to a VNFD";

           type leafref {
               path "../../../constituent-vnfd" +
                    "[member-vnf-index = current()/../member-vnf-index-ref]" +
           type leafref {
               path "../../../constituent-vnfd" +
                    "[member-vnf-index = current()/../member-vnf-index-ref]" +


@@ -718,7 +717,7 @@ module nsd
 
           leaf ip-proto {
             description
 
           leaf ip-proto {
             description

-                "IP Protocol.";
+                "Internet Protocol.";

             type uint8;
           }
 
             type uint8;
           }
 


@@ -745,22 +744,23 @@ module nsd
                 "Destination port number.";
             type inet:port-number;
           }
                 "Destination port number.";
             type inet:port-number;
           }

-          //TODO: Add more match criteria

         } //match-attributes
       } // classifier
     } // vnffgd
 
     list monitoring-param {
       description
         } //match-attributes
       } // classifier
     } // vnffgd
 
     list monitoring-param {
       description

-        "List of monitoring parameters from VNF's that should be
+        "List of monitoring parameters from VNFs that should be

         propogated up into NSR";
       key "id";
 
       leaf id {
         propogated up into NSR";
       key "id";
 
       leaf id {

+        description "Identifier for a monitoring parameter";

         type string;
       }
 
       leaf name {
         type string;
       }
 
       leaf name {

+        description "Name of the monitoring parameter";

         type string;
       }
 
         type string;
       }
 


@@ -774,7 +774,7 @@ module nsd
 
         leaf vnfd-id-ref {
           description
 
         leaf vnfd-id-ref {
           description

-             "A reference to a vnfd. This is a leafref";
+             "A reference to a VNFD. This is a leafref";

 
           type leafref {
             path "../../../constituent-vnfd" +
 
           type leafref {
             path "../../../constituent-vnfd" +


@@ -806,8 +806,8 @@ module nsd
 
     list parameter-pool {
       description
 
     list parameter-pool {
       description

-        "Pool of parameter values which must be
-         pulled from during configuration";
+         "Pool of parameter values from which to choose during 
+         configuration.";  

       key "name";
 
       leaf name {
       key "name";
 
       leaf name {


@@ -818,7 +818,7 @@ module nsd
 
       container range {
         description
 
       container range {
         description

-            "Create a range of values to populate the pool with";
+            "Create a range of values from which to populate the pool with";

 
         leaf start-value {
           description
 
         leaf start-value {
           description


@@ -873,7 +873,7 @@ module nsd
 
         leaf vnfd-id-ref {
           description
 
         leaf vnfd-id-ref {
           description

-              "A reference to a vnfd. This is a leafref";
+              "A reference to a VNFD. This is a leafref";

 
           type leafref {
              path "../../../constituent-vnfd" +
 
           type leafref {
              path "../../../constituent-vnfd" +


@@ -925,7 +925,7 @@ module nsd
     list key-pair {
       key "name";
       description "Used to configure the list of public keys to be injected as part
     list key-pair {
       key "name";
       description "Used to configure the list of public keys to be injected as part

-          of ns instantiation";
+          of NS instantiation";

 
       leaf name {
         description "Name of this key pair";
 
       leaf name {
         description "Name of this key pair";


@@ -955,7 +955,7 @@ module nsd
       list key-pair {
         key "name";
         description "Used to configure the list of public keys to be injected as part
       list key-pair {
         key "name";
         description "Used to configure the list of public keys to be injected as part

-            of ns instantiation";
+            of NS instantiation";

 
         leaf name {
           description "Name of this key pair";
 
         leaf name {
           description "Name of this key pair";

diff --git a/models/plugins/yang/nsr.yang b/models/plugins/yang/nsr.yang
index b081f6a..3fdd642 100644 (file)
--- a/models/plugins/yang/nsr.yang
+++ b/models/plugins/yang/nsr.yang
@@ -271,11 +271,7 @@ module nsr
           ../../../../nsd:constituent-vnfd
           + [nsr:id = current()/../nsd:id-ref]
           + /nsd:vnfd-id-ref
           ../../../../nsd:constituent-vnfd
           + [nsr:id = current()/../nsd:id-ref]
           + /nsd:vnfd-id-ref

-          NOTE: An issue with confd is preventing the
-          use of xpath. Seems to be an issue with leafref
-          to leafref, whose target is in a different module.
-          Once that is resolved this will switched to use
-          leafref";
+          NOTE: confd limitations prevent the use of xpath";

       type yang:uuid;
     }
 
       type yang:uuid;
     }
 


@@ -869,11 +865,7 @@ module nsr
                       ../../../../nsd:constituent-vnfd
                       + [nsd:id = current()/../nsd:id-ref]
                       + /nsd:vnfd-id-ref
                       ../../../../nsd:constituent-vnfd
                       + [nsd:id = current()/../nsd:id-ref]
                       + /nsd:vnfd-id-ref

-                  NOTE: An issue with confd is preventing the
-                  use of xpath. Seems to be an issue with leafref
-                  to leafref, whose target is in a different module.
-                  Once that is resolved this will switched to use
-                  leafref";
+                  NOTE: confd limitations prevent the use of xpath";

 
                type string;
             }
 
                type string;
             }


@@ -931,12 +923,17 @@ module nsr
         }
 
         list parameter {
         }
 
         list parameter {

+          description
+              "List of parameters for the initial config primitive";

           key "name";
           leaf name {
           key "name";
           leaf name {

+            description "Name of the intitial config parameter";

             type string;
           }
 
           leaf value {
             type string;
           }
 
           leaf value {

+            description "Value associated with the initial config 
+                        parameter";

             type string;
           }
         }
             type string;
           }
         }


@@ -1178,11 +1175,7 @@ module nsr
                    ../../../../nsd:constituent-vnfd
                    + [nsd:id = current()/../nsd:id-ref]
                    + /nsd:vnfd-id-ref
                    ../../../../nsd:constituent-vnfd
                    + [nsd:id = current()/../nsd:id-ref]
                    + /nsd:vnfd-id-ref

-               NOTE: An issue with confd is preventing the
-               use of xpath. Seems to be an issue with leafref
-               to leafref, whose target is in a different module.
-               Once that is resolved this will switched to use
-               leafref";
+               NOTE: confd limitations prevent the use of xpath";

 
           type string;
         }
 
           type string;
         }