X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconfig-deploy.rst;h=ddf164f9ba3c9bd4e5c895980c118296e4dd2ef9;hb=f6f5bf3401f62a8f6019da3196423e5b26be2254;hp=11144eda31ab2831ac7040b50173f825a34b017a;hpb=c4d5b6c02be72614aa70f0b6222d784af47b2a7e;p=portal%2Fric-dashboard.git diff --git a/docs/config-deploy.rst b/docs/config-deploy.rst index 11144eda..ddf164f9 100644 --- a/docs/config-deploy.rst +++ b/docs/config-deploy.rst @@ -14,7 +14,7 @@ Configuration The application requires the following configuration files:: - application.properties + application.yaml key.properties portal.properties @@ -24,16 +24,16 @@ a configuration map. 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 -deploys the application should mount this file appropriately. +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). The 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. @@ -46,15 +46,6 @@ like ``http://ricplt-entry/a1mediator`` 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`` - -ANR Application URL suffix. Default is the empty string. - ``appmgr.url.prefix`` Application Manager URL prefix. No useful default. Usually a service @@ -176,7 +167,7 @@ like ``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`` @@ -200,7 +191,7 @@ Deployment 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. @@ -243,11 +234,3 @@ 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 \ - -Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \ - org.springframework.boot.loader.PropertiesLauncher