docs/api-docs.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2020 Nordix
   4
   5 ========
   6 API-Docs
   7 ========
   8
   9 This is the API-docs of Non-RT RIC.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15 The Non-RT RIC consists of two parts, described in the sections below:
  16  * The Policy Agent
  17  * The SDNC A1 Controller
  18
  19
  20 Policy Agent
  21 ============
  22
  23 The Policy Agent provides common functionality useful for R-Apps, for instance:
  24  * A repository of available Near-RT RICs, their policy types and policy instances.
  25  * An A1 connection to the Near-RT RICs.
  26
  27 See :ref:`policy-agent-api` for how to use the API.
  28
  29 See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
  30
  31 API Functions
  32 -------------
  33 See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
  34
  35 SDNC A1 Controller
  36 ==================
  37
  38 An ONAP SDNC Controller for the A1 interface.
  39
  40 See :ref:`sdnc-a1-controller-api` for how to use the API.
  41
  42 See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
  43
  44 Complementary tools
  45 ===================
  46
  47 There are two additional tools that can be used together with the Non-RT RIC, namely the Control Panel and the Near-RT RIC simulator.
  48
  49 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
  50 Documentation for the Control Panel can be found here:
  51 :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
  52 It can be downloaded from here: ::
  53
  54   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
  55
  56 The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
  57 here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
  58
  59   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"