From 419f7c602ef9d9cd4771ebcb2b1ae17d58dc78aa Mon Sep 17 00:00:00 2001 From: Anurag Dwivedi Date: Mon, 3 Apr 2017 05:43:24 -0400 Subject: [PATCH] RIFT-14719 : mano-types.yang Feedback and Comments (i) Typos and Grammatical Feedback. (ii) Improved Descriptions. Signed-off-by: Anurag Dwivedi --- models/plugins/yang/mano-types.yang | 159 ++++++++++++++-------------- models/plugins/yang/nsd.yang | 2 +- models/plugins/yang/nsr.yang | 6 +- 3 files changed, 86 insertions(+), 81 deletions(-) diff --git a/models/plugins/yang/mano-types.yang b/models/plugins/yang/mano-types.yang index aad89724..5cf74db2 100644 --- a/models/plugins/yang/mano-types.yang +++ b/models/plugins/yang/mano-types.yang @@ -100,13 +100,13 @@ module mano-types } leaf parameter-pool { - description "NSD Parameter pool name to use for this paramter"; + description "NSD parameter pool name to use for this parameter"; type string; } leaf read-only { description - "The value should be greyed out by the UI. + "The value should be dimmed by the UI. Only applies to parameters with default values."; type boolean; } @@ -151,8 +151,8 @@ module mano-types description "Image name for the software image. If the image name is found within the VNF packaage it will - be uploaded to all cloud accounts during onboarding process. - Otherwise, the image must be added to the cloud account with + be uploaded to all VIM accounts during onboarding process. + Otherwise, the image must be added to the VIM account with the same name as entered here. "; type string; @@ -194,6 +194,7 @@ module mano-types } leaf value { + description "Value of the configuration primitive."; type string; } } @@ -203,10 +204,10 @@ module mano-types container vnf-configuration { rwpb:msg-new VnfConfiguration; description - "Information regarding the VNF configuration - is captured here. Note that if the NS contains - multiple instances of the same VNF, each instance - of the VNF may have different configuration"; + "Information about the VNF configuration. Note: + If the NS contains multiple instances of the + same VNF, each instance could have a different + configuration."; choice config-method { description @@ -226,7 +227,7 @@ module mano-types leaf protocol { description - "Protocol to use for netconf (e.g. ssh)"; + "Protocol to use for NETCONF such as ssh"; type enumeration { enum None; enum ssh; @@ -235,7 +236,7 @@ module mano-types leaf port { description - "Port for the netconf server."; + "Port for the NETCONF server."; type inet:port-number; } } @@ -257,7 +258,8 @@ module mano-types description "Use custom script for configuring the VNF. This script is executed in the context of - Orchestrator."; + Orchestrator (The same system and environment + as the Launchpad)."; container script { leaf script-type { description @@ -292,7 +294,7 @@ module mano-types leaf username { description - "username for configuration."; + "User name for configuration."; type string; } @@ -305,14 +307,14 @@ module mano-types container config-attributes { description - "Miscelaneous input parameters to be considered + "Miscellaneous input parameters to be considered while processing the NSD to apply configuration"; leaf config-priority { description - "Configuration priority - order of confgiration - to be applied to each VNF in this NS, - low number gets precedence over high number"; + "Configuration priority - order of configuration + to be applied to each VNF in this NS ,A low + number takes precedence over a high number"; type uint64; } @@ -402,7 +404,7 @@ module mano-types typedef api-type { description - "Type of API to fetch monitoring params"; + "Type of API to fetch monitoring parameters"; type enumeration { enum HTTP; @@ -416,8 +418,8 @@ module mano-types "The method to extract a value from a JSON response NAMEKEY - Use the name as the key for a non-nested value. - JSONPATH - Use jsonpath-rw implemenation to extract a value. - OBJECTPATH - Use objectpath implemenation to extract a value."; + JSONPATH - Use jsonpath-rw implementation to extract a value. + OBJECTPATH - Use objectpath implementation to extract a value."; type enumeration { enum NAMEKEY; enum JSONPATH; @@ -441,7 +443,7 @@ module mano-types VPORT: Virtual Port // VNIC_ADDR: Virtual NIC Address // PNIC_ADDR: Physical NIC Address - // PPORT: Phsical Port."; + // PPORT: Physical Port."; type enumeration { enum VPORT; @@ -647,7 +649,7 @@ module mano-types container vm-flavor { leaf vcpu-count { description - "Number of vcpus for the VM."; + "Number of VCPUs for the VM."; type uint16; } @@ -794,13 +796,13 @@ module mano-types leaf om-cpu-model-string { - description "Openmano CPU model string"; + description "OpenMANO CPU model string"; type string; } list om-cpu-feature { key "feature"; - description "List of openmano CPU features"; + description "List of OpenMANO CPU features"; leaf feature { description "CPU feature"; type string; @@ -822,12 +824,12 @@ module mano-types "Memory page allocation size. If a VM requires hugepages, it should choose LARGE or SIZE_2MB or SIZE_1GB. If the VM prefers hugepages it - should chose PREFER_LARGE. + should choose PREFER_LARGE. LARGE : Require hugepages (either 2MB or 1GB) SMALL : Doesn't require hugepages SIZE_2MB : Requires 2MB hugepages SIZE_1GB : Requires 1GB hugepages - PREFER_LARGE : Application perfers hugepages"; + PREFER_LARGE : Application prefers hugepages"; type enumeration { enum LARGE; enum SMALL; @@ -904,20 +906,21 @@ module mano-types case numa-aware { container numa-node-policy { description - "This policy defines numa topology of the + "This policy defines NUMA topology of the guest. Specifically identifies if the guest - should be run on a host with one numa - node or multiple numa nodes. As an example - a guest may want 8 vcpus and 4 GB of - memory. But may want the vcpus and memory - distributed across multiple numa nodes. - The NUMA node 1 may run with 6 vcpus and - 3GB, and NUMA node 2 may run with 2 vcpus - and 1GB."; + should be run on a host with one NUMA + node or multiple NUMA nodes. As an example + a guest might need 8 VCPUs and 4 GB of + memory. However, it might need the VCPUs + and memory distributed across multiple + NUMA nodes. In this scenario, NUMA node + 1 could run with 6 VCPUs and 3GB, and + NUMA node 2 could run with 2 VCPUs and + 1GB."; leaf node-cnt { description - "The number of numa nodes to expose to the VM."; + "The number of NUMA nodes to expose to the VM."; type uint16; } @@ -929,7 +932,7 @@ module mano-types strictly from the memory attached to the NUMA node. PREFERRED : The memory should be allocated - perferentially from the memory + preferentially from the memory attached to the NUMA node"; type enumeration { enum STRICT; @@ -949,12 +952,12 @@ module mano-types list vcpu { key "id"; description - "List of vcpus to allocate on - this numa node."; + "List of VCPUs to allocate on + this NUMA node."; leaf id { type uint64; - description "List of vcpus ids to allocate on - this numa node"; + description "List of VCPUs ids to allocate on + this NUMA node"; } } @@ -967,7 +970,7 @@ module mano-types choice om-numa-type { description - "Openmano Numa type selection"; + "OpenMANO Numa type selection"; case cores { leaf num-cores { @@ -983,7 +986,7 @@ module mano-types list paired-thread-ids { description - "List of thread pairs to use in case of paired-thread numa"; + "List of thread pairs to use in case of paired-thread NUMA"; max-elements 16; key thread-a; @@ -1016,7 +1019,7 @@ module mano-types description "Container for the provider network."; leaf physical-network { description - "Name of the phsyical network on which the provider + "Name of the physical network on which the provider network is built."; type string; } @@ -1034,7 +1037,7 @@ module mano-types } leaf segmentation_id { description - "Segmentation ID"; + "ID of segregated virtual networks"; type uint32; } } @@ -1080,8 +1083,8 @@ module mano-types leaf method { description - "This is the method to be performed at the uri. - GET by default for action"; + "Method that the URI should perform. + Deafult action is GET."; type manotypes:http-method; default "GET"; @@ -1104,7 +1107,7 @@ module mano-types list monitoring-param { description - "List of monitoring parameters at the NS level"; + "List of monitoring parameters at the network service level"; key id; leaf id { type string; @@ -1167,16 +1170,18 @@ module mano-types } leaf group-tag { - description "A simple tag to group monitoring parameters"; + description "A tag to group monitoring parameters"; type string; } leaf widget-type { + description "Defines the UI Display variant of measured counters."; type manotypes:widget-type; } leaf units { + description "Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.)"; type string; } } @@ -1195,7 +1200,7 @@ module mano-types } leaf max-value { description - "Maxium value for the parameter"; + "Maximum value for the parameter"; type uint64; } } @@ -1254,7 +1259,7 @@ module mano-types } leaf group-tag { - description "A simple tag to group control parameters"; + description "A tag to group control parameters"; type string; } @@ -1266,7 +1271,7 @@ module mano-types leaf max-value { description - "Maxium value for the parameter"; + "Maximum value for the parameter"; type uint64; } @@ -1292,15 +1297,15 @@ module mano-types leaf url { description - "This is the URL where to perform the operation"; + "This is the URL where the operation should be performed."; type inet:uri; } leaf method { description - "This is the method to be performed at the uri. - POST by default for action"; + "Method that the URI should perform. + Default Action is POST"; type manotypes:http-method; default "POST"; @@ -1336,7 +1341,7 @@ module mano-types } leaf group-tag { - description "A simple tag to group monitoring parameter"; + description "A tag to group monitoring parameter"; type string; } @@ -1366,7 +1371,7 @@ module mano-types } grouping input-parameter { - description ""; + description "List of input parameters that can be specified when instantiating a network service."; list input-parameter { description @@ -1377,7 +1382,7 @@ module mano-types leaf xpath { description - "A an xpath that specfies which element in a descriptor is to be + "An xpath that specfies which element in a descriptor is to be modified."; type string; } @@ -1410,7 +1415,7 @@ module mano-types } leaf default-value { - description " A default value for this input parameter"; + description "/nsd:nsd-catalog/nsd:nsd/nsd:vendor"; type string; } } @@ -1616,7 +1621,7 @@ module mano-types } typedef alarm-severity-type { - description "An indication of the importance or ugency of the alarm"; + description "An indication of the importance or urgency of the alarm"; type enumeration { enum LOW; enum MODERATE; @@ -1635,8 +1640,8 @@ module mano-types typedef alarm-statistic-type { description - "The type of statistic to used to measure a metric to determine - threshold crossing for an alarm."; + "Statistic type to use to determine threshold crossing + for an alarm."; type enumeration { enum AVERAGE; enum MINIMUM; @@ -1648,9 +1653,9 @@ module mano-types typedef alarm-operation-type { description - "The relational operator used to define whether an alarm should be - triggered when, say, the metric statistic goes above or below a - specified value."; + "The relational operator used to define whether an alarm + should be triggered in certain scenarios, such as if the + metric statistic goes above or below a specified value."; type enumeration { enum GE; // greater than or equal enum LE; // less than or equal @@ -1663,8 +1668,7 @@ module mano-types grouping alarm { leaf alarm-id { description - "This field is reserved for the identifier assigned by the cloud - provider"; + "This field is reserved for the identifier assigned by the VIM provider"; type string; } @@ -1675,7 +1679,7 @@ module mano-types } leaf description { - description "A string containing a description of this alarm"; + description "A description of this alarm"; type string; } @@ -1727,7 +1731,7 @@ module mano-types } leaf severity { - description "A measure of the important or urgency of the alarm"; + description "A measure of the importance or urgency of the alarm"; type alarm-severity-type; } @@ -1743,9 +1747,9 @@ module mano-types leaf operation { description - "The relational operator that defines whether the alarm should be - triggered when the metric statistic is, say, above or below the - specified threshold value."; + "The relational operator used to define whether an alarm should be + triggered in certain scenarios, such as if the metric statistic + goes above or below a specified value."; type alarm-operation-type; } @@ -1768,17 +1772,14 @@ module mano-types leaf evaluations { description - "This is the number of samples of the metric statistic used to - evaluate threshold crossing. Each sample or evaluation is equal to - the metric statistic obtained for a given period. This can be used - to mitigate spikes in the metric that may skew the statistic of - interest."; + "Defines the length of time (seconds) in which metric data are + collected in order to evaluate the chosen statistic."; type uint32; } } typedef cloud-account-type { - description "cloud account type"; + description "VIM account type"; type enumeration { enum aws; enum cloudsim; @@ -1797,9 +1798,13 @@ module mano-types key "metadata-key"; leaf metadata-key { + description + "Name of the additional information attached to the host-aggregate"; type string; } leaf metadata-value { + description + "Value of the corresponding metadata-key"; type string; } } diff --git a/models/plugins/yang/nsd.yang b/models/plugins/yang/nsd.yang index a81535b6..23d5d171 100644 --- a/models/plugins/yang/nsd.yang +++ b/models/plugins/yang/nsd.yang @@ -119,7 +119,7 @@ module nsd } leaf parameter-pool { - description "NSD Parameter pool name to use for this paramter"; + description "NSD parameter pool name to use for this parameter"; type string; } } diff --git a/models/plugins/yang/nsr.yang b/models/plugins/yang/nsr.yang index 97c32dee..6f9b5f7f 100644 --- a/models/plugins/yang/nsr.yang +++ b/models/plugins/yang/nsr.yang @@ -274,7 +274,7 @@ module nsr 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 resovled this will switched to use + Once that is resolved this will switched to use leafref"; type yang:uuid; } @@ -872,7 +872,7 @@ module nsr 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 resovled this will switched to use + Once that is resolved this will switched to use leafref"; type string; @@ -1181,7 +1181,7 @@ module nsr 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 resovled this will switched to use + Once that is resolved this will switched to use leafref"; type string; -- 2.17.1