summaryrefslogtreecommitdiffstats
path: root/docs/sections/services
diff options
context:
space:
mode:
authorVijay VK <vv770d@att.com>2019-05-23 22:02:50 +0100
committerVijay Venkatesh Kumar <vv770d@att.com>2019-05-23 21:28:45 +0000
commit6cdebe0d51014c9cfbbee0b63f31f671a25f4f7a (patch)
treee0a5f257e641e41e6a809a038fe6acec9e1c33d6 /docs/sections/services
parentf9e4344e9c9834face106b6c153ede020ff5410f (diff)
Fix doc issues
Change-Id: I711a40a64a1d47b50f0923ba67b02ad121ace5b4 Signed-off-by: VENKATESH KUMAR <vv770d@att.com> Issue-ID: DCAEGEN2-1505
Diffstat (limited to 'docs/sections/services')
-rw-r--r--docs/sections/services/bbs-event-processor/installation.rst1
-rw-r--r--docs/sections/services/mapper/installation.rst6
-rw-r--r--docs/sections/services/restconf/installation.rst17
-rw-r--r--docs/sections/services/son-handler/installation.rst170
-rw-r--r--docs/sections/services/tca-cdap/development_info.rst18
-rw-r--r--docs/sections/services/tca-cdap/index.rst8
-rw-r--r--docs/sections/services/ves-http/architecture.rst8
-rw-r--r--docs/sections/services/ves-http/installation.rst4
-rw-r--r--docs/sections/services/ves-http/tls-authentication.rst4
9 files changed, 126 insertions, 110 deletions
diff --git a/docs/sections/services/bbs-event-processor/installation.rst b/docs/sections/services/bbs-event-processor/installation.rst
index 242f9f9b..92d2e83f 100644
--- a/docs/sections/services/bbs-event-processor/installation.rst
+++ b/docs/sections/services/bbs-event-processor/installation.rst
@@ -40,6 +40,7 @@ The following docker-compose-yaml file shows a default configuration. The file c
LOGGING_LEVEL_ORG_ONAP_BBS: TRACE
For Dublin release, it will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation.
+
Steps to deploy are shown below
- Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Blueprint can be found in
diff --git a/docs/sections/services/mapper/installation.rst b/docs/sections/services/mapper/installation.rst
index 7559f4a5..a83229ce 100644
--- a/docs/sections/services/mapper/installation.rst
+++ b/docs/sections/services/mapper/installation.rst
@@ -15,7 +15,7 @@ VES-Mapper can be deployed individually though it will throw errors if it can't
**Blueprint/model/image**
VES-Mapper blueprint is available @
-https://gerrit.onap.org/r/gitweb?p=dcaegen2/services/mapper.git;a=blob;f=UniversalVesAdapter/dpo/blueprints/k8s-vesmapper.yaml-template.yaml;h=refs/head/master
+https://git.onap.org/dcaegen2/services/mapper/tree/UniversalVesAdapter/dpo/blueprints/k8s-vesmapper.yaml-template.yaml?h=dublin
VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0-SNAPSHOT <nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0-SNAPSHOT>`_
@@ -33,9 +33,7 @@ VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap
update these ``urls`` as per your DMaaP configurations in the blueprint.
-*b. Verify the Smooks mapping files in the blueprint as per the usecase. Blueprint contains default mapping file for each supported collector ( SNMP Collector and RESTConf collector currently) which may serve the purpose for the usecase.
-
-``mapping-files`` in ``collectors`` contains the contents of the mapping file.
+*b. Verify the Smooks mapping configuration in the blueprint as per the usecase. Blueprint contains default mapping for each supported collector ( SNMP Collector and RESTConf collector currently) which may serve the purpose for the usecase. The ``mapping-files`` in ``collectors`` contains the contents of the mapping file.
*c. Upload the blueprint in the DCAE's Cloudify instance*
diff --git a/docs/sections/services/restconf/installation.rst b/docs/sections/services/restconf/installation.rst
index 2f369873..d475ef7a 100644
--- a/docs/sections/services/restconf/installation.rst
+++ b/docs/sections/services/restconf/installation.rst
@@ -1,18 +1,21 @@
Installation
============
-Sample docker run command could be -
-.. code-block:: bash
- docker run onap/org.onap.dcaegen2.collectors.restconfcollector
+Standalone docker run command
+ .. code-block:: bash
+
+ docker run onap/org.onap.dcaegen2.collectors.restconfcollector
+
+For Dublin release, RESTConf collector will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation.
+
-For Dublin release, it will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation.
Steps to deploy are shown below
-- Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Blueprint can be found in
+- Enter the Bootstrap POD using kubectl
- https://git.onap.org/dcaegen2/collectors/restconf/tree/dpo/blueprints/k8s-rcc-policy.yaml-template?h=master
+- Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Blueprint can be found in
+ https://git.onap.org/dcaegen2/collectors/restconf/tree/dpo/blueprints/k8s-rcc-policy.yaml-template?h=dublin
-- Enter the Bootstrap POD
- Validate blueprint
.. code-block:: bash
diff --git a/docs/sections/services/son-handler/installation.rst b/docs/sections/services/son-handler/installation.rst
index f529bc4a..edfcb39f 100644
--- a/docs/sections/services/son-handler/installation.rst
+++ b/docs/sections/services/son-handler/installation.rst
@@ -10,38 +10,48 @@ Deployment Prerequisites
- SON-hadler service requires the following dmaap topics to be present in the running DMAAP instance :
- 1.PCI-NOTIF-TOPIC-NGHBR-LIST-CHANGE-INFO
-
- 2.unauthenticated.SEC_FAULT_OUTPUT
-
- 3.unauthenticated.SEC_MEASUREMENT_OUTPUT
-
- 4.DCAE_CL_RSP
-
-- Policy model required for SON-handler service should be created and pushed to policy component.Steps for creating and pushing the policy model:
- 1.Login to PDP container and execute
- kubectl exec -ti --namespace onap policy-pdp-0 bash
- 2.Create policy model
- curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
- "policyName": "com.PCIMS_CONFIG_POLICY",
- "configBody": "{ \"PCI_NEIGHBOR_CHANGE_CLUSTER_TIMEOUT_IN_SECS\":60, \"PCI_MODCONFIG_POLICY_NAME\":\"ControlLoop-vPCI-fb41f388-a5f2-11e8-98d0-529269fb1459\", \"PCI_OPTMIZATION_ALGO_CATEGORY_IN_OOF\":\"OOF-PCI-OPTIMIZATION\", \"PCI_SDNR_TARGET_NAME\":\"SDNR\" }",
- "policyType": "Config",
- "attributes" : { "matching" : { "key1" : "value1" } },
- "policyConfigType": "Base",
- "onapName": "DCAE",
- "configName": "PCIMS_CONFIG_POLICY",
- "configBodyType": "JSON"
-}' 'https://pdp:8081/pdp/api/createPolicy'
-
- 3.Push policy model
- curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
- "policyName": "com.PCIMS_CONFIG_POLICY",
- "policyType": "Base"
-}' 'https://pdp:8081/pdp/api/pushPolicy'
-
- 4.Verify config policy is present
-
- curl -k -v --silent -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{ "configName": "PCIMS_CONFIG_POLICY", "policyName": "com.Config_PCIMS_CONFIG_POLICY1*", "requestID":"e65cc45a-9efb-11e8-98d0-529269ffa459" }' 'https://pdp:8081/pdp/api/getConfig'
+ 1.PCI-NOTIF-TOPIC-NGHBR-LIST-CHANGE-INFO
+
+ 2.unauthenticated.SEC_FAULT_OUTPUT
+
+ 3.unauthenticated.SEC_MEASUREMENT_OUTPUT
+
+ 4.DCAE_CL_RSP
+
+- Policy model required for SON-handler service should be created and pushed to policy component. Steps for creating and pushing the policy model:
+
+ 1.Login to PDP container and execute
+
+ .. code-block:: bash
+
+ kubectl exec -ti --namespace onap policy-pdp-0 bash
+
+ 2.Create policy model
+
+ .. code-block:: bash
+
+ curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "policyName": "com.PCIMS_CONFIG_POLICY",
+ "configBody": "{ \"PCI_NEIGHBOR_CHANGE_CLUSTER_TIMEOUT_IN_SECS\":60, \"PCI_MODCONFIG_POLICY_NAME\":\"ControlLoop-vPCI-fb41f388-a5f2-11e8-98d0-529269fb1459\", \"PCI_OPTMIZATION_ALGO_CATEGORY_IN_OOF\":\"OOF-PCI-OPTIMIZATION\", \"PCI_SDNR_TARGET_NAME\":\"SDNR\" }",
+ "policyType": "Config", "attributes" : { "matching" : { "key1" : "value1" } },
+ "policyConfigType": "Base",
+ "onapName": "DCAE",
+ "configName": "PCIMS_CONFIG_POLICY",
+ "configBodyType": "JSON" }' 'https://pdp:8081/pdp/api/createPolicy'
+
+ 3.Push policy model
+
+ .. code-block:: bash
+
+ curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "policyName": "com.PCIMS_CONFIG_POLICY",
+ "policyType": "Base"}' 'https://pdp:8081/pdp/api/pushPolicy'
+
+ 4.Verify config policy is present
+
+ .. code-block:: bash
+
+ curl -k -v --silent -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{ "configName": "PCIMS_CONFIG_POLICY", "policyName": "com.Config_PCIMS_CONFIG_POLICY1*", "requestID":"e65cc45a-9efb-11e8-98d0-529269ffa459" }' 'https://pdp:8081/pdp/api/getConfig'
Deployment steps
~~~~~~~~~~~~~~~~
@@ -60,51 +70,53 @@ Deployment steps
Application Configurations
--------------------------
-
-Streams_subscribes Dmaap topics that the MS will consume messages
-
-Streams_publishes Dmaap topics that the MS will publish messages
-
-postgres.host Host where the postgres database is running
-
-postgres.port Host where the postgres database is running
-
-postgres.username Postgres username
-
-postgres.password Postgres password
-
-sonhandler.pollingInterval Polling Interval for consuming dmaap messages
-
-sonhandler.pollingTimeout Polling timeout for consuming dmaap messages
-
-sonhandler.numSolutions Number for solutions for OOF optimization
-
-sonhandler.minCollision Minimum collision criteria to trigger OOF
-
-sonhandler.minConfusion Minimum confusion criteria to trigger OOF
-
-sonhandler.maximumClusters Maximum number of clusters MS can process
-
-sonhandler.badThreshold Bad threshold for Handover success rate
-
-sonhandler.poorThreshold Poor threshold for Handover success rate
-
-sonhandler.namespace Namespace where MS is going to be deployed
-
-sonhandler.sourceId Source ID of the Microservice (Required for Sending request to OOF)
-
-sonhandler.dmaap.server Location of message routers
-
-sonhandler.bufferTime Buffer time for MS to wait for more notifications when the optimization criteria is not met
-
-sonhandler.cg Consumer group for the MS to consume message from dmaap
-
-sonhandler.cid Consumer ID for the MS to consume message from dmaap
-
-sonhandler.configDbService Location of the config DB (protocol, host & port)
-
-sonhandler.oof.service Location of OOF (protocol, host & port)
-
-sonhandler.optimizers Optimizer to trigger in OOF
-
++-------------------------------+------------------------------------------------+
+|Configuration | Description |
++===============================+================================================+
+|Streams_subscribes | Dmaap topics that the MS will consume messages |
++-------------------------------+------------------------------------------------+
+|Streams_publishes | Dmaap topics that the MS will publish messages |
++-------------------------------+------------------------------------------------+
+|postgres.host | Host where the postgres database is running |
++-------------------------------+------------------------------------------------+
+|postgres.port | Host where the postgres database is running |
++-------------------------------+------------------------------------------------+
+|postgres.username | Postgres username |
++-------------------------------+------------------------------------------------+
+|postgres.password | Postgres password |
++-------------------------------+------------------------------------------------+
+|sonhandler.pollingInterval | Polling Interval for consuming dmaap messages |
++-------------------------------+------------------------------------------------+
+|sonhandler.pollingTimeout | Polling timeout for consuming dmaap messages |
++-------------------------------+------------------------------------------------+
+|sonhandler.numSolutions | Number for solutions for OOF optimization |
++-------------------------------+------------------------------------------------+
+|sonhandler.minCollision | Minimum collision criteria to trigger OOF |
++-------------------------------+------------------------------------------------+
+|sonhandler.minConfusion | Minimum confusion criteria to trigger OOF |
++-------------------------------+------------------------------------------------+
+|sonhandler.maximumClusters | Maximum number of clusters MS can process |
++-------------------------------+------------------------------------------------+
+|sonhandler.badThreshold | Bad threshold for Handover success rate |
++-------------------------------+------------------------------------------------+
+|sonhandler.poorThreshold | Poor threshold for Handover success rate |
++-------------------------------+------------------------------------------------+
+|sonhandler.namespace | Namespace where MS is going to be deployed |
++-------------------------------+------------------------------------------------+
+|sonhandler.sourceId | Source ID of the Microservice (to OOF) |
++-------------------------------+------------------------------------------------+
+|sonhandler.dmaap.server | Location of message routers |
++-------------------------------+------------------------------------------------+
+|sonhandler.bufferTime | Buffer time for MS to wait for notifications |
++-------------------------------+------------------------------------------------+
+|sonhandler.cg | DMAAP Consumer group for subscription |
++-------------------------------+------------------------------------------------+
+|sonhandler.cid | DMAAP Consumer id for subcription |
++-------------------------------+------------------------------------------------+
+|sonhandler.configDbService | Location of config DB (protocol, host & port) |
++-------------------------------+------------------------------------------------+
+|sonhandler.oof.service | Location of OOF (protocol, host & port) |
++-------------------------------+------------------------------------------------+
+|sonhandler.optimizers | Optimizer to trigger in OOF |
++-------------------------------+------------------------------------------------+
diff --git a/docs/sections/services/tca-cdap/development_info.rst b/docs/sections/services/tca-cdap/development_info.rst
index afb240ef..fe48c267 100644
--- a/docs/sections/services/tca-cdap/development_info.rst
+++ b/docs/sections/services/tca-cdap/development_info.rst
@@ -6,16 +6,16 @@ To build just the TCA component, run the following maven command
`mvn clean install`
-Maven GroupId:
-==============
+Maven GroupId
+-------------
org.onap.dcaegen2.analytics.tca
-Maven Parent ArtifactId:
-----------------
+Maven Parent ArtifactId
+-----------------------
dcae-analytics
-Maven Children Artifacts:
+Maven Children Artifacts
------------------------
1. dcae-analytics-test: Common test code for all DCAE Analytics Modules
2. dcae-analytics-model: Contains models (e.g. Common Event Format) which are common to DCAE Analytics
@@ -29,7 +29,10 @@ Maven Children Artifacts:
API Endpoints
-=============
+-------------
+
+For deployment into CDAP, following API's can be used to deploy TCA application.
+
# create namespace
curl -X PUT http://<k8s-clusterIP>:11015/v3/namespaces/cdap_tca_hi_lo
@@ -60,8 +63,7 @@ curl http://<k8s-clusterIP>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flo
TCA CDAP Container
-=================
-
+------------------
If new jar is generated, corresponding version should be updated into https://git.onap.org/dcaegen2/deployments/tree/tca-cdap-container.
Following files should be revised
diff --git a/docs/sections/services/tca-cdap/index.rst b/docs/sections/services/tca-cdap/index.rst
index 9d184f5b..b8bc2ef8 100644
--- a/docs/sections/services/tca-cdap/index.rst
+++ b/docs/sections/services/tca-cdap/index.rst
@@ -1,15 +1,11 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-=================================
+==================================
Threshold Crossing Analytics (TCA)
-=================================
+==================================
-.. contents::
- :depth: 3
-..
-
Overview
========
diff --git a/docs/sections/services/ves-http/architecture.rst b/docs/sections/services/ves-http/architecture.rst
index 29077afe..41f3e8f1 100644
--- a/docs/sections/services/ves-http/architecture.rst
+++ b/docs/sections/services/ves-http/architecture.rst
@@ -7,13 +7,13 @@ 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.
@@ -30,7 +30,7 @@ Schema definition files are contained within VES collector gerrit repo - https:/
Features Supported
-==================
+------------------
- VES collector deployed as docker containers
- Acknowledgement to sender with appropriate response code (both successful and failure)
- Authentication of the events posted to collector (support 4 types of authentication setting)
@@ -45,7 +45,7 @@ The collector can receive events via standard HTTP port (8080) or secure port (8
Dynamic configuration fed into Collector via DCAEPlatform
-=========================================================
+---------------------------------------------------------
- Outbound Dmaap/UEB topic
- Schema version to be validated against
diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst
index 9a627df3..b39b007d 100644
--- a/docs/sections/services/ves-http/installation.rst
+++ b/docs/sections/services/ves-http/installation.rst
@@ -4,6 +4,10 @@
Installation
============
+VESCollector is installed via cloudify blueprint by DCAE bootstrap process on typical ONAP installation.
+As the service is containerized, it can be started on stand-alone mode also.
+
+
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.2``
diff --git a/docs/sections/services/ves-http/tls-authentication.rst b/docs/sections/services/ves-http/tls-authentication.rst
index b5226dc5..ad8d8d22 100644
--- a/docs/sections/services/ves-http/tls-authentication.rst
+++ b/docs/sections/services/ves-http/tls-authentication.rst
@@ -1,8 +1,8 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Certificates as authentication method for PNFs/VNFs
-===================================================
+Authentication Types
+====================
VES supports mutual TLS authentication via X.509 certificates. If VES is deployed via docker image then VES configuration can be modified by editing */opt/app/VESCollector/etc/collector.properties* which is present on the docker container. VES detects changes made to the mentioned file automatically and restarts the application.