| 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 | |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 7 | .. |swagger-icon| image:: ./images/swagger.png |
| 8 | :width: 40px |
| 9 | |
| 10 | .. |yaml-icon| image:: ./images/yaml_logo.png |
| 11 | :width: 40px |
| 12 | |
| elinuxhenrik | 0d27184 | 2020-10-19 10:17:28 +0200 | [diff] [blame] | 13 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 14 | ======== |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 15 | API-Docs |
| 16 | ======== |
| 17 | |
| 18 | This is the API-docs of Non-RT RIC. |
| 19 | |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 20 | The Non-RT RIC consists of three parts, described in the sections below: |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 21 | * The Policy Agent |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 22 | * The Enrichment Coordinator Service |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 23 | * The rAPP Catalogue |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 24 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 25 | |
| 26 | Policy Agent |
| 27 | ============ |
| elinuxhenrik | c7a0d73 | 2020-02-04 14:49:59 +0100 | [diff] [blame] | 28 | |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 29 | For information about the The Policy Agent that is implemented in ONAP, see `readthedocs`_ and `wiki`_. |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 30 | |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 31 | .. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html |
| 32 | .. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984 |
| elinuxhenrik | e0fab9a | 2020-03-31 17:59:49 +0200 | [diff] [blame] | 33 | |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 34 | Enrichment Coordinator Service |
| 35 | ============================== |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 36 | |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 37 | See `ECS API <./ecs-api.html>`_ for how to use the API. |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 38 | |
| elinuxhenrik | 6208ce8 | 2020-11-18 15:15:07 +0100 | [diff] [blame] | 39 | .. csv-table:: |
| elinuxhenrik | 7a09fbb | 2020-12-04 16:51:19 +0100 | [diff] [blame^] | 40 | :header: "API name", "|swagger-icon|", "|yaml-icon|" |
| 41 | :widths: 10,5,5 |
| elinuxhenrik | c7a0d73 | 2020-02-04 14:49:59 +0100 | [diff] [blame] | 42 | |
| elinuxhenrik | 7a09fbb | 2020-12-04 16:51:19 +0100 | [diff] [blame^] | 43 | "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`" |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 44 | |
| elinuxhenrik | 0c44286 | 2020-01-31 11:27:50 +0100 | [diff] [blame] | 45 | |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 46 | rAPP Catalogue |
| 47 | ============== |
| 48 | |
| 49 | The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover. |
| 50 | |
| 51 | See `RAC API <./rac-api.html>`_ for how to use the API. |
| 52 | |
| elinuxhenrik | 5ada515 | 2020-10-19 10:39:59 +0200 | [diff] [blame] | 53 | |
| 54 | .. csv-table:: |
| 55 | :header: "API name", "|swagger-icon|", "|yaml-icon|" |
| 56 | :widths: 10,5, 5 |
| 57 | |
| 58 | "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`" |
| 59 | |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 60 | Complementary tools |
| 61 | =================== |
| 62 | |
| maximesson | f217fff | 2020-04-09 15:16:04 +0200 | [diff] [blame] | 63 | 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] | 64 | |
| maximesson | f217fff | 2020-04-09 15:16:04 +0200 | [diff] [blame] | 65 | 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] | 66 | Documentation for the Control Panel can be found here: |
| 67 | :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`. |
| 68 | It can be downloaded from here: :: |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 69 | |
| elinuxhenrik | 0a4c38b | 2020-04-14 10:59:36 +0200 | [diff] [blame] | 70 | git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel". |
| 71 | |
| 72 | The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found |
| 73 | here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: :: |
| 74 | |
| 75 | git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface" |