1 .. SPDX-License-Identifier: CC-BY-4.0
2 .. Copyright 2018 ORANGE
8 This document describes local installation for development purpose
9 It also describes some keypoints for understanding NBI in OOM context
18 * free port 8080, used by tests
24 Alternative 1 run SpringBoot application
25 ----------------------------------------
34 Review and edit *src/main/resources/application.properties*
38 Mongo, host=localhost, port=27017, database=ServiceOrderDB
40 Mariadb, url=jdbc:mariadb://localhost:3306/nbi, username=root,
47 Alternative 2 run docker
48 ------------------------
56 Edit *docker-compose.yml* to select previous generated local build, replace::
58 image: ${NEXUS_DOCKER_REPO}/onap/externalapi/nbi:latest
66 docker-compose up -d mongo mariadb
68 docker-compose up --build -d nbi
72 docker-compose logs -f nbi
78 Status is available at http://localhost:8080/nbi/api/v4/status
80 Running a standalone test::
82 curl "http://localhost:8080/nbi/api/v4/status"
95 A full collection of requests is available in *docs/offeredapis/postman* for inspiration
102 Running a standalone test::
104 curl "https://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/status"
112 Running an integration test with SO, SDC, DMAAP, AAI::
114 curl "https://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/status?fullStatus=true"
122 "name": "so connectivity",
126 "name": "sdc connectivity",
130 "name": "dmaap connectivity",
134 "name": "aai connectivity",
140 **Understanding OOM deployment**
142 NBI uses AAF init container to generate valid server certificate, signed by ONAP Root CA.
143 This server certificate is used for TLS over HTTP.
145 Passing specific JAVA_OPTS to NBI SpringBoot java app will enable HTTPS.
147 Here are some OOM related files which could help to understand how HTTPS is set up.
149 Search for JAVA_OPTS in
150 https://github.com/onap/oom/blob/master/kubernetes/nbi/templates/deployment.yaml
153 https://github.com/onap/oom/blob/master/kubernetes/nbi/values.yaml
156 https://github.com/onap/oom/blob/master/kubernetes/nbi/templates/configmap-aaf-add-config.yaml