Update ReadTheDocs docs folder 65/20365/1
authorOfir Sonsino <os0695@att.com>
Tue, 24 Oct 2017 14:20:13 +0000 (17:20 +0300)
committerOfir Sonsino <os0695@att.com>
Tue, 24 Oct 2017 14:20:13 +0000 (17:20 +0300)
Change-Id: Ie1eb45f5116d420e2caa1dce39e5c7ca5dd2de18
Issue-ID: VID-71
Signed-off-by: Ofir Sonsino <os0695@att.com>
docs/docs-configuration.rst
docs/docs-logging.rst
docs/index.rst

index 085f9c6..9142c4c 100644 (file)
@@ -4,24 +4,57 @@
 Configuration
 =============
 
-.. note::
-   * This section is used to describe the options a software component offers for configuration.
+Configurations files are located under ``WEB-INF/conf/``
 
-   * Configuration is typically: provided for platform-component and sdk projects;
-     and referenced in developer and user guides.
-   
-   * This note must be removed after content has been added.
+system.properties file
+----------------------
 
+``db.connectionURL``
+  The connection URL for VID database
 
+``db.userName``
+  The username for VID database
 
-Example ...
+``db.password``
+  The password for VID database
 
-You can provide the following in ``basic.conf``
+``aai.server.url.base``
+  Base URL for A&AI server
 
-``host=ADDRESS``
-  The address of the host
+``aai.server.url``
+  URL for A&AI server including its version (default: v11)
 
-``port=PORT``
-  The port used for signaling
+``aai.vid.username``, ``aai.vid.pass``
+  Credentials for accessing A&AI
 
-  Optional. Default: ``8080``
+``mso.server.url``
+  Base URL for SO server
+
+``mso.polling.interval.msecs``
+  Interval in milliseconds for polling SO for instantiation status
+
+``mso.max.polls``
+  Max polling tryings fo SO instantiation status
+  
+``mso.user.name``,  ``mso.password.x``
+  Credentials for accessing SO
+
+``scheduler.server.url``
+  Base URL for 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
+
+``asdc.client.rest.host``
+  States the hostname of SDC instance
+
+``asdc.client.rest.port``
+  States the port of SDC instance
+
+``asdc.client.rest.auth``
+  Basic authorization string to access SDC
\ No newline at end of file
index b65f2ae..3748376 100644 (file)
@@ -4,16 +4,6 @@
 Logging
 =======
 
-.. note::
-   * This section is used to describe the informational or diagnostic messages emitted from 
-     a software component and the methods or collecting them.
-   
-   * This section is typically: provided for a platform-component and sdk; and
-     referenced in developer and user guides
-   
-   * This note must be removed after content has been added.
-
-
 Where to Access Information
 ---------------------------
 
index b971270..4f5b8db 100644 (file)
@@ -6,13 +6,14 @@ VID Documentation
 .. toctree::
    :maxdepth: 2
    
-   administration.rst
-   architecture.rst
-   configuration.rst
-   consumedapis.rst
-   offeredapis.rst
-   delivery.rst
-   humaninterfaces.rst
-   installation.rst
-   logging.rst
-   release-notes.rst
+   
+   docs-architecture.rst
+   docs-offeredapis.rst
+   docs-consumedapis.rst
+   docs-delivery.rst
+   docs-logging.rst
+   docs-installation.rst
+   docs-configuration.rst
+   docs-administration.rst
+   docs-humaninterfaces.rst
+   docs-release-notes.rst