summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorVijay <vv770d@att.com>2017-10-18 17:27:55 +0000
committerVijay <vv770d@att.com>2017-10-18 17:28:05 +0000
commit0245de0204ca80ec0154ca5161a616d64f6ffb1a (patch)
tree56d2e34b259fc8dd65f0a6f41ff920bdf3b4744c /docs
parent914778def3d2c6625c3e471b0f7a9f504d5d8e3f (diff)
dcae ms installation
Issue-Id:DCAEGEN2-128 Change-Id: Id1f805dce6e2f3513cf5450eb6f78807ed6bb24d Signed-off-by: Vijay <vv770d@att.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/installation.rst466
1 files changed, 419 insertions, 47 deletions
diff --git a/docs/sections/installation.rst b/docs/sections/installation.rst
index 65f80920..ab90cebe 100644
--- a/docs/sections/installation.rst
+++ b/docs/sections/installation.rst
@@ -1,69 +1,441 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+DCAE mS Installation
+====================
-Installation
-============
+The below steps covers manual setup of DCAE VM’s and DCAE service
+components.
VESCollector
------------
+ 
+
DCAE VES Collector can be configured on VM with ubuntu-16.04 image
(m1.small should suffice if this is only service) and 20Gb cinder
storage
-1) Install docker
+1. Install docker
+
+  sudo apt-get update
+
+  sudo apt install `docker.io <http://docker.io/>`__
+
+1. Pull the latest container from onap nexus
+
+ sudo docker login -u docker -p docker
+ `nexus.onap.org <http://nexus.onap.org/>`__:10001
+
+ sudo docker pull
+ `nexus.onap.org <http://nexus.onap.org/>`__:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+
+1. Start the VESCollector with below command
+
+ sudo docker run -d --name vescollector -p 8080:8080/tcp -p
+ 8443:8443/tcp -P -e DMAAPHOST='<dmaap IP>'
+ `nexus.onap.org <http://nexus.onap.org/>`__:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+
+  Note:  Change the dmaaphost to required DMAAP ip. To change the
+ dmaap information for a running container,  stop the active
+ container and rerun above command changing the dmaap IP.
+
+1. Verification
+
+i. Check logs under container /opt/app/VESCollector/logs/collector.log
+ for errors
+
+ii. If no active feed, you can simulate an event into collector via curl
+
+ curl -i  -X POST -d @<sampleves> --header "Content-Type:
+ application/json" http://localhost:8080/eventListener/v5 -k
+
+ Note: If DMAAPHOST provided is invalid, you will see exception
+ around publish on the collector.logs (collector queues and attempts
+ to resend the event hence exceptions reported will be periodic). 
+
+i. Below two topic configuration are pre-set into this container.  When
+ valid DMAAP instance ip was provided and VES events are received,
+ the collector will post to below topics.
+
+ Fault -
+  http://<dmaaphost>:3904/events/unauthenticated.SEC\_FAULT\_OUTPUT
+
+ Measurement
+ -http://<dmaaphost>:3904/events/unauthenticated.SEC\_MEASUREMENT\_OUTPUT
+
+VM Init
+~~~~~~
+
+To address windriver server in-stability, the below **init.sh** script
+was used to start the container on VM restart.  
+
++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| #!/bin/sh |
+| |
+| sudo docker ps \| grep "vescollector" |
+| |
+| if [ $? -ne 0 ]; then |
+| |
+|         sudo docker login -u docker -p docker nexus.onap.org:10001 |
+| |
+|         sudo docker pull nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1 |
+| |
+|         sudo docker rm -f vescollector |
+| |
+|         echo "Collector process not running - $(date)" >> /home/ubuntu/startuplog |
+| |
+|         sudo docker run -d --name vescollector -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.12.25.96' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1 |
+| |
+| else |
+| |
+|         echo "Collector process running - $(date)" >> /home/ubuntu/startuplog |
+| |
+| fi |
++==============================================================================================================================================================================================+
++----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+This script was invoked via VM init script (rc.d).
+
+ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
+
+sudo  update-rc.d init.sh start 2
+
+ 
+
+ThresholdCrossingAnalysis (TCA/CDAP)
+------------------------------------
+
+The platform deploys CDAP as cluster and instantiates TCA. For the
+manual setup, we will leverage the CDAP SDK docker container to deploy
+TCA instances.  To setup TCA, choose VM with ubuntu-16.04 image,
+m1.medium size and 50gb cinder volumes.
+
+1. Install docker
+
+  sudo apt-get update
+
+  sudo apt install `docker.io <http://docker.io/>`__
+
+1. Pull CDAP SDK container
+
+sudo docker pull caskdata/cdap-standalone:4.1.2
+
+1. Deploy and run the CDAP container
+
+ sudo docker run -d --name cdap-sdk-2 -p 11011:11011 -p 11015:11015
+ caskdata/cdap-standalone:4.1.2
+
+1. Create Namespace on CDAP application
+
+curl -X PUT http://localhost:11015/v3/namespaces/cdap_tca_hi_lo
+
+1. Create TCA app preference file under ~ubuntu as below
+
++--------------------------------------------------------------------------------------------------------------------------------------------+
+| { |
+| |
+|   "publisherContentType" : "application/json", |
+| |
+|   "publisherHostName" : "10.12.25.96", |
+| |
+|   "publisherHostPort" : "3904", |
+| |
+|   "publisherMaxBatchSize" : "1", |
+| |
+|   "publisherMaxRecoveryQueueSize" : "100000", |
+| |
+|   "publisherPollingInterval" : "20000", |
+| |
+|   "publisherProtocol" : "http", |
+| |
+|   "publisherTopicName" : "unauthenticated.DCAE\_CL\_OUTPUT", |
+| |
+|   "subscriberConsumerGroup" : "OpenDCAE-c1", |
+| |
+|   "subscriberConsumerId" : "c1", |
+| |
+|   "subscriberContentType" : "application/json", |
+| |
+|   "subscriberHostName" : "10.12.25.96", |
+| |
+|   "subscriberHostPort" : "3904", |
+| |
+|   "subscriberMessageLimit" : "-1", |
+| |
+|   "subscriberPollingInterval" : "20000", |
+| |
+|   "subscriberProtocol" : "http", |
+| |
+|   "subscriberTimeoutMS" : "-1", |
+| |
+|   "subscriberTopicName" : "unauthenticated.SEC\_MEASUREMENT\_OUTPUT", |
+| |
+|   "enableAAIEnrichment" : false, |
+| |
+|   "aaiEnrichmentHost" : "10.12.25.72", |
+| |
+|   "aaiEnrichmentPortNumber" : 8443, |
+| |
+|   "aaiEnrichmentProtocol" : "https", |
+| |
+|   "aaiEnrichmentUserName" : "DCAE", |
+| |
+|   "aaiEnrichmentUserPassword" : "DCAE", |
+| |
+|   "aaiEnrichmentIgnoreSSLCertificateErrors" : false, |
+| |
+|   "aaiVNFEnrichmentAPIPath" : "/aai/v11/network/generic-vnfs/generic-vnf", |
+| |
+|   "aaiVMEnrichmentAPIPath" :  "/aai/v11/search/nodes-query", |
+| |
+|   "tca\_policy" : "{ |
+| |
+|         \\"domain\\": \\"measurementsForVfScaling\\", |
+| |
+|         \\"metricsPerEventName\\": [{ |
+| |
+|                 \\"eventName\\": \\"vFirewallBroadcastPackets\\", |
+| |
+|                 \\"controlLoopSchemaType\\": \\"VNF\\", |
+| |
+|                 \\"policyScope\\": \\"DCAE\\", |
+| |
+|                 \\"policyName\\": \\"DCAE.Config\_tca-hi-lo\\", |
+| |
+|                 \\"policyVersion\\": \\"v0.0.1\\", |
+| |
+|                 \\"thresholds\\": [{ |
+| |
+|                         \\"closedLoopControlName\\": \\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\\", |
+| |
+|                         \\"version\\": \\"1.0.2\\", |
+| |
+|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.vNicUsageArray[\*].receivedTotalPacketsDelta\\", |
+| |
+|                         \\"thresholdValue\\": 300, |
+| |
+|                         \\"direction\\": \\"LESS\_OR\_EQUAL\\", |
+| |
+|                         \\"severity\\": \\"MAJOR\\", |
+| |
+|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
+| |
+|                 }, { |
+| |
+|                         \\"closedLoopControlName\\": \\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\\", |
+| |
+|                         \\"version\\": \\"1.0.2\\", |
+| |
+|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.vNicUsageArray[\*].receivedTotalPacketsDelta\\", |
+| |
+|                         \\"thresholdValue\\": 700, |
+| |
+|                         \\"direction\\": \\"GREATER\_OR\_EQUAL\\", |
+| |
+|                         \\"severity\\": \\"CRITICAL\\", |
+| |
+|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
+| |
+|                 }] |
+| |
+|         }, { |
+| |
+|                 \\"eventName\\": \\"vLoadBalancer\\", |
+| |
+|                 \\"controlLoopSchemaType\\": \\"VM\\", |
+| |
+|                 \\"policyScope\\": \\"DCAE\\", |
+| |
+|                 \\"policyName\\": \\"DCAE.Config\_tca-hi-lo\\", |
+| |
+|                 \\"policyVersion\\": \\"v0.0.1\\", |
+| |
+|                 \\"thresholds\\": [{ |
+| |
+|                         \\"closedLoopControlName\\": \\"ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3\\", |
+| |
+|                         \\"version\\": \\"1.0.2\\", |
+| |
+|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.vNicUsageArray[\*].receivedTotalPacketsDelta\\", |
+| |
+|                         \\"thresholdValue\\": 300, |
+| |
+|                         \\"direction\\": \\"GREATER\_OR\_EQUAL\\", |
+| |
+|                         \\"severity\\": \\"CRITICAL\\", |
+| |
+|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
+| |
+|                 }] |
+| |
+|         }, { |
+| |
+|                 \\"eventName\\": \\"Measurement\_vGMUX\\", |
+| |
+|                 \\"controlLoopSchemaType\\": \\"VNF\\", |
+| |
+|                 \\"policyScope\\": \\"DCAE\\", |
+| |
+|                 \\"policyName\\": \\"DCAE.Config\_tca-hi-lo\\", |
+| |
+|                 \\"policyVersion\\": \\"v0.0.1\\", |
+| |
+|                 \\"thresholds\\": [{ |
+| |
+|                         \\"closedLoopControlName\\": \\"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\\", |
+| |
+|                         \\"version\\": \\"1.0.2\\", |
+| |
+|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.additionalMeasurements[\*].arrayOfFields[0].value\\", |
+| |
+|                         \\"thresholdValue\\": 0, |
+| |
+|                         \\"direction\\": \\"EQUAL\\", |
+| |
+|                         \\"severity\\": \\"MAJOR\\", |
+| |
+|                         \\"closedLoopEventStatus\\": \\"ABATED\\" |
+| |
+|                 }, { |
+| |
+|                         \\"closedLoopControlName\\": \\"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\\", |
+| |
+|                         \\"version\\": \\"1.0.2\\", |
+| |
+|                         \\"fieldPath\\": \\"$.event.measurementsForVfScalingFields.additionalMeasurements[\*].arrayOfFields[0].value\\", |
+| |
+|                         \\"thresholdValue\\": 0, |
+| |
+|                         \\"direction\\": \\"GREATER\\", |
+| |
+|                         \\"severity\\": \\"CRITICAL\\", |
+| |
+|                         \\"closedLoopEventStatus\\": \\"ONSET\\" |
+| |
+|                 }] |
+| |
+|         }] |
+| |
+| }" |
+| |
+| } |
++============================================================================================================================================+
++--------------------------------------------------------------------------------------------------------------------------------------------+
+
+  Note: Dmaap configuration are specified on this file on
+ publisherHostName and subscriberHostName. To be changed as
+ required\*\*
+
+1. Copy below script to CDAP server (this gets latest image from nexus
+ and deploys TCA application) and execute it
- sudo apt-get update
- sudo apt install docker.io
++---------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| #!/bin/sh |
+| |
+| TCA\_JAR=dcae-analytics-cdap-tca-2.0.0.jar |
+| |
+| rm -f /home/ubuntu/$TCA\_JAR |
+| |
+| cd /home/ubuntu/ |
+| |
+| wget https://nexus.onap.org/service/local/repositories/staging/content/org/onap/dcaegen2/analytics/tca/dcae-analytics-cdap-tca/2.0.0/$TCA\_JAR |
+| |
+| if [ $? -eq 0 ]; then |
+| |
+|         if [ -f /home/ubuntu/$TCA\_JAR ]; then |
+| |
+|                 echo "Restarting TCA CDAP application using $TCA\_JAR artifact" |
+| |
+|         else |
+| |
+|                 echo "ERROR: $TCA\_JAR missing" |
+| |
+|                 exit 1 |
+| |
+|         fi |
+| |
+| else |
+| |
+|         echo "ERROR: $TCA\_JAR not found in nexus" |
+| |
+|         exit 1 |
+| |
+| fi |
+| |
+| # stop programs |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/stop |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/stop |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/stop |
+| |
+| # delete application |
+| |
+| curl -X DELETE http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca# delete artifact |
+| |
+| curl -X DELETE http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/artifacts/dcae-analytics-cdap-tca/versions/2.0.0# load artifact |
+| |
+| curl -X POST --data-binary @/home/ubuntu/$TCA\_JAR http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/artifacts/dcae-analytics-cdap-tcaecho# create app |
+| |
+| curl -X PUT -d @/home/ubuntu/tca\_app\_config.json http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca# load preferences |
+| |
+| curl -X PUT -d @/home/ubuntu/tca\_app\_preferences.json http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/preferences# start programs |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/startecho# get status of programs |
+| |
+| curl http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/status |
+| |
+| curl http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/status |
+| |
+| curl http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/statusecho |
++===============================================================================================================================================================+
++---------------------------------------------------------------------------------------------------------------------------------------------------------------+
-2) Pull the latest container from onap nexus
+1. Verify TCA application and logs via CDAP GUI processes
- sudo docker login -u docker -p docker nexus.onap.org:10001
- sudo docker pull
- nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+ The overall flow can be checked here
-3) Start the VESCollector with below command
+TCA Configuration Change
+~~~~~~~~~~~~~~~~~~~~~~~
- Note: Change the dmaaphost to required DMAAP ip
+Typical configuration changes include changing DMAAP host and/or Policy
+configuration. If necessary, modify the file on step #5 and run the
+script noted as step #6 to redeploy TCA with updated configuration.
- sudo docker run -d --name vescollector -p 8080:8080/tcp -p
- 8443:8443/tcp -P -e DMAAPHOST='10.12.25.96'
- nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
+VM Init
+~~~~~~
- Note: To change the dmaap information for a running container, stop the active container and rerun above command changing the dmaap IP.
+To address windriver server in-stability, the below **init.sh** script
+was used to restart the container on VM restart.  This script was
+invoked via VM init script (rc.d).
-4) Verification
++------------------------------------------------------------------------------------------------------------------------------+
+| #!/bin/sh |
+| |
+| #docker run -d --name cdap-sdk -p 11011:11011 -p 11015:11015 caskdata/cdap-standalone:4.1.2 |
+| |
+| sudo docker restart cdap-sdk-2 |
+| |
+| sleep 30 |
+| |
+| # start program |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start |
+| |
+| curl -X POST http://localhost:11015/v3/namespaces/cdap\_tca\_hi\_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/start |
++==============================================================================================================================+
++------------------------------------------------------------------------------------------------------------------------------+
- a. Check logs under container /opt/app/VESCollector/logs/collector.log for errors
-
- b. If no active feed, you can simulate an event into collector via curl
- curl -i -X POST -d @<sampleves> --header "Content-Type:application/json" http://localhost:8080/eventListener/v5 -k
+ 
- c. Topic configuration are pre-set into this container. When valid DMAAP instance ip was provided and VES events are received, the collector will post to MEASUREMENT and FAULT Topics.
- Fault - http://<dmaaphost>:3904/events/unauthenticated.SEC\_FAULT\_OUTPUT
- Measurement - http://<dmaaphost>:3904/events/unauthenticated.SEC\_MEASUREMENT\_OUTPUT
+This script was invoked via VM init script (rc.d).
-VM INIT
----------------
-To address windriver server in-stability, the following init.sh script was used to start the container on VM restart.
+ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
-::
- #!/bin/sh
- sudo docker ps \| grep "vescollector"
- if [ $? -ne 0 ]; then
- sudo docker login -u docker -p docker nexus.onap.org:10001
- sudo docker pull
- nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
- sudo docker rm -f vescollector
- echo "Collector process not running - $(date)" >>
- /home/ubuntu/startuplog
- sudo docker run -d --name vescollector -p 8080:8080/tcp -p
- 8443:8443/tcp -P -e DMAAPHOST='10.12.25.96'
- nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.1
- else
- echo "Collector process running - $(date)" >>/home/ubuntu/startuplog
- fi
+sudo  update-rc.d init.sh start 2
-::
- ln -s /home/ubuntu/init.sh /etc/init.d/init.sh
- sudo update-rc.d init.sh start 2