docs/sdnr_Docker_Image_configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 highstreet technologies and others
   4
   5 .. contents::
   6    :depth: 3
   7 ..
   8
   9 SDN-R Docker Image configuration
  10 ================================
  11
  12 Introduction
  13 ~~~~~~~~~~~~
  14
  15 ONAP SDN-R is running in a docker container using ONAP/SDN-C image
  16 "onap/sdnc".
  17
  18 The container is available as Alpine and Ubuntu version. The description
  19 uses examples for the Alpine version.
  20
  21 The alpine based sdnc docker images are stored in \ `ONAP Nexus sdnc
  22 image <https://nexus3.onap.org:10001/v2/onap/sdnc-image/tags/list>`__.
  23
  24 The docker image contains a OpenDaylight distribution in a standard
  25 configuration and ONAP/SDN-R specific microservices.
  26
  27 The Root location of ODL Karaf directory structure
  28 is \ *ODL\_HOME=/opt/opendaylight.*
  29
  30 During container provisioning the installation of the feature is done,
  31 according to the provided configuration setting.
  32
  33 The docker image configuration is done by
  34
  35 -  Specific Environment variables settings
  36
  37 -  Files that are provided
  38
  39 Container startup parameters
  40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  41
  42 The SDN-R specific configurations are provided during container start.
  43
  44 Different SDN-R services are using different parameter to be installed.
  45
  46 +----------------+-------------------+-----------------------------------------------------------------------------------------------------+
  47 | Parameter      | Content           | Description                                                                                         |
  48 +================+===================+=====================================================================================================+
  49 | SDNRWT         | true or **false** | Set true to activate sdnr wt feature set. Set this during container start.                          |
  50 +                +                   +-----------------------------------------------------------------------------------------------------+
  51 |                |                   | Devicemanager configuration is provided via *$ODL_HOME/etc/devicemanager.properties*                |
  52 +                +                   +-----------------------------------------------------------------------------------------------------+
  53 |                |                   | See  :doc:`SDN-R WT Service Configuration parameters <../sdnr_WT_Service_Configuration_parameters>` |
  54 +----------------+-------------------+-----------------------------------------------------------------------------------------------------+
  55 | SDNRNORTHBOUND | true or **false** | Set true to activate sdnr oofpci service.                                                           |
  56 +----------------+-------------------+-----------------------------------------------------------------------------------------------------+
  57
  58
  59