veslibrary/README

   1  #
   2  # ============LICENSE_START==========================================
   3  # ===================================================================
   4  # Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   5  # ===================================================================
   6  # Licensed under the Apache License, Version 2.0 (the "License");
   7  # you may not use this file except in compliance with the License.
   8  # You may obtain a copy of the License at
   9  #
  10  #        http://www.apache.org/licenses/LICENSE-2.0
  11  #
  12  # Unless required by applicable law or agreed to in writing, software
  13  # distributed under the License is distributed on an "AS IS" BASIS,
  14  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  # See the License for the specific language governing permissions and
  16  # limitations under the License.
  17  # ============LICENSE_END============================================
  18  #
  19  # ECOMP and OpenECOMP are trademarks
  20  # and service marks of AT&T Intellectual Property.
  21  #
  22  #
  23
  24 For support queries reach out to Gokul Singaraju gs244f@att.com
  25
  26 VES Library is opensourced library provided for Virtual Event Streaming Agent
  27 development.
  28
  29 The VES Library provides standard API for Data collector agents
  30 to interface with DCAE. This VES Library supports 5.x version of API.
  31    The Vendor related documentation is provided in
  32          https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition
  33    VES preliminary documentation is under
  34          https://wiki.opnfv.org/display/ves/VES+Home
  35
  36
  37 To compile C Library
  38    C compiler would be needed for Linux and Windows.
  39
  40   Ubuntu platform dependencies are
  41               sudo apt-get install update
  42               sudo apt-get install upgrade
  43               sudo apt-get install build-essential
  44   For Redhat/CentOS it would be
  45               sudo yum groupinstall "Development Tools"
  46
  47   Compile:
  48               cd veslibrary/ves_clibrary/evel/evel-library/bldjobs;make clean;make all
  49   Install VES Library:
  50               cd veslibrary/ves_clibrary/evel/evel-library/bldjobs;make install
  51
  52 For Running the VES Agent
  53       pthread, curl and libcurl3 packages will neeed to be installed
  54     Sample agents Firewall (vFW) and Loadbalancer (vLB) are provided as development examples
  55     Modify per your agent requirements
  56      Reporting DCAE/VES collector ip and port also need to be setup
  57
  58
  59 To compile Java library
  60
  61   On Windows
  62    Load the Maven project into Eclipse
  63     Select evel_javalib2 project Right click
  64       Select Maven > Download Sources
  65       Select Maven > Update Project
  66    then
  67     Select pom.xml Right click > Run As > Maven Clean
  68     Select pom.xml Right click > Run As > Maven Build
  69    to compile and build the jar
  70
  71   On Ubuntu platform dependencies are
  72    sudo apt-get install openjdk-8-jre
  73    sudo apt-get install openjdk-8-jdk
  74
  75   Maven build utility
  76    sudo apt-get install mvn
  77
  78   On Redhat/Centos
  79    sudo yum install java-1.8.0-openjdk
  80    sudo yum install java-1.8.0-openjdk-devel
  81
  82   Maven
  83    sudo yum install maven2
  84
  85   Compile library:
  86    cd  veslibrary/ves_javalibrary/evel_javalib2;mvn clean install
  87
  88
  89   Copy the evel_javalib2-0.0.1-SNAPSHOT.jar into directory
  90
  91   Dependent classpath jars that are needed to compile and Run
  92    log4j-1.2.17.jar
  93    javax.json-api-1.1.jar
  94    slf4j-api-1.7.5.jar
  95    slf4j-log4j12-1.7.5.jar
  96    javax.json-1.0.4.jar
  97
  98   Sample Agent application is at src_test/maindir/Main.java
  99      mkdir ./evel_javalibrary/att/com/maindir
 100      copy the agent code into this directory and modify per your agent requirements
 101      Reporting DCAE/VES collector ip and port also need to be setup
 102
 103
 104   Compile Sample VES agent
 105    javac -cp <.:dependent jars> ./evel_javalibrary/att/com/maindir
 106   Run VES agent
 107    java -cp <.:dependent jars> evel_javalibrary.att.com.maindir.Main
 108
 109