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