summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--docs/sections/apis/swagger_vescollector.json689
-rw-r--r--docs/sections/apis/swagger_vescollector.yaml71
-rw-r--r--docs/sections/services/son-handler/index.rst5
-rw-r--r--docs/sections/services/son-handler/installation.rst14
-rw-r--r--docs/sections/services/son-handler/son_handler_overview.rst22
5 files changed, 331 insertions, 470 deletions
diff --git a/docs/sections/apis/swagger_vescollector.json b/docs/sections/apis/swagger_vescollector.json
index 05376ae4..7d0d76fe 100644
--- a/docs/sections/apis/swagger_vescollector.json
+++ b/docs/sections/apis/swagger_vescollector.json
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
- "version": "1.4.5",
- "title": "VES Collector",
+ "version": "1.5.4",
+ "title": "Api Documentation",
"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\n",
"termsOfService": "urn:tos",
"contact": {},
@@ -11,29 +11,22 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
- "host": "localhost:8080",
+ "host": "localhost:8443",
"basePath": "/",
- "tags": [
- {
- "name": "basic-error-controller",
- "description": "Basic Error Controller"
- },
- {
- "name": "ves-rest-controller",
- "description": "Ves Rest Controller"
- }
- ],
+ "tags": [{
+ "name": "basic-error-controller",
+ "description": "Basic Error Controller"
+ }, {
+ "name": "ves-rest-controller",
+ "description": "Ves Rest Controller"
+ }],
"paths": {
"/": {
"get": {
- "tags": [
- "ves-rest-controller"
- ],
+ "tags": ["ves-rest-controller"],
"summary": "mainPage",
"operationId": "mainPageUsingGET",
- "produces": [
- "*/*"
- ],
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
@@ -55,19 +48,18 @@
},
"/error": {
"get": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingGET",
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingGET",
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
"401": {
@@ -82,22 +74,19 @@
}
},
"head": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingHEAD",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingHEAD",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
"204": {
@@ -112,26 +101,23 @@
}
},
"post": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingPOST",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPOST",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -145,26 +131,23 @@
}
},
"put": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingPUT",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPUT",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -178,19 +161,18 @@
}
},
"delete": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingDELETE",
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingDELETE",
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
"204": {
@@ -205,22 +187,19 @@
}
},
"options": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingOPTIONS",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingOPTIONS",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
"204": {
@@ -235,22 +214,19 @@
}
},
"patch": {
- "tags": [
- "basic-error-controller"
- ],
- "summary": "errorHtml",
- "operationId": "errorHtmlUsingPATCH",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
+ "tags": ["basic-error-controller"],
+ "summary": "error",
+ "operationId": "errorUsingPATCH",
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
"responses": {
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ModelAndView"
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
}
},
"204": {
@@ -267,28 +243,20 @@
},
"/eventListener/v1": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "tags": ["ves-rest-controller"],
"summary": "receiveEvent",
"operationId": "receiveEventUsingPOST",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "*/*"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "jsonPayload",
- "description": "jsonPayload",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -296,8 +264,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -313,28 +281,20 @@
},
"/eventListener/v1/eventBatch": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -342,8 +302,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -359,28 +319,20 @@
},
"/eventListener/v2": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "tags": ["ves-rest-controller"],
"summary": "receiveEvent",
"operationId": "receiveEventUsingPOST_2",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "*/*"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "jsonPayload",
- "description": "jsonPayload",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -388,8 +340,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -405,28 +357,20 @@
},
"/eventListener/v2/eventBatch": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -434,8 +378,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -451,28 +395,20 @@
},
"/eventListener/v3": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "tags": ["ves-rest-controller"],
"summary": "receiveEvent",
"operationId": "receiveEventUsingPOST_4",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "*/*"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "jsonPayload",
- "description": "jsonPayload",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -480,8 +416,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -497,28 +433,20 @@
},
"/eventListener/v3/eventBatch": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "tags": ["ves-rest-controller"],
"summary": "receiveEvent",
"operationId": "receiveEventUsingPOST_5",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "*/*"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "jsonPayload",
- "description": "jsonPayload",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -526,8 +454,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -543,28 +471,20 @@
},
"/eventListener/v4": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "tags": ["ves-rest-controller"],
"summary": "receiveEvent",
"operationId": "receiveEventUsingPOST_6",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "*/*"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "jsonPayload",
- "description": "jsonPayload",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -572,8 +492,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -589,28 +509,20 @@
},
"/eventListener/v4/eventBatch": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -618,8 +530,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -635,28 +547,20 @@
},
"/eventListener/v5": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -664,8 +568,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -681,28 +585,20 @@
},
"/eventListener/v5/eventBatch": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -710,8 +606,8 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
},
"401": {
"description": "Unauthorized"
@@ -727,28 +623,20 @@
},
"/eventListener/v7": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -756,8 +644,11 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
+ },
+ "400": {
+ "description": "Bad Request"
},
"401": {
"description": "Unauthorized"
@@ -767,34 +658,29 @@
},
"404": {
"description": "Not Found"
+ },
+ "500": {
+ "description": "Internal Server Error"
}
}
}
},
"/eventListener/v7/eventBatch": {
"post": {
- "tags": [
- "ves-rest-controller"
- ],
+ "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"
- }
- }
- ],
+ "consumes": ["application/json"],
+ "produces": ["*/*"],
+ "parameters": [{
+ "in": "body",
+ "name": "jsonPayload",
+ "description": "jsonPayload",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }],
"responses": {
"200": {
"description": "OK",
@@ -802,8 +688,11 @@
"type": "string"
}
},
- "201": {
- "description": "Created"
+ "202": {
+ "description": "Accepted"
+ },
+ "400": {
+ "description": "Bad Request"
},
"401": {
"description": "Unauthorized"
@@ -813,6 +702,9 @@
},
"404": {
"description": "Not Found"
+ },
+ "500": {
+ "description": "Internal Server Error"
}
}
}
@@ -839,72 +731,7 @@
},
"status": {
"type": "string",
- "enum": [
- "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"
- ]
+ "enum": ["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"
diff --git a/docs/sections/apis/swagger_vescollector.yaml b/docs/sections/apis/swagger_vescollector.yaml
index 978ea1d7..77ced698 100644
--- a/docs/sections/apis/swagger_vescollector.yaml
+++ b/docs/sections/apis/swagger_vescollector.yaml
@@ -1,5 +1,6 @@
# ================================================================================
# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+# Modifications Copyright (C) 2020 Nokia. 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.
@@ -16,8 +17,8 @@
#
swagger: '2.0'
info:
- version: 1.4.5
- title: VES Collector
+ version: '1.5.4'
+ title: Api Documentation
description: >
Virtual Event Streaming (VES) Collector is RESTful collector for processing
JSON messages. The collector verifies the source and validates the events
@@ -27,7 +28,7 @@ info:
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
-host: 'localhost:8080'
+host: 'localhost:8443'
basePath: /
tags:
- name: basic-error-controller
@@ -107,8 +108,8 @@ paths:
description: OK
schema:
$ref: '#/definitions/ModelAndView'
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -129,8 +130,8 @@ paths:
description: OK
schema:
$ref: '#/definitions/ModelAndView'
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -217,8 +218,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -247,8 +248,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -277,8 +278,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -307,8 +308,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -337,8 +338,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -367,8 +368,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -397,8 +398,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -427,8 +428,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -457,8 +458,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -487,8 +488,8 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
'401':
description: Unauthorized
'403':
@@ -517,14 +518,18 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
+ '400':
+ description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
+ '500':
+ description: Internal Server Error
/eventListener/v7/eventBatch:
post:
tags:
@@ -547,14 +552,18 @@ paths:
description: OK
schema:
type: string
- '201':
- description: Created
+ '202':
+ description: Accepted
+ '400':
+ description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
+ '500':
+ description: Internal Server Error
definitions:
ModelAndView:
type: object
diff --git a/docs/sections/services/son-handler/index.rst b/docs/sections/services/son-handler/index.rst
index 79bcb2d1..80f52c7a 100644
--- a/docs/sections/services/son-handler/index.rst
+++ b/docs/sections/services/son-handler/index.rst
@@ -9,8 +9,9 @@ SON-Handler MS
**SON-Handler MS** is introduced in ONAP for implementing the pre-processing and co-ordination actions of various RAN SON use cases.
-As of now PCI optimization and ANR updates are handled in Dublin release.
-OOF, SON Handler MS, DCAE, VES Collector, Policy, DMaaP and SDNR are involved in this use case implementation.
+PCI optimization and centralized ANR updates are handled in Frankfurt release.
+
+OOF, DCAE - SON Handler MS and VES Collector, Policy, DMaaP and SDN-C (SDN-R) are involved in the realization of this use case.
.. image:: flowdiagram.jpg
diff --git a/docs/sections/services/son-handler/installation.rst b/docs/sections/services/son-handler/installation.rst
index edfcb39f..17f6e740 100644
--- a/docs/sections/services/son-handler/installation.rst
+++ b/docs/sections/services/son-handler/installation.rst
@@ -55,11 +55,20 @@ Deployment Prerequisites
Deployment steps
~~~~~~~~~~~~~~~~
+1.Using DCAE Dashboard
+ - Login to DCAE Dashboard
+ - Go to Inventory --> Blueprints
+ - Upload son-handler blueprint which can be found under blueprints repo (https://gerrit.onap.org/r/dcaegen2/platform/blueprints)
+ - Click on Deploy Action for son-handler blueprint
+ - Deployment logs can be viewed under Deployments section
+
+2.Using cloudify commands
+
- Login to the bootstrap container
kubectl exec -ti --namespace onap <bootstrap pod name> bash
-- Copy the blueprints and inputs file to the bootstrap container. The blueprint and a sample input file can be found under dpo/blueprints directory of son-hanler project. (https://gerrit.onap.org/r/dcaegen2/services/son-handler)
+- The blueprint can be found under dcaegen2 blueprint repo and is part of bootstrap container. (https://gerrit.onap.org/r/dcaegen2/platform/blueprints)
- Deploy the microservice into the cloudify using the following command
- cfy install -d sonhms -b sonhms -i <inputs file path> <blueprint file path>
+ cfy install -d sonhms -b sonhms <blueprint file path>
- Deployment status of the microservice can be found from kubernetes pods status (MS will be deployed as a k8s pod in the kubernetes environment under the same namespace as the DCAE environment).
kubectl get pods --namespace onap
- To uninstall the microservice
@@ -119,4 +128,3 @@ Application Configurations
+-------------------------------+------------------------------------------------+
|sonhandler.optimizers | Optimizer to trigger in OOF |
+-------------------------------+------------------------------------------------+
-
diff --git a/docs/sections/services/son-handler/son_handler_overview.rst b/docs/sections/services/son-handler/son_handler_overview.rst
index 41dbd844..62dc12a8 100644
--- a/docs/sections/services/son-handler/son_handler_overview.rst
+++ b/docs/sections/services/son-handler/son_handler_overview.rst
@@ -28,15 +28,30 @@ The logic may not be 100% fool-proof (i.e., cover all possible scenarios and bou
The details of the state machines of all the threads in the core logic are available in https://wiki.onap.org/pages/viewpage.action?pageId=56131985.
+In Frankfurt release, adaptive SON functionality was introduced for PCI optimization. While determining the optimum PCI values to resolve PCI collision and confusion, the optimizer also takes into consideration a set of cells whose PCI values may not be changed during the optimization. Such situations could arise, for example, when the PCI value of a cell could not be updated in the past (due to whatever reason), or configuration policy specifies that certain cells’ PCI values should never be changed. So, the SON-Handler MS keeps track of cells whose PCI values cannot be changed. When triggering OOF for PCI optimization, the SON-Handler MS also provides the list of cells whose PCI values cannot be changed.
+
+
+Details of Frankfurt implementation are available in https://wiki.onap.org/display/DW/SON-Handler+MS+%28DCAE%29+Impacts.
+
+
Database
~~~~~~~~
This is a PostgreSQL DB, and is intended to persist information such as the following:
+
- PCI-Handler MS Config information (e.g., thresholds, timer values, OOF algorithm name, etc.)
+
- Pre-processing results and other related information (e.g., neighbor list)
+
- Buffered notifications (i.e., notifications not yet processed at all)
+
- State information
+
- Association between PNF-name and CellId
-- PM/FM data
+
+- Aggregated PM/FM data
+
+- List of cells whose PCI values are fixed
+
- Etc.
DMaaP Client
@@ -45,8 +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.
+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.
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. \ No newline at end of file
+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 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.