docs/docs_5g_a1_adaptor.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _docs_5g_a1_adaptor:
   5
   6 5G - A1 Adaptor
   7 ---------------
   8
   9 Description
  10 ~~~~~~~~~~~
  11
  12 A1 is an O-RAN defined interface between Non-Real Time RIC (Ran Intelligent Controller) in the management platform (ONAP) and RAN network element called Near-Real Time RIC.
  13 A1 interface is used to communicate policy choices, AI/ML model updates, and other RAN functions that are not included in the traditional network configuration.
  14 O-RAN defines architecture of RT RIC and relevant interfaces.
  15 O-RAN WG2 has released the first version of A1 specifications September 2019.
  16 ONAP needed to implement a module serving a communication channel between other ONAP components and RT RIC for A1 interface.
  17 ONAP community has a harmonization project with mobility standard and A1 adaptor has been proposed in the project (https://wiki.onap.org/display/DW/MOBILITY+STANDARDS+HARMONIZATION+WITH+ONAP).
  18 A1 adaptor has been implemented as a component in CCSDK. All implementation details are explained here: https://wiki.onap.org/display/DW/A1+Adapter+in+ONAP
  19
  20 How to Use
  21 ~~~~~~~~~~
  22
  23 Following steps describe a general procedure about how to use A1 adaptor.
  24
  25 1. ONAP Frankfurt includes A1 adaptor.
  26
  27 2. Edit A1 adaptor property file in sdnc container at dev-sdnc-x POD. (dev is an example of release name and x is replica number)
  28
  29    a. A property file is located at /opt/onap/ccsdk/data/properties/a1-adapter-api-dg.properties.
  30
  31    b. SSH into a rancher node (NFS/rancher).
  32
  33    c. sudo su
  34
  35    d. kubectl get pods -n onap -o wide | grep sdnc
  36
  37    e. execute the following command to all sdnc PODs to update properties files.
  38
  39       - kubectl exec -it dev-sdnc-x bash (x=0,1,2, depending on number of sdnc replicas in the setup)
  40
  41    f. Once in the docker, edit the properties file.
  42
  43    g. Make following configuration changes per setup
  44
  45       - Update IP address and port number for Near-Real Time RIC as below
  46
  47       - near-rt-ric-id=a.b.c.d:port
  48
  49 A1 adaptor has been tested with A1 mediator as an example of Near-Real Time RIC. Detailed information can be found at its repo: https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt%2Fric-dep.git;a=shortlog;h=refs%2Fheads%2Fmaster.
  50
  51 Test Status and Plans
  52 ~~~~~~~~~~~~~~~~~~~~~
  53
  54 For ONAP Frankfurt, A1 adaptor has not been involved in a full closed loop use case. A1 adaptor has gone through a unit test with A1 mediator in OSC as a underlying device. It has been tested for receiving A1 policy via DMaaP and publishing a response back to DMaaP as well as notification. More details are presented in https://wiki.onap.org/pages/viewpage.action?pageId=71837463.