--- /dev/null
+<!--
+ -
+ ========================LICENSE_START=================================
+ O-RAN-SC
+ %%
+ Copyright (C) 2023: 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.
+ ========================LICENSE_END===================================
+
+-->
+
+# O-RAN-SC Non-RealTime RIC O-DU Closed Loop use case Slice Assurance
+
+There are two versions of the use case implemented.
+
+- One SMO version, see [SMO version](smoversion/README.md).
+- One Information Coordinator Service (ICS) version, see [ICS version](icsversion/README.md).
Developer Guide
===============
-This document provides a quickstart for developers of the RAN Slice Assurance use case.
+This document provides a quick start for developers of the RAN Slice Assurance use case.
Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+F>`_.
-See the page in Wiki: `O-DU Slice Assurance usecase <https://wiki.o-ran-sc.org/display/RICNR/O-DU+Slice+Assurance+usecase>`_.
+See the page in Wiki: `O-DU Slice Assurance use case <https://wiki.o-ran-sc.org/display/RICNR/O-DU+Slice+Assurance+usecase>`_.
Kubernetes deployment
:depth: 1
:local:
-Version history RAN Slice Assurance usecase
-============================================
+Version history RAN Slice Assurance use case
+=============================================
+------------+----------+------------------+-----------------+
| **Date** | **Ver.** | **Author** | **Comment** |
-## License
-Copyright (C) 2022 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
+<!--
+ -
+ ========================LICENSE_START=================================
+ O-RAN-SC
+ %%
+ Copyright (C) 2022: 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
+ 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.
+ 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.
+ ========================LICENSE_END===================================
-# O-RAN-SC docker-compose files for O-DU Closed Loop Usecase Slice Assurance integrated with ICS:
-The docker compose file helps the user to deploy all or partial components of the Slice assurance usecase with one command.
+-->
-## Prerequisite:
+# O-RAN-SC docker-compose files for O-DU Closed Loop use case Slice Assurance integrated with ICS
+
+The docker compose file helps the user to deploy all or partial components of the Slice assurance use case with one command.
+
+## Prerequisite
Minimal SMO deployment is needed. This can be started using the instructions from https://gerrit.o-ran-sc.org/r/gitweb?p=oam.git;a=blob;f=solution/integration/README.md;h=73100a4d31a84fb0de9beeb52b639df249ab0fcf;hb=HEAD
This docker compose start the following components:
### Information Coordinator Service
+
Coordinate/Register Information Types, Producers, Consumers, and Jobs.
### O-RAN-SC Control Panel
The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in the RAN and also view producers and jobs for the Information coordinator service.
-### O-RAN-SC Control Panel Gateway:
+### O-RAN-SC Control Panel Gateway
To view the policy or information jobs and types in control panel gui along with Policy Management Service & Information Coordinator Service you should also have nonrtric gateway because all the request from the gui are passed through this API gateway.
-### Dmaap-Adaptor/Mediator
+### DMaaP-Adaptor/Mediator
+
Two alternatives mediators that take information from DMaaP (& Kafka) and present it as a coordinated Information Producer.
These configurable adapters/mediators act as producers of Information Coordinator Service (ICS) jobs by polling topics in DMaaP Message Router (MR) or Kafka and pushing the messages to a consumer.
-#### Configuration files for Dmaap topics
+#### Configuration files for DMaaP topics
+
+* The DMaaP Adaptor Service needs two configurations files, one for the application specific parameters and one for the types the application supports. More information can be found on wiki page: [Java version](https://wiki.o-ran-sc.org/display/RICNR/Release+F+-+Run+in+Docker#ReleaseFRuninDocker-RuntheDmaapAdaptorServiceDockerContainer).
-* The Dmaap Adaptor Service needs two configurations files, one for the application specific parameters and one for the types the application supports. More information can be found on wiki page: [Java version](https://wiki.o-ran-sc.org/display/RICNR/Release+F+-+Run+in+Docker#ReleaseFRuninDocker-RuntheDmaapAdaptorServiceDockerContainer).
+* The DMaaP Mediator Producer needs one configuration file for the types the application supports and different environment variables that can be configured in the docker compose file. More information can be found on wiki page: [Go version](https://wiki.o-ran-sc.org/display/RICNR/Release+F+-+Run+in+Docker#ReleaseFRuninDocker-RuntheDmaapMediatorProducerDockerContainer).
-* The Dmaap Mediator Producer needs one configuration file for the types the application supports and different enviroment variables that can be configured in the docker compose file. More information can be found on wiki page: [Go version](https://wiki.o-ran-sc.org/display/RICNR/Release+F+-+Run+in+Docker#ReleaseFRuninDocker-RuntheDmaapMediatorProducerDockerContainer).
+### O-DU Slice Assurance rApp
-### O-DU Slice Assurance Rapp
-O-DU Closed Loop Usecase Slice Assurance Rapp integrated with ICS.
+O-DU Closed Loop use case Slice Assurance rApp integrated with ICS.
#### Startup solution
-# O-RAN-SC Non-RealTime RIC O-DU Closed Loop Usecase Slice Assurance
+<!--
+ -
+ ========================LICENSE_START=================================
+ O-RAN-SC
+ %%
+ Copyright (C) 2022: 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.
+ ========================LICENSE_END===================================
+
+-->
+# O-RAN-SC Non-RealTime RIC O-DU Closed Loop use case Slice Assurance
## Configuration
The consumer takes a number of environment variables, described below, as configuration.
->- MR_HOST **Required**. The host for Dmaap Message Router. Example: `http://mrproducer`
->- MR_PORT **Required**. The port for the Dmaap Message Router. Example: `8095`
+>- MR_HOST **Required**. The host for DMaaP Message Router. Example: `http://mrproducer`
+>- MR_PORT **Required**. The port for the DMaaP Message Router. Example: `8095`
>- SDNR_ADDR Optional. The address for SDNR. Defaults to `http://localhost:3904`.
>- SDNR_USER Optional. The user for the SDNR. Defaults to `admin`.
>- SDNR_PASSWORD Optional. The password for the SDNR user. Defaults to `Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U`.
>- LOG_LEVEL Optional. The log level, which can be `Error`, `Warn`, `Info` or `Debug`. Defaults to `Info`.
->- POLLTIME Optional. Waiting time between one pull request to Dmaap and another. Defaults to 10 sec
+>- POLLTIME Optional. Waiting time between one pull request to DMaaP and another. Defaults to 10 sec
## Functionality
There is a status call provided in a REST API on port 40936.
+
>- /status OK
## Development
To make it easy to test during development of the consumer, there is a stub provided in the `stub` folder.
-This stub is used to simulate both received VES messages from Dmaap MR with information about performance measurements for the slices in a determinated DU and also SDNR, that sends information about Radio Resource Management Policy Ratio and allows to modify value for RRM Policy Dedicated Ratio from default to higher value.
+This stub is used to simulate both received VES messages from DMaaP MR with information about performance measurements for the slices in a determined DU and also SDNR, that sends information about Radio Resource Management Policy Ratio and allows to modify value for RRM Policy Dedicated Ratio from default to higher value.
-By default, SDNR stub listens to the port `3904`, but his can be overridden by passing a `--sdnr-port [PORT]` flag when starting the stub. For Dmaap MR stub default port is `3905` but it can be overriden by passing a `--dmaap-port [PORT]` flag when starting the stub.
+By default, SDNR stub listens to the port `3904`, but his can be overridden by passing a `--sdnr-port [PORT]` flag when starting the stub. For DMaaP MR stub default port is `3905` but it can be overridden by passing a `--dmaap-port [PORT]` flag when starting the stub.
To build and start the stub, do the following:
>1. cd stub
>2. go build
>3. ./stub [--sdnr-port <portNo>] [--dmaap-port <portNo>]
-
-## License
-
-Copyright (C) 2021 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.
\ No newline at end of file
Code Review / nonrtric / rapp / ransliceassurance.git / commitdiff