ricsdl-package/README.md

   1 RIC SDL
   2 =======
   3
   4 Shared Data Layer in the RAN Intelligent Controller
   5
   6 Shared Data Layer (SDL) provides a lightweight, high-speed interface for
   7 accessing shared data storage. The purpose is to enable utilizing clients to
   8 become stateless, conforming with, e.g., the requirements of the fifth
   9 generation mobile networks.
  10
  11
  12 Concepts
  13 --------
  14
  15 Namespace
  16
  17 Namespaces provide data isolation within SDL data storage. That is, data in
  18 certain namespace is isolated from the data in other namespaces. Each SDL
  19 client uses one or more namespaces. Namespaces can be used, for example, to
  20 isolate data belonging to different use cases.
  21
  22 Keys and Data
  23
  24 Clients save key-data pairs. Data is passed as a `bytes` type. SDL stores the
  25 data as it is. Any structure that this data may have (e.g. a data structure
  26 serialized by `pickle`) is meaningful only to the client itself. Clients are
  27 responsible for managing the keys. As namespaces provide data isolation,
  28 keys in different namespaces always access different data.
  29
  30 Backend Data Storage
  31
  32 Backend data storage refers to data storage technology behind SDL API, which
  33 handles the actual data storing. SDL API hides the backend data storage
  34 implementation from SDL API clients, and therefore backend data storage
  35 technology can be changed without affecting SDL API clients. Currently, Redis
  36 database is used as a backend data storage solution.
  37
  38 Notifications
  39
  40 Notifications functionality provide SDL clients the possibility to receive
  41 notifications about data changes in SDL namespaces. SDL client receiving
  42 notifications about data changes is referred to as "subscriber", while the SDL
  43 client modifying data and publishing notifications is referred to as
  44 "publisher".
  45
  46 Install
  47 -------
  48
  49 Install from PyPi
  50
  51 ```
  52 python3 -m pip install ricsdl
  53 ```
  54
  55 Install using the source
  56
  57 ```
  58 python3 setup.py install
  59 ```
  60
  61
  62 Usage
  63 -----
  64
  65 Instructions how to use SDL can be found from O-RAN Software Community (SC)
  66 Documentation under Near Realtime RAN Intelligent Controller (RIC) section:
  67 [O-RAN SC Documentation Home](https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-sdl/en/latest/)
  68
  69
  70 Unit Testing
  71 ------------
  72
  73 To run the unit tests run the following command in the package directory:
  74 `
  75 python3 -m pytest
  76 `
  77
  78
  79 Examples
  80 --------
  81
  82 See the ``examples`` directory.
  83
  84
  85
  86 CI
  87 --
  88
  89 The ci is done with the `tox` tool. See `tox.ini` file for details.