icsversion/README.md

   1 <!--
   2  -
   3    ========================LICENSE_START=================================
   4    O-RAN-SC
   5    %%
   6    Copyright (C) 2022: Nordix Foundation
   7    %%
   8    Licensed under the Apache License, Version 2.0 (the "License");
   9    you may not use this file except in compliance with the License.
  10    You may obtain a copy of the License at
  11
  12         http://www.apache.org/licenses/LICENSE-2.0
  13
  14    Unless required by applicable law or agreed to in writing, software
  15    distributed under the License is distributed on an "AS IS" BASIS,
  16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17    See the License for the specific language governing permissions and
  18    limitations under the License.
  19    ========================LICENSE_END===================================
  20
  21 -->
  22
  23 # O-RAN-SC docker-compose files for O-DU Closed Loop use case Slice Assurance integrated with ICS
  24
  25 The docker compose file helps the user to deploy all or partial components of the Slice assurance use case with one command.
  26
  27 ## Prerequisite
  28
  29 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
  30
  31 ## Overview
  32
  33 This docker compose start the following components:
  34
  35 ### Information Coordinator Service
  36
  37 Coordinate/Register Information Types, Producers, Consumers, and Jobs.
  38
  39 ### O-RAN-SC Control Panel
  40
  41 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.
  42
  43 ### O-RAN-SC Control Panel Gateway
  44
  45 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.
  46
  47 ### DMaaP-Adaptor/Mediator
  48
  49 Two alternatives mediators that take information from DMaaP (& Kafka) and present it as a coordinated Information Producer.
  50 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.
  51
  52 #### Configuration files for DMaaP topics
  53
  54 * 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).
  55
  56 * 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).
  57
  58 ### O-DU Slice Assurance rApp
  59
  60 O-DU Closed Loop use case Slice Assurance rApp integrated with ICS.
  61
  62 #### Startup solution
  63
  64 ```
  65 docker-compose up -d
  66 ```
  67
  68 ### Log files
  69
  70 ```
  71 docker logs -f ics
  72 docker logs -f dmaap-adaptor-service
  73 docker logs -f dmaap-mediator-service
  74 docker logs -f odu-app
  75 ```
  76