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 frontend:
  25
  26     cd webapp-frontend
  27
  28     To start the frontend with Mock data:
  29
  30     npm run start:mock
  31
  32     To start the UI:
  33
  34     You need to start the ControlPanel API Gateway, Policy Management Service & EI Service for the UI to list policy & EI information
  35
  36     ./ng serve --proxy-config proxy.conf.json
  37
  38     OR
  39
  40     npm start
  41
  42 - Now you can open URL:  `localhost:4200`_ in a browser to access the Control Panel.
  43
  44 .. _localhost:4200: http://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