Docs update
[vid.git] / docs / configuration.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Configuration
5 =============
6
7 Configurations .properties files are located under ``WEB-INF/conf/``, while .js files are under ``scripts/constants/``
8
9 system.properties file
10 ----------------------
11
12 ``db.connectionURL``
13   The connection URL for the VID database
14
15 ``db.userName``
16   The username for the VID database
17
18 ``db.password``
19   The password for the VID database
20
21 ``aai.server.url.base``
22   Base URL for the A&AI server
23
24 ``aai.server.url``
25   URL for the A&AI server including its version (default: v11)
26
27 ``aai.vid.username``, ``aai.vid.pass``
28   Credentials for accessing A&AI server offered APIs
29
30 ``mso.server.url``
31   Base URL for the SO server
32
33 ``mso.polling.interval.msecs``
34   Interval in milliseconds for polling the SO for the instantiation status
35
36 ``mso.max.polls``
37   Max attempts for polling the SO instantiation status
38   
39 ``mso.user.name``,  ``mso.password.x``
40   Credentials for accessing the SO server
41
42 ``scheduler.server.url``
43   Base URL for the Scheduler
44
45 ``scheduler.create.new.vnf.change.instance``, ``scheduler.get.time.slots``, ``scheduler.submit.new.vnf.change``, ``scheduler.get.schedules``
46   Scheduler endpoints
47
48 asdc.properties file
49 ----------------------
50 ``asdc.client.rest.protocol``
51   States the protocol used for accessing SDC: http or https
52
53 ``asdc.client.rest.host``
54   States the hostname of the SDC instance
55
56 ``asdc.client.rest.port``
57   States the port of the SDC instance
58
59 ``asdc.client.rest.auth``
60   Basic authorization string for accessing SDC
61   
62 vidConfiguration.js file
63 ------------------------
64 ``MSO_MAX_POLLS``
65   Max attempts for polling the SO instantiation status
66   
67 ``MSO_POLLING_INTERVAL_MSECS``
68   Interval in milliseconds for polling the SO for the instantiation status
69   
70 ``SCHEDULER_POLLING_INTERVAL_MSECS``
71   Interval in milliseconds for polling the Scheduler
72
73 ``SCHEDULER_MAX_POLLS``
74   Max attempts for polling the Scheduler
75   
76 ``MACRO_SERVICES``
77   |  List of all service model invariant UUIDs that need macro instantiation.
78   |  Example: ["3cf30cbb-5fe7-4fb3-b049-559a4997b221", "b135a703-bab5-4295-a37f-580a4f2d0961"]
79