From: JohnKeeney Date: Sun, 17 Dec 2023 22:25:53 +0000 (+0000) Subject: Update i-release RTD documents & links X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F79%2F12379%2F1;p=nonrtric.git Update i-release RTD documents & links Change-Id: I607f73ce07382a79310c63727071f711a91fc28c Issue-ID: NONRTRIC-958 Signed-off-by: JohnKeeney --- diff --git a/docs/conf.py b/docs/conf.py index 036bca6c..f437de7a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,6 @@ # ============LICENSE_START=============================================== -# Copyright (C) 2019-2022 Nordix Foundation. All rights reserved. +# Copyright (C) 2019-2023 Nordix Foundation. All rights reserved. +# Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved. # ======================================================================== # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -16,22 +17,32 @@ from docs_conf.conf import * -#branch configuration - -controlpanelbranch = 'latest' -simulatorbranch = 'latest' -dmaapmediatorproducerbranch = 'latest' -dmaapadapterbranch = 'latest' -informationcoordinatorservicebranch = 'latest' -rappcataloguebranch = 'latest' -helmmanagerbranch = 'latest' +## Update here to configure which branch is used. +#branch configurations +controlpanelbranch = 'i-release' +simulatorbranch = 'i-release' +dmaapmediatorproducerbranch = 'i-release' +dmaapadapterbranch = 'i-release' +informationcoordinatorservicebranch = 'i-release' +rappcataloguebranch = 'i-release' +rappmanagerbranch = 'i-release' +helmmanagerbranch = 'i-release' ransliceassurancebranch = 'latest' orufhrecoverybranch = 'latest' -authtokenfetchbranch = 'latest' -a1policymanagementservicebranch = 'latest' -smebranch = 'latest' -ranpmbranch = 'latest' -onapbranch = 'latest' +authtokenfetchbranch = 'i-release' +a1policymanagementservicebranch = 'i-release' +smebranch = 'i-release' +ranpmbranch = 'i-release' +onapbranch = 'montreal' +# Add some useful links available in every page +rst_epilog = """ +.. _nonrtricwiki: https://wiki.o-ran-sc.org/display/RICNR/ +.. _nonrtricwikidevguide: https://wiki.o-ran-sc.org/display/RICNR/Release+I +.. _nonrtricwikik8s: https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Kubernetes +.. _nonrtricwikidocker: https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Docker +""" +## + linkcheck_ignore = [ 'http://localhost.*', @@ -53,6 +64,7 @@ intersphinx_mapping['dmaapmediatorproducer'] = ('https://docs.o-ran-sc.org/proje intersphinx_mapping['dmaapadapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/%s' % dmaapadapterbranch, None) intersphinx_mapping['informationcoordinatorservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/%s' % informationcoordinatorservicebranch, None) intersphinx_mapping['rappcatalogue'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue/en/%s' % rappcataloguebranch, None) +intersphinx_mapping['rappmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappmanager/en/%s' % rappmanagerbranch, None) intersphinx_mapping['helmmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager/en/%s' % helmmanagerbranch, None) intersphinx_mapping['ransliceassurance'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-ransliceassurance/en/%s' % ransliceassurancebranch, None) intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-orufhrecovery/en/%s' % orufhrecoverybranch, None) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 9ef6ef28..9e831776 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,13 +1,14 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved Developer Guide =============== This document provides a quickstart for developers of the Non-RT RIC parts. -Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. Kubernetes deployment --------------------- @@ -16,7 +17,7 @@ Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_. +For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_. For more information see `Integration and Testing documentation in the O-RAN-SC `_. diff --git a/docs/images/nonrtric-architecture-I.png b/docs/images/nonrtric-architecture-I.png new file mode 100644 index 00000000..940eca0a Binary files /dev/null and b/docs/images/nonrtric-architecture-I.png differ diff --git a/docs/index.rst b/docs/index.rst index ca977702..cc8b0a02 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved Non-RT RIC ========== diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 18371522..4a4f0131 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved Installation Guide ================== @@ -8,15 +9,36 @@ Installation Guide Abstract -------- -This document describes how to install the Non-RT RIC components, their dependencies and required system resources. +This document describes how to install some of the Non-RT RIC components, their dependencies and required system resources. Software Installation and Deployment ------------------------------------ +Install with Helm in Kubernetes ++++++++++++++++++++++++++++++++ + +The easiest and preferred way to install NONRTRIC functions is using Kubernetes, with installation instructions provided in Helm Charts. +Full details of how to install NONRTRIC functions are provided in `Deploy NONRTRIC in Kubernetes `_. + +Helm charts and an example recipe are provided in the `it/dep repo `_, +under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which +components that will be installed can be controlled. Then the components can be installed and started by running the +following command: + + .. code-block:: bash + + bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml + Install with Docker +++++++++++++++++++ -Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following +Some NONRTRIC functions, and simpler usecases can be install directly using Docker. +Full details of how to use Docker for NONRTRIC functions are provided in `Deploy NONRTRIC in Docker `_. + +Install with Docker Compose ++++++++++++++++++++++++++++ + +Some older docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following command to start the components: .. code-block:: bash @@ -26,16 +48,4 @@ command to start the components: -f ics/docker-compose.yaml The example above is just an example to start some of the components. -For more information on running and configuring the functions can be found in the README file in the "`docker-compose `__" folder, and on the `wiki page `_ - -Install with Helm -+++++++++++++++++ - -Helm charts and an example recipe are provided in the `it/dep repo `_, -under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which -components that will be installed can be controlled. Then the components can be installed and started by running the -following command: - - .. code-block:: bash - - bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml +For more information on running and configuring the functions can be found in the README file in the "`docker-compose `_" folder, and on the `wiki page `_ diff --git a/docs/overview.rst b/docs/overview.rst index 04bb0d3a..8ee7317d 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2021 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved .. |archpic| image:: ./images/nonrtric-architecture-H.png :alt: Image: O-RAN SC - NONRTRIC Overall Architecture @@ -12,16 +13,17 @@ The Non-RealTime RIC (RAN Intelligent Controller) is an Orchestration and Automa The primary goal of the Non-RealTime RIC is to support non-real-time radio resource management, higher layer procedure optimization, policy optimization in RAN, and providing guidance, parameters, policies and AI/ML models to support the operation of near-RealTime RIC functions in the RAN to achieve higher-level non-real-time objectives. -Non-RealTime RIC functions include service and policy management, RAN analytics and model-training for the near-RealTime RICs. +Non-RealTime RIC functions include service and policy management and RAN analytics for the RAN. The Non-RealTime RIC platform hosts and coordinates rApps (Non-RT RIC applications) to perform Non-RealTime RIC tasks. The Non-RealTime RIC also hosts the new R1 interface (between rApps and SMO/Non-RealTime-RIC services). The O-RAN-SC (OSC) NONRTRIC project provides concepts, architecture and reference implementations as defined and described by the `O-RAN Alliance `_ architecture. The OSC NONRTRIC implementation communicates with near-RealTime RIC elements in the RAN via the A1 interface. Using the A1 interface the NONRTRIC will facilitate the provision of policies for individual UEs or groups of UEs; monitor and provide basic feedback on policy state from near-RealTime RICs; provide enrichment information as required by near-RealTime RICs; and facilitate ML model training, distribution and inference in cooperation with the near-RealTime RICs. +The OSC NONRTRIC hosts rApps, and coordinates all interactions between the rApp and underlying SMo by way of the R1 Interface. |archpic| -Find detailed description of the NONRTRIC project see the `O-RAN SC NONRTRIC Project Wiki `_. +Find detailed description of the NONRTRIC project see the `O-RAN SC NONRTRIC Project Wiki `_. NONRTRIC components ------------------- @@ -38,8 +40,10 @@ These are the components that make up the Non-RT-RIC: * `DMaaP/Kafka Information Producer Adapters <#dmaap-information-producer-adapters-kafka>`_. :doc:`Documentation site adapter `. :doc:`Documentation site mediator `. * `Initial Non-RT-RIC App Catalogue <#initial-app-catalogue>`_. :doc:`Documentation site `. * `Initial K8S Helm Chart LCM Manager <#initial-kubernetes-helm-chart-lcm-manager>`_. :doc:`Documentation site `. -* `Service Management & Exposure (SME) <#service-management-and-exposure>`_. :doc:`Documentation site `. +* `Service Management & Exposure (SME) (CAPIF) <#service-management-and-exposure-capif>`_. :doc:`Documentation site `. * `Authentication Support <#authentication-support-keycloak>`_. +* `RApp Manager Service <#rapp-manager-service>`_ :doc:`rApp Manager documentation site `. +* `RAN Performance Monitoring Functions (File-based PM) <#ran-performance-monitoring-functions-file-based-pm>`_ :doc:`Non-RT RIC RAN PM Usecase / Functions documentation site `. * `Test Framework <#non-rt-ric-test-framework>`_. * `Use Cases: <#non-rt-ric-use-cases>`_ @@ -62,7 +66,6 @@ Implementation: - Frontend: Angular framework - Repo: *portal/nonrtric-controlpanel* -- `Wiki `_ to set up in your local environment. - Documentation at the :doc:`NONRTRIC-Portal documentation site `. Information Coordination Service @@ -117,6 +120,7 @@ Implementation: A1/SDNC Controller & A1 Adapter (Controller plugin) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Mediation point for A1 interface termination in SMO/NONRTRIC. - Implemented as CCSDK OSGI Feature/Bundles. @@ -168,7 +172,9 @@ Support Apps to use NONRTRIC, SMO and other App interfaces. A building block for coming releases as the R1 Interface concept matures . - Support dynamic registration and exposure of service interfaces to Non-RT-RIC applications (& NONRTRIC Control panel). -- The architecture and componets are defined in :doc:`Non-RT RIC Security Architecture Prototyping (Documentation site) `. +- The architecture and components are defined in :doc:`Non-RT RIC Security Architecture Prototyping (Documentation site) `. +- Works with the CAPIF `Service Management & Exposure (SME) <#service-management-and-exposure>`_. :doc:`Documentation site ` functions. + DMaaP Information Producer Adapters (Kafka) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -197,7 +203,7 @@ Register for Non-RT-RIC Apps. Implementation: -- Implemented as a Java Spring Boot application. +- Implemented as a Java Spring Boot application and in Python. - Repo: *nonrtric/plt/rappcatalogue* - Documentation at the :doc:`rApp Catalogue documentation site `. @@ -219,8 +225,8 @@ Implementation: - Repo: *nonrtric/plt/helmmanager* - Documentation at the :doc:`Helm Manager documentation site `. -Service Management and Exposure -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Service Management and Exposure (CAPIF) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ An initial implementation of the CAPIF Core service. It implements the following CAPIF APIs: @@ -265,6 +271,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 +RApp Manager Service +~~~~~~~~~~~~~~~~~~~~ + +Early version of a service to manage rApps and rApp instances. + +- Manages the entire lifecycle and state of rApp and thie instances +- Integrated with NONRTRIC Data Management & Exposure functions (ICS) +- Integrates with NONRTRIC Service registration and discovery functions (SME CAPIF) +- Also add new ONAP ACM participants to handle rApp composition elements + +Implementation: + +- Implemented as a Java Spring Boot application. +- Repo: *nonrtric/plt/rappmanager* +- Documentation at the :doc:`Non-RT RIC rApp Manager documentation site `. + RAN Performance Monitoring Functions (File-based PM) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~