Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / ric-plt / rtmgr / 871fa393844ce1b61b8d5218d27687d9fc05803a
commit871fa393844ce1b61b8d5218d27687d9fc05803a[log] [tgz]
authorBalint Uveges <balint.uveges@nokia.com>Tue Apr 02 20:31:11 2019 +0000
committerBalint Uveges <balint.uveges@nokia.com>Tue Apr 02 20:38:54 2019 +0000
tree47ce6352f6121493f13391f56c60d7753326f384
parent3b790149556c8d8f3a3701c0e3c4a56e56e078d1 [diff]
Seed code for Routing Manager (ric-plt/rtmgr).

Change-Id: I2f255043d81564550ea9bbc5f3d082346910eb0d
Signed-off-by: Balint Uveges <balint.uveges@nokia.com>
43 files changed
tree: 47ce6352f6121493f13391f56c60d7753326f384
  1. api/
  2. build/
  3. cmd/
  4. manifests/
  5. pkg/
  6. test/
  7. .gitignore
  8. build.sh
  9. CONTRIBUTING.md
  10. LICENSE
  11. README.md
  12. RELNOTES
README.md

Routing Manager

Table of contents

Introduction

Routing Manager is a basic platform serive of RIC. It is responsible for distributing routing policies among the other platform components and xApps.

The implemented logic periodically queries the xApp Manager component for xApps' list. Stores the data then processes it to create routing policies and distributes them to all xApps. The architecture consists of the following five well defined functions:

  • NorthBound Interface (NBI): Maintains the communication channels towards RIC manager components
  • Routing Policy Engine (RPE): Provides the logic to calculate routing policies
  • Shared Data Layer (SDL): Provides access to different kind persistent data stores
  • SouthBound Interface (SBI): Maintains the communication channels towards RIC tenants and control components
  • Controll Logic (RTMGR): Controls the operatin of above functions

Current implementation provides support for the followings:

  • NBI:
    • httpGet: simple HTTP GET interface. Expects an URL where it gets the xApps' list in JSON format
    • (WIP) httRESTful: provides REST API endpoints towards RIC manager components
  • RPE:
    • rmr: creates routing policies formatted for RIC RMR
  • SDL:
    • file: stores xApp data in container's local filesystem (or in a mountpoint)
    • (backlog) sdl: Shared Data Library to Redis database
  • SBI:
    • nngpub: distributes RPE created policies via NNG Pub channel
    • (WIP) nngpipe: distributes RPE created policies via NNG Pipeline channel

Release notes

Check the separated RELNOTES file.

Prerequisites

  • Healthy kubernetes cluster
  • Access to the common docker registry

Project folder structure

  • /api: contains swagger source files
  • /build: contains build tools (scripts, Dockerfiles, etc.)
  • /manifest: contains deployment files (kubernetes manifests, helm chart)
  • /cmd: contains go project's main file
  • /pkg: contains go project's internal packages
  • /test: contains CI/CD testing files (scripts, mocks, manifests)

Installation guide

Compiling code

Enter the project root and execute ./build.sh script. The build script has two main phases. First is the code compilation, where it creates a temporary container for downloading all dependencies then compiles the code. In the second phase it builds the production ready container and taggs it to rtmgr:builder NOTE: The script puts a copy of the binary into the ./bin folder for further use cases

Installing Routing Manager

Preparing environment

Re-Tag the rtmgr container according to the project release and push it to a registry accessible from all minions of the kubernetes cluster. Edit the container image section of rtmgr-dep.yaml file according to the rtmgr image tag

Deploying Routing Manager

Issue the kubectl create -f {manifest.yaml} command in the following order

  1. manifests/namespaces.yaml: creates the example namespace for routing-manager resources
  2. manifests/rtmgr/rtmgr-dep.yaml: instantiates the rtmgr deployment in the example namespace
  3. manifests/rtmgr/rtmgr-svc.yaml: creates the rtmgr service in example namespace

Testing and Troubleshoting

Routing Manager's behaviour can be tested using the mocked xApp Manager, traffic generator xApp and receiver xApp.

  1. Checkout and compile both xApp receiver and xApp Tx generator of RIC admission control project
  2. Copy the adm-ctrl-xapp binary to ./test/docker/xapp.build folder. Enter the folder and issue docker build .. Tag the recently created docker image and push it to the common registry.
  3. Copy the test-tx binary to ./test/docker/xapp-tx.build folder. Enter the folder and issue docker build .. Tag the recently created docker image and push it to the common registry.
  4. Enter the ./test/docker/xmgr.build folder and issue docker build .. Tag the recently created docker image and push it to the common registry.
  5. Modify the the docker image version in each kuberbetes manifest files under ./test/kubernetes/ folder accordingly then issue the kubectl create -f {manifest.yaml} on each file.
  6. Compile and Install routing manager

Command line arguments

Routing manager binary can be called with -h flag when it displays the available command line arguments and it's default value.

Example:

root@a3684ff4cdb0:/# ./rtmgr -h
Usage of ./rtmgr:
  -loglevel string
        INFO | WARN | ERROR | DEBUG (default "INFO")
  -nbi-httpget string
        xApp Manager URL (default "http://localhost:3000/xapps")
  -rpe string
        Policy Engine Module name (default "rmr")
  -sbi-nngsub string
        NNG Subsciption Socket URI (default "tcp://0.0.0.0:4560")
  -sdl-file string
        Local file store location (default "/db/rt.json")

For troubleshooting purpose the default logging level can be increased to DEBUG.

Upcoming changes

[] Add RESTful NBI based on swagger api definition

[] Support RMR Pipeline

[] Add unit tests

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE