diff options
| author |   Vijay VK <vv770d@att.com> | 2018-10-23 16:35:29 +0100 |
|---|---|---|
| committer | VENKATESH KUMAR <vv770d@att.com> | 2018-10-23 12:02:55 -0400 |
| commit | 86cd893e8dbbbd02a1b3209baa6da60337ae417a (patch) | |
| tree | 5d867dcc5dcfdeb46c79dbada9b30a0cb5ce9c53 /docs | |
| parent | 2133aae7fd41c0d100dbc31ebb5ac2d5456fc15a (diff) | |
dcaegen2 doc updates
Change-Id: I8f0a8a733b6e28fc9d18bed81c9ac4e82c954af8
Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Issue-ID: DCAEGEN2-573
Diffstat (limited to 'docs')
20 files changed, 853 insertions, 1922 deletions
diff --git a/docs/sections/apis/configbinding.yaml b/docs/sections/apis/configbinding.yaml index cfe09440..1d3e7884 100644 --- a/docs/sections/apis/configbinding.yaml +++ b/docs/sections/apis/configbinding.yaml @@ -13,14 +13,13 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. + --- swagger: "2.0" info: - version: "2.1.0" + version: "2.2.3" title: "Config Binding Service" paths: /service_component/{service_component_name}: diff --git a/docs/sections/apis/deployment-handler-API.yaml b/docs/sections/apis/deployment-handler-API.yaml index 887e3361..7d3cf6e3 100644 --- a/docs/sections/apis/deployment-handler-API.yaml +++ b/docs/sections/apis/deployment-handler-API.yaml @@ -13,14 +13,13 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. + --- swagger: '2.0' info: - version: "4.2.0" + version: "3.0.3" title: "deployment-handler API" license: name: "Apache 2.0" diff --git a/docs/sections/apis/deployment-handler.rst b/docs/sections/apis/deployment-handler.rst index c3e9c6c0..32373c9b 100644 --- a/docs/sections/apis/deployment-handler.rst +++ b/docs/sections/apis/deployment-handler.rst @@ -1,4 +1,4 @@ -deployment-handler API 4.2.0 +deployment-handler API 3.0.3 ============================ .. toctree:: diff --git a/docs/sections/apis/inventory.rst b/docs/sections/apis/inventory.rst index 4dd02170..a37ef14e 100644 --- a/docs/sections/apis/inventory.rst +++ b/docs/sections/apis/inventory.rst @@ -1,4 +1,4 @@ -DCAE Inventory API 2.1.0 +DCAE Inventory API 3.0.4 ======================== .. toctree:: diff --git a/docs/sections/apis/swagger_inventory.yaml b/docs/sections/apis/swagger_inventory.yaml index 068f2216..6fd57162 100644 --- a/docs/sections/apis/swagger_inventory.yaml +++ b/docs/sections/apis/swagger_inventory.yaml @@ -17,7 +17,7 @@ # ECOMP is a trademark and service mark of AT&T Intellectual Property. swagger: '2.0' info: - version: "2.1.0" + version: "3.0.4" title: DCAE Inventory API description: | DCAE Inventory is a web service that provides the following: diff --git a/docs/sections/apis/swagger_vescollector.yaml b/docs/sections/apis/swagger_vescollector.yaml index 6acae21e..52b19226 100644 --- a/docs/sections/apis/swagger_vescollector.yaml +++ b/docs/sections/apis/swagger_vescollector.yaml @@ -1,5 +1,5 @@ # ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. +# Copyright (c) 2018 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. @@ -14,1931 +14,636 @@ # limitations under the License. # ============LICENSE_END========================================================= # -# ECOMP is a trademark and service mark of AT&T Intellectual Property. swagger: '2.0' info: - version: 1.1.0 + version: 1.3.1 title: VES Collector description: > Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics - contact: - email: dcae@lists.openecomp.org -externalDocs: - description: VESCollector - url: 'https://gerrit.onap.org/r/#/admin/projects/dcaegen2/collectors/ves' -schemes: - - http - - https -securityDefinitions: - basicAuth: - type: basic - description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS` + termsOfService: 'urn:tos' + contact: {} + license: + name: Apache 2.0 + url: 'http://www.apache.org/licenses/LICENSE-2.0' +host: 'localhost:8080' +basePath: / +tags: + - name: basic-error-controller + description: Basic Error Controller + - name: ves-rest-controller + description: Ves Rest Controller paths: - /eventListener/v5: + /: + get: + tags: + - ves-rest-controller + summary: mainPage + operationId: mainPageUsingGET + produces: + - '*/*' + responses: + '200': + description: OK + schema: + type: string + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /error: + get: + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingGET + produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + head: + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingHEAD + consumes: + - application/json + produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '204': + description: No Content + '401': + description: Unauthorized + '403': + description: Forbidden post: - security: - - basicAuth: [] - summary: '' - description: uri for posting VES event objects - operationId: veseventPut + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingPOST + consumes: + - application/json + produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + put: + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingPUT consumes: - application/json produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + delete: + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingDELETE + produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '204': + description: No Content + '401': + description: Unauthorized + '403': + description: Forbidden + options: + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingOPTIONS + consumes: + - application/json + produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '204': + description: No Content + '401': + description: Unauthorized + '403': + description: Forbidden + patch: + tags: + - basic-error-controller + summary: errorHtml + operationId: errorHtmlUsingPATCH + consumes: + - application/json + produces: + - text/html + responses: + '200': + description: OK + schema: + $ref: '#/definitions/ModelAndView' + '204': + description: No Content + '401': + description: Unauthorized + '403': + description: Forbidden + /eventListener/v1: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST + consumes: - application/json + produces: + - '*/*' parameters: - in: body - name: body + name: jsonPayload + description: jsonPayload required: true schema: - $ref: '#/definitions/VES5Request' + type: string responses: '200': - description: VES Event Accepted. + description: OK schema: - $ref: '#/definitions/ApiResponseMessage' - '400': - description: Bad request provided + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v1/eventBatch: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_1 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: + type: string + responses: + '200': + description: OK schema: - $ref: '#/definitions/ApiResponseMessage' + type: string + '201': + description: Created '401': - description: Unauthorized request + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v2: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_2 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true schema: - $ref: '#/definitions/ApiResponseMessage' - '503': - description: Service Unavailable + type: string + responses: + '200': + description: OK schema: - $ref: '#/definitions/ApiResponseMessage' - /eventListener/v5/eventBatch: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v2/eventBatch: post: - security: - - basicAuth: [] - summary: '' - description: uri for posting VES batch event objects - operationId: veseventbatchPut + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_3 consumes: - application/json produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: + type: string + responses: + '200': + description: OK + schema: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v3: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_4 + consumes: - application/json + produces: + - '*/*' parameters: - in: body - name: body + name: jsonPayload + description: jsonPayload required: true schema: - $ref: '#/definitions/VES5Request' + type: string responses: '200': - description: VES Event Accepted. + description: OK schema: - $ref: '#/definitions/ApiResponseMessage' - '400': - description: Bad request provided + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v3/eventBatch: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_5 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true schema: - $ref: '#/definitions/ApiResponseMessage' + type: string + responses: + '200': + description: OK + schema: + type: string + '201': + description: Created '401': - description: Unauthorized request + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v4: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_6 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true schema: - $ref: '#/definitions/ApiResponseMessage' - '503': - description: Service Unavailable + type: string + responses: + '200': + description: OK schema: - $ref: '#/definitions/ApiResponseMessage' - /healthcheck: - get: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v4/eventBatch: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_7 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: + type: string responses: '200': - description: healthcheck successful -definitions: - ApiResponseMessage: - type: object - properties: - code: - type: integer - format: int32 - type: - type: string - message: - type: string - VES5Request: - type: object - properties: - event: - $ref: '#/definitions/event' - codecsInUse: - description: number of times an identified codec was used over the measurementInterval - type: object - properties: - codecIdentifier: - type: string - numberInUse: - type: integer - required: - - codecIdentifier - - numberInUse - command: - description: command from an event collector toward an event source - type: object - properties: - commandType: - type: string - enum: - - heartbeatIntervalChange - - measurementIntervalChange - - provideThrottlingState - - throttlingSpecification - eventDomainThrottleSpecification: - $ref: '#/definitions/eventDomainThrottleSpecification' - heartbeatInterval: - type: integer - measurementInterval: - type: integer - required: - - commandType - commonEventHeader: - description: fields common to all events - type: object - properties: - domain: - description: the eventing domain associated with the event - type: string - enum: - - fault - - heartbeat - - measurementsForVfScaling - - mobileFlow - - other - - sipSignaling - - stateChange - - syslog - - thresholdCrossingAlert - - voiceQuality - eventId: - description: event key that is unique to the event source - type: string - eventName: - description: unique event name - type: string - eventType: - description: 'for example - applicationVnf, guestOS, hostOS, platform' - type: string - internalHeaderFields: - $ref: '#/definitions/internalHeaderFields' - lastEpochMicrosec: - description: >- - 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 - type: number - nfcNamingCode: - description: >- - 3 character network function component type, aligned with vfc naming - standards - type: string - nfNamingCode: - description: '4 character network function type, aligned with vnf naming standards' - type: string - priority: - description: processing priority - type: string - enum: - - High - - Medium - - Normal - - Low - reportingEntityId: - description: >- - UUID identifying the entity reporting the event, for example an OAM - VM; must be populated by the ATT enrichment process - type: string - reportingEntityName: - description: >- - name of the entity reporting the event, for example, an EMS name; may - be the same as sourceName - type: string - sequence: - description: >- - ordering of events communicated by an event source instance or 0 if - not needed - type: integer - sourceId: - description: >- - UUID identifying the entity experiencing the event issue; must be - populated by the ATT enrichment process - type: string - sourceName: - description: name of the entity experiencing the event issue - type: string - startEpochMicrosec: - description: >- - 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 - type: number - version: - description: version of the event header - type: number - required: - - domain - - eventId - - eventName - - lastEpochMicrosec - - priority - - reportingEntityName - - sequence - - sourceName - - startEpochMicrosec - - version - counter: - description: performance counter - type: object - properties: - criticality: - type: string - enum: - - CRIT - - MAJ - name: - type: string - thresholdCrossed: - type: string - value: - type: string - required: - - criticality - - name - - thresholdCrossed - - value - cpuUsage: - description: usage of an identified CPU - type: object - properties: - cpuIdentifier: - description: cpu identifer - type: string - cpuIdle: - description: percentage of CPU time spent in the idle task - type: number - cpuUsageInterrupt: - description: percentage of time spent servicing interrupts - type: number - cpuUsageNice: - description: >- - percentage of time spent running user space processes that have been - niced - type: number - cpuUsageSoftIrq: - description: percentage of time spent handling soft irq interrupts - type: number - cpuUsageSteal: - description: >- - percentage of time spent in involuntary wait which is neither user, - system or idle time and is effectively time that went missing - type: number - cpuUsageSystem: - description: percentage of time spent on system tasks running the kernel - type: number - cpuUsageUser: - description: percentage of time spent running un-niced user space processes - type: number - cpuWait: - description: percentage of CPU time spent waiting for I/O operations to complete - type: number - percentUsage: - description: >- - aggregate cpu usage of the virtual machine on which the VNFC reporting - the event is running - type: number - required: - - cpuIdentifier - - percentUsage - diskUsage: - description: usage of an identified disk - type: object - properties: - diskIdentifier: - description: disk identifier - type: string - diskIoTimeAvg: - description: >- - 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 - type: number - diskIoTimeLast: - description: >- - 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 - type: number - diskIoTimeMax: - description: >- - 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 - type: number - diskIoTimeMin: - description: >- - 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 - type: number - diskMergedReadAvg: - description: >- - 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 - type: number - diskMergedReadLast: - description: >- - 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 - type: number - diskMergedReadMax: - description: >- - 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 - type: number - diskMergedReadMin: - description: >- - 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 - type: number - diskMergedWriteAvg: - description: >- - 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 - type: number - diskMergedWriteLast: - description: >- - 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 - type: number - diskMergedWriteMax: - description: >- - 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 - type: number - diskMergedWriteMin: - description: >- - 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 - type: number - diskOctetsReadAvg: - description: >- - number of octets per second read from a disk or partition; provide the - average measurement within the measurement interval - type: number - diskOctetsReadLast: - description: >- - number of octets per second read from a disk or partition; provide the - last measurement within the measurement interval - type: number - diskOctetsReadMax: - description: >- - number of octets per second read from a disk or partition; provide the - maximum measurement within the measurement interval - type: number - diskOctetsReadMin: - description: >- - number of octets per second read from a disk or partition; provide the - minimum measurement within the measurement interval - type: number - diskOctetsWriteAvg: - description: >- - number of octets per second written to a disk or partition; provide - the average measurement within the measurement interval - type: number - diskOctetsWriteLast: - description: >- - number of octets per second written to a disk or partition; provide - the last measurement within the measurement interval - type: number - diskOctetsWriteMax: - description: >- - number of octets per second written to a disk or partition; provide - the maximum measurement within the measurement interval - type: number - diskOctetsWriteMin: - description: >- - number of octets per second written to a disk or partition; provide - the minimum measurement within the measurement interval - type: number - diskOpsReadAvg: - description: >- - number of read operations per second issued to the disk; provide the - average measurement within the measurement interval - type: number - diskOpsReadLast: - description: >- - number of read operations per second issued to the disk; provide the - last measurement within the measurement interval - type: number - diskOpsReadMax: - description: >- - number of read operations per second issued to the disk; provide the - maximum measurement within the measurement interval - type: number - diskOpsReadMin: - description: >- - number of read operations per second issued to the disk; provide the - minimum measurement within the measurement interval - type: number - diskOpsWriteAvg: - description: >- - number of write operations per second issued to the disk; provide the - average measurement within the measurement interval - type: number - diskOpsWriteLast: - description: >- - number of write operations per second issued to the disk; provide the - last measurement within the measurement interval - type: number - diskOpsWriteMax: - description: >- - number of write operations per second issued to the disk; provide the - maximum measurement within the measurement interval - type: number - diskOpsWriteMin: - description: >- - number of write operations per second issued to the disk; provide the - minimum measurement within the measurement interval - type: number - diskPendingOperationsAvg: - description: >- - queue size of pending I/O operations per second; provide the average - measurement within the measurement interval - type: number - diskPendingOperationsLast: - description: >- - queue size of pending I/O operations per second; provide the last - measurement within the measurement interval - type: number - diskPendingOperationsMax: - description: >- - queue size of pending I/O operations per second; provide the maximum - measurement within the measurement interval - type: number - diskPendingOperationsMin: - description: >- - queue size of pending I/O operations per second; provide the minimum - measurement within the measurement interval - type: number - diskTimeReadAvg: - description: >- - milliseconds a read operation took to complete; provide the average - measurement within the measurement interval - type: number - diskTimeReadLast: - description: >- - milliseconds a read operation took to complete; provide the last - measurement within the measurement interval - type: number - diskTimeReadMax: - description: >- - milliseconds a read operation took to complete; provide the maximum - measurement within the measurement interval - type: number - diskTimeReadMin: - description: >- - milliseconds a read operation took to complete; provide the minimum - measurement within the measurement interval - type: number - diskTimeWriteAvg: - description: >- - milliseconds a write operation took to complete; provide the average - measurement within the measurement interval - type: number - diskTimeWriteLast: - description: >- - milliseconds a write operation took to complete; provide the last - measurement within the measurement interval - type: number - diskTimeWriteMax: - description: >- - milliseconds a write operation took to complete; provide the maximum - measurement within the measurement interval - type: number - diskTimeWriteMin: - description: >- - milliseconds a write operation took to complete; provide the minimum - measurement within the measurement interval - type: number - required: - - diskIdentifier - endOfCallVqmSummaries: - description: provides end of call voice quality metrics - type: object - properties: - adjacencyName: - description: ' adjacency name' - type: string - endpointDescription: - description: Either Caller or Callee - type: string - enum: - - Caller - - Callee - endpointJitter: - description: '' - type: number - endpointRtpOctetsDiscarded: - description: '' - type: number - endpointRtpOctetsReceived: - description: '' - type: number - endpointRtpOctetsSent: - description: '' - type: number - endpointRtpPacketsDiscarded: - description: '' - type: number - endpointRtpPacketsReceived: - description: '' - type: number - endpointRtpPacketsSent: - description: '' - type: number - localJitter: - description: '' - type: number - localRtpOctetsDiscarded: - description: '' - type: number - localRtpOctetsReceived: - description: '' - type: number - localRtpOctetsSent: - description: '' - type: number - localRtpPacketsDiscarded: - description: '' - type: number - localRtpPacketsReceived: - description: '' - type: number - localRtpPacketsSent: - description: '' - type: number - mosCqe: - description: 1-5 1dp - type: number - packetsLost: - description: '' - type: number - packetLossPercent: - description: >- - 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) - type: number - rFactor: - description: 0-100 - type: number - roundTripDelay: - description: millisecs - type: number - required: - - adjacencyName - - endpointDescription - event: - description: the root level of the common event format - type: object - properties: - commonEventHeader: - $ref: '#/definitions/commonEventHeader' - faultFields: - $ref: '#/definitions/faultFields' - heartbeatFields: - $ref: '#/definitions/heartbeatFields' - measurementsForVfScalingFields: - $ref: '#/definitions/measurementsForVfScalingFields' - mobileFlowFields: - $ref: '#/definitions/mobileFlowFields' - otherFields: - $ref: '#/definitions/otherFields' - sipSignalingFields: - $ref: '#/definitions/sipSignalingFields' - stateChangeFields: - $ref: '#/definitions/stateChangeFields' - syslogFields: - $ref: '#/definitions/syslogFields' - thresholdCrossingAlertFields: - $ref: '#/definitions/thresholdCrossingAlertFields' - voiceQualityFields: - $ref: '#/definitions/voiceQualityFields' - required: - - commonEventHeader - eventDomainThrottleSpecification: - description: specification of what information to suppress within an event domain - type: object - properties: - eventDomain: - description: Event domain enum from the commonEventHeader domain field - type: string - suppressedFieldNames: - description: >- - List of optional field names in the event block that should not be - sent to the Event Listener - type: array - items: - type: string - suppressedNvPairsList: - description: >- - Optional list of specific NvPairsNames to suppress within a given - Name-Value Field - type: array - items: - $ref: '#/definitions/suppressedNvPairs' - required: - - eventDomain - eventDomainThrottleSpecificationList: - description: array of eventDomainThrottleSpecifications - type: array - items: - $ref: '#/definitions/eventDomainThrottleSpecification' - minItems: 0 - eventList: - description: array of events - type: array - items: - $ref: '#/definitions/event' - faultFields: - description: fields specific to fault events - type: object - properties: - alarmAdditionalInformation: - description: additional alarm information - type: array - items: - $ref: '#/definitions/field' - alarmCondition: - description: alarm condition reported by the device - type: string - alarmInterfaceA: - description: >- - card, port, channel or interface name of the device generating the - alarm - type: string - eventCategory: - description: >- - Event category, for example: license, link, routing, security, - signaling - type: string - eventSeverity: - description: event severity - type: string - enum: - - CRITICAL - - MAJOR - - MINOR - - WARNING - - NORMAL - eventSourceType: - description: >- - type of event source; examples: card, host, other, port, - portThreshold, router, slotThreshold, switch, virtualMachine, - virtualNetworkFunction - type: string - faultFieldsVersion: - description: version of the faultFields block - type: number - specificProblem: - description: short description of the alarm or problem - type: string - vfStatus: - description: virtual function status enumeration - type: string - enum: - - Active - - Idle - - Preparing to terminate - - Ready to terminate - - Requesting termination - required: - - alarmCondition - - eventSeverity - - eventSourceType - - faultFieldsVersion - - specificProblem - - vfStatus - featuresInUse: - description: >- - number of times an identified feature was used over the - measurementInterval - type: object - properties: - featureIdentifier: - type: string - featureUtilization: - type: integer - required: - - featureIdentifier - - featureUtilization - field: - description: name value pair - type: object - properties: - name: - type: string - value: - type: string - required: - - name - - value - filesystemUsage: - description: >- - disk usage of an identified virtual machine in gigabytes and/or gigabytes - per second - type: object - properties: - blockConfigured: - type: number - blockIops: - type: number - blockUsed: - type: number - ephemeralConfigured: - type: number - ephemeralIops: - type: number - ephemeralUsed: - type: number - filesystemName: - type: string - required: - - blockConfigured - - blockIops - - blockUsed - - ephemeralConfigured - - ephemeralIops - - ephemeralUsed - - filesystemName - gtpPerFlowMetrics: - description: Mobility GTP Protocol per flow metrics - type: object - properties: - avgBitErrorRate: - description: average bit error rate - type: number - avgPacketDelayVariation: - description: >- - 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 - type: number - avgPacketLatency: - description: average delivery latency - type: number - avgReceiveThroughput: - description: average receive throughput - type: number - avgTransmitThroughput: - description: average transmit throughput - type: number - durConnectionFailedStatus: - description: >- - 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 - type: number - durTunnelFailedStatus: - description: >- - 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 - type: number - flowActivatedBy: - description: Endpoint activating the flow - type: string - flowActivationEpoch: - description: >- - 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 - type: number - flowActivationMicrosec: - description: Integer microseconds for the start of the flow connection - type: number - flowActivationTime: - description: >- - 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 - type: string - flowDeactivatedBy: - description: Endpoint deactivating the flow - type: string - flowDeactivationEpoch: - description: >- - Time for the start of the flow connection, in integer UTC epoch time - aka UNIX time - type: number - flowDeactivationMicrosec: - description: Integer microseconds for the start of the flow connection - type: number - flowDeactivationTime: - description: >- - 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 - type: string - flowStatus: - description: >- - connection status at reporting time as a working / inactive / failed - indicator value - type: string - gtpConnectionStatus: - description: Current connection state at reporting time - type: string - gtpTunnelStatus: - description: Current tunnel state at reporting time - type: string - ipTosCountList: - description: >- - 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 - type: array - items: - type: array - items: + description: OK + schema: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v5: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_8 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: type: string - type: number - ipTosList: - description: >- - Array of unique IP Type-of-Service values observed in the flow where - values range from '0' to '255' - type: array - items: - type: string - largePacketRtt: - description: large packet round trip time - type: number - largePacketThreshold: - description: large packet threshold being applied - type: number - maxPacketDelayVariation: - description: >- - 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 - type: number - maxReceiveBitRate: - description: maximum receive bit rate - type: number - maxTransmitBitRate: - description: maximum transmit bit rate - type: number - mobileQciCosCountList: - description: >- - 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 - type: array - items: - type: array - items: + responses: + '200': + description: OK + schema: type: string - type: number - mobileQciCosList: - description: >- - Array of unique LTE QCI or UMTS class-of-service values observed in - the flow - type: array - items: - type: string - numActivationFailures: - description: >- - Number of failed activation requests, as observed by the reporting - node - type: number - numBitErrors: - description: number of errored bits - type: number - numBytesReceived: - description: 'number of bytes received, including retransmissions' - type: number - numBytesTransmitted: - description: 'number of bytes transmitted, including retransmissions' - type: number - numDroppedPackets: - description: number of received packets dropped due to errors per virtual interface - type: number - numGtpEchoFailures: - description: >- - 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 - type: number - numGtpTunnelErrors: - description: >- - 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 - type: number - numHttpErrors: - description: Http error count - type: number - numL7BytesReceived: - description: 'number of tunneled layer 7 bytes received, including retransmissions' - type: number - numL7BytesTransmitted: - description: >- - number of tunneled layer 7 bytes transmitted, excluding - retransmissions - type: number - numLostPackets: - description: number of lost packets - type: number - numOutOfOrderPackets: - description: number of out-of-order packets - type: number - numPacketErrors: - description: number of errored packets - type: number - numPacketsReceivedExclRetrans: - description: 'number of packets received, excluding retransmission' - type: number - numPacketsReceivedInclRetrans: - description: 'number of packets received, including retransmission' - type: number - numPacketsTransmittedInclRetrans: - description: 'number of packets transmitted, including retransmissions' - type: number - numRetries: - description: number of packet retries - type: number - numTimeouts: - description: number of packet timeouts - type: number - numTunneledL7BytesReceived: - description: 'number of tunneled layer 7 bytes received, excluding retransmissions' - type: number - roundTripTime: - description: round trip time - type: number - tcpFlagCountList: - description: >- - 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 - type: array - items: - type: array - items: + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v5/eventBatch: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_9 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: type: string - type: number - tcpFlagList: - description: Array of unique TCP Flags observed in the flow - type: array - items: - type: string - timeToFirstByte: - description: >- - Time in milliseconds between the connection activation and first byte - received - type: number - required: - - avgBitErrorRate - - avgPacketDelayVariation - - avgPacketLatency - - avgReceiveThroughput - - avgTransmitThroughput - - flowActivationEpoch - - flowActivationMicrosec - - flowDeactivationEpoch - - flowDeactivationMicrosec - - flowDeactivationTime - - flowStatus - - maxPacketDelayVariation - - numActivationFailures - - numBitErrors - - numBytesReceived - - numBytesTransmitted - - numDroppedPackets - - numL7BytesReceived - - numL7BytesTransmitted - - numLostPackets - - numOutOfOrderPackets - - numPacketErrors - - numPacketsReceivedExclRetrans - - numPacketsReceivedInclRetrans - - numPacketsTransmittedInclRetrans - - numRetries - - numTimeouts - - numTunneledL7BytesReceived - - roundTripTime - - timeToFirstByte - heartbeatFields: - description: optional field block for fields specific to heartbeat events - type: object - properties: - additionalFields: - description: additional heartbeat fields if needed - type: array - items: - $ref: '#/definitions/field' - heartbeatFieldsVersion: - description: version of the heartbeatFields block - type: number - heartbeatInterval: - description: current heartbeat interval in seconds - type: integer - required: - - heartbeatFieldsVersion - - heartbeatInterval - internalHeaderFields: - description: >- - enrichment fields for internal VES Event Listener service use only, not - supplied by event sources - type: object - jsonObject: - description: >- - json object schema, name and other meta-information along with one or more - object instances - type: object - properties: - objectInstances: - description: one or more instances of the jsonObject - type: array - items: - $ref: '#/definitions/jsonObjectInstance' - objectName: - description: name of the JSON Object - type: string - objectSchema: - description: json schema for the object - type: string - objectSchemaUrl: - description: Url to the json schema for the object - type: string - nfSubscribedObjectName: - description: name of the object associated with the nfSubscriptonId - type: string - nfSubscriptionId: - description: >- - identifies an openConfig telemetry subscription on a network function, - which configures the network function to send complex object data - associated with the jsonObject - type: string - required: - - objectInstances - - objectName - jsonObjectInstance: - description: >- - meta-information about an instance of a jsonObject along with the actual - object instance + responses: + '200': + description: OK + schema: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v7: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_10 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: + type: string + responses: + '200': + description: OK + schema: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found + /eventListener/v7/eventBatch: + post: + tags: + - ves-rest-controller + summary: receiveEvent + operationId: receiveEventUsingPOST_11 + consumes: + - application/json + produces: + - '*/*' + parameters: + - in: body + name: jsonPayload + description: jsonPayload + required: true + schema: + type: string + responses: + '200': + description: OK + schema: + type: string + '201': + description: Created + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: Not Found +definitions: + ModelAndView: type: object properties: - objectInstance: - description: an instance conforming to the jsonObject schema + empty: + type: boolean + model: type: object - objectInstanceEpochMicrosec: - description: >- - the unix time aka epoch time associated with this objectInstance--as - microseconds elapsed since 1 Jan 1970 not including leap seconds - type: number - objectKeys: - description: >- - an ordered set of keys that identifies this particular instance of - jsonObject - type: array - items: - $ref: '#/definitions/key' - required: - - objectInstance - key: - description: >- - tuple which provides the name of a key along with its value and relative - order - type: object - properties: - keyName: - description: name of the key - type: string - keyOrder: - description: relative sequence or order of the key with respect to other keys - type: integer - keyValue: - description: value of the key - type: string - required: - - keyName - latencyBucketMeasure: - description: number of counts falling within a defined latency bucket - type: object - properties: - countsInTheBucket: - type: number - highEndOfLatencyBucket: - type: number - lowEndOfLatencyBucket: - type: number - required: - - countsInTheBucket - measurementsForVfScalingFields: - description: measurementsForVfScaling fields - type: object - properties: - additionalFields: - description: additional name-value-pair fields - type: array - items: - $ref: '#/definitions/field' - additionalMeasurements: - description: array of named name-value-pair arrays - type: array - items: - $ref: '#/definitions/namedArrayOfFields' - additionalObjects: - description: >- - array of JSON objects described by name, schema and other - meta-information - type: array - items: - $ref: '#/definitions/jsonObject' - codecUsageArray: - description: array of codecs in use - type: array - items: - $ref: '#/definitions/codecsInUse' - concurrentSessions: - description: >- - peak concurrent sessions for the VM or VNF over the - measurementInterval - type: integer - configuredEntities: - description: >- - over the measurementInterval, peak total number of: users, - subscribers, devices, adjacencies, etc., for the VM, or subscribers, - devices, etc., for the VNF - type: integer - cpuUsageArray: - description: usage of an array of CPUs - type: array - items: - $ref: '#/definitions/cpuUsage' - diskUsageArray: - description: usage of an array of disks - type: array - items: - $ref: '#/definitions/diskUsage' - featureUsageArray: - description: array of features in use - type: array - items: - $ref: '#/definitions/featuresInUse' - filesystemUsageArray: - description: >- - filesystem usage of the VM on which the VNFC reporting the event is - running - type: array - items: - $ref: '#/definitions/filesystemUsage' - latencyDistribution: - description: >- - array of integers representing counts of requests whose latency in - milliseconds falls within per-VNF configured ranges - type: array - items: - $ref: '#/definitions/latencyBucketMeasure' - meanRequestLatency: - description: >- - mean seconds required to respond to each request for the VM on which - the VNFC reporting the event is running - type: number - measurementInterval: - description: interval over which measurements are being reported in seconds - type: number - measurementsForVfScalingVersion: - description: version of the measurementsForVfScaling block - type: number - memoryUsageArray: - description: memory usage of an array of VMs - type: array - items: - $ref: '#/definitions/memoryUsage' - numberOfMediaPortsInUse: - description: number of media ports in use - type: integer - requestRate: - description: >- - peak rate of service requests per second to the VNF over the - measurementInterval - type: number - vnfcScalingMetric: - description: represents busy-ness of the VNF from 0 to 100 as reported by the VNFC - type: integer - vNicPerformanceArray: - description: usage of an array of virtual network interface cards - type: array - items: - $ref: '#/definitions/vNicPerformance' - required: - - measurementInterval - - measurementsForVfScalingVersion - memoryUsage: - description: memory usage of an identified virtual machine - type: object - properties: - memoryBuffered: - description: kibibytes of temporary storage for raw disk blocks - type: number - memoryCached: - description: kibibytes of memory used for cache - type: number - memoryConfigured: - description: >- - kibibytes of memory configured in the virtual machine on which the - VNFC reporting the event is running - type: number - memoryFree: - description: kibibytes of physical RAM left unused by the system - type: number - memorySlabRecl: - description: >- - the part of the slab that can be reclaimed such as caches measured in - kibibytes - type: number - memorySlabUnrecl: - description: >- - the part of the slab that cannot be reclaimed even when lacking memory - measured in kibibytes - type: number - memoryUsed: - description: >- - total memory minus the sum of free, buffered, cached and slab memory - measured in kibibytes - type: number - vmIdentifier: - description: virtual machine identifier associated with the memory metrics - type: string - required: - - memoryFree - - memoryUsed - - vmIdentifier - mobileFlowFields: - description: mobileFlow fields - type: object - properties: - additionalFields: - description: additional mobileFlow fields if needed - type: array - items: - $ref: '#/definitions/field' - applicationType: - description: Application type inferred - type: string - appProtocolType: - description: application protocol - type: string - appProtocolVersion: - description: application protocol version - type: string - cid: - description: cell id - type: string - connectionType: - description: 'Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc' - type: string - ecgi: - description: Evolved Cell Global Id - type: string - flowDirection: - description: >- - Flow direction, indicating if the reporting node is the source of the - flow or destination for the flow - type: string - gtpPerFlowMetrics: - $ref: '#/definitions/gtpPerFlowMetrics' - gtpProtocolType: - description: GTP protocol - type: string - gtpVersion: - description: GTP protocol version - type: string - httpHeader: - description: 'HTTP request header, if the flow connects to a node referenced by HTTP' - type: string - imei: - description: >- - IMEI for the subscriber UE used in this flow, if the flow connects to - a mobile device - type: string - imsi: - description: >- - IMSI for the subscriber UE used in this flow, if the flow connects to - a mobile device - type: string - ipProtocolType: - description: 'IP protocol type e.g., TCP, UDP, RTP...' - type: string - ipVersion: - description: 'IP protocol version e.g., IPv4, IPv6' - type: string - lac: - description: location area code - type: string - mcc: - description: mobile country code - type: string - mnc: - description: mobile network code - type: string - mobileFlowFieldsVersion: - description: version of the mobileFlowFields block - type: number - msisdn: - description: >- - MSISDN for the subscriber UE used in this flow, as an integer, if the - flow connects to a mobile device - type: string - otherEndpointIpAddress: - description: >- - IP address for the other endpoint, as used for the flow being reported - on - type: string - otherEndpointPort: - description: >- - IP Port for the reporting entity, as used for the flow being reported - on - type: integer - otherFunctionalRole: - description: >- - Functional role of the other endpoint for the flow being reported on - e.g., MME, S-GW, P-GW, PCRF... - type: string - rac: - description: routing area code - type: string - radioAccessTechnology: - description: 'Radio Access Technology e.g., 2G, 3G, LTE' - type: string - reportingEndpointIpAddr: - description: >- - IP address for the reporting entity, as used for the flow being - reported on - type: string - reportingEndpointPort: - description: >- - IP port for the reporting entity, as used for the flow being reported - on - type: integer - sac: - description: service area code - type: string - samplingAlgorithm: - description: >- - 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 - type: integer - tac: - description: transport area code - type: string - tunnelId: - description: tunnel identifier - type: string - vlanId: - description: VLAN identifier used by this flow - type: string - required: - - flowDirection - - gtpPerFlowMetrics - - ipProtocolType - - ipVersion - - mobileFlowFieldsVersion - - otherEndpointIpAddress - - otherEndpointPort - - reportingEndpointIpAddr - - reportingEndpointPort - namedArrayOfFields: - description: an array of name value pairs along with a name for the array - type: object - properties: - name: - type: string - arrayOfFields: - description: array of name value pairs - type: array - items: - $ref: '#/definitions/field' - required: - - name - - arrayOfFields - otherFields: - description: >- - fields for events belonging to the 'other' domain of the commonEventHeader - domain enumeration - type: object - properties: - hashOfNameValuePairArrays: - description: array of named name-value-pair arrays - type: array - items: - $ref: '#/definitions/namedArrayOfFields' - jsonObjects: - description: >- - array of JSON objects described by name, schema and other - meta-information - type: array - items: - $ref: '#/definitions/jsonObject' - nameValuePairs: - description: array of name-value pairs - type: array - items: - $ref: '#/definitions/field' - otherFieldsVersion: - description: version of the otherFields block - type: number - required: - - otherFieldsVersion - requestError: - description: standard request error data structure - type: object - properties: - messageId: - description: >- - Unique message identifier of the format ABCnnnn where ABC is either - SVC for Service Exceptions or POL for Policy Exception - type: string - text: - description: >- - Message text, with replacement variables marked with %n, where n is an - index into the list of <variables> elements, starting at 1 - type: string - url: - description: >- - Hyperlink to a detailed error resource e.g., an HTML page for browser - user agents - type: string - variables: - description: >- - List of zero or more strings that represent the contents of the - variables used by the message text - type: string - required: - - messageId - - text - sipSignalingFields: - description: sip signaling fields - type: object - properties: - additionalInformation: - description: additional sip signaling fields if needed - type: array - items: - $ref: '#/definitions/field' - compressedSip: - description: the full SIP request/response including headers and bodies - type: string - correlator: - description: this is the same for all events on this call - type: string - localIpAddress: - description: IP address on VNF - type: string - localPort: - description: port on VNF - type: string - remoteIpAddress: - description: IP address of peer endpoint - type: string - remotePort: - description: port of peer endpoint - type: string - sipSignalingFieldsVersion: - description: version of the sipSignalingFields block - type: number - summarySip: - description: >- - the SIP Method or Response (INVITE, 200 OK, BYE, - etc) - type: string - vendorVnfNameFields: - $ref: '#/definitions/vendorVnfNameFields' - required: - - correlator - - localIpAddress - - localPort - - remoteIpAddress - - remotePort - - sipSignalingFieldsVersion - - vendorVnfNameFields - stateChangeFields: - description: stateChange fields - type: object - properties: - additionalFields: - description: additional stateChange fields if needed - type: array - items: - $ref: '#/definitions/field' - newState: - description: new state of the entity - type: string - enum: - - inService - - maintenance - - outOfService - oldState: - description: previous state of the entity - type: string - enum: - - inService - - maintenance - - outOfService - stateChangeFieldsVersion: - description: version of the stateChangeFields block - type: number - stateInterface: - description: card or port name of the entity that changed state - type: string - required: - - newState - - oldState - - stateChangeFieldsVersion - - stateInterface - suppressedNvPairs: - description: >- - List of specific NvPairsNames to suppress within a given Name-Value Field - for event Throttling - type: object - properties: - nvPairFieldName: - description: Name of the field within which are the nvpair names to suppress - type: string - suppressedNvPairNames: - description: Array of nvpair names to suppress within the nvpairFieldName - type: array - items: - type: string - required: - - nvPairFieldName - - suppressedNvPairNames - syslogFields: - description: sysLog fields - type: object - properties: - additionalFields: - description: >- - additional syslog fields if needed provided as name=value delimited by - a pipe | symbol, for example: 'name1=value1|name2=value2|' - type: string - eventSourceHost: - description: hostname of the device - type: string - eventSourceType: - description: >- - type of event source; examples: other, router, switch, host, card, - port, slotThreshold, portThreshold, virtualMachine, - virtualNetworkFunction - type: string - syslogFacility: - description: numeric code from 0 to 23 for facility--see table in documentation - type: integer - syslogFieldsVersion: - description: version of the syslogFields block - type: number - syslogMsg: - description: syslog message - type: string - syslogPri: - description: 0-192 combined severity and facility - type: integer - syslogProc: - description: identifies the application that originated the message - type: string - syslogProcId: - description: >- - a change in the value of this field indicates a discontinuity in - syslog reporting - type: number - syslogSData: - description: >- - syslog structured data consisting of a structured data Id followed by - a set of key value pairs - type: string - syslogSdId: - description: 0-32 char in format name@number for example ourSDID@32473 - type: string - syslogSev: - description: >- - numerical Code for severity derived from syslogPri as remaider of - syslogPri / 8 - type: string - enum: - - Alert - - Critical - - Debug - - Emergency - - Error - - Info - - Notice - - Warning - syslogTag: - description: >- - msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE - should be used when no other value can be provided - type: string - syslogVer: - description: >- - IANA assigned version of the syslog protocol specification - typically - 1 - type: number - required: - - eventSourceType - - syslogFieldsVersion - - syslogMsg - - syslogTag - thresholdCrossingAlertFields: - description: fields specific to threshold crossing alert events - type: object - properties: - additionalFields: - description: additional threshold crossing alert fields if needed - type: array - items: - $ref: '#/definitions/field' - additionalParameters: - description: performance counters - type: array - items: - $ref: '#/definitions/counter' - alertAction: - description: Event action - type: string - enum: - - CLEAR - - CONT - - SET - alertDescription: - description: Unique short alert description such as IF-SHUB-ERRDROP - type: string - alertType: - description: Event type - type: string - enum: - - CARD-ANOMALY - - ELEMENT-ANOMALY - - INTERFACE-ANOMALY - - SERVICE-ANOMALY - alertValue: - description: Calculated API value (if applicable) - type: string - associatedAlertIdList: - description: List of eventIds associated with the event being reported - type: array - items: - type: string - collectionTimestamp: - description: >- - Time when the performance collector picked up the data; with RFC 2822 - compliant format: Sat, 13 Mar 2010 11:29:05 -0800 - type: string - dataCollector: - description: Specific performance collector instance used - type: string - elementType: - description: type of network element - internal ATT field - type: string - eventSeverity: - description: event severity or priority - type: string - enum: - - CRITICAL - - MAJOR - - MINOR - - WARNING - - NORMAL - eventStartTimestamp: - description: >- - Time closest to when the measurement was made; with RFC 2822 compliant - format: Sat, 13 Mar 2010 11:29:05 -0800 - type: string - interfaceName: - description: Physical or logical port or card (if applicable) - type: string - networkService: - description: network name - internal ATT field - type: string - possibleRootCause: - description: Reserved for future use - type: string - thresholdCrossingFieldsVersion: - description: version of the thresholdCrossingAlertFields block - type: number - required: - - additionalParameters - - alertAction - - alertDescription - - alertType - - collectionTimestamp - - eventSeverity - - eventStartTimestamp - - thresholdCrossingFieldsVersion - vendorVnfNameFields: - description: 'provides vendor, vnf and vfModule identifying information' - type: object - properties: - vendorName: - description: VNF vendor name - type: string - vfModuleName: - description: ASDC vfModuleName for the vfModule generating the event - type: string - vnfName: - description: ASDC modelName for the VNF generating the event - type: string - required: - - vendorName - vNicPerformance: - description: >- - describes the performance and errors of an identified virtual network - interface card - type: object - properties: - receivedBroadcastPacketsAccumulated: - description: >- - Cumulative count of broadcast packets received as read at the end of - the measurement interval - type: number - receivedBroadcastPacketsDelta: - description: Count of broadcast packets received within the measurement interval - type: number - receivedDiscardedPacketsAccumulated: - description: >- - Cumulative count of discarded packets received as read at the end of - the measurement interval - type: number - receivedDiscardedPacketsDelta: - description: Count of discarded packets received within the measurement interval - type: number - receivedErrorPacketsAccumulated: - description: >- - Cumulative count of error packets received as read at the end of the - measurement interval - type: number - receivedErrorPacketsDelta: - description: Count of error packets received within the measurement interval - type: number - receivedMulticastPacketsAccumulated: - description: >- - Cumulative count of multicast packets received as read at the end of - the measurement interval - type: number - receivedMulticastPacketsDelta: - description: Count of multicast packets received within the measurement interval - type: number - receivedOctetsAccumulated: - description: >- - Cumulative count of octets received as read at the end of the - measurement interval - type: number - receivedOctetsDelta: - description: Count of octets received within the measurement interval - type: number - receivedTotalPacketsAccumulated: - description: >- - Cumulative count of all packets received as read at the end of the - measurement interval - type: number - receivedTotalPacketsDelta: - description: Count of all packets received within the measurement interval - type: number - receivedUnicastPacketsAccumulated: - description: >- - Cumulative count of unicast packets received as read at the end of the - measurement interval - type: number - receivedUnicastPacketsDelta: - description: Count of unicast packets received within the measurement interval - type: number - transmittedBroadcastPacketsAccumulated: - description: >- - Cumulative count of broadcast packets transmitted as read at the end - of the measurement interval - type: number - transmittedBroadcastPacketsDelta: - description: Count of broadcast packets transmitted within the measurement interval - type: number - transmittedDiscardedPacketsAccumulated: - description: >- - Cumulative count of discarded packets transmitted as read at the end - of the measurement interval - type: number - transmittedDiscardedPacketsDelta: - description: Count of discarded packets transmitted within the measurement interval - type: number - transmittedErrorPacketsAccumulated: - description: >- - Cumulative count of error packets transmitted as read at the end of - the measurement interval - type: number - transmittedErrorPacketsDelta: - description: Count of error packets transmitted within the measurement interval - type: number - transmittedMulticastPacketsAccumulated: - description: >- - Cumulative count of multicast packets transmitted as read at the end - of the measurement interval - type: number - transmittedMulticastPacketsDelta: - description: Count of multicast packets transmitted within the measurement interval - type: number - transmittedOctetsAccumulated: - description: >- - Cumulative count of octets transmitted as read at the end of the - measurement interval - type: number - transmittedOctetsDelta: - description: Count of octets transmitted within the measurement interval - type: number - transmittedTotalPacketsAccumulated: - description: >- - Cumulative count of all packets transmitted as read at the end of the - measurement interval - type: number - transmittedTotalPacketsDelta: - description: Count of all packets transmitted within the measurement interval - type: number - transmittedUnicastPacketsAccumulated: - description: >- - Cumulative count of unicast packets transmitted as read at the end of - the measurement interval - type: number - transmittedUnicastPacketsDelta: - description: Count of unicast packets transmitted within the measurement interval - type: number - valuesAreSuspect: - description: >- - Indicates whether vNicPerformance values are likely inaccurate due to - counter overflow or other condtions + modelMap: + type: object + additionalProperties: + type: object + reference: + type: boolean + status: type: string enum: - - 'true' - - 'false' - vNicIdentifier: - description: vNic identification - type: string - required: - - valuesAreSuspect - - vNicIdentifier - voiceQualityFields: - description: provides statistics related to customer facing voice products - type: object - properties: - additionalInformation: - description: additional voice quality fields if needed - type: array - items: - $ref: '#/definitions/field' - calleeSideCodec: - description: callee codec for the call - type: string - callerSideCodec: - description: caller codec for the call - type: string - correlator: - description: this is the same for all events on this call - type: string - endOfCallVqmSummaries: - $ref: '#/definitions/endOfCallVqmSummaries' - phoneNumber: - description: phone number associated with the correlator - type: string - midCallRtcp: - description: Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers - type: string - vendorVnfNameFields: - $ref: '#/definitions/vendorVnfNameFields' - voiceQualityFieldsVersion: - description: version of the voiceQualityFields block - type: number - required: - - calleeSideCodec - - callerSideCodec - - correlator - - midCallRtcp - - vendorVnfNameFields - - voiceQualityFieldsVersion + - '100' + - '101' + - '102' + - '103' + - '200' + - '201' + - '202' + - '203' + - '204' + - '205' + - '206' + - '207' + - '208' + - '226' + - '300' + - '301' + - '302' + - '303' + - '304' + - '305' + - '307' + - '308' + - '400' + - '401' + - '402' + - '403' + - '404' + - '405' + - '406' + - '407' + - '408' + - '409' + - '410' + - '411' + - '412' + - '413' + - '414' + - '415' + - '416' + - '417' + - '418' + - '419' + - '420' + - '421' + - '422' + - '423' + - '424' + - '426' + - '428' + - '429' + - '431' + - '451' + - '500' + - '501' + - '502' + - '503' + - '504' + - '505' + - '506' + - '507' + - '508' + - '509' + - '510' + - '511' + view: + $ref: '#/definitions/View' + viewName: + type: string + title: ModelAndView + View: + type: object + properties: + contentType: + type: string + title: View diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst index b1c00889..a53480b0 100644 --- a/docs/sections/architecture.rst +++ b/docs/sections/architecture.rst @@ -59,14 +59,14 @@ The figure below shows the DCAE R3 architecture and how the components work with .. image:: images/R3_architecture_diagram.gif -Note: PM-Mapper was descoped from R3 +Note: Missing Heartbeat, Universal Data-mapper, PM-Mapper descoped from R3 Deployment Scenarios -------------------- Because DCAE service components are deployed on-demand following the control loop needs for managing ONAP deployed services, DCAE must support dynamic and on-demand deployment of service components based on ONAP control loop demands. This is why all other ONAP components are launched from the ONAP level method, DCAE only deploys a subset of its components during this ONAP deployment process and rest of DCAE components will be deployed either as TOSCA executor launches a series of Blueprints, or deployed by control loop request originated from CLAMP, or even by operator manually invoking DCAE's deployment API call. -For R2, ONAP supports two deployment methodologies: Heat Orchestration Template method, or Helm Chart method. No matter which method, DCAE is deployed following the same flow. At its minimum, only the TOSCA model executor, the DCAE Cloudify Manager, needs to be deployed through the ONAP deployment process. Once the Cloudify Manager is up and running, all the rest of DCAE platform can be deployed by a bootstrap script, which makes a number of calls into the Cloudify Manager API with Blueprints for various DCAE components, first the DCAE Platform components, then the service components that are needed for the built-in control loops, such as vFW/vDNS traffic throttling. It is also possible that additional DCAE components are also launched as part of the ONAP deployment process using the ONAP level method instead of TOSCA model based method. +For R3, ONAP supports two deployment methodologies: Heat Orchestration Template method, or Helm Chart method. No matter which method, DCAE is deployed following the same flow. At its minimum, only the TOSCA model executor, the DCAE Cloudify Manager, needs to be deployed through the ONAP deployment process. Once the Cloudify Manager is up and running, all the rest of DCAE platform can be deployed by a bootstrap script, which makes a number of calls into the Cloudify Manager API with Blueprints for various DCAE components, first the DCAE Platform components, then the service components that are needed for the built-in control loops, such as vFW/vDNS traffic throttling. It is also possible that additional DCAE components are also launched as part of the ONAP deployment process using the ONAP level method instead of TOSCA model based method. More details of the DCAE R3 deployment will be covered by the Installation section. diff --git a/docs/sections/build.rst b/docs/sections/build.rst index 641773c6..6b3a1140 100644 --- a/docs/sections/build.rst +++ b/docs/sections/build.rst @@ -51,7 +51,6 @@ Below is a list of the repos and their sub-modules, and the language they are wr - dcaegen2.services.heartbeat (Python) - dcaegen2.services.prh (Java) - - dcaegen2.services.mapper (Java) * dcaegen2.deployments diff --git a/docs/sections/healthcheck.rst b/docs/sections/healthcheck.rst index 10572fc8..57266bbf 100644 --- a/docs/sections/healthcheck.rst +++ b/docs/sections/healthcheck.rst @@ -11,8 +11,62 @@ OOM Deployment In OOM deployments DCAE healthcheck are reported by separate service - dcae-healthcheck; this is deployment of org.onap.dcaegen2.deployments.healthcheck-container which is built from dcaegen2/deployment repo - healthcheck-container module. The container includes list of deployments done in DCAE (both via helm charts and Cloudify) for which periodic health check is performed. For helm deployed component - servicename defined is charts are used and for cloudify, the deployments identified in bootstrap are prefixed with release name. The container itself is deployed via helm charts (oom/kubernetes/dcaegen2/charts/dcae-healthcheck). This polls the deployments specified periodically and reports the status. The service can be queried for status as below. - curl dcae-healthcheck - {"type":"summary","count":8,"ready":8,"items":[{"name":"dev-dcae-cloudify-manager","ready":1,"unavailable":0},{"name":"dep-config-binding-service","ready":1,"unavailable":0},{"name":"dep-deployment-handler","ready":1,"unavailable":0},{"name":"dep-inventory","ready":1,"unavailable":0},{"name":"dep-service-change-handler","ready":1,"unavailable":0},{"name":"dep-policy-handler","ready":1,"unavailable":0},{"name":"dep-dcae-ves-collector","ready":1,"unavailable":0},{"name":"dep-dcae-tca-analytics","ready":1,"unavailable":0}]} +curl dcae-healthcheck +.. code-block:: json + + + + { + "type": "summary", + "count": 11, + "ready": 11, + "items": [{ + "name": "dev-dcaegen2-dcae-cloudify-manager", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-config-binding-service", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-deployment-handler", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-inventory", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-service-change-handler", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-policy-handler", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-dcae-ves-collector", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-dcae-tca-analytics", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-dcae-prh", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-dcae-hv-ves-collector", + "ready": 1, + "unavailable": 0 + }, { + "name": "dep-dcae-datafile-collector", + "ready": 1, + "unavailable": 0 + }] + } + Heat Deployment diff --git a/docs/sections/installation_heat.rst b/docs/sections/installation_heat.rst index 1cb2d865..82f93947 100644 --- a/docs/sections/installation_heat.rst +++ b/docs/sections/installation_heat.rst @@ -84,10 +84,9 @@ In DCAE R3, the configuration for DCAE deployment in Heat is greatly simplified. * R3PLUS: This profile deploys the DCAE R2 stretch goal service components, namely: * PNF Registration Handler, * SNMP Trap collector, + * HV-VES Collector * Missing Heartbeat Detection analytics, - * Universal Mapper. - - + * Universal Mapper Tips for Manual Interventions diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst index f5c58bed..d071f833 100644 --- a/docs/sections/installation_oom.rst +++ b/docs/sections/installation_oom.rst @@ -120,19 +120,21 @@ DCAE Service Endpoints ---------------------- Below is a table of default hostnames and ports for DCAE component service endpoints in Kuubernetes deployment: - ================== ============================ ================================= - Component Cluster Internal (host:port) Cluster external (svc_name:port) - ================== ============================ ================================= - VES dcae-ves-collector:8080 xdcae-ves-collector.onap:30235 - HV-VES dcae-hv-ves-collector:6061 xdcae-hv-ves-collector.onap:30222 - TCA dcae-tca-analytics:11011 xdcae-tca-analytics.onap:32010 - Policy Handler policy-handler:25577 NA - Deployment Handler deployment-handler:8443 NA - Inventory inventory:8080 NA - Config binding config-binding-service:10000 NA - DCAE Healthcheck dcae-healthcheck:80 NA - Cloudify Manager dcae-cloudify-manager:80 NA - ================== ============================ ================================= + ================== ============================ ====================================================== + Component Cluster Internal (host:port) Cluster external (svc_name:port) + ================== ============================ ====================================================== + VES dcae-ves-collector:8080 xdcae-ves-collector.onap:30235 + HV-VES dcae-hv-ves-collector:6061 xdcae-hv-ves-collector.onap:30222 + TCA dcae-tca-analytics:11011 xdcae-tca-analytics.onap:32010 + DataFileCollector dcae-datafile-collector:8443/8100 xdcae-datafile-collector:8433:30224/TCP,8100:30223/TCP + SNMPTrap dcae-snmptrap-collector:6162/udp NA + Policy Handler policy-handler:25577 NA + Deployment Handler deployment-handler:8443 NA + Inventory inventory:8080 NA + Config binding config-binding-service:10000 NA + DCAE Healthcheck dcae-healthcheck:80 NA + Cloudify Manager dcae-cloudify-manager:80 NA + ================== ============================ ====================================================== In addition, a number of ONAP service endpoints that are used by DCAE components are listed as follows for reference by DCAE developers and testers: diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 204a2845..cda7e970 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -94,16 +94,16 @@ Quick Links: The following components are upgraded from R2: - Cloudify Manager: - - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.1 + - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2 - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3. - Bootstrap container: - - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.2 + - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.4 - Description: R3 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications. The bootstrap is for OOM (Kubernetes) based deployment. - Configuration Binding Service: - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS - Deployment Handler - - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.2 + - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3 - Policy Handler - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.3.1 - Description: Policy Handler now supports the new configuration policy format and support for TLS diff --git a/docs/sections/services/ves-http/VES-processingFlow.png b/docs/sections/services/ves-http/VES-processingFlow.png Binary files differnew file mode 100644 index 00000000..6d9e28bc --- /dev/null +++ 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 new file mode 100644 index 00000000..d7815d36 --- /dev/null +++ b/docs/sections/services/ves-http/architecture.rst @@ -0,0 +1,60 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +VES Architecture +=================== + +.. image:: ./ves-deployarch.png + +VES Processing Flow +=================== + +.. image:: ./VES-processingFlow.png + + +VES Schema Validation +===================== + +VES Collector is configured to support below VES Version; the corresponding API uses VES schema definition for event validation. + +============== ========================== ================================= +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 +============== ========================== ================================== + +Schema definition files are contained within VES collector gerrit repo - https://git.onap.org/dcaegen2/collectors/ves/tree/etc + + +Features Supported +================== +- VES collector deployed as docker containers +- Acknowledged the sender with appropriate response code (both successful and failure) +- Authentication of the events posted to collector +- Support single or batch JSON events input +- Schema validation (against standard VES definition) +- Multiple schema support and backward compatibility +- Configurable event transformation +- Configurable suppression +- Publish events into Dmaap Topic (with/without AAF) + +The collector can receive events via standard HTTP port (8080) or secure port (8443). Depending on the install/configuration – either one or both can be supported (ports are also modifiable). + + +Dynamic configuration fed into Collector via DCAEPlatform +========================================================= + +- Outbound Dmaap/UEB topic +- Schema version to be validated against +- Authentication account for VNF + +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 + + diff --git a/docs/sections/services/ves-http/configuration.rst b/docs/sections/services/ves-http/configuration.rst new file mode 100644 index 00000000..c7f2fe6e --- /dev/null +++ b/docs/sections/services/ves-http/configuration.rst @@ -0,0 +1,67 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +VES expects to be able to fetch configuration directly from consul service in following JSON format: + +.. code-block:: json + + { + "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.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.inputQueue.maxPending": "8096", + "streams_publishes": { + "ves-measurement": { + "type": "message_router", + "dmaap_info": { + "topic_url": "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/" + } + }, + "ves-fault": { + "type": "message_router", + "dmaap_info": { + "topic_url": "http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT/" + } + }, + "ves-pnfRegistration": { + "type": "message_router", + "dmaap_info": { + "topic_url": "http://message-router:3904/events/unauthenticated.VES_PNFREG_OUTPUT/" + } + }, + "ves-other": { + "type": "message_router", + "dmaap_info": { + "topic_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/" + } + }, + "ves-heartbeat": { + "type": "message_router", + "dmaap_info": { + "topic_url": "http://message-router:3904/events/unauthenticated.SEC_HEARTBEAT_OUTPUT/" + } + }, + "ves-notification": { + "type": "message_router", + "dmaap_info": { + "topic_url": "http://message-router:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT/" + } + } + }, + "collector.service.secure.port": "8443", + "header.authflag": "0", + "collector.keystore.file.location": "/opt/app/VESCollector/etc/keystore", + "collector.keystore.alias": "dynamically generated", + "services_calls": [], + "header.authlist": "sample1,c2FtcGxlMQ==" + } + + +During ONAP OOM/Kubernetes deployment this configuration is created from VES cloudify blueprint. diff --git a/docs/sections/services/ves-http/delivery.rst b/docs/sections/services/ves-http/delivery.rst new file mode 100644 index 00000000..0e5e826a --- /dev/null +++ b/docs/sections/services/ves-http/delivery.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Delivery +======== + +**VES** is delivered as a docker container and published in ONAP Nexus repository following image naming convention. + +Full image name is `onap/org.onap.dcaegen2.collectors.ves.vescollector`.
\ No newline at end of file diff --git a/docs/sections/services/ves-http/index.rst b/docs/sections/services/ves-http/index.rst index e1ad6e72..286e765b 100644 --- a/docs/sections/services/ves-http/index.rst +++ b/docs/sections/services/ves-http/index.rst @@ -7,5 +7,20 @@ VNF Event Streaming (VES) Collector .. Add or remove sections below as appropriate for the platform component. +**Virtual Event Streaming** (VES) Collector (formerly known as Standard Event Collector/Common Event Collector) is RESTful collector for processing JSON messages into DCAE. The collector supports individual events or eventbatch posted to collector end-point(s) and post them to interface/bus for other application to subscribe. +The collector verifies the source (when authentication is enabled) and validates the events against VES schema before distributing to DMAAP MR topics for downstream system to subscribe. The VESCollector also supports configurable event transformation function and event distribution to DMAAP MR topics. + + + VES Collector (HTTP) overview and functions +=========================================== + +.. toctree:: + :maxdepth: 1 + ./architecture.rst + ./configuration.rst + ./delivery.rst + ./installation.rst + `API`_ +.. _API: ../../apis/swagger_vescollector.yaml
\ No newline at end of file diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst new file mode 100644 index 00000000..27f46463 --- /dev/null +++ b/docs/sections/services/ves-http/installation.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +To run VES Collector container on standalone mode, following parameters are required + + ``docker run -d -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.0.11.1' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1`` + + +DMAAPHOST is required for standalone; for normal platform installed instance the publish URL are obtained from Consul. Below parameters are exposed for DCAE platform (cloudify) deployed instance + + +- COLLECTOR_IP +- DMAAPHOST - should contain an address to DMaaP, so that event publishing can work +- CBSPOLLTIMER - it should be put in here if we want to automatically fetch configuration from CBS. +- CONSUL_PROTOCOL - Consul protocol by default set to **http**, if it is need to change it then that can be set to different value +- CONSUL_HOST - used with conjunction with CBSPOLLTIMER, should be a host address (without port! e.g my-ip-or-host) where Consul service lies +- CBS_PROTOCOL - Config Binding Service protocol by default set to **http**, if it is need to change it then that can be set to different value +- CONFIG_BINDING_SERVICE - used with conjunction with CBSPOLLTIMER, should be a name of CBS as it is registered in Consul +- HOSTNAME - used with conjunction with CBSPOLLTIMER, should be a name of VESCollector application as it is registered in CBS catalog + +These parameters can be configured either by passing command line option during `docker run` call or by specifying environment variables named after command line option name
\ No newline at end of file diff --git a/docs/sections/services/ves-http/ves-deployarch.png b/docs/sections/services/ves-http/ves-deployarch.png Binary files differnew file mode 100644 index 00000000..fd4db1bc --- /dev/null +++ b/docs/sections/services/ves-http/ves-deployarch.png diff --git a/docs/sections/tls_enablement.rst b/docs/sections/tls_enablement.rst index 92556b58..0f75bc88 100644 --- a/docs/sections/tls_enablement.rst +++ b/docs/sections/tls_enablement.rst @@ -14,8 +14,7 @@ Solution overview 2. Plugin and Blueprint: Update blueprint to include new (optional) node property (tls_info) to the type definitions for the Kubernetes component types. The property is a dictionary with two elements: A boolean (use_tls) that indicates whether the com ponent uses TLS. A string (cert_directory) that indicates where the component expects to find certificate artifacts - During deployment Kubernetes plugin (referenced in blueprint) will check if the tls_info property is set and use_tls is set to true, then the plugin will add -some elements to the Kubernetes Deployment for the component: + During deployment Kubernetes plugin (referenced in blueprint) will check if the tls_info property is set and use_tls is set to true, then the plugin will add some elements to the Kubernetes Deployment for the component: * A Kubernetes volume (tls-info) that will hold the certificate artifacts * A Kubernetes initContainer (tls-init) * A Kubernetes volumeMount for the initContainer that mounts the tlsinit volume at /opt/tls/shared. @@ -25,11 +24,11 @@ some elements to the Kubernetes Deployment for the component: 3. Certificate Artifacts The certificate directory m ounted on the container will include the following files: - * cert.jks: A Java keystore containing the DCAE certificate. - * jks.pass: A text file with a single line that contains the password for the cert.jks keystore. - * trust.jks: A Jave truststore containing the AAF CA certificate (needed by clients) - * trust.pass: A text file with a single line that contains the password for the trust.jks keystore. - * cert.p12: The DCAE certificate and private key package in PKCS12 form at. - * p12.pass: A text file with a single line that contains the password for cert.p12 file. - * cert.pem: The DCAE certificate, in PEM form at. - * key.pem: The private key for the DCAE certificate. The key is not encrypted. + - cert.jks: A Java keystore containing the DCAE certificate. + - jks.pass: A text file with a single line that contains the password for the cert.jks keystore. + - trust.jks: A Jave truststore containing the AAF CA certificate (needed by clients) + - trust.pass: A text file with a single line that contains the password for the trust.jks keystore. + - cert.p12: The DCAE certificate and private key package in PKCS12 form at. + - p12.pass: A text file with a single line that contains the password for cert.p12 file. + - cert.pem: The DCAE certificate, in PEM form at. + - key.pem: The private key for the DCAE certificate. The key is not encrypted. |
