From: JohnKeeney Date: Mon, 28 Aug 2023 18:26:07 +0000 (+0100) Subject: Update main documentation H-Release X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=69544058169af63db698c5ebdddd630b1b47ce0f;p=nonrtric.git Update main documentation H-Release Issue-ID: NONRTRIC-855 Change-Id: I094a699f582b1116fdb66f796370ec2f97dfa057 Signed-off-by: JohnKeeney --- diff --git a/docs/conf.py b/docs/conf.py index 3695020e..036bca6c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,7 @@ orufhrecoverybranch = 'latest' authtokenfetchbranch = 'latest' a1policymanagementservicebranch = 'latest' smebranch = 'latest' +ranpmbranch = 'latest' onapbranch = 'latest' linkcheck_ignore = [ @@ -58,4 +59,5 @@ intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ra intersphinx_mapping['authtokenfetch'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % authtokenfetchbranch, None) intersphinx_mapping['a1policymanagementservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-a1policymanagementservice/en/%s' % a1policymanagementservicebranch, None) intersphinx_mapping['sme'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-sme/en/%s' % smebranch, None) +intersphinx_mapping['ranpm'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % ranpmbranch, None) intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None) diff --git a/docs/images/nonrtric-architecture-H.png b/docs/images/nonrtric-architecture-H.png new file mode 100644 index 00000000..9efbd701 Binary files /dev/null and b/docs/images/nonrtric-architecture-H.png differ diff --git a/docs/overview.rst b/docs/overview.rst index 6f96be83..7c6698ed 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -2,7 +2,7 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2021 Nordix -.. |archpic| image:: ./images/nonrtric-architecture-F.png +.. |archpic| image:: ./images/nonrtric-architecture-H.png :alt: Image: O-RAN SC - NONRTRIC Overall Architecture Summary @@ -73,6 +73,7 @@ The ICS is a data subscription service which decouples data producers from data A data consumer can have several active data subscriptions (Information Job). One Information Job consists of the type of data to produce and additional parameters, which may be different for different data types. These parameters are not defined or limited by this service. Maintains a registry of: + - Information Types / schemas - Information Producers - Information Consumers @@ -264,6 +265,22 @@ The auth-token-fetch is configured by the following environment variables. * AUTH_SERVICE_URL - the URL to the authentication service (Keycloak) * REFRESH_MARGIN_SECONDS - how long in advance before the authorization token expires it is refreshed +RAN Performance Monitoring Functions (File-based PM) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Functions to collect/parse/filter/store/forward file-based & event-based RAN PM data + +- End-to-end tool-chain to collection, parsing, filtering and delivery of file-based RAN PM observability data. +- PM report data format defined by 3GPP (TS 32.432 and 3GPP TS 32.435) +- High performance, fully scalable +- Subscribers (e.g. rApps) can subscribe for chosen measurement types from specific resources in the network + +Implementation: + +- Implemented in Go, Java and Python +- Repo: *nonrtric/plt/ranpm* +- Documentation at the :doc:`Non-RT RIC RAN PM Usecase / Functions documentation site `. + Non-RT-RIC Test Framework ~~~~~~~~~~~~~~~~~~~~~~~~~