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) 2020 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 for development
  16 =======================================
  17
  18 To run the Control Panel locally for development with simulated services, follow these steps:
  19
  20 - Fetch the latest code from `gerrit`_
  21
  22 .. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel
  23
  24 - Start the backend:
  25
  26     cd webapp-backend
  27
  28     mvn clean install
  29
  30     mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=MockControlPanelBackEnd -DfailIfNoTests=false test
  31
  32
  33 - Now you can open URL:  `localhost:8080`_ in a browser to access the backend directly.
  34
  35 .. _localhost:8080: http://localhost:8080
  36
  37 Start the frontend:
  38
  39     cd webapp-frontend
  40
  41     ./ng serve --proxy-config proxy.conf.json
  42
  43 - Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
  44
  45 .. _localhost:4200: http://localhost:4200
  46
  47 From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each
  48 existing policy type.
  49
  50 When the instances are listed, it is possible to edit or delete each instance from the expanded view.
  51
  52 .. image:: ./images/non-RT_RIC_controlpanel.png
  53
  54
  55 End-to-end call
  56 ===============
  57
  58 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  59
  60 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166