Configure doc version as Amber

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

diff --git a/docs/config-deploy.rst b/docs/config-deploy.rst
index 5f62be4..11144ed 100644 (file)
--- a/docs/config-deploy.rst
+++ b/docs/config-deploy.rst
@@ -1,20 +1,6 @@
-.. ===============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
 ==========================================
@@ -76,7 +62,29 @@ name like ``http://ricplt-entry/appmgr``
 
 ``appmgr.url.suffix``
 
-Application Manager URL suffix. Default is ``/ric/v1``
+Application Manager URL suffix. Default is ``/ric/v1``.
+
+``caasingress.aux.url.prefix``
+
+CAAS-Ingress application URL prefix for the RIC Auxiliary cluster.  No useful default.
+
+``caasingress.aux.url.suffix``
+
+CAAS-Ingress application URL suffix for the RIC Auxiliary cluster. Default is ``api``.
+
+``caasingress.insecure``
+
+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.
+
+``caasingress.plt.url.prefix``
+
+CAAS-Ingress application URL prefix for the RIC Platform cluster.  No useful default.
+
+``caasingress.plt.url.suffix``
+
+CAAS-Ingress application URL suffix for the RIC-PLT cluster. Default is ``api``.
 
 ``e2mgr.url.prefix``
 
@@ -85,12 +93,12 @@ E2 Manager URL prefix. No useful default. Usually a service name like
 
 ``e2mgr.url.suffix``
 
-E2 Manager URL prefix. Default is ``/v1``
+E2 Manager URL prefix. Default is ``/v1``.
 
 ``mock.config.delay``
 
 Sleep period for mock methods in milliseconds.  This mimics slow
-endpoints. Default is ``0``
+endpoints. Default is ``0``.
 
 ``portalapi.appname``
 
@@ -99,7 +107,7 @@ Application name expected at ONAP portal. Default is ``RIC Dashboard``
 ``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``
 
@@ -114,7 +122,7 @@ lab testing.
 
 ``portalapi.usercookie``
 
-Name of request cookie with user ID. Default is ``UserId``
+Name of request cookie with user ID. Default is ``UserId``.
 
 ``portalapi.username``
 
@@ -122,7 +130,7 @@ REST user name expected at ONAP portal. No default value.
 
 ``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``
 
@@ -130,7 +138,7 @@ Url to the kibana source which visualizes AC App metrics. No default value and n
 
 ``userfile``
 
-Path of file that stores user details. Default is ``users.json``
+Path of file that stores user details. Default is ``users.json``.
 
 
 Key Properties
@@ -178,7 +186,7 @@ Java class name.  No default value.  Value must be
 
 ``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``
 
@@ -210,8 +218,8 @@ must supply the following information about the deployed instance:
   ``http://dashboard.simpledemo.onap.org:8080``
 - Dashboard REST URL that is reachable by the Portal back-end server.
   This can be a host name or an IP address, because it does not use
-  cookie-based authentication.  This should be a value like
-  ``http://192.168.1.1:8080/auxapi/v3``
+  cookie-based authentication.  This must be a URL with suffix "/api/v3"
+  for example ``http://192.168.1.1:8080/api/v3``.
 
 The Dashboard server only listens on a single port, so the examples
 above both use the same port number.  Different port numbers might be