README.md

   1 #==================================================================================
   2
   3 #        Copyright (c) 2018-2019 AT&T Intellectual Property.
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 #==================================================================================
  17
  18 This repo contains code related to the admission control xapp.
  19 Main source code for the xapp is under src/
  20
  21 Look at Dockerfile for building instructions
  22
  23
  24 NOTE : In order to compile code as a stand alone process, following pre-requisites are required
  25 -- For compilation, the nanomsg, nng and ric messaging libraries, as well as ric messaging header must be installed in standard paths (or if non-default, then visible in search paths)
  26
  27 -- mdclog library and headers must be installed and available in search path
  28
  29 NOTE:
  30 In order to test the code,
  31
  32 -- An E2 termination must be available
  33
  34 -- A ves collector which collects metrics must be available
  35
  36 The run_xapp.sh script provides a convenient way to set the various parameters and invoke the process (if not running in a docker container)