| commit | a0745d294dcd72f7d78ea4c3accd3b477dd668a5 | [log] [tgz] |
|---|---|---|
| author | Timo Tietavainen <timo.tietavainen@nokia.com> | Thu Nov 28 09:55:22 2019 +0200 |
| committer | Timo Tietavainen <timo.tietavainen@nokia.com> | Thu Nov 28 09:55:22 2019 +0200 |
| tree | 923f0fa0ca3bb11ca0c3f5ed7e6f6eb8a3c10937 | |
| parent | 3c95b1893710d2183765957a1118dda217644ddd [diff] |
Add extra line about src files are part of RIC platform project Signed-off-by: Timo Tietavainen <timo.tietavainen@nokia.com> Change-Id: Idf0de8c3b3c8133847f14d0d0b1b38a68fcb2c67
Documentation is generated with doxygen tool.
By default make doxygen-doc creates HTML, PDF and PS documents (if the needed tools are available). The documents are created to:
Creation of different document formats can be controlled with various --enable-doxygen-* and --disable-doxygen-* configuration options. For example if only HTML document is needed, then run:
./configure --disable-doxygen-pdf --disable-doxygen-ps make doxygen-doc
These instructions assume that the project has been cloned into directory named shareddatalayer.
Currently, the following libraries are required while building:
boost-devel hiredis-devel
cd shareddatalayer ./autogen.sh ./configure make all test
cd shareddatalayer ./autogen.sh cd .. mkdir workdir cd workdir ../shareddatalayer/configure make all test
By default the shared library is installed to /usr/local/lib and headers into to /usr/local/include. If this is not desired, then provide different path when running configure, for example:
./configure --prefix=$HOME/usr/local
In above example SDL pkg-config .pc file is installed to $HOME/usr/local/lib/pkgconfig directory. This directory should be included to PKG_CONFIG_PATH while building the application which is using the SDL API library.
Note that configure command allows plethora of additional options. For more info:
./configure --help
After configuration has been done, run:
make install
In some cases dynamic linker cache needs to be manually refreshed after SDL API has been re-installed:
ldconfig
When Redis is used, SDL requires that the following Redis extension commands have been installed to runtime environment:
Redis v4.0 or greater is required. Older versions do not support extension modules.
Implementation for these commands is produced by RIC DBaaS: https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/dbaas
In official RIC deployments these commands are installed by dbaas service to Redis container(s).
In development environment you may want install commands manually to pod/container which is running Redis.
Installation to default system directory:
cd redismodule ./autogen.sh ./configure make install
Following line should be added to redis.conf file:
loadmodule <path>/libredismodule.so
<path> should be replaced to match library installation directory path. redis-server must be restarted after configuration file update.
Notice that redis-server takes path to configuration file as an argument. If not given it will start with default parameter values and above made loadmodule option is not effective. Refer to redis-server --help.
SDL API will check in connection setup phase that all required commands are available, if not then execution is aborted and error log is written to identify that which commands are missing.
Unit tests are compiled and executed by simply running:
make test
By default all unit tests are executed. If valgrind is installed, then by default unit test execution is analyzed with valgrind. Running specific test cases can be achieved by using GTEST_FILTER environment variable. For example:
make test GTEST_FILTER=ConnectionTest*
If valgrind is not desired (even if installed), then it can be disabled with USE_VALGRIND environment variable:
make test USE_VALGRIND=false
Additional valgrind arguments can be specified with VALGRIND_EXTRA_ARGS environment variable. For example:
make test VALGRIND_EXTRA_ARGS='--track-fds=yes --log-file=mylog.txt'
It is also possible to use the testrunner binary directly (after it has been compiled). The testrunner binary supports all the command line options gtest supports, for example:
make testrunner ./testrunner --help
SDL is not yet available in O-RAN-SC PackageCloud.io repository.
Plan is to add it, but in the meantime SDL API needs to be complied and installed in SDL client Dockerfiles (refer instructions above). You may need to execute RUN ldconfig command to Dockerfile after SDL API installation.
RIC DBaaS service must be running before starting application pod which is using SDL API. DBaaS defines environment variables which are used to contact DBaaS service (offering backend for SDL). Those environment variables are exposed inside application container only if DBaaS service is running when application container is started.
You may test SDL connectivity to its backend with sdltool test-connectivity command inside your application container.