From 3b4813b6dab278581601a06185c146ea47b4ebb7 Mon Sep 17 00:00:00 2001 From: JohnKeeney Date: Wed, 17 Dec 2025 14:21:04 +0000 Subject: [PATCH] Update RTD documentation after M-Release Issue-ID: NONRTRIC-1095 Change-Id: If74ddddd0316c0c8d2936c104edc85adc816ac68 Signed-off-by: JohnKeeney (cherry picked from commit b01951c30aca63b843540750eca9c1c86af7bde1) --- docs/conf.py | 12 ++++- docs/developer-guide.rst | 14 ++---- docs/installation-guide.rst | 84 ++------------------------------ docs/overview.rst | 4 +- participants/docs/conf.py | 12 ++++- participants/docs/developer-guide.rst | 10 ++-- participants/docs/installation-guide.rst | 15 ++---- participants/docs/overview.rst | 2 +- tox.ini | 2 +- 9 files changed, 41 insertions(+), 114 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f167c43..84cd2a0 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ from docs_conf.conf import * #branch configuration selfbranch = 'm-release' -participantsbranch = 'latest' #sometimes this may be different from self.branch, e.g. on first build, it may not exist yet, so linkcheck will fail +participantsbranch = 'm-release' #sometimes this may be different from self.branch, e.g. on first build, it may not exist yet, so linkcheck will fail nonrtricbranch = 'm-release' #sometimes this may be different from self.branch, e.g. on first build, it may not exist yet, so linkcheck will fail baseurl = 'https://docs.o-ran-sc.org/projects/' @@ -53,3 +53,13 @@ intersphinx_mapping = {} intersphinx_mapping['nonrtric'] = ('%s' %(nonrtricurl), None) intersphinx_mapping['participants'] = ('%s' %(participantsurl), None) intersphinx_disabled_reftypes = ["*"] + +# Add some useful links available in every page +# Can be used later in any RST file as "" etc.. (Note the underscores!) +rst_epilog = """ +.. _nonrtricwiki: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/overview +.. _nonrtricwikidevguide: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/679903234/Release+M +.. _nonrtricwikik8s: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/679903652/Release+M+-+Run+in+Kubernetes +.. _nonrtricwikidocker: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/679903494/Release+M+-+Run+in+Docker +""" +## diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 0711158..47d62a1 100755 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -8,7 +8,7 @@ Developer Guide This document provides a quickstart for developers of the Non-RT RIC rApp Manager. -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 `_. The rApp Manager is a Java 17 web application built using the Spring Framework. Using Spring Boot dependencies, it runs as a standalone application. @@ -58,13 +58,7 @@ Then start the container by running the following command: Kubernetes deployment +++++++++++++++++++++ -Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_. -hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the -OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory. - -The scripts located in *rappmanager/scripts/install* can be used for an automatic installation in the Kubernetes Cluster, see `Automatic Installation in Kubernetes `_. - -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 `_. +The Non-RT RIC rApp Manager can be also deployed as part of an Integrated SMO in a Kubernetes cluster, and instructions can be found in the `OSC it/dep repository `_, +particularly in the *./smo-install* directory. +For more information on installation of Non-RT RIC and SMO components in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_. diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 5ccfb1d..fbceece 100755 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved. Installation Guide ================== @@ -8,87 +8,9 @@ Installation Guide Abstract -------- -This document describes how to install the Non-RT RIC components, their dependencies and required system resources. - Software Installation and Deployment ------------------------------------ -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 - -Install with dependent components -+++++++++++++++++++++++++++++++++ - -The scripts for the deployments of rApp Manager and its dependent components are available in *rappmanager/scripts/install* directory. - -ACM components should be configured with couple of other components for the participants to work. - -In case some of the installation is already setup or not set by the installation scripts, the below environment variables can be used to set the configurations ACM through installation scripts. - -+--------------------+--------------------------------------------+----------------------------------------------+ -| **Variable Name** | **Description** | **Default Value** | -+--------------------+--------------------------------------------+----------------------------------------------+ -| CHART_REPO_GET_URI | URI to get the charts. | \http://IP_ADDRESS:8879/charts | -| | | | -| | It will be used by Kubernetes participant | IP_ADDRESS: IP of the host in which | -| | and sample rApp generator | the installation scripts are running. | -+--------------------+--------------------------------------------+----------------------------------------------+ -| CHART_REPO_POST_URI| URI to upload the charts. | \http://IP_ADDRESS:8879/charts/api/charts | -| | | | -| | It will be used by sample rApp generator | IP_ADDRESS: IP of the host in which | -| | | the installation scripts are running. | -+--------------------+--------------------------------------------+----------------------------------------------+ -| A1PMS_HOST | Address of the A1PMS. | \http://policymanagementservice.nonrtric:9080| -| | | | -| | It will be accessed from A1PMS participant.| | -+--------------------+--------------------------------------------+----------------------------------------------+ - -All components can be installed using the command below, - - .. code-block:: bash - - ./install-all.sh - -Individual components can be installed using the commands below, - -To install the tools required for other installer scripts. - - .. code-block:: bash - - ./install-base.sh - -To install the ACM, and it's related components. - - .. code-block:: bash - - ./install-acm.sh - -To install the Kserve, and it's related components. - - .. code-block:: bash - - ./install-kserve.sh - -To installs the NONRTRIC components. - - .. code-block:: bash - - ./install-nonrtric.sh - - -Uninstallation -++++++++++++++ -To uninstall all the components - - .. code-block:: bash +The NONRTRIC rApp Manager requires several other functions to be installed and configured to operate correctly. Therefore it should be installed as part of an Integrated SMO installation. - ./uninstall-all.sh +For more information on installation of Non-RT RIC and SMO components in Kubernetes using Helm, see `Deploy NONRTRIC in Kubernetes `_. diff --git a/docs/overview.rst b/docs/overview.rst index 6bfb31f..001ac27 100755 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved. rApp Manager ~~~~~~~~~~~~ @@ -60,7 +60,7 @@ Information type, and Data producer/consumer information can be provided as part SME --- -Service Manager is a Go implementation of a service that calls the CAPIF Core function. When publishing a service it creates a Kong route and Kong service. +Service Manager is a Go implementation of a service that wraps the CAPIF Core function. When publishing a service it also creates a Kong route and Kong service. The CAPIF stands for Common API framework and it was developed by 3GPP to enable a unified Northbound API framework across 3GPP network functions, and to ensure that there is a single and harmonized approach for API development. More details about SME can be found in `SME `_. diff --git a/participants/docs/conf.py b/participants/docs/conf.py index 35310b9..ba60d01 100755 --- a/participants/docs/conf.py +++ b/participants/docs/conf.py @@ -26,11 +26,21 @@ linkcheck_ignore = [ 'https://gerrit.o-ran-sc.org.*', ] +# Add some useful links available in every page +# Can be used later in any RST file as "" etc.. (Note the underscores!) +rst_epilog = """ +.. _nonrtricwiki: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/overview +.. _nonrtricwikidevguide: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/679903234/Release+M +.. _nonrtricwikik8s: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/679903652/Release+M+-+Run+in+Kubernetes +.. _nonrtricwikidocker: https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/pages/679903494/Release+M+-+Run+in+Docker +""" +## + extensions = ['sphinx.ext.intersphinx',] #intershpinx mapping with other projects intersphinx_mapping = {} - intersphinx_mapping['nonrtric'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % branch, None) +intersphinx_disabled_reftypes = ["*"] diff --git a/participants/docs/developer-guide.rst b/participants/docs/developer-guide.rst index 6881df7..1d26eea 100755 --- a/participants/docs/developer-guide.rst +++ b/participants/docs/developer-guide.rst @@ -8,7 +8,7 @@ Developer Guide This document provides a quickstart for developers of the Non-RT RIC DME Participant. -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 `_. The DME Participant is a Java 17 web application built using the Spring Framework. Using Spring Boot dependencies, it runs as a standalone application. @@ -50,11 +50,11 @@ Then start the container by running the following command: Kubernetes deployment +++++++++++++++++++++ -Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_. -hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the -OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory. +The Non-RT RIC rApp Manager can be also deployed as part of an Integrated SMO in a Kubernetes cluster, and instructions can be found in the `OSC it/dep repository `_, +particularly in the *./smo-install* directory. + +For more information on installation of Non-RT RIC and SMO components in Kubernetes, see `Deploy NONRTRIC functions in Kubernetes `_. -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/participants/docs/installation-guide.rst b/participants/docs/installation-guide.rst index 620c5bc..22dad5b 100755 --- a/participants/docs/installation-guide.rst +++ b/participants/docs/installation-guide.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved. Installation Guide ================== @@ -8,19 +8,10 @@ Installation Guide Abstract -------- -This document describes how to install the Non-RT RIC components, their dependencies and required system resources. - Software Installation and Deployment ------------------------------------ -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: +The NONRTRIC rApp Manager requires several other functions to be installed and configured to operate correctly. Therefore it should be installed as part of an Integrated SMO installation. - .. code-block:: bash +For more information on installation of Non-RT RIC and SMO components in Kubernetes using Helm, see `Deploy NONRTRIC in Kubernetes `_. - bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml diff --git a/participants/docs/overview.rst b/participants/docs/overview.rst index a13b3a9..f977709 100755 --- a/participants/docs/overview.rst +++ b/participants/docs/overview.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved. DME Participant ~~~~~~~~~~~~~~~ diff --git a/tox.ini b/tox.ini index 1b63bfc..eb4a009 100755 --- a/tox.ini +++ b/tox.ini @@ -32,7 +32,7 @@ deps = commands = sphinx-build -W -b html --keep-going -n -d {envtmpdir}/participants/doctrees ./participants/docs/ {toxinidir}/docs/_build/html/participants - sphinx-build -W -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -b html --keep-going -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html allowlist_externals = echo -- 2.16.6