summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMorgan Richomme <morgan.richomme@orange.com>2017-11-08 10:43:33 +0100
committerLusheng Ji <lji@research.att.com>2017-11-27 21:58:00 -0500
commit95be74bfa769f7e57bc64d5621f1bfd96e016ee5 (patch)
tree746bc1a7492dd2d1c36019972a36f4db459998b1
parent4367b9df79a5fb12fd43658f370de23b3b56f331 (diff)
Fix Doc8 errors
Issue-ID: DCAEGEN2-197 Change-Id: I7de01b8c52ae7919f3d8d4f6545a53b026096ab9 Signed-off-by: Morgan Richomme <morgan.richomme@orange.com> DOC: release notes updates Change-Id: I8d88d65c1c5be9e114b6aab60d70b6e36464a75f Issue-ID: DCAEGEN2-194 Signed-off-by: Vijay <vv770d@att.com> Fix editorial errors Modify ONPA by ONAP Correct some JSON file example Add code-block for code snippet Change-Id: Ia313b6adc615bcd353f4e3c3e363c3f854d25181 ISSUE-ID: DCAEGEN2-199 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Improve documentation Issue-Id: DCAEGEN2-199 Change-Id: Id5e3f3e57e86debe41b7df7986c9d8a808b2752f Signed-off-by: Lusheng Ji <lji@research.att.com> Cherry pick from master, add defaultbranch Issue-ID: DCAEGEN2-206 Change-Id: I363a9331afa1bad33586aa2de34af9c3e6716532 Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat
-rw-r--r--.gitreview1
-rw-r--r--docs/sections/apis/ves.rst2429
-rw-r--r--docs/sections/architecture.rst2
-rw-r--r--docs/sections/blueprints/ves.rst10
-rw-r--r--docs/sections/images/designate.gifbin0 -> 115887 bytes
-rw-r--r--docs/sections/installation.rst4
-rw-r--r--docs/sections/installation_heat.rst153
-rw-r--r--docs/sections/installation_manual.rst645
-rw-r--r--docs/sections/installation_test.rst8
-rw-r--r--docs/sections/release-notes.rst5
10 files changed, 1589 insertions, 1668 deletions
diff --git a/.gitreview b/.gitreview
index c33b8033..d2dee95d 100644
--- a/.gitreview
+++ b/.gitreview
@@ -2,3 +2,4 @@
host=gerrit.onap.org
port=29418
project=dcaegen2
+defaultbranch=amsterdam
diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst
index 41d903be..4fb338f8 100644
--- a/docs/sections/apis/ves.rst
+++ b/docs/sections/apis/ves.rst
@@ -99,850 +99,850 @@ Body
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
+ event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
.. code-block:: javascript
{
"event": {
"commonEventHeader": {
- "domain": "fault",
- "eventId": "somestring",
- "eventName": "somestring",
- "eventType": "somestring",
- "internalHeaderFields": {},
- "lastEpochMicrosec": 1,
- "nfNamingCode": "somestring",
- "nfcNamingCode": "somestring",
- "priority": "High",
- "reportingEntityId": "somestring",
- "reportingEntityName": "somestring",
- "sequence": 1,
- "sourceId": "somestring",
- "sourceName": "somestring",
- "startEpochMicrosec": 1,
+ "domain": "fault",
+ "eventId": "somestring",
+ "eventName": "somestring",
+ "eventType": "somestring",
+ "internalHeaderFields": {},
+ "lastEpochMicrosec": 1,
+ "nfNamingCode": "somestring",
+ "nfcNamingCode": "somestring",
+ "priority": "High",
+ "reportingEntityId": "somestring",
+ "reportingEntityName": "somestring",
+ "sequence": 1,
+ "sourceId": "somestring",
+ "sourceName": "somestring",
+ "startEpochMicrosec": 1,
"version": 1
- },
+ },
"faultFields": {
"alarmAdditionalInformation": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "alarmCondition": "somestring",
- "alarmInterfaceA": "somestring",
- "eventCategory": "somestring",
- "eventSeverity": "CRITICAL",
- "eventSourceType": "somestring",
- "faultFieldsVersion": 1,
- "specificProblem": "somestring",
+ ],
+ "alarmCondition": "somestring",
+ "alarmInterfaceA": "somestring",
+ "eventCategory": "somestring",
+ "eventSeverity": "CRITICAL",
+ "eventSourceType": "somestring",
+ "faultFieldsVersion": 1,
+ "specificProblem": "somestring",
"vfStatus": "Active"
- },
+ },
"heartbeatFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "heartbeatFieldsVersion": 1,
+ ],
+ "heartbeatFieldsVersion": 1,
"heartbeatInterval": 1
- },
+ },
"measurementsForVfScalingFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"additionalMeasurements": [
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
- },
+ },
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
}
- ],
+ ],
"additionalObjects": [
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
- },
+ },
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
}
- ],
+ ],
"codecUsageArray": [
{
- "codecIdentifier": "somestring",
+ "codecIdentifier": "somestring",
"numberInUse": 1
- },
+ },
{
- "codecIdentifier": "somestring",
+ "codecIdentifier": "somestring",
"numberInUse": 1
}
- ],
- "concurrentSessions": 1,
- "configuredEntities": 1,
+ ],
+ "concurrentSessions": 1,
+ "configuredEntities": 1,
"cpuUsageArray": [
{
- "cpuIdentifier": "somestring",
- "cpuIdle": 1,
- "cpuUsageInterrupt": 1,
- "cpuUsageNice": 1,
- "cpuUsageSoftIrq": 1,
- "cpuUsageSteal": 1,
- "cpuUsageSystem": 1,
- "cpuUsageUser": 1,
- "cpuWait": 1,
+ "cpuIdentifier": "somestring",
+ "cpuIdle": 1,
+ "cpuUsageInterrupt": 1,
+ "cpuUsageNice": 1,
+ "cpuUsageSoftIrq": 1,
+ "cpuUsageSteal": 1,
+ "cpuUsageSystem": 1,
+ "cpuUsageUser": 1,
+ "cpuWait": 1,
"percentUsage": 1
- },
- {
- "cpuIdentifier": "somestring",
- "cpuIdle": 1,
- "cpuUsageInterrupt": 1,
- "cpuUsageNice": 1,
- "cpuUsageSoftIrq": 1,
- "cpuUsageSteal": 1,
- "cpuUsageSystem": 1,
- "cpuUsageUser": 1,
- "cpuWait": 1,
+ },
+ {
+ "cpuIdentifier": "somestring",
+ "cpuIdle": 1,
+ "cpuUsageInterrupt": 1,
+ "cpuUsageNice": 1,
+ "cpuUsageSoftIrq": 1,
+ "cpuUsageSteal": 1,
+ "cpuUsageSystem": 1,
+ "cpuUsageUser": 1,
+ "cpuWait": 1,
"percentUsage": 1
}
- ],
+ ],
"diskUsageArray": [
{
- "diskIdentifier": "somestring",
- "diskIoTimeAvg": 1,
- "diskIoTimeLast": 1,
- "diskIoTimeMax": 1,
- "diskIoTimeMin": 1,
- "diskMergedReadAvg": 1,
- "diskMergedReadLast": 1,
- "diskMergedReadMax": 1,
- "diskMergedReadMin": 1,
- "diskMergedWriteAvg": 1,
- "diskMergedWriteLast": 1,
- "diskMergedWriteMax": 1,
- "diskMergedWriteMin": 1,
- "diskOctetsReadAvg": 1,
- "diskOctetsReadLast": 1,
- "diskOctetsReadMax": 1,
- "diskOctetsReadMin": 1,
- "diskOctetsWriteAvg": 1,
- "diskOctetsWriteLast": 1,
- "diskOctetsWriteMax": 1,
- "diskOctetsWriteMin": 1,
- "diskOpsReadAvg": 1,
- "diskOpsReadLast": 1,
- "diskOpsReadMax": 1,
- "diskOpsReadMin": 1,
- "diskOpsWriteAvg": 1,
- "diskOpsWriteLast": 1,
- "diskOpsWriteMax": 1,
- "diskOpsWriteMin": 1,
- "diskPendingOperationsAvg": 1,
- "diskPendingOperationsLast": 1,
- "diskPendingOperationsMax": 1,
- "diskPendingOperationsMin": 1,
- "diskTimeReadAvg": 1,
- "diskTimeReadLast": 1,
- "diskTimeReadMax": 1,
- "diskTimeReadMin": 1,
- "diskTimeWriteAvg": 1,
- "diskTimeWriteLast": 1,
- "diskTimeWriteMax": 1,
+ "diskIdentifier": "somestring",
+ "diskIoTimeAvg": 1,
+ "diskIoTimeLast": 1,
+ "diskIoTimeMax": 1,
+ "diskIoTimeMin": 1,
+ "diskMergedReadAvg": 1,
+ "diskMergedReadLast": 1,
+ "diskMergedReadMax": 1,
+ "diskMergedReadMin": 1,
+ "diskMergedWriteAvg": 1,
+ "diskMergedWriteLast": 1,
+ "diskMergedWriteMax": 1,
+ "diskMergedWriteMin": 1,
+ "diskOctetsReadAvg": 1,
+ "diskOctetsReadLast": 1,
+ "diskOctetsReadMax": 1,
+ "diskOctetsReadMin": 1,
+ "diskOctetsWriteAvg": 1,
+ "diskOctetsWriteLast": 1,
+ "diskOctetsWriteMax": 1,
+ "diskOctetsWriteMin": 1,
+ "diskOpsReadAvg": 1,
+ "diskOpsReadLast": 1,
+ "diskOpsReadMax": 1,
+ "diskOpsReadMin": 1,
+ "diskOpsWriteAvg": 1,
+ "diskOpsWriteLast": 1,
+ "diskOpsWriteMax": 1,
+ "diskOpsWriteMin": 1,
+ "diskPendingOperationsAvg": 1,
+ "diskPendingOperationsLast": 1,
+ "diskPendingOperationsMax": 1,
+ "diskPendingOperationsMin": 1,
+ "diskTimeReadAvg": 1,
+ "diskTimeReadLast": 1,
+ "diskTimeReadMax": 1,
+ "diskTimeReadMin": 1,
+ "diskTimeWriteAvg": 1,
+ "diskTimeWriteLast": 1,
+ "diskTimeWriteMax": 1,
"diskTimeWriteMin": 1
- },
- {
- "diskIdentifier": "somestring",
- "diskIoTimeAvg": 1,
- "diskIoTimeLast": 1,
- "diskIoTimeMax": 1,
- "diskIoTimeMin": 1,
- "diskMergedReadAvg": 1,
- "diskMergedReadLast": 1,
- "diskMergedReadMax": 1,
- "diskMergedReadMin": 1,
- "diskMergedWriteAvg": 1,
- "diskMergedWriteLast": 1,
- "diskMergedWriteMax": 1,
- "diskMergedWriteMin": 1,
- "diskOctetsReadAvg": 1,
- "diskOctetsReadLast": 1,
- "diskOctetsReadMax": 1,
- "diskOctetsReadMin": 1,
- "diskOctetsWriteAvg": 1,
- "diskOctetsWriteLast": 1,
- "diskOctetsWriteMax": 1,
- "diskOctetsWriteMin": 1,
- "diskOpsReadAvg": 1,
- "diskOpsReadLast": 1,
- "diskOpsReadMax": 1,
- "diskOpsReadMin": 1,
- "diskOpsWriteAvg": 1,
- "diskOpsWriteLast": 1,
- "diskOpsWriteMax": 1,
- "diskOpsWriteMin": 1,
- "diskPendingOperationsAvg": 1,
- "diskPendingOperationsLast": 1,
- "diskPendingOperationsMax": 1,
- "diskPendingOperationsMin": 1,
- "diskTimeReadAvg": 1,
- "diskTimeReadLast": 1,
- "diskTimeReadMax": 1,
- "diskTimeReadMin": 1,
- "diskTimeWriteAvg": 1,
- "diskTimeWriteLast": 1,
- "diskTimeWriteMax": 1,
+ },
+ {
+ "diskIdentifier": "somestring",
+ "diskIoTimeAvg": 1,
+ "diskIoTimeLast": 1,
+ "diskIoTimeMax": 1,
+ "diskIoTimeMin": 1,
+ "diskMergedReadAvg": 1,
+ "diskMergedReadLast": 1,
+ "diskMergedReadMax": 1,
+ "diskMergedReadMin": 1,
+ "diskMergedWriteAvg": 1,
+ "diskMergedWriteLast": 1,
+ "diskMergedWriteMax": 1,
+ "diskMergedWriteMin": 1,
+ "diskOctetsReadAvg": 1,
+ "diskOctetsReadLast": 1,
+ "diskOctetsReadMax": 1,
+ "diskOctetsReadMin": 1,
+ "diskOctetsWriteAvg": 1,
+ "diskOctetsWriteLast": 1,
+ "diskOctetsWriteMax": 1,
+ "diskOctetsWriteMin": 1,
+ "diskOpsReadAvg": 1,
+ "diskOpsReadLast": 1,
+ "diskOpsReadMax": 1,
+ "diskOpsReadMin": 1,
+ "diskOpsWriteAvg": 1,
+ "diskOpsWriteLast": 1,
+ "diskOpsWriteMax": 1,
+ "diskOpsWriteMin": 1,
+ "diskPendingOperationsAvg": 1,
+ "diskPendingOperationsLast": 1,
+ "diskPendingOperationsMax": 1,
+ "diskPendingOperationsMin": 1,
+ "diskTimeReadAvg": 1,
+ "diskTimeReadLast": 1,
+ "diskTimeReadMax": 1,
+ "diskTimeReadMin": 1,
+ "diskTimeWriteAvg": 1,
+ "diskTimeWriteLast": 1,
+ "diskTimeWriteMax": 1,
"diskTimeWriteMin": 1
}
- ],
+ ],
"featureUsageArray": [
{
- "featureIdentifier": "somestring",
+ "featureIdentifier": "somestring",
"featureUtilization": 1
- },
+ },
{
- "featureIdentifier": "somestring",
+ "featureIdentifier": "somestring",
"featureUtilization": 1
}
- ],
+ ],
"filesystemUsageArray": [
{
- "blockConfigured": 1,
- "blockIops": 1,
- "blockUsed": 1,
- "ephemeralConfigured": 1,
- "ephemeralIops": 1,
- "ephemeralUsed": 1,
+ "blockConfigured": 1,
+ "blockIops": 1,
+ "blockUsed": 1,
+ "ephemeralConfigured": 1,
+ "ephemeralIops": 1,
+ "ephemeralUsed": 1,
"filesystemName": "somestring"
- },
- {
- "blockConfigured": 1,
- "blockIops": 1,
- "blockUsed": 1,
- "ephemeralConfigured": 1,
- "ephemeralIops": 1,
- "ephemeralUsed": 1,
+ },
+ {
+ "blockConfigured": 1,
+ "blockIops": 1,
+ "blockUsed": 1,
+ "ephemeralConfigured": 1,
+ "ephemeralIops": 1,
+ "ephemeralUsed": 1,
"filesystemName": "somestring"
}
- ],
+ ],
"latencyDistribution": [
{
- "countsInTheBucket": 1,
- "highEndOfLatencyBucket": 1,
+ "countsInTheBucket": 1,
+ "highEndOfLatencyBucket": 1,
"lowEndOfLatencyBucket": 1
- },
+ },
{
- "countsInTheBucket": 1,
- "highEndOfLatencyBucket": 1,
+ "countsInTheBucket": 1,
+ "highEndOfLatencyBucket": 1,
"lowEndOfLatencyBucket": 1
}
- ],
- "meanRequestLatency": 1,
- "measurementInterval": 1,
- "measurementsForVfScalingVersion": 1,
+ ],
+ "meanRequestLatency": 1,
+ "measurementInterval": 1,
+ "measurementsForVfScalingVersion": 1,
"memoryUsageArray": [
{
- "memoryBuffered": 1,
- "memoryCached": 1,
- "memoryConfigured": 1,
- "memoryFree": 1,
- "memorySlabRecl": 1,
- "memorySlabUnrecl": 1,
- "memoryUsed": 1,
+ "memoryBuffered": 1,
+ "memoryCached": 1,
+ "memoryConfigured": 1,
+ "memoryFree": 1,
+ "memorySlabRecl": 1,
+ "memorySlabUnrecl": 1,
+ "memoryUsed": 1,
"vmIdentifier": "somestring"
- },
- {
- "memoryBuffered": 1,
- "memoryCached": 1,
- "memoryConfigured": 1,
- "memoryFree": 1,
- "memorySlabRecl": 1,
- "memorySlabUnrecl": 1,
- "memoryUsed": 1,
+ },
+ {
+ "memoryBuffered": 1,
+ "memoryCached": 1,
+ "memoryConfigured": 1,
+ "memoryFree": 1,
+ "memorySlabRecl": 1,
+ "memorySlabUnrecl": 1,
+ "memoryUsed": 1,
"vmIdentifier": "somestring"
}
- ],
- "numberOfMediaPortsInUse": 1,
- "requestRate": 1,
+ ],
+ "numberOfMediaPortsInUse": 1,
+ "requestRate": 1,
"vNicPerformanceArray": [
{
- "receivedBroadcastPacketsAccumulated": 1,
- "receivedBroadcastPacketsDelta": 1,
- "receivedDiscardedPacketsAccumulated": 1,
- "receivedDiscardedPacketsDelta": 1,
- "receivedErrorPacketsAccumulated": 1,
- "receivedErrorPacketsDelta": 1,
- "receivedMulticastPacketsAccumulated": 1,
- "receivedMulticastPacketsDelta": 1,
- "receivedOctetsAccumulated": 1,
- "receivedOctetsDelta": 1,
- "receivedTotalPacketsAccumulated": 1,
- "receivedTotalPacketsDelta": 1,
- "receivedUnicastPacketsAccumulated": 1,
- "receivedUnicastPacketsDelta": 1,
- "transmittedBroadcastPacketsAccumulated": 1,
- "transmittedBroadcastPacketsDelta": 1,
- "transmittedDiscardedPacketsAccumulated": 1,
- "transmittedDiscardedPacketsDelta": 1,
- "transmittedErrorPacketsAccumulated": 1,
- "transmittedErrorPacketsDelta": 1,
- "transmittedMulticastPacketsAccumulated": 1,
- "transmittedMulticastPacketsDelta": 1,
- "transmittedOctetsAccumulated": 1,
- "transmittedOctetsDelta": 1,
- "transmittedTotalPacketsAccumulated": 1,
- "transmittedTotalPacketsDelta": 1,
- "transmittedUnicastPacketsAccumulated": 1,
- "transmittedUnicastPacketsDelta": 1,
- "vNicIdentifier": "somestring",
+ "receivedBroadcastPacketsAccumulated": 1,
+ "receivedBroadcastPacketsDelta": 1,
+ "receivedDiscardedPacketsAccumulated": 1,
+ "receivedDiscardedPacketsDelta": 1,
+ "receivedErrorPacketsAccumulated": 1,
+ "receivedErrorPacketsDelta": 1,
+ "receivedMulticastPacketsAccumulated": 1,
+ "receivedMulticastPacketsDelta": 1,
+ "receivedOctetsAccumulated": 1,
+ "receivedOctetsDelta": 1,
+ "receivedTotalPacketsAccumulated": 1,
+ "receivedTotalPacketsDelta": 1,
+ "receivedUnicastPacketsAccumulated": 1,
+ "receivedUnicastPacketsDelta": 1,
+ "transmittedBroadcastPacketsAccumulated": 1,
+ "transmittedBroadcastPacketsDelta": 1,
+ "transmittedDiscardedPacketsAccumulated": 1,
+ "transmittedDiscardedPacketsDelta": 1,
+ "transmittedErrorPacketsAccumulated": 1,
+ "transmittedErrorPacketsDelta": 1,
+ "transmittedMulticastPacketsAccumulated": 1,
+ "transmittedMulticastPacketsDelta": 1,
+ "transmittedOctetsAccumulated": 1,
+ "transmittedOctetsDelta": 1,
+ "transmittedTotalPacketsAccumulated": 1,
+ "transmittedTotalPacketsDelta": 1,
+ "transmittedUnicastPacketsAccumulated": 1,
+ "transmittedUnicastPacketsDelta": 1,
+ "vNicIdentifier": "somestring",
"valuesAreSuspect": "true"
- },
- {
- "receivedBroadcastPacketsAccumulated": 1,
- "receivedBroadcastPacketsDelta": 1,
- "receivedDiscardedPacketsAccumulated": 1,
- "receivedDiscardedPacketsDelta": 1,
- "receivedErrorPacketsAccumulated": 1,
- "receivedErrorPacketsDelta": 1,
- "receivedMulticastPacketsAccumulated": 1,
- "receivedMulticastPacketsDelta": 1,
- "receivedOctetsAccumulated": 1,
- "receivedOctetsDelta": 1,
- "receivedTotalPacketsAccumulated": 1,
- "receivedTotalPacketsDelta": 1,
- "receivedUnicastPacketsAccumulated": 1,
- "receivedUnicastPacketsDelta": 1,
- "transmittedBroadcastPacketsAccumulated": 1,
- "transmittedBroadcastPacketsDelta": 1,
- "transmittedDiscardedPacketsAccumulated": 1,
- "transmittedDiscardedPacketsDelta": 1,
- "transmittedErrorPacketsAccumulated": 1,
- "transmittedErrorPacketsDelta": 1,
- "transmittedMulticastPacketsAccumulated": 1,
- "transmittedMulticastPacketsDelta": 1,
- "transmittedOctetsAccumulated": 1,
- "transmittedOctetsDelta": 1,
- "transmittedTotalPacketsAccumulated": 1,
- "transmittedTotalPacketsDelta": 1,
- "transmittedUnicastPacketsAccumulated": 1,
- "transmittedUnicastPacketsDelta": 1,
- "vNicIdentifier": "somestring",
+ },
+ {
+ "receivedBroadcastPacketsAccumulated": 1,
+ "receivedBroadcastPacketsDelta": 1,
+ "receivedDiscardedPacketsAccumulated": 1,
+ "receivedDiscardedPacketsDelta": 1,
+ "receivedErrorPacketsAccumulated": 1,
+ "receivedErrorPacketsDelta": 1,
+ "receivedMulticastPacketsAccumulated": 1,
+ "receivedMulticastPacketsDelta": 1,
+ "receivedOctetsAccumulated": 1,
+ "receivedOctetsDelta": 1,
+ "receivedTotalPacketsAccumulated": 1,
+ "receivedTotalPacketsDelta": 1,
+ "receivedUnicastPacketsAccumulated": 1,
+ "receivedUnicastPacketsDelta": 1,
+ "transmittedBroadcastPacketsAccumulated": 1,
+ "transmittedBroadcastPacketsDelta": 1,
+ "transmittedDiscardedPacketsAccumulated": 1,
+ "transmittedDiscardedPacketsDelta": 1,
+ "transmittedErrorPacketsAccumulated": 1,
+ "transmittedErrorPacketsDelta": 1,
+ "transmittedMulticastPacketsAccumulated": 1,
+ "transmittedMulticastPacketsDelta": 1,
+ "transmittedOctetsAccumulated": 1,
+ "transmittedOctetsDelta": 1,
+ "transmittedTotalPacketsAccumulated": 1,
+ "transmittedTotalPacketsDelta": 1,
+ "transmittedUnicastPacketsAccumulated": 1,
+ "transmittedUnicastPacketsDelta": 1,
+ "vNicIdentifier": "somestring",
"valuesAreSuspect": "true"
}
- ],
+ ],
"vnfcScalingMetric": 1
- },
+ },
"mobileFlowFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "appProtocolType": "somestring",
- "appProtocolVersion": "somestring",
- "applicationType": "somestring",
- "cid": "somestring",
- "connectionType": "somestring",
- "ecgi": "somestring",
- "flowDirection": "somestring",
+ ],
+ "appProtocolType": "somestring",
+ "appProtocolVersion": "somestring",
+ "applicationType": "somestring",
+ "cid": "somestring",
+ "connectionType": "somestring",
+ "ecgi": "somestring",
+ "flowDirection": "somestring",
"gtpPerFlowMetrics": {
- "avgBitErrorRate": 1,
- "avgPacketDelayVariation": 1,
- "avgPacketLatency": 1,
- "avgReceiveThroughput": 1,
- "avgTransmitThroughput": 1,
- "durConnectionFailedStatus": 1,
- "durTunnelFailedStatus": 1,
- "flowActivatedBy": "somestring",
- "flowActivationEpoch": 1,
- "flowActivationMicrosec": 1,
- "flowActivationTime": "somestring",
- "flowDeactivatedBy": "somestring",
- "flowDeactivationEpoch": 1,
- "flowDeactivationMicrosec": 1,
- "flowDeactivationTime": "somestring",
- "flowStatus": "somestring",
- "gtpConnectionStatus": "somestring",
- "gtpTunnelStatus": "somestring",
+ "avgBitErrorRate": 1,
+ "avgPacketDelayVariation": 1,
+ "avgPacketLatency": 1,
+ "avgReceiveThroughput": 1,
+ "avgTransmitThroughput": 1,
+ "durConnectionFailedStatus": 1,
+ "durTunnelFailedStatus": 1,
+ "flowActivatedBy": "somestring",
+ "flowActivationEpoch": 1,
+ "flowActivationMicrosec": 1,
+ "flowActivationTime": "somestring",
+ "flowDeactivatedBy": "somestring",
+ "flowDeactivationEpoch": 1,
+ "flowDeactivationMicrosec": 1,
+ "flowDeactivationTime": "somestring",
+ "flowStatus": "somestring",
+ "gtpConnectionStatus": "somestring",
+ "gtpTunnelStatus": "somestring",
"ipTosCountList": [
[
- 1,
+ 1,
1
- ],
+ ],
[
- 1,
+ 1,
1
]
- ],
+ ],
"ipTosList": [
- "somestring",
+ "somestring",
"somestring"
- ],
- "largePacketRtt": 1,
- "largePacketThreshold": 1,
- "maxPacketDelayVariation": 1,
- "maxReceiveBitRate": 1,
- "maxTransmitBitRate": 1,
+ ],
+ "largePacketRtt": 1,
+ "largePacketThreshold": 1,
+ "maxPacketDelayVariation": 1,
+ "maxReceiveBitRate": 1,
+ "maxTransmitBitRate": 1,
"mobileQciCosCountList": [
[
- 1,
+ 1,
1
- ],
+ ],
[
- 1,
+ 1,
1
]
- ],
+ ],
"mobileQciCosList": [
- "somestring",
+ "somestring",
"somestring"
- ],
- "numActivationFailures": 1,
- "numBitErrors": 1,
- "numBytesReceived": 1,
- "numBytesTransmitted": 1,
- "numDroppedPackets": 1,
- "numGtpEchoFailures": 1,
- "numGtpTunnelErrors": 1,
- "numHttpErrors": 1,
- "numL7BytesReceived": 1,
- "numL7BytesTransmitted": 1,
- "numLostPackets": 1,
- "numOutOfOrderPackets": 1,
- "numPacketErrors": 1,
- "numPacketsReceivedExclRetrans": 1,
- "numPacketsReceivedInclRetrans": 1,
- "numPacketsTransmittedInclRetrans": 1,
- "numRetries": 1,
- "numTimeouts": 1,
- "numTunneledL7BytesReceived": 1,
- "roundTripTime": 1,
+ ],
+ "numActivationFailures": 1,
+ "numBitErrors": 1,
+ "numBytesReceived": 1,
+ "numBytesTransmitted": 1,
+ "numDroppedPackets": 1,
+ "numGtpEchoFailures": 1,
+ "numGtpTunnelErrors": 1,
+ "numHttpErrors": 1,
+ "numL7BytesReceived": 1,
+ "numL7BytesTransmitted": 1,
+ "numLostPackets": 1,
+ "numOutOfOrderPackets": 1,
+ "numPacketErrors": 1,
+ "numPacketsReceivedExclRetrans": 1,
+ "numPacketsReceivedInclRetrans": 1,
+ "numPacketsTransmittedInclRetrans": 1,
+ "numRetries": 1,
+ "numTimeouts": 1,
+ "numTunneledL7BytesReceived": 1,
+ "roundTripTime": 1,
"tcpFlagCountList": [
[
- 1,
+ 1,
1
- ],
+ ],
[
- 1,
+ 1,
1
]
- ],
+ ],
"tcpFlagList": [
- "somestring",
+ "somestring",
"somestring"
- ],
+ ],
"timeToFirstByte": 1
- },
- "gtpProtocolType": "somestring",
- "gtpVersion": "somestring",
- "httpHeader": "somestring",
- "imei": "somestring",
- "imsi": "somestring",
- "ipProtocolType": "somestring",
- "ipVersion": "somestring",
- "lac": "somestring",
- "mcc": "somestring",
- "mnc": "somestring",
- "mobileFlowFieldsVersion": 1,
- "msisdn": "somestring",
- "otherEndpointIpAddress": "somestring",
- "otherEndpointPort": 1,
- "otherFunctionalRole": "somestring",
- "rac": "somestring",
- "radioAccessTechnology": "somestring",
- "reportingEndpointIpAddr": "somestring",
- "reportingEndpointPort": 1,
- "sac": "somestring",
- "samplingAlgorithm": 1,
- "tac": "somestring",
- "tunnelId": "somestring",
+ },
+ "gtpProtocolType": "somestring",
+ "gtpVersion": "somestring",
+ "httpHeader": "somestring",
+ "imei": "somestring",
+ "imsi": "somestring",
+ "ipProtocolType": "somestring",
+ "ipVersion": "somestring",
+ "lac": "somestring",
+ "mcc": "somestring",
+ "mnc": "somestring",
+ "mobileFlowFieldsVersion": 1,
+ "msisdn": "somestring",
+ "otherEndpointIpAddress": "somestring",
+ "otherEndpointPort": 1,
+ "otherFunctionalRole": "somestring",
+ "rac": "somestring",
+ "radioAccessTechnology": "somestring",
+ "reportingEndpointIpAddr": "somestring",
+ "reportingEndpointPort": 1,
+ "sac": "somestring",
+ "samplingAlgorithm": 1,
+ "tac": "somestring",
+ "tunnelId": "somestring",
"vlanId": "somestring"
- },
+ },
"otherFields": {
"hashOfNameValuePairArrays": [
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
- },
+ },
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
}
- ],
+ ],
"jsonObjects": [
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
- },
+ },
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
}
- ],
+ ],
"nameValuePairs": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"otherFieldsVersion": 1
- },
+ },
"sipSignalingFields": {
"additionalInformation": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "compressedSip": "somestring",
- "correlator": "somestring",
- "localIpAddress": "somestring",
- "localPort": "somestring",
- "remoteIpAddress": "somestring",
- "remotePort": "somestring",
- "sipSignalingFieldsVersion": 1,
- "summarySip": "somestring",
+ ],
+ "compressedSip": "somestring",
+ "correlator": "somestring",
+ "localIpAddress": "somestring",
+ "localPort": "somestring",
+ "remoteIpAddress": "somestring",
+ "remotePort": "somestring",
+ "sipSignalingFieldsVersion": 1,
+ "summarySip": "somestring",
"vendorVnfNameFields": {
- "vendorName": "somestring",
- "vfModuleName": "somestring",
+ "vendorName": "somestring",
+ "vfModuleName": "somestring",
"vnfName": "somestring"
}
- },
+ },
"stateChangeFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "newState": "inService",
- "oldState": "inService",
- "stateChangeFieldsVersion": 1,
+ ],
+ "newState": "inService",
+ "oldState": "inService",
+ "stateChangeFieldsVersion": 1,
"stateInterface": "somestring"
- },
+ },
"syslogFields": {
- "additionalFields": "somestring",
- "eventSourceHost": "somestring",
- "eventSourceType": "somestring",
- "syslogFacility": 1,
- "syslogFieldsVersion": 1,
- "syslogMsg": "somestring",
- "syslogPri": 1,
- "syslogProc": "somestring",
- "syslogProcId": 1,
- "syslogSData": "somestring",
- "syslogSdId": "somestring",
- "syslogSev": "Alert",
- "syslogTag": "somestring",
+ "additionalFields": "somestring",
+ "eventSourceHost": "somestring",
+ "eventSourceType": "somestring",
+ "syslogFacility": 1,
+ "syslogFieldsVersion": 1,
+ "syslogMsg": "somestring",
+ "syslogPri": 1,
+ "syslogProc": "somestring",
+ "syslogProcId": 1,
+ "syslogSData": "somestring",
+ "syslogSdId": "somestring",
+ "syslogSev": "Alert",
+ "syslogTag": "somestring",
"syslogVer": 1
- },
+ },
"thresholdCrossingAlertFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"additionalParameters": [
{
- "criticality": "CRIT",
- "name": "somestring",
- "thresholdCrossed": "somestring",
+ "criticality": "CRIT",
+ "name": "somestring",
+ "thresholdCrossed": "somestring",
"value": "somestring"
- },
+ },
{
- "criticality": "CRIT",
- "name": "somestring",
- "thresholdCrossed": "somestring",
+ "criticality": "CRIT",
+ "name": "somestring",
+ "thresholdCrossed": "somestring",
"value": "somestring"
}
- ],
- "alertAction": "CLEAR",
- "alertDescription": "somestring",
- "alertType": "CARD-ANOMALY",
- "alertValue": "somestring",
+ ],
+ "alertAction": "CLEAR",
+ "alertDescription": "somestring",
+ "alertType": "CARD-ANOMALY",
+ "alertValue": "somestring",
"associatedAlertIdList": [
- "somestring",
+ "somestring",
"somestring"
- ],
- "collectionTimestamp": "somestring",
- "dataCollector": "somestring",
- "elementType": "somestring",
- "eventSeverity": "CRITICAL",
- "eventStartTimestamp": "somestring",
- "interfaceName": "somestring",
- "networkService": "somestring",
- "possibleRootCause": "somestring",
+ ],
+ "collectionTimestamp": "somestring",
+ "dataCollector": "somestring",
+ "elementType": "somestring",
+ "eventSeverity": "CRITICAL",
+ "eventStartTimestamp": "somestring",
+ "interfaceName": "somestring",
+ "networkService": "somestring",
+ "possibleRootCause": "somestring",
"thresholdCrossingFieldsVersion": 1
- },
+ },
"voiceQualityFields": {
"additionalInformation": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "calleeSideCodec": "somestring",
- "callerSideCodec": "somestring",
- "correlator": "somestring",
+ ],
+ "calleeSideCodec": "somestring",
+ "callerSideCodec": "somestring",
+ "correlator": "somestring",
"endOfCallVqmSummaries": {
- "adjacencyName": "somestring",
- "endpointDescription": "Caller",
- "endpointJitter": 1,
- "endpointRtpOctetsDiscarded": 1,
- "endpointRtpOctetsReceived": 1,
- "endpointRtpOctetsSent": 1,
- "endpointRtpPacketsDiscarded": 1,
- "endpointRtpPacketsReceived": 1,
- "endpointRtpPacketsSent": 1,
- "localJitter": 1,
- "localRtpOctetsDiscarded": 1,
- "localRtpOctetsReceived": 1,
- "localRtpOctetsSent": 1,
- "localRtpPacketsDiscarded": 1,
- "localRtpPacketsReceived": 1,
- "localRtpPacketsSent": 1,
- "mosCqe": 1,
- "packetLossPercent": 1,
- "packetsLost": 1,
- "rFactor": 1,
+ "adjacencyName": "somestring",
+ "endpointDescription": "Caller",
+ "endpointJitter": 1,
+ "endpointRtpOctetsDiscarded": 1,
+ "endpointRtpOctetsReceived": 1,
+ "endpointRtpOctetsSent": 1,
+ "endpointRtpPacketsDiscarded": 1,
+ "endpointRtpPacketsReceived": 1,
+ "endpointRtpPacketsSent": 1,
+ "localJitter": 1,
+ "localRtpOctetsDiscarded": 1,
+ "localRtpOctetsReceived": 1,
+ "localRtpOctetsSent": 1,
+ "localRtpPacketsDiscarded": 1,
+ "localRtpPacketsReceived": 1,
+ "localRtpPacketsSent": 1,
+ "mosCqe": 1,
+ "packetLossPercent": 1,
+ "packetsLost": 1,
+ "rFactor": 1,
"roundTripDelay": 1
- },
- "midCallRtcp": "somestring",
- "phoneNumber": "somestring",
+ },
+ "midCallRtcp": "somestring",
+ "phoneNumber": "somestring",
"vendorVnfNameFields": {
- "vendorName": "somestring",
- "vfModuleName": "somestring",
+ "vendorName": "somestring",
+ "vfModuleName": "somestring",
"vnfName": "somestring"
- },
+ },
"voiceQualityFieldsVersion": 1
}
}
@@ -964,8 +964,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -982,8 +982,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1000,8 +1000,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1018,8 +1018,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1063,850 +1063,850 @@ Body
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
+ event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
.. code-block:: javascript
{
"event": {
"commonEventHeader": {
- "domain": "fault",
- "eventId": "somestring",
- "eventName": "somestring",
- "eventType": "somestring",
- "internalHeaderFields": {},
- "lastEpochMicrosec": 1,
- "nfNamingCode": "somestring",
- "nfcNamingCode": "somestring",
- "priority": "High",
- "reportingEntityId": "somestring",
- "reportingEntityName": "somestring",
- "sequence": 1,
- "sourceId": "somestring",
- "sourceName": "somestring",
- "startEpochMicrosec": 1,
+ "domain": "fault",
+ "eventId": "somestring",
+ "eventName": "somestring",
+ "eventType": "somestring",
+ "internalHeaderFields": {},
+ "lastEpochMicrosec": 1,
+ "nfNamingCode": "somestring",
+ "nfcNamingCode": "somestring",
+ "priority": "High",
+ "reportingEntityId": "somestring",
+ "reportingEntityName": "somestring",
+ "sequence": 1,
+ "sourceId": "somestring",
+ "sourceName": "somestring",
+ "startEpochMicrosec": 1,
"version": 1
- },
+ },
"faultFields": {
"alarmAdditionalInformation": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "alarmCondition": "somestring",
- "alarmInterfaceA": "somestring",
- "eventCategory": "somestring",
- "eventSeverity": "CRITICAL",
- "eventSourceType": "somestring",
- "faultFieldsVersion": 1,
- "specificProblem": "somestring",
+ ],
+ "alarmCondition": "somestring",
+ "alarmInterfaceA": "somestring",
+ "eventCategory": "somestring",
+ "eventSeverity": "CRITICAL",
+ "eventSourceType": "somestring",
+ "faultFieldsVersion": 1,
+ "specificProblem": "somestring",
"vfStatus": "Active"
- },
+ },
"heartbeatFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "heartbeatFieldsVersion": 1,
+ ],
+ "heartbeatFieldsVersion": 1,
"heartbeatInterval": 1
- },
+ },
"measurementsForVfScalingFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"additionalMeasurements": [
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
- },
+ },
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
}
- ],
+ ],
"additionalObjects": [
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
- },
+ },
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
}
- ],
+ ],
"codecUsageArray": [
{
- "codecIdentifier": "somestring",
+ "codecIdentifier": "somestring",
"numberInUse": 1
- },
+ },
{
- "codecIdentifier": "somestring",
+ "codecIdentifier": "somestring",
"numberInUse": 1
}
- ],
- "concurrentSessions": 1,
- "configuredEntities": 1,
+ ],
+ "concurrentSessions": 1,
+ "configuredEntities": 1,
"cpuUsageArray": [
{
- "cpuIdentifier": "somestring",
- "cpuIdle": 1,
- "cpuUsageInterrupt": 1,
- "cpuUsageNice": 1,
- "cpuUsageSoftIrq": 1,
- "cpuUsageSteal": 1,
- "cpuUsageSystem": 1,
- "cpuUsageUser": 1,
- "cpuWait": 1,
+ "cpuIdentifier": "somestring",
+ "cpuIdle": 1,
+ "cpuUsageInterrupt": 1,
+ "cpuUsageNice": 1,
+ "cpuUsageSoftIrq": 1,
+ "cpuUsageSteal": 1,
+ "cpuUsageSystem": 1,
+ "cpuUsageUser": 1,
+ "cpuWait": 1,
"percentUsage": 1
- },
- {
- "cpuIdentifier": "somestring",
- "cpuIdle": 1,
- "cpuUsageInterrupt": 1,
- "cpuUsageNice": 1,
- "cpuUsageSoftIrq": 1,
- "cpuUsageSteal": 1,
- "cpuUsageSystem": 1,
- "cpuUsageUser": 1,
- "cpuWait": 1,
+ },
+ {
+ "cpuIdentifier": "somestring",
+ "cpuIdle": 1,
+ "cpuUsageInterrupt": 1,
+ "cpuUsageNice": 1,
+ "cpuUsageSoftIrq": 1,
+ "cpuUsageSteal": 1,
+ "cpuUsageSystem": 1,
+ "cpuUsageUser": 1,
+ "cpuWait": 1,
"percentUsage": 1
}
- ],
+ ],
"diskUsageArray": [
{
- "diskIdentifier": "somestring",
- "diskIoTimeAvg": 1,
- "diskIoTimeLast": 1,
- "diskIoTimeMax": 1,
- "diskIoTimeMin": 1,
- "diskMergedReadAvg": 1,
- "diskMergedReadLast": 1,
- "diskMergedReadMax": 1,
- "diskMergedReadMin": 1,
- "diskMergedWriteAvg": 1,
- "diskMergedWriteLast": 1,
- "diskMergedWriteMax": 1,
- "diskMergedWriteMin": 1,
- "diskOctetsReadAvg": 1,
- "diskOctetsReadLast": 1,
- "diskOctetsReadMax": 1,
- "diskOctetsReadMin": 1,
- "diskOctetsWriteAvg": 1,
- "diskOctetsWriteLast": 1,
- "diskOctetsWriteMax": 1,
- "diskOctetsWriteMin": 1,
- "diskOpsReadAvg": 1,
- "diskOpsReadLast": 1,
- "diskOpsReadMax": 1,
- "diskOpsReadMin": 1,
- "diskOpsWriteAvg": 1,
- "diskOpsWriteLast": 1,
- "diskOpsWriteMax": 1,
- "diskOpsWriteMin": 1,
- "diskPendingOperationsAvg": 1,
- "diskPendingOperationsLast": 1,
- "diskPendingOperationsMax": 1,
- "diskPendingOperationsMin": 1,
- "diskTimeReadAvg": 1,
- "diskTimeReadLast": 1,
- "diskTimeReadMax": 1,
- "diskTimeReadMin": 1,
- "diskTimeWriteAvg": 1,
- "diskTimeWriteLast": 1,
- "diskTimeWriteMax": 1,
+ "diskIdentifier": "somestring",
+ "diskIoTimeAvg": 1,
+ "diskIoTimeLast": 1,
+ "diskIoTimeMax": 1,
+ "diskIoTimeMin": 1,
+ "diskMergedReadAvg": 1,
+ "diskMergedReadLast": 1,
+ "diskMergedReadMax": 1,
+ "diskMergedReadMin": 1,
+ "diskMergedWriteAvg": 1,
+ "diskMergedWriteLast": 1,
+ "diskMergedWriteMax": 1,
+ "diskMergedWriteMin": 1,
+ "diskOctetsReadAvg": 1,
+ "diskOctetsReadLast": 1,
+ "diskOctetsReadMax": 1,
+ "diskOctetsReadMin": 1,
+ "diskOctetsWriteAvg": 1,
+ "diskOctetsWriteLast": 1,
+ "diskOctetsWriteMax": 1,
+ "diskOctetsWriteMin": 1,
+ "diskOpsReadAvg": 1,
+ "diskOpsReadLast": 1,
+ "diskOpsReadMax": 1,
+ "diskOpsReadMin": 1,
+ "diskOpsWriteAvg": 1,
+ "diskOpsWriteLast": 1,
+ "diskOpsWriteMax": 1,
+ "diskOpsWriteMin": 1,
+ "diskPendingOperationsAvg": 1,
+ "diskPendingOperationsLast": 1,
+ "diskPendingOperationsMax": 1,
+ "diskPendingOperationsMin": 1,
+ "diskTimeReadAvg": 1,
+ "diskTimeReadLast": 1,
+ "diskTimeReadMax": 1,
+ "diskTimeReadMin": 1,
+ "diskTimeWriteAvg": 1,
+ "diskTimeWriteLast": 1,
+ "diskTimeWriteMax": 1,
"diskTimeWriteMin": 1
- },
- {
- "diskIdentifier": "somestring",
- "diskIoTimeAvg": 1,
- "diskIoTimeLast": 1,
- "diskIoTimeMax": 1,
- "diskIoTimeMin": 1,
- "diskMergedReadAvg": 1,
- "diskMergedReadLast": 1,
- "diskMergedReadMax": 1,
- "diskMergedReadMin": 1,
- "diskMergedWriteAvg": 1,
- "diskMergedWriteLast": 1,
- "diskMergedWriteMax": 1,
- "diskMergedWriteMin": 1,
- "diskOctetsReadAvg": 1,
- "diskOctetsReadLast": 1,
- "diskOctetsReadMax": 1,
- "diskOctetsReadMin": 1,
- "diskOctetsWriteAvg": 1,
- "diskOctetsWriteLast": 1,
- "diskOctetsWriteMax": 1,
- "diskOctetsWriteMin": 1,
- "diskOpsReadAvg": 1,
- "diskOpsReadLast": 1,
- "diskOpsReadMax": 1,
- "diskOpsReadMin": 1,
- "diskOpsWriteAvg": 1,
- "diskOpsWriteLast": 1,
- "diskOpsWriteMax": 1,
- "diskOpsWriteMin": 1,
- "diskPendingOperationsAvg": 1,
- "diskPendingOperationsLast": 1,
- "diskPendingOperationsMax": 1,
- "diskPendingOperationsMin": 1,
- "diskTimeReadAvg": 1,
- "diskTimeReadLast": 1,
- "diskTimeReadMax": 1,
- "diskTimeReadMin": 1,
- "diskTimeWriteAvg": 1,
- "diskTimeWriteLast": 1,
- "diskTimeWriteMax": 1,
+ },
+ {
+ "diskIdentifier": "somestring",
+ "diskIoTimeAvg": 1,
+ "diskIoTimeLast": 1,
+ "diskIoTimeMax": 1,
+ "diskIoTimeMin": 1,
+ "diskMergedReadAvg": 1,
+ "diskMergedReadLast": 1,
+ "diskMergedReadMax": 1,
+ "diskMergedReadMin": 1,
+ "diskMergedWriteAvg": 1,
+ "diskMergedWriteLast": 1,
+ "diskMergedWriteMax": 1,
+ "diskMergedWriteMin": 1,
+ "diskOctetsReadAvg": 1,
+ "diskOctetsReadLast": 1,
+ "diskOctetsReadMax": 1,
+ "diskOctetsReadMin": 1,
+ "diskOctetsWriteAvg": 1,
+ "diskOctetsWriteLast": 1,
+ "diskOctetsWriteMax": 1,
+ "diskOctetsWriteMin": 1,
+ "diskOpsReadAvg": 1,
+ "diskOpsReadLast": 1,
+ "diskOpsReadMax": 1,
+ "diskOpsReadMin": 1,
+ "diskOpsWriteAvg": 1,
+ "diskOpsWriteLast": 1,
+ "diskOpsWriteMax": 1,
+ "diskOpsWriteMin": 1,
+ "diskPendingOperationsAvg": 1,
+ "diskPendingOperationsLast": 1,
+ "diskPendingOperationsMax": 1,
+ "diskPendingOperationsMin": 1,
+ "diskTimeReadAvg": 1,
+ "diskTimeReadLast": 1,
+ "diskTimeReadMax": 1,
+ "diskTimeReadMin": 1,
+ "diskTimeWriteAvg": 1,
+ "diskTimeWriteLast": 1,
+ "diskTimeWriteMax": 1,
"diskTimeWriteMin": 1
}
- ],
+ ],
"featureUsageArray": [
{
- "featureIdentifier": "somestring",
+ "featureIdentifier": "somestring",
"featureUtilization": 1
- },
+ },
{
- "featureIdentifier": "somestring",
+ "featureIdentifier": "somestring",
"featureUtilization": 1
}
- ],
+ ],
"filesystemUsageArray": [
{
- "blockConfigured": 1,
- "blockIops": 1,
- "blockUsed": 1,
- "ephemeralConfigured": 1,
- "ephemeralIops": 1,
- "ephemeralUsed": 1,
+ "blockConfigured": 1,
+ "blockIops": 1,
+ "blockUsed": 1,
+ "ephemeralConfigured": 1,
+ "ephemeralIops": 1,
+ "ephemeralUsed": 1,
"filesystemName": "somestring"
- },
- {
- "blockConfigured": 1,
- "blockIops": 1,
- "blockUsed": 1,
- "ephemeralConfigured": 1,
- "ephemeralIops": 1,
- "ephemeralUsed": 1,
+ },
+ {
+ "blockConfigured": 1,
+ "blockIops": 1,
+ "blockUsed": 1,
+ "ephemeralConfigured": 1,
+ "ephemeralIops": 1,
+ "ephemeralUsed": 1,
"filesystemName": "somestring"
}
- ],
+ ],
"latencyDistribution": [
{
- "countsInTheBucket": 1,
- "highEndOfLatencyBucket": 1,
+ "countsInTheBucket": 1,
+ "highEndOfLatencyBucket": 1,
"lowEndOfLatencyBucket": 1
- },
+ },
{
- "countsInTheBucket": 1,
- "highEndOfLatencyBucket": 1,
+ "countsInTheBucket": 1,
+ "highEndOfLatencyBucket": 1,
"lowEndOfLatencyBucket": 1
}
- ],
- "meanRequestLatency": 1,
- "measurementInterval": 1,
- "measurementsForVfScalingVersion": 1,
+ ],
+ "meanRequestLatency": 1,
+ "measurementInterval": 1,
+ "measurementsForVfScalingVersion": 1,
"memoryUsageArray": [
{
- "memoryBuffered": 1,
- "memoryCached": 1,
- "memoryConfigured": 1,
- "memoryFree": 1,
- "memorySlabRecl": 1,
- "memorySlabUnrecl": 1,
- "memoryUsed": 1,
+ "memoryBuffered": 1,
+ "memoryCached": 1,
+ "memoryConfigured": 1,
+ "memoryFree": 1,
+ "memorySlabRecl": 1,
+ "memorySlabUnrecl": 1,
+ "memoryUsed": 1,
"vmIdentifier": "somestring"
- },
- {
- "memoryBuffered": 1,
- "memoryCached": 1,
- "memoryConfigured": 1,
- "memoryFree": 1,
- "memorySlabRecl": 1,
- "memorySlabUnrecl": 1,
- "memoryUsed": 1,
+ },
+ {
+ "memoryBuffered": 1,
+ "memoryCached": 1,
+ "memoryConfigured": 1,
+ "memoryFree": 1,
+ "memorySlabRecl": 1,
+ "memorySlabUnrecl": 1,
+ "memoryUsed": 1,
"vmIdentifier": "somestring"
}
- ],
- "numberOfMediaPortsInUse": 1,
- "requestRate": 1,
+ ],
+ "numberOfMediaPortsInUse": 1,
+ "requestRate": 1,
"vNicPerformanceArray": [
{
- "receivedBroadcastPacketsAccumulated": 1,
- "receivedBroadcastPacketsDelta": 1,
- "receivedDiscardedPacketsAccumulated": 1,
- "receivedDiscardedPacketsDelta": 1,
- "receivedErrorPacketsAccumulated": 1,
- "receivedErrorPacketsDelta": 1,
- "receivedMulticastPacketsAccumulated": 1,
- "receivedMulticastPacketsDelta": 1,
- "receivedOctetsAccumulated": 1,
- "receivedOctetsDelta": 1,
- "receivedTotalPacketsAccumulated": 1,
- "receivedTotalPacketsDelta": 1,
- "receivedUnicastPacketsAccumulated": 1,
- "receivedUnicastPacketsDelta": 1,
- "transmittedBroadcastPacketsAccumulated": 1,
- "transmittedBroadcastPacketsDelta": 1,
- "transmittedDiscardedPacketsAccumulated": 1,
- "transmittedDiscardedPacketsDelta": 1,
- "transmittedErrorPacketsAccumulated": 1,
- "transmittedErrorPacketsDelta": 1,
- "transmittedMulticastPacketsAccumulated": 1,
- "transmittedMulticastPacketsDelta": 1,
- "transmittedOctetsAccumulated": 1,
- "transmittedOctetsDelta": 1,
- "transmittedTotalPacketsAccumulated": 1,
- "transmittedTotalPacketsDelta": 1,
- "transmittedUnicastPacketsAccumulated": 1,
- "transmittedUnicastPacketsDelta": 1,
- "vNicIdentifier": "somestring",
+ "receivedBroadcastPacketsAccumulated": 1,
+ "receivedBroadcastPacketsDelta": 1,
+ "receivedDiscardedPacketsAccumulated": 1,
+ "receivedDiscardedPacketsDelta": 1,
+ "receivedErrorPacketsAccumulated": 1,
+ "receivedErrorPacketsDelta": 1,
+ "receivedMulticastPacketsAccumulated": 1,
+ "receivedMulticastPacketsDelta": 1,
+ "receivedOctetsAccumulated": 1,
+ "receivedOctetsDelta": 1,
+ "receivedTotalPacketsAccumulated": 1,
+ "receivedTotalPacketsDelta": 1,
+ "receivedUnicastPacketsAccumulated": 1,
+ "receivedUnicastPacketsDelta": 1,
+ "transmittedBroadcastPacketsAccumulated": 1,
+ "transmittedBroadcastPacketsDelta": 1,
+ "transmittedDiscardedPacketsAccumulated": 1,
+ "transmittedDiscardedPacketsDelta": 1,
+ "transmittedErrorPacketsAccumulated": 1,
+ "transmittedErrorPacketsDelta": 1,
+ "transmittedMulticastPacketsAccumulated": 1,
+ "transmittedMulticastPacketsDelta": 1,
+ "transmittedOctetsAccumulated": 1,
+ "transmittedOctetsDelta": 1,
+ "transmittedTotalPacketsAccumulated": 1,
+ "transmittedTotalPacketsDelta": 1,
+ "transmittedUnicastPacketsAccumulated": 1,
+ "transmittedUnicastPacketsDelta": 1,
+ "vNicIdentifier": "somestring",
"valuesAreSuspect": "true"
- },
- {
- "receivedBroadcastPacketsAccumulated": 1,
- "receivedBroadcastPacketsDelta": 1,
- "receivedDiscardedPacketsAccumulated": 1,
- "receivedDiscardedPacketsDelta": 1,
- "receivedErrorPacketsAccumulated": 1,
- "receivedErrorPacketsDelta": 1,
- "receivedMulticastPacketsAccumulated": 1,
- "receivedMulticastPacketsDelta": 1,
- "receivedOctetsAccumulated": 1,
- "receivedOctetsDelta": 1,
- "receivedTotalPacketsAccumulated": 1,
- "receivedTotalPacketsDelta": 1,
- "receivedUnicastPacketsAccumulated": 1,
- "receivedUnicastPacketsDelta": 1,
- "transmittedBroadcastPacketsAccumulated": 1,
- "transmittedBroadcastPacketsDelta": 1,
- "transmittedDiscardedPacketsAccumulated": 1,
- "transmittedDiscardedPacketsDelta": 1,
- "transmittedErrorPacketsAccumulated": 1,
- "transmittedErrorPacketsDelta": 1,
- "transmittedMulticastPacketsAccumulated": 1,
- "transmittedMulticastPacketsDelta": 1,
- "transmittedOctetsAccumulated": 1,
- "transmittedOctetsDelta": 1,
- "transmittedTotalPacketsAccumulated": 1,
- "transmittedTotalPacketsDelta": 1,
- "transmittedUnicastPacketsAccumulated": 1,
- "transmittedUnicastPacketsDelta": 1,
- "vNicIdentifier": "somestring",
+ },
+ {
+ "receivedBroadcastPacketsAccumulated": 1,
+ "receivedBroadcastPacketsDelta": 1,
+ "receivedDiscardedPacketsAccumulated": 1,
+ "receivedDiscardedPacketsDelta": 1,
+ "receivedErrorPacketsAccumulated": 1,
+ "receivedErrorPacketsDelta": 1,
+ "receivedMulticastPacketsAccumulated": 1,
+ "receivedMulticastPacketsDelta": 1,
+ "receivedOctetsAccumulated": 1,
+ "receivedOctetsDelta": 1,
+ "receivedTotalPacketsAccumulated": 1,
+ "receivedTotalPacketsDelta": 1,
+ "receivedUnicastPacketsAccumulated": 1,
+ "receivedUnicastPacketsDelta": 1,
+ "transmittedBroadcastPacketsAccumulated": 1,
+ "transmittedBroadcastPacketsDelta": 1,
+ "transmittedDiscardedPacketsAccumulated": 1,
+ "transmittedDiscardedPacketsDelta": 1,
+ "transmittedErrorPacketsAccumulated": 1,
+ "transmittedErrorPacketsDelta": 1,
+ "transmittedMulticastPacketsAccumulated": 1,
+ "transmittedMulticastPacketsDelta": 1,
+ "transmittedOctetsAccumulated": 1,
+ "transmittedOctetsDelta": 1,
+ "transmittedTotalPacketsAccumulated": 1,
+ "transmittedTotalPacketsDelta": 1,
+ "transmittedUnicastPacketsAccumulated": 1,
+ "transmittedUnicastPacketsDelta": 1,
+ "vNicIdentifier": "somestring",
"valuesAreSuspect": "true"
}
- ],
+ ],
"vnfcScalingMetric": 1
- },
+ },
"mobileFlowFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "appProtocolType": "somestring",
- "appProtocolVersion": "somestring",
- "applicationType": "somestring",
- "cid": "somestring",
- "connectionType": "somestring",
- "ecgi": "somestring",
- "flowDirection": "somestring",
+ ],
+ "appProtocolType": "somestring",
+ "appProtocolVersion": "somestring",
+ "applicationType": "somestring",
+ "cid": "somestring",
+ "connectionType": "somestring",
+ "ecgi": "somestring",
+ "flowDirection": "somestring",
"gtpPerFlowMetrics": {
- "avgBitErrorRate": 1,
- "avgPacketDelayVariation": 1,
- "avgPacketLatency": 1,
- "avgReceiveThroughput": 1,
- "avgTransmitThroughput": 1,
- "durConnectionFailedStatus": 1,
- "durTunnelFailedStatus": 1,
- "flowActivatedBy": "somestring",
- "flowActivationEpoch": 1,
- "flowActivationMicrosec": 1,
- "flowActivationTime": "somestring",
- "flowDeactivatedBy": "somestring",
- "flowDeactivationEpoch": 1,
- "flowDeactivationMicrosec": 1,
- "flowDeactivationTime": "somestring",
- "flowStatus": "somestring",
- "gtpConnectionStatus": "somestring",
- "gtpTunnelStatus": "somestring",
+ "avgBitErrorRate": 1,
+ "avgPacketDelayVariation": 1,
+ "avgPacketLatency": 1,
+ "avgReceiveThroughput": 1,
+ "avgTransmitThroughput": 1,
+ "durConnectionFailedStatus": 1,
+ "durTunnelFailedStatus": 1,
+ "flowActivatedBy": "somestring",
+ "flowActivationEpoch": 1,
+ "flowActivationMicrosec": 1,
+ "flowActivationTime": "somestring",
+ "flowDeactivatedBy": "somestring",
+ "flowDeactivationEpoch": 1,
+ "flowDeactivationMicrosec": 1,
+ "flowDeactivationTime": "somestring",
+ "flowStatus": "somestring",
+ "gtpConnectionStatus": "somestring",
+ "gtpTunnelStatus": "somestring",
"ipTosCountList": [
[
- 1,
+ 1,
1
- ],
+ ],
[
- 1,
+ 1,
1
]
- ],
+ ],
"ipTosList": [
- "somestring",
+ "somestring",
"somestring"
- ],
- "largePacketRtt": 1,
- "largePacketThreshold": 1,
- "maxPacketDelayVariation": 1,
- "maxReceiveBitRate": 1,
- "maxTransmitBitRate": 1,
+ ],
+ "largePacketRtt": 1,
+ "largePacketThreshold": 1,
+ "maxPacketDelayVariation": 1,
+ "maxReceiveBitRate": 1,
+ "maxTransmitBitRate": 1,
"mobileQciCosCountList": [
[
- 1,
+ 1,
1
- ],
+ ],
[
- 1,
+ 1,
1
]
- ],
+ ],
"mobileQciCosList": [
- "somestring",
+ "somestring",
"somestring"
- ],
- "numActivationFailures": 1,
- "numBitErrors": 1,
- "numBytesReceived": 1,
- "numBytesTransmitted": 1,
- "numDroppedPackets": 1,
- "numGtpEchoFailures": 1,
- "numGtpTunnelErrors": 1,
- "numHttpErrors": 1,
- "numL7BytesReceived": 1,
- "numL7BytesTransmitted": 1,
- "numLostPackets": 1,
- "numOutOfOrderPackets": 1,
- "numPacketErrors": 1,
- "numPacketsReceivedExclRetrans": 1,
- "numPacketsReceivedInclRetrans": 1,
- "numPacketsTransmittedInclRetrans": 1,
- "numRetries": 1,
- "numTimeouts": 1,
- "numTunneledL7BytesReceived": 1,
- "roundTripTime": 1,
+ ],
+ "numActivationFailures": 1,
+ "numBitErrors": 1,
+ "numBytesReceived": 1,
+ "numBytesTransmitted": 1,
+ "numDroppedPackets": 1,
+ "numGtpEchoFailures": 1,
+ "numGtpTunnelErrors": 1,
+ "numHttpErrors": 1,
+ "numL7BytesReceived": 1,
+ "numL7BytesTransmitted": 1,
+ "numLostPackets": 1,
+ "numOutOfOrderPackets": 1,
+ "numPacketErrors": 1,
+ "numPacketsReceivedExclRetrans": 1,
+ "numPacketsReceivedInclRetrans": 1,
+ "numPacketsTransmittedInclRetrans": 1,
+ "numRetries": 1,
+ "numTimeouts": 1,
+ "numTunneledL7BytesReceived": 1,
+ "roundTripTime": 1,
"tcpFlagCountList": [
[
- 1,
+ 1,
1
- ],
+ ],
[
- 1,
+ 1,
1
]
- ],
+ ],
"tcpFlagList": [
- "somestring",
+ "somestring",
"somestring"
- ],
+ ],
"timeToFirstByte": 1
- },
- "gtpProtocolType": "somestring",
- "gtpVersion": "somestring",
- "httpHeader": "somestring",
- "imei": "somestring",
- "imsi": "somestring",
- "ipProtocolType": "somestring",
- "ipVersion": "somestring",
- "lac": "somestring",
- "mcc": "somestring",
- "mnc": "somestring",
- "mobileFlowFieldsVersion": 1,
- "msisdn": "somestring",
- "otherEndpointIpAddress": "somestring",
- "otherEndpointPort": 1,
- "otherFunctionalRole": "somestring",
- "rac": "somestring",
- "radioAccessTechnology": "somestring",
- "reportingEndpointIpAddr": "somestring",
- "reportingEndpointPort": 1,
- "sac": "somestring",
- "samplingAlgorithm": 1,
- "tac": "somestring",
- "tunnelId": "somestring",
+ },
+ "gtpProtocolType": "somestring",
+ "gtpVersion": "somestring",
+ "httpHeader": "somestring",
+ "imei": "somestring",
+ "imsi": "somestring",
+ "ipProtocolType": "somestring",
+ "ipVersion": "somestring",
+ "lac": "somestring",
+ "mcc": "somestring",
+ "mnc": "somestring",
+ "mobileFlowFieldsVersion": 1,
+ "msisdn": "somestring",
+ "otherEndpointIpAddress": "somestring",
+ "otherEndpointPort": 1,
+ "otherFunctionalRole": "somestring",
+ "rac": "somestring",
+ "radioAccessTechnology": "somestring",
+ "reportingEndpointIpAddr": "somestring",
+ "reportingEndpointPort": 1,
+ "sac": "somestring",
+ "samplingAlgorithm": 1,
+ "tac": "somestring",
+ "tunnelId": "somestring",
"vlanId": "somestring"
- },
+ },
"otherFields": {
"hashOfNameValuePairArrays": [
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
- },
+ },
{
"arrayOfFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"name": "somestring"
}
- ],
+ ],
"jsonObjects": [
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
- },
+ },
{
- "nfSubscribedObjectName": "somestring",
- "nfSubscriptionId": "somestring",
+ "nfSubscribedObjectName": "somestring",
+ "nfSubscriptionId": "somestring",
"objectInstances": [
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
- },
+ },
{
- "objectInstance": {},
- "objectInstanceEpochMicrosec": 1,
+ "objectInstance": {},
+ "objectInstanceEpochMicrosec": 1,
"objectKeys": [
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
- },
+ },
{
- "keyName": "somestring",
- "keyOrder": 1,
+ "keyName": "somestring",
+ "keyOrder": 1,
"keyValue": "somestring"
}
]
}
- ],
- "objectName": "somestring",
- "objectSchema": "somestring",
+ ],
+ "objectName": "somestring",
+ "objectSchema": "somestring",
"objectSchemaUrl": "somestring"
}
- ],
+ ],
"nameValuePairs": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"otherFieldsVersion": 1
- },
+ },
"sipSignalingFields": {
"additionalInformation": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "compressedSip": "somestring",
- "correlator": "somestring",
- "localIpAddress": "somestring",
- "localPort": "somestring",
- "remoteIpAddress": "somestring",
- "remotePort": "somestring",
- "sipSignalingFieldsVersion": 1,
- "summarySip": "somestring",
+ ],
+ "compressedSip": "somestring",
+ "correlator": "somestring",
+ "localIpAddress": "somestring",
+ "localPort": "somestring",
+ "remoteIpAddress": "somestring",
+ "remotePort": "somestring",
+ "sipSignalingFieldsVersion": 1,
+ "summarySip": "somestring",
"vendorVnfNameFields": {
- "vendorName": "somestring",
- "vfModuleName": "somestring",
+ "vendorName": "somestring",
+ "vfModuleName": "somestring",
"vnfName": "somestring"
}
- },
+ },
"stateChangeFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "newState": "inService",
- "oldState": "inService",
- "stateChangeFieldsVersion": 1,
+ ],
+ "newState": "inService",
+ "oldState": "inService",
+ "stateChangeFieldsVersion": 1,
"stateInterface": "somestring"
- },
+ },
"syslogFields": {
- "additionalFields": "somestring",
- "eventSourceHost": "somestring",
- "eventSourceType": "somestring",
- "syslogFacility": 1,
- "syslogFieldsVersion": 1,
- "syslogMsg": "somestring",
- "syslogPri": 1,
- "syslogProc": "somestring",
- "syslogProcId": 1,
- "syslogSData": "somestring",
- "syslogSdId": "somestring",
- "syslogSev": "Alert",
- "syslogTag": "somestring",
+ "additionalFields": "somestring",
+ "eventSourceHost": "somestring",
+ "eventSourceType": "somestring",
+ "syslogFacility": 1,
+ "syslogFieldsVersion": 1,
+ "syslogMsg": "somestring",
+ "syslogPri": 1,
+ "syslogProc": "somestring",
+ "syslogProcId": 1,
+ "syslogSData": "somestring",
+ "syslogSdId": "somestring",
+ "syslogSev": "Alert",
+ "syslogTag": "somestring",
"syslogVer": 1
- },
+ },
"thresholdCrossingAlertFields": {
"additionalFields": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
+ ],
"additionalParameters": [
{
- "criticality": "CRIT",
- "name": "somestring",
- "thresholdCrossed": "somestring",
+ "criticality": "CRIT",
+ "name": "somestring",
+ "thresholdCrossed": "somestring",
"value": "somestring"
- },
+ },
{
- "criticality": "CRIT",
- "name": "somestring",
- "thresholdCrossed": "somestring",
+ "criticality": "CRIT",
+ "name": "somestring",
+ "thresholdCrossed": "somestring",
"value": "somestring"
}
- ],
- "alertAction": "CLEAR",
- "alertDescription": "somestring",
- "alertType": "CARD-ANOMALY",
- "alertValue": "somestring",
+ ],
+ "alertAction": "CLEAR",
+ "alertDescription": "somestring",
+ "alertType": "CARD-ANOMALY",
+ "alertValue": "somestring",
"associatedAlertIdList": [
- "somestring",
+ "somestring",
"somestring"
- ],
- "collectionTimestamp": "somestring",
- "dataCollector": "somestring",
- "elementType": "somestring",
- "eventSeverity": "CRITICAL",
- "eventStartTimestamp": "somestring",
- "interfaceName": "somestring",
- "networkService": "somestring",
- "possibleRootCause": "somestring",
+ ],
+ "collectionTimestamp": "somestring",
+ "dataCollector": "somestring",
+ "elementType": "somestring",
+ "eventSeverity": "CRITICAL",
+ "eventStartTimestamp": "somestring",
+ "interfaceName": "somestring",
+ "networkService": "somestring",
+ "possibleRootCause": "somestring",
"thresholdCrossingFieldsVersion": 1
- },
+ },
"voiceQualityFields": {
"additionalInformation": [
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
- },
+ },
{
- "name": "somestring",
+ "name": "somestring",
"value": "somestring"
}
- ],
- "calleeSideCodec": "somestring",
- "callerSideCodec": "somestring",
- "correlator": "somestring",
+ ],
+ "calleeSideCodec": "somestring",
+ "callerSideCodec": "somestring",
+ "correlator": "somestring",
"endOfCallVqmSummaries": {
- "adjacencyName": "somestring",
- "endpointDescription": "Caller",
- "endpointJitter": 1,
- "endpointRtpOctetsDiscarded": 1,
- "endpointRtpOctetsReceived": 1,
- "endpointRtpOctetsSent": 1,
- "endpointRtpPacketsDiscarded": 1,
- "endpointRtpPacketsReceived": 1,
- "endpointRtpPacketsSent": 1,
- "localJitter": 1,
- "localRtpOctetsDiscarded": 1,
- "localRtpOctetsReceived": 1,
- "localRtpOctetsSent": 1,
- "localRtpPacketsDiscarded": 1,
- "localRtpPacketsReceived": 1,
- "localRtpPacketsSent": 1,
- "mosCqe": 1,
- "packetLossPercent": 1,
- "packetsLost": 1,
- "rFactor": 1,
+ "adjacencyName": "somestring",
+ "endpointDescription": "Caller",
+ "endpointJitter": 1,
+ "endpointRtpOctetsDiscarded": 1,
+ "endpointRtpOctetsReceived": 1,
+ "endpointRtpOctetsSent": 1,
+ "endpointRtpPacketsDiscarded": 1,
+ "endpointRtpPacketsReceived": 1,
+ "endpointRtpPacketsSent": 1,
+ "localJitter": 1,
+ "localRtpOctetsDiscarded": 1,
+ "localRtpOctetsReceived": 1,
+ "localRtpOctetsSent": 1,
+ "localRtpPacketsDiscarded": 1,
+ "localRtpPacketsReceived": 1,
+ "localRtpPacketsSent": 1,
+ "mosCqe": 1,
+ "packetLossPercent": 1,
+ "packetsLost": 1,
+ "rFactor": 1,
"roundTripDelay": 1
- },
- "midCallRtcp": "somestring",
- "phoneNumber": "somestring",
+ },
+ "midCallRtcp": "somestring",
+ "phoneNumber": "somestring",
"vendorVnfNameFields": {
- "vendorName": "somestring",
- "vfModuleName": "somestring",
+ "vendorName": "somestring",
+ "vfModuleName": "somestring",
"vnfName": "somestring"
- },
+ },
"voiceQualityFieldsVersion": 1
}
}
@@ -1928,8 +1928,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1946,8 +1946,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1964,8 +1964,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1982,8 +1982,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
.. code-block:: javascript
{
- "code": 1,
- "message": "somestring",
+ "code": 1,
+ "message": "somestring",
"type": "somestring"
}
@@ -1997,7 +1997,7 @@ Security
:widths: 15, 45
:ref:`basicAuth <securities_basicAuth>`, ""
-
+
Data Structures
~~~~~~~~~~~~~~~
@@ -2011,9 +2011,9 @@ ApiResponseMessage Model Structure
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- code | No | integer | int32 | |
- message | No | string | | |
- type | No | string | | |
+ code | No | integer | int32 | |
+ message | No | string | | |
+ type | No | string | | |
.. _d_f598222d7a83ca9c3538556b263682d1:
@@ -2025,7 +2025,7 @@ VES5Request Model Structure
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
+ event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | |
.. _d_df249c51a416f54e5609f2ffffe059c0:
@@ -2039,8 +2039,8 @@ number of times an identified codec was used over the measurementInterval
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- codecIdentifier | Yes | string | | |
- numberInUse | Yes | integer | | |
+ codecIdentifier | Yes | string | | |
+ numberInUse | Yes | integer | | |
.. _d_a68e1b21fdcef792db73f711201c56ad:
@@ -2054,10 +2054,10 @@ command from an event collector toward an event source
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} |
- eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | |
- heartbeatInterval | No | integer | | |
- measurementInterval | No | integer | | |
+ commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} |
+ eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | |
+ heartbeatInterval | No | integer | | |
+ measurementInterval | No | integer | | |
.. _d_2dc9a27be1410f60241c5f63c636bb7e:
@@ -2075,7 +2075,7 @@ fields common to all events
eventId | Yes | string | | | event key that is unique to the event source
eventName | Yes | string | | | unique event name
eventType | No | string | | | for example - applicationVnf, guestOS, hostOS, platform
- internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | |
+ internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | |
lastEpochMicrosec | Yes | number | | | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds
nfNamingCode | No | string | | | 4 character network function type, aligned with vnf naming standards
nfcNamingCode | No | string | | | 3 character network function component type, aligned with vfc naming standards
@@ -2100,10 +2100,10 @@ performance counter
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} |
- name | Yes | string | | |
- thresholdCrossed | Yes | string | | |
- value | Yes | string | | |
+ criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} |
+ name | Yes | string | | |
+ thresholdCrossed | Yes | string | | |
+ value | Yes | string | | |
.. _d_6f081937f31c09078c8acf9212d6c449:
@@ -2196,23 +2196,23 @@ provides end of call voice quality metrics
adjacencyName | Yes | string | | | adjacency name
endpointDescription | Yes | string | | {'enum': ['Caller', 'Callee']} | Either Caller or Callee
- endpointJitter | No | number | | |
- endpointRtpOctetsDiscarded | No | number | | |
- endpointRtpOctetsReceived | No | number | | |
- endpointRtpOctetsSent | No | number | | |
- endpointRtpPacketsDiscarded | No | number | | |
- endpointRtpPacketsReceived | No | number | | |
- endpointRtpPacketsSent | No | number | | |
- localJitter | No | number | | |
- localRtpOctetsDiscarded | No | number | | |
- localRtpOctetsReceived | No | number | | |
- localRtpOctetsSent | No | number | | |
- localRtpPacketsDiscarded | No | number | | |
- localRtpPacketsReceived | No | number | | |
- localRtpPacketsSent | No | number | | |
+ endpointJitter | No | number | | |
+ endpointRtpOctetsDiscarded | No | number | | |
+ endpointRtpOctetsReceived | No | number | | |
+ endpointRtpOctetsSent | No | number | | |
+ endpointRtpPacketsDiscarded | No | number | | |
+ endpointRtpPacketsReceived | No | number | | |
+ endpointRtpPacketsSent | No | number | | |
+ localJitter | No | number | | |
+ localRtpOctetsDiscarded | No | number | | |
+ localRtpOctetsReceived | No | number | | |
+ localRtpOctetsSent | No | number | | |
+ localRtpPacketsDiscarded | No | number | | |
+ localRtpPacketsReceived | No | number | | |
+ localRtpPacketsSent | No | number | | |
mosCqe | No | number | | | 1-5 1dp
packetLossPercent | No | number | | | Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)
- packetsLost | No | number | | |
+ packetsLost | No | number | | |
rFactor | No | number | | | 0-100
roundTripDelay | No | number | | | millisecs
@@ -2228,17 +2228,17 @@ the root level of the common event format
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | |
- faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | |
- heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | |
- measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | |
- mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | |
- otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | |
- sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | |
- stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | |
- syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | |
- thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | |
- voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | |
+ commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | |
+ faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | |
+ heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | |
+ measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | |
+ mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | |
+ otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | |
+ sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | |
+ stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | |
+ syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | |
+ thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | |
+ voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | |
.. _d_4089a4a9ee684770c6f37a588a577589:
@@ -2290,8 +2290,8 @@ number of times an identified feature was used over the measurementInterval
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- featureIdentifier | Yes | string | | |
- featureUtilization | Yes | integer | | |
+ featureIdentifier | Yes | string | | |
+ featureUtilization | Yes | integer | | |
.. _d_a9799335edbbc52c7f0c5191f7bd09ee:
@@ -2305,8 +2305,8 @@ name value pair
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- name | Yes | string | | |
- value | Yes | string | | |
+ name | Yes | string | | |
+ value | Yes | string | | |
.. _d_18e1fa5fd6774deefce826b075f8b6e7:
@@ -2320,13 +2320,13 @@ disk usage of an identified virtual machine in gigabytes and/or gigabytes per se
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- blockConfigured | Yes | number | | |
- blockIops | Yes | number | | |
- blockUsed | Yes | number | | |
- ephemeralConfigured | Yes | number | | |
- ephemeralIops | Yes | number | | |
- ephemeralUsed | Yes | number | | |
- filesystemName | Yes | string | | |
+ blockConfigured | Yes | number | | |
+ blockIops | Yes | number | | |
+ blockUsed | Yes | number | | |
+ ephemeralConfigured | Yes | number | | |
+ ephemeralIops | Yes | number | | |
+ ephemeralUsed | Yes | number | | |
+ filesystemName | Yes | string | | |
.. _d_bb1527d221e848e0896c78552979238b:
@@ -2488,9 +2488,9 @@ number of counts falling within a defined latency bucket
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- countsInTheBucket | Yes | number | | |
- highEndOfLatencyBucket | No | number | | |
- lowEndOfLatencyBucket | No | number | | |
+ countsInTheBucket | Yes | number | | |
+ highEndOfLatencyBucket | No | number | | |
+ lowEndOfLatencyBucket | No | number | | |
.. _d_669cf98e276c9992abd27056c432bbb2:
@@ -2565,7 +2565,7 @@ mobileFlow fields
connectionType | No | string | | | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc
ecgi | No | string | | | Evolved Cell Global Id
flowDirection | Yes | string | | | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow
- gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | |
+ gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | |
gtpProtocolType | No | string | | | GTP protocol
gtpVersion | No | string | | | GTP protocol version
httpHeader | No | string | | | HTTP request header, if the flow connects to a node referenced by HTTP
@@ -2604,7 +2604,7 @@ an array of name value pairs along with a name for the array
:widths: 20, 10, 15, 15, 30, 25
arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name value pairs
- name | Yes | string | | |
+ name | Yes | string | | |
.. _d_5a79cd7ce784d60fd832d9c7c0a24322:
@@ -2661,7 +2661,7 @@ sip signaling fields
remotePort | Yes | string | | | port of peer endpoint
sipSignalingFieldsVersion | Yes | number | | | version of the sipSignalingFields block
summarySip | No | string | | | the SIP Method or Response (INVITE, 200 OK, BYE, etc)
- vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | |
+ vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | |
.. _d_c5450f1a263d0a2b0c64c96119f7d759:
@@ -2704,24 +2704,24 @@ syslogFields Model Structure
sysLog fields
.. csv-table::
- :delim: |
+ :delim: ;
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- additionalFields | No | string | | | additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|'
- eventSourceHost | No | string | | | hostname of the device
- eventSourceType | Yes | string | | | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction
- syslogFacility | No | integer | | | numeric code from 0 to 23 for facility--see table in documentation
- syslogFieldsVersion | Yes | number | | | version of the syslogFields block
- syslogMsg | Yes | string | | | syslog message
- syslogPri | No | integer | | | 0-192 combined severity and facility
- syslogProc | No | string | | | identifies the application that originated the message
- syslogProcId | No | number | | | a change in the value of this field indicates a discontinuity in syslog reporting
- syslogSData | No | string | | | syslog structured data consisting of a structured data Id followed by a set of key value pairs
- syslogSdId | No | string | | | 0-32 char in format name@number for example ourSDID@32473
- syslogSev | No | string | | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for severity derived from syslogPri as remaider of syslogPri / 8
- syslogTag | Yes | string | | | msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided
- syslogVer | No | number | | | IANA assigned version of the syslog protocol specification - typically 1
+ additionalFields ; No ; string ; ; ; additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|'
+ eventSourceHost ; No ; string ; ; ; hostname of the device
+ eventSourceType ; Yes ; string ; ; ; type of event source, examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction
+ syslogFacility ; No ; integer ; ; ; numeric code from 0 to 23 for facility--see table in documentation
+ syslogFieldsVersion ; Yes ; number ; ; ; version of the syslogFields block
+ syslogMsg ; Yes ; string ; ; ; syslog message
+ syslogPri ; No ; integer ; ; ; 0-192 combined severity and facility
+ syslogProc ; No ; string ; ; ; identifies the application that originated the message
+ syslogProcId ; No ; number ; ; ; a change in the value of this field indicates a discontinuity in syslog reporting
+ syslogSData ; No ; string ; ; ; syslog structured data consisting of a structured data Id followed by a set of key value pairs
+ syslogSdId ; No ; string ; ; ; 0-32 char in format name@number for example ourSDID@32473
+ syslogSev ; No ; string ; ; {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} , numerical Code for severity derived from syslogPri as remaider of syslogPri / 8
+ syslogTag ; Yes ; string ; ; ; msgId indicating the type of message such as TCPOUT or TCPIN, NILVALUE should be used when no other value can be provided
+ syslogVer ; No ; number ; ; ; IANA assigned version of the syslog protocol specification - typically 1
.. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20:
@@ -2827,9 +2827,8 @@ provides statistics related to customer facing voice products
calleeSideCodec | Yes | string | | | callee codec for the call
callerSideCodec | Yes | string | | | caller codec for the call
correlator | Yes | string | | | this is the same for all events on this call
- endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | |
+ endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | |
midCallRtcp | Yes | string | | | Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers
phoneNumber | No | string | | | phone number associated with the correlator
- vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | |
+ vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | |
voiceQualityFieldsVersion | Yes | number | | | version of the voiceQualityFields block
-
diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst
index 8014ed49..b45e1055 100644
--- a/docs/sections/architecture.rst
+++ b/docs/sections/architecture.rst
@@ -44,7 +44,7 @@ in ONAP R1
Usage Scenarios
---------------
-For ONPA R1 DCAE participates in all use cases.
+For ONAP R1 DCAE participates in all use cases.
vDNS/vFW: VES collector, TCA analytics
vCPE: VES collector, TCA analytics
diff --git a/docs/sections/blueprints/ves.rst b/docs/sections/blueprints/ves.rst
index 86a343d1..427fc9c0 100644
--- a/docs/sections/blueprints/ves.rst
+++ b/docs/sections/blueprints/ves.rst
@@ -1,23 +1,23 @@
VNF Event Streaming Collector
-======================
+=============================
Overview of my blueprint and the part it plays in DCAE.
Blueprint files
-----------------------
+---------------
List where we can find the blueprints
Parameters
----------------------
+----------
The input parameters needed for running the blueprint
How To Run
----------------------
+----------
Cfy command for running the blueprint
Additional Information
----------------------
+----------------------
Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/images/designate.gif b/docs/sections/images/designate.gif
new file mode 100644
index 00000000..8d6dff52
--- /dev/null
+++ b/docs/sections/images/designate.gif
Binary files differ
diff --git a/docs/sections/installation.rst b/docs/sections/installation.rst
index f6c7d0d9..02e7a9ca 100644
--- a/docs/sections/installation.rst
+++ b/docs/sections/installation.rst
@@ -1,5 +1,5 @@
-DCAE mS Installation
-====================
+DCAE Installation
+=================
.. toctree::
:maxdepth: 1
diff --git a/docs/sections/installation_heat.rst b/docs/sections/installation_heat.rst
index b90ebb41..a2ba4432 100644
--- a/docs/sections/installation_heat.rst
+++ b/docs/sections/installation_heat.rst
@@ -1,11 +1,11 @@
OpenStack Heat Template Based ONAP Deployment
=============================================
-For ONAP R1, ONAP is deployed using OpenStack Heat template. DCAE is also deployed through this process. This document describes the details of the Heat template deployment process and how to configure DCAE related parameters in the Heat template and its parameter file.
+For ONAP R1, ONAP is deployed using OpenStack Heat template. DCAE is also deployed through this process. This i document describes the details of the Heat template deployment process and how to configure DCAE related parameters in the Heat template and its parameter file.
-ONAP Deployment
----------------
+ONAP Deployment Overview
+------------------------
ONAP supports an OpenStack Heat template based system deployment. When a new "stack" is created using the template, the following virtual resources will be launched in the target OpenStack tenant:
@@ -14,7 +14,7 @@ ONAP supports an OpenStack Heat template based system deployment. When a new "s
* A virtual router interconnecting the private OAM network with the external network of the OpenStack installation.
* A key-pair named onap_key_{{RAND}}.
* A security group named onap_sg_{{RAND}}.
-* A list of VMs for ONAP components. Each VM has one NIC connected to the OAM network and assigned a fixed IP. Each VM is also assigned a floating IP address from the external network. The VM hostnames are name consistently across different ONAP deployments, a user defined prefix, denoted as {{PREFIX}}, followed by a descriptive string for the ONAP component this VM runs, and optionally followed by a sub-function name. The VMs of the same ONAP role across different ONAP deployments will always have the same OAM network IP address. For example, the Message Router will always have the OAM network IP address of 10.0.11.1.
+* A list of VMs for ONAP components. Each VM has one NIC connected to the OAM network and assigned a fixed IP. Each VM is also assigned a floating IP address from the external network. The VM hostnames are name consistently across different ONAP deployments, a user defined prefix, denoted as {{PREFIX}}, followed by a descriptive string for the ONAP component this VM runs, and optionally followed by a sub-function name. In the parameter env file supplied when running the Heat template, the {{PREFIX}} is defined by the **vm_base_name** parameter. The VMs of the same ONAP role across different ONAP deployments will always have the same OAM network IP address. For example, the Message Router will always have the OAM network IP address of 10.0.11.1.
============== ========================== ==========================
ONAP Role VM (Neutron) hostname OAM IP address(s)
@@ -35,60 +35,112 @@ ONAP supports an OpenStack Heat template based system deployment. When a new "s
MultiService {{PREFIX}}-multi-service 10.0.14.1
Private DNS {{PREFIX}}-dns-server 10.0.100.1
============== ========================== ==========================
+* Each of the above VMs will also be associated with a floating IP address from the external network.
+* A list of DCAE VMs, launched by the {{PREFIX}}-dcae-bootstrap VM. These VMs are also connected to the OAM network and associated with floating IP addresses on the external network. What's different is that their OAM IP addresses are DHCP assigned. The table below lists the DCAE VMs that are deployed for R1 use stories.
-* A list of DCAE VMs, launched by the {{PREFIX}}-dcae-bootstrap VM. These VMs are also connected to the OAM network and associated with floating IP addresses on teh external network. What's different is that their OAM IP addresses are DHCP assigned, not statically assigned. The table below lists the DCAE VMs that are deployed for R1 use stories.
-
- ===================== ============================
- DCAE Role VM (Neutron) hostname(s)
- ===================== ============================
+ ===================== ============================
+ DCAE Role VM (Neutron) hostname(s)
+ ===================== ============================
Cloudify Manager {{DCAEPREFIX}}orcl{00}
Consul cluster {{DCAEPREFIX}}cnsl{00-02}
Platform Docker Host {{DCAEPREFIX}}dokp{00}
- Service Docker Host {{DCAEPREFIX}}dokp{00}
+ Service Docker Host {{DCAEPREFIX}}doks{00}
CDAP cluster {{DCAEPREFIX}}cdap{00-06}
Postgres {{DCAEPREFIX}}pgvm{00}
- ===================== ============================
+ ===================== ============================
+
+
+DNS Configurations and Designate
+================================
+
+.. image:: images/designate.gif
+
+When DCAE VMs are launched by the dcae-bootstrap VM, they obtain their OAM IP addresses from
+the DHCP server running on the OAM network (ONAP private network). Because these addresses
+are dynamic, DCAE VMs rely on the OpenStack **Designate** DNSaaS API for registering their
+IP-address-to-hostname bindings.
+
+DCAE VMs register their hostnames under a DNS zone. This zone can be a zone that is exposed
+to the global DNS hierarchy, or a zone that is only known to the ONAP deployment. The actual
+zone name is configurable, by the blueprint input files of the DCAE VMs. By default they are
+set to be {{DCAE_ZONE}}.{{DOMAIN_NAME}}, where {{DCAE_ZONE}} is set to the {{RANDID}} and the
+domain name is set to "dcaeg2.onap.org". If DCAE VMs are required to be routable in operator organization or on the Internet, it is expected that the DNS domain is already configured in
+the organizational or global DNS hierarchy.
+
+For OpenStack installations without Designate, there is an alternative "Proxyed-Designate"
+solution. That is, a second OpenStack installation with Designate support is used for
+providing Designate API and DNSaaS for the first OpenStack installation where ONAP is
+deployed. The Designate API calls from DCAE VMs are proxyed through the MultiCloud
+service running in the same ONAP installation. The diagram above illustrates the solution.
+Such a solution can be utilized by operators who have difficulties enhancing their existing
+OpenStack infrastructure with Designate. The ONAP Pod25 lab is configured using this
+approach.
+
+To prepare for using the proxyed-Designate solution for an ONAP deployment, a surrogate
+tenant needs to be set up in the Designate-providing OpenStack. The name of the surrogate
+tenant must match with the name of the tenant where the ONAP is deployed. At DCAE bootstrap
+time, the dcae2_vm_init.sh script will first register two records into A&AI, which contain
+parameters describing the two OpenStack installations, parameters that are needed by the MultiCloud service when performing the Designate and other API call proxying.
+
+When DCAE VMs make OpenStack API calls, these calls are made to the MultiCloud service
+node instead, not to the underlying OpenStack cloud infrastructure. For non-Designate
+calls, the MultiCloud node proxys them to the same OpenStack installation and the project
+where the ONAP is installed. For Designate
+calls, the MultiCloud node proxys to the Designate-providing OpenStack installation as if
+such calls are for the surrogate tenant. The result is that the Designate providing
+OpenStack's backend DNS server will have the new records for DCAE VMs and their IP
+addresses.
-DNS
-===
+ONAP VMs deployed by Heat template are all registered with the private DNS server under the domain name of **simpledemo.onap.org**. This domain can not be exposed to any where outside of the ONAP deployment because all ONAP deployments use the same domain name and same address space. Hence these host names remain only resolvable within the same ONAP deployment. On the
+other hand DCAE VMs have host names under the DNS zone of **{{DCAE_ZONE}}.{{DOMAIN_NAME}}**,
+which can be set up to be resolvable within organizational network or even global Internet.
-ONAP VMs deployed by Heat template are all registered with the private DNS server under the domain name of **simpledemo.onap.org**. This domain can not be exposed to any where outside of the ONAP deployment because all ONAP deployments use the same domain name and same address space. Hence these host names remain only resolvable within the same ONAP deployment.
+To make the hostnames of ONAP VMs and external servers (e.g. onap.org) resolvable, the
+following DNS related configurations are needed.
-On the other hand DCAE VMs, although attached to the same OAM network as the rest of ONAP VMs, all have dynamic IP addresses allocated by the DHCP server and resort to a DNS based solution for registering the hostname and IP address mapping. DCAE VMs of different ONAP deployments are registered under different zones named as **{{RAND}}.dcaeg2.onap.org**. The API that DCAE calls to request the DNS zone registration and record registration is provided by OpenStack's DNS as a Service technology Designate.
+* The ONAP deployment's private DNS server, 10.0.100.1, is the default resolver for all the VMS. This is necessary to make the **simpledemo.onap.org** hostnames resolvable.
+* The ONAP deployment's private DNS server, 10.0.100.1, must have the Designate backend DNS server as the forwarder. This is necessary to make the **{{DCAE_ZONE}}.{{DOMAIN_NAME}}** hostnames resolvable.
+* The Designate backend DNS server needs to be configured so it can resolve all global hostnames. One exemplary configuration for achieving this is to have an external DNS server such as an organizational or global DNS server, e.g. Google's 8.8.8.8, as the forwarder.
-To enable VMs spun up by ONPA Heat template and DCAE's bootstrap process communicate with each other using hostnames, all VMs are configured to use the private DNS server launched by the Heat template as their name resolution server. In the configuration of this private DNS server, the DNS server that backs up Designate API frontend is used as the DNS forwarder.
+As the result of such configurations, below lists how different hostnames are resolved, as illustrated in the figure above:
-For simpledemo.onap.org VM to simpledemo.onap.org VM communications and {{RAND}}.dcaeg2.onap.org VM to simpledemo.onap.org VM communications, the resolution is completed by the private DNS server itself. For simpledemo.onap.org VM to {{RAND}}.dcaeg2.onap.org VM communications and {{RAND}}.dcaeg2.onap.org VM to {{RAND}}.dcaeg2.onap.org VM communications, the resolution request is forwarded from the private DNS server to the Designate DNS server and resolved there. Communications to outside world are resolved also by the Designate DNS server if the hostname belongs to a zone registered under the Designate DNS server, or forwarded to the next DNS server, either an organizational DNS server or a DNS server even higher in the global DNS server hierarchy.
+* For hostnames within the **simpledemo.onap.org** domain, the private DNS server at 10.0.100.1 has the bindings;
+* For hostnames within the **{{DCAE_ZONE}}.{{DOMAIN_NAME}}** domain, the private DNS server forwards to the Designate backend DNS server, which has the bindings;
+* For all other hostnames, e.g. ubuntu.org, the private DNS server forwards to the Designate backend DNS server, which then forwards to an external DNS server that has or is able to further forward request to a DNS server that has the bindings.
-For OpenStack installations where there is no existing DNS service, a "proxyed" Designate solution is supported. In this arrangement, DCAE bootstrap process will use MultiCloud service node as its Keystone API endpoint. For non Designate API calls, the MultiCloud service node forwards to the underlying cloud provider. However, for Designate API calls, the MultiCloud service node forwards to an off-stack Designate server.
+We wil go over the details of related Heat template env parameters in the next section.
Heat Template Parameters
========================
Here we list Heat template parameters that are related to DCAE operation. Bold values are the default values that should be used "as-is".
-* public_net_id: the UUID of the external network where floating IPs are assigned from. For example: 971040b2-7059-49dc-b220-4fab50cb2ad4
-* public_net_name: the name of the external network where floating IPs are assigned from. For example: external
-* openstack_tenant_id: the ID of the OpenStack tenant/project that will host the ONPA deployment. For example: dd327af0542e47d7853e0470fe9ad625.
-* openstack_tenant_name: the name of the OpenStack tenant/project that will host the ONPA deployment. For example: Integration-SB-01.
-* openstack_username: the username for accessing the OpenStack tenant specified by openstack_tenant_id/ openstack_tenant_name.
-* openstack_api_key: the password for accessing the OpenStack tenant specified by openstack_tenant_id/ openstack_tenant_name.
-* openstack_auth_method: **password**
-* openstack_region: **RegionOne**
-* cloud_env: **openstack**
-* dns_forwarder: This is the DNS forwarder for the ONAP deployment private DNS server. It must point to the IP address of the Designate DNS. For example '10.12.25.5'.
-* dcae_ip_addr: **10.0.4.1**. The static IP address on the OAM network that is assigned to the DCAE bootstraping VM.
-* dnsaas_config_enabled: Whether a proxy-ed Designate solution is used. For example: **true**.
-* dnsaas_region: The region of the Designate providing OpenStack. For example: RegionOne
-* dnsaas_tenant_name: The tenant/project name of the Designate providing OpenStack. For example Integration-SB-01.
-* dnsaas_keystone_url: The keystone URL of the Designate providing OpenStack. For example http://10.12.25.5:5000/v3.
-* dnsaas_username: The username for accessing the Designate providing OpenStack.
-* dnsaas_password: The password for accessing the Designate providing OpenStack.
-* dcae_keystone_url: This is the API endpoint for MltiCloud service node. **"http://10.0.14.1/api/multicloud-titanium_cloud/v0/pod25_RegionOne/identity/v2.0"**
+* public_net_id: the UUID of the external network where floating IPs are assigned from. For example: 971040b2-7059-49dc-b220-4fab50cb2ad4.
+* public_net_name: the name of the external network where floating IPs are assigned from. For example: external.
+* openstack_tenant_id: the ID of the OpenStack tenant/project that will host the ONAP deployment. For example: dd327af0542e47d7853e0470fe9ad625.
+* openstack_tenant_name: the name of the OpenStack tenant/project that will host the ONAP deployment. For example: Integration-SB-01.
+* openstack_username: the username for accessing the OpenStack tenant specified by openstack_tenant_id/openstack_tenant_name.
+* openstack_api_key: the password for accessing the OpenStack tenant specified by openstack_tenant_id/openstack_tenant_name.
+* openstack_auth_method: '**password**'.
+* openstack_region: '**RegionOne**'.
+* cloud_env: '**openstack**'.
+* dns_list: This is the list of DNS servers to be configured into DHCP server of the ONAP OAM network. As mentioned above it needs to have the ONAP private DNS server as the first item, then one or more external DNS servers next, for example: **["10.0.100.1", "8.8.8.8"]**.
+* external_dns: This is the first external DNS server in the list above. For example, **"8.8.8.8"**
+* dns_forwarder: This is the DNS forwarder for the ONAP private DNS server. It must point to the IP address of the Designate backend DNS. For example **'10.12.25.5'** for the Integration Pod25 lab.
+* dcae_ip_addr: The static IP address on the OAM network that is assigned to the DCAE bootstraping VM. **10.0.4.1**.
+* dnsaas_config_enabled: Whether a proxy-ed Designate solution is used. For example: **true**.
+* dnsaas_region: The OpenStack region of the Designate-providing OpenStack installation. For example: **RegionOne**.
+* dnsaas_tenant_name: The surrogate tenant/project name of the Designate-providing OpenStack. It must match with the *openstack_tenant_name* parameter. For example Integration-SB-01.
+* dnsaas_keystone_url: The keystone URL of the Designate providing OpenStack. For example **http://10.12.25.5:5000/v3**.
+* dnsaas_username: The username for accessing the surrogate tenant/project in Designate providing OpenStack. For Pod25 Integration lab, this value is set to **demo**.
+* dnsaas_password: The password for accessing surrogate tenant/project in the Designate providing OpenStack. For Pod25 Integration lab, this value is set to **onapdemo**.
+* dcae_keystone_url: This is the keystone API endpoint used by DCAE VMs. If MultiCloud proxying is used, this parameter needs to provide the service endpoint of the MltiCloud service node: **"http://10.0.14.1/api/multicloud-titanium_cloud/v0/pod25_RegionOne/identity/v2.0"**. Otherwise it shall point to the keystone 2.0 API endpoint of the under-lying OpenStack installation.
* dcae_centos_7_image: The name of the CentOS-7 image.
-* dcae_domain: The domain under which ONAP deployment zones are registered. For example: 'dcaeg2.onap.org'.
+* dcae_domain: The domain under which DCAE VMs register their zone. For example: **'dcaeg2.onap.org'**.
* dcae_public_key: the public key of the onap_key_{{RAND}} key-pair.
-* dcae_private_key: The private key of the onap_key_{{RAND}} key-pair (put a literal \n at the end of each line of text).
+* dcae_private_key: The private key of the onap_key_{{RAND}} key-pair (with the additions of literal \n at the end of each line of text).
+
+
Heat Deployment
===============
@@ -125,3 +177,28 @@ For DCAE bootstrap VM, the dcae2_vm_init.sh script completes the following steps
* Enters a infinite sleep loop to keep the bootstrap container up
+Removing Deployed ONAP Deployment
+=================================
+
+Because DACE VMs are not deployed directly from Heat template, they need to be deleted using
+a separate method.
+
+* Ssh into the dcae-bootstrap VM
+* Enter the dcae-bootstrap container by executing:
+ * **sudo docker exec -it boot /bin/bash**
+* Inside of the bootstrap container, execute:
+ * **bash ./teardown**
+ * All DCAE assets deployed by the bootstrap container will be uninstalled in the reverse order that they are installed.
+* Exit from the bootstrap container.
+
+After all DCAE assets are deleted, the next step is to delete the ONAP stack, using either the
+dashboard GUI or openstack CLI.
+
+When VMs are not terminated in a graceful fashion, certain resources such as ports and floating
+IP addresses may not be released promptly by OpenStack. One "quick-nad-dirty" way to release
+these resources is to use the openstack CLI with the following commands::
+
+ openstack port list |grep 'DOWN' |cut -b 3-38 |xargs openstack port delete
+ openstack floating ip list |grep 'None' |cut -b 3-38 |xargs openstack floating ip delete
+
+
diff --git a/docs/sections/installation_manual.rst b/docs/sections/installation_manual.rst
index 070e36ab..d308028e 100644
--- a/docs/sections/installation_manual.rst
+++ b/docs/sections/installation_manual.rst
@@ -1,5 +1,5 @@
-DCAE mS Installation
-====================
+DCAE Installation
+=================
The below steps covers manual setup of DCAE VM’s and DCAE service
components.
@@ -15,27 +15,32 @@ storage
1. Install docker
-  sudo apt-get update
+.. code-block:: bash
-  sudo apt install `docker.io <http://docker.io/>`__
+ sudo apt-get update
+ sudo apt install `docker.io <http://docker.io/>`__
2. Pull the latest container from onap nexus
- sudo docker login -u docker -p docker
- `nexus.onap.org <http://nexus.onap.org/>`__:10001
+.. code-block:: bash
- sudo docker pull
- `nexus.onap.org <http://nexus.onap.org/>`__:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+ sudo docker login -u docker -p docker
+ `nexus.onap.org <http://nexus.onap.org/>`__:10001
+
+ sudo docker pull
+ `nexus.onap.org <http://nexus.onap.org/>`__:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
3. Start the VESCollector with below command
- sudo docker run -d --name vescollector -p 8080:8080/tcp -p
- 8443:8443/tcp -P -e DMAAPHOST='<dmaap IP>'
- `nexus.onap.org <http://nexus.onap.org/>`__:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+.. code-block:: bash
+
+ sudo docker run -d --name vescollector -p 8080:8080/tcp -p
+ 8443:8443/tcp -P -e DMAAPHOST='<dmaap IP>'
+ `nexus.onap.org <http://nexus.onap.org/>`__:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
-  Note:  Change the dmaaphost to required DMAAP ip. To change the
- dmaap information for a running container,  stop the active
- container and rerun above command changing the dmaap IP.
+.. Note:  Change the dmaaphost to required DMAAP ip. To change the
+ dmaap information for a running container,  stop the active
+ container and rerun above command changing the dmaap IP.
4. Verification
@@ -44,12 +49,13 @@ i. Check logs under container /opt/app/VESCollector/logs/collector.log
ii. If no active feed, you can simulate an event into collector via curl
- curl -i  -X POST -d @<sampleves> --header "Content-Type:
- application/json" http://localhost:8080/eventListener/v5 -k
+.. code-block:: bash
+
+ curl -i  -X POST -d @<sampleves> --header "Content-Type:application/json" -k http://localhost:8080/eventListener/v5
- Note: If DMAAPHOST provided is invalid, you will see exception
- around publish on the collector.logs (collector queues and attempts
- to resend the event hence exceptions reported will be periodic). 
+.. Note: If DMAAPHOST provided is invalid, you will see exception
+ around publish on the collector.logs (collector queues and attempts
+ to resend the event hence exceptions reported will be periodic). 
i. Below two topic configuration are pre-set into this container.  When
valid DMAAP instance ip was provided and VES events are received,
@@ -62,41 +68,32 @@ i. Below two topic configuration are pre-set into this container.  When
-http://<dmaaphost>:3904/events/unauthenticated.SEC\_MEASUREMENT\_OUTPUT
VM Init
-~~~~~~
+~~~~~~~
To address windriver server in-stability, the below **init.sh** script
was used to start the container on VM restart.  
-+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| #!/bin/sh |
-| |
-| sudo docker ps \| grep "vescollector" |
-| |
-| if [ $? -ne 0 ]; then |
-| |
-|         sudo docker login -u docker -p docker nexus.onap.org:10001 |
-| |
-|         sudo docker pull nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1 |
-| |
-|         sudo docker rm -f vescollector |
-| |
-|         echo "Collector process not running - $(date)" >> /home/ubuntu/startuplog |
-| |
-|         sudo docker run -d --name vescollector -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.12.25.96' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1 |
-| |
-| else |
-| |
-|         echo "Collector process running - $(date)" >> /home/ubuntu/startuplog |
-| |
-| fi |
-+==============================================================================================================================================================================================+
-+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+.. code-block:: bash
+
+ #!/bin/sh
+ sudo docker ps | grep “vescollector”
+ if [ $? -ne 0 ]; then
+ sudo docker login -u docker -p docker nexus.onap.org:10001
+ sudo docker pull nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+ sudo docker rm -f vescollector
+ echo “Collector process not running - $(date)” >> /home/ubuntu/startuplog
+ sudo docker run -d –name vescollector -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST=‘10.12.25.96’ nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+ else
+ echo “Collector process running - $(date)” >> /home/ubuntu/startuplog
+ fi
+
This script was invoked via VM init script (rc.d).
-ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
+.. code-block:: bash
-sudo  update-rc.d init.sh start 2
+ ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
+ sudo  update-rc.d init.sh start 2
 
@@ -110,391 +107,237 @@ m1.medium size and 50gb cinder volumes.
1. Install docker
-  sudo apt-get update
+.. code-block:: bash
-  sudo apt install `docker.io <http://docker.io/>`__
+ sudo apt-get update
+ sudo apt install `docker.io <http://docker.io/>`__
2. Pull CDAP SDK container
-sudo docker pull caskdata/cdap-standalone:4.1.2
+.. code-block:: bash
+
+ sudo docker pull caskdata/cdap-standalone:4.1.2
3. Deploy and run the CDAP container
- sudo docker run -d --name cdap-sdk-2 -p 11011:11011 -p 11015:11015
- caskdata/cdap-standalone:4.1.2
+.. code-block:: bash
+
+ sudo docker run -d --name cdap-sdk-2 -p 11011:11011 -p 11015:11015
+ caskdata/cdap-standalone:4.1.2
4. Create Namespace on CDAP application
-curl -X PUT http://localhost:11015/v3/namespaces/cdap_tca_hi_lo
-
-5. Create TCA app config file - "tca\_app\_config.json" under ~ubuntu as
- below
-
-+------------------------------------------------------------------------------+
-| { |
-| |
-|  "artifact": { |
-| |
-|   "name": "dcae-analytics-cdap-tca", |
-| |
-|   "version": "2.0.0", |
-| |
-|   "scope": "user" |
-| |
-|  }, |
-| |
-|  "config": { |
-| |
-|   "appName": "dcae-tca", |
-| |
-|   "appDescription": "DCAE Analytics Threshold Crossing Alert Application", |
-| |
-|   "tcaVESMessageStatusTableName": "TCAVESMessageStatusTable", |
-| |
-|   "tcaVESMessageStatusTableTTLSeconds": 86400.0, |
-| |
-|   "tcaAlertsAbatementTableName": "TCAAlertsAbatementTable", |
-| |
-|   "tcaAlertsAbatementTableTTLSeconds": 1728000.0, |
-| |
-|   "tcaVESAlertsTableName": "TCAVESAlertsTable", |
-| |
-|   "tcaVESAlertsTableTTLSeconds": 1728000.0, |
-| |
-|   "thresholdCalculatorFlowletInstances": 2.0, |
-| |
-|   "tcaSubscriberOutputStreamName": "TCASubscriberOutputStream" |
-| |
-|  } |
-| |
-| } |
-+==============================================================================+
-+------------------------------------------------------------------------------+
+.. code-block:: bash
+
+ curl -X PUT http://localhost:11015/v3/namespaces/cdap_tca_hi_lo
+
+5. Create TCA app config file - "tca\_app\_config.json" under ~ubuntu as below
+
+.. code-block:: json
+
+ {
+ "artifact": {
+ "name": "dcae-analytics-cdap-tca",
+ "version": "2.0.0",
+ "scope": "user"
+ },
+
+ "config": {
+ "appName": "dcae-tca",
+ "appDescription": "DCAE Analytics Threshold Crossing Alert Application",
+ "tcaVESMessageStatusTableName": "TCAVESMessageStatusTable",
+ "tcaVESMessageStatusTableTTLSeconds": 86400.0,
+ "tcaAlertsAbatementTableName": "TCAAlertsAbatementTable",
+ "tcaAlertsAbatementTableTTLSeconds": 1728000.0,
+ "tcaVESAlertsTableName": "TCAVESAlertsTable",
+ "tcaVESAlertsTableTTLSeconds": 1728000.0,
+ "thresholdCalculatorFlowletInstances": 2.0,
+ "tcaSubscriberOutputStreamName": "TCASubscriberOutputStream"
+ }
+ }
+
6. Create TCA app preference file under ~ubuntu as below
-+--------------------------------------------------------------------------------------------------------------------------------------------+
-| { |
-| |
-|   "publisherContentType" : "application/json", |
-| |
-|   "publisherHostName" : "10.12.25.96", |
-| |
-|   "publisherHostPort" : "3904", |
-| |
-|   "publisherMaxBatchSize" : "1", |
-| |
-|   "publisherMaxRecoveryQueueSize" : "100000", |
-| |
-|   "publisherPollingInterval" : "20000", |
-| |
-|   "publisherProtocol" : "http", |
-| |
-|   "publisherTopicName" : "unauthenticated.DCAE\_CL\_OUTPUT", |
-| |
-|   "subscriberConsumerGroup" : "OpenDCAE-c1", |
-| |
-|   "subscriberConsumerId" : "c1", |
-| |
-|   "subscriberContentType" : "application/json", |
-| |
-|   "subscriberHostName" : "10.12.25.96", |
-| |
-|   "subscriberHostPort" : "3904", |
-| |
-|   "subscriberMessageLimit" : "-1", |
-| |
-|   "subscriberPollingInterval" : "20000", |
-| |
-|   "subscriberProtocol" : "http", |
-| |
-|   "subscriberTimeoutMS" : "-1", |
-| |
-|   "subscriberTopicName" : "unauthenticated.SEC\_MEASUREMENT\_OUTPUT", |
-| |
-|   "enableAAIEnrichment" : false, |
-| |
-|   "aaiEnrichmentHost" : "10.12.25.72", |
-| |
-|   "aaiEnrichmentPortNumber" : 8443, |
-| |
-|   "aaiEnrichmentProtocol" : "https", |
-| |
-|   "aaiEnrichmentUserName" : "DCAE", |
-| |
-|   "aaiEnrichmentUserPassword" : "DCAE", |
-| |
-|   "aaiEnrichmentIgnoreSSLCertificateErrors" : false, |
-| |
-|   "aaiVNFEnrichmentAPIPath" : "/aai/v11/network/generic-vnfs/generic-vnf", |
-| |
-|   "aaiVMEnrichmentAPIPath" :  "/aai/v11/search/nodes-query", |
-| |
-|   "tca\_policy" : "{ |
-| |
-|         \\"domain\\": \\"measurementsForVfScaling\\", |
-| |
-|         \\"metricsPerEventName\\": [{ |
-| |
-|                 \\"eventName\\": \\"vFirewallBroadcastPackets\\", |
-| |
-|                 \\"controlLoopSchemaType\\": \\"VNF\\", |
-| |
-|                 \\"policyScope\\": \\"DCAE\\", |
-| |
-|                 \\"policyName\\": \\"DCAE.Config\_tca-hi-lo\\", |
-| |
-|                 \\"policyVersion\\": \\"v0.0.1\\", |
-| |
-|                 \\"thresholds\\": [{ |
-| |
-|                         \\"closedLoopControlName\\": \\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\\", |
-| |
-|                         \\"version\\": \\"1.0.2\\", |
-| |
-|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.vNicUsageArray[\*].receivedTotalPacketsDelta\\", |
-| |
-|                         \\"thresholdValue\\": 300, |
-| |
-|                         \\"direction\\": \\"LESS\_OR\_EQUAL\\", |
-| |
-|                         \\"severity\\": \\"MAJOR\\", |
-| |
-|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
-| |
-|                 }, { |
-| |
-|                         \\"closedLoopControlName\\": \\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\\", |
-| |
-|                         \\"version\\": \\"1.0.2\\", |
-| |
-|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.vNicUsageArray[\*].receivedTotalPacketsDelta\\", |
-| |
-|                         \\"thresholdValue\\": 700, |
-| |
-|                         \\"direction\\": \\"GREATER\_OR\_EQUAL\\", |
-| |
-|                         \\"severity\\": \\"CRITICAL\\", |
-| |
-|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
-| |
-|                 }] |
-| |
-|         }, { |
-| |
-|                 \\"eventName\\": \\"vLoadBalancer\\", |
-| |
-|                 \\"controlLoopSchemaType\\": \\"VM\\", |
-| |
-|                 \\"policyScope\\": \\"DCAE\\", |
-| |
-|                 \\"policyName\\": \\"DCAE.Config\_tca-hi-lo\\", |
-| |
-|                 \\"policyVersion\\": \\"v0.0.1\\", |
-| |
-|                 \\"thresholds\\": [{ |
-| |
-|                         \\"closedLoopControlName\\": \\"ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3\\", |
-| |
-|                         \\"version\\": \\"1.0.2\\", |
-| |
-|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.vNicUsageArray[\*].receivedTotalPacketsDelta\\", |
-| |
-|                         \\"thresholdValue\\": 300, |
-| |
-|                         \\"direction\\": \\"GREATER\_OR\_EQUAL\\", |
-| |
-|                         \\"severity\\": \\"CRITICAL\\", |
-| |
-|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
-| |
-|                 }] |
-| |
-|         }, { |
-| |
-|                 \\"eventName\\": \\"Measurement\_vGMUX\\", |
-| |
-|                 \\"controlLoopSchemaType\\": \\"VNF\\", |
-| |
-|                 \\"policyScope\\": \\"DCAE\\", |
-| |
-|                 \\"policyName\\": \\"DCAE.Config\_tca-hi-lo\\", |
-| |
-|                 \\"policyVersion\\": \\"v0.0.1\\", |
-| |
-|                 \\"thresholds\\": [{ |
-| |
-|                         \\"closedLoopControlName\\": \\"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\\", |
-| |
-|                         \\"version\\": \\"1.0.2\\", |
-| |
-|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.additionalMeasurements[\*].arrayOfFields[0].value\\", |
-| |
-|                         \\"thresholdValue\\": 0, |
-| |
-|                         \\"direction\\": \\"EQUAL\\", |
-| |
-|                         \\"severity\\": \\"MAJOR\\", |
-| |
-|                         \\"closedLoopEventStatus\\": \\"ABATED\\" |
-| |
-|                 }, { |
-| |
-|                         \\"closedLoopControlName\\": \\"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\\", |
-| |
-|                         \\"version\\": \\"1.0.2\\", |
-| |
-|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.additionalMeasurements[\*].arrayOfFields[0].value\\", |
-| |
-|                         \\"thresholdValue\\": 0, |
-| |
-|                         \\"direction\\": \\"GREATER\\", |
-| |
-|                         \\"severity\\": \\"CRITICAL\\", |
-| |
-|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
-| |
-|                 }] |
-| |
-|         }] |
-| |
-| }" |
-| |
-| } |
-+============================================================================================================================================+
-+--------------------------------------------------------------------------------------------------------------------------------------------+
-
-  Note: Dmaap configuration are specified on this file on
- publisherHostName and subscriberHostName. To be changed as
- required\*\*
-
-7. Copy below script to CDAP server (this gets latest image from nexus
- and deploys TCA application) and execute it
-
-+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| #!/bin/sh |
-| |
-| TCA\_JAR=dcae-analytics-cdap-tca-2.0.0.jar |
-| |
-| rm -f /home/ubuntu/$TCA\_JAR |
-| |
-| cd /home/ubuntu/ |
-| |
-| wget https://nexus.onap.org/service/local/repositories/staging/content/org/onap/dcaegen2/analytics/tca/dcae-analytics-cdap-tca/2.0.0/$TCA\_JAR |
-| |
-| if [ $? -eq 0 ]; then |
-| |
-|         if [ -f /home/ubuntu/$TCA\_JAR ]; then |
-| |
-|                 echo "Restarting TCA CDAP application using $TCA\_JAR artifact" |
-| |
-|         else |
-| |
-|                 echo "ERROR: $TCA\_JAR missing" |
-| |
-|                 exit 1 |
-| |
-|         fi |
-| |
-| else |
-| |
-|         echo "ERROR: $TCA\_JAR not found in nexus" |
-| |
-|         exit 1 |
-| |
-| fi |
-| |
-| # stop programs |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/stop |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/stop |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/stop |
-| |
-| # delete application |
-| |
-| curl -X DELETE http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca |
-| |
-| # delete artifact |
-| |
-| curl -X DELETE http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/artifacts/dcae-analytics-cdap-tca/versions/2.0.0 |
-| |
-| # load artifact |
-| |
-| curl -X POST --data-binary @/home/ubuntu/$TCA\_JAR http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/artifacts/dcae-analytics-cdap-tca |
-| |
-| # create app |
-| |
-| curl -X PUT -d @/home/ubuntu/tca\_app\_config.json http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca |
-| |
-| # load preferences |
-| |
-| curl -X PUT -d @/home/ubuntu/tca\_app\_preferences.json http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/preferences |
-| |
-| # start programs |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/start |
-| |
-| echo |
-| |
-| # get status of programs |
-| |
-| curl http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/status |
-| |
-| curl http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/status |
-| |
-| curl http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/status |
-| |
-| echo |
-+==================================================================================================================================================+
-+--------------------------------------------------------------------------------------------------------------------------------------------------+
+.. code-block:: json
+
+ {
+ "publisherContentType" : "application/json",
+ "publisherHostName" : "10.12.25.96",
+ "publisherHostPort" : "3904",
+ "publisherMaxBatchSize" : "1",
+ "publisherMaxRecoveryQueueSize" : "100000",
+ "publisherPollingInterval" : "20000",
+ "publisherProtocol" : "http",
+ "publisherTopicName" : "unauthenticated.DCAE_CL_OUTPUT",
+ "subscriberConsumerGroup" : "OpenDCAE-c1",
+ "subscriberConsumerId" : "c1",
+ "subscriberContentType" : "application/json",
+ "subscriberHostName" : "10.12.25.96",
+ "subscriberHostPort" : "3904",
+ "subscriberMessageLimit" : "-1",
+ "subscriberPollingInterval" : "20000",
+ "subscriberProtocol" : "http",
+ "subscriberTimeoutMS" : "-1",
+ "subscriberTopicName" : "unauthenticated.SEC_MEASUREMENT_OUTPUT",
+ "enableAAIEnrichment" : false,
+ "aaiEnrichmentHost" : "10.12.25.72",
+ "aaiEnrichmentPortNumber" : 8443,
+ "aaiEnrichmentProtocol" : "https",
+ "aaiEnrichmentUserName" : "DCAE",
+ "aaiEnrichmentUserPassword" : "DCAE",
+ "aaiEnrichmentIgnoreSSLCertificateErrors" : false,
+ "aaiVNFEnrichmentAPIPath" : "/aai/v11/network/generic-vnfs/generic-vnf",
+ "aaiVMEnrichmentAPIPath" : "/aai/v11/search/nodes-query",
+ "tca_policy" : {
+ "domain": "measurementsForVfScaling",
+ "metricsPerEventName": [{
+ "eventName": "vFirewallBroadcastPackets",
+ "controlLoopSchemaType": "VNF",
+ "policyScope": "DCAE",
+ "policyName": "DCAE.Config_tca-hi-lo",
+ "policyVersion": "v0.0.1",
+ "thresholds": [{
+ "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a",
+ "version": "1.0.2",
+ "fieldPath": "$.event.measurementsForVfScalingFields.vNicUsageArray[*].receivedTotalPacketsDelta",
+ "thresholdValue": 300,
+ "direction": "LESS_OR_EQUAL",
+ "severity": "MAJOR",
+ "closedLoopEventStatus": "ONSET"
+ }, {
+ "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a",
+ "version": "1.0.2",
+ "fieldPath": "$.event.measurementsForVfScalingFields.vNicUsageArray[*].receivedTotalPacketsDelta",
+ "thresholdValue": 700,
+ "direction": "GREATER_OR_EQUAL",
+ "severity": "CRITICAL",
+ "closedLoopEventStatus": "ONSET"
+ }]
+ }, {
+ "eventName": "vLoadBalancer",
+ "controlLoopSchemaType": "VM",
+ "policyScope": "DCAE",
+ "policyName": "DCAE.Config_tca-hi-lo",
+ "policyVersion": "v0.0.1",
+ "thresholds": [{
+ "closedLoopControlName": "ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3",
+ "version": "1.0.2",
+ "fieldPath": "$.event.measurementsForVfScalingFields.vNicUsageArray[*].receivedTotalPacketsDelta",
+ "thresholdValue": 300,
+ "direction": "GREATER_OR_EQUAL",
+ "severity": "CRITICAL",
+ "closedLoopEventStatus": "ONSET"
+ }]
+ }, {
+ "eventName": "Measurement_vGMUX",
+ "controlLoopSchemaType": "VNF",
+ "policyScope": "DCAE",
+ "policyName": "DCAE.Config_tca-hi-lo",
+ "policyVersion": "v0.0.1",
+ "thresholds": [{
+ "closedLoopControlName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
+ "version": "1.0.2",
+ "fieldPath": "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",
+ "thresholdValue": 0,
+ "direction": "EQUAL",
+ "severity": "MAJOR",
+ "closedLoopEventStatus": "ABATED"
+ }, {
+ "closedLoopControlName": "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e",
+ "version": "1.0.2",
+ "fieldPath": "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value",
+ "thresholdValue": 0,
+ "direction": "GREATER",
+ "severity": "CRITICAL",
+ "closedLoopEventStatus": "ONSET"
+ }]
+ }]
+ }
+ }
+
+
+.. Note: Dmaap configuration are specified on this file on
+ publisherHostName and subscriberHostName. To be changed as
+ required\*\*
+
+7. Copy below script to CDAP server (this gets latest image from nexus and deploys TCA application) and execute it
+
+.. code-block:: bash
+
+ #!/bin/sh
+ TCA_JAR=dcae-analytics-cdap-tca-2.0.0.jar
+ rm -f /home/ubuntu/$TCA_JAR
+ cd /home/ubuntu/
+ wget https://nexus.onap.org/service/local/repositories/staging/content/org/onap/dcaegen2/analytics/tca/dcae-analytics-cdap-tca/2.0.0/$TCA_JAR
+ if [ $? -eq 0 ]; then
+ if [ -f /home/ubuntu/$TCA_JAR ]; then
+ echo “Restarting TCA CDAP application using $TCA_JAR artifact”
+ else
+ echo “ERROR: $TCA_JAR missing”
+ exit 1
+ fi
+ else
+ echo “ERROR: $TCA_JAR not found in nexus”
+ exit 1
+ fi
+ # stop programs
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/stop
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/stop
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/stop
+ # delete application
+ curl -X DELETE http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca
+ # delete artifact
+ curl -X DELETE http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/artifacts/dcae-analytics-cdap-tca/versions/2.0.0
+ # load artifact
+ curl -X POST –data-binary @/home/ubuntu/$TCA_JAR http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/artifacts/dcae-analytics-cdap-tca
+ # create app
+ curl -X PUT -d @/home/ubuntu/tca_app_config.json http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca
+ # load preferences
+ curl -X PUT -d @/home/ubuntu/tca_app_preferences.json http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/preferences
+ # start programs
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/start
+ echo
+ # get status of programs
+ curl http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/status
+ curl http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/status
+ curl http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/status
+ echo
+
8. Verify TCA application and logs via CDAP GUI processes
The overall flow can be checked here
TCA Configuration Change
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
Typical configuration changes include changing DMAAP host and/or Policy configuration. If necessary, modify the file on step #6 and run the script noted as step #7 to redeploy TCA with updated configuration.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
VM Init
-~~~~~~
+~~~~~~~
To address windriver server in-stability, the below **init.sh** script
was used to restart the container on VM restart.  This script was
invoked via VM init script (rc.d).
-+------------------------------------------------------------------------------------------------------------------------------+
-| #!/bin/sh |
-| |
-| #docker run -d --name cdap-sdk -p 11011:11011 -p 11015:11015 caskdata/cdap-standalone:4.1.2 |
-| |
-| sudo docker restart cdap-sdk-2 |
-| |
-| sleep 30 |
-| |
-| # start program |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start |
-| |
-| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/start |
-+==============================================================================================================================+
-+------------------------------------------------------------------------------------------------------------------------------+
+.. code-block:: bash
- 
+ #!/bin/sh
+ #docker run -d –name cdap-sdk -p 11011:11011 -p 11015:11015 caskdata/cdap-standalone:4.1.2
+ sudo docker restart cdap-sdk-2
+ sleep 30
+ # start program
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start
+ curl -X POST http://localhost:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/start
-This script was invoked via VM init script (rc.d).
-ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
+This script was invoked via VM init script (rc.d).
-sudo  update-rc.d init.sh start 2
+.. code-block:: bash
+ ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
+ sudo  update-rc.d init.sh start 2
diff --git a/docs/sections/installation_test.rst b/docs/sections/installation_test.rst
index 2c49a957..641a8616 100644
--- a/docs/sections/installation_test.rst
+++ b/docs/sections/installation_test.rst
@@ -5,15 +5,15 @@ Testing and Debugging ONAP DCAE Deployment
Check Component Status
======================
-Testing of a DCAE system starts with checking the health of the deployed components. This can be done by accessing the Consul becsue all DCAE components register their staus with Consul. Such API is accessible at http://{{ANY_CONSUL_VM_IP}}:8500 .
+Testing of a DCAE system starts with checking the health of the deployed components. This can be done by accessing the Consul becsue all DCAE components register their staus with Consul. Such API is accessible at http://{{ANY_CONSUL_VM_IP}}:8500.
-In addition, more details status information can be obtained in additional ways.
+In addition, more details status information can be obtained in additional ways.
1. Check VES Status
- VES status and running logs can be found on the {{RAND}}doks00 VM. The detailed API and access methods can be found in the logging and human interface sections.
+ VES status and running logs can be found on the {{RAND}}doks00 VM. The detailed API and access methods can be found in the logging and human interface sections.
2. Check TCA Status
- TCA has its own GUI that provides detailed operation information. Point browser to http://{{CDAP02_VM_IP}}:11011/oldcdap/ns/cdap_tca_hi_lo/apps/, select the application with Description "DCAE Analytics Threshold Crossing Alert Application"; then select "TCAVESCollectorFlow". This leads to a flow display where all stages of processing are illustrated and the number inside of each stage icon shows the number of events/messages processed.
+ TCA has its own GUI that provides detailed operation information. Point browser to http://{{CDAP02_VM_IP}}:11011/oldcdap/ns/cdap_tca_hi_lo/apps/, select the application with Description "DCAE Analytics Threshold Crossing Alert Application"; then select "TCAVESCollectorFlow". This leads to a flow display where all stages of processing are illustrated and the number inside of each stage icon shows the number of events/messages processed.
3. Check Message Router Status
diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst
index fd655bb8..721e64df 100644
--- a/docs/sections/release-notes.rst
+++ b/docs/sections/release-notes.rst
@@ -36,9 +36,9 @@ Specifically, DCAE R1 includes the following components:
- Service components
- Docker container components
- VNF Event Streaming (VES) collector
- - Holmes engine (**)
- - Holmes rule management (**)
+ - Holmes (engine and rule management) **
- CDAP analytics component
+ - Threshold Crossing Analytics (TCA)
(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
@@ -133,3 +133,4 @@ following Gerrit repos are voided and already locked as read-only.
**Other**
+SNMP trap collector is seed code delivery only.