| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| elinuxhenrik | 7f93fb6 | 2020-04-08 17:02:40 +0200 | [diff] [blame] | 3 | .. Copyright (C) 2020 Nordix |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 4 | |
| elinuxhenrik | 0d27184 | 2020-10-19 10:17:28 +0200 | [diff] [blame] | 5 | .. _api_docs: |
| 6 | |
| 7 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 8 | ======== |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 9 | API-Docs |
| 10 | ======== |
| 11 | |
| 12 | This is the API-docs of Non-RT RIC. |
| 13 | |
| 14 | .. contents:: |
| 15 | :depth: 3 |
| 16 | :local: |
| 17 | |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 18 | The Non-RT RIC consists of three parts, described in the sections below: |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 19 | * The Policy Agent |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 20 | * The SDNC A1 Controller |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 21 | * The rAPP Catalogue |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 22 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 23 | |
| 24 | Policy Agent |
| 25 | ============ |
| elinuxhenrik | c7a0d73 | 2020-02-04 14:49:59 +0100 | [diff] [blame] | 26 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 27 | The Policy Agent provides common functionality useful for R-Apps, for instance: |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 28 | * A repository of available Near-RT RICs, their policy types and policy instances. |
| 29 | * An A1 connection to the Near-RT RICs. |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 30 | |
| elinuxhenrik | e0fab9a | 2020-03-31 17:59:49 +0200 | [diff] [blame] | 31 | See :ref:`policy-agent-api` for how to use the API. |
| 32 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 33 | See the README.md file in the nonrtric/policy-agent repo for info about how to use it. |
| 34 | |
| elinuxhenrik | c7a0d73 | 2020-02-04 14:49:59 +0100 | [diff] [blame] | 35 | API Functions |
| 36 | ------------- |
| PatrikBuhr | 1b8d76d | 2020-01-30 16:10:19 +0100 | [diff] [blame] | 37 | See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 38 | |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 39 | SDNC A1 Controller |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 40 | ================== |
| elinuxhenrik | c7a0d73 | 2020-02-04 14:49:59 +0100 | [diff] [blame] | 41 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 42 | An ONAP SDNC Controller for the A1 interface. |
| 43 | |
| elinuxhenrik | 7f93fb6 | 2020-04-08 17:02:40 +0200 | [diff] [blame] | 44 | See :ref:`sdnc-a1-controller-api` for how to use the API. |
| 45 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 46 | See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. |
| 47 | |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 48 | rAPP Catalogue |
| 49 | ============== |
| 50 | |
| 51 | The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. |
| 52 | |
| 53 | See `RAC API <./rac-api.html>`_ for how to use the API. |
| 54 | |
| 55 | .. |swagger-icon| image:: ./images/swagger.png |
| 56 | :width: 40px |
| 57 | |
| 58 | .. |yaml-icon| image:: ./images/yaml_logo.png |
| 59 | :width: 40px |
| 60 | |
| 61 | |
| 62 | .. csv-table:: |
| 63 | :header: "API name", "|swagger-icon|", "|yaml-icon|" |
| 64 | :widths: 10,5, 5 |
| 65 | |
| 66 | "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" |
| 67 | |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 68 | Complementary tools |
| 69 | =================== |
| 70 | |
| maximesson | f217fff | 2020-04-09 15:16:04 +0200 | [diff] [blame] | 71 | 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. |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 72 | |
| maximesson | f217fff | 2020-04-09 15:16:04 +0200 | [diff] [blame] | 73 | The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC. |
| elinuxhenrik | 0a4c38b | 2020-04-14 10:59:36 +0200 | [diff] [blame] | 74 | Documentation for the Control Panel can be found here: |
| 75 | :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`. |
| 76 | It can be downloaded from here: :: |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 77 | |
| elinuxhenrik | 0a4c38b | 2020-04-14 10:59:36 +0200 | [diff] [blame] | 78 | git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". |
| 79 | |
| 80 | The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found |
| 81 | here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: :: |
| 82 | |
| 83 | git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" |