summaryrefslogtreecommitdiffstats
path: root/docs/docs-configuration.rst
diff options
context:
space:
mode:
authorOfir Sonsino <os0695@att.com>2017-11-08 11:31:34 +0200
committerOfir Sonsino <os0695@att.com>2017-11-08 11:31:34 +0200
commit0e1e6a925e99446cdd653b606b04c2fc43fb28c0 (patch)
treed788259eaa8d040753b5eb7df81054c9a4763718 /docs/docs-configuration.rst
parentce389b5342e7614c5d79533b718710dc4b76e6b8 (diff)
Update ReadTheDocs docs folder
Change-Id: Ia95169494404548706371f608b4e53ac8ffa6ad2 Issue-ID: VID-71 Signed-off-by: Ofir Sonsino <os0695@att.com>
Diffstat (limited to 'docs/docs-configuration.rst')
-rw-r--r--docs/docs-configuration.rst53
1 files changed, 36 insertions, 17 deletions
diff --git a/docs/docs-configuration.rst b/docs/docs-configuration.rst
index 9142c4c61..6357d5aac 100644
--- a/docs/docs-configuration.rst
+++ b/docs/docs-configuration.rst
@@ -4,57 +4,76 @@
Configuration
=============
-Configurations files are located under ``WEB-INF/conf/``
+Configurations .properties files are located under ``WEB-INF/conf/``, while .js files are under ``scripts/constants/``
system.properties file
----------------------
``db.connectionURL``
- The connection URL for VID database
+ The connection URL for the VID database
``db.userName``
- The username for VID database
+ The username for the VID database
``db.password``
- The password for VID database
+ The password for the VID database
``aai.server.url.base``
- Base URL for A&AI server
+ Base URL for the A&AI server
``aai.server.url``
- URL for A&AI server including its version (default: v11)
+ URL for the A&AI server including its version (default: v11)
``aai.vid.username``, ``aai.vid.pass``
- Credentials for accessing A&AI
+ Credentials for accessing A&AI server offered APIs
``mso.server.url``
- Base URL for SO server
+ Base URL for the SO server
``mso.polling.interval.msecs``
- Interval in milliseconds for polling SO for instantiation status
+ Interval in milliseconds for polling the SO for the instantiation status
``mso.max.polls``
- Max polling tryings fo SO instantiation status
+ Max attempts for polling the SO instantiation status
``mso.user.name``, ``mso.password.x``
- Credentials for accessing SO
+ Credentials for accessing the SO server
``scheduler.server.url``
- Base URL for Scheduler
+ Base URL for the Scheduler
``scheduler.create.new.vnf.change.instance``, ``scheduler.get.time.slots``, ``scheduler.submit.new.vnf.change``, ``scheduler.get.schedules``
Scheduler endpoints
asdc.properties file
-----------------------------
+----------------------
``asdc.client.rest.protocol``
- States the protocol for accessing SDC: http or https
+ States the protocol used for accessing SDC: http or https
``asdc.client.rest.host``
- States the hostname of SDC instance
+ States the hostname of the SDC instance
``asdc.client.rest.port``
- States the port of SDC instance
+ States the port of the SDC instance
``asdc.client.rest.auth``
- Basic authorization string to access SDC \ No newline at end of file
+ Basic authorization string for accessing SDC
+
+vidConfiguration.js file
+------------------------
+``MSO_MAX_POLLS``
+ Max attempts for polling the SO instantiation status
+
+``MSO_POLLING_INTERVAL_MSECS``
+ Interval in milliseconds for polling the SO for the instantiation status
+
+``SCHEDULER_POLLING_INTERVAL_MSECS``
+ Interval in milliseconds for polling the Scheduler
+
+``SCHEDULER_MAX_POLLS``
+ Max attempts for polling the Scheduler
+
+``MACRO_SERVICES``
+ | List of all service model invariant UUIDs that need macro instantiation.
+ | Example: ["3cf30cbb-5fe7-4fb3-b049-559a4997b221", "b135a703-bab5-4295-a37f-580a4f2d0961"]
+ \ No newline at end of file