README.md

   1 # O-RAN-SC Non-RealTime RIC DMaaP Mediator Producer
   2
   3 This product is a producer of Information Coordinator Service (ICS) jobs for polling topics in DMaaP Message Router (MR) and pushing the messages to a consumer.
   4
   5 ## Configuration
   6
   7 The producer takes a number of environment variables, described below, as configuration.
   8
   9 >- INFO_PRODUCER_HOST  **Required**. The host for the producer.                                   Example: `https://mrproducer`
  10 >- INFO_PRODUCER_PORT  Optional. The port for the product.                                        Defaults to `8085`.
  11 >- INFO_COORD_ADDR     Optional. The address of the Information Coordinator.                      Defaults to `https://enrichmentservice:8434`.
  12 >- DMAAP_MR_ADDR       Optional. The address of the DMaaP Message Router.                         Defaults to `https://message-router.onap:3905`.
  13 >- PRODUCER_CERT_PATH  Optional. The path to the certificate to use for https.                    Defaults to `security/producer.crt`
  14 >- PRODUCER_KEY_PATH   Optional. The path to the key to the certificate to use for https.         Defaults to `security/producer.key`
  15 >- LOG_LEVEL           Optional. The log level, which can be `Error`, `Warn`, `Info` or `Debug`.  Defaults to `Info`.
  16
  17 The file `configs/type_config.json` contains the configuration of job types that the producer will support.
  18
  19     {
  20        "types":
  21         [
  22           {
  23             "id": The ID of the job type, e.g. "STD_Fault_Messages",
  24             "dmaapTopicUrl": The topic URL to poll from DMaaP Message Router, e.g. "events/unauthenticated.SEC_FAULT_OUTPUT/dmaapmediatorproducer/STD_Fault_Messages"
  25           }
  26       ]
  27     }
  28
  29 Any of the addresses used by this product can be configured to use https, by specifying it as the scheme of the address URI. Clients configured to use https will not use server certificate verification. The communication towards the consumers will use https if their callback address URI uses that scheme. The producer's own callback will only listen to the scheme configured in the scheme of the info producer host address.
  30
  31 The configured public key and cerificate shall be PEM-encoded. A self signed certificate and key are provided in the `security` folder of the project. These files should be replaced for production. To generate a self signed key and certificate, use the example code below:
  32
  33     openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650
  34
  35 ## Functionality
  36
  37 At start up the producer will register the configured job types in ICS and also register itself as a producer supporting these types. If ICS is unavailable, the producer will retry to connect indefinetely. The same goes for MR.
  38
  39 Once the initial registration is done, the producer will constantly poll MR for all configured job types. When receiving messages for a type, it will distribute these messages to all jobs registered for the type. If no jobs for that type are registered, the messages will be discarded. If a consumer is unavailable for distribution, the messages will be discarded for that consumer.
  40
  41 ## Development
  42
  43 To make it easy to test during development of the producer, two stubs are provided in the `stub` folder.
  44
  45 One, under the `dmaap` folder, called `dmaap` that stubs MR and respond with an array with one message with `eventSeverity` alternating between `NORMAL` and `CRITICAL`. The default port is `3905`, but this can be overridden by passing a `-port [PORT]` flag when starting the stub. To build and start the stub, do the following:
  46 >1. cd stub/dmaap
  47 >2. go build
  48 >3. ./dmaap
  49
  50 One, under the `consumer` folder, called `consumer` that at startup will register a job of type `STD_Fault_Messages` in ICS, and then listen for REST calls and print the body of them. By default, it listens to the port `40935`, but his can be overridden by passing a `-port [PORT]` flag when starting the stub. To build and start the stub, do the following:
  51 >1. cd stub/consumer
  52 >2. go build
  53 >3. ./consumer
  54
  55 Mocks needed for unit tests have been generated using `github.com/stretchr/testify/mock` and are checked in under the `mocks` folder. **Note!** Keep in mind that if any of the mocked interfaces change, a new mock for that interface must be generated and checked in.
  56
  57 ## License
  58
  59 Copyright (C) 2021 Nordix Foundation.
  60 Licensed under the Apache License, Version 2.0 (the "License")
  61 you may not use this file except in compliance with the License.
  62 You may obtain a copy of the License at
  63
  64       http://www.apache.org/licenses/LICENSE-2.0
  65
  66 Unless required by applicable law or agreed to in writing, software
  67 distributed under the License is distributed on an "AS IS" BASIS,
  68 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  69 See the License for the specific language governing permissions and
  70 limitations under the License.
  71
  72 For more information about license please see the [LICENSE](LICENSE.txt) file for details.