Aditional Update i-release RTD documents 81/12381/2
authorJohnKeeney <john.keeney@est.tech>
Sun, 17 Dec 2023 23:57:18 +0000 (23:57 +0000)
committerJohn Keeney <John.Keeney@est.tech>
Mon, 18 Dec 2023 00:20:11 +0000 (00:20 +0000)
Change-Id: I57fe196c56b8f2288baebd83c32588321102e422
Issue-ID: NONRTRIC-958
Signed-off-by: JohnKeeney <john.keeney@est.tech>
README.md
docs/overview.rst
docs/release-notes.rst

index 81caa27..e27ff07 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,25 @@
-# O-RAN-SC Non-RealTime RIC
-
-The O-RAN SC Non-RT RIC provides support for non-real-time intelligent 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 the Near-RT RIC to achieve higher-level non-real-time objectives.
-
-Please see the documentation in the docs/ folder
-
-For more information about the Non-RT RIC project please see the [project website](https://wiki.o-ran-sc.org/display/RICNR "O-RAN-SC Non-RT RIC project")
-
-## License
-
-Copyright (C) 2019 Nordix Foundation.
-Licensed under the Apache License, Version 2.0 (the "License")
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-      http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-For more information about license please see the [LICENSE](LICENSE.txt) file for details.
+# O-RAN-SC Non-RealTime RIC\r
+\r
+The O-RAN SC Non-RT RIC provides support for non-real-time intelligent 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 the Near-RT RIC to achieve higher-level non-real-time objectives.\r
+\r
+Please see the documentation in the docs/ folder\r
+\r
+For more information about the Non-RT RIC project please see the [project website](https://wiki.o-ran-sc.org/display/RICNR "O-RAN-SC Non-RT RIC project")\r
+\r
+## License\r
+\r
+Copyright (C) 2019-2023 Nordix Foundation. All Rights Reserved.\r
+Copyright (C) 2019-2023 OpenInfra Foundation Europe. All Rights Reserved.\r
+Licensed under the Apache License, Version 2.0 (the "License")\r
+you may not use this file except in compliance with the License.\r
+You may obtain a copy of the License at\r
+\r
+      http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+Unless required by applicable law or agreed to in writing, software\r
+distributed under the License is distributed on an "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+See the License for the specific language governing permissions and\r
+limitations under the License.\r
+\r
+For more information about license please see the [LICENSE](LICENSE.txt) file for details.\r
index 8ee7317..eeaf260 100644 (file)
@@ -3,7 +3,7 @@
 .. 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
+.. |archpic| image:: ./images/nonrtric-architecture-I.png
   :alt: Image: O-RAN SC - NONRTRIC Overall Architecture
 
 Summary
@@ -25,31 +25,30 @@ The OSC NONRTRIC hosts rApps, and coordinates all interactions between the rApp
 
 Find detailed description of the NONRTRIC project see the `O-RAN SC NONRTRIC Project Wiki <nonrtricwiki_>`_.
 
-NONRTRIC components
+NONRTRIC Components
 -------------------
 
 These are the components that make up the Non-RT-RIC:
 
-* `Non-RT-RIC Control Panel <#non-rt-ric-control-panel-nonrtric-dashboard>`_. :doc:`Documentation site <controlpanel:index>`.
-* `Information Coordinator Service <#information-coordination-service>`_. :doc:`Documentation site <informationcoordinatorservice:index>`.
-* `A1 Policy Management Service <#a1-policy-management-service-from-onap-ccsdk>`_. :doc:`Documentation site <a1policymanagementservice:index>`.
+* `Non-RT-RIC Control Panel <#non-rt-ric-control-panel-nonrtric-dashboard>`_.  (:doc:`Documentation site <controlpanel:index>`).
+* `Information Coordinator Service <#information-coordination-service>`_.  (:doc:`Documentation site <informationcoordinatorservice:index>`).
+* `A1 Policy Management Service <#a1-policy-management-service-from-onap-ccsdk>`_.  (:doc:`Documentation site <a1policymanagementservice:index>`).
 * `A1 Policy Controller / Adapter <#a1-sdnc-controller-a1-adapter-controller-plugin>`_.
-* `Near-RT RIC A1 Simulator <#a1-interface-near-rt-ric-simulator>`_. :doc:`Documentation site <simulator:index>`.
+* `Near-RT RIC A1 Simulator <#a1-interface-near-rt-ric-simulator>`_.  (:doc:`Documentation site <simulator:index>`).
 * `Non-RT-RIC (Spring Cloud) Service Gateway <#spring-cloud-service-gateway>`_.
-* `Non-RT-RIC Service Exposure Security Architecture Prototyping <#service-exposure-security-architecture-prototyping>`_. :doc:`Documentation site <service-exposure/se-overview/>`
-* `DMaaP/Kafka Information Producer Adapters <#dmaap-information-producer-adapters-kafka>`_. :doc:`Documentation site adapter <dmaapadapter:index>`. :doc:`Documentation site mediator <dmaapmediatorproducer:index>`.
-* `Initial Non-RT-RIC App Catalogue <#initial-app-catalogue>`_. :doc:`Documentation site <rappcatalogue:index>`.
-* `Initial K8S Helm Chart LCM Manager <#initial-kubernetes-helm-chart-lcm-manager>`_. :doc:`Documentation site <helmmanager:index>`.
-* `Service Management & Exposure (SME) (CAPIF) <#service-management-and-exposure-capif>`_. :doc:`Documentation site <sme:index>`.
+* `Non-RT-RIC Service Exposure Security Architecture Prototyping <#service-exposure-security-architecture-prototyping>`_.  (:doc:`Documentation site <service-exposure/se-overview/>`)
+* `DMaaP/Kafka Information Producer Adapters <#dmaap-information-producer-adapters-kafka>`_.  (:doc:`Documentation site adapter <dmaapadapter:index>`),  (:doc:`Documentation site mediator <dmaapmediatorproducer:index>`).
+* `Initial Non-RT-RIC App Catalogue <#initial-app-catalogue>`_.  (:doc:`Documentation site <rappcatalogue:index>`).
+* `Initial K8S Helm Chart LCM Manager <#initial-kubernetes-helm-chart-lcm-manager>`_.  (:doc:`Documentation site <helmmanager:index>`).
+* `Service Management & Exposure (SME) (CAPIF) <#service-management-and-exposure-capif>`_.  (:doc:`Documentation site <sme:index>`).
 * `Authentication Support <#authentication-support-keycloak>`_.
-* `RApp Manager Service <#rapp-manager-service>`_ :doc:`rApp Manager documentation site <rappmanager:index>`.
-* `RAN Performance Monitoring Functions (File-based PM) <#ran-performance-monitoring-functions-file-based-pm>`_  :doc:`Non-RT RIC RAN PM Usecase / Functions documentation site <ranpm:index>`.
+* `RApp Manager Service <#rapp-manager-service>`_.  (:doc:`Documentation site <rappmanager:index>`).
+* `RAN Performance Monitoring Functions (File-based PM) <#ran-performance-monitoring-functions-file-based-pm>`_   (:doc:`Documentation site <ranpm:index>`).
 * `Test Framework <#non-rt-ric-test-framework>`_.
 * `Use Cases: <#non-rt-ric-use-cases>`_
 
-  * "Helloworld" O-RU Fronthaul Recovery use case. :doc:`Documentation site <orufhrecovery:index>`.
-  * "Helloworld" O-DU Slice Assurance use case. :doc:`Documentation site <ransliceassurance:index>`.
-
+  * "Helloworld" O-RU Fronthaul Recovery use case.  (:doc:`Documentation site <orufhrecovery:index>`).
+  * "Helloworld" O-DU Slice Assurance use case.  (:doc:`Documentation site <ransliceassurance:index>`).
 
 Non-RT-RIC Control Panel / NONRTRIC Dashboard
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -210,10 +209,10 @@ Implementation:
 Initial Kubernetes Helm Chart LCM Manager
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Onboard, start, stop, and modify Non-RT-RIC App µServices as Helm Charts.
-*A building block for coming releases as the R-APP concept matures*.
+Onboard, start, stop, and modify Non-RT-RIC App microservices as Helm Charts.
+*A building block for coming releases as the RAPP concept matures*.
 
-- Interfaces that accepts Non-RT-RIC App µServices Helm Charts.
+- Interfaces that accepts Non-RT-RIC App microservices Helm Charts.
 - Support basic LCM operations.
 - Onboard, Start, Stop, Modify, Monitor.
 - Initial version co-developed with v. similar functions in ONAP.
index 4e0c609..4c37861 100644 (file)
@@ -19,7 +19,7 @@ Functions, previously here, but now with their own repos have their own release
 * :doc:`Information Coordinator Service <informationcoordinatorservice:release-notes>`.
 * :doc:`A1 Policy Management Service <a1policymanagementservice:release-notes>`.
 * :doc:`Near-RT RIC A1 Simulator <simulator:release-notes>`.
-* DMaaP/Kafka Information Producer Adapters. :doc:`DMaaPAdapter <dmaapadapter:release-notes>`. :doc:`DMaaP Mediator Producer <dmaapmediatorproducer:release-notes>`.
+* DMaaP/Kafka Information Producer Adapters. :doc:`DMaaP Adapter <dmaapadapter:release-notes>`. :doc:`DMaaP Mediator Producer <dmaapmediatorproducer:release-notes>`.
 * :doc:`Non-RT-RIC App Catalogue <rappcatalogue:release-notes>`.
 * :doc:`K8S Helm Chart LCM Manager <helmmanager:release-notes>`.
 * :doc:`Service Management & Exposure (SME) <sme:release-notes>`.
@@ -30,6 +30,9 @@ Functions, previously here, but now with their own repos have their own release
 
 
 
+Release-Notes for just the nonrtric repo
+========================================
+
 Bronze
 ------
 +-----------------------------+---------------------------------------------------+
@@ -202,3 +205,17 @@ H Release
 |                             |                                                   |
 +-----------------------------+---------------------------------------------------+
 
+I Release
+---------
++-----------------------------+---------------------------------------------------+
+| **Project**                 | Non-RT RIC                                        |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+| **Repo/commit-ID**          | nonrtric                                          |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+| **Note**                    | No new images released from this repo for         |
+|                             |     the I Release.                                |
+|                             |                                                   |
++-----------------------------+---------------------------------------------------+
+