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 Additionally, producers and jobs for the Enrichment Information coordinator service can be viewed and managed.
  14
  15 See the README.md file in the nonrtric-controlpanel repo for information about how to use it.
  16
  17 Start the Control Panel for development
  18 ---------------------------------------
  19
  20 To run the Control Panel locally for development with simulated services, follow these steps:
  21
  22 - Fetch the latest code from `gerrit`_
  23
  24 .. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel
  25
  26 - Start the frontend:
  27
  28     +------------------------------+
  29     | cd webapp-frontend           |
  30     +------------------------------+
  31
  32     - To start the frontend with Mock data:
  33
  34         +------------------------------+
  35         | npm run start:mock           |
  36         +------------------------------+
  37
  38     - To start the UI:
  39
  40         - You need to start the ControlPanel API Gateway, Policy Management Service & EI Service for the UI to list policy & EI information
  41
  42         +---------------------------------------------------+
  43         | ./ng serve --proxy-config proxy.conf.json         |
  44         +---------------------------------------------------+
  45
  46         OR
  47
  48         +---------------------+
  49         | npm start           |
  50         +---------------------+
  51
  52     - Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
  53
  54     .. _localhost:4200: http://localhost:4200
  55
  56 From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each
  57 existing policy type.
  58
  59 When the instances are listed, it is possible to edit or delete each instance from the expanded view.
  60
  61 .. image:: ./images/non-RT_RIC_controlpanel_Policy.PNG
  62
  63 In order to view producers and jobs from the EI service, from the main page, click on the "Enrichment information coordinator" card or use the menu on the left hand side of the page.
  64
  65 .. image:: ./images/non-RT_RIC_controlpanel_EI.PNG
  66
  67 End-to-end call
  68 ---------------
  69
  70 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  71
  72 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=34963461