Ron Shacham | e7dfeb8 | 2020-04-24 14:46:48 -0400 | [diff] [blame] | 1 | |
| 2 | ================================================================================== |
Ron Shacham | e7dfeb8 | 2020-04-24 14:46:48 -0400 | [diff] [blame] | 3 | Copyright (c) 2020 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 | |
E. Scott Daniels | f7b69b8 | 2020-04-28 14:17:08 -0400 | [diff] [blame] | 18 | Traffic Steering |
Ron Shacham | 394029b | 2020-06-02 13:48:42 -0400 | [diff] [blame] | 19 | ================ |
Ron Shacham | e7dfeb8 | 2020-04-24 14:46:48 -0400 | [diff] [blame] | 20 | |
E. Scott Daniels | f7b69b8 | 2020-04-28 14:17:08 -0400 | [diff] [blame] | 21 | This repository contains the source for the RIC traffic steering application. |
Ron Shacham | 394029b | 2020-06-02 13:48:42 -0400 | [diff] [blame] | 22 | |
Alexandre Huff | b86721b | 2021-05-28 13:32:02 -0300 | [diff] [blame^] | 23 | This xApp can be onboarded through the xApp Onboarder. The xapp descriptor |
Ron Shacham | 394029b | 2020-06-02 13:48:42 -0400 | [diff] [blame] | 24 | is under the xapp-descriptor/ directory. |
| 25 | |
| 26 | Then the xapp can be deployed through the App Manager. |
| 27 | |
| 28 | In order for Traffic Steering xApp to carry out the Traffic Steering Use Case, |
| 29 | the following needs to be done: |
| 30 | * QP xApp needs to be onboarded and deployed (see xapp descriptor in that repo) |
| 31 | * QP Driver xApp needs to be onboarded and deployed (see xapp descriptor in that repo) |
Alexandre Huff | b86721b | 2021-05-28 13:32:02 -0300 | [diff] [blame^] | 32 | * SDL must contain network data which required by the QP Driver xApp |
Ron Shacham | 394029b | 2020-06-02 13:48:42 -0400 | [diff] [blame] | 33 | |
| 34 | Mock network data |
| 35 | ================= |
| 36 | |
Alexandre Huff | b86721b | 2021-05-28 13:32:02 -0300 | [diff] [blame^] | 37 | KPIMON xApp is in charge of collecting RAN metrics and write to SDL. |
Ron Shacham | 394029b | 2020-06-02 13:48:42 -0400 | [diff] [blame] | 38 | |
Alexandre Huff | b86721b | 2021-05-28 13:32:02 -0300 | [diff] [blame^] | 39 | However, the Traffic Steering Use Case can be run with mock data. Everything needed to write this |
Ron Shacham | 394029b | 2020-06-02 13:48:42 -0400 | [diff] [blame] | 40 | mock data is included in this repo. Directions are as follows: |
| 41 | |
| 42 | cd test/populatedb |
| 43 | |
| 44 | chmod a+x populate_db.sh |
| 45 | |
| 46 | ./populate_db.sh |
| 47 | |
| 48 | This script will build a docker image locally and also install a helm chart in the kubernetes cluster to run the image. |
| 49 | |
| 50 | The code that is run will write the necessary data to SDL |
| 51 | |
Alexandre Huff | b86721b | 2021-05-28 13:32:02 -0300 | [diff] [blame^] | 52 | Mock applications (Release D) |
| 53 | ============================= |
| 54 | |
| 55 | There are sample applications in the test/app/ directory that demonstrate a dummy message exchange |
| 56 | among AD, QP Driver, QP, and TS xApps. Currently, there is no Dockerfile to run those mock applications, |
| 57 | but they can be built according to the following: |
| 58 | |
| 59 | 1. Build the TS xApp |
| 60 | 2. $cd test/app/ |
| 61 | 3. $cmake -S . -B build |
| 62 | 4. $cd build/ |
| 63 | 5. $make |
| 64 | |
| 65 | Run xApps in the following order: |
| 66 | 1. TS xApp |
| 67 | 2. qp_xapp |
| 68 | 3. ad_xapp |
| 69 | |
| 70 | There is an additional application that mocks a Rest server to demonstrate all control messages |
| 71 | issued by the TS xApp. It is implemented in Python and echoes all messages it receives. This |
| 72 | application is located at the test/app directory. |