Improve documentation 51/8051/1
authorelinuxhenrik <henrik.b.andersson@est.tech>
Thu, 7 Apr 2022 05:48:46 +0000 (07:48 +0200)
committerelinuxhenrik <henrik.b.andersson@est.tech>
Thu, 7 Apr 2022 05:49:01 +0000 (07:49 +0200)
Issue-ID: NONRTRIC-718
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Change-Id: I0e68ae38726f970d2568624dfcb22c47516cf1cf

docs/overview.rst
test/auto-test/FTC2003.sh
test/common/README.md

index d130778..26e755f 100644 (file)
@@ -28,18 +28,18 @@ NONRTRIC components
 
 These are the components that make up the Non-RT-RIC:
 
-* Non-RT-RIC Control Panel
-* Information Coordinator Service
-* A1 Policy Management Service
-* A1 Policy Controller / Adapter
-* Near-RT RIC A1 Simulator
-* Non-RT-RIC (Spring Cloud) Service Gateway
-* Non-RT-RIC (Kong) Service Exposure Prototyping
-* DMaaP/Kafka Information Producer Adapters
-* Initial Non-RT-RIC App Catalogue
-* Initial K8S Helm Chart LCM Manager
-* Test Framework
-* Use Cases
+- Non-RT-RIC Control Panel
+- Information Coordinator Service
+- A1 Policy Management Service
+- A1 Policy Controller / Adapter
+- Near-RT RIC A1 Simulator
+- Non-RT-RIC (Spring Cloud) Service Gateway
+- Non-RT-RIC (Kong) Service Exposure Prototyping
+- DMaaP/Kafka Information Producer Adapters
+- Initial Non-RT-RIC App Catalogue
+- Initial K8S Helm Chart LCM Manager
+- Test Framework
+- Use Cases
 
   + "Helloworld" O-RU Fronthaul Recovery use case
   + "Helloworld" O-DU Slice Assurance use case
@@ -51,20 +51,18 @@ Non-RT-RIC Control Panel / NONRTRIC Dashboard
 
 Graphical user interface.
 
-* View and Manage A1 policies in the RAN (near-RT-RICs)
-* Graphical A1 policy creation/editing is model-driven, based on policy type's JSON schema
-* View and manage producers and jobs for the Information coordinator service
-* Configure A1 Policy Management Service (e.g. add/remove near-rt-rics)
-* Interacts with the A1-Policy Management Service & Information Coordination Service (REST NBIs) via Service Exposure gateway
+- View and Manage A1 policies in the RAN (near-RT-RICs)
+- Graphical A1 policy creation/editing is model-driven, based on policy type's JSON schema
+- View and manage producers and jobs for the Information coordinator service
+- Configure A1 Policy Management Service (e.g. add/remove near-rt-rics)
+- Interacts with the A1-Policy Management Service & Information Coordination Service (REST NBIs) via Service Exposure gateway
 
 Implementation:
 
-* Frontend: Angular framework
-* Repo: *portal/nonrtric-controlpanel*
-
-Please refer the developer guide and the `Wiki <https://wiki.o-ran-sc.org/display/RICNR/>`_ to set up in your local environment.
-
-More details available at the `NONRTRIC-Portal documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel>`_.
+- Frontend: Angular framework
+- Repo: *portal/nonrtric-controlpanel*
+- `Wiki <https://wiki.o-ran-sc.org/display/RICNR/>`_ to set up in your local environment.
+- Documentation at the `NONRTRIC-Portal documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel>`_.
 
 Information Coordination Service
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -73,95 +71,90 @@ 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
-  + Information Jobs
+Maintains a registry of:
+- Information Types / schemas
+- Information Producers
+- Information Consumers
+- Information Jobs
 
 The service is not involved in data delivery and hence does not put restrictions on this. 
 
 Implementation:
 
-* Implemented as a Java Spring Boot application.
-* Repo: *nonrtric/plt/informationcoordinatorservice*.
-
-More details available at the `Information Coordination Service site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_
+- Implemented as a Java Spring Boot application.
+- Repo: *nonrtric/plt/informationcoordinatorservice*.
+- Documentation at the `Information Coordination Service site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_
 
 A1 Policy Management Service (from ONAP CCSDK)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-A1 Controller Service above A1 Controller/Adaptor that provides:
-
-* Unified REST & DMaaP NBI APIs for managing A1 Policies in all near-RT-RICs.
+A1 Controller Service above A1 Controller/Adapter that provides:
 
-  + Query A1 Policy Types in near-RT-RICs.
-  + Create/Query/Update/Delete A1 Policy Instances in near-RT-RICs.
-  + Query Status for A1 Policy Instances.
+- Unified REST & DMaaP NBI APIs for managing A1 Policies in all near-RT-RICs.
 
-* Maintains (persistent) cache of RAN's A1 Policy information.
+  - Query A1 Policy Types in near-RT-RICs.
+  - Create/Query/Update/Delete A1 Policy Instances in near-RT-RICs.
+  - Query Status for A1 Policy Instances.
 
-  * Support RAN-wide view of A1 Policy information.
-  * Streamline A1 traffic.
-  * Enable (optional) re-synchronization after inconsistencies / near-RT-RIC restarts.
-  * Supports a large number of near-RT-RICs (& multi-version support).
+Maintains (persistent) cache of RAN's A1 Policy information.
 
-* Converged ONAP & O-RAN-SC A1 Adapter/Controller functions in ONAP SDNC/CCSDK (Optionally deploy without A1 Adaptor to connect direct to near-RT-RICs).
-* Support for different Southbound connectors per near-RT-RIC - e.g. different A1 versions, different near-RT-RIC version, different A1 adapter/controllers supports different or proprietary A1 controllers/EMSs.
+- Support RAN-wide view of A1 Policy information.
+- Streamline A1 traffic.
+- Enable (optional) re-synchronization after inconsistencies / near-RT-RIC restarts.
+- Supports a large number of near-RT-RICs (& multi-version support).
 
-See also: `A1 Policy Management Service in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
+- Converged ONAP & O-RAN-SC A1 Adapter/Controller functions in ONAP SDNC/CCSDK (Optionally deploy without A1 Adapter to connect direct to near-RT-RICs).
+- Support for different Southbound connectors per near-RT-RIC - e.g. different A1 versions, different near-RT-RIC version, different A1 adapter/controllers supports different or proprietary A1 controllers/EMSs.
 
 Implementation:
 
-* Implemented as a Java Spring Boot application.
+- Implemented as a Java Spring Boot application.
+- Wiki: `A1 Policy Management Service in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
 
 A1/SDNC Controller & A1 Adapter (Controller plugin)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Mediation point for A1 interface termination in SMO/NONRTRIC.
 
-* Implemented as CCSDK OSGI Feature/Bundles.
-* A1 REST southbound.
-* RESTCONF Northbound.
-* NETCONF YANG > RESTCONF adapter.
-* SLI Mapping logic supported.
-* Can be included in an any controller based on ONAP CCSDK.
+- Implemented as CCSDK OSGI Feature/Bundles.
+- A1 REST southbound.
+- RESTCONF Northbound.
+- NETCONF YANG > RESTCONF adapter.
+- SLI Mapping logic supported.
+- Can be included in an any controller based on ONAP CCSDK.
 
 Implementation:
 
-* Repo: *nonrtric/plt/sdnca1controller*
-
-See also: `A1 Adapter/Controller Functions in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
+- Repo: *nonrtric/plt/sdnca1controller*
+- Wiki: `A1 Adapter/Controller Functions in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_ .
 
 A1 Interface / Near-RT-RIC Simulator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Stateful A1 test stub.
 
-* Used to create multiple stateful A1 providers (simulated near-rt-rics).
-* Supports A1-Policy and A1-Enrichment Information.
-* Swagger-based northbound interface, so easy to change the A1 profile exposed (e.g. A1 version, A1 Policy Types, A1-E1 consumers, etc).
-* All A1-AP versions supported.
+- Used to create multiple stateful A1 providers (simulated near-rt-rics).
+- Supports A1-Policy and A1-Enrichment Information.
+- Swagger-based northbound interface, so easy to change the A1 profile exposed (e.g. A1 version, A1 Policy Types, A1-E1 consumers, etc).
+- All A1-AP versions supported.
 
 Implementation:
 
-* Implemented as a Python application.
-* Repo: *sim/a1-interface*.
-
-More details available at the `A1 Simulator documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface>`_
+- Implemented as a Python application.
+- Repo: *sim/a1-interface*.
+- Documentation at the `A1 Simulator documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface>`_
 
 Non-RT-RIC (Spring Cloud) Service Gateway
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Support Apps to use A1 Services.
 
-* `Spring Cloud Gateway <https://cloud.spring.io/spring-cloud-gateway>`_ provides the library to build a basic API gateway.
-* Exposes A1 Policy Management Service & Information Coordinator Service.
-* Additional predicates can be added in code or preferably in the Gateway yaml configuration.
+- `Spring Cloud Gateway <https://cloud.spring.io/spring-cloud-gateway>`_ provides the library to build a basic API gateway.
+- Exposes A1 Policy Management Service & Information Coordinator Service.
+- Additional predicates can be added in code or preferably in the Gateway yaml configuration.
 
 Implementation:
 
-* Implemented as a Java Spring Cloud application.
-* Repo: *portal/nonrtric-controlpanel*.
+- Implemented as a Java Spring Cloud application.
+- Repo: *portal/nonrtric-controlpanel*.
 
 
 Non-RT-RIC (Kong) Service Exposure Prototyping
@@ -170,10 +163,10 @@ Non-RT-RIC (Kong) Service Exposure Prototyping
 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).
-* Extends a static gateway function specifically for NONRTRIC Control panel (described above).
-* Initial version based on `Kong API Gateway <https://docs.konghq.com/gateway-oss>`_ function.
-* Initial exposure candidates include A1 (NONRTRIC) services & O1 (OAM/SMO) services.
+- Support dynamic registration and exposure of service interfaces to Non-RT-RIC applications (& NONRTRIC Control panel).
+- Extends a static gateway function specifically for NONRTRIC Control panel (described above).
+- Initial version based on `Kong API Gateway <https://docs.konghq.com/gateway-oss>`_ function.
+- Initial exposure candidates include A1 (NONRTRIC) services & O1 (OAM/SMO) services.
 
 NONRTRIC Kubernetes deployment - including Kong configurations can be found in the OSC `it/dep <https://gerrit.o-ran-sc.org/r/gitweb?p=it/dep.git;a=tree;f=nonrtric/helm/nonrtric>`_ Gerrit repo.
 
@@ -188,23 +181,25 @@ Information jobs defined using ICS then allow information consumers to retrieve
 
 There are two alternative implementations to allow Information Consumers to consume DMaaP or Kafka events as coordinated Information Jobs.
 
-1. A version implemented in Java Spring (DMaaP Adaptor Service), repo: *nonrtric/plt/dmaapadapter*, see `DMaaP Adapter documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/latest/>`_.
-2. A version implemented in Go (DMaaP Mediator Producer), repo: *nonrtric/plt/dmaapmediatorproducer*, see `DMaaP Mediator Producer documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapmediatorproducer>`_.
+Implementation:
+
+- Implementation in Java Spring (DMaaP Adapter), repo: *nonrtric/plt/dmaapadapter*, see `DMaaP Adapter documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/latest/>`_.
+- Implemention in Go (DMaaP Mediator Producer), repo: *nonrtric/plt/dmaapmediatorproducer*, see `DMaaP Mediator Producer documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapmediatorproducer>`_.
 
 Initial Non-RT-RIC App Catalogue
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Register for Non-RT-RIC Apps.
 
-* Non-RT-RIC Apps can be registered / queried.
-* Limited functionality/integration for now.
-* *More work required in coming releases as the rApp concept matures*.
+- Non-RT-RIC Apps can be registered / queried.
+- Limited functionality/integration for now.
+- *More work required in coming releases as the rApp concept matures*.
 
 Implementation:
 
-* Repo: *nonrtric/plt/rappcatalogue*
-
-More details available at the `rApp Catalogue documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue>`_.
+- Implemented as a Java Spring Boot application.
+- Repo: *nonrtric/plt/rappcatalogue*
+- Documentation at the `rApp Catalogue documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue>`_.
 
 Initial K8S Helm Chart LCM Manager
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -212,18 +207,17 @@ Initial K8S 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*.
 
-* Interfaces that accepts Non-RT-RIC App µServices Helm Charts.
-* Support basic LCM operations.
-* Onboard, Start, Stop, Modify, Monitor.
-* Initial version co-developed with v. similar functions in ONAP.
-* *Limited functionality/integration for now*.
+- Interfaces that accepts Non-RT-RIC App µServices Helm Charts.
+- Support basic LCM operations.
+- Onboard, Start, Stop, Modify, Monitor.
+- Initial version co-developed with v. similar functions in ONAP.
+- *Limited functionality/integration for now*.
 
 Implementation:
 
-* Implemented as a Java Spring Boot application.
-* Repo: *nonrtric/plt/helmmanager*
-
-More details available at the `Helm Manager documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager>`_.
+- Implemented as a Java Spring Boot application.
+- Repo: *nonrtric/plt/helmmanager*
+- Documentation at the `Helm Manager documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager>`_.
 
 Test Framework
 ~~~~~~~~~~~~~~
index 824ff3e..dcd9f9c 100755 (executable)
@@ -17,7 +17,7 @@
 #  ============LICENSE_END=================================================
 #
 
-TC_ONELINE_DESCR="Testing southbound proxy for Dmaap Adaptor"
+TC_ONELINE_DESCR="Testing southbound proxy for Dmaap Adapter"
 
 #App names to include in the test when running docker, space separated list
 DOCKER_INCLUDED_IMAGES="CR MR ICS HTTPPROXY KUBEPROXY DMAAPADP"
@@ -120,4 +120,4 @@ store_logs          END
 
 print_result
 
-auto_clean_environment
\ No newline at end of file
+auto_clean_environment
index fcb33b3..d46b416 100644 (file)
@@ -48,7 +48,7 @@ A python script to create a json file from a formatted string of ric info. Helpe
 A python script to delete a batch of policies. The script is intended to run in a number of processes to delete policies in parallel.
 
 `dmaapadp_api_function.sh`
-Contains funnctions for managing the Dmaap Adaptor Service.
+Contains funnctions for managing the Dmaap Adapter.
 
 `dmaapmed_api_function.sh`
 Contains funnctions for managing the Dmaap Mediator Service.