correct some rst files
[externalapi/nbi.git] / docs / configuration / 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 .. Copyright 2018 ORANGE
4
5
6 Configuration
7 =============
8
9 A configuration file, *src/main/resources/application-localhost.properties* list all the component interface that can be configured depending on the environment were the app is deployed.
10 By default, the application runs with an embedded both MongoDB and MariaDB local instance.
11 This file also list configurations of all the REST interface maid from NBI to other ONAP component such as SDC, AA&I and SO.
12
13
14 **************
15 Default values
16 **************
17
18 ::
19
20     # SERVER
21     server.contextPath=/nbi/api/v1
22     server.port = 8080
23
24     # LOGGING
25     logging.level.=INFO
26
27     # ONAP
28     onap.lcpCloudRegionId=RegionOne
29     onap.tenantId=6e97a2bd51d74f6db5671d8dc1517d82
30     onap.cloudOwner=CloudOwner
31
32     # NBI
33     nbi.url=http://localhost:8080/nbi/api/v1
34     nbi.callForVNF=false
35
36     # SDC
37     sdc.host=http://10.0.3.1:8080
38     sdc.header.ecompInstanceId=demo
39     sdc.header.authorization=Basic YWFpOktwOGJKNFNYc3pNMFdYbGhhazNlSGxjc2UyZ0F3ODR2YW9HR21KdlV5MlU=
40
41     # AAI
42     aai.host=https://10.0.1.1:8443
43     aai.header.authorization=Basic QUFJOkFBSQ==
44     aai.api.id=AAI
45
46     # SO
47     so.host=http://10.0.5.1:8080
48     so.header.authorization=Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==
49     so.api.id=SO
50
51     # MONGO
52     spring.data.mongodb.host=localhost
53     spring.data.mongodb.port=27017
54     spring.data.mongodb.database=ServiceOrderDB
55
56     # MYSQL
57     spring.datasource.url=jdbc:mariadb://localhost:3306/nbi
58     spring.datasource.username=root
59     spring.datasource.password=secret
60     spring.datasource.testWhileIdle=true
61     spring.datasource.validationQuery=SELECT 1
62     spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
63     spring.jpa.show-sql=false
64     spring.jpa.hibernate.ddl-auto=update
65     spring.jpa.hibernate.naming-strategy=org.hibernate.cfg.ImprovedNamingStrategy
66
67 ***************
68 Changing values
69 ***************
70
71 To adapt application parameters to your context, you need to set up some environment attributes. For example :
72
73 ::
74
75       SPRING_DATASOURCE_PASSWORD: your own value here
76       SPRING_DATASOURCE_USERNAME: your own value here
77       SDC_HOST: http://${SDC_IP}:8080
78       AAI_HOST: https://${AAI_IP}:8443
79       SO_HOST: http://${SO_IP}:8080