DRAFT

This page describes how to get the release F G version of Non-RT RIC up and running locally with locally with three separate A1 simulator (previously called Near-RT RIC A1 Interface) docker containers providing STD_1.1.3, STD_2.0.0 and OSC_2.1.0 versions of the A1 interface.

All components of the Non-RT RIC run as docker containers and communicate via a private docker network with container ports, ports also available on localhost. Details of the architecture can be found from Release G page.

Project Requirements

• Docker and docker-compose (latest)

• Additional optional requirements if using the "Helm Manager" function
  • kubernetes v1.19+
  • kubectl with admin access to kubernetes (minikube, docker-desktop kubernetes etc) 
  -  this is only applicable when running the Helm Manager
  • helm with access to kubernetes -
   this
  • this is only applicable when running the Helm Manager example
  operations
  • operations 

Images

The images used for running the Non-RT RIC can be selected from the table below depending on if the images are built manually (snapshot image) or if release images shall be used.

...

The run commands throughout this page uses the release images and tags. Replace the release images/tags in the container run commands in the instructions if manually-built snapshot images are desired. 

G Maintenance Release images

Note: A version of this table appears Integration&Testing - G Release Docker Image List - NONRTRIC (G-Release). This is the authoritative version! 

Ports

The following ports will be allocated and exposed to localhost for each component. If other port(s) are desired, then the ports need to be replaced in the container run commands in the instructions further below.

...

Prerequisites

The containers need to be connected to docker network in order to communicate with each other.

...

Run the A1 Policy Management Service Docker Container

To support local test with three separate A1 simulator (previously called Near-RT RIC A1 Interface) instances, each running a one of the three available A1 Policy interface versions:  

• Create an application_configuration.json file with the configuration below.  This will configure the policy management service to use the simulators for the A1 interface
• Note: Any defined ric names must match the given docker container names in near-RT RIC simulator startup, see Run A1 (previously called Near-RT RIC A1 Interface) Simulator Docker Containers

The policy management service can be configure with or without a A-Controller. Choose the appropriate configuration below.A1 Policy Mnagement Service can be configured to support A1 connection via an SDNC A1-Controller for some or all rics/simulators. It is optional to access the near-RT-RIC through an A1-Controller.
This is configured using the optional "controller" paramter for each ric entry. If all configured rics bypass the A1-Controller (do not have "controller" values) then the "controller" object at the top of the configuration can be omitted. If all configured rics bypass the A1-Controller there is no need to start an A1-Controller.

This sample configuration This file is for running without the SDNC A1-Controller

{
  "config": {
    "ric": [
      {
        "name": "ric1",
        "baseUrl": "http://ric1:8085/",
        "managedElementIds": [
          "kista_1",
          "kista_2"
        ]
      },
      {
        "name": "ric2",
        "baseUrl": "http://ric2:8085/",
        "managedElementIds": [
          "kista_3",
          "kista_4"
        ]
      },
      {
        "name": "ric3",
        "baseUrl": "http://ric3:8085/",
        "managedElementIds": [
          "kista_5",
          "kista_6"
        ]
      }
    ]
  }
}

This file sample configuration is for running with the SDNC A1-Controller.

{
    "config": {
        "controller": [
            {
                "name": "a1controller",
                "baseUrl": "https://a1controller:8443",
                "userName": "admin",
                "password": "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U"
            }
        ],
        "ric": [
            {
                "name": "ric1",
                "baseUrl": "http://ric1:8085/",
                "controller": "a1controller",
                "managedElementIds": [
                    "kista_1",
                    "kista_2"
                ]
            },
            {
                "name": "ric2",
                "baseUrl": "http://ric2:8085/",
                "controller": "a1controller",
                "managedElementIds": [
                    "kista_3",
                    "kista_4"
                ]
            },
            {
                "name": "ric3",
                "baseUrl": "http://ric3:8085/",
                "controller": "a1controller",
                "managedElementIds": [
                    "kista_5",
                    "kista_6"
                ]
            }
        ]
    }
}

...

Run the SDNC A1 Controller Docker Container (ONAP SDNC)

This step is only applicable if the configuration for the Policy Management Service include the SDNC A1 Controller (second config option), see Run the Policy Management Service Docker Container.

Create the docker compose file - be sure to update image for the a1controller to the one listed for SDNC A1 Controller in the table on the top of this page.
docker-compose.yaml Expand source

version: '3'
 
networks:
  default:
    external: true
    name: nonrtric-docker-net
 
services:
  db:
    image: nexus3.o-ran-sc.org:10001/mariadb:10.5
    container_name: sdncdb
    networks:
      - default
    ports:
      - "3306"
    environment:
      - MYSQL_ROOT_PASSWORD=itsASecret
      - MYSQL_ROOT_HOST=%
      - MYSQL_USER=sdnctl
      - MYSQL_PASSWORD=gamma
      - MYSQL_DATABASE=sdnctl
    logging:
      driver:   "json-file"
      options:
        max-size: "30m"
        max-file: "5"
 
  a1controller:
    image: nexus3.onap.org:10002/onap/sdnc-image:2.4.2
    depends_on :
      - db
    container_name: a1controller
    networks:
      - default
    entrypoint: ["/opt/onap/sdnc/bin/startODL.sh"]
    ports:
      - 8282:8181
      - 8443:8443
    links:
      - db:dbhost
      - db:sdnctldb01
      - db:sdnctldb02
    environment:
      - MYSQL_ROOT_PASSWORD=itsASecret
      - MYSQL_USER=sdnctl
      - MYSQL_PASSWORD=gamma
      - MYSQL_DATABASE=sdnctl
      - SDNC_CONFIG_DIR=/opt/onap/sdnc/data/properties
      - SDNC_BIN=/opt/onap/sdnc/bin
      - ODL_CERT_DIR=/tmp
      - ODL_ADMIN_USERNAME=admin
      - ODL_ADMIN_PASSWORD=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
      - ODL_USER=admin
      - ODL_PASSWORD=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
      - SDNC_DB_INIT=true
      - A1_TRUSTSTORE_PASSWORD=a1adapter
      - AAI_TRUSTSTORE_PASSWORD=changeit
    logging:
      driver:   "json-file"
      options:
        max-size: "30m"
        max-file: "5"

...

Run the A1 Simulator (previously called Near-RT RIC A1 Interface) Docker Containers

Start a simulator for each ric defined in in the application_configuration.json created in Run the Policy Management Service Docker Container. Each simulator will use one of the currently available A1 interface versions.

...

Run the Information Coordinator Service Docker Container

Run the following command to start the information coordinator service.

...

For troubleshooting/verification purposes you can view/access the full swagger API from url: http://localhost:8083/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

Run the Non-RT RIC Gateway and Control Panel Docker Container

The Gateway exposes the interfaces of the Policy Management Service and the Information Coordinator Service to a single port of the gateway. This single port is then used by the control panel to access both services.

...

The webbased UI can be accessed by pointing the web-browser to this URL: 

http://localhost:8080/

Run the App Catalogue Service Docker Container

Start the App Catalogue Service by the following command.

...

Expected output:

Run the App Catalogue Enhanced Service Docker Container

Start the App Catalogue Enhanced Service by the following command.

Verify that the service is up and running

Expected output:

Run the Helm Manager Docker Container

Note: Access to kubernetes is required as stated the requirements on the top of this page.

...

Start the helm manger in a separate shell by the following command:

...

Start a chartmuseum chart repository in a separate shell

Add the chart repo to the helm manager by the following command:

...

The commands below show examples of operations towards the helm manager using the dummy chart.

...

...

Run

...

the DMaaP Adapter Service Docker Container

The Dmaap DMaaP Adapter Service needs two configurations files, one for the application specific parameters and one for the types the application supports.

...

The following parameter need to be configured according to hosts and ports  (these setting may need to adjusted to your environment)

• ics-base-url: https://information-service-container:8434/
• dmaap-base-url: https://message-router:3905/  (needed when data is received from the Dmaap message router)
• bootstrap-servers: message-router-kafka:9092 (needed when data is received on a kafka topic)

...

spring:
  profiles:
    active: prod
  main:
    allow-bean-definition-overriding: true
  aop:
    auto: false
management:
  endpoints:
    web:
      exposure:
        # Enabling of springboot actuator features. See springboot documentation.
        include: "loggers,logfile,health,info,metrics,threaddump,heapdump"
springdoc:
  show-actuator: true
logging:
  # Configuration of logging
  level:
    ROOT: ERROR
    org.springframework: ERROR
    org.springframework.data: ERROR
    org.springframework.web.reactive.function.client.ExchangeFunctions: ERROR
    org.oran.dmaapadapter: INFO
  file:
    name: /var/log/dmaap-adapter-service/application.log
server:
   # Configuration of the HTTP/REST server. The parameters are defined and handeled by the springboot framework.
   # See springboot documentation.
   port : 8435
   http-port: 8084
   ssl:
      key-store-type: JKS
      key-store-password: policy_agent
      key-store: /opt/app/dmaap-adapter-service/etc/cert/keystore.jks
      key-password: policy_agent
      key-alias: policy_agent
app:
  webclient:
    # Configuration of the trust store used for the HTTP client (outgoing requests)
    # The file location and the password for the truststore is only relevant if trust-store-used == true
    # Note that the same keystore as for the server is used.
    trust-store-used: false
    trust-store-password: policy_agent
    trust-store: /opt/app/dmaap-adapter-service/etc/cert/truststore.jks
    # Configuration of usage of HTTP Proxy for the southbound accesses.
    # The HTTP proxy (if configured) will only be used for accessing NearRT RIC:s
    http.proxy-host:
    http.proxy-port: 0
  ics-base-url: https://information-service-container:8434
  # Location of the component configuration file. The file will only be used if the Consul database is not used;
  # configuration from the Consul will override the file.
  configuration-filepath: /opt/app/dmaap-adapter-service/data/application_configuration.json
  dmaap-base-url: https://message-router:3905
  # The url used to address this component. This is used as a callback url sent to other components.
  dmaap-adapter-base-url: https://dmaapadapterservice:8435
  zip-output: false
  # KAFKA boostrap server. This is only needed if there are Information Types that uses a kafkaInputTopic
  kafka:
    bootstrap-servers: message-router-kafka:9092

Create the file application_configuration.json according to one of alternatives below.
 application_configuration.json without kafka type
 application

{

...

  "types":

...

 [
     {
        "id":

...

 "ExampleInformationType",

...

        "dmaapTopicUrl":

...

 "/events/unauthenticated.dmaapadp.json/dmaapadapterproducer/msgs?timeout=15000&limit=100",

...

        "useHttpProxy":

...

 false
     }
  ]
}

...

{

...

  "types":

...

 [
     {
        "id":

...

 "ExampleInformationType",

...

        "dmaapTopicUrl":

...

 "/events/unauthenticated.dmaapadp.json/dmaapadapterproducer/msgs?timeout=15000&limit=100",

...

        "useHttpProxy":

...

 false
     },
     {
      "id":

...

 "ExampleInformationTypeKafka",

...

      "kafkaInputTopic":

...

 "unauthenticated.dmaapadp_kafka.text",

...

      "useHttpProxy":

...

 false
   }
  ]
}

Start the Dmaap Adapter Service in a separate shell with the following command:

Setup jobs to produce data according to the types in application_configuration.json

Create a file job1.json with the job definition (replace paths <url-for-jod-data-delivery> and <url-for-jod-status-delivery> to fit your environment:

{

...

  "info_type_id":

...

 "ExampleInformationType",

...

  "job_result_uri":

...

 "<url-for-jod-data-delivery>",

...

  "job_owner":

...

 "job1owner",

...

  "status_notification_uri":

...

 "<url-for-jod-status-delivery>",

...

  "job_definition": {}

...

}

Create job1 for type 'ExampleInformationType'

Check that the job has been enabled - job accepted by the Dmaap Adapter Service

...

Create a file job2.json with the job definition (replace paths <url-for-jod-data-delivery> and <url-for-jod-status-delivery> to fit your enviroment:

{

...

  "info_type_id":

...

 "ExampleInformationTypeKafka",

...

  "job_result_uri":

...

 "<url-for-jod-data-delivery>",

...

  "job_owner":

...

 "job1owner",

...

  "status_notification_uri":

...

 "<url-for-jod-status-delivery>",

...

  "job_definition": {}

...

}

Create job2 for type 'ExampleInformationType'

Check that the job has been enabled - job accepted by the Dmaap Adapter Service

...

Data posted on the kafka topic unauthenticated.dmaapadp_kafka.text will be delivered to the path as specified in the job2.json.

Run the Dmaap Mediator Producer Docker Container

The Dmaap Mediator Producer needs one configuration file for the types the application supports.

...

Create the file type_config.json with the content below:

{

...

    "types":

...

 [
        {
            "id":

...

 "STD_Fault_Messages",

...

            "dmaapTopicUrl":

...

 "/events/unauthenticated.dmaapmed.json/dmaapmediatorproducer/STD_Fault_Messages?timeout=15000&limit=100"

...

        }
    ]
}

There are a number of environment variables that need to be set when starting the application. See these example settings:

...

Start the Dmaap Mediator Producer in a separate shell with the following command:

Setup jobs to produce data according to the types in type_config.json

Create a file job3.json with the job definition (replace paths <url-for-jod-data-delivery> and <url-for-jod-status-delivery> to fit your environment:

{
  "info_type_id": "STD_Fault_Messages",
  "job_result_uri": "<url-for-job-data-delivery>",
  "job_owner": "job3owner",
  "status_notification_uri": "<url-for-

...

job-

...

status-delivery>",
  "job_definition": {}
}

Create job3 for type 'ExampleInformationType'

Check that the job has been enabled - job accepted by the Dmaap Adapter Service

Data posted on the message router topic unauthenticated.dmaapmed.json will be delivered to the path as specified in the job3.json.

Run SME CAPIF Core

Start the CAPIF Core in a separate shell with the following command:

This is a basic start command without helm. See repo README for more options.

Check that the component has started.

...

Create job3 for type 'ExampleInformationType'

Check that the job has been enabled - job accepted by the Dmaap Adapter Service

Data posted on the message router topic unauthenticated.dmaapmed.json will be delivered to the path as specified in the job3.json

Run usecases

Within NON-RT RIC a number of usecase implementations are provided. Follow the links below to see how to run them.

...

Run use cases

Within NON-RT RIC a number of use case implementations are provided. Follow the links below to see how to run them.

...