Roll version after release nonrtric-plt-ranpm-x to 1.1.0
[nonrtric/plt/ranpm.git] / datafilecollector / docs / developer-guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2023 Nordix
4
5 Developer Guide
6 ===============
7
8 This document provides a quickstart for developers of the Non-RT RIC Data File Collector.
9
10 Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR>`_.
11
12 Data File Collector Service
13 ---------------------------
14
15 The DFC is configured via the application.yaml file.
16
17 Example: ":download:`link <../config/application.yaml>`"
18
19 Kubernetes deployment
20 =====================
21
22 Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_.
23 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
24 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
25
26 For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Deploy+NONRTRIC+in+Kubernetes>`_.
27
28 For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.
29