--- /dev/null
+# Routing Manager\r
+\r
+## Table of contents\r
+* [Introduction](#introduction)\r
+* [Release notes](#release-notes)\r
+* [Prerequisites](#prerequisites)\r
+* [Project folders structure](#project-folders-structure)\r
+* [Installation guide](#installation-guide)\r
+ * [Compiling code](#compiling-code)\r
+ * [Building docker container](#building-docker-container)\r
+ * [Installing Routing Manager](#installing-routing-manager)\r
+ * [Testing and Troubleshoting](#testing-and-troubleshoting)\r
+* [Upcoming changes](#upcoming-changes)\r
+* [License](#license)\r
+\r
+## Introduction\r
+__Routing Manager__ is a basic platform serive of RIC. It is responsible for distributing routing policies among the other platform components and xApps.\r
+\r
+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.\r
+The architecture consists of the following five well defined functions:\r
+* NorthBound Interface (__NBI__): Maintains the communication channels towards RIC manager components \r
+* Routing Policy Engine (__RPE__): Provides the logic to calculate routing policies\r
+* Shared Data Layer (__SDL__): Provides access to different kind persistent data stores\r
+* SouthBound Interface (__SBI__): Maintains the communication channels towards RIC tenants and control components\r
+* Controll Logic (__RTMGR__): Controls the operatin of above functions\r
+\r
+Current implementation provides support for the followings:\r
+* NBI:\r
+ * __httpGet__: simple HTTP GET interface. Expects an URL where it gets the xApps' list in JSON format\r
+ * (WIP) __httRESTful__: provides REST API endpoints towards RIC manager components \r
+* RPE:\r
+ * __rmr__: creates routing policies formatted for RIC RMR\r
+* SDL:\r
+ * __file__: stores xApp data in container's local filesystem (or in a mountpoint)\r
+ * (backlog) __sdl__: Shared Data Library to Redis database\r
+* SBI:\r
+ * __nngpub__: distributes RPE created policies via NNG Pub channel\r
+ * (WIP) __nngpipe__: distributes RPE created policies via NNG Pipeline channel\r
+\r
+## Release notes\r
+Check the separated `RELNOTES` file.\r
+\r
+## Prerequisites\r
+* Healthy kubernetes cluster\r
+* Access to the common docker registry\r
+\r
+## Project folder structure\r
+* /api: contains swagger source files\r
+* /build: contains build tools (scripts, Dockerfiles, etc.)\r
+* /manifest: contains deployment files (kubernetes manifests, helm chart)\r
+* /cmd: contains go project's main file\r
+* /pkg: contains go project's internal packages\r
+* /test: contains CI/CD testing files (scripts, mocks, manifests)\r
+\r
+## Installation guide\r
+\r
+### Compiling code\r
+Enter the project root and execute `./build.sh` script.\r
+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`\r
+**NOTE:** The script puts a copy of the binary into the `./bin` folder for further use cases\r
+\r
+### Installing Routing Manager\r
+#### Preparing environment\r
+Re-Tag the `rtmgr` container according to the project release and push it to a registry accessible from all minions of the kubernetes cluster.\r
+Edit the container image section of `rtmgr-dep.yaml` file according to the `rtmgr` image tag\r
+\r
+#### Deploying Routing Manager \r
+Issue the `kubectl create -f {manifest.yaml}` command in the following order\r
+ 1. `manifests/namespaces.yaml`: creates the `example` namespace for routing-manager resources\r
+ 2. `manifests/rtmgr/rtmgr-dep.yaml`: instantiates the `rtmgr` deployment in the `example` namespace\r
+ 3. `manifests/rtmgr/rtmgr-svc.yaml`: creates the `rtmgr` service in `example` namespace\r
+\r
+### Testing and Troubleshoting\r
+Routing Manager's behaviour can be tested using the mocked xApp Manager, traffic generator xApp and receiver xApp.\r
+\r
+ 1. Checkout and compile both xApp receiver and xApp Tx generator of RIC admission control project\r
+ 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.\r
+ 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.\r
+ 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.\r
+ 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.\r
+ 6. [Compile](#compiling-code) and [Install routing manager](#installing-routing-manager)\r
+\r
+#### Command line arguments\r
+Routing manager binary can be called with `-h` flag when it displays the available command line arguments and it's default value.\r
+\r
+Example:\r
+\r
+```bash\r
+root@a3684ff4cdb0:/# ./rtmgr -h\r
+Usage of ./rtmgr:\r
+ -loglevel string\r
+ INFO | WARN | ERROR | DEBUG (default "INFO")\r
+ -nbi-httpget string\r
+ xApp Manager URL (default "http://localhost:3000/xapps")\r
+ -rpe string\r
+ Policy Engine Module name (default "rmr")\r
+ -sbi-nngsub string\r
+ NNG Subsciption Socket URI (default "tcp://0.0.0.0:4560")\r
+ -sdl-file string\r
+ Local file store location (default "/db/rt.json")\r
+```\r
+\r
+For troubleshooting purpose the default logging level can be increased to `DEBUG`.\r
+\r
+## Upcoming changes\r
+[] Add RESTful NBI based on swagger api definition\r
+\r
+[] Support RMR Pipeline\r
+\r
+[] Add unit tests\r
+\r
+## License\r
+This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE)\r
+\r
Code Review / ric-plt / rtmgr.git / blobdiff