-.. ===============LICENSE_START=======================================================
-.. O-RAN SC CC-BY-4.0
-.. %%
-.. Copyright (C) 2019 AT&T Intellectual Property and Nokia
-.. %%
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-.. ===============LICENSE_END=========================================================
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 AT&T Intellectual Property
RIC Dashboard Configuration and Deployment
==========================================
The application requires the following configuration files::
- application.properties
+ application.yaml
key.properties
portal.properties
-In the usual Kubernetes deployment, all file contents are provided by
-a configuration map.
+In Kubernetes deployment, all file contents are provided by a
+configuration map. Construction of Helm charts, config maps and other
+Kubernetes deployment resources is beyond the scope of this document.
Application Properties
^^^^^^^^^^^^^^^^^^^^^^
-The file ``application.properties`` must be provided when the
-application is launched, either in the current working directory or in
-a ``config`` subdirectory (latter is preferred). The Helm chart that
+The file ``application.yaml`` must be provided when the application is
+launched, either in the current working directory or in a ``config``
+subdirectory (latter is preferred). For example, a Helm chart that
deploys the application should mount this file appropriately.
Many properties have default values cached within the application, in
-file ``src/main/resources/application.properties``. Properties with
-default values do NOT need to be repeated in a deployment-specific
-configuration. Properties without default values MUST be specified in
-a deployment-specific configuration.
+file ``src/main/resources/application.yaml``. Properties with default
+values do NOT need to be repeated in a deployment-specific configuration.
+Properties without default values MUST be specified in a
+deployment-specific configuration.
-The properties are listed below in alphabetical order.
+The properties are listed below in alphabetical order with their fully
+qualified dot-separated names, for example "server.port". Please note
+that in the YAML file, every component of the name is on a separate
+line, for example::
-``a1med.url.prefix``
+ server:
+ port: 8080
+
+The application uses the following properties.
-A1 Mediator URL prefix. No useful default. Usually a service name
-like ``http://ricplt-entry/a1mediator``
-
-``a1med.url.suffix``
-
-A1 Mediator URL suffix. Default is the empty string.
-
-``anrxapp.url.prefix``
-
-ANR Application URL prefix. No useful default. Usually a service name
-like ``http://ricxapp-entry/anr``
-
-``anrxapp.url.suffix``
+``appmgr.url.suffix``
-ANR Application URL suffix. Default is the empty string.
+Application Manager URL suffix. Default is ``/appmgr/ric/v1``.
-``appmgr.url.prefix``
+``caasingress.aux.url.suffix``
-Application Manager URL prefix. No useful default. Usually a service
-name like ``http://ricplt-entry/appmgr``
+CAAS-Ingress application URL suffix for the RIC Auxiliary cluster. Default is ``api``.
-``appmgr.url.suffix``
+``caasingress.insecure``
-Application Manager URL suffix. Default is ``/ric/v1``
+Flag whether to disable SSL/TLS certificate and hostname verification.
+If true, the dashboard can communicate with a CAAS-Ingress endpoint that
+uses self-signed certificates.
-``e2mgr.url.prefix``
+``caasingress.plt.url.suffix``
-E2 Manager URL prefix. No useful default. Usually a service name like
-``http://ricplt-entry/e2mgr``
+CAAS-Ingress application URL suffix for the RIC-PLT cluster. Default is ``api``.
``e2mgr.url.suffix``
-E2 Manager URL prefix. Default is ``/v1``
-
-``mock.config.delay``
-
-Sleep period for mock methods in milliseconds. This mimics slow
-endpoints. Default is ``0``
+E2 Manager URL suffix. Default is ``/e2mgr/v1``.
``portalapi.appname``
``portalapi.decryptor``
Java class that decrypts ciphertext from Portal. Default is
-``org.oransc.ric.portal.dashboard.portalapi.PortalSdkDecryptorAes``
+``org.oransc.ric.portal.dashboard.portalapi.PortalSdkDecryptorAes``.
``portalapi.password``
``portalapi.usercookie``
-Name of request cookie with user ID. Default is ``UserId``
+Name of request cookie with user ID. Default is ``UserId``.
``portalapi.username``
REST user name expected at ONAP portal. No default value.
+``ricinstances.regions``
+
+List of RIC region entries. Each region has a name and a list of RIC
+instances. A region has entries as shown below, where the "[0]"
+notation refers to the first instance in a list. A partial example
+appears next::
+
+ ricinstances:
+ regions:
+ -
+ name: Region AAA
+ instances:
+ -
+ key: i1
+ name: Primary RIC Instance
+ appUrlPrefix: App prefix 1
+ caasUrlPrefix: Caas prefix 1
+ pltUrlPrefix: Plt prefix 1
+
+
+``ricinstances.regions[0].name``
+
+User-friendly name of the region.
+
+``ricinstances.regions[0].instances[0].key``
+
+Unique key for the instance, across all instances.
+
+``ricinstances.regions[0].instances[0].name``
+
+User-friendly name for the instance.
+
+``ricinstances.regions[0].instances[0].appUrlPrefix``
+
+xApplication URL prefix. In a Kubernetes deployment, this should be
+the URL where an ingress service listens. Usually a service
+name like ``http://ricplt-entry/xapp``
+
+``ricinstances.regions[0].instances[0].caasUrlPrefix``
+
+CAAS-Ingress application URL prefix for the RIC Auxiliary cluster.
+
+``ricinstances.regions[0].instances[0].pltUrlPrefix``
+
+RIC Platform URL prefix. In a Kubernetes deployment, this should be
+the URL where an ingress service listens. Usually a service name like
+``http://ricplt-entry/xapp``
+
``server.port``
-Port where the Tomcat server listens for requests. Default is ``8080``
+Port where the Tomcat server listens for requests. Default is
+``8080``.
-``metrics.url.ac``
+``statsfile``
-Url to the kibana source which visualizes AC App metrics. No default value and needs to be replaced with actual value during deployment time.
+Path of file that stores application statistic details. Default is
+``dashboard-stats.json``.
``userfile``
-Path of file that stores user details. Default is ``users.json``
+Path of file that stores user details. Default is
+``dashboard-users.json``.
+``xappobrd.url.suffix``
+
+Xapp Onboarder URL suffix. Default is ``/xapporbd/api/v1``.
Key Properties
^^^^^^^^^^^^^^
``ecomp_rest_url``
-Portal REST URL that is reachable by the Dashboard back-end.
+Portal REST URL that is reachable by the Dashboard back-end.
This is a value like ``http://portal-app.onap:8989/ONAPPORTAL/auxapi``
``portal.api.impl.class``
``role_access_centralized``
-Selector for role access. No default value. Value must be ``remote``
+Selector for role access. No default value. Value must be ``remote``.
``ueb_app_key``
A production server requires the configuration files listed above.
All files should be placed in a ``config`` directory. That name is
important; Spring automatically searches that directory for the
-``application.properties`` file. Further, that directory can easily be
+``application.yaml`` file. Further, that directory can easily be
placed on the Java classpath so the additional files can be found at
runtime.
appropriately, launch the server with this command-line invocation to
include the ``config`` directory on the Java classpath::
- java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \
- -Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \
- org.springframework.boot.loader.PropertiesLauncher
-
-Alternately, to use the configuration in the "application-abc.properties" file,
-modify the command to have "spring.config.name=name" like this::
-
- java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \
- -Dspring.config.name=application-abc \
+ java -cp config:target/ric-dash-be-2.0.1-SNAPSHOT.jar \
-Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \
org.springframework.boot.loader.PropertiesLauncher
Code Review / portal / ric-dashboard.git / blobdiff