docs/config.rst

   1 .. ===============LICENSE_START=======================================================
   2 .. O-RAN SC CC-BY-4.0
   3 .. %%
   4 .. Copyright (C) 2019 AT&T Intellectual Property and Nokia
   5 .. %%
   6 .. Licensed under the Apache License, Version 2.0 (the "License");
   7 .. you may not use this file except in compliance with the License.
   8 .. You may obtain a copy of the License at
   9 ..
  10 ..      http://www.apache.org/licenses/LICENSE-2.0
  11 ..
  12 .. Unless required by applicable law or agreed to in writing, software
  13 .. distributed under the License is distributed on an "AS IS" BASIS,
  14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 .. See the License for the specific language governing permissions and
  16 .. limitations under the License.
  17 .. ===============LICENSE_END=========================================================
  18
  19 ===========================
  20 RIC Dashboard Configuration
  21 ===========================
  22
  23 This documents the configuration parameters for the O-RAN SC RIC
  24 Dashboard web application.
  25
  26 Application Properties
  27 ----------------------
  28
  29 This Spring-Boot project reads parameters from file
  30 ``application.properties`` in the current working directory when
  31 launched, or from the same file in a ``config`` subdirectory. The
  32 application properties are listed in alphabetical order. Most have
  33 default values, but not all.
  34
  35 ``a1med.url.prefix``
  36
  37 A1 Mediator URL prefix.  Usually a service name like
  38 "http://ricplt-entry/a1mediator"
  39
  40 ``a1med.url.suffix``
  41
  42 A1 Mediator URL suffix; default is empty.
  43
  44 ``anrxapp.url.prefix``
  45
  46 ANR Application URL prefix.  Usually a service name like
  47 "http://ricxapp-entry/anr"
  48
  49 ``anrxapp.url.suffix``
  50
  51 ANR Application URL suffix; default is empty.
  52
  53 ``appmgr.url.prefix``
  54
  55 Application Manager URL prefix. Usually a service name like
  56 "http://ricplt-entry/appmgr"
  57
  58 ``appmgr.url.suffix``
  59
  60 Application Manager URL suffix. Default is "/ric/v1".
  61
  62 ``e2mgr.url.prefix``
  63
  64 E2 Manager URL prefix. Usually a service name like
  65 "http://ricplt-entry/e2mgr".
  66
  67 ``e2mgr.url.suffix``
  68
  69 E2 Manager URL prefix. Default is "/v1".
  70
  71 ``mock.config.delay``
  72
  73 Sleep period for mock methods in milliseconds.  This mimics slow
  74 endpoints. Default is 0.
  75
  76
  77 ``portalapi.appname``
  78
  79 Application name expected at ONAP portal; default "RIC Dashboard"
  80
  81 ``portalapi.decryptor``
  82
  83 Java class that decrypts ciphertext from Portal; default
  84 "org.oransc.ric.portal.dashboard.portalapi.PortalSdkDecryptorAes"
  85
  86 ``portalapi.password``
  87
  88 Application password expected at ONAP portal; no default.
  89
  90 ``portalapi.usercookie``
  91
  92 Name of request cookie with user ID; default "UserId"
  93
  94 ``portalapi.username``
  95
  96 Application user name expected at ONAP portal; no default.
  97
  98 ``server.port``
  99
 100 Tomcat server port, default 8080
 101
 102 ``userfile``
 103
 104 Path to file that stores user details; default "users.json"
 105
 106
 107 Key Properties
 108 --------------
 109
 110 The file ``key.properties`` must be found on the Java classpath.  It
 111 must contain the following entries.
 112
 113 ``cipher.enc.key``
 114
 115 Encryption key used by the EPSDK-FW library.
 116
 117
 118 Portal Properties
 119 -----------------
 120
 121 The file ``portal.properties`` must be found on the Java classpath.
 122 It must contain the following entries.
 123
 124 ``ecomp_redirect_url``
 125
 126 URL of ONAP Portal.  Usually a value like
 127 "https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm"
 128
 129 ``ecomp_rest_url``
 130
 131 URL of ONAP Portal REST endpoint.  Usually a value like
 132 "http://portal-app.onap:8989/ONAPPORTAL/auxapi"
 133
 134 ``portal.api.impl.class``
 135
 136 Java class name.  Default is "org.oransc.ric.portal.dashboard.portalapi.PortalRestCentralServiceImpl"
 137
 138 ``role_access_centralized``
 139
 140 Default value is "remote".
 141
 142 ``ueb_app_key``
 143
 144 Unique key assigned by ONAP Portal to the RIC Dashboard application.
 145 No default.