summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorromaingimbert <romain.gimbert@orange.com>2019-03-21 10:04:30 +0100
committerromaingimbert <romain.gimbert@orange.com>2019-03-22 14:23:25 +0100
commit5973e241424950c8f6fcf1b9d5a107b19b5a9816 (patch)
tree4d7036853565712d2474555a8a735a23ec82da28 /docs
parent726031bf80339a3c23cc52f89a403e86afa301f4 (diff)
Documentation improvement
-add documentation from dublin -change pdf Change-Id: I18c1356a862eac851f46ff12348ec268fd615127 Issue-ID: EXTAPI-169 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/architecture/architecture.rst4
-rwxr-xr-xdocs/architecture/images/ONAP_External_ID_Beijing.jpgbin103409 -> 0 bytes
-rwxr-xr-xdocs/architecture/images/ONAP_External_ID_Casablanca.jpgbin127034 -> 0 bytes
-rw-r--r--docs/configuration/configuration.rst100
-rwxr-xr-xdocs/consumedapis/consumedapis.rst40
-rw-r--r--docs/images/onap_nbi_dublin.jpgbin0 -> 59026 bytes
-rw-r--r--docs/offeredapis/images/ONAP_External_ID_Beijing.jpgbin103409 -> 0 bytes
-rw-r--r--docs/offeredapis/images/ONAP_External_ID_Casablanca.jpgbin126974 -> 0 bytes
-rw-r--r--docs/offeredapis/offeredapis.rst21
-rw-r--r--docs/offeredapis/pdf/nbicallflow.pdfbin142247 -> 963461 bytes
10 files changed, 119 insertions, 46 deletions
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst
index 1ded2f6..042ffe0 100755
--- a/docs/architecture/architecture.rst
+++ b/docs/architecture/architecture.rst
@@ -16,13 +16,13 @@ These API are based on **TMF API**.
**********************************************
-Global NBI architecture for Casablanca release
+Global NBI architecture for Dublin release
**********************************************
Following illustration provides a global view about NBI architecture,
integration with other ONAP components and API resource/operation provided.
-.. image:: images/ONAP_External_ID_Casablanca.jpg
+.. image:: ../images/onap_nbi_dublin.jpg
:width: 800px
diff --git a/docs/architecture/images/ONAP_External_ID_Beijing.jpg b/docs/architecture/images/ONAP_External_ID_Beijing.jpg
deleted file mode 100755
index 8fbd4ab..0000000
--- a/docs/architecture/images/ONAP_External_ID_Beijing.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/architecture/images/ONAP_External_ID_Casablanca.jpg b/docs/architecture/images/ONAP_External_ID_Casablanca.jpg
deleted file mode 100755
index a566e42..0000000
--- a/docs/architecture/images/ONAP_External_ID_Casablanca.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst
index d0c2bd4..6290691 100644
--- a/docs/configuration/configuration.rst
+++ b/docs/configuration/configuration.rst
@@ -23,51 +23,89 @@ Default values
::
# SERVER
- server.servlet.context-path=/nbi/api/v3
- server.port = 8080
+ server.servlet.context-path = /nbi/api/${nbi.version}
+ server.port = 8080
# LOGGING
- logging.level.=INFO
+ logging.level. = WARN
+ logging.level.org.springframework = OFF
+ logging.level.org.onap = INFO
+ logging.level.root = WARN
+ spring.main.banner-mode = off
# ONAP
- onap.lcpCloudRegionId=RegionOne
- onap.tenantId=6e97a2bd51d74f6db5671d8dc1517d82
- onap.cloudOwner=CloudOwner
+ onap.lcpCloudRegionId = RegionOne
+ onap.tenantId = 6e97a2bd51d74f6db5671d8dc1517d82
+ onap.cloudOwner = CloudOwner
# NBI
- nbi.url=http://localhost:8080/nbi/api/v3
- nbi.callForVNF=false
+ nbi.url = http://localhost:${server.port}${server.servlet.context-path}
+ nbi.callForVNF = false
+
+ # SCHEDULER
+ scheduler.pollingDurationInMins = 360
+ serviceOrder.schedule = 5000
+ serviceOrder.initial = 1
+ executionTask.schedule = 2000
+ executionTask.initial = 1
+ dmaapCheck.schedule = 10000
+ dmaapCheck.initial = 1
# SDC
- sdc.host=http://10.0.3.1:8080
- sdc.header.ecompInstanceId=demo
- sdc.header.authorization=Basic YWFpOktwOGJKNFNYc3pNMFdYbGhhazNlSGxjc2UyZ0F3ODR2YW9HR21KdlV5MlU=
-
+ sdc.host = http://10.0.3.1:8080
+ sdc.header.ecompInstanceId = demo
+ sdc.header.authorization = Basic YWFpOktwOGJKNFNYc3pNMFdYbGhhazNlSGxjc2UyZ0F3ODR2YW9HR21KdlV5MlU=
# AAI
- aai.host=https://10.0.1.1:8443
- aai.header.authorization=Basic QUFJOkFBSQ==
- aai.api.id=AAI
+
+ aai.host = https://10.0.1.1:8443
+ aai.header.authorization = Basic QUFJOkFBSQ==
+ aai.api.id = NBI
+ aai.header.transaction.id = 808b54e3-e563-4144-a1b9-e24e2ed93d4f
# SO
- so.host=http://10.0.5.1:8080
- so.header.authorization=Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==
- so.api.id=SO
+ so.host = http://10.0.5.1:8080
+ so.header.authorization = Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==
+ so.api.id = SO
+ so.owning.entity.id = 6b5b6b70-4e9a-4f6f-8b7b-cbd7cf990c6e
+ so.owning.entity.name = OE-generic
+ so.project.name = Project-generic
+
+ # DMAAP
+ dmaap.host = http://10.0.6.1:3904
+ dmaap.aai.topic = AAI-EVENT
+ dmaap.sdc.topic = SDC-DISTR-NOTIF-TOPIC-AUTO
+ dmaap.consumergroup = NBICG1
+ dmaap.consumerid = NBIC1
+ dmaap.timeout = 2000
+
+ # MSB
+ msb.enabled = true
+ msb.discovery.host = msb_discovery
+ msb.discovery.port = 10081
+ msb.discovery.retry = 1
+ msb.discovery.retry_interval = 5000
+ msb.service.host =
+ msb.service.name = nbi
+ msb.service.custom_path =
+ msb.service.protocol = REST
+ msb.service.visual_range = 1
+ msb.service.enable_ssl = false
# MONGO
- spring.data.mongodb.host=localhost
- spring.data.mongodb.port=27017
- spring.data.mongodb.database=ServiceOrderDB
+ spring.data.mongodb.host = localhost
+ spring.data.mongodb.port = 27017
+ spring.data.mongodb.database = ServiceOrderDB
# MYSQL
- spring.datasource.url=jdbc:mariadb://localhost:3306/nbi
- spring.datasource.username=root
- spring.datasource.password=secret
- spring.datasource.testWhileIdle=true
- spring.datasource.validationQuery=SELECT 1
- spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
- spring.jpa.show-sql=false
- spring.jpa.hibernate.ddl-auto=update
- spring.jpa.hibernate.naming-strategy=org.hibernate.cfg.ImprovedNamingStrategy
+ spring.datasource.url = jdbc:mariadb://localhost:3306/nbi
+ spring.datasource.username = root
+ spring.datasource.password = secret
+ spring.datasource.testWhileIdle = true
+ spring.datasource.validationQuery = SELECT 1
+ spring.datasource.driver-class-name = org.mariadb.jdbc.Driver
+ spring.jpa.show-sql = false
+ spring.jpa.hibernate.ddl-auto = update
+ spring.jpa.hibernate.naming-strategy = org.hibernate.cfg.ImprovedNamingStrategy
***************
Changing values
@@ -83,3 +121,5 @@ environment attributes. For example :
SDC_HOST: http://${SDC_IP}:8080
AAI_HOST: https://${AAI_IP}:8443
SO_HOST: http://${SO_IP}:8080
+ DMAAP_HOST: http://${DMAAP_IP}:3904
+
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst
index 02b5782..91f634f 100755
--- a/docs/consumedapis/consumedapis.rst
+++ b/docs/consumedapis/consumedapis.rst
@@ -6,7 +6,7 @@ Consumed APIs
=============
-NBI application is interacting with 3 ONAP APIs
+NBI application is interacting with 4 ONAP APIs
*******
SDC API
@@ -36,19 +36,25 @@ will be retrieve in service inventory: id, name and type
::
- AAI_GET_TENANTS_PATH = "/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"
+ AAI_GET_TENANTS_PATH = "/aai/v14/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"
- AAI_GET_CUSTOMER_PATH = "/aai/v11/business/customers/customer/"
+ AAI_GET_CUSTOMER_PATH = "/aai/v14/business/customers/customer/"
- AAI_GET_SERVICES_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions"
+ AAI_GET_SERVICES_FOR_CUSTOMER_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions"
- AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/
+ AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions/service-subscription/
- AAI_GET_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"
+ AAI_GET_SERVICE_FOR_CUSTOMER_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"
- AAI_GET_SERVICE_INSTANCES_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"
+ AAI_GET_SERVICE_INSTANCES_PATH = "/aai/v14/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"
+ AAI_HEALTH_CHECK = "aai/util/echo?action=long"
+ AAI_GET_SERVICE = "/aai/v14/nodes/service-instances/service-instance/$serviceId"
+
+ AAI_GET_SERVICE_CUSTOMER = "/aai/v14/nodes/service-instances/service-instance/$serviceId?format=resource_and_url"
+
+ SDC_HEALTH_CHECK = "/sdc2/rest/healthCheck"
******
SO API
@@ -64,9 +70,9 @@ In this case NBI uses
MSO_CREATE_E2ESERVICE_INSTANCE_PATH = "/ecomp/mso/infra/e2eServiceInstances/v3"
- MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v6/"
+ MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v7/"
- MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"
+ MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v7/"
else following API are used:
@@ -75,6 +81,18 @@ else following API are used:
MSO_CREATE_SERVICE_INSTANCE_PATH = "/ecomp/mso/infra/serviceInstance/v6"
- MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v6/"
+ MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v7/"
+
+ MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v7/"
+
+ MSO_HEALTH_CHECK = "/globalhealthcheck"
+
+*********
+DMAAP API
+*********
+
+This API is used to retrieve Dmaap notifications from SDC and AAI.
+
+::
- MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"
+ DMAAP_CONSUME_EVENTS = "/events/$topic/$consumergroup/$consumerid?timeout=$timeout" \ No newline at end of file
diff --git a/docs/images/onap_nbi_dublin.jpg b/docs/images/onap_nbi_dublin.jpg
new file mode 100644
index 0000000..8ef3267
--- /dev/null
+++ b/docs/images/onap_nbi_dublin.jpg
Binary files differ
diff --git a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg b/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg
deleted file mode 100644
index 8fbd4ab..0000000
--- a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg
deleted file mode 100644
index 721d9f2..0000000
--- a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index 9845165..f575b01 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -16,13 +16,13 @@ be used by external systems as BSS for example. These API are based on
**TMF API**.
**********************************************
-Global NBI architecture for Casablanca release
+Global NBI architecture for Dublin release
**********************************************
Following illustration provides a global view about **NBI** architecture,
integration with other ONAP components and API resource/operation provided.
-.. image:: images/ONAP_External_ID_Casablanca.jpg
+.. image:: ../images/onap_nbi_dublin.jpg
:width: 800px
***********
@@ -139,6 +139,13 @@ Example: ``GET /nbi/api/v3/serviceSpecification/{uuid}``
It is use to retrieve one ``serviceSpecification`` - all available information
are retieved (see Swagger for description)
+**GET service Specification Schema (id)**
+
+Example: ``GET /nbi/api/v3/serviceSpecification/{uuid}/specificationInputSchema``
+
+It is use to retrieve one input schema from the tosca file stored in **NBI** - all available
+information are retieved (see Swagger for description)
+
----------------
serviceInventory
----------------
@@ -270,7 +277,15 @@ notifications. 3 events are managed:
• A service order state changes
• A service order item state changes
-These 3 events have distinct notification allowing any system to subscribe to
+It is also possible to subscribe to **AAI** and **SDC** notifications via **NBI**.
+4 events are managed:
+
+• A new service is created in **AAI***
+• A service attribute value is changed in **AAI**
+• A service is removed in **AAI**
+• A service specification is distributed in **SDC**
+
+These 7 events have distinct notification allowing any system to subscribe to
one, two or all notification types.
The implementation will be split in 2 components:
diff --git a/docs/offeredapis/pdf/nbicallflow.pdf b/docs/offeredapis/pdf/nbicallflow.pdf
index 8fc564b..b1e1fea 100644
--- a/docs/offeredapis/pdf/nbicallflow.pdf
+++ b/docs/offeredapis/pdf/nbicallflow.pdf
Binary files differ