80aff0b2d753fc0b867a8953a1654d51abe11997
[vfc/nfvo/driver/vnfm/svnfm.git] / nokiav2 / docs / onboarding.rst
1 On-board NS
2 ===========
3
4 The following section describes how to create an E2E service.
5
6 Create licensing model
7 ----------------------
8
9 The following section will create a license model. The license model is required for onboarding a VNF.
10
11 - Log into ONAP portal with designer role (cs0008)
12
13 - Select SDC from the application
14
15 - Select ONBOARD
16
17 - Click on CREATE NEW VLM
18
19 - Specify the name of the license <licenseName>
20
21 - Specify the description of the license
22
23 - Select Entitlement pools from left
24
25 - Click on ADD ENTITLEMENT POOL on right
26
27   - Specify the name (can be anything)
28
29   - Click on SAVE
30
31 - Select License key groups from left
32
33 - Click on ADD LICENSE KEY GROUP
34
35   - Specify the name (can be anything)
36
37   - Select universal type
38
39   - Click on SAVE
40
41 - Select Feature groups from left
42
43 - Click on ADD FEATURE GROUP
44
45  - Specify the name (can be anything) <featureGroup>
46
47  - Set 123456 as part number
48
49  - Set 123456 as manufacturer reference number
50
51  - Click on entitlement pools in middle
52
53    - Add previously created entitlement pool with arrow button
54
55  - Click on license key groups in middle
56
57    - Add previously created license key group with arrow button
58
59  - Click on SAVE
60
61 - Select License agreements from left
62
63 - Click on ADD LICENSE AGREEMENT on right
64
65  - Specify the name (can be anything)
66
67  - Select unlimited license term
68
69  - Click on feature groups
70
71    - Add previously created feature group with arrow button
72
73 - Click on the submit button on top right
74
75 Prepare the ETSI configuration JSON
76 -----------------------------------
77
78 The ETSI configuration of VF is the information gap that is required to instantiate a VNF, but this information is not
79 provided by the VF-C component to the VNFM. The ETSI configuration is a JSON serialized into a string, which is specified
80 as a VF property during VF design time.
81
82 The JSON has the following root elements:
83
84 - vimType: The type of the VIM
85
86 - instantiationLevel: The initial instantiation level of the VNF.
87
88 - computeResourceFlavours: The collection of compute flavors.
89
90 - zones: The collection of availability zones.
91
92 - softwareImages: The collection of software images.
93
94 - extManagedVirtualLinks: The collection of externally managed virtual links.
95
96 - externalConnectionPointAddresses: Addresses of the external connection points.
97
98 - extVirtualLinks: The collection of external virtual links.
99
100 - extensions: The collection of VNF properties
101
102 - additionalParams: Additional parameters passed during instantiation to the VNFM.
103
104 - domain: The domain of the OpenStack cloud (only available in Amsterdam)
105
106
107 On-board VNF
108 ------------
109
110 The following section requires the CSAR and the ETSI configuration of the VNF to be available as a prerequisite.
111
112 - Log into ONAP portal with designer role (cs0008)
113
114 - Select SDC from the application
115
116 - Select ONBOARD
117
118 - Click on CREATE NEW VSP
119
120   - Specify a the name of the VNF <vnfPackageName> (ex. vnf_simple_20180526_1)
121
122   - Select the previously created license model as vendor
123
124   - Select Database (General) for the category. It is important to select a category that has been linked to the customer.
125
126   - Select network package for onboarding procedure
127
128   - Specify description
129
130   - Click on CREATE
131
132 - Click on SELECT FILE from SOFTWARE PRODUCT ATTACHMENTS and upload the CSAR file
133
134 - Click on General on the left
135
136   - Select 1.0 as for licensing version under LICENSES
137
138   - Select the previously created license agreement <licenseName>
139
140   - Select the previously created feature group <featureGroup>
141
142   - Click on save icon at top right
143
144   - Click on Submit icon at top right
145
146 - Select HOME using the small arrow left from ONBOARD at top
147
148 - Hoover over the import icon and select Import VSP
149
150 - Select the created VSP from the list by name <vnfPackageName>
151
152 - Click on import VSP icon
153
154   - Set the CBAM VNF package identifier as the Vendor model number on left bottom
155
156   - Click on create on top right
157
158 - Click on Properties assignment on left
159
160   - Click on Inputs
161
162     - Specify NokiaSVNFM for the nf_type property
163
164   - Click on Save on the middle
165
166   - Click on Inputs
167
168     - Specify the ETSI configuration JSON for the etsi_config property
169
170     - If the ETSI configuration is larger than the maximal allowed value for a field
171
172       - Instead of specifying it using a property click on Deployment Artifact at left
173
174       - Click on Add other artifact at bottom middle
175
176         - Specify etsiConfig as Artifact Label
177
178         - Choose OTHER for type
179
180         - Specify anything for Description
181
182         - Select the ETSI configuration file using Browse
183
184         - Click on Done
185
186 - Click on Check in
187
188 - Search for the created VNF using the search box at top right <vnfPackageName>
189
190 - Click on the VF
191
192 - Click on submit for testing at top right
193
194 - Log out using the small person icon at top right
195
196 - Log in with tester role (jm0007)
197
198 - Select SDC from the application
199
200 - Search for the created VNF using the search box at top right <vnfPackageName>
201
202 - Click on Start testing
203
204 - Click on Accept
205
206 - Log out using the small person icon at top right
207
208
209 Design a network service
210 ------------------------
211
212 The following section design a network service. The prerequisite is that the tested VF package is available.
213
214 - Log into ONAP portal with designer role (cs0008)
215
216 - Select SDC from the application
217
218 - Select HOME
219
220 - Hoover over the Add icon and select add service
221
222   - Specify the name of the network service <nsName> (ex. ns_simple_20180526_1)
223
224   - Specify 123456 ad project code
225
226   - Specify description
227
228   - Select Network Service for the category
229
230     - If the network service is missing from the list
231
232       - Log in as demo user and select SDC
233
234   - Click on Create
235
236   - Click on Composition at left
237
238     - Search for the created VF using the search box at top left <vnfPackageName>
239
240     - Drag the VF icon to middle
241
242     - Wait for the icon to appear at the middle (only drag once)
243
244     - Click on the icon on the middle
245
246       - Click on very small pencil icon at top right
247
248       - Specify the name of the VF
249
250   - Click on check in
251
252   - Search for the created NS using the search box at top right <nsName>
253
254   - Click on the NS icon
255
256   - Click on Submit for testing
257
258 - Log out using the small person icon at top right
259
260 - Log in with tester role (jm0007)
261
262   - Select SDC from the application
263
264   - Search for the created VNF using the search box at top right <vnfPackageName>
265
266   - Click on Start testing
267
268   - Click on Accept
269
270   - Log out using the small person icon at top right
271
272 - Log in with tester role (gv0001)
273
274   - Select SDC from the application
275
276   - Search for the created VNF using the search box at top right <vnfPackageName>
277
278   - Click on Approve on top right
279
280   - Log out using the small person icon at top right
281
282 - Log in with operation role (op0001)
283
284   - Select SDC from the application
285
286   - Search for the created VNF using the search box at top right <vnfPackageName>
287
288   - Click on Distribute on top right
289
290   - Click on monitor in an order to verify that the distribution was successful
291
292     - Click on the small arrow next to the Distribution ID
293
294     - The list should contain at least two lines staring with sdc and aai-ml
295
296     - If the list does not contain enough elements it can be refreshed with the small icon at middle right
297
298     - Each of the two lines should contain a green check sign next to Deployed
299
300   - Log out using the small person icon at top right
301
302
303
304 Design a VF for the E2E service
305 -------------------------------
306
307 This step is only required if the UUI is planed to be used to manage the E2E service. The VF of the E2E service is
308 a wrapper to be able to treat the created NS as a VF. The prerequisite of this step is that the network service was
309 successfully distributed.
310
311 - Determine the UUIDs of the created NS in previous step
312
313   - Using a REST client of your choice, send a request to the following URL: https://sdc.api.simpledemo.onap.org:8443/sdc/v1/catalog/services
314
315     - HTTP method: GET
316
317     - Set the following values in the Header of the request:
318
319       - basic auth SDC:SDC
320
321       - X-ECOMP-InstanceID: VFC
322
323       - Accept: application/json
324
325   - Search for the created service by name <nsName> and note the uuid and invariantUUID fields
326
327 - Log in with designer role (cs0008)
328
329   - Select SDC from the application
330
331   - Select HOME
332
333   - Hoover over the Add icon and select add VF
334
335     - Specify the name of the VF <vfForNsName> (ex. vf_for_ns_simple_20180526_1_vIMS)
336
337       - the name must contain the vIMS character sequence (even if this is not an IMS)
338
339     - Specify something for the Vendor
340
341     - Specify any numeric value for the Vendor Release
342
343     - Specify something for description
344
345     - Select Network Service for the category
346
347     - Click on Create on top right
348
349   - Click on Composition at left
350
351     - Search for the NSD using the search box at top left
352
353     - Drag the NSD icon to middle
354
355     - Wait for the icon to appear at the middle (only drag once)
356
357     - Click on the icon on the middle
358
359       - Click on very small pencil icon at top right
360
361       - Specify the name of the NSD (ex. firstNsd ) <nsdName>
362
363     - Click on the name of the VF next to HOME at top
364
365     - Select Properties Assignment
366
367       - Select the check box before providing_service_uuid and providing_service_invariant_uuid properties
368
369       - Click on Declare at right
370
371       - Click on Inputs at middle
372
373       - Specify the UUID of the service (that was determined in previous step) for the <nsdName>_providing_service_uuid property
374
375       - Specify the invariant UUID of the service (that was determined in previous step) for the <nsdName>_providing_service_invariant_uuid property
376
377       - Click on Save
378
379   - Click on Check in
380
381   - Search for the created VF using the search box at top right <vfForNsName>
382
383   - Click on the VF icon
384
385   - Click on Submit for testing
386
387 - Log out using the small person icon at top right
388
389 - Log in with tester role (jm0007)
390
391   - Select SDC from the application
392
393   - Search for the created VNF using the search box at top right <vfForNsName>
394
395   - Click on Start testing
396
397   - Click on Accept
398
399   - Log out using the small person icon at top right
400
401
402 Design a E2E service
403 --------------------
404
405 This step is only required if the UUI is planed to be used to manage the E2E service. The prerequisite of this step is that the VF
406 wrapping the network service is tested.
407
408 - Log in with designer role (cs0008)
409
410   - Select SDC from the application
411
412   - Select HOME
413
414   - Hoover over the Add icon and select add Service
415
416     - Specify the name of the NS <e2eNsName> (ex. e2e_simple_20180526_1)
417
418     - Specify any numeric value for the Project Code
419
420     - Specify something for description
421
422     - Select E2E Service for the category
423
424     - Click on Create on top right
425
426   - Click on Composition at left
427
428     - Search for the created VF using the search box at top left <vfForNsName>
429
430     - Drag the VF icon to middle
431
432     - Wait for the icon to appear at the middle (only drag once)
433
434     - Click on the name of the NS next to HOME at top
435
436   - Click on Check in
437
438   - Search for the created NS using the search box at top right <e2eNsName>
439
440   - Click on the NS icon
441
442   - Click on Submit for testing
443
444 - Log out using the small person icon at top right
445
446 - Log in with tester role (jm0007)
447
448   - Select SDC from the application
449
450   - Search for the created NS using the search box at top right <e2eNsName>
451
452   - Click on Start testing
453
454   - Click on Accept
455
456   - Log out using the small person icon at top right
457
458 - Log in with tester role (gv0001)
459
460   - Select SDC from the application
461
462   - Search for the created VNF using the search box at top right <e2eNsName>
463
464   - Click on Approve on top right
465
466   - Log out using the small person icon at top right
467
468 - Log in with operation role (op0001)
469
470   - Select SDC from the application
471
472   - Search for the created VNF using the search box at top right <e2eNsName>
473
474   - Click on Distribute on top right
475
476   - Click on monitor in an order to verify that the distribution was successful
477
478     - Click on the small arrow next to the Distribution ID
479
480     - The list should contain at least two lines staring with sdc and aai-ml
481
482     - If the list does not contain enough elements it can be refreshed with the small icon at middle right
483
484     - Each of the two lines should contain a green check sign next to Deployed
485
486   - Log out using the small person icon at top right