Upadated Xappframework for Xapp registration/deregistration to RIC

[ric-plt/xapp-frame-py.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 06f01b7..dc03c77 100644 (file)
--- 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
 ----------
 
@@ -34,6 +38,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
 ------------