docs/developer-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2021 Nordix
   4
   5 Developer Guide
   6 ===============
   7
   8 This document provides a quickstart for developers of the Non-RT RIC Control Panel.
   9
  10 The Non-RT RIC Control Panel is an interface that allows human users to create, edit and delete policy instances, for
  11 each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC.
  12
  13 See the *README.md* file in the nonrtric-controlpanel repo for info about how to use it.
  14
  15 Start the Control Panel
  16 =======================
  17
  18 To run the Control Panel locally for development with simulated services, follow these steps:
  19
  20 Fetch the code
  21 --------------
  22
  23 Fetch the latest code from `gerrit (nonrtric-controlpanel) <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_
  24
  25 Start the backend
  26 -----------------
  27
  28 ::
  29
  30     cd webapp-backend
  31     mvn clean install
  32     mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=MockControlPanelBackEnd -DfailIfNoTests=false test
  33
  34
  35 Now you can open URL:  `localhost:8080`_ in a browser to access the backend directly.
  36
  37 .. _localhost:8080: http://localhost:8080
  38
  39 Start the frontend
  40 ------------------
  41
  42 ::
  43
  44     cd webapp-frontend
  45     ./ng serve --proxy-config proxy.conf.json
  46
  47
  48 Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
  49
  50 .. _localhost:4200: http://localhost:4200
  51
  52 From the main page, click on the **Policy Control** card. From here, it is possible to create or list instances for each
  53 existing policy type.
  54
  55 When the instances are listed, it is possible to edit or delete each instance from the expanded view.
  56
  57 .. image:: ./images/non-RT_RIC_controlpanel.png
  58
  59
  60 End-to-end call
  61 ===============
  62
  63 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  64
  65 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878049