Adjust application.yaml keys and values

[portal/ric-dashboard.git] / docs / config-deploy.rst

diff --git a/docs/config-deploy.rst b/docs/config-deploy.rst
index 1063848..bdadbe1 100644 (file)
--- a/docs/config-deploy.rst
+++ b/docs/config-deploy.rst
@@ -1,5 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
 .. 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
 ==========================================
 
 RIC Dashboard Configuration and Deployment
 ==========================================


@@ -13,7 +14,7 @@ Configuration
 
 The application requires the following configuration files::
 
 
 The application requires the following configuration files::
 

-    application.properties
+    application.yaml

     key.properties
     portal.properties
 
     key.properties
     portal.properties
 


@@ -23,16 +24,16 @@ a configuration map.
 Application Properties
 ^^^^^^^^^^^^^^^^^^^^^^
 
 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
 
 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.
 


@@ -175,7 +176,7 @@ like
 
 ``ecomp_rest_url``
 
 
 ``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``
 This is a value like ``http://portal-app.onap:8989/ONAPPORTAL/auxapi``
 
 ``portal.api.impl.class``


@@ -199,7 +200,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
 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.
 
 placed on the Java classpath so the additional files can be found at
 runtime.
 


@@ -242,11 +243,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
     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