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           - the name of the file on the local file system must be etsi_config.json
 185
 186         - Click on Done
 187
 188 - Click on Check in
 189
 190 - Search for the created VNF using the search box at top right <vnfPackageName>
 191
 192 - Click on the VF
 193
 194 - Click on submit for testing at top right
 195
 196 - Log out using the small person icon at top right
 197
 198 - Log in with tester role (jm0007)
 199
 200 - Select SDC from the application
 201
 202 - Search for the created VNF using the search box at top right <vnfPackageName>
 203
 204 - Click on Start testing
 205
 206 - Click on Accept
 207
 208 - Log out using the small person icon at top right
 209
 210
 211 Design a network service
 212 ------------------------
 213
 214 The following section design a network service. The prerequisite is that the tested VF package is available.
 215
 216 - Log into ONAP portal with designer role (cs0008)
 217
 218 - Select SDC from the application
 219
 220 - Select HOME
 221
 222 - Hoover over the Add icon and select add service
 223
 224   - Specify the name of the network service <nsName> (ex. ns_simple_20180526_1)
 225
 226   - Specify 123456 ad project code
 227
 228   - Specify description
 229
 230   - Select Network Service for the category
 231
 232     - If the network service is missing from the list
 233
 234       - Log in as demo user and select SDC
 235
 236   - Click on Create
 237
 238   - Click on Composition at left
 239
 240     - Search for the created VF using the search box at top left <vnfPackageName>
 241
 242     - Drag the VF icon to middle
 243
 244     - Wait for the icon to appear at the middle (only drag once)
 245
 246     - Click on the icon on the middle
 247
 248       - Click on very small pencil icon at top right
 249
 250       - Specify the name of the VF
 251
 252   - Click on check in
 253
 254   - Search for the created NS using the search box at top right <nsName>
 255
 256   - Click on the NS icon
 257
 258   - Click on Submit for testing
 259
 260 - Log out using the small person icon at top right
 261
 262 - Log in with tester role (jm0007)
 263
 264   - Select SDC from the application
 265
 266   - Search for the created VNF using the search box at top right <vnfPackageName>
 267
 268   - Click on Start testing
 269
 270   - Click on Accept
 271
 272   - Log out using the small person icon at top right
 273
 274 - Log in with tester role (gv0001)
 275
 276   - Select SDC from the application
 277
 278   - Search for the created VNF using the search box at top right <vnfPackageName>
 279
 280   - Click on Approve on top right
 281
 282   - Log out using the small person icon at top right
 283
 284 - Log in with operation role (op0001)
 285
 286   - Select SDC from the application
 287
 288   - Search for the created VNF using the search box at top right <vnfPackageName>
 289
 290   - Click on Distribute on top right
 291
 292   - Click on monitor in an order to verify that the distribution was successful
 293
 294     - Click on the small arrow next to the Distribution ID
 295
 296     - The list should contain at least two lines staring with sdc and aai-ml
 297
 298     - If the list does not contain enough elements it can be refreshed with the small icon at middle right
 299
 300     - Each of the two lines should contain a green check sign next to Deployed
 301
 302   - Log out using the small person icon at top right
 303
 304
 305
 306 Design a VF for the E2E service
 307 -------------------------------
 308
 309 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
 310 a wrapper to be able to treat the created NS as a VF. The prerequisite of this step is that the network service was
 311 successfully distributed.
 312
 313 - Determine the UUIDs of the created NS in previous step
 314
 315   - 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
 316
 317     - HTTP method: GET
 318
 319     - Set the following values in the Header of the request:
 320
 321       - basic auth SDC:SDC
 322
 323       - X-ECOMP-InstanceID: VFC
 324
 325       - Accept: application/json
 326
 327   - Search for the created service by name <nsName> and note the uuid and invariantUUID fields
 328
 329 - Log in with designer role (cs0008)
 330
 331   - Select SDC from the application
 332
 333   - Select HOME
 334
 335   - Hoover over the Add icon and select add VF
 336
 337     - Specify the name of the VF <vfForNsName> (ex. vf_for_ns_simple_20180526_1_vIMS)
 338
 339       - the name must contain the vIMS character sequence (even if this is not an IMS)
 340
 341     - Specify something for the Vendor
 342
 343     - Specify any numeric value for the Vendor Release
 344
 345     - Specify something for description
 346
 347     - Select Network Service for the category
 348
 349     - Click on Create on top right
 350
 351   - Click on Composition at left
 352
 353     - Search for the NSD using the search box at top left
 354
 355     - Drag the NSD icon to middle
 356
 357     - Wait for the icon to appear at the middle (only drag once)
 358
 359     - Click on the icon on the middle
 360
 361       - Click on very small pencil icon at top right
 362
 363       - Specify the name of the NSD (ex. firstNsd ) <nsdName>
 364
 365     - Click on the name of the VF next to HOME at top
 366
 367     - Select Properties Assignment
 368
 369       - Select the check box before providing_service_uuid and providing_service_invariant_uuid properties
 370
 371       - Click on Declare at right
 372
 373       - Click on Inputs at middle
 374
 375       - Specify the UUID of the service (that was determined in previous step) for the <nsdName>_providing_service_uuid property
 376
 377       - Specify the invariant UUID of the service (that was determined in previous step) for the <nsdName>_providing_service_invariant_uuid property
 378
 379       - Click on Save
 380
 381   - Click on Check in
 382
 383   - Search for the created VF using the search box at top right <vfForNsName>
 384
 385   - Click on the VF icon
 386
 387   - Click on Submit for testing
 388
 389 - Log out using the small person icon at top right
 390
 391 - Log in with tester role (jm0007)
 392
 393   - Select SDC from the application
 394
 395   - Search for the created VNF using the search box at top right <vfForNsName>
 396
 397   - Click on Start testing
 398
 399   - Click on Accept
 400
 401   - Log out using the small person icon at top right
 402
 403
 404 Design a E2E service
 405 --------------------
 406
 407 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
 408 wrapping the network service is tested.
 409
 410 - Log in with designer role (cs0008)
 411
 412   - Select SDC from the application
 413
 414   - Select HOME
 415
 416   - Hoover over the Add icon and select add Service
 417
 418     - Specify the name of the NS <e2eNsName> (ex. e2e_simple_20180526_1)
 419
 420     - Specify any numeric value for the Project Code
 421
 422     - Specify something for description
 423
 424     - Select E2E Service for the category
 425
 426     - Click on Create on top right
 427
 428   - Click on Composition at left
 429
 430     - Search for the created VF using the search box at top left <vfForNsName>
 431
 432     - Drag the VF icon to middle
 433
 434     - Wait for the icon to appear at the middle (only drag once)
 435
 436     - Click on the name of the NS next to HOME at top
 437
 438   - Click on Check in
 439
 440   - Search for the created NS using the search box at top right <e2eNsName>
 441
 442   - Click on the NS icon
 443
 444   - Click on Submit for testing
 445
 446 - Log out using the small person icon at top right
 447
 448 - Log in with tester role (jm0007)
 449
 450   - Select SDC from the application
 451
 452   - Search for the created NS using the search box at top right <e2eNsName>
 453
 454   - Click on Start testing
 455
 456   - Click on Accept
 457
 458   - Log out using the small person icon at top right
 459
 460 - Log in with tester role (gv0001)
 461
 462   - Select SDC from the application
 463
 464   - Search for the created VNF using the search box at top right <e2eNsName>
 465
 466   - Click on Approve on top right
 467
 468   - Log out using the small person icon at top right
 469
 470 - Log in with operation role (op0001)
 471
 472   - Select SDC from the application
 473
 474   - Search for the created VNF using the search box at top right <e2eNsName>
 475
 476   - Click on Distribute on top right
 477
 478   - Click on monitor in an order to verify that the distribution was successful
 479
 480     - Click on the small arrow next to the Distribution ID
 481
 482     - The list should contain at least two lines staring with sdc and aai-ml
 483
 484     - If the list does not contain enough elements it can be refreshed with the small icon at middle right
 485
 486     - Each of the two lines should contain a green check sign next to Deployed
 487
 488   - Log out using the small person icon at top right