Doc update
[nonrtric/plt/a1policymanagementservice.git] / 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) 2021-2023 Nordix
4 .. Copyright (C) 2024: OpenInfra Foundation Europe. All rights reserved.
5
6 ===============
7 Developer Guide
8 ===============
9
10 This document provides a quickstart for developers of the Non-RT RIC A1 Policy Management Service.
11
12 The A1 Policy Management Service is implemented in ONAP. For additional documentation 
13 see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran>`_.
14 and `wiki <https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP>`_.
15
16 Docker & Kubernetes deployment
17 ==============================
18
19 Information on running and configuring the functions in Docker can be found 
20 on the `Run in Docker wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Docker>`_
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 see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep>`_.
27
28 For more information on installation of NonRT-RIC in Kubernetes, 
29 see `Deploy NONRTRIC functions in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Kubernetes>`_.
30
31