(i) Typos and Grammatical Feedback.
(ii) Improved Descriptions.
Signed-off-by: Anurag Dwivedi <anurag.dwivedi@riftio.com>
- 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
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;
}
Only applies to parameters with default values.";
type boolean;
}
description
"Image name for the software image.
If the image name is found within the VNF packaage it will
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;
the same name as entered here.
";
type string;
+ description "Value of the configuration primitive.";
container vnf-configuration {
rwpb:msg-new VnfConfiguration;
description
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
choice config-method {
description
leaf protocol {
description
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;
type enumeration {
enum None;
enum ssh;
- "Port for the netconf server.";
+ "Port for the NETCONF server.";
type inet:port-number;
}
}
type inet:port-number;
}
}
description
"Use custom script for configuring the VNF.
This script is executed in the context of
description
"Use custom script for configuring the VNF.
This script is executed in the context of
+ Orchestrator (The same system and environment
+ as the Launchpad).";
container script {
leaf script-type {
description
container script {
leaf script-type {
description
leaf username {
description
leaf username {
description
- "username for configuration.";
+ "User name for configuration.";
container config-attributes {
description
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
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";
typedef api-type {
description
typedef api-type {
description
- "Type of API to fetch monitoring params";
+ "Type of API to fetch monitoring parameters";
type enumeration {
enum HTTP;
type enumeration {
enum HTTP;
"The method to extract a value from a JSON response
NAMEKEY - Use the name as the key for a non-nested value.
"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;
type enumeration {
enum NAMEKEY;
enum JSONPATH;
VPORT: Virtual Port
// VNIC_ADDR: Virtual NIC Address
// PNIC_ADDR: Physical NIC Address
VPORT: Virtual Port
// VNIC_ADDR: Virtual NIC Address
// PNIC_ADDR: Physical NIC Address
- // PPORT: Phsical Port.";
+ // PPORT: Physical Port.";
type enumeration {
enum VPORT;
type enumeration {
enum VPORT;
container vm-flavor {
leaf vcpu-count {
description
container vm-flavor {
leaf vcpu-count {
description
- "Number of vcpus for the VM.";
+ "Number of VCPUs for the VM.";
leaf om-cpu-model-string {
leaf om-cpu-model-string {
- description "Openmano CPU model string";
+ description "OpenMANO CPU model string";
type string;
}
list om-cpu-feature {
key "feature";
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;
leaf feature {
description "CPU feature";
type string;
"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
"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
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;
type enumeration {
enum LARGE;
enum SMALL;
case numa-aware {
container numa-node-policy {
description
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
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
leaf node-cnt {
description
- "The number of numa nodes to expose to the VM.";
+ "The number of NUMA nodes to expose to the VM.";
strictly from the memory attached
to the NUMA node.
PREFERRED : The memory should be allocated
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;
attached to the NUMA node";
type enumeration {
enum STRICT;
list vcpu {
key "id";
description
list vcpu {
key "id";
description
- "List of vcpus to allocate on
- this numa node.";
+ "List of VCPUs to allocate on
+ this NUMA node.";
- description "List of vcpus ids to allocate on
- this numa node";
+ description "List of VCPUs ids to allocate on
+ this NUMA node";
choice om-numa-type {
description
choice om-numa-type {
description
- "Openmano Numa type selection";
+ "OpenMANO Numa type selection";
case cores {
leaf num-cores {
case cores {
leaf num-cores {
list paired-thread-ids {
description
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;
max-elements 16;
key thread-a;
description "Container for the provider network.";
leaf physical-network {
description
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;
}
network is built.";
type string;
}
}
leaf segmentation_id {
description
}
leaf segmentation_id {
description
+ "ID of segregated virtual networks";
leaf method {
description
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";
type manotypes:http-method;
default "GET";
list monitoring-param {
description
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;
key id;
leaf id {
type string;
- description "A simple tag to group monitoring parameters";
+ description "A tag to group monitoring parameters";
type string;
}
leaf widget-type {
type string;
}
leaf widget-type {
+ description "Defines the UI Display variant of measured counters.";
type manotypes:widget-type;
}
leaf units {
type manotypes:widget-type;
}
leaf units {
+ description "Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.)";
}
leaf max-value {
description
}
leaf max-value {
description
- "Maxium value for the parameter";
+ "Maximum value for the parameter";
- description "A simple tag to group control parameters";
+ description "A tag to group control parameters";
leaf max-value {
description
leaf max-value {
description
- "Maxium value for the parameter";
+ "Maximum value for the parameter";
- "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
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";
type manotypes:http-method;
default "POST";
- description "A simple tag to group monitoring parameter";
+ description "A tag to group monitoring parameter";
}
grouping input-parameter {
}
grouping input-parameter {
+ description "List of input parameters that can be specified when instantiating a network service.";
list input-parameter {
description
list input-parameter {
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;
}
modified.";
type string;
}
- description " A default value for this input parameter";
+ description "/nsd:nsd-catalog/nsd:nsd/nsd:vendor";
}
typedef alarm-severity-type {
}
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;
type enumeration {
enum LOW;
enum MODERATE;
typedef alarm-statistic-type {
description
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;
type enumeration {
enum AVERAGE;
enum MINIMUM;
typedef alarm-operation-type {
description
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
type enumeration {
enum GE; // greater than or equal
enum LE; // less than or equal
grouping alarm {
leaf alarm-id {
description
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";
- description "A string containing a description of this alarm";
+ description "A description of this alarm";
- 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;
}
type alarm-severity-type;
}
leaf operation {
description
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;
}
type alarm-operation-type;
}
leaf evaluations {
description
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 {
type uint32;
}
}
typedef cloud-account-type {
- description "cloud account type";
+ description "VIM account type";
type enumeration {
enum aws;
enum cloudsim;
type enumeration {
enum aws;
enum cloudsim;
key "metadata-key";
leaf metadata-key {
key "metadata-key";
leaf metadata-key {
+ description
+ "Name of the additional information attached to the host-aggregate";
type string;
}
leaf metadata-value {
type string;
}
leaf metadata-value {
+ description
+ "Value of the corresponding metadata-key";
- description "NSD Parameter pool name to use for this paramter";
+ description "NSD parameter pool name to use for this parameter";
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.
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;
}
leafref";
type yang:uuid;
}
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.
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
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.
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
projects / osm / SO.git / commitdiff