e2sim/previous/e2apv1sim/e2sim/README.md

   1 #/*****************************************************************************
   2 #                                                                            *
   3 # Copyright 2019 AT&T Intellectual Property                                  *
   4 # Copyright 2019 Nokia                                                       *
   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 #                                                                            *
  18 #******************************************************************************/
  19
  20 This is an update to E2 Simulator, based on E2AP v1.
  21
  22
  23
  24 # INSTALLATION (tested on Ubuntu 16.04)
  25   1. Install dependencies
  26     $ sudo apt-get update
  27     $ sudo apt-get install -y
  28         build-essential
  29         git
  30         cmake
  31         libsctp-dev
  32         lksctp-tools
  33         autoconf
  34         automake
  35         libtool
  36         bison
  37         flex
  38         libboost-all-dev
  39     $ sudo apt-get clean
  40
  41   2. SET ENVIRONMENT VARIABLE
  42     Add this line to `~/.bashrc`
  43       export E2SIM_DIR=<your e2sim directory>
  44
  45   3. Build the official e2sim
  46     $ ./build_e2sim
  47
  48 # USAGE
  49   $  $E2SIM_DIR/build/e2sim [SERVER IP] [PORT]
  50
  51   By default, SERVER IP = 127.0.0.1, PORT = 36421
  52   The RIC (i.e., E2 Manager) will need to setup X2 or E2 connection to e2sim on
  53   this SERVER IP and PORT
  54
  55 # DOCKER
  56   * Build docker image: run this command from $E2SIM_DIR
  57   $ sudo docker build -f docker/Dockerfile -t [DOCKER_IMAGE]:[TAG] .
  58
  59   * Example how to run docker container
  60   $ sudo docker run --rm --net host -it [DOCKER_IMAGE]:[TAG] sh -c "./build/e2sim [SERVER IP] [PORT]"
  61   ex: sudo docker run --rm --net host -it e2sim:1.0.0 sh -c "./build/e2sim 127.0.0.1 36422"
  62