diff options
Diffstat (limited to 'docs')
28 files changed, 235 insertions, 3009 deletions
diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst index df91681c..c3ccfa0c 100644 --- a/docs/sections/apis/ves-hv/index.rst +++ b/docs/sections/apis/ves-hv/index.rst @@ -5,7 +5,6 @@ HV-VES (High Volume VES) ======================== -:Date: 2018-10-05 .. contents:: :depth: 4 @@ -25,9 +24,11 @@ TCP Endpoint ============ HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp. -It uses plain, insecure TCP connection without socket data encryption. In Dublin release, -there is an experimental option to enable SSL/TLS (see :ref:`ssl_tls_authorization`). -Without TLS client authentication/authorization is not possible. +By default, as of the Frankfurt release, all TCP communications are secured using +SSL/TLS. Plain, insecure TCP connections without socket data encryption can be enabled if needed. + (see ref:`ssl_tls_authorization`). + +Without TLS, client authentication/authorization is not possible. Connections are stream-based (as opposed to request-based) and long-running. Communication is wrapped with thin Wire Transfer Protocol, which mainly provides delimitation. diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst index f444c273..4ddd7b1d 100644 --- a/docs/sections/apis/ves.rst +++ b/docs/sections/apis/ves.rst @@ -1,7 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -VES Collector +VES-Collector ============= .. toctree:: @@ -28,2745 +28,106 @@ onap-discuss@lists.onap.org Security ~~~~~~~~ -.. _securities_basicAuth: - -basicAuth (HTTP Basic Authentication) -------------------------------------- - -*HTTP Basic Authentication. Works over `HTTP` and `HTTPS`* - -DEFAULT -~~~~~~~ - -GET ``/healthcheck`` --------------------- - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -healthcheck successful - -POST ``/eventListener/v5`` --------------------------- - -Description -+++++++++++ - -.. raw:: html - - uri for posting VES event objects - -Request -+++++++ - -.. _d_f598222d7a83ca9c3538556b263682d1: +`VES Authentication Types <https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/services/ves-http/tls-authentication.html>`_ + + +VES Specification +~~~~~~~~~~~~~~~~~ + +- `VES 7.1.1 Data Model <https://docs.onap.org/en/latest/submodules/vnfrqts/requirements.git/docs/Chapter8/ves7_1spec.html#common-event-format>`_ +- `VES 5.4 Data Model <https://docs.onap.org/en/latest/submodules/vnfrqts/requirements.git/docs/Chapter8/ves_5_4_1/VESEventListener.html#common-event-format>`_ + + +Response Code +~~~~~~~~~~~~~ + ++-----+--------------+--------------------------------------------------------+ +| Code| Reason Phrase| Description | ++=====+==============+========================================================+ +| 202 | Accepted | The request has been accepted for processing | ++-----+--------------+--------------------------------------------------------+ +| 400 | Bad Request | Many possible reasons not specified by the other codes | +| | | (e.g., missing required parameters or incorrect format)| +| | | . The response body may include a further exception | +| | | code and text. HTTP 400 errors may be mapped to SVC0001| +| | | (general service error), SVC0002 (bad parameter), | +| | | SVC2000 (general service error with details) or PO9003 | +| | | (message content size exceeds the allowable limit). | ++-----+--------------+--------------------------------------------------------+ +| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 | +| | | errors may be mapped to POL0001 (general policy error) | +| | | or POL2000 (general policy error with details). | ++-----+--------------+--------------------------------------------------------+ +| 404 | Not Found | The server has not found anything matching the | +| | | Request-URI. No indication is given of whether the | +| | | condition is temporary or permanent. | ++-----+--------------+--------------------------------------------------------+ +| 405 | Method Not | A request was made of a resource using a request method| +| | Allowed | not supported by that resource (e.g., using PUT on a | +| | | REST resource that only supports POST). | ++-----+--------------+--------------------------------------------------------+ +| 500 | Internal | The server encountered an internal error or timed out; | +| | Server Error | please retry (general catch-all server-side error).HTTP| +| | | 500 errors may be mapped to SVC1000 (no server | +| | | resources). | ++-----+--------------+--------------------------------------------------------+ + +Sample Request and Response +--------------------------- -Body -^^^^ +Request Example -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | +.. code-block:: http -.. code-block:: javascript + POST /eventListener/v7 HTTP/1.1 + Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== + content-type: application/json + content-length: 12345 + X-MinorVersion: 1 { "event": { "commonEventHeader": { + "version": "4.1", + "vesEventListenerVersion": "7.1.1", "domain": "fault", - "eventId": "somestring", - "eventName": "somestring", - "eventType": "somestring", - "internalHeaderFields": {}, - "lastEpochMicrosec": 1, - "nfNamingCode": "somestring", - "nfcNamingCode": "somestring", - "priority": "High", - "reportingEntityId": "somestring", - "reportingEntityName": "somestring", + "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", + "eventId": "fault0000245", "sequence": 1, - "sourceId": "somestring", - "sourceName": "somestring", - "startEpochMicrosec": 1, - "version": 1 - }, - "faultFields": { - "alarmAdditionalInformation": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "alarmCondition": "somestring", - "alarmInterfaceA": "somestring", - "eventCategory": "somestring", - "eventSeverity": "CRITICAL", - "eventSourceType": "somestring", - "faultFieldsVersion": 1, - "specificProblem": "somestring", - "vfStatus": "Active" - }, - "heartbeatFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "heartbeatFieldsVersion": 1, - "heartbeatInterval": 1 - }, - "measurementsForVfScalingFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "additionalMeasurements": [ - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - }, - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - } - ], - "additionalObjects": [ - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - }, - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - } - ], - "codecUsageArray": [ - { - "codecIdentifier": "somestring", - "numberInUse": 1 - }, - { - "codecIdentifier": "somestring", - "numberInUse": 1 - } - ], - "concurrentSessions": 1, - "configuredEntities": 1, - "cpuUsageArray": [ - { - "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, - "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, - "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, - "diskTimeWriteMin": 1 - } - ], - "featureUsageArray": [ - { - "featureIdentifier": "somestring", - "featureUtilization": 1 - }, - { - "featureIdentifier": "somestring", - "featureUtilization": 1 - } - ], - "filesystemUsageArray": [ - { - "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, - "filesystemName": "somestring" - } - ], - "latencyDistribution": [ - { - "countsInTheBucket": 1, - "highEndOfLatencyBucket": 1, - "lowEndOfLatencyBucket": 1 - }, - { - "countsInTheBucket": 1, - "highEndOfLatencyBucket": 1, - "lowEndOfLatencyBucket": 1 - } - ], - "meanRequestLatency": 1, - "measurementInterval": 1, - "measurementsForVfScalingVersion": 1, - "memoryUsageArray": [ - { - "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, - "vmIdentifier": "somestring" - } - ], - "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", - "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", - "valuesAreSuspect": "true" - } - ], - "vnfcScalingMetric": 1 - }, - "mobileFlowFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "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", - "ipTosCountList": [ - [ - 1, - 1 - ], - [ - 1, - 1 - ] - ], - "ipTosList": [ - "somestring", - "somestring" - ], - "largePacketRtt": 1, - "largePacketThreshold": 1, - "maxPacketDelayVariation": 1, - "maxReceiveBitRate": 1, - "maxTransmitBitRate": 1, - "mobileQciCosCountList": [ - [ - 1, - 1 - ], - [ - 1, - 1 - ] - ], - "mobileQciCosList": [ - "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, - "tcpFlagCountList": [ - [ - 1, - 1 - ], - [ - 1, - 1 - ] - ], - "tcpFlagList": [ - "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", - "vlanId": "somestring" - }, - "otherFields": { - "hashOfNameValuePairArrays": [ - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - }, - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - } - ], - "jsonObjects": [ - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - }, - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - } - ], - "nameValuePairs": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "otherFieldsVersion": 1 - }, - "sipSignalingFields": { - "additionalInformation": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "compressedSip": "somestring", - "correlator": "somestring", - "localIpAddress": "somestring", - "localPort": "somestring", - "remoteIpAddress": "somestring", - "remotePort": "somestring", - "sipSignalingFieldsVersion": 1, - "summarySip": "somestring", - "vendorVnfNameFields": { - "vendorName": "somestring", - "vfModuleName": "somestring", - "vnfName": "somestring" - } - }, - "stateChangeFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "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", - "syslogVer": 1 - }, - "thresholdCrossingAlertFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "additionalParameters": [ - { - "criticality": "CRIT", - "name": "somestring", - "thresholdCrossed": "somestring", - "value": "somestring" - }, - { - "criticality": "CRIT", - "name": "somestring", - "thresholdCrossed": "somestring", - "value": "somestring" - } - ], - "alertAction": "CLEAR", - "alertDescription": "somestring", - "alertType": "CARD-ANOMALY", - "alertValue": "somestring", - "associatedAlertIdList": [ - "somestring", - "somestring" - ], - "collectionTimestamp": "somestring", - "dataCollector": "somestring", - "elementType": "somestring", - "eventSeverity": "CRITICAL", - "eventStartTimestamp": "somestring", - "interfaceName": "somestring", - "networkService": "somestring", - "possibleRootCause": "somestring", - "thresholdCrossingFieldsVersion": 1 - }, - "voiceQualityFields": { - "additionalInformation": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "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, - "roundTripDelay": 1 - }, - "midCallRtcp": "somestring", - "phoneNumber": "somestring", - "vendorVnfNameFields": { - "vendorName": "somestring", - "vfModuleName": "somestring", - "vnfName": "somestring" - }, - "voiceQualityFieldsVersion": 1 - } - } - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -VES Event Accepted. - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**400** -^^^^^^^ - -Bad request provided - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**401** -^^^^^^^ - -Unauthorized request - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**503** -^^^^^^^ - -Service Unavailable - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -Security -++++++++ - -.. csv-table:: - :header: "Security Schema", "Scopes" - :widths: 15, 45 - - :ref:`basicAuth <securities_basicAuth>`, "" - -POST ``/eventListener/v5/eventBatch`` -------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - uri for posting VES batch event objects - -Request -+++++++ - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - 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, - "version": 1 + "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", + "reportingEntityName": "ibcx0001vm002oam001", + "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", + "sourceName": "scfx0001vm002cap001", + "nfVendorName": "Ericsson", + "nfNamingCode": "scfx", + "nfcNamingCode": "ssc", + "startEpochMicrosec": 1413378172000000, + "lastEpochMicrosec": 1413378172000000, + "timeZoneOffset": "UTC-05:30" }, "faultFields": { - "alarmAdditionalInformation": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "alarmCondition": "somestring", - "alarmInterfaceA": "somestring", - "eventCategory": "somestring", + "faultFieldsVersion": 4.0, + "alarmCondition": "PilotNumberPoolExhaustion", + "eventSourceType": "other", + "specificProblem": "Calls cannot complete - pilot numbers are unavailable", "eventSeverity": "CRITICAL", - "eventSourceType": "somestring", - "faultFieldsVersion": 1, - "specificProblem": "somestring", - "vfStatus": "Active" - }, - "heartbeatFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "heartbeatFieldsVersion": 1, - "heartbeatInterval": 1 - }, - "measurementsForVfScalingFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "additionalMeasurements": [ - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - }, - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - } - ], - "additionalObjects": [ - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - }, - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - } - ], - "codecUsageArray": [ - { - "codecIdentifier": "somestring", - "numberInUse": 1 - }, - { - "codecIdentifier": "somestring", - "numberInUse": 1 - } - ], - "concurrentSessions": 1, - "configuredEntities": 1, - "cpuUsageArray": [ - { - "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, - "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, - "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, - "diskTimeWriteMin": 1 - } - ], - "featureUsageArray": [ - { - "featureIdentifier": "somestring", - "featureUtilization": 1 - }, - { - "featureIdentifier": "somestring", - "featureUtilization": 1 - } - ], - "filesystemUsageArray": [ - { - "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, - "filesystemName": "somestring" - } - ], - "latencyDistribution": [ - { - "countsInTheBucket": 1, - "highEndOfLatencyBucket": 1, - "lowEndOfLatencyBucket": 1 - }, - { - "countsInTheBucket": 1, - "highEndOfLatencyBucket": 1, - "lowEndOfLatencyBucket": 1 - } - ], - "meanRequestLatency": 1, - "measurementInterval": 1, - "measurementsForVfScalingVersion": 1, - "memoryUsageArray": [ - { - "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, - "vmIdentifier": "somestring" - } - ], - "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", - "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", - "valuesAreSuspect": "true" - } - ], - "vnfcScalingMetric": 1 - }, - "mobileFlowFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "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", - "ipTosCountList": [ - [ - 1, - 1 - ], - [ - 1, - 1 - ] - ], - "ipTosList": [ - "somestring", - "somestring" - ], - "largePacketRtt": 1, - "largePacketThreshold": 1, - "maxPacketDelayVariation": 1, - "maxReceiveBitRate": 1, - "maxTransmitBitRate": 1, - "mobileQciCosCountList": [ - [ - 1, - 1 - ], - [ - 1, - 1 - ] - ], - "mobileQciCosList": [ - "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, - "tcpFlagCountList": [ - [ - 1, - 1 - ], - [ - 1, - 1 - ] - ], - "tcpFlagList": [ - "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", - "vlanId": "somestring" - }, - "otherFields": { - "hashOfNameValuePairArrays": [ - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - }, - { - "arrayOfFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "name": "somestring" - } - ], - "jsonObjects": [ - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - }, - { - "nfSubscribedObjectName": "somestring", - "nfSubscriptionId": "somestring", - "objectInstances": [ - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - }, - { - "objectInstance": {}, - "objectInstanceEpochMicrosec": 1, - "objectKeys": [ - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - }, - { - "keyName": "somestring", - "keyOrder": 1, - "keyValue": "somestring" - } - ] - } - ], - "objectName": "somestring", - "objectSchema": "somestring", - "objectSchemaUrl": "somestring" - } - ], - "nameValuePairs": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "otherFieldsVersion": 1 - }, - "sipSignalingFields": { - "additionalInformation": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "compressedSip": "somestring", - "correlator": "somestring", - "localIpAddress": "somestring", - "localPort": "somestring", - "remoteIpAddress": "somestring", - "remotePort": "somestring", - "sipSignalingFieldsVersion": 1, - "summarySip": "somestring", - "vendorVnfNameFields": { - "vendorName": "somestring", - "vfModuleName": "somestring", - "vnfName": "somestring" + "vfStatus": "Active", + "alarmAdditionalInformation": { + "PilotNumberPoolSize": "1000" } - }, - "stateChangeFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "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", - "syslogVer": 1 - }, - "thresholdCrossingAlertFields": { - "additionalFields": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "somestring" - } - ], - "additionalParameters": [ - { - "criticality": "CRIT", - "name": "somestring", - "thresholdCrossed": "somestring", - "value": "somestring" - }, - { - "criticality": "CRIT", - "name": "somestring", - "thresholdCrossed": "somestring", - "value": "somestring" - } - ], - "alertAction": "CLEAR", - "alertDescription": "somestring", - "alertType": "CARD-ANOMALY", - "alertValue": "somestring", - "associatedAlertIdList": [ - "somestring", - "somestring" - ], - "collectionTimestamp": "somestring", - "dataCollector": "somestring", - "elementType": "somestring", - "eventSeverity": "CRITICAL", - "eventStartTimestamp": "somestring", - "interfaceName": "somestring", - "networkService": "somestring", - "possibleRootCause": "somestring", - "thresholdCrossingFieldsVersion": 1 - }, - "voiceQualityFields": { - "additionalInformation": [ - { - "name": "somestring", - "value": "somestring" - }, - { - "name": "somestring", - "value": "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, - "roundTripDelay": 1 - }, - "midCallRtcp": "somestring", - "phoneNumber": "somestring", - "vendorVnfNameFields": { - "vendorName": "somestring", - "vfModuleName": "somestring", - "vnfName": "somestring" - }, - "voiceQualityFieldsVersion": 1 } } } -Responses -+++++++++ - -**200** -^^^^^^^ - -VES Event Accepted. - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**400** -^^^^^^^ - -Bad request provided - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**401** -^^^^^^^ - -Unauthorized request - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**503** -^^^^^^^ - -Service Unavailable - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -Security -++++++++ - -.. csv-table:: - :header: "Security Schema", "Scopes" - :widths: 15, 45 - - :ref:`basicAuth <securities_basicAuth>`, "" - -Data Structures -~~~~~~~~~~~~~~~ - -ApiResponseMessage Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - code | No | integer | int32 | | - message | No | string | | | - type | No | string | | | - -VES5Request Model Structure ---------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | - -.. _d_df249c51a416f54e5609f2ffffe059c0: - -codecsInUse Model Structure ---------------------------- - -number of times an identified codec was used over the measurementInterval - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - codecIdentifier | Yes | string | | | - numberInUse | Yes | integer | | | - -.. _d_a68e1b21fdcef792db73f711201c56ad: - -commonEventHeader Model Structure ---------------------------------- - -fields common to all events - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - domain | Yes | string | | {'enum': ['fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality']} | the eventing domain associated with the event - 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>` | | | - 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 - priority | Yes | string | | {'enum': ['High', 'Medium', 'Normal', 'Low']} | processing priority - reportingEntityId | No | string | | | UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process - reportingEntityName | Yes | string | | | name of the entity reporting the event, for example, an EMS name; may be the same as sourceName - sequence | Yes | integer | | | ordering of events communicated by an event source instance or 0 if not needed - sourceId | No | string | | | UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process - sourceName | Yes | string | | | name of the entity experiencing the event issue - startEpochMicrosec | Yes | number | | | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds - version | Yes | number | | | version of the event header - -.. _d_6e043350cba5faafe21de49c2f6fd745: - -counter Model Structure ------------------------ - -performance counter - -.. csv-table:: - :delim: | - :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 | | | - -.. _d_6f081937f31c09078c8acf9212d6c449: - -cpuUsage Model Structure ------------------------- - -usage of an identified CPU - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - cpuIdentifier | Yes | string | | | cpu identifer - cpuIdle | No | number | | | percentage of CPU time spent in the idle task - cpuUsageInterrupt | No | number | | | percentage of time spent servicing interrupts - cpuUsageNice | No | number | | | percentage of time spent running user space processes that have been niced - cpuUsageSoftIrq | No | number | | | percentage of time spent handling soft irq interrupts - cpuUsageSteal | No | number | | | percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing - cpuUsageSystem | No | number | | | percentage of time spent on system tasks running the kernel - cpuUsageUser | No | number | | | percentage of time spent running un-niced user space processes - cpuWait | No | number | | | percentage of CPU time spent waiting for I/O operations to complete - percentUsage | Yes | number | | | aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running - -.. _d_bb7a69764c21219953df76826934938e: -diskUsage Model Structure -------------------------- -usage of an identified disk - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - diskIdentifier | Yes | string | | | disk identifier - diskIoTimeAvg | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval - diskIoTimeLast | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval - diskIoTimeMax | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval - diskIoTimeMin | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval - diskMergedReadAvg | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval - diskMergedReadLast | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval - diskMergedReadMax | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval - diskMergedReadMin | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval - diskMergedWriteAvg | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval - diskMergedWriteLast | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval - diskMergedWriteMax | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval - diskMergedWriteMin | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval - diskOctetsReadAvg | No | number | | | number of octets per second read from a disk or partition; provide the average measurement within the measurement interval - diskOctetsReadLast | No | number | | | number of octets per second read from a disk or partition; provide the last measurement within the measurement interval - diskOctetsReadMax | No | number | | | number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval - diskOctetsReadMin | No | number | | | number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval - diskOctetsWriteAvg | No | number | | | number of octets per second written to a disk or partition; provide the average measurement within the measurement interval - diskOctetsWriteLast | No | number | | | number of octets per second written to a disk or partition; provide the last measurement within the measurement interval - diskOctetsWriteMax | No | number | | | number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval - diskOctetsWriteMin | No | number | | | number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval - diskOpsReadAvg | No | number | | | number of read operations per second issued to the disk; provide the average measurement within the measurement interval - diskOpsReadLast | No | number | | | number of read operations per second issued to the disk; provide the last measurement within the measurement interval - diskOpsReadMax | No | number | | | number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval - diskOpsReadMin | No | number | | | number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval - diskOpsWriteAvg | No | number | | | number of write operations per second issued to the disk; provide the average measurement within the measurement interval - diskOpsWriteLast | No | number | | | number of write operations per second issued to the disk; provide the last measurement within the measurement interval - diskOpsWriteMax | No | number | | | number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval - diskOpsWriteMin | No | number | | | number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval - diskPendingOperationsAvg | No | number | | | queue size of pending I/O operations per second; provide the average measurement within the measurement interval - diskPendingOperationsLast | No | number | | | queue size of pending I/O operations per second; provide the last measurement within the measurement interval - diskPendingOperationsMax | No | number | | | queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval - diskPendingOperationsMin | No | number | | | queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval - diskTimeReadAvg | No | number | | | milliseconds a read operation took to complete; provide the average measurement within the measurement interval - diskTimeReadLast | No | number | | | milliseconds a read operation took to complete; provide the last measurement within the measurement interval - diskTimeReadMax | No | number | | | milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval - diskTimeReadMin | No | number | | | milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval - diskTimeWriteAvg | No | number | | | milliseconds a write operation took to complete; provide the average measurement within the measurement interval - diskTimeWriteLast | No | number | | | milliseconds a write operation took to complete; provide the last measurement within the measurement interval - diskTimeWriteMax | No | number | | | milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval - diskTimeWriteMin | No | number | | | milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval - -.. _d_c911a0a8abdb511d7cd6590f383d817b: - -endOfCallVqmSummaries Model Structure -------------------------------------- - -provides end of call voice quality metrics - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - 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 | | | - 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 | | | - rFactor | No | number | | | 0-100 - roundTripDelay | No | number | | | millisecs - -.. _d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb: - -event Model Structure ---------------------- - -the root level of the common event format - -.. csv-table:: - :delim: | - :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>` | | | - -.. _d_4089a4a9ee684770c6f37a588a577589: - -eventDomainThrottleSpecification Model Structure ------------------------------------------------- - -specification of what information to suppress within an event domain - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - eventDomain | Yes | string | | | Event domain enum from the commonEventHeader domain field - suppressedFieldNames | No | array of string | | | List of optional field names in the event block that should not be sent to the Event Listener - suppressedNvPairsList | No | array of :ref:`suppressedNvPairs <d_52877eda2d273b282063857f97fa7ff4>` | | | Optional list of specific NvPairsNames to suppress within a given Name-Value Field - -.. _d_e7aa5254472f7823fdd6d5a090bfd0a4: - -faultFields Model Structure ---------------------------- - -fields specific to fault events - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - alarmAdditionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional alarm information - alarmCondition | Yes | string | | | alarm condition reported by the device - alarmInterfaceA | No | string | | | card, port, channel or interface name of the device generating the alarm - eventCategory | No | string | | | Event category, for example: license, link, routing, security, signaling - eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity - eventSourceType | Yes | string | | | type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction - faultFieldsVersion | Yes | number | | | version of the faultFields block - specificProblem | Yes | string | | | short description of the alarm or problem - vfStatus | Yes | string | | {'enum': ['Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting termination']} | virtual function status enumeration - -.. _d_76d7f35861442236cee9f716ea1e1540: - -featuresInUse Model Structure ------------------------------ - -number of times an identified feature was used over the measurementInterval - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - featureIdentifier | Yes | string | | | - featureUtilization | Yes | integer | | | - -.. _d_a9799335edbbc52c7f0c5191f7bd09ee: - -field Model Structure ---------------------- - -name value pair - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - name | Yes | string | | | - value | Yes | string | | | - -.. _d_18e1fa5fd6774deefce826b075f8b6e7: - -filesystemUsage Model Structure -------------------------------- - -disk usage of an identified virtual machine in gigabytes and/or gigabytes per -second - -.. csv-table:: - :delim: | - :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 | | | - -.. _d_bb1527d221e848e0896c78552979238b: - -gtpPerFlowMetrics Model Structure ---------------------------------- - -Mobility GTP Protocol per flow metrics - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - avgBitErrorRate | Yes | number | | | average bit error rate - avgPacketDelayVariation | Yes | number | | | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets - avgPacketLatency | Yes | number | | | average delivery latency - avgReceiveThroughput | Yes | number | | | average receive throughput - avgTransmitThroughput | Yes | number | | | average transmit throughput - durConnectionFailedStatus | No | number | | | duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval - durTunnelFailedStatus | No | number | | | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval - flowActivatedBy | No | string | | | Endpoint activating the flow - flowActivationEpoch | Yes | number | | | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available - flowActivationMicrosec | Yes | number | | | Integer microseconds for the start of the flow connection - flowActivationTime | No | string | | | time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 - flowDeactivatedBy | No | string | | | Endpoint deactivating the flow - flowDeactivationEpoch | Yes | number | | | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time - flowDeactivationMicrosec | Yes | number | | | Integer microseconds for the start of the flow connection - flowDeactivationTime | Yes | string | | | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 - flowStatus | Yes | string | | | connection status at reporting time as a working / inactive / failed indicator value - gtpConnectionStatus | No | string | | | Current connection state at reporting time - gtpTunnelStatus | No | string | | | Current tunnel state at reporting time - ipTosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow - ipTosList | No | array of string | | | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' - largePacketRtt | No | number | | | large packet round trip time - largePacketThreshold | No | number | | | large packet threshold being applied - maxPacketDelayVariation | Yes | number | | | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets - maxReceiveBitRate | No | number | | | maximum receive bit rate - maxTransmitBitRate | No | number | | | maximum transmit bit rate - mobileQciCosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow - mobileQciCosList | No | array of string | | | Array of unique LTE QCI or UMTS class-of-service values observed in the flow - numActivationFailures | Yes | number | | | Number of failed activation requests, as observed by the reporting node - numBitErrors | Yes | number | | | number of errored bits - numBytesReceived | Yes | number | | | number of bytes received, including retransmissions - numBytesTransmitted | Yes | number | | | number of bytes transmitted, including retransmissions - numDroppedPackets | Yes | number | | | number of received packets dropped due to errors per virtual interface - numGtpEchoFailures | No | number | | | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 - numGtpTunnelErrors | No | number | | | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 - numHttpErrors | No | number | | | Http error count - numL7BytesReceived | Yes | number | | | number of tunneled layer 7 bytes received, including retransmissions - numL7BytesTransmitted | Yes | number | | | number of tunneled layer 7 bytes transmitted, excluding retransmissions - numLostPackets | Yes | number | | | number of lost packets - numOutOfOrderPackets | Yes | number | | | number of out-of-order packets - numPacketErrors | Yes | number | | | number of errored packets - numPacketsReceivedExclRetrans | Yes | number | | | number of packets received, excluding retransmission - numPacketsReceivedInclRetrans | Yes | number | | | number of packets received, including retransmission - numPacketsTransmittedInclRetrans | Yes | number | | | number of packets transmitted, including retransmissions - numRetries | Yes | number | | | number of packet retries - numTimeouts | Yes | number | | | number of packet timeouts - numTunneledL7BytesReceived | Yes | number | | | number of tunneled layer 7 bytes received, excluding retransmissions - roundTripTime | Yes | number | | | round trip time - tcpFlagCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow - tcpFlagList | No | array of string | | | Array of unique TCP Flags observed in the flow - timeToFirstByte | Yes | number | | | Time in milliseconds between the connection activation and first byte received - -.. _d_6ea626e11ce7887cddd39c36ff4f0926: - -heartbeatFields Model Structure -------------------------------- - -optional field block for fields specific to heartbeat events - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional heartbeat fields if needed - heartbeatFieldsVersion | Yes | number | | | version of the heartbeatFields block - heartbeatInterval | Yes | integer | | | current heartbeat interval in seconds - -.. _d_2873d30f54c59ef635c1fc0cbbaa89f1: - -internalHeaderFields Model Structure ------------------------------------- - -enrichment fields for internal VES Event Listener service use only, not -supplied by event sources - -.. _d_d8868aee802ae8e2b1e7ea1c4ecc1f54: - -jsonObject Model Structure --------------------------- - -json object schema, name and other meta-information along with one or more -object instances - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - nfSubscribedObjectName | No | string | | | name of the object associated with the nfSubscriptonId - nfSubscriptionId | No | string | | | identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject - objectInstances | Yes | array of :ref:`jsonObjectInstance <d_7bccbee07bd3044bd0b929cb6b567c03>` | | | one or more instances of the jsonObject - objectName | Yes | string | | | name of the JSON Object - objectSchema | No | string | | | json schema for the object - objectSchemaUrl | No | string | | | Url to the json schema for the object - -.. _d_7bccbee07bd3044bd0b929cb6b567c03: - -jsonObjectInstance Model Structure ----------------------------------- - -meta-information about an instance of a jsonObject along with the actual -object instance - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - objectInstance | Yes | :ref:`objectInstance <i_4cf8290bf745cd386f0a55ec865aafd5>` | | | an instance conforming to the jsonObject schema - objectInstanceEpochMicrosec | No | number | | | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds - objectKeys | No | array of :ref:`key <d_a217491e9c44487ec7bbd9ce3ac9dddb>` | | | an ordered set of keys that identifies this particular instance of jsonObject - -.. _i_4cf8290bf745cd386f0a55ec865aafd5: - -**Objectinstance schema:** - -an instance conforming to the jsonObject schema - -.. _d_a217491e9c44487ec7bbd9ce3ac9dddb: - -key Model Structure -------------------- - -tuple which provides the name of a key along with its value and relative order - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - keyName | Yes | string | | | name of the key - keyOrder | No | integer | | | relative sequence or order of the key with respect to other keys - keyValue | No | string | | | value of the key - -.. _d_dc21244021b6cb0e0af16166e4600d99: - -latencyBucketMeasure Model Structure ------------------------------------- - -number of counts falling within a defined latency bucket - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - countsInTheBucket | Yes | number | | | - highEndOfLatencyBucket | No | number | | | - lowEndOfLatencyBucket | No | number | | | - -.. _d_669cf98e276c9992abd27056c432bbb2: - -measurementsForVfScalingFields Model Structure ----------------------------------------------- - -measurementsForVfScaling fields - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional name-value-pair fields - additionalMeasurements | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` | | | array of named name-value-pair arrays - additionalObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` | | | array of JSON objects described by name, schema and other meta-information - codecUsageArray | No | array of :ref:`codecsInUse <d_df249c51a416f54e5609f2ffffe059c0>` | | | array of codecs in use - concurrentSessions | No | integer | | | peak concurrent sessions for the VM or VNF over the measurementInterval - configuredEntities | No | integer | | | over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF - cpuUsageArray | No | array of :ref:`cpuUsage <d_6f081937f31c09078c8acf9212d6c449>` | | | usage of an array of CPUs - diskUsageArray | No | array of :ref:`diskUsage <d_bb7a69764c21219953df76826934938e>` | | | usage of an array of disks - featureUsageArray | No | array of :ref:`featuresInUse <d_76d7f35861442236cee9f716ea1e1540>` | | | array of features in use - filesystemUsageArray | No | array of :ref:`filesystemUsage <d_18e1fa5fd6774deefce826b075f8b6e7>` | | | filesystem usage of the VM on which the VNFC reporting the event is running - latencyDistribution | No | array of :ref:`latencyBucketMeasure <d_dc21244021b6cb0e0af16166e4600d99>` | | | array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges - meanRequestLatency | No | number | | | mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running - measurementInterval | Yes | number | | | interval over which measurements are being reported in seconds - measurementsForVfScalingVersion | Yes | number | | | version of the measurementsForVfScaling block - memoryUsageArray | No | array of :ref:`memoryUsage <d_7a758ee807f435a8ba5568e6da6ed597>` | | | memory usage of an array of VMs - numberOfMediaPortsInUse | No | integer | | | number of media ports in use - requestRate | No | number | | | peak rate of service requests per second to the VNF over the measurementInterval - vNicPerformanceArray | No | array of :ref:`vNicPerformance <d_b845a2955da4c78bef3ba4d50021a240>` | | | usage of an array of virtual network interface cards - vnfcScalingMetric | No | integer | | | represents busy-ness of the VNF from 0 to 100 as reported by the VNFC - -.. _d_7a758ee807f435a8ba5568e6da6ed597: - -memoryUsage Model Structure ---------------------------- - -memory usage of an identified virtual machine - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - memoryBuffered | No | number | | | kibibytes of temporary storage for raw disk blocks - memoryCached | No | number | | | kibibytes of memory used for cache - memoryConfigured | No | number | | | kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running - memoryFree | Yes | number | | | kibibytes of physical RAM left unused by the system - memorySlabRecl | No | number | | | the part of the slab that can be reclaimed such as caches measured in kibibytes - memorySlabUnrecl | No | number | | | the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes - memoryUsed | Yes | number | | | total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes - vmIdentifier | Yes | string | | | virtual machine identifier associated with the memory metrics - -.. _d_dc18fe1d28fe3ef664c3f4ab777d8424: - -mobileFlowFields Model Structure --------------------------------- - -mobileFlow fields - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional mobileFlow fields if needed - appProtocolType | No | string | | | application protocol - appProtocolVersion | No | string | | | application protocol version - applicationType | No | string | | | Application type inferred - cid | No | string | | | cell id - 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>` | | | - 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 - imei | No | string | | | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device - imsi | No | string | | | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device - ipProtocolType | Yes | string | | | IP protocol type e.g., TCP, UDP, RTP... - ipVersion | Yes | string | | | IP protocol version e.g., IPv4, IPv6 - lac | No | string | | | location area code - mcc | No | string | | | mobile country code - mnc | No | string | | | mobile network code - mobileFlowFieldsVersion | Yes | number | | | version of the mobileFlowFields block - msisdn | No | string | | | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device - otherEndpointIpAddress | Yes | string | | | IP address for the other endpoint, as used for the flow being reported on - otherEndpointPort | Yes | integer | | | IP Port for the reporting entity, as used for the flow being reported on - otherFunctionalRole | No | string | | | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... - rac | No | string | | | routing area code - radioAccessTechnology | No | string | | | Radio Access Technology e.g., 2G, 3G, LTE - reportingEndpointIpAddr | Yes | string | | | IP address for the reporting entity, as used for the flow being reported on - reportingEndpointPort | Yes | integer | | | IP port for the reporting entity, as used for the flow being reported on - sac | No | string | | | service area code - samplingAlgorithm | No | integer | | | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied - tac | No | string | | | transport area code - tunnelId | No | string | | | tunnel identifier - vlanId | No | string | | | VLAN identifier used by this flow - -.. _d_38de3331d60414da3eea18e8f7e0ecf9: - -namedArrayOfFields Model Structure ----------------------------------- - -an array of name value pairs along with a name for the array - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name value pairs - name | Yes | string | | | - -.. _d_5a79cd7ce784d60fd832d9c7c0a24322: - -otherFields Model Structure ---------------------------- - -fields for events belonging to the 'other' domain of the commonEventHeader -domain enumeration - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - hashOfNameValuePairArrays | No | array of :ref:`namedArrayOfFields <d_38de3331d60414da3eea18e8f7e0ecf9>` | | | array of named name-value-pair arrays - jsonObjects | No | array of :ref:`jsonObject <d_d8868aee802ae8e2b1e7ea1c4ecc1f54>` | | | array of JSON objects described by name, schema and other meta-information - nameValuePairs | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name-value pairs - otherFieldsVersion | Yes | number | | | version of the otherFields block - -.. _d_6747334473cf2b305fe43b61a40656e1: - -requestError Model Structure ----------------------------- - -standard request error data structure - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - messageId | Yes | string | | | Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception - text | Yes | string | | | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 - url | No | string | | | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents - variables | No | string | | | List of zero or more strings that represent the contents of the variables used by the message text - -.. _d_c3e191f0b26ddd68f927ac0c8b551c5e: - -sipSignalingFields Model Structure ----------------------------------- - -sip signaling fields - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional sip signaling fields if needed - compressedSip | No | string | | | the full SIP request/response including headers and bodies - correlator | Yes | string | | | this is the same for all events on this call - localIpAddress | Yes | string | | | IP address on VNF - localPort | Yes | string | | | port on VNF - remoteIpAddress | Yes | string | | | IP address of peer endpoint - 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>` | | | - -.. _d_c5450f1a263d0a2b0c64c96119f7d759: - -stateChangeFields Model Structure ---------------------------------- - -stateChange fields - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional stateChange fields if needed - newState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | new state of the entity - oldState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | previous state of the entity - stateChangeFieldsVersion | Yes | number | | | version of the stateChangeFields block - stateInterface | Yes | string | | | card or port name of the entity that changed state - -.. _d_52877eda2d273b282063857f97fa7ff4: - -suppressedNvPairs Model Structure ---------------------------------- - -List of specific NvPairsNames to suppress within a given Name-Value Field -for event Throttling - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - nvPairFieldName | Yes | string | | | Name of the field within which are the nvpair names to suppress - suppressedNvPairNames | Yes | array of string | | | Array of nvpair names to suppress within the nvpairFieldName - -.. _d_782271970af04a3b0e5a5da9b30996d2: - -syslogFields Model Structure ----------------------------- - -sysLog fields - -.. csv-table:: - :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 - 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: - -thresholdCrossingAlertFields Model Structure --------------------------------------------- - -fields specific to threshold crossing alert events - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - additionalFields | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional threshold crossing alert fields if needed - additionalParameters | Yes | array of :ref:`counter <d_6e043350cba5faafe21de49c2f6fd745>` | | | performance counters - alertAction | Yes | string | | {'enum': ['CLEAR', 'CONT', 'SET']} | Event action - alertDescription | Yes | string | | | Unique short alert description such as IF-SHUB-ERRDROP - alertType | Yes | string | | {'enum': ['CARD-ANOMALY', 'ELEMENT-ANOMALY', 'INTERFACE-ANOMALY', 'SERVICE-ANOMALY']} | Event type - alertValue | No | string | | | Calculated API value (if applicable) - associatedAlertIdList | No | array of string | | | List of eventIds associated with the event being reported - collectionTimestamp | Yes | string | | | Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 - dataCollector | No | string | | | Specific performance collector instance used - elementType | No | string | | | type of network element - internal ATT field - eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity or priority - eventStartTimestamp | Yes | string | | | Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800 - interfaceName | No | string | | | Physical or logical port or card (if applicable) - networkService | No | string | | | network name - internal ATT field - possibleRootCause | No | string | | | Reserved for future use - thresholdCrossingFieldsVersion | Yes | number | | | version of the thresholdCrossingAlertFields block - -.. _d_b845a2955da4c78bef3ba4d50021a240: - -vNicPerformance Model Structure -------------------------------- - -describes the performance and errors of an identified virtual network -interface card - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - receivedBroadcastPacketsAccumulated | No | number | | | Cumulative count of broadcast packets received as read at the end of the measurement interval - receivedBroadcastPacketsDelta | No | number | | | Count of broadcast packets received within the measurement interval - receivedDiscardedPacketsAccumulated | No | number | | | Cumulative count of discarded packets received as read at the end of the measurement interval - receivedDiscardedPacketsDelta | No | number | | | Count of discarded packets received within the measurement interval - receivedErrorPacketsAccumulated | No | number | | | Cumulative count of error packets received as read at the end of the measurement interval - receivedErrorPacketsDelta | No | number | | | Count of error packets received within the measurement interval - receivedMulticastPacketsAccumulated | No | number | | | Cumulative count of multicast packets received as read at the end of the measurement interval - receivedMulticastPacketsDelta | No | number | | | Count of multicast packets received within the measurement interval - receivedOctetsAccumulated | No | number | | | Cumulative count of octets received as read at the end of the measurement interval - receivedOctetsDelta | No | number | | | Count of octets received within the measurement interval - receivedTotalPacketsAccumulated | No | number | | | Cumulative count of all packets received as read at the end of the measurement interval - receivedTotalPacketsDelta | No | number | | | Count of all packets received within the measurement interval - receivedUnicastPacketsAccumulated | No | number | | | Cumulative count of unicast packets received as read at the end of the measurement interval - receivedUnicastPacketsDelta | No | number | | | Count of unicast packets received within the measurement interval - transmittedBroadcastPacketsAccumulated | No | number | | | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval - transmittedBroadcastPacketsDelta | No | number | | | Count of broadcast packets transmitted within the measurement interval - transmittedDiscardedPacketsAccumulated | No | number | | | Cumulative count of discarded packets transmitted as read at the end of the measurement interval - transmittedDiscardedPacketsDelta | No | number | | | Count of discarded packets transmitted within the measurement interval - transmittedErrorPacketsAccumulated | No | number | | | Cumulative count of error packets transmitted as read at the end of the measurement interval - transmittedErrorPacketsDelta | No | number | | | Count of error packets transmitted within the measurement interval - transmittedMulticastPacketsAccumulated | No | number | | | Cumulative count of multicast packets transmitted as read at the end of the measurement interval - transmittedMulticastPacketsDelta | No | number | | | Count of multicast packets transmitted within the measurement interval - transmittedOctetsAccumulated | No | number | | | Cumulative count of octets transmitted as read at the end of the measurement interval - transmittedOctetsDelta | No | number | | | Count of octets transmitted within the measurement interval - transmittedTotalPacketsAccumulated | No | number | | | Cumulative count of all packets transmitted as read at the end of the measurement interval - transmittedTotalPacketsDelta | No | number | | | Count of all packets transmitted within the measurement interval - transmittedUnicastPacketsAccumulated | No | number | | | Cumulative count of unicast packets transmitted as read at the end of the measurement interval - transmittedUnicastPacketsDelta | No | number | | | Count of unicast packets transmitted within the measurement interval - vNicIdentifier | Yes | string | | | vNic identification - valuesAreSuspect | Yes | string | | {'enum': ['true', 'false']} | Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions - -.. _d_d694eebbbc0078612d2ba22e0cbf814c: - -vendorVnfNameFields Model Structure ------------------------------------ - -provides vendor, vnf and vfModule identifying information - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - vendorName | Yes | string | | | VNF vendor name - vfModuleName | No | string | | | ASDC vfModuleName for the vfModule generating the event - vnfName | No | string | | | ASDC modelName for the VNF generating the event - -.. _d_9551641bd1c775d9fcf4e45353de8e43: - -voiceQualityFields Model Structure ----------------------------------- - -provides statistics related to customer facing voice products - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 +Response Example - additionalInformation | No | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | additional voice quality fields if needed - 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>` | | | - 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>` | | | - voiceQualityFieldsVersion | Yes | number | | | version of the voiceQualityFields block +.. code-block:: http + HTTPS/1.1 202 Accepted + X-MinorVersion: 1 + X-PatchVersion: 1 + X-LatestVersion: 7.1.1 diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst index bd97770a..3bc3ceb6 100644 --- a/docs/sections/architecture.rst +++ b/docs/sections/architecture.rst @@ -43,7 +43,6 @@ The following lists the components included in ONAP DCAE . All DCAE components - DCAE Inventory-API: API for DCAE's TOSCA model store. - Platform services - Consul: Distributed service discovery service and KV store. - - PNDA: Platform for Network Data Analytics. - Postgres Database: DCAE's TOSCA model store. - Redis Database: DCAE's transactional state store, used by TCA for supporting persistence and seamless scaling. @@ -60,12 +59,13 @@ The following lists the components included in ONAP DCAE . All DCAE components - Docker based Threshold Crosssing Analytics - Heartbeat Services - SON-Handler Service - - Microservices + - Event processors - PNF Registration Handler - VES Mapper Service - PM-Mapper Service - BBS-EventProcessor Service - PM Subcription Handler + - DataLake Handlers The figure below shows the DCAE architecture and how the components work with each other. The components on the right constitute the Platform/controller components which are statically deployed. The components on the right represent the services which can be both deployed statically or dynamically (via CLAMP) diff --git a/docs/sections/components/blueprint_generator.rst b/docs/sections/components/blueprint_generator.rst index 8813cefd..3a014ea3 100644 --- a/docs/sections/components/blueprint_generator.rst +++ b/docs/sections/components/blueprint_generator.rst @@ -1,6 +1,6 @@ Blueprint Generator (DCAE) -============================================= +========================== What is the Blueprint Generator? ++++++++++++++++++++++++++++++++ @@ -34,7 +34,7 @@ Steps to run the blueprint generator: -o: This flag will create a service component override for your deployment equal to the value you put (optional) 6. An example running this program would look like this: - ``java -jar blueprint-generator-1.2.1-executable.jar -p blueprint_output -i ComponentSpecs/TestComponentSpec.json -n TestAppBlueprint`` + ``java -jar blueprint-generator-1.3.1-executable.jar -p blueprint_output -i ComponentSpecs/TestComponentSpec.json -n TestAppBlueprint`` Extra information diff --git a/docs/sections/components/component-development.rst b/docs/sections/components/component-development.rst index d4b34a74..63c7f389 100644 --- a/docs/sections/components/component-development.rst +++ b/docs/sections/components/component-development.rst @@ -10,11 +10,10 @@ Onboarding Pre-requisite (Service Component) ./intro.rst ./architecture/pieces.rst ./architecture/service-discovery.rst - ./architecture/blueprint_generator.rst + ./blueprint_generator.rst ./requirements-guidelines.rst ./component-specification/component-specification.rst ./component-json-schema.rst ./data-formats.rst ./dcae-cli/dcae-cli-tool.rst - ./glossary.rst - + ./glossary.rst
\ No newline at end of file diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst index 22e77d18..b62a5406 100644 --- a/docs/sections/configuration.rst +++ b/docs/sections/configuration.rst @@ -6,19 +6,23 @@ Configuration DACEGEN2 platform is deployed via helm charts. The configuration are maintained as on values.yaml and can be updated for deployment if necessary. -The following components are migrated to helm chart part of Dublin release. +For Frankfurt release, the helm charts for each platform component can be controlled via separate override file +https://wiki.onap.org/pages/viewpage.action?pageId=71837415 + + -ConfigBindingService .. csv-table:: :header: "Component", "Charts" :widths: 22,100 - "ConfigBinding Service", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/charts/dcae-config-binding-service" - "Deployment Handler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/charts/dcae-deployment-handler" - "Policy Handler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/charts/dcae-policy-handler" - "ServiceChangeHandler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/charts/dcae-servicechange-handler" - "Invetory", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/charts/dcae-servicechange-handler/charts/dcae-inventory-api" + "Cloudify", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-cloudify-manager" + "ConfigBinding Service", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-config-binding-service" + "Deployment Handler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-deployment-handler" + "Policy Handler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-policy-handler" + "ServiceChangeHandler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-servicechange-handler" + "Inventory", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-inventory-api" + "Dashboard", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-dashboard" @@ -43,32 +47,34 @@ In addition, for DCAE components deployed through Cloudify Manager blueprints, t * The blueprint input files may contain Helm templates, which are resolved into actual deployment time values following the rules for Helm values. -Now we walk through an example, how to configure the Docker image for the DCAE dashboard, which is deployed by Cloudify Manager. +DCAE Service components are deployed via Cloudify Blueprints. Instruction for deployment and configuration are documented under https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/services/serviceindex.html -In the ``k8s-dashboard.yaml-template`` blueprint template, the Docker image to use is defined as an input parameter with a default value: +Now we walk through an example, how to configure the Docker image for the DCAE VESCollector, which is deployed by Cloudify Manager. -.. code-block:: yaml +In the `k8s-ves.yaml <https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-ves.yaml>`_ blueprint, the Docker image to use is defined as an input parameter with a default value: - dashboard_docker_image: - description: 'Docker image for dashboard' - default: 'nexus3.onap.org:10001/onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0-SNAPSHOT-latest' +.. code-block:: yaml -Then in the input file, ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/resources/inputs/k8s-dashboard-inputs.yaml``, + tag_version: + type: string + default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4" + +The corresponding input file, ``https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-bootstrap/resources/inputs/k8s-ves-inputs-tls.yaml``, it is defined again as: .. code-block:: yaml + {{ if .Values.componentImages.ves }} + tag_version: {{ include "common.repository" . }}/{{ .Values.componentImages.ves }} + {{ end }} + - dashboard_docker_image: {{ include "common.repository" . }}/{{ .Values.componentImages.dashboard }} - -Thus, when ``common.repository`` and ``componentImages.policy_handler`` are defined in the ``values.yaml`` files, -their values will be plugged in here and the resulting ``policy_handler_image`` value -will be passed to the Policy Handler blueprint as the Docker image tag to use instead of the default value in the blueprint. +Thus, when ``common.repository`` and ``componentImages.ves`` are defined in the ``values.yaml`` files, +their values will be plugged in here and the resulting ``tag_version`` value +will be passed to the blueprint as the Docker image tag to use instead of the default value in the blueprint. -Indeed the ``componentImages.dashboard`` value is provided in the ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/values.yaml`` file: +The ``componentImages.ves`` value is provided in the ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/values.yaml`` file: .. code-block:: yaml componentImages: - dashboard: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0 - -DCAE Service components are deployed via Cloudify Blueprints. Instruction for deployment and configuration are documented under https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/services/serviceindex.html + ves: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4 diff --git a/docs/sections/healthcheck.rst b/docs/sections/healthcheck.rst index dea0807b..fa017f00 100644 --- a/docs/sections/healthcheck.rst +++ b/docs/sections/healthcheck.rst @@ -18,8 +18,7 @@ request, the service checks Kubernetes to verify that all of the expected DCAE platform and service components are in a ready state. The service has a fixed list of platform and service components that are normally deployed when DCAE is first installed, including components deployed with Helm charts and -components deployed using Cloudify blueprints. In addition, beginning with -the Dublin release, the healthcheck +components deployed using Cloudify blueprints. In addition, the healthcheck service tracks and checks components that are deployed dynamically using Cloudify blueprints after the initial DCAE installation. diff --git a/docs/sections/images/R6_architecture_diagram.png b/docs/sections/images/R6_architecture_diagram.png Binary files differindex f12d86d2..4ebf852e 100644 --- a/docs/sections/images/R6_architecture_diagram.png +++ b/docs/sections/images/R6_architecture_diagram.png diff --git a/docs/sections/installation_MS_ondemand.rst b/docs/sections/installation_MS_ondemand.rst index ce32764e..3fb4c2d6 100644 --- a/docs/sections/installation_MS_ondemand.rst +++ b/docs/sections/installation_MS_ondemand.rst @@ -4,7 +4,7 @@ DCAE MS Deployment ================== -DCAE MS catalog includes number of collectors, analytics and event processor services. For Dublin, not all MS available on default ONAP/DCAE deployment. +DCAE MS catalog includes number of collectors, analytics and event processor services. Not all MS available on default ONAP/DCAE deployment. Following Services are deployed via DCAE Bootstrap @@ -12,11 +12,11 @@ Following Services are deployed via DCAE Bootstrap .. toctree:: :maxdepth: 1 - ./services/snmptrap/index.rst ./services/ves-http/index.rst ./services/ves-hv/index.rst ./services/prh/index.rst ./services/tca-cdap/index.rst + ./services/tcagen2-docker/index.rst Following additional MS are available for on-demand deployment as necessary for any usecases; instruction for deployment are provided under each MS. @@ -30,3 +30,6 @@ Following additional MS are available for on-demand deployment as necessary for BBS EventProcessor MS Installation <./services/bbs-event-processor/installation> Son-Handler MS Installation <./services/son-handler/installation> RESTconf MS Installation <./services/restconf/installation> + SNMP Trap Collector MS Installation <./services/snmptrap/installation> + PM Subscription Handler MS Installation <./services/pm-subscription-handler/installation> + DataLake Handler Installation <./services/datalake-handler/installation> diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst index bd1b752d..fccefa0b 100644 --- a/docs/sections/installation_oom.rst +++ b/docs/sections/installation_oom.rst @@ -24,7 +24,7 @@ and invokes Kubernetes deployment operations for all the resources. All ONAP Helm charts are organized under the **kubernetes** directory of the **OOM** project, where roughly each ONAP component occupies a subdirectory. DCAE charts are placed under the **dcaegen2** directory. -In Dublin, all DCAE platform components (exception of Dashboard) have corresponding Helm chart which will be used to trigger the deployment. +All DCAE platform components have corresponding Helm chart which will be used to trigger the deployment. All DCAE Services are deployed through Cloudify Blueprint. The default ONAP DCAE deployment includes small subset of DCAE services deployed through Bootstrap pod to meet ONAP Integration usecases. Optionally operators can deploy on-demand other MS required for their usecases as described in `On-demand MS Installation <installation_MS_ondemand>`_. @@ -44,8 +44,8 @@ Following Helm conventions, the DCAE Helm chart directory (``oom/kubernetes/dcae * ``requirements.yaml``: dependency charts. * ``values.yaml``: values for Helm templating engine to expand templates. * ``resources``: subdirectory for additional resource definitions such as configuration, scripts, etc. -* ``templates``: subdirectory for Kubernetes resource definition templates. -* ``charts``: subdirectory for sub-charts. +* ``Makefile``: make file to build DCAE charts +* ``components``: subdirectory for DCAE sub-charts. The dcaegen2 chart has the following sub-charts: @@ -56,6 +56,7 @@ The dcaegen2 chart has the following sub-charts: * ``dcae-healthcheck``: deploys the DCAE healthcheck service that provides an API to check the health of all DCAE components. * ``dcae-policy-handler``: deploys the DCAE policy handler service. * ``dcae-redis``: deploys the DCAE Redis cluster. +* ``dcae-dashboard``: deploys the DCAE Dashboard for managing DCAE microservices deployments * ``dcae-servicechange-handler``: deploys the DCAE service change handler service. A subchart (``dcae-inventory-api``) deploys the DCAE inventory API service. DCAE Deployment @@ -96,9 +97,10 @@ The dcae-bootstrap service has a number of prerequisites because the subsequentl * kube2msb * dcae-config-binding-service * dcae-db + * dcae-mongodb Once started, the DCAE bootstrap service will call Cloudify Manager to deploy -a series of blueprints which specify the additional DCAE R4 components. +a series of blueprints which specify the additional DCAE microservice components. These blueprints use the DCAE Kubernetes plugin (``k8splugin``) to deploy Docker images into the ONAP Kubernetes cluster. For each component, the plugin creates a Kubernetes deployment and other Kubernetes resources (services, volumes, logging sidecar, etc.) @@ -106,10 +108,8 @@ as needed. The DCAE bootstrap service creates the following Kubernetes deployments: -* deploy/dep-dcae-dashboard * deploy/dep-dcae-hv-ves-collector * deploy/dep-dcae-prh -* deploy/dep-dcae-snmptrap-collector * deploy/dep-dcae-tca-analytics * deploy/dep-dcae-ves-collector * deploy/dep-holmes-engine-mgmt @@ -145,35 +145,38 @@ In addition, for DCAE components deployed through Cloudify Manager blueprints, t * The blueprint input files may contain Helm templates, which are resolved into actual deployment time values following the rules for Helm values. -Now we walk through an example, how to configure the Docker image for the DCAE dashboard, which is deployed by Cloudify Manager. +Now we walk through an example, how to configure the Docker image for the DCAE VESCollector, which is deployed by Cloudify Manager. -In the ``k8s-dashboard.yaml-template`` blueprint template, the Docker image to use is defined as an input parameter with a default value: +In the `k8s-ves.yaml <https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-ves.yaml>`_ blueprint, the Docker image to use is defined as an input parameter with a default value: .. code-block:: yaml - dashboard_docker_image: - description: 'Docker image for dashboard' - default: 'nexus3.onap.org:10001/onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0-SNAPSHOT-latest' - -Then in the input file, ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/resources/inputs/k8s-dashboard-inputs.yaml``, + tag_version: + type: string + default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4" + +The corresponding input file, ``https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-bootstrap/resources/inputs/k8s-ves-inputs-tls.yaml``, it is defined again as: .. code-block:: yaml + {{ if .Values.componentImages.ves }} + tag_version: {{ include "common.repository" . }}/{{ .Values.componentImages.ves }} + {{ end }} + - dashboard_docker_image: {{ include "common.repository" . }}/{{ .Values.componentImages.dashboard }} - -Thus, when ``common.repository`` and ``componentImages.policy_handler`` are defined in the ``values.yaml`` files, -their values will be plugged in here and the resulting ``policy_handler_image`` value -will be passed to the Policy Handler blueprint as the Docker image tag to use instead of the default value in the blueprint. +Thus, when ``common.repository`` and ``componentImages.ves`` are defined in the ``values.yaml`` files, +their values will be plugged in here and the resulting ``tag_version`` value +will be passed to the blueprint as the Docker image tag to use instead of the default value in the blueprint. -Indeed the ``componentImages.dashboard`` value is provided in the ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/values.yaml`` file: +The ``componentImages.ves`` value is provided in the ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/values.yaml`` file: .. code-block:: yaml componentImages: - dashboard: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0 + ves: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4 + -The final result is that when DCAE bootstrap calls Cloudify Manager to deploy the DCAE dashboard, the 1.1.0 image will be deployed. +The final result is that when DCAE bootstrap calls Cloudify Manager to deploy the DCAE VES collector, the 1.5.4 image will be deployed. DCAE Service Endpoints ---------------------- @@ -182,18 +185,18 @@ Below is a table of default hostnames and ports for DCAE component service endpo ================== ================================= ====================================================== Component Cluster Internal (host:port) Cluster external (svc_name:port) ================== ================================= ====================================================== - VES dcae-ves-collector:8080 xdcae-ves-collector.onap:30235 + VES dcae-ves-collector:8443 xdcae-ves-collector.onap:30417 HV-VES dcae-hv-ves-collector:6061 xdcae-hv-ves-collector.onap:30222 TCA dcae-tca-analytics:11011 xdcae-tca-analytics.onap:32010 + TCA-Gen2 dcae-tcagen2:9091 NA PRH dcae-prh:8100 NA - SNMPTrap dcae-snmptrap-collector:6162/udp xdcae-snmptrap-collector:30470/UDP Policy Handler policy-handler:25577 NA Deployment Handler deployment-handler:8443 NA Inventory inventory:8080 NA - Config binding config-binding-service:10000 config-binding-servicee:30415 + Config binding config-binding-service:10000/10001 config-binding-service:30415 DCAE Healthcheck dcae-healthcheck:80 NA Cloudify Manager dcae-cloudify-manager:80 NA - DCAE Dashboard dcae-dashboard:8080/8443 xdcae-dashboard:30418/30419 + DCAE Dashboard dcae-dashboard:8443 xdcae-dashboard:30419 ================== ================================= ====================================================== In addition, a number of ONAP service endpoints that are used by DCAE components are listed as follows diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 4322199c..849cd7b7 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -3,16 +3,20 @@ .. Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved. .. _release_notes: -Release Notes -============= +DCAE Release Notes +================== + +Abstract +-------- +This document provides the release notes for the Frankfurt release (6.0.0) -Version: 6.0.0 --------------- +Summary +------- **New Features** -DCAE R6 improves upon previous release with the following new features: +DCAE improves upon previous release with the following new features: - DCAE Platform Enhancement - Introduction of Microservice and Onboarding Design (MOD) platform @@ -81,6 +85,7 @@ Under OOM (Kubernetes) deployment all DCAE component containers are deployed as **Known Issues** * Blueprint generator issue (DCAEGEN2-2140) + * TCAgen2 Policy configuration support (DCAEGEN2-2198) **Security Notes** @@ -92,6 +97,7 @@ Under OOM (Kubernetes) deployment all DCAE component containers are deployed as * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_] * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_] * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_] + *Known Security Issues* @@ -104,10 +110,6 @@ Under OOM (Kubernetes) deployment all DCAE component containers are deployed as DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_. -Quick Links: - - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_ - - - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ Artifacts released: @@ -156,7 +158,15 @@ Artifacts released: "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)" "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2" +**Test Results** + + - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_ + - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_ + +**References** + - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_ + - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ Version: 5.0.1 -------------- diff --git a/docs/sections/sdk/architecture.rst b/docs/sections/sdk/architecture.rst index 3f3cdf55..7cf70267 100644 --- a/docs/sections/sdk/architecture.rst +++ b/docs/sections/sdk/architecture.rst @@ -8,7 +8,7 @@ Introduction ------------ As most services and collectors deployed on DCAE platform relies on similar microservices a common Software Development Kit has been created. It contains utilities and clients which may be used for getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK is written in Java. -Some of common function across different services are targeted to build as separate library was created in Dublin release. +Some of common function across different services are targeted to build as separate library. Reactive programming -------------------- diff --git a/docs/sections/sdk/index.rst b/docs/sections/sdk/index.rst index c5d27a2d..86a9d99b 100644 --- a/docs/sections/sdk/index.rst +++ b/docs/sections/sdk/index.rst @@ -4,7 +4,7 @@ DCAE SDK ======== -With Dublin release, DCAE has introduced new SDK's to aid component development. **SDK** is a common software development kit written in Java. It contains various utilities and clients which may be used for getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. +Since Dublin release, DCAE has introduced new SDK's to aid component development. **SDK** is a common software development kit written in Java. It contains various utilities and clients which may be used for getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK Overview diff --git a/docs/sections/services/dfc/installation.rst b/docs/sections/services/dfc/installation.rst index 6f1c91e1..cd546754 100644 --- a/docs/sections/services/dfc/installation.rst +++ b/docs/sections/services/dfc/installation.rst @@ -57,10 +57,10 @@ subscribes to DMAAP/MR fileReady event as JSON messages and publishes the downlo Installation
^^^^^^^^^^^^
-The following command will download the Dublin version of the datafile image from
+The following command will download the Frankfurt version of the datafile image from
nexus and launch it in the container named "datafile":
- ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3``
+ ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0``
For another version, it is possible to replace the tag '1.2.3' with any version that seems suitable (including latest).
Available images are visible following this `link`_.
diff --git a/docs/sections/services/heartbeat-ms/installation.rst b/docs/sections/services/heartbeat-ms/installation.rst index df50dfb1..b8aef18a 100644 --- a/docs/sections/services/heartbeat-ms/installation.rst +++ b/docs/sections/services/heartbeat-ms/installation.rst @@ -6,26 +6,27 @@ Following are steps if manual deployment/undeployment required. Steps to deploy are shown below -- Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Heartbeat Blueprint can be found under https://git.onap.org/dcaegen2/services/heartbeat/tree/dpo/k8s-heartbeat.yaml?h=dublin - -- Transfer blueprint inputs file in DCAE bootstrap POD under /inputs directory. Sample input file can be found under https://git.onap.org/dcaegen2/services/heartbeat/tree/dpo/k8s-heartbeat-inputs.yaml +- Heartbeat MS blueprint is available under bootstrap pod (under /blueprints/k8s-heartbeat.yaml). The blueprint is also maintained in gerrit and can be downloaded from https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-heartbeat.yaml + + +- Create an input file in DCAE bootstrap POD under / directory. Sample input file can be found under https://git.onap.org/dcaegen2/services/heartbeat/tree/dpo/k8s-heartbeat-inputs.yaml - Enter the Bootstrap POD - Validate blueprint .. code-block:: bash - cfy blueprints validate /blueprints/k8s-hearttbeat.yaml + cfy blueprints validate /blueprints/k8s-heartbeat.yaml - Upload validated blueprint .. code-block:: bash - cfy blueprints upload -b heartbeat /blueprints/k8s-hearttbeat.yaml + cfy blueprints upload -b heartbeat /blueprints/k8s-heartbeat.yaml - Create deployment .. code-block:: bash - cfy deployments create -b heartbeat -i /k8s-hearttbeat-input.yaml heartbeat + cfy deployments create -b heartbeat -i /k8s-heartbeat-input.yaml heartbeat - Deploy blueprint .. code-block:: bash diff --git a/docs/sections/services/mapper/troubleshooting.rst b/docs/sections/services/mapper/troubleshooting.rst index 196faa0d..5d524e5c 100644 --- a/docs/sections/services/mapper/troubleshooting.rst +++ b/docs/sections/services/mapper/troubleshooting.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _troubleshooting: Troubleshooting =============== diff --git a/docs/sections/services/pm-mapper/installation.rst b/docs/sections/services/pm-mapper/installation.rst index ad96e5d2..432a2e34 100644 --- a/docs/sections/services/pm-mapper/installation.rst +++ b/docs/sections/services/pm-mapper/installation.rst @@ -36,7 +36,7 @@ Enter the Cloudify Manager kuberenetes pod :delim: ;
:header: Property , Sample Value , Description , Required
- client_id ; dcae@dcae.onap.org ; In the Dublin release information about the AAF user must be provided to enable publishing to authenticated topics. ; Yes
+ client_id ; dcae@dcae.onap.org ; Information about the AAF user must be provided to enable publishing to authenticated topics. ; Yes
client_password ; <dcae_password> ; This is the password for the given user e.g. The <dcae_password> is dcae@dcae.onap.org's password. ; Yes
enable_http ; true ; By default, the PM-Mapper will only allow inbound queries over HTTPS. However, it is possible to configure it to enable HTTP also. ; No
tag_version ; nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.0.1 ; The tag of the Docker image will be used when deploying the PM-Mapper. ; No
diff --git a/docs/sections/services/pm-mapper/troubleshooting.rst b/docs/sections/services/pm-mapper/troubleshooting.rst index c025fb0c..add7b7ae 100644 --- a/docs/sections/services/pm-mapper/troubleshooting.rst +++ b/docs/sections/services/pm-mapper/troubleshooting.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _troubleshooting: Troubleshooting =============== diff --git a/docs/sections/services/pm-subscription-handler/troubleshooting.rst b/docs/sections/services/pm-subscription-handler/troubleshooting.rst index 07787c41..d5238026 100644 --- a/docs/sections/services/pm-subscription-handler/troubleshooting.rst +++ b/docs/sections/services/pm-subscription-handler/troubleshooting.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _Troubleshooting: Troubleshooting =============== diff --git a/docs/sections/services/restconf/installation.rst b/docs/sections/services/restconf/installation.rst index d475ef7a..e38cf6be 100644 --- a/docs/sections/services/restconf/installation.rst +++ b/docs/sections/services/restconf/installation.rst @@ -6,7 +6,7 @@ Standalone docker run command docker run onap/org.onap.dcaegen2.collectors.restconfcollector -For Dublin release, RESTConf collector will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation. +For the current release, RESTConf collector will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation. Steps to deploy are shown below @@ -14,17 +14,17 @@ Steps to deploy are shown below - Enter the Bootstrap POD using kubectl - Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Blueprint can be found in - https://git.onap.org/dcaegen2/collectors/restconf/tree/dpo/blueprints/k8s-rcc-policy.yaml-template?h=dublin + https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-restconf.yaml - Validate blueprint .. code-block:: bash - cfy blueprints validate /blueprints/k8s-rcc-policy.yaml + cfy blueprints validate /blueprints/k8s-restconf.yaml - Upload validated blueprint .. code-block:: bash - cfy blueprints upload -b restconfcollector /blueprints/k8s-rcc-policy.yaml + cfy blueprints upload -b restconfcollector /blueprints/k8s-restconf.yaml - Create deployment .. code-block:: bash diff --git a/docs/sections/services/serviceindex.rst b/docs/sections/services/serviceindex.rst index e7faca4a..aa29f06e 100644 --- a/docs/sections/services/serviceindex.rst +++ b/docs/sections/services/serviceindex.rst @@ -22,4 +22,5 @@ DCAE Service components ./bbs-event-processor/index.rst ./son-handler/index.rst ./restconf/index.rst - ./tca-cdap/index.rst
\ No newline at end of file + ./tca-cdap/index.rst + ./tcagen2-docker/index.rst
\ No newline at end of file diff --git a/docs/sections/services/son-handler/son_handler_overview.rst b/docs/sections/services/son-handler/son_handler_overview.rst index 62dc12a8..767d923d 100644 --- a/docs/sections/services/son-handler/son_handler_overview.rst +++ b/docs/sections/services/son-handler/son_handler_overview.rst @@ -60,9 +60,9 @@ This is responsible for registering with the DMaaP client for the DMaaP notifica Deployment aspects
------------------
-The SON-Handler MS will be deployed on DCAE using the mechanism described in "Option 3 - On-Demand deployment through DCAE-Controller cli" at https://wiki.onap.org/display/DW/Dublin+Deployment+Strategy.Details of the installation steps are available at ./installation.rst. Further details can be obtained from https://wiki.onap.org/pages/viewpage.action?pageId=76875778.
+The SON-Handler MS will be deployed on DCAE as an on-demand component. Details of the installation steps are available at ./installation.rst. Further details can be obtained from https://wiki.onap.org/pages/viewpage.action?pageId=76875778
Known Issues and Resolutions
----------------------------
-The scope and scenarios addressed are documented in the SON use case page for Dublin - https://wiki.onap.org/display/DW/OOF-PCI+Use+Case+-+Dublin+Release+-+ONAP+based+SON+for+PCI+and+ANR.
+The scope and scenarios addressed are documented in the SON use case page - https://wiki.onap.org/display/DW/OOF-PCI+Use+Case+-+Dublin+Release+-+ONAP+based+SON+for+PCI+and+ANR.
The enhancements and limitations in Frankfurt release are documented in the SON use case page for Frankfurt - https://wiki.onap.org/display/DW/OOF+%28SON%29+in+R5+El+Alto%2C+OOF+%28SON%29+in+R6+Frankfurt.
diff --git a/docs/sections/services/tcagen2-docker/installation.rst b/docs/sections/services/tcagen2-docker/installation.rst index 7fa53e29..792f8a48 100644 --- a/docs/sections/services/tcagen2-docker/installation.rst +++ b/docs/sections/services/tcagen2-docker/installation.rst @@ -21,14 +21,13 @@ Enter the Cloudify Manager kuberenetes pod - Tca-gen2 blueprint directory (/blueprints/k8s-tcagen2.yaml). The blueprint is also maintained in gerrit and can be downloaded from https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2.yaml - - Create input file required for deployment + - Create input file required for deployment Configuration of the service consists of generating an inputs file (YAML) which will be used as part of the Cloudify install. The tca-gen2 blueprints was designed with known defaults for the majority of the fields. Below you will find examples of fields which can be configured, and some of the fields - which must be configured. The full list of configurable parameters can be seen within the bootstrap container under - /inputs/k8s-tcagen2-inputs.yaml + which must be configured. An input file is loaded into bootstrap container (/inputs/k8s-tcagen2-inputs.yaml). .. csv-table:: @@ -52,7 +51,7 @@ Enter the Cloudify Manager kuberenetes pod .. code-block:: bash - cfy install --blueprint-id tca-gen2 --deployment-id tca-gen2 -i k8s-tcagen2-inputs.yaml /blueprints/k8s-tcagen2.yaml + cfy install --blueprint-id tcagen2 --deployment-id tcagen2 -i /inputs/k8s-tcagen2-inputs.yaml /blueprints/k8s-tcagen2.yaml @@ -61,9 +60,9 @@ To undeploy TCA-gen2, steps are shown below - Uninstall running TCA-gen2 and delete deployment .. code-block:: bash - cfy uninstall tca-gen2 + cfy uninstall tcagen2 - Delete blueprint .. code-block:: bash - cfy blueprints delete tca-gen2 + cfy blueprints delete tcagen2
\ No newline at end of file diff --git a/docs/sections/services/ves-http/VES-processingFlow.png b/docs/sections/services/ves-http/VES-processingFlow.png Binary files differindex 4c53a2e9..2c765937 100644 --- a/docs/sections/services/ves-http/VES-processingFlow.png +++ b/docs/sections/services/ves-http/VES-processingFlow.png diff --git a/docs/sections/services/ves-http/architecture.rst b/docs/sections/services/ves-http/architecture.rst index 960c9cc5..30145509 100644 --- a/docs/sections/services/ves-http/architecture.rst +++ b/docs/sections/services/ves-http/architecture.rst @@ -9,6 +9,14 @@ VES Architecture VES Processing Flow ------------------- +1) Collector supports different URI based on single or batch event to be received +2) Post authentication – events are validated for schema. At this point – appropriate return code is sent to client (success/failure) +3) Event Processor check against transformation rules (if enabled) and handles VES output standardization (e.g. VES 7.x input to VES5.4 output) +4) Based on domain, events are distributed to configurable topics +5) Post to outbound topic(s). If DMaaP publish is unsuccessful, messages will be queued per topic within VESCollector + +Note: As the collector is deployed as micro-service, all configuration parameters (including DMaaP topics) are passed to the collector dynamically. VEScollector refreshes the configuration from CBS every 5 minutes + .. image:: ./VES-processingFlow.png @@ -20,13 +28,12 @@ VES Collector is configured to support below VES Version; the corresponding API =========== ================ ================================== VES Version API version Schema Definition =========== ================ ================================== -VES 1.2 eventListener/v1 CommonEventFormat_Vendors_v25.json -VES 4.1 eventListener/v4 CommonEventFormat_27.2.json -VES 5.4 eventListener/v5 CommonEventFormat_28.4.1.json -VES 7.0 eventListener/v7 CommonEventFormat_30.0.1.json +VES 1.2 eventListener/v1 `CommonEventFormat_Vendors_v25.json <https://git.onap.org/dcaegen2/collectors/ves/tree/etc/CommonEventFormat_Vendors_v25.json>`_ +VES 4.1 eventListener/v4 `CommonEventFormat_27.2.json <https://git.onap.org/dcaegen2/collectors/ves/tree/etc/CommonEventFormat_27.2.json>`_ +VES 5.4 eventListener/v5 `CommonEventFormat_28.4.1.json <https://git.onap.org/dcaegen2/collectors/ves/tree/etc/CommonEventFormat_28.4.1.json>`_ +VES 7.1.1 eventListener/v7 `CommonEventFormat_30.1.1.json <https://git.onap.org/vnfrqts/requirements/tree/docs/Chapter8/CommonEventFormat_30.1.1_ONAP.json>`_ =========== ================ ================================== - -Schema definition files are contained within VES collector gerrit repo - https://git.onap.org/dcaegen2/collectors/ves/tree/etc + Features Supported @@ -53,8 +60,8 @@ Dynamic configuration fed into Collector via DCAEPlatform POST requests result in standard HTTP status codes: -200-299 Success -400-499 Client request has a problem (data error) -500-599 Collector service has a problem +- 200-299 Success +- 400-499 Client request has a problem (data error) +- 500-599 Collector service has a problem diff --git a/docs/sections/services/ves-http/configuration.rst b/docs/sections/services/ves-http/configuration.rst index eaadf277..7cf9831f 100644 --- a/docs/sections/services/ves-http/configuration.rst +++ b/docs/sections/services/ves-http/configuration.rst @@ -12,10 +12,10 @@ VES expects to be able to fetch configuration directly from consul service in fo "collector.dynamic.config.update.frequency": "5", "event.transform.flag": "0", "collector.schema.checkflag": "1", - "collector.dmaap.streamid": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling|notification=ves-notification|pnfRegistration=ves-pnfRegistration", + "collector.dmaap.streamid": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|measurement=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling|notification=ves-notification|pnfRegistration=ves-pnfRegistration", "collector.service.port": "8080", - "collector.schema.file": "{\"v1\":\"./etc/CommonEventFormat_27.2.json\",\"v2\":\"./etc/CommonEventFormat_27.2.json\",\"v3\":\"./etc/CommonEventFormat_27.2.json\",\"v4\":\"./etc/CommonEventFormat_27.2.json\",\"v5\":\"./etc/CommonEventFormat_28.4.1.json\",\"v7\":\"./etc/CommonEventFormat_30.0.1.json\"}", - "collector.keystore.passwordfile": "/opt/app/VESCollector/etc/passwordfile", + "collector.service.secure.port": "8443", + "collector.schema.file": "{\"v1\":\"./etc/CommonEventFormat_27.2.json\",\"v2\":\"./etc/CommonEventFormat_27.2.json\",\"v3\":\"./etc/CommonEventFormat_27.2.json\",\"v4\":\"./etc/CommonEventFormat_27.2.json\",\"v5\":\"./etc/CommonEventFormat_28.4.1.json\",\"v7\":\"./etc/CommonEventFormat_30.1.1.json\"}", "streams_publishes": { "ves-measurement": { "type": "message_router", @@ -55,9 +55,12 @@ VES expects to be able to fetch configuration directly from consul service in fo } }, "collector.service.secure.port": "8443", - "auth.method": "noAuth", - "collector.keystore.file.location": "/opt/app/VESCollector/etc/keystore", - "header.authlist": "sample1,$2a$10$0buh.2WeYwN868YMwnNNEuNEAMNYVU9.FSMJGyIKV3dGET/7oGOi6" + "auth.method": "certBasicAuth", + "collector.keystore.file.location": "/opt/app/dcae-certificate/cert.jks", + "collector.keystore.passwordfile": "/opt/app/dcae-certificate/jks.pass", + "collector.truststore.file.location": "/opt/app/dcae-certificate/trust.jks", + "collector.truststore.passwordfile": "/opt/app/dcae-certificate/trust.pass", + "header.authlist": "sample1,$2a$10$0buh.2WeYwN868YMwnNNEuNEAMNYVU9.FSMJGyIKV3dGET/7oGOi6|demouser,$2a$10$1cc.COcqV/d3iT2N7BjPG.S6ZKv2jpb9a5MV.o7lMih/GpjJRX.Ce" } diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst index 0e399301..b21ca919 100644 --- a/docs/sections/services/ves-http/installation.rst +++ b/docs/sections/services/ves-http/installation.rst @@ -36,198 +36,35 @@ VES Collector support following authentication types * *auth.method=noAuth* default option - no security (http) * *auth.method=certBasicAuth* is used to enable mutual TLS authentication or/and basic HTTPs authentication -Default ONAP deployed VESCOllector is configured for "noAuth". If VESCollector instance need to be deployed with authentication enabled, follow below setup +The blueprint is same for both deployments - based on the input configuration, VESCollector can be set for required authentication type. +Default ONAP deployed VESCollector is configured for "certBasicAuth". +If VESCollector instance need to be deployed with authentication disabled, follow below setup -- Update existing VESCollector deployment to remove nodeport conflict by editing service definition - .. code-block:: bash - - kubectl edit svc -n onap xdcae-ves-collector - -and remove following entry and save the changes; K8S will update the service definition default VES instance - - .. code-block:: bash - - - name: xport-t-8443 - nodePort: 30417 - port: 8443 - protocol: TCP - targetPort: 8443 - Execute into Bootstrap POD using kubectl command -- Copy blueprint content into DCAE bootstrap POD under /blueprints directory under same file name. - -``k8s-ves-tls.yaml`` --------------------- - - -:: - - # ============LICENSE_START==================================================== - # ============================================================================= - # Copyright (c) 2019 AT&T Intellectual Property. All rights reserved. - # ============================================================================= - # Licensed under the Apache License, Version 2.0 (the "License"); - # you may not use this file except in compliance with the License. - # You may obtain a copy of the License at - # - # http://www.apache.org/licenses/LICENSE-2.0 - # - # Unless required by applicable law or agreed to in writing, software - # distributed under the License is distributed on an "AS IS" BASIS, - # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - # See the License for the specific language governing permissions and - # limitations under the License. - # ============LICENSE_END====================================================== - - tosca_definitions_version: cloudify_dsl_1_3 - - imports: - - "http://www.getcloudify.org/spec/cloudify/3.4/types.yaml" - - https://nexus.onap.org/service/local/repositories/raw/content/org.onap.dcaegen2.platform.plugins/R4/k8splugin/1.4.13/k8splugin_types.yaml - - inputs: - ves_other_publish_url: - type: string - default: "http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_OTHER_OUTPUT" - ves_heartbeat_publish_url: - type: string - default: "http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_HEARTBEAT_OUTPUT" - ves_fault_publish_url: - type: string - default: "http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_FAULT_OUTPUT" - ves_measurement_publish_url: - type: string - default: "http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT" - ves_notification_publish_url: - type: string - default: "http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT" - ves_pnfRegistration_publish_url: - type: string - default: "http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.VES_PNFREG_OUTPUT" - tag_version: - type: string - default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5" - external_port: - type: string - description: Kubernetes node port on which collector is exposed - default: "30235" - external_tls_port: - type: string - description: Kubernetes node port on which collector is exposed for https - default: "30417" - replicas: - type: integer - description: number of instances - default: 1 - node_templates: - ves: - interfaces: - cloudify.interfaces.lifecycle: - start: - inputs: - ports: - - concat: ["8443:", { get_input: external_tls_port }] - properties: - application_config: - collector.dmaap.streamid: fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|measurement=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling|notification=ves-notification|pnfRegistration=ves-pnfRegistration - collector.keystore.file.location: /opt/app/VESCollector/etc/keystore - collector.keystore.passwordfile: /opt/app/VESCollector/etc/passwordfile - collector.schema.checkflag: "1" - collector.schema.file: "{\"v1\":\"./etc/CommonEventFormat_27.2.json\",\"v2\":\"./etc/CommonEventFormat_27.2.json\",\"v3\":\"./etc/CommonEventFormat_27.2.json\",\"v4\":\"./etc/CommonEventFormat_27.2.json\",\"v5\":\"./etc/CommonEventFormat_28.4.1.json\",\"v7\":\"./etc/CommonEventFormat_30.0.1.json\"}" - collector.service.port: "8080" - collector.service.secure.port: "8443" - event.transform.flag: "0" - auth.method: certBasicAuth - header.authlist: "sample1,$2a$10$0buh.2WeYwN868YMwnNNEuNEAMNYVU9.FSMJGyIKV3dGET/7oGOi6" - streams_publishes: - ves-fault: - dmaap_info: - topic_url: - get_input: ves_fault_publish_url - type: message_router - ves-measurement: - dmaap_info: - topic_url: - get_input: ves_measurement_publish_url - type: message_router - ves-notification: - dmaap_info: - topic_url: - get_input: ves_notification_publish_url - type: message_router - ves-pnfRegistration: - dmaap_info: - topic_url: - get_input: ves_pnfRegistration_publish_url - type: message_router - ves-heartbeat: - dmaap_info: - topic_url: - get_input: ves_heartbeat_publish_url - type: message_router - ves-other: - dmaap_info: - topic_url: - get_input: ves_other_publish_url - type: message_router - collector.dynamic.config.update.frequency: "5" - #docker_config: - # healthcheck: - # endpoint: /healthcheck - # interval: 15s - # timeout: 1s - # type: https - image: - get_input: tag_version - replicas: {get_input: replicas} - name: 'dcae-ves-collector-tls' - dns_name: 'dcae-ves-collector-tls' - log_info: - log_directory: "/opt/app/VESCollector/logs/ecomp" - type: dcae.nodes.ContainerizedPlatformComponent - - - -- Validate blueprint - .. code-block:: bash - - cfy blueprints validate /blueprints/k8s-ves-tls.yaml +- VES blueprint is available under /blueprints directory ``k8s-ves-tls.yaml``. A corresponding input files is also pre-loaded into bootstrap +pod under /inputs/k8s-ves-inputs.yaml - Deploy blueprint .. code-block:: bash - cfy install -b ves-tls -d ves-tls /blueprints/k8s-ves-tls.yaml + cfy install -b ves-http -d ves-http -i /inputs/k8s-ves-inputs.yaml /blueprints/k8s-ves-tls.yaml -To undeploy ves-tls, steps are noted below +To undeploy ves-http, steps are noted below -- Uninstall running ves-tls and delete deployment +- Uninstall running ves-http and delete deployment .. code-block:: bash - cfy uninstall ves-tls + cfy uninstall ves-http The deployment uninstall will also delete the blueprint. In some case you might notice 400 error reported indicating active deployment exist such as below -** An error occurred on the server: 400: Can't delete blueprint ves-tls - There exist deployments for this blueprint; Deployments ids: ves-tls** +** An error occurred on the server: 400: Can't delete blueprint ves-http - There exist deployments for this blueprint; Deployments ids: ves-http** In this case blueprint can be deleted explicitly using this command. .. code-block:: bash - cfy blueprint delete ves-tls - -Known Issue : When VESCollector is required to be deployed with authentication enabled *auth.method: certBasicAuth* -the blueprint currently disables healthcheck parameters configuration (below). This causes no readiness probe to be deployed in K8S when VES Collector is deployed with authentication enabled. - - - .. code-block:: bash - - docker_config: - healthcheck: - endpoint: /healthcheck - interval: 15s - timeout: 1s - type: https - + cfy blueprint delete ves-http -The healthcheck support when VESauthentication is enabled needs a different solution to be worked. This will be worked as future enhancement (DCAEGEN2-1594) diff --git a/docs/sections/services/ves-hv/troubleshooting.rst b/docs/sections/services/ves-hv/troubleshooting.rst index 15ce44c3..ebb80d9c 100644 --- a/docs/sections/services/ves-hv/troubleshooting.rst +++ b/docs/sections/services/ves-hv/troubleshooting.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _troubleshooting: Troubleshooting =============== |
