X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=6892d1514c818180246673617fcc8b7e520cf810;hb=refs%2Fchanges%2F09%2F7209%2F3;hp=06f01b755ca901bee80717fb675e3c544baa24b6;hpb=bbc9028aa34ae48e7806596cd05fbe7a5bfd7fb8;p=ric-plt%2Fxapp-frame-py.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 06f01b7..6892d15 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,9 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2020 AT&T Intellectual Property Developer Guide =============== +This document explains how to maintain the RIC Xapp framework. +Information for users of this framework (i.e., Xapp developers) is in the User Guide. + Tech Stack ---------- @@ -13,6 +17,7 @@ these packages provided by the O-RAN-SC project and third parties: * msgpack * mdclogpy * ricsdl +* protobuf Version bumping the framework @@ -34,6 +39,15 @@ These items in this repo must be kept in sync with the RMR version: #. ``rmr-version.yaml`` controls what version of RMR is installed for unit testing in Jenkins CI +Registration/Deregistartion of Xapp +----------------------------------- + +For registration and deregistration of Xapp following items need to be defined: + +#. CONFIG_FILE_PATH variable as a environment variable in Dockerfile if running + Xapp as a docker container or in configmap in case of Xapp as a pod. +#. Copy the xappConfig.json into the docker image in Dockerfile. + Unit Testing ------------