Update SO request to use GR_API instead of VNF_API
[externalapi/nbi.git] / docs / configuration / configuration.rst
1 .. This work is licensed under
2 .. a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright 2018 ORANGE
5
6
7 Configuration
8 =============
9
10 A configuration file, *src/main/resources/application-localhost.properties*
11 list all the component interface that can be configured depending on the
12 environment were the application is deployed.
13 By default, the application runs with an embedded both MongoDB and MariaDB
14 local instance.
15 This file also list configurations of all the REST interface maid from NBI
16 to other ONAP component such as SDC, AA&I and SO.
17
18
19 **************
20 Default values
21 **************
22
23 ::
24
25     # SERVER
26     server.servlet.context-path          = /nbi/api/${nbi.version}
27     server.port                          = 8080
28     server.public.ip                     = localhost
29
30     # LOGGING
31     logging.level.                       = WARN
32     logging.level.org.springframework    = OFF
33     logging.level.org.onap               = INFO
34     logging.level.root                   = WARN
35     spring.main.banner-mode              = off
36
37     # ONAP
38     onap.lcpCloudRegionId                = RegionOne
39     onap.tenantId                        = 6e97a2bd51d74f6db5671d8dc1517d82
40     onap.cloudOwner                      = CloudOwner
41
42     # NBI
43     nbi.url                              = http://localhost:${server.port}${server.servlet.context-path}
44     nbi.callForVNF                       = false
45     nbi.public.url                       = http://${server.public.ip}:${server.port}${server.servlet.context-path}
46
47     # SCHEDULER
48     scheduler.pollingDurationInMins      = 360
49     serviceOrder.schedule                = 5000
50     serviceOrder.initial                 = 1
51     executionTask.schedule               = 2000
52     executionTask.initial                = 1
53     dmaapCheck.schedule                  = 10000
54     dmaapCheck.initial                   = 1
55
56     # SDC
57     sdc.host                             = http://10.0.3.1:8080
58     sdc.header.ecompInstanceId           = demo
59     sdc.header.authorization             = Basic YWFpOktwOGJKNFNYc3pNMFdYbGhhazNlSGxjc2UyZ0F3ODR2YW9HR21KdlV5MlU=
60     # AAI
61
62     aai.host                             = https://10.0.1.1:8443
63     aai.header.authorization             = Basic QUFJOkFBSQ==
64     aai.api.id                           = NBI
65     aai.header.transaction.id            = 808b54e3-e563-4144-a1b9-e24e2ed93d4f
66
67     # SO
68     so.host                              = http://10.0.5.1:8080
69     so.header.authorization              = Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==
70     so.api.id                            = SO
71     so.owning.entity.id                  = OE-generic
72     so.owning.entity.name                = OE-generic
73     so.project.name                      = Project-generic
74
75     # DMAAP
76     dmaap.host                           = http://10.0.6.1:3904
77     dmaap.aai.topic                      = AAI-EVENT
78     dmaap.sdc.topic                      = SDC-DISTR-NOTIF-TOPIC-AUTO
79     dmaap.consumergroup                  = NBICG1
80     dmaap.consumerid                     = NBIC1
81     dmaap.timeout                        = 2000
82
83     # MSB
84     msb.enabled                          = true
85     msb.discovery.host                   = msb_discovery
86     msb.discovery.port                   = 10081
87     msb.discovery.retry                  = 1
88     msb.discovery.retry_interval         = 5000
89     msb.service.host                     =
90     msb.service.name                     = nbi
91     msb.service.custom_path              =
92     msb.service.protocol                 = REST
93     msb.service.visual_range             = 1
94     msb.service.enable_ssl               = false
95
96     # MONGO
97     spring.data.mongodb.host             = localhost
98     spring.data.mongodb.port             = 27017
99     spring.data.mongodb.database         = ServiceOrderDB
100
101     # MYSQL
102     spring.datasource.url                = jdbc:mariadb://localhost:3306/nbi
103     spring.datasource.username           = root
104     spring.datasource.password           = secret
105     spring.datasource.testWhileIdle      = true
106     spring.datasource.validationQuery    = SELECT 1
107     spring.datasource.driver-class-name  = org.mariadb.jdbc.Driver
108     spring.jpa.show-sql                  = false
109     spring.jpa.hibernate.ddl-auto        = update
110     spring.jpa.hibernate.naming-strategy = org.hibernate.cfg.ImprovedNamingStrategy
111
112 ***************
113 Changing values
114 ***************
115
116 To adapt application parameters to your context, you need to set up some
117 environment attributes. For example :
118
119 ::
120
121       SPRING_DATASOURCE_PASSWORD: your own value here
122       SPRING_DATASOURCE_USERNAME: your own value here
123       SDC_HOST: http://${SDC_IP}:8080
124       AAI_HOST: https://${AAI_IP}:8443
125       SO_HOST: http://${SO_IP}:8080
126       DMAAP_HOST: http://${DMAAP_IP}:3904
127