diff options
| -rw-r--r-- | docs/architecture/NBI_R1_Developer_Guide.rst | 51 | ||||
| -rw-r--r-- | docs/architecture/architecture.rst | 17 | ||||
| -rw-r--r-- | docs/configuration/configuration.rst | 16 | ||||
| -rw-r--r-- | docs/consumedapis/consumedapis.rst | 10 | ||||
| -rw-r--r-- | docs/installation/installation.rst | 29 | ||||
| -rw-r--r-- | docs/logging/logging.rst | 5 | ||||
| -rw-r--r-- | docs/offeredapis/index.rst | 10 | ||||
| -rw-r--r-- | docs/releasenotes/releasenotes.rst | 6 |
8 files changed, 97 insertions, 47 deletions
diff --git a/docs/architecture/NBI_R1_Developer_Guide.rst b/docs/architecture/NBI_R1_Developer_Guide.rst index 893bfc3..1a421f6 100644 --- a/docs/architecture/NBI_R1_Developer_Guide.rst +++ b/docs/architecture/NBI_R1_Developer_Guide.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ORANGE @@ -10,12 +11,15 @@ NBI - Developer Guide Introduction ************ -NBI is a Java 8 web application built over Spring Framework. Using Spring Boot 1.5.10 dependencies, it runs as a standalone application with an embedded Tomcat server. +NBI is a Java 8 web application built over Spring Framework. +Using Spring Boot 1.5.10 dependencies, it runs as a standalone +application with an embedded Tomcat server. ************ Dependencies ************ -This project use various framework which are managed with Maven dependency management tool (see *pom.xml* file at root level) : +This project use various framework which are managed with Maven +dependency management tool (see *pom.xml* file at root level) : - Swagger annotations - `Spring Framework <https://github.com/spring-projects/spring-boot>`_ @@ -27,16 +31,23 @@ This project use various framework which are managed with Maven dependency manag ************* Configuration ************* -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. -By default, the application runs with an embedded both MongoDB and MariaDB local instance. -This file also list configurations of all the REST interface maid from NBI to other ONAP component such as SDC, AA&I and SO. +A configuration file, *src/main/resources/application-localhost.properties* +list all the component interface that can be configured depending on +the environment were the application is deployed. +By default, the application runs with an embedded both MongoDB and MariaDB +local instance. +This file also list configurations of all the REST interface maid from NBI +to other ONAP component such as SDC, AA&I and SO. *********** Source tree *********** -This application provides ServiceOrder, ServiceCatalag and ServiceInventory as main functional resources and HealthCheck. Each resource is implemented independently in a package corresponding to its name. +This application provides ServiceOrder, ServiceCatalag and ServiceInventory +as main functional resources and HealthCheck. Each resource is implemented +independently in a package corresponding to its name. -*commons , configuration, and exceptions* are shared technical classes that provided for all the application. +*commons , configuration, and exceptions* are shared technical classes that +provided for all the application. *********************************** @@ -45,20 +56,25 @@ Running and testing the application **Locally** -Ensure that you have a MongoDB and MariaDB instance running and properly configured in *application.properties* file. +Ensure that you have a MongoDB and MariaDB instance running and properly +configured in *application.properties* file. Run *Application.java* class in your favorite IDE -Or through a terminal, ensure that your maven installation is works and run *mvn spring-boot:run* command to start the application. +Or through a terminal, ensure that your maven installation is works and +run *mvn spring-boot:run* command to start the application. **Docker** -Requirements: `Docker engine <https://docs.docker.com/engine/>`_ and `docker-compose <https://docs.docker.com/compose/>`_. +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` + 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: @@ -66,7 +82,12 @@ 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 :samp:`http://yourhostname:8080/nbi/api/v1` and fill the url with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status) +When the application is running, you can access the API at +:samp:`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. +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. diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index dc296ab..f5b03d8 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ORANGE @@ -11,14 +12,17 @@ Introduction ************ -NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be used by external systems as BSS for example. These API are based on **TMF API**. +NBI stands for NorthBound Interface. It brings to ONAP a set of API that can be +used by external systems as BSS for example. +These API are based on **TMF API**. ******************************************* Global NBI architecture for Beijing release ******************************************* -Following illustration provides a global view about nbi architecture,integration with other ONAP components and API resource/operation provided. +Following illustration provides a global view about NBI architecture, +integration with other ONAP components and API resource/operation provided. .. image:: images/ONAP_External_ID_Beijing.jpg :width: 800px @@ -28,7 +32,10 @@ Following illustration provides a global view about nbi architecture,integration Developer Guide *************** -Technical information about NBI (dependancies, configuration, running & testing) could be found here: :doc:`NBI_R1_Developer_Guide <NBI_R1_Developer_Guide>` +Technical information about NBI +(dependencies, configuration, running & testing) +could be found here: :doc:`NBI_R1_Developer_Guide <NBI_R1_Developer_Guide>` -API Flow illustration (with example messages) is described in this document: :download:`nbicallflow.pdf <../offeredapis/pdf/nbicallflow.pdf>` +API Flow illustration (with example messages) is described in this document: +:download:`nbicallflow.pdf <../offeredapis/pdf/nbicallflow.pdf>` diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst index b71d60f..1ec4054 100644 --- a/docs/configuration/configuration.rst +++ b/docs/configuration/configuration.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ORANGE @@ -6,9 +7,13 @@ Configuration ============= -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. -By default, the application runs with an embedded both MongoDB and MariaDB local instance. -This file also list configurations of all the REST interface maid from NBI to other ONAP component such as SDC, AA&I and SO. +A configuration file, *src/main/resources/application-localhost.properties* +list all the component interface that can be configured depending on the +environment were the application is deployed. +By default, the application runs with an embedded both MongoDB and MariaDB +local instance. +This file also list configurations of all the REST interface maid from NBI +to other ONAP component such as SDC, AA&I and SO. ************** @@ -68,7 +73,8 @@ Default values Changing values *************** -To adapt application parameters to your context, you need to set up some environment attributes. For example : +To adapt application parameters to your context, you need to set up some +environment attributes. For example : :: diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst index 581b571..4770f55 100644 --- a/docs/consumedapis/consumedapis.rst +++ b/docs/consumedapis/consumedapis.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ORANGE @@ -14,7 +15,8 @@ SDC API ******* This API is used to provide Service Catalog information -Information are retrieved in SDC (and in Tosca "service template" file) - Only GET operation is provided - this API DID NOT UPDATE SDC +Information are retrieved in SDC (and in TOSCA "service template" file) +- Only GET operation is provided - this API DID NOT UPDATE SDC :: @@ -30,7 +32,9 @@ AAI API ******* This API is used to provide Service Inventory information -This API retrieves service(s) in the AAI inventory. Only following attributes will be retrieve in service inventory: id, name and type (no state or startDate available ) +This API retrieves service(s) in the AAI inventory. Only following attributes +will be retrieve in service inventory: id, name and type +(no state or startDate available ) :: diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst index 43db47c..e5473e4 100644 --- a/docs/installation/installation.rst +++ b/docs/installation/installation.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ORANGE @@ -13,20 +14,24 @@ Environment **Locally** -Ensure that you have a MongoDB and MariaDB instance running and properly configured in *application.properties* file. +Ensure that you have a MongoDB and MariaDB instance running and properly +configured in *application.properties* file. Run *Application.java* class in your favorite IDE -Or through a terminal, ensure that your maven installation is works and run *mvn spring-boot:run* command to start the appication. +Or through a terminal, ensure that your maven installation is works and +run *mvn spring-boot:run* command to start the application. **Docker** -Requirements: `Docker engine <https://docs.docker.com/engine/>`_ and `docker-compose <https://docs.docker.com/compose/>`_. +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` + 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: @@ -38,8 +43,14 @@ Steps ----- **Testing** -When the app is running, you can access the API at :samp:`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. +When the application is running, you can access the API at +:samp:`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. diff --git a/docs/logging/logging.rst b/docs/logging/logging.rst index 724df74..0c366fc 100644 --- a/docs/logging/logging.rst +++ b/docs/logging/logging.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ORANGE @@ -12,7 +13,7 @@ NBI application is using MongoDB and MariaDB databases. Where to Access Information --------------------------- -mongodb and Mariadb are accessible inside there respective docker container +MongoDB and MariaDB are accessible inside there respective docker container Error / Warning Messages diff --git a/docs/offeredapis/index.rst b/docs/offeredapis/index.rst index de8e8a5..248029e 100644 --- a/docs/offeredapis/index.rst +++ b/docs/offeredapis/index.rst @@ -25,7 +25,7 @@ Following illustration provides a global view about nbi architecture,integration API Version *********** -APIs are described with a state version with “v” following the API Name, e.g.: nbi/api/v1/productOrder. +APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v1/productOrder'. The schema associated with a REST API must have its version number aligned with that of the REST API. The version number has major, minor and revision numbers. E.g. v1.0.0 @@ -91,16 +91,16 @@ API at a glance: Only high level information are provided - swagger is documented. Only serviceSpecification resource is provided. -Information are retrieved in SDC (and in Tosca file) - Only GET operation is provided - this API DID NOT UPDATE SDC +Information are retrieved in SDC (and in TOSCA file) - Only GET operation is provided - this API DID NOT UPDATE SDC -Only characteristics at service level will be retrieved in ONAP Tosca file. For example if an ONAP service is composed of VNF and the VF module, the serviceSpecification resource will only feature characteristic describe in the ONAP service tosca model and not attributes in the tosca files for VNF or VF module. +Only characteristics at service level will be retrieved in ONAP TOSCA file. For example if an ONAP service is composed of VNF and the VF module, the serviceSpecification resource will only feature characteristic describe in the ONAP service tosca model and not attributes in the tosca files for VNF or VF module. Only ‘basic’ service characteristics will be managed in this release. By ‘basic’ we mean string, boolean, integer parameter type and we do not manage ‘map’ or ‘list parameter type GET serviceSpecification(list) -(example: GET /nbi/api/v1/serviceSpecification/?category=NetworkService&distributionStatus =DISTRIBUTED) +(example: GET /nbi/api/v1/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) It is possible to retrieve a list of serviceSpecification (get by list). @@ -158,7 +158,7 @@ From TMF641 serviceOrder API at a glance: Only high level information are provided - swagger is documented. -It is possible to use POST operation to create new serviceOrder in nbi and triggers service provisioning. GET operation is also available to retrieve one service order by providing id or a list of service order. For this release, only a subset of criteria is available: +It is possible to use POST operation to create new serviceOrder in NBI and triggers service provisioning. GET operation is also available to retrieve one service order by providing id or a list of service order. For this release, only a subset of criteria is available: • externalId • state diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst index 283b321..b7962cb 100644 --- a/docs/releasenotes/releasenotes.rst +++ b/docs/releasenotes/releasenotes.rst @@ -29,12 +29,12 @@ Not applicable - This is an initial release For service catalog: -- Find criterias are limited +- Find criteria are limited For service inventory: - Customer information must be passed to get complete service representation. -- Find criterias are limited. +- Find criteria are limited. For service order: @@ -49,7 +49,7 @@ Detail of limitations described in the readTheDoc documentation. **Security Issues** Security has not be addressed in this release: -Authentification management and Data Access rights have not been implemented. +Authentication management and Data Access rights have not been implemented. **Upgrade Notes** |