diff options
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml')
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml | 191 |
1 files changed, 98 insertions, 93 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml index d0e25b5..255cfbe 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml | |||
@@ -311,13 +311,13 @@ | |||
311 | 311 | ||
312 | <listitem> | 312 | <listitem> |
313 | <para>When prompted by the following UI, make sure the | 313 | <para>When prompted by the following UI, make sure the |
314 | <literal>VNF Package</literal> radio button is selected. </para> | 314 | <literal>VNF Package</literal> radio button is selected.</para> |
315 | </listitem> | 315 | </listitem> |
316 | 316 | ||
317 | <listitem> | 317 | <listitem> |
318 | <para> Click <literal>Choose File</literal> and choose the VNF | 318 | <para>Click <literal>Choose File</literal> and choose the VNF |
319 | Package ZIP archive, e.g <literal>VProbe.zip</literal>, which | 319 | Package ZIP archive, e.g <literal>VProbe.zip</literal>, which |
320 | represents the VNF bundle. </para> | 320 | represents the VNF bundle.</para> |
321 | </listitem> | 321 | </listitem> |
322 | 322 | ||
323 | <listitem> | 323 | <listitem> |
@@ -402,7 +402,7 @@ | |||
402 | 402 | ||
403 | <listitem> | 403 | <listitem> |
404 | <para><emphasis role="bold">Memory in MB.</emphasis> This is the | 404 | <para><emphasis role="bold">Memory in MB.</emphasis> This is the |
405 | amount of memory (in Megabytes) that will be provided to this type | 405 | amount of memory (in megabytes) that will be provided to this type |
406 | of VNF when it is instantiated. To determine the value for this | 406 | of VNF when it is instantiated. To determine the value for this |
407 | field, consult the VNF vendor.</para> | 407 | field, consult the VNF vendor.</para> |
408 | </listitem> | 408 | </listitem> |
@@ -435,7 +435,7 @@ | |||
435 | </figure> | 435 | </figure> |
436 | 436 | ||
437 | <para>Click on the <literal>Interfaces</literal> tab to show the | 437 | <para>Click on the <literal>Interfaces</literal> tab to show the |
438 | Interfaces table. </para> | 438 | Interfaces table.</para> |
439 | 439 | ||
440 | <para>This table will contain the interfaces required by this VNF to | 440 | <para>This table will contain the interfaces required by this VNF to |
441 | be configured, when creating an instance. Consult the VNF vendor to | 441 | be configured, when creating an instance. Consult the VNF vendor to |
@@ -445,8 +445,8 @@ | |||
445 | 445 | ||
446 | <para><emphasis role="bold">Cloud-Init Tab</emphasis></para> | 446 | <para><emphasis role="bold">Cloud-Init Tab</emphasis></para> |
447 | 447 | ||
448 | <para>You must provide Clout-Init configuration for the VNF. Click the | 448 | <para>Click the <literal>Clout Init</literal> tab to provide the |
449 | <literal>Clout Init</literal> tab.</para> | 449 | Clout-Init configuration.</para> |
450 | 450 | ||
451 | <figure> | 451 | <figure> |
452 | <title>Cloud-Init Tab</title> | 452 | <title>Cloud-Init Tab</title> |
@@ -459,36 +459,42 @@ | |||
459 | </mediaobject> | 459 | </mediaobject> |
460 | </figure> | 460 | </figure> |
461 | 461 | ||
462 | <para>Shown in the picture above are three fields that need to be populated: | 462 | <para>As shown in the picture above, there are three fields that need |
463 | Cloud-Init Datasource, Cloud-Init Disk Type and the Content Files Table.</para> | 463 | to be populated: Cloud-Init Datasource, Cloud-Init Disk Type and the |
464 | 464 | Content Files Table.</para> | |
465 | <para>To onboard the VNF you must specify the Cloud-Init datasource that the VNF | 465 | |
466 | uses. You can get this information from the VNF Vendor. Choose one of the following | 466 | <para>To onboard the VNF you must specify the Cloud-Init datasource |
467 | methods to specify the datasource:</para> | 467 | that the VNF uses. You can get this information from the VNF Vendor. |
468 | 468 | Choose one of the following methods to specify the datasource:</para> | |
469 | <itemizedlist> | 469 | |
470 | <listitem> | 470 | <itemizedlist> |
471 | <para><emphasis role="bold">ConfigDrive</emphasis>. This method allows you to provide | 471 | <listitem> |
472 | any number of content-data files containing Cloud-Init data.</para></listitem> | 472 | <para><emphasis role="bold">ConfigDrive</emphasis>. This method |
473 | <listitem> | 473 | allows you to provide any number of content-data files containing |
474 | 474 | Cloud-Init data.</para> | |
475 | <para><emphasis role="bold">NoCloud</emphasis>. This is a simpler method that uses only | 475 | </listitem> |
476 | one cloud init file (User-Data).</para></listitem> | 476 | |
477 | </itemizedlist> | 477 | <listitem> |
478 | 478 | <para><emphasis role="bold">NoCloud</emphasis>. This is a simpler | |
479 | <para>The Cloud-Init Disk Type field must be set to either <literal>Disk</literal>, | 479 | method that uses only one cloud init file (User-Data).</para> |
480 | or <literal>CD ROM</literal>, depending on what the VNF requires. You can get this | 480 | </listitem> |
481 | information from the VNF Vendor.</para> | 481 | </itemizedlist> |
482 | 482 | ||
483 | <para>The Content Files Table is used ONLY if you chose <literal>ConfigDrive</literal> | 483 | <para>The Cloud-Init Disk Type field must be set to either |
484 | as the Cloud-Init Datasource. For each content file added, you must provide a | 484 | <literal>Disk</literal>, or <literal>CD-ROM</literal>, depending on |
485 | <literal>Path</literal>. When a user uses the uCPE Manager to create an instance | 485 | what the VNF requires. You can get this information from the VNF |
486 | of one of these VNFs, they will be prompted to provide a data file for each entry | 486 | Vendor.</para> |
487 | in this table. Each type of VNF will require different cloud-init files, e.g.: | 487 | |
488 | a license file.</para> | 488 | <para>The Content Files Table is used ONLY if you chose |
489 | 489 | <literal>ConfigDrive</literal> as the Cloud-Init Datasource. For each | |
490 | <para>Consult with the VNF vendor to determine what is required for the VNF you | 490 | content file added, you must provide a <literal>Path</literal>. When a |
491 | are onboarding.</para> | 491 | user uses the uCPE Manager to create an instance of one of these VNFs, |
492 | they will be prompted to provide a data file for each entry in this | ||
493 | table. Each type of VNF will require different cloud-init files, e.g.: | ||
494 | a license file.</para> | ||
495 | |||
496 | <para>Consult with the VNF vendor to determine what is required for | ||
497 | the VNF you are onboarding.</para> | ||
492 | 498 | ||
493 | <figure> | 499 | <figure> |
494 | <title>Content Files Table example</title> | 500 | <title>Content Files Table example</title> |
@@ -504,13 +510,12 @@ | |||
504 | <para><emphasis role="bold">Properties Tab</emphasis></para> | 510 | <para><emphasis role="bold">Properties Tab</emphasis></para> |
505 | 511 | ||
506 | <para>In this table, you can enter values for properties that will be | 512 | <para>In this table, you can enter values for properties that will be |
507 | used during instantiation of the VNF. The values will augment the default | 513 | used during instantiation of the VNF. The values will augment the |
508 | values in the Domain.XML file used by libvert/virsh (running in NFV Access) | 514 | default values in the Domain.XML file used by libvirt/virsh (running |
509 | when creating an instance of the VNF. | 515 | in NFV Access) when creating an instance of the VNF. These property |
510 | These property names are well known to the uCPE NFV Access | 516 | names are well known to the uCPE NFV Access software, and more will be |
511 | software, and more will be added in future versions. You will need to | 517 | added in future versions. You will need to consult with the VNF Vendor |
512 | consult with the VNF Vendor or ENEA support for values needed by | 518 | or ENEA support for values needed by specific VNFs.</para> |
513 | specific VNFs.</para> | ||
514 | 519 | ||
515 | <figure> | 520 | <figure> |
516 | <title>Properties Tab</title> | 521 | <title>Properties Tab</title> |
@@ -526,21 +531,21 @@ | |||
526 | <para><emphasis role="bold">Property Values</emphasis></para> | 531 | <para><emphasis role="bold">Property Values</emphasis></para> |
527 | 532 | ||
528 | <para><literal>numHugePages</literal> defines the number of huge | 533 | <para><literal>numHugePages</literal> defines the number of huge |
529 | memory pages the VNF uses (for DPDK). Needed for Clavister COS | 534 | memory pages the VNF uses (for DPDK).</para> |
530 | Stream.</para> | ||
531 | </section> | 535 | </section> |
532 | </section> | 536 | </section> |
533 | 537 | ||
534 | <section id="instantiating_a_vnf"> | 538 | <section id="instantiating_a_vnf"> |
535 | <title>Instantiating a VNF</title> | 539 | <title>Instantiating a VNF</title> |
536 | 540 | ||
537 | <para>Once the VNF bundle has been onboarded, you can instantiate a | 541 | <para>Once the VNF bundle has been onboarded, you can instantiate a VNF |
538 | VNF on a specific uCPE host:</para> | 542 | on a specific uCPE host:</para> |
539 | 543 | ||
540 | <para>Launch the <literal>VNF instance</literal> table by choosing the | 544 | <para>Launch the <literal>VNF instance</literal> table by choosing the |
541 | <literal>Instances</literal> option from the <literal>VNF</literal> menu. | 545 | <literal>Instances</literal> option from the <literal>VNF</literal> |
542 | This will display the table of VNF instances controlled by the VNF Manager. | 546 | menu. This will display the table of VNF instances controlled by the VNF |
543 | Hit the <literal>Add</literal> button to create a new instance, as shown below:</para> | 547 | Manager. Hit the <literal>Add</literal> button to create a new |
548 | instance:</para> | ||
544 | 549 | ||
545 | <figure> | 550 | <figure> |
546 | <title>Instantiating a VNF</title> | 551 | <title>Instantiating a VNF</title> |
@@ -558,33 +563,34 @@ | |||
558 | 563 | ||
559 | <itemizedlist> | 564 | <itemizedlist> |
560 | <listitem> | 565 | <listitem> |
561 | <para><emphasis role="bold">VNF Type</emphasis>. The | 566 | <para><emphasis role="bold">Name</emphasis>. The name of the |
562 | <literal>VProbe</literal> VNF, in this case.</para> | 567 | VNF.</para> |
563 | </listitem> | 568 | </listitem> |
564 | 569 | ||
565 | <listitem> | 570 | <listitem> |
566 | <para><emphasis role="bold">VIM</emphasis>. This stands for <literal> | 571 | <para><emphasis role="bold">VNF Type</emphasis>. The name of the |
567 | Virtual Infrastructure Manager</literal>, the target host on which to | 572 | on-boarded VNF bundle. In this case <literal>VProbe</literal> |
568 | instantiate a VNF, i.e. the target uCPE host that will run this VNF.</para> | 573 | VNF.</para> |
569 | |||
570 | </listitem> | 574 | </listitem> |
571 | 575 | ||
572 | <listitem> | 576 | <listitem> |
573 | <para><emphasis role="bold">Name</emphasis>. The name of the | 577 | <para><emphasis role="bold">Flavor</emphasis>. The flavor of VNF (as |
574 | VNF.</para> | 578 | specified in the descriptor) you would like to instantiate.</para> |
575 | </listitem> | 579 | </listitem> |
576 | 580 | ||
577 | <listitem> | 581 | <listitem> |
578 | <para><emphasis role="bold">VNF Flavor</emphasis>. The flavor of VNF | 582 | <para><emphasis role="bold">VIM</emphasis>. This stands for |
579 | (as specified in the descriptor) you would like to | 583 | <literal> Virtual Infrastructure Manager</literal>, the target host |
580 | instantiate.</para> | 584 | on which to instantiate a VNF, i.e. the target uCPE host that will |
585 | run this VNF.</para> | ||
581 | </listitem> | 586 | </listitem> |
582 | 587 | ||
583 | <listitem> | 588 | <listitem> |
584 | <para><emphasis role="bold">Device Name</emphasis>. The name by | 589 | <para><emphasis role="bold">Device Name</emphasis>. The name by |
585 | which the VNF will be known in the uCPE Manager, if the <literal>Manage | 590 | which the VNF will be known in the uCPE Manager, if the |
586 | Device</literal> checkbox is checked. If unchecked, the VNF will not | 591 | <literal>Manage Device</literal> checkbox is checked. If unchecked, |
587 | be shown as a managed device in the uCPE Manager.</para> | 592 | the VNF will not be shown as a managed device in the uCPE |
593 | Manager.</para> | ||
588 | </listitem> | 594 | </listitem> |
589 | 595 | ||
590 | <listitem> | 596 | <listitem> |
@@ -595,17 +601,17 @@ | |||
595 | for two separate interfaces (enp0s9 and enp0s10 respectively). Every | 601 | for two separate interfaces (enp0s9 and enp0s10 respectively). Every |
596 | VNF type will have a different UI section here. This section is | 602 | VNF type will have a different UI section here. This section is |
597 | populated by the <literal>getInstanceGui()</literal> method in the | 603 | populated by the <literal>getInstanceGui()</literal> method in the |
598 | <literal>VnfGuiProcessorIf</literal> | 604 | <literal>VnfGuiProcessorIf</literal> interface, see Section 6.1 to |
599 | interface, see Section 6.1 to understand exactly how the VProbe | 605 | understand exactly how the VProbe method causes the above GUI |
600 | method causes the above GUI section to be displayed.</para> | 606 | section to be displayed.</para> |
601 | </listitem> | 607 | </listitem> |
602 | 608 | ||
603 | <listitem> | 609 | <listitem> |
604 | <para><emphasis role="bold">Auto-start</emphasis>. If checked, the | 610 | <para><emphasis role="bold">Auto-start</emphasis>. If checked, the |
605 | VNF will be stopped and started when unreachable. When the VIM | 611 | VNF will be stopped and started when unreachable. When the VIM |
606 | reports that it has lost connection to the VNF, the uCPE Manager will | 612 | reports that it has lost connection to the VNF, the uCPE Manager |
607 | ask the VIM to terminate the VM and then start it up again. | 613 | will ask the VIM to terminate the VM and then start it up again. If |
608 | If unchecked, only a <literal>Disconnected</literal> notification will | 614 | unchecked, only a <literal>Disconnected</literal> notification will |
609 | appear in the uCPE Manager.</para> | 615 | appear in the uCPE Manager.</para> |
610 | </listitem> | 616 | </listitem> |
611 | </itemizedlist> | 617 | </itemizedlist> |
@@ -632,36 +638,35 @@ | |||
632 | 638 | ||
633 | <itemizedlist> | 639 | <itemizedlist> |
634 | <listitem> | 640 | <listitem> |
635 | <para><emphasis role="bold">Networking information.</emphasis> | 641 | <para><emphasis role="bold">Networking information.</emphasis> |
636 | Use the <literal>VnfGuiProcessorIf | 642 | Use the <literal>VnfGuiProcessorIf</literal> class<literal> |
637 | </literal>class<literal> getConnectionInfo()</literal> method to | 643 | getConnectionInfo()</literal> method to convert user parameters |
638 | convert user parameters into networking information objects | 644 | into networking information objects (refer to Section 6.1 for |
639 | (refer to Section 6.1 for the <literal>VProbe</literal> | 645 | the <literal>VProbe</literal> VNF).</para> |
640 | VNF).</para> | ||
641 | </listitem> | 646 | </listitem> |
642 | </itemizedlist> | 647 | </itemizedlist> |
643 | 648 | ||
644 | <itemizedlist> | 649 | <itemizedlist> |
645 | <listitem> | 650 | <listitem> |
646 | <para><emphasis role="bold">Cloud-init.</emphasis> | 651 | <para><emphasis role="bold">Cloud-init.</emphasis> Use generic |
647 | Use generic VNF instance information in | 652 | VNF instance information in conjunction with the networking |
648 | conjunction with the networking information objects from | 653 | information objects from above and invoke the |
649 | above and invoke the <literal>getCloudInitData()</literal> method on the | 654 | <literal>getCloudInitData()</literal> method on the |
650 | <literal>VnfProcessorIf</literal> class (refer to Section 6.2 for how this is done | 655 | <literal>VnfProcessorIf</literal> class (refer to Section 6.2 |
651 | for the <literal>VProbe</literal> VNF). The cloud-init data is | 656 | for how this is done for the <literal>VProbe</literal> VNF). The |
652 | the script that will be executed by the VNF when it starts up | 657 | cloud-init data is the script that will be executed by the VNF |
653 | for the first time only. It is responsible for setting up the | 658 | when it starts up for the first time only. It is responsible for |
654 | initial system configuration to what is required by the VNF to | 659 | setting up the initial system configuration to what is required |
655 | run correctly, setting up the network interfaces, static IP | 660 | by the VNF to run correctly, setting up the network interfaces, |
656 | addresses, etc.</para> | 661 | static IP addresses, etc.</para> |
657 | </listitem> | 662 | </listitem> |
658 | </itemizedlist> | 663 | </itemizedlist> |
659 | </listitem> | 664 | </listitem> |
660 | 665 | ||
661 | <listitem> | 666 | <listitem> |
662 | <para>Make the uCPE create the VNF with the specified image, | 667 | <para>Make the uCPE create the VNF with the specified image, flavor |
663 | flavor and cloud-init data via a NETCONF request and waits for it to | 668 | and cloud-init data via a NETCONF request and wait for the VNF to be |
664 | be created and started up.</para> | 669 | created and booted up.</para> |
665 | </listitem> | 670 | </listitem> |
666 | 671 | ||
667 | <listitem> | 672 | <listitem> |
@@ -723,7 +728,7 @@ | |||
723 | this update.</para> | 728 | this update.</para> |
724 | 729 | ||
725 | <para>This step needs to be done each time the uCPE Manager host changes | 730 | <para>This step needs to be done each time the uCPE Manager host changes |
726 | the IP address.</para> | 731 | its IP address.</para> |
727 | </note> | 732 | </note> |
728 | 733 | ||
729 | <para>An offline configuration can be prepared in advance for the uCPE | 734 | <para>An offline configuration can be prepared in advance for the uCPE |