summaryrefslogtreecommitdiffstats
path: root/docs/architecture
diff options
context:
space:
mode:
authorRene Robert <rene.robert@orange.com>2018-04-20 13:12:45 +0000
committerRene Robert <rene.robert@orange.com>2018-04-20 13:16:23 +0000
commitc371fc9d8dd18b9cbdefeb4f2c48b67b99acde20 (patch)
tree53daa84cb5b3306dc06ad6189a02e835e40ee690 /docs/architecture
parent012cf24a769893f092f07d05737e9e9e9dda40f1 (diff)
nbi doc update
Issue-ID: EXTAPI-74 Change-Id: Iedf3bad3ac690a3e2e2ffbb77bff6bc5aee20323 Signed-off-by: Rene Robert <rene.robert@orange.com>
Diffstat (limited to 'docs/architecture')
-rw-r--r--docs/architecture/NBI_R1_Developer_Guide.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/architecture/NBI_R1_Developer_Guide.rst b/docs/architecture/NBI_R1_Developer_Guide.rst
index 1d17665..e855fea 100644
--- a/docs/architecture/NBI_R1_Developer_Guide.rst
+++ b/docs/architecture/NBI_R1_Developer_Guide.rst
@@ -53,12 +53,20 @@ Or through a terminal, ensure that your maven installation is works and run *mvn
**Docker**
-in progress ...
+Requirements: `Docker engine <https://docs.docker.com/engine/>`_ and `docker-compose <https://docs.docker.com/compose/>`_.
+To start the application:
+ 1. Generate the application .jar file: `$ mvn clean package`
+ 2. Configure the **.env** file
+ 3. Start the *MariaDB* and *MongoDB* services: `$ docker-compose up -d mongo mariadb`
+ 4. Build and start the *NBI* service: `$ docker-compose up --build -d nbi`
+
+You can view the log output of the application with the following command:
+
+`$ docker-compose logs -f nbi`
**Testing**
When the app is running, you can access the API at http://yourhostname:8080/nbi/api/v1/ and fill the url with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status)
You can run a test by using `VisualStudio RestClient plugin <https://github.com/Huachao/vscode-restclient>`_
See the *restclient* package at root level to find *.vscode/settings.json* configuration file and */json/* package with samples requests that can be run.
You can also trigger these endpoints with any RESTful client or automation framework.
-