1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 ORANGE
==================================================
nbi - northbound interface - External API for ONAP
==================================================
************
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**.
*******************************************
Global NBI architecture for Casablanca 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
:width: 800px
***********
API Version
***********
APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v3/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
The version number (without the revision number) is held in the URI.
The major version number is incremented for an incompatible change.
The minor version number is incremented for a compatible change.
For minor modifications of the API, version numbering must not be updated, provided the following backward compatibility rules are respected:
- New elements in a data type must be optional (minOccurs=0)
- Changes in the cardinality of an attribute in a data type must be from mandatory to optional or from lower to greater
- New attributes defined in an element must be optional (absence of use=”required”).
- If new enumerated values are included, the former ones and its meaning must be kept.
- If new operations are added, the existing operations must be kept
- New parameters added to existing operations must be optional and existing parameters
must be kept
For major modifications of the API, not backward compatible and forcing client implementations to be changed, the version number must be updated.
*********
API Table
*********
.. |pdf-icon| image:: images/pdf.png
:width: 40px
.. |swagger-icon| image:: images/swagger.png
:width: 40px
.. |swaggerUI-icon| image:: images/swaggerUI.png
:width: 40px
.. |html-icon| image:: images/html.png
:width: 40px
.. |plantuml-icon| image:: images/uml.jpg
:width: 40px
.. |postman-icon| image:: images/postman.png
:width: 40px
.. csv-table::
:header: "API", "|swagger-icon|", "|html-icon|", "|plantuml-icon|", "|swagger-icon|", "|postman-icon|", "|pdf-icon|"
:widths: 10,5,5,5,5,5,5
" ", "json file", "html doc", "plantUML doc", "Swagger Editor", "Postman Collection", "pdf doc"
"serviceCatalog", ":download:`link <swaggers/serviceCatalog_3_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming"
"serviceInventory", ":download:`link <swaggers/serviceInventory_3_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming"
"serviceOrder", ":download:`link <swaggers/serviceOrder_3_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming"
"listener", ":download:`link <swaggers/listener_1_0_0.json>`", ":download:`link <listener/documentation.html>`", ":download:`link <listener/apiListener.plantuml>`", "coming", "coming", "coming"
***************
API Description
***************
**serviceCatalog:**
From TMF633 serviceCatalog
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
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/v3/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED)
It is possible to retrieve a list of serviceSpecification (get by list).
Only attributes category and distributionStatus are available for serviceSpecification filtering. It is possible to select retrieved attributes using fields attribute.
if no serviceSpecification matches, an empty list is send back.
GET tservice Specification (id)
(example: GET /nbi/api/v3/serviceSpecification/{uuid})
It is use to retrieve one serviceSpecification - all available information are retieved (see swagger for description)
**serviceInventory:**
From TMF638 serviceInventory
API at a glance:
Only high level information are provided - swagger is documented.
This API retrieves service(s) in the AAI inventory. Only following attributes will be retrieve in service inventory: id, name, state and type.
GET Service Inventory (list):
(example: GET /nbi/api/v3/service/?relatedParty.id=Pontus
)
GET (by list) allows to request with following criteria (all optional) :
* id (id of the service instance) - id of the service instance (inventory)
* serviceSpecification.id - id of the service specification (catalog)
* serviceSpecification.name - name of the service specification (catalog)
* relatedParty.id - id of the (aai) customer - if not filled we use ‘generic’ customer
if no service matches, an empty list is send back.
1. If a request is send without any parameter, we’ll retrieve the list of service-instance for the ‘generic’ customer
2. If only customer parameter is filled (relatedParty.id + role= relatedParty’ONAPcustomer’) we’ll retrieve the list of service-instance for this customer
3. If serviceSpecification.id or name is filled we’ll retrieve the list of Service instance (from this service specification) – We’ll use the customer id if provided (with Role=’ONAPcustomer) or generic if no customer id provided
GET Service Inventory (id):
(example: GET /nbi/api/v3/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters)
Because of AAI capability, additionally to the service id, customer id and [serviceSpecification.id or serviceSpecification.name] must be supplied. If the customer id is not supplied, External API will use ‘generic’ customer
**serviceOrder:**
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:
• externalId
• state
• description
• orderDate.gt (orderDate must be greater – after -than)
• orderDate.lt (orderDate must be lower-before - than)
• fields – attribute used to filter retrieved attributes (if needed) and also for sorted SO
• offset and limit are used for pagination purpose
ServiceOrder will manage following actioItem action:
• add - a new service will be created
• delete - an existing service will be deleted
• change - an existing service will be deleted and then created with new attribute value
prerequisites & assumptions :
• Cloud & tenant information MUST BE defined in the external API property file
• Management of ONAP customer for add service action
With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:
• It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.
• If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.
• Additionally nbi will create in AAI the service-type if it did not exists for the customer
ServiceOrder management in NBI will support 2 modes:
• E2E integration - NBI call SO API to perform an End-To-end integration
• Service-level only integration - nbi will trigger only SO request at serviceInstance level --> ONAPSO prerequisite: SO must be able to find a BPMN to process service fulfillment (integrate vnf, vnf activation in SDNC, VF module
The choice of the mode is done in NBI depending on information retrieved in SDC. If the serviceSpecification is within a Category “E2E Service” , NBI will use E2E SO API, if not only API at service instance level will be used.
There is no difference or specific expectation in the service order API used by NBI user.
ServiceOrder tracking
State management: States are only managed by ServiceOrder component and could not be updated from north side via API.
Accordingly to service order item fulfillment progress, order item state are updated. Order state is automatically updated based on item state.
Additionnally to this state, NBI provided a completion percent progress to have detailled information about order progress.
Order Message are retrieved in the GET serviceOrder to provide NBI used addtionnal information about serviceOrder management.
**Notification:**
It is possible for an external system to subscribe to service order notifications. 3 events are managed:
• A new service order is created in NBI
• A service order state changes.
• A service order item state changes
These 3 events have distinct notification allowing any system to subscribe to one, two or all notification types.
The implementation will be split in 2 components:
• A HUB resource must be managed within the NBI/serviceOrder API. This HUB resource allows system to subscribe to NBI notification
• An Event API must be available at listener side in order to be able to receive Listener (when event occurs). NBI will be upgraded to use this API as client – NBI will shoot POST listener/
Following diagram illustrate an illustrative notification flow:
.. image:: images/notification.jpg
:width: 800px
***************
Developer Guide
***************
Technical information about NBI (dependancies, configuration, running & testing) could be found here: :doc:`NBI_Developer_Guide <../architecture/NBI_Developer_Guide>`
API Flow illustration (with example messages) is described in this document: :download:`nbicallflow.pdf <pdf/nbicallflow.pdf>`
|
