diff options
Diffstat (limited to 'docs/files')
| -rw-r--r-- | docs/files/Dovetail.rst | 2 | ||||
| -rw-r--r-- | docs/files/ICE.rst | 2 | ||||
| -rw-r--r-- | docs/files/VESEventListener.rst | 12 | ||||
| -rw-r--r-- | docs/files/VESEventRegistration.rst | 33 | ||||
| -rw-r--r-- | docs/files/marketplace-overview.rst | 2 | ||||
| -rw-r--r-- | docs/files/mktplace-install.rst | 2 | ||||
| -rw-r--r-- | docs/files/pkgtool.rst | 4 |
7 files changed, 24 insertions, 33 deletions
diff --git a/docs/files/Dovetail.rst b/docs/files/Dovetail.rst index cec6ab1..1205786 100644 --- a/docs/files/Dovetail.rst +++ b/docs/files/Dovetail.rst @@ -47,7 +47,7 @@ The Open Platform for NFV (OPNFV) is a collaborative project under the Linux Foundation that is transforming global networks through open source Network Functions Virtualization (NFV). OPNFV focuses on developing test suites for Open Source implementations of the NFV -infrastructure components such as those specified in the ETSI Mano +infrastructure components such as those specified in the ETSI NFV ISG MANO architecture. Areas of focus in OPNFV include: Virtualized Infrastructure Managers (VIM) such as OpenStack and Software Defined Networking Controllers (SDNC) such as Open Daylight. diff --git a/docs/files/ICE.rst b/docs/files/ICE.rst index a3ba77e..094c4f3 100644 --- a/docs/files/ICE.rst +++ b/docs/files/ICE.rst @@ -42,7 +42,7 @@ Go into the ice_validator directory: ``$ cd ice/validation-scripts/ice_validator`` -The Heat templates validation may generate different ouput format (plain, tap, html): +The Heat templates validation may generate different output format (plain, tap, html): - plain format diff --git a/docs/files/VESEventListener.rst b/docs/files/VESEventListener.rst index 1157f24..a396e5c 100644 --- a/docs/files/VESEventListener.rst +++ b/docs/files/VESEventListener.rst @@ -1,7 +1,7 @@ .. This work is 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 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2017-2018 Huawei Technologies Co., Ltd. ============================= Service: *VES Event Listener* @@ -47,7 +47,7 @@ commonEventHeader, as specified below: - 'Tca'for the thresholdCrossingAlert domain - 'voiceQuality'for the voiceQuality domain -Sdc (the ONAP Service Design and Creation environment) defines and catalogs specific services, VNFs, VF modules and other entities, which are generically referred to as 'Sdc models'. The Sdc model that an event is associated with should be indicated in the second subfield within the eventName. If the event is not associated with an Sdc model but is instead being generated by an application platform like SO, then a string identifying the Application Platform may be used instead. In either case, all subfield names should be converted to camel case format (with no spaces, hyphens or underscores). +SDC (the ONAP Service Design and Creation environment) defines and catalogs specific services, VNFs, VF modules and other entities, which are generically referred to as 'SDC models'. The SDC model that an event is associated with should be indicated in the second subfield within the eventName. If the event is not associated with an Sdc model but is instead being generated by an application platform like SO, then a string identifying the Application Platform may be used instead. In either case, all subfield names should be converted to camel case format (with no spaces, hyphens or underscores). The final subfield of the eventName name should describe, in a compact camel case format (with no spaces, hyphens or underscores), the specific information being conveyed by the event. In some cases, this final subfield will not be required (e.g., in the case of Heartbeats or in the case of an event source which, for a domain like syslog, defines only one eventName to support it): @@ -60,7 +60,7 @@ Examples of eventNames following the naming standards are provided below: - Tca\_vDbe\_CpuThresholdExceeded - Other\_SO\_InstantiationPhase1Complete -Any questions about the naming of eventNames should be resolved as part of service and resource onboarding to the ONAP Service Design and Creation environment (i.e., Sdc). +Any questions about the naming of eventNames should be resolved as part of service and resource onboarding to the ONAP Service Design and Creation environment (i.e., SDC). Support for Protocols Other Than HTTPS -------------------------------------- @@ -1170,7 +1170,7 @@ The gtpPerFlowMetrics datatype consists of the following fields: +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | numPacketsTransmittedInclRetrans | number | Yes | number of packets transmitted, including retransmissions | +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numRetries | number | Yes | number of packet retrie | +| numRetries | number | Yes | number of packet retries | +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | numTimeouts | number | Yes | number of packet timeouts | +------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1281,7 +1281,7 @@ following fields: +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ | correlator | string | Yes | Constant across all events on this call | +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| localIpAddress | string | Yes | Ip address on VNF | +| localIpAddress | string | Yes | IP address on VNF | +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ | localPort | string | Yes | Port on VNF | +-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ @@ -1496,7 +1496,7 @@ REST Operation Summary Table - REST Operation Summary -Api Version +API Version ~~~~~~~~~~~ apiVersion is used to describe the major version number of the event diff --git a/docs/files/VESEventRegistration.rst b/docs/files/VESEventRegistration.rst index e796b4f..23953f6 100644 --- a/docs/files/VESEventRegistration.rst +++ b/docs/files/VESEventRegistration.rst @@ -1,7 +1,7 @@ .. This work is 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 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2017-2018 Huawei Technologies Co., Ltd. ====================== VES Event Registration @@ -133,13 +133,13 @@ YAML file names should conform to the following naming convention: The ‘#’ should be replaced with the current numbered version of the file. -‘ASDC’ is a reference to the Service Provider’s Service Design and +‘SDC’ is a reference to the Service Provider’s Service Design and Creation environment. The sdcModelType is an enumeration with several values of which the following three are potentially relevant: - Service -- Vnf +- VNF - VfModule @@ -355,7 +355,7 @@ Examples: ] } # whenever the above event occurs, a vnfDown condition is asserted - and the vnf should be rebooted, plus the indicated tca should be + and the VNF should be rebooted, plus the indicated tca should be generated. Presence @@ -370,9 +370,7 @@ Examples - element: { presence: optional } # element is optional -- element: { value: blue } # by omitting a presence definition, the - - element is assumed to be optional +- element: { value: blue } # by omitting a presence definition, the element is assumed to be optional Range ~~~~~ @@ -406,20 +404,13 @@ object. Example: - objectName: { structure: { - -element1: { }, - -element2: { }, - -anotherObject: { structure: { - -element3: { }, - -element4: { } - -} } - -} } + element1: { }, + element2: { }, + anotherObject: { structure: { + element3: { }, + element4: { } + } } + } } Units ~~~~~ diff --git a/docs/files/marketplace-overview.rst b/docs/files/marketplace-overview.rst index 8927ea1..4864777 100644 --- a/docs/files/marketplace-overview.rst +++ b/docs/files/marketplace-overview.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2017-2018 Huawei Technologies Co., Ltd. VNF SDK Marketplace ------------------- diff --git a/docs/files/mktplace-install.rst b/docs/files/mktplace-install.rst index 784ffc0..5e9fa6d 100644 --- a/docs/files/mktplace-install.rst +++ b/docs/files/mktplace-install.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2017-2018 Huawei Technologies Co., Ltd. VNF SDK Marketplace Installation Instructions ============================================= diff --git a/docs/files/pkgtool.rst b/docs/files/pkgtool.rst index bbcb3c2..f8eb3e7 100644 --- a/docs/files/pkgtool.rst +++ b/docs/files/pkgtool.rst @@ -21,7 +21,7 @@ Provided tools The tools are provided in a form of a shared library (Python module) that can be used in other projects. A CLI is also provided out-of-the box for DevOps to -use the library with their scripts and autoamtion framework. +use the library with their scripts and automation framework. Repository Name: vnfsdk/pkgtools @@ -58,4 +58,4 @@ Usage All commands have -h switch which displays help and description of all -paramaters. +parameters. |