summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjoquiltyL <john.quilty@ericsson.com>2018-08-29 16:02:42 +0100
committerjoquiltyL <john.quilty@ericsson.com>2018-08-29 16:02:42 +0100
commita04f16e618d2a34b90ca8c736861a915a6f341e7 (patch)
treecf3989144e333b046ca4bac7265077be360808d7
parentec2f263e009b1463dc6df01b8e45ae94b2609829 (diff)
Remove R-51910, add R-10623
Change R-51910 to paragraph text Change Google protocol buffer text to requirement Updated needs.json Issue-ID: VNFRQTS-207 Change-Id: Id73872f3be1c59d36251fc9270caa7cea3bd183a Signed-off-by: joquiltyL <john.quilty@ericsson.com>
-rwxr-xr-xdocs/Chapter7/Monitoring-And-Management.rst72
-rw-r--r--docs/data/needs.json35
2 files changed, 67 insertions, 40 deletions
diff --git a/docs/Chapter7/Monitoring-And-Management.rst b/docs/Chapter7/Monitoring-And-Management.rst
index 32a486d..c40eea2 100755
--- a/docs/Chapter7/Monitoring-And-Management.rst
+++ b/docs/Chapter7/Monitoring-And-Management.rst
@@ -357,14 +357,9 @@ VNF telemetry via standardized interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. req::
- :id: R-51910
- :target: XNF
- :keyword: MUST
-
- The xNF **MUST** provide all telemetry (e.g., fault event
- records, syslog records, performance records etc.) to ONAP using the
- model, format and mechanisms described in this section.
+All VNF telemetry data (e.g. fault event records, syslog records,
+performance records, etc.) need to be delivered to ONAP using the
+standardized models and interfaces described in this section.
Encoding and Serialization
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -416,36 +411,39 @@ Buffers (GPB).
KV-GPB/GPB
~~~~~~~~~~~~~~~~~~
-Telemetry data delivered using Google Protocol Buffers v3 (proto3)
-can be serialized in one of the following methods:
-
-* Key-value Google Protocol Buffers (KV-GPB) is also known as
- self-describing GPB:
-
- * keys are strings that correspond to the path of the system
- resources for the VNF being monitored.
- * values correspond to integers or strings that identify the
- operational state of the VNF resource, such a statistics counters
- and the state of a VNF resource.
-
-* VNF providers must supply valid KV-GPB definition file(s) to allow
- for the decoding of all KV-GPB encoded telemetry messages.
-
-* Native Google Protocol Buffers (GPB) is also known as compact GPB:
-
- * keys are represented as integers pointing to the system resources for
- the VNF being monitored.
- * values correspond to integers or strings that identify the operational
- state of the VNF resource, such a statistics counters and the state
- of a VNF resource.
-
-* Google Protocol Buffers (GPB) requires metadata in the form of .proto
- files. VNF providers must supply the necessary GPB .proto files such that
- GPB telemetry messages can be encoded and decoded.
-
-* In the future, we may consider support for other types of
- encoding & serialization methods based on industry demand.
+.. req::
+ :id: R-10623
+ :target: XNF
+ :keyword: MUST
+ :introduced: casablanca
+ Telemetry data delivered using Google Protocol Buffers v3 (proto3)
+ **MUST** be serialized in one of the following methods:
+
+ * Key-value Google Protocol Buffers (KV-GPB) is also known as
+ self-describing GPB:
+
+ * keys are strings that correspond to the path of the system
+ resources for the VNF being monitored.
+ * values correspond to integers or strings that identify the
+ operational state of the VNF resource, such a statistics counters
+ and the state of a VNF resource.
+ * VNF providers must supply valid KV-GPB definition file(s) to allow
+ for the decoding of all KV-GPB encoded telemetry messages.
+
+ * Native Google Protocol Buffers (GPB) is also known as compact GPB:
+
+ * keys are represented as integers pointing to the system resources for
+ the VNF being monitored.
+ * values correspond to integers or strings that identify the operational
+ state of the VNF resource, such a statistics counters and the state
+ of a VNF resource.
+ * Google Protocol Buffers (GPB) requires metadata in the form of .proto
+ files. VNF providers must supply the necessary GPB .proto files such that
+ GPB telemetry messages can be encoded and decoded.
+
+In the future, we may consider support for other types of
+encoding & serialization methods based on industry demand.
Reporting Frequency
~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/data/needs.json b/docs/data/needs.json
index 4dc1edd..f8907af 100644
--- a/docs/data/needs.json
+++ b/docs/data/needs.json
@@ -1,10 +1,10 @@
{
- "created": "2018-08-28T18:13:45.520689",
+ "created": "2018-08-29T15:58:48.649549",
"current_version": "casablanca",
"project": "",
"versions": {
"casablanca": {
- "created": "2018-08-28T18:13:45.520548",
+ "created": "2018-08-29T15:58:48.649549",
"needs": {
"R-00011": {
"description": "A VNF's Heat Orchestration Template's Nested YAML files\nparameter's **MUST NOT** have a parameter constraint defined.",
@@ -1960,6 +1960,35 @@
"validated_by": "",
"validation_mode": ""
},
+ "R-10623": {
+ "description": "Telemetry data delivered using Google Protocol Buffers v3 (proto3)\n**MUST** be serialized in one of the following methods:\n\n * Key-value Google Protocol Buffers (KV-GPB) is also known as\n self-describing GPB:\n\n * keys are strings that correspond to the path of the system\n resources for the VNF being monitored.\n * values correspond to integers or strings that identify the\n operational state of the VNF resource, such a statistics counters\n and the state of a VNF resource.\n * VNF providers must supply valid KV-GPB definition file(s) to allow\n for the decoding of all KV-GPB encoded telemetry messages.\n\n * Native Google Protocol Buffers (GPB) is also known as compact GPB:\n\n * keys are represented as integers pointing to the system resources for\n the VNF being monitored.\n * values correspond to integers or strings that identify the operational\n state of the VNF resource, such a statistics counters and the state\n of a VNF resource.\n * Google Protocol Buffers (GPB) requires metadata in the form of .proto\n files. VNF providers must supply the necessary GPB .proto files such that\n GPB telemetry messages can be encoded and decoded.",
+ "full_title": "",
+ "hide_links": "",
+ "id": "R-10623",
+ "impacts": "",
+ "introduced": "casablanca",
+ "keyword": "MUST",
+ "links": [],
+ "notes": "",
+ "section_name": "KV-GPB/GPB",
+ "sections": [
+ "KV-GPB/GPB",
+ "Monitoring & Management Requirements",
+ "Monitoring & Management"
+ ],
+ "status": null,
+ "tags": [],
+ "target": "XNF",
+ "test": "",
+ "test_case": "",
+ "test_file": "",
+ "title": "",
+ "title_from_content": "",
+ "type_name": "Requirement",
+ "updated": "",
+ "validated_by": "",
+ "validation_mode": ""
+ },
"R-10716": {
"description": "The xNF **MUST** support parallel and simultaneous\nconfiguration of separate objects within itself.",
"full_title": "",
@@ -21970,7 +21999,7 @@
"validation_mode": ""
}
},
- "needs_amount": 754
+ "needs_amount": 755
},
"master branch": {
"created": "2018-08-22T16:47:37.993404",