Update documentation
[oam.git] / docs / sdnr_Docker_Image_configuration.rst
1 .. contents::
2    :depth: 3
3 ..
4
5 SDN-R Docker Image configuration
6 ================================
7
8 Introduction
9 ~~~~~~~~~~~~
10
11 ONAP SDN-R is running in a docker container using ONAP/SDN-C image
12 "onap/sdnc".
13
14 The container is available as Alpine and Ubuntu version. The description
15 uses examples for the Alpine version.
16
17 The alpine based sdnc docker imanges are stored in \ `ONAP Nexus sdnc
18 image <https://nexus3.onap.org:10001/v2/onap/sdnc-image/tags/list>`__.
19
20 The docker image contains a Opendaylight distribution in a standard
21 configuration and ONAP/SDN-R specific microservices.
22
23 The Root location of ODL Karaf directory structure
24 is \ *ODL\_HOME=/opt/opendaylight.*
25
26 During container provisioning the installation of the feature is done,
27 according to the provided configuration setting.
28
29 The docker image configuration is done by
30
31 -  Specific Environment variables settings
32
33 -  Files that are provided
34
35 Container startup parameters
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38 The SDN-R specific configurations are provided during container start. 
39
40 Different SDN-R services are using different parameter to be installed.
41
42 +------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
43 | **Parameter**    | **Content**         | **Description**                                                                                                         |
44 +==================+=====================+=========================================================================================================================+
45 | SDNRWT           | true\|\ **false**   | Set true to activate sdnr wt featureset. Set this during container start.                                               |
46 |                  |                     |                                                                                                                         |
47 |                  |                     | Devicemanager configuration is provided via *$ODL\_HOME/etc/devicemanager.properties*                                   |
48 |                  |                     |                                                                                                                         |
49 |                  |                     | See  `SDN-R WT Service Configuration parameters <sdnr_WT_Service_Configuration_parameters.html>`__                     |
50 +------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
51 | SDNRNORTHBOUND   | true\|\ **false**   | Set true to activate sdnr oofpci service.                                                                               |
52 +------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+