From: PatrikBuhr Date: Tue, 14 Dec 2021 07:31:18 +0000 (+0100) Subject: Documentation updates X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=7563539a5df0cd16fee4dd2d2110ba390c8dda6f;p=nonrtric.git Documentation updates NONRTRIC-679 NONRTRIC-680 Signed-off-by: PatrikBuhr Issue-ID: NONRTRIC-679 Change-Id: I3a40f30baed363677ff41e3bfcd2a498e47f6f22 --- diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 9dc4b8bb..0d950cd3 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -35,6 +35,13 @@ command in the *information-coordinator-service* directory: | mvn spring-boot:run | +-----------------------------+ +There are a few files that needs to be available to run. These are referred to from the application.yaml file. +The following properties have to be modified: + +* server.ssl.key-store=./config/keystore.jks +* app.webclient.trust-store=./config/truststore.jks +* app.vardata-directory=./target + Start in Docker +++++++++++++++ @@ -56,10 +63,38 @@ Initial Non-RT-RIC App Catalogue See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. +DMaaP Adaptor Service +--------------------- +This is run in the same way as the Information Coordinator Service + +The following properties in the application.yaml file have to be modified: +* server.ssl.key-store=./config/keystore.jks +* app.webclient.trust-store=./config/truststore.jks +* app.configuration-filepath=./src/test/resources/test_application_configuration.json + +O-DU & O-RU fronthaul recovery +------------------------------ + +See the page in Wiki: `O-RU Fronthaul Recovery usecase `_ + +O-DU Slicing use cases +---------------------- + +See the page in Wiki: `O-DU Slice Assurance usecase `_ + +Helm Manager +------------ + +See the page in Wiki: `Release E `_ + 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. + +For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_ + For more information see `Integration and Testing documentation on the O-RAN-SC wiki `_. + diff --git a/docs/overview.rst b/docs/overview.rst index 10a03dac..5bdaf8c1 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -122,20 +122,20 @@ Dmaap Adapter ~~~~~~~~~~~~~ Is a generic information producer, which registers itself as an information producer of information types (in Information Coordination Service). -The information types are defined in a configuration file. +The information types are defined in a configuration file. Information jobs can retrieve data from DMaaP or Kafka topics and push this to data consumers (accessing the ICS API). -Implementation: +Implementation (2 implementations): 1. Implementation as a Java Spring Boot application -2. Implementation as a Go application +2. Implementation as a Go application Non-RT-RIC (Spring Cloud) Service Gateway ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Support Apps to use A1 Services +Support Apps to use A1 Services * `Spring Cloud Gateway `_ provides the library to build a basic API gateway -* Exposes A1 Policy Management Service & Information Coordinator Service. +* Exposes A1 Policy Management Service & Information Coordinator Service. * Additional predicates can be added in code or preferably in the Gateway yaml configuration. Implementation: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 055ac255..99010c2c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -43,8 +43,8 @@ Version history A1 Policy Management Service (A1 Policy Agent) | | | | | +------------+----------+------------------+--------------------+ -Version history Enrichment Coordinator Service -============================================== +Version history Information Coordinator Service +=============================================== +------------+----------+------------------+----------------+ | **Date** | **Ver.** | **Author** | **Comment** | diff --git a/docs/use-cases.rst b/docs/use-cases.rst index d45a4a08..194e9b1c 100644 --- a/docs/use-cases.rst +++ b/docs/use-cases.rst @@ -54,4 +54,4 @@ There is a `docker-compose `_. \ No newline at end of file +the `wiki `_.