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) 2019 AT&T Intellectual Property
5 RIC Dashboard Configuration and Deployment
6 ==========================================
8 This documents the configuration and deployment of the O-RAN SC RIC
9 Dashboard web application, which is often deployed together with the
15 The application requires the following configuration files::
21 In the usual Kubernetes deployment, all file contents are provided by
24 Application Properties
25 ^^^^^^^^^^^^^^^^^^^^^^
27 The file ``application.yaml`` must be provided when the application
28 is launched, either in the current working directory or in a ``config``
29 subdirectory (latter is preferred). The Helm chart that deploys the
30 application should mount this file appropriately.
32 Many properties have default values cached within the application, in
33 file ``src/main/resources/application.yaml``. Properties with default
34 values do NOT need to be repeated in a deployment-specific configuration.
35 Properties without default values MUST be specified in a
36 deployment-specific configuration.
38 The properties are listed below in alphabetical order.
42 A1 Mediator URL prefix. No useful default. Usually a service name
43 like ``http://ricplt-entry/a1mediator``
47 A1 Mediator URL suffix. Default is the empty string.
51 Application Manager URL prefix. No useful default. Usually a service
52 name like ``http://ricplt-entry/appmgr``
56 Application Manager URL suffix. Default is ``/ric/v1``.
58 ``caasingress.aux.url.prefix``
60 CAAS-Ingress application URL prefix for the RIC Auxiliary cluster. No useful default.
62 ``caasingress.aux.url.suffix``
64 CAAS-Ingress application URL suffix for the RIC Auxiliary cluster. Default is ``api``.
66 ``caasingress.insecure``
68 Flag whether to disable SSL/TLS certificate and hostname verification.
69 If true, the dashboard can communicate with a CAAS-Ingress endpoint that
70 uses self-signed certificates.
72 ``caasingress.plt.url.prefix``
74 CAAS-Ingress application URL prefix for the RIC Platform cluster. No useful default.
76 ``caasingress.plt.url.suffix``
78 CAAS-Ingress application URL suffix for the RIC-PLT cluster. Default is ``api``.
82 E2 Manager URL prefix. No useful default. Usually a service name like
83 ``http://ricplt-entry/e2mgr``
87 E2 Manager URL prefix. Default is ``/v1``.
91 Sleep period for mock methods in milliseconds. This mimics slow
92 endpoints. Default is ``0``.
96 Application name expected at ONAP portal. Default is ``RIC Dashboard``
98 ``portalapi.decryptor``
100 Java class that decrypts ciphertext from Portal. Default is
101 ``org.oransc.ric.portal.dashboard.portalapi.PortalSdkDecryptorAes``.
103 ``portalapi.password``
105 REST password expected at ONAP portal. No default value.
107 ``portalapi.security``
109 Boolean flag whether the Dashboard limits access to users (browsers)
110 that present security tokens set by the ONAP Portal. If false, no
111 access control is performed, which is only appropriate for isolated
114 ``portalapi.usercookie``
116 Name of request cookie with user ID. Default is ``UserId``.
118 ``portalapi.username``
120 REST user name expected at ONAP portal. No default value.
124 Port where the Tomcat server listens for requests. Default is ``8080``.
128 Url to the kibana source which visualizes AC App metrics. No default value and needs to be replaced with actual value during deployment time.
132 Path of file that stores user details. Default is ``users.json``.
138 The file ``key.properties`` must be provided on the Java classpath for
139 the Spring-Boot application, as required by the EPSDK-FW library. The
140 Helm chart for the application should mount this file appropriately.
141 A sample file is in directory ``src/test/resources``.
143 The file must contain the following entries, listed here in
148 Encryption key used by the EPSDK-FW library. No default value.
154 The file ``portal.properties`` must be provided on the Java classpath
155 for the application, as required by the EPSDK-FW library. The Helm
156 chart for the application should mount this file appropriately. A
157 sample file is in directory ``src/test/resources``.
159 The file must contain the following entries, listed here in
162 ``ecomp_redirect_url``
164 Portal URL that is reachable by a user's browser. This is a value
166 ``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm``
170 Portal REST URL that is reachable by the Dashboard back-end.
171 This is a value like ``http://portal-app.onap:8989/ONAPPORTAL/auxapi``
173 ``portal.api.impl.class``
175 Java class name. No default value. Value must be
176 ``org.oransc.ric.portal.dashboard.portalapi.PortalRestCentralServiceImpl``
178 ``role_access_centralized``
180 Selector for role access. No default value. Value must be ``remote``.
184 Unique key assigned by ONAP Portal to the RIC Dashboard application.
191 A production server requires the configuration files listed above.
192 All files should be placed in a ``config`` directory. That name is
193 important; Spring automatically searches that directory for the
194 ``application.yaml`` file. Further, that directory can easily be
195 placed on the Java classpath so the additional files can be found at
199 On-Board Dashboard to ONAP Portal
200 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202 When on-boarding the Dashboard to the ONAP Portal the administrator
203 must supply the following information about the deployed instance:
205 - Dashboard URL that is reachable by a user's browser. The domain of
206 this host name must match the Portal URL that is similarly reachable
207 by a user's browser for cookie-based authentication to function as
208 expected. This should be a value like
209 ``http://dashboard.simpledemo.onap.org:8080``
210 - Dashboard REST URL that is reachable by the Portal back-end server.
211 This can be a host name or an IP address, because it does not use
212 cookie-based authentication. This must be a URL with suffix "/api/v3"
213 for example ``http://192.168.1.1:8080/api/v3``.
215 The Dashboard server only listens on a single port, so the examples
216 above both use the same port number. Different port numbers might be
217 required if an ingress controller or other proxy server is used.
219 After the on-boarding process is complete, the administrator must
220 enter values from the Portal for the following properties explained
223 - ``portalapi.password``
224 - ``portalapi.username``
230 After creating, populating and mounting Kubernetes config maps
231 appropriately, launch the server with this command-line invocation to
232 include the ``config`` directory on the Java classpath::
234 java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \
235 -Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \
236 org.springframework.boot.loader.PropertiesLauncher