diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-10-01 08:27:04 +0200 |
---|---|---|
committer | Miruna Paun <Miruna.Paun@enea.com> | 2019-10-03 11:52:52 +0200 |
commit | cdcd83985ddbf546c06c33919abfd479bacfe404 (patch) | |
tree | 32269eb4db83ddfca095fa7b11e6edf2efe67271 | |
parent | 1a18b1d629bcc83dbd20be33d18435533362add7 (diff) | |
download | nfv-access-documentation-cdcd83985ddbf546c06c33919abfd479bacfe404.tar.gz |
GettingStarted: update VNF Management ch
- Merge "Onboarding and Instantiating a VNF" chapters from "VNF
Onboarding Guide" and "Getting Started Guide".
- Remove all references to "Wizard"
- Remove all screenshots except “Figure 4.8 Onboard a VNF using the Wizard”
Change-Id: I0391abfa8254df9bed0ea3d1d7121a2bb1627a18
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 717 |
1 files changed, 197 insertions, 520 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index afb6ee3..935c9df 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | |||
@@ -410,95 +410,121 @@ | |||
410 | <section id="vnf_management"> | 410 | <section id="vnf_management"> |
411 | <title>VNF Management</title> | 411 | <title>VNF Management</title> |
412 | 412 | ||
413 | <para>As the acting vnf manager, the uCPE Manager is responsible for | 413 | <para>The Enea uCPE Manager is responsible for |
414 | handling the life-cycles of VNFs that are instantiated and run on the | 414 | onboarding, configuring (e.g. CloudInit) and ensuring life cycle |
415 | various uCPE devices. The vnf manager module is written so as to be able | 415 | management of VNFs that are instantiated and run on the various uCPE |
416 | to manage multiple VNF types. Along with it is provided a generic | 416 | devices.</para> |
417 | infrastructure to allow the end-user to introduce new VNF types | ||
418 | dynamically into the system. This allows for third-party VNFs to be added | ||
419 | over time to an existing network infrastructure without having to perform | ||
420 | an expensive upgrade of the vnf manager itself.</para> | ||
421 | |||
422 | <para>The process of VNF Onboarding consists of providing the system with | ||
423 | sufficient information and resources related to the VNF such that it can | ||
424 | instantiate a flavour of the VNF on the uCPE device, configure and scale | ||
425 | it as appropriate, heal and upgrade it when necessary and tear it down at | ||
426 | the right moment.</para> | ||
427 | |||
428 | <para>The vnf manager subsystem in the uCPE Manager inserts a menu item in | ||
429 | the toolbar, called <literal>VNF</literal> as shown in the screen-shot | ||
430 | below.</para> | ||
431 | |||
432 | <figure> | ||
433 | <title>VNF Management</title> | ||
434 | |||
435 | <mediaobject> | ||
436 | <imageobject> | ||
437 | <imagedata align="center" fileref="images/vnf_management.png" | ||
438 | scale="80" /> | ||
439 | </imageobject> | ||
440 | </mediaobject> | ||
441 | </figure> | ||
442 | |||
443 | <para>Selecting this menu item gives you the following options:</para> | ||
444 | 417 | ||
445 | <itemizedlist> | 418 | <section id="onboarding_a_vnf"> |
446 | <listitem> | 419 | <title>Onboarding a VNF</title> |
447 | <para><literal>Descriptors</literal>: Choosing this option lets you | ||
448 | manage the VNF Descriptors catalog. The vnf manager maintains a | ||
449 | catalog of all VNFs that can be instantiated and managed by the | ||
450 | system. Before you can use a new VNF, you need to onboard it into the | ||
451 | catalog.</para> | ||
452 | </listitem> | ||
453 | 420 | ||
454 | <listitem> | 421 | <para>The onboarding of a VNF means adding it to the Enea uCPE Manager |
455 | <para><literal>Instances</literal>: Choosing this option lets you | 422 | VNF Catalog and preparing it for instantiation (deployment on connected |
456 | instantiate (or destroy) VNFs on a given uCPE device.</para> | 423 | uCPE devices). This is accomplished using the Enea uCPE Manager |
457 | </listitem> | 424 | Onboarding graphical user interface.</para> |
458 | 425 | ||
459 | <listitem> | 426 | <para>Typically, the Getting Started Guide of a VNF contains all necessary |
460 | <para><literal>Events</literal>: Choosing this option displays all the | 427 | information needed to onboard a VNF.</para> |
461 | events that are related to VNF lifecycle management. Whenever a VNF | ||
462 | state changes (i.e. it is | ||
463 | created/destroyed/stopped/started/paused/resumed), a state change | ||
464 | event is generated in the uCPE Manager. The screen shown when this | ||
465 | option is chosen displays all events in the system, filtered to show | ||
466 | only VNF state change notifications.</para> | ||
467 | </listitem> | ||
468 | </itemizedlist> | ||
469 | 428 | ||
470 | <section id="onboarding_a_vnf"> | 429 | <section id="retrieve_art"> |
471 | <title>Onboarding a VNF (old)</title> | 430 | <title>Retrieving Artifacts</title> |
472 | 431 | ||
473 | <para>The VNF descriptor catalog table provides a button that allows you | 432 | <para>The user must first retrieve the necessary artifacts from the |
474 | to onboard a new (third-party) VNF into the catalog.</para> | 433 | VNF vendor:</para> |
475 | 434 | ||
476 | <figure> | 435 | <orderedlist> |
477 | <title>Onboard New VNF</title> | 436 | <listitem> |
437 | <para>Download the VNF from the commercial vendor.</para> | ||
438 | </listitem> | ||
478 | 439 | ||
479 | <mediaobject> | 440 | <listitem> |
480 | <imageobject> | 441 | <para>Procure any VNF-specific files from the VNF vendor, e.g. license file.</para> |
481 | <imagedata align="center" | ||
482 | fileref="images/onboarding_a_new_vnf.png" scale="70" /> | ||
483 | </imageobject> | ||
484 | </mediaobject> | ||
485 | </figure> | ||
486 | 442 | ||
487 | <section id="onboarding_a_vnf_wizard"> | 443 | <note> |
488 | <title>Onboarding a VNF VM Image using the Onboarding Wizard</title> | 444 | <para>There are no standard ways of managing VNF licenses, |
445 | therefore no general guidelines can be provided. One example of | ||
446 | license handling that can be employed in the uCPE Manager is the | ||
447 | adding of a license during the Cloud-Init setup.</para> | ||
448 | </note> | ||
449 | </listitem> | ||
489 | 450 | ||
490 | <para><emphasis role="bold">How to onboard a VNF into the uCPE Manager | 451 | <listitem> |
491 | using the Onboarding Wizard</emphasis></para> | 452 | <para>Get access to the VNF specific VNF Manager for day 1 and 2 |
453 | configuration (in cloud or for local deployment).</para> | ||
454 | </listitem> | ||
455 | |||
456 | <listitem> | ||
457 | <para>Procure the Getting Started Guide from the VNF vendor, | ||
458 | preferably for KVM deployment for VNF specific configuration | ||
459 | information.</para> | ||
460 | </listitem> | ||
461 | </orderedlist> | ||
462 | </section> | ||
463 | |||
464 | <section id="onboard_prep"> | ||
465 | <title>Preparation</title> | ||
466 | |||
467 | <para>Once all needed downloadables, documentation and more have been | ||
468 | attained, preparation for onboarding must be completed:</para> | ||
492 | 469 | ||
493 | <orderedlist> | 470 | <orderedlist> |
494 | <listitem> | 471 | <listitem> |
495 | <para>Make sure the uCPE device is added and placed on the map in | 472 | <para>Determine the use-case and performance requirements of the |
496 | the uCPE Manager.</para> | 473 | VNF you wish to deploy:</para> |
474 | |||
475 | <itemizedlist spacing="compact"> | ||
476 | <listitem> | ||
477 | <para>This decides what resources the VNF is configured for, | ||
478 | along with networking and day zero configurations.</para> | ||
479 | |||
480 | <note><para>Generally, the Getting Started Guide for the VNF | ||
481 | provides guidelines for resource allocation, but since | ||
482 | performance is dependent on hardware capacity, the right | ||
483 | resource allocation for deployment is determined | ||
484 | through benchmarking.</para></note> | ||
485 | </listitem> | ||
486 | |||
487 | <listitem> | ||
488 | <para>Determine the amount of hardware resources needed for | ||
489 | the VNF (RAM, CPUs and Disk size).</para> | ||
490 | </listitem> | ||
491 | |||
492 | <listitem> | ||
493 | <para>Determine how many Network Interfaces the VNF will | ||
494 | use.</para> | ||
495 | </listitem> | ||
496 | </itemizedlist> | ||
497 | </listitem> | ||
498 | |||
499 | <listitem> | ||
500 | <para>Determine the day zero configuration method from the VNF | ||
501 | Getting Started guidelines.</para> | ||
502 | |||
503 | <note> | ||
504 | <para>For many VNFs, day zero configuration can be skipped in | ||
505 | early onboarding efforts when automation is not of | ||
506 | importance.</para> | ||
507 | </note> | ||
508 | </listitem> | ||
509 | |||
510 | <listitem> | ||
511 | <para>Determine any requirements needed by the Cloud-Init file | ||
512 | structure and the content needed when this structure is | ||
513 | used.</para> | ||
497 | </listitem> | 514 | </listitem> |
515 | </orderedlist> | ||
516 | </section> | ||
498 | 517 | ||
518 | <section id="onboard_in_ucpemg"> | ||
519 | <title>Onboarding into the uCPE Manager</title> | ||
520 | |||
521 | <para><emphasis role="bold">How to onboard a VNF into the uCPE Manager | ||
522 | </emphasis></para> | ||
523 | |||
524 | <orderedlist> | ||
499 | <listitem> | 525 | <listitem> |
500 | <para>Select from the top toolbar <literal>VNF</literal> -> | 526 | <para>Select from the top toolbar <literal>VNF</literal> -> |
501 | <literal>Descriptors.</literal></para> | 527 | <literal>Descriptors</literal></para> |
502 | </listitem> | 528 | </listitem> |
503 | 529 | ||
504 | <listitem> | 530 | <listitem> |
@@ -506,24 +532,24 @@ | |||
506 | </listitem> | 532 | </listitem> |
507 | 533 | ||
508 | <listitem> | 534 | <listitem> |
509 | <para>When prompted by the following UI, make sure the <literal>VM | 535 | <para>When prompted by the UI, make sure the <literal>VM |
510 | Image</literal> radio button is selected.</para> | 536 | Image</literal> radio button at the top of the onboarding |
537 | screen is selected, it will trigger a popup menu.</para> | ||
511 | </listitem> | 538 | </listitem> |
512 | </orderedlist> | 539 | </orderedlist> |
513 | 540 | ||
514 | <para>If you click the <literal>VM Image</literal> radio button at the | 541 | <para>This menu contains data fields where both necessary and optional |
515 | top of the onboarding screen, you will get a pop-up containing fields | 542 | information about the VNF can be supplied. After doing so, press |
516 | which you can fill, suppling the necessary information about the VNF. | 543 | the onboard button, the uCPE Manager will create the VNF package and onboard it.</para> |
517 | After providing the information and pressing the onboard button, the | ||
518 | uCPE Manager will create the VNF package and onboard it.</para> | ||
519 | 544 | ||
520 | <figure> | 545 | <figure> |
521 | <title>Onboard a VNF using the Wizard</title> | 546 | <title>Onboard a VNF</title> |
522 | 547 | ||
523 | <mediaobject> | 548 | <mediaobject> |
524 | <imageobject> | 549 | <imageobject> |
525 | <imagedata align="center" | 550 | <imagedata align="center" |
526 | fileref="images/onboard_a_vnf_image.png" scale="70" /> | 551 | contentwidth="600" |
552 | fileref="images/onboard_a_vnf_image.png" /> | ||
527 | </imageobject> | 553 | </imageobject> |
528 | </mediaobject> | 554 | </mediaobject> |
529 | </figure> | 555 | </figure> |
@@ -532,26 +558,26 @@ | |||
532 | 558 | ||
533 | <itemizedlist> | 559 | <itemizedlist> |
534 | <listitem> | 560 | <listitem> |
535 | <para><emphasis role="bold">VM Image File.</emphasis> This is the | 561 | <para><emphasis role="bold">VM Image File</emphasis>. This is the |
536 | Virtual Machine image file for the VNF itself. Typically, it is a | 562 | Virtual Machine image file for the VNF. Typically, it is a |
537 | QCOW image. Press <literal>Choose File</literal> and select the | 563 | QCOW image. Press <literal>Choose File</literal> and select the |
538 | image to be uploaded.</para> | 564 | image you wish to upload.</para> |
539 | </listitem> | 565 | </listitem> |
540 | 566 | ||
541 | <listitem> | 567 | <listitem> |
542 | <para><emphasis role="bold">Image Format</emphasis>. Select the | 568 | <para><emphasis role="bold">Image Format</emphasis>. Select the |
543 | format which matches the image file.</para> | 569 | format which matches the image file format.</para> |
544 | </listitem> | 570 | </listitem> |
545 | 571 | ||
546 | <listitem> | 572 | <listitem> |
547 | <para><emphasis role="bold">VNF Type Name.</emphasis> This is the | 573 | <para><emphasis role="bold">VNF Type Name</emphasis>. This is the |
548 | name that will be used to identify this VNF. It will be shown in | 574 | name that will be used to identify this VNF. It will be shown in |
549 | the VNF tables.</para> | 575 | the VNF tables.</para> |
550 | </listitem> | 576 | </listitem> |
551 | 577 | ||
552 | <listitem> | 578 | <listitem> |
553 | <para><emphasis role="bold">Description.</emphasis> This field | 579 | <para><emphasis role="bold">Description</emphasis>. This field |
554 | contains any description you want to provide. It is only displayed | 580 | contains any description provided and is only displayed |
555 | in the GUI tables in the uCPE Manager.</para> | 581 | in the GUI tables in the uCPE Manager.</para> |
556 | </listitem> | 582 | </listitem> |
557 | 583 | ||
@@ -562,21 +588,21 @@ | |||
562 | </listitem> | 588 | </listitem> |
563 | 589 | ||
564 | <listitem> | 590 | <listitem> |
565 | <para><emphasis role="bold">Memory in MB.</emphasis> This is the | 591 | <para><emphasis role="bold">Memory in MB</emphasis>. This is the |
566 | amount of memory (in megabytes) that will be provided to this type | 592 | amount of memory (in megabytes) that will be provided to this type |
567 | of VNF when it is instantiated. To determine the value for this | 593 | of VNF when it is instantiated. To determine the value for this |
568 | field, consult the VNF vendor.</para> | 594 | field, consult the VNF vendor.</para> |
569 | </listitem> | 595 | </listitem> |
570 | 596 | ||
571 | <listitem> | 597 | <listitem> |
572 | <para><emphasis role="bold">Num of CPUs.</emphasis> The number of | 598 | <para><emphasis role="bold">Num of CPUs</emphasis>. The number of |
573 | CPUs that will be dedicated to an instance of this VNF when | 599 | CPUs that will be dedicated to an instance of this VNF when |
574 | created. To determine the value for this field, consult the VNF | 600 | created. To determine the value for this field, consult the VNF |
575 | vendor.</para> | 601 | vendor.</para> |
576 | </listitem> | 602 | </listitem> |
577 | 603 | ||
578 | <listitem> | 604 | <listitem> |
579 | <para><emphasis role="bold">Storage in GB.</emphasis> How much | 605 | <para><emphasis role="bold">Storage in GB</emphasis>. How much |
580 | disk space to provide an instance of this VNF. To determine the | 606 | disk space to provide an instance of this VNF. To determine the |
581 | value for this field, consult the VNF vendor.</para> | 607 | value for this field, consult the VNF vendor.</para> |
582 | </listitem> | 608 | </listitem> |
@@ -584,56 +610,31 @@ | |||
584 | 610 | ||
585 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> | 611 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> |
586 | 612 | ||
587 | <figure> | ||
588 | <title>Interfaces Table</title> | ||
589 | |||
590 | <mediaobject> | ||
591 | <imageobject> | ||
592 | <imagedata align="center" fileref="images/interfaces_table.png" | ||
593 | scale="70" /> | ||
594 | </imageobject> | ||
595 | </mediaobject> | ||
596 | </figure> | ||
597 | |||
598 | <para>Click on the <literal>Interfaces</literal> tab to show the | 613 | <para>Click on the <literal>Interfaces</literal> tab to show the |
599 | Interfaces table.</para> | 614 | Interfaces table.</para> |
600 | 615 | ||
601 | <para>This table will contain the interfaces required by this VNF to | 616 | <para>This table will contain the interfaces required by this VNF to |
602 | be configured, when creating an instance. Consult the VNF vendor to | 617 | be configured, when creating an instance. Consult the VNF vendor to |
603 | determine which and how many are required. Each interface requires a | 618 | determine which and how many are required. Each interface requires a |
604 | name, and optionally a description, used by the uCPE Manager | 619 | name, and optionally a description, used only by the uCPE Manager.</para> |
605 | only.</para> | ||
606 | 620 | ||
607 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 621 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
608 | 622 | ||
609 | <para>Click the <literal>Clout Init</literal> tab to provide the | 623 | <para>Click the <literal>Clout Init</literal> tab to provide the |
610 | Clout-Init configuration.</para> | 624 | Clout-Init configuration. There are three fields that need to be |
611 | 625 | populated:</para> | |
612 | <figure> | ||
613 | <title>Cloud-Init Tab</title> | ||
614 | |||
615 | <mediaobject> | ||
616 | <imageobject> | ||
617 | <imagedata align="center" fileref="images/cloud_init_tab.png" | ||
618 | scale="70" /> | ||
619 | </imageobject> | ||
620 | </mediaobject> | ||
621 | </figure> | ||
622 | |||
623 | <para>As shown in the picture above, there are three fields that need | ||
624 | to be populated:</para> | ||
625 | 626 | ||
626 | <orderedlist> | 627 | <orderedlist> |
627 | <listitem> | 628 | <listitem> |
628 | <para><emphasis role="bold">Cloud-Init | 629 | <para><emphasis role="bold">Cloud-Init |
629 | Datasource</emphasis></para> | 630 | Datasource</emphasis></para> |
630 | 631 | ||
631 | <para>To onboard the VNF you must specify the<literal> Cloud-Init | 632 | <para>To onboard a VNF you must specify the <literal>Cloud-Init |
632 | Datasource</literal> that the VNF uses. You can get this | 633 | Datasource</literal> that the VNF uses. This |
633 | information from the VNF Vendor. Choose one of the following | 634 | information is procured from the VNF Vendor. Choose one of the following |
634 | methods to specify the datasource:</para> | 635 | methods to specify the datasource:</para> |
635 | 636 | ||
636 | <itemizedlist> | 637 | <itemizedlist spacing="compact"> |
637 | <listitem> | 638 | <listitem> |
638 | <para><emphasis role="bold">None</emphasis>. If there is no | 639 | <para><emphasis role="bold">None</emphasis>. If there is no |
639 | datasource.</para> | 640 | datasource.</para> |
@@ -662,7 +663,7 @@ | |||
662 | <listitem> | 663 | <listitem> |
663 | <para><emphasis role="bold">Cloud-Init Disk Type</emphasis></para> | 664 | <para><emphasis role="bold">Cloud-Init Disk Type</emphasis></para> |
664 | 665 | ||
665 | <para>The <literal>Cloud-Init Disk Type </literal>field must be | 666 | <para>The <literal>Cloud-Init Disk Type</literal> field must be |
666 | set to either <literal>Disk</literal>, or | 667 | set to either <literal>Disk</literal>, or |
667 | <literal>CD-ROM</literal>, depending on what the VNF requires. You | 668 | <literal>CD-ROM</literal>, depending on what the VNF requires. You |
668 | can get this information from the VNF Vendor.</para> | 669 | can get this information from the VNF Vendor.</para> |
@@ -675,24 +676,13 @@ | |||
675 | you choose <literal>ConfigDrive</literal> as the Cloud-Init | 676 | you choose <literal>ConfigDrive</literal> as the Cloud-Init |
676 | Datasource. For each content file added, you must provide a | 677 | Datasource. For each content file added, you must provide a |
677 | <literal>Path</literal>. When a user uses the uCPE Manager to | 678 | <literal>Path</literal>. When a user uses the uCPE Manager to |
678 | create an instance of one of these VNFs, they will be prompted to | 679 | create an instance for multiple VNFs, they will be prompted to |
679 | provide a data file for each entry in this table. Each type of VNF | 680 | provide a data file for each entry in this table. Each type of VNF |
680 | will require different cloud-init files, e.g.: a license | 681 | will require different cloud-init files, e.g.: a license |
681 | file.</para> | 682 | file.</para> |
682 | </listitem> | 683 | </listitem> |
683 | </orderedlist> | 684 | </orderedlist> |
684 | 685 | ||
685 | <figure> | ||
686 | <title>Content Files Table example</title> | ||
687 | |||
688 | <mediaobject> | ||
689 | <imageobject> | ||
690 | <imagedata align="center" | ||
691 | fileref="images/content_files_table.png" scale="70" /> | ||
692 | </imageobject> | ||
693 | </mediaobject> | ||
694 | </figure> | ||
695 | |||
696 | <para>Consult with the VNF vendor to determine what is required for | 686 | <para>Consult with the VNF vendor to determine what is required for |
697 | the VNF you are onboarding.</para> | 687 | the VNF you are onboarding.</para> |
698 | 688 | ||
@@ -700,23 +690,11 @@ | |||
700 | 690 | ||
701 | <para>In this table, you can enter values for properties that will be | 691 | <para>In this table, you can enter values for properties that will be |
702 | used during instantiation of the VNF. The values will augment the | 692 | used during instantiation of the VNF. The values will augment the |
703 | default values in the Domain.XML file used by libvirt/virsh (running | 693 | default values in the <filename>Domain.XML</filename> file used |
704 | in NFV Access) when creating an instance of the VNF. These property | 694 | by <literal>libvirt/virsh</literal> (running in NFV Access) when |
705 | names are well known to the uCPE NFV Access software, and more will be | 695 | creating an instance of the VNF. Consult with the VNF Vendor |
706 | added in future versions. You will need to consult with the VNF Vendor | ||
707 | or ENEA support for values needed by specific VNFs.</para> | 696 | or ENEA support for values needed by specific VNFs.</para> |
708 | 697 | ||
709 | <figure> | ||
710 | <title>Properties Tab</title> | ||
711 | |||
712 | <mediaobject> | ||
713 | <imageobject> | ||
714 | <imagedata align="center" fileref="images/properties_tab.png" | ||
715 | scale="70" /> | ||
716 | </imageobject> | ||
717 | </mediaobject> | ||
718 | </figure> | ||
719 | |||
720 | <para><emphasis role="bold">Property Values</emphasis></para> | 698 | <para><emphasis role="bold">Property Values</emphasis></para> |
721 | 699 | ||
722 | <para><literal>numHugePages</literal> defines the number of huge | 700 | <para><literal>numHugePages</literal> defines the number of huge |
@@ -724,203 +702,16 @@ | |||
724 | </section> | 702 | </section> |
725 | </section> | 703 | </section> |
726 | 704 | ||
727 | <section id="onboarding_a_vnf2"> | ||
728 | <title>Onboarding a VNF (copied from VNF Onboarding Guide)</title> | ||
729 | |||
730 | <para>The onboarding of a VNF means adding it to the Enea uCPE Manager | ||
731 | VNF Catalog and preparing it for instantiation (deployment on connected | ||
732 | uCPE devices). This is accomplished using the Enea uCPE Manager | ||
733 | Onboarding Wizard, a graphical user interface specifically designed to | ||
734 | make VNF onboarding simple and fast.</para> | ||
735 | |||
736 | <para>Typically, the VNF's Getting Started Guide contains all necessary | ||
737 | information needed to onboard a VNF using the Onboarding Wizard. This | ||
738 | present guide however, provides a number of examples of how to onboard | ||
739 | specific commercial VNFs.</para> | ||
740 | |||
741 | <para>The following sections detail the basic steps needed to | ||
742 | successfully onboard a VNF in the Enea uCPE Manager.</para> | ||
743 | |||
744 | <section id="retrieve_art"> | ||
745 | <title>Retrieving Artifacts</title> | ||
746 | |||
747 | <para>The user must first retrieve the necessary artifacts from the | ||
748 | VNF vendor:</para> | ||
749 | |||
750 | <orderedlist> | ||
751 | <listitem> | ||
752 | <para>Download the VNF from the commercial vendor.</para> | ||
753 | </listitem> | ||
754 | |||
755 | <listitem> | ||
756 | <para>Get any VNF specific license from the VNF vendor.</para> | ||
757 | |||
758 | <note> | ||
759 | <para>There are no standard ways of managing VNF licenses, | ||
760 | therefore no general guidelines can be provided. One example of | ||
761 | license handling that can be employed in the uCPE Manager is the | ||
762 | adding of a license during the Cloud-Init setup. The ConfigDrive | ||
763 | value is provided in the Fortios specific guidelines.</para> | ||
764 | </note> | ||
765 | </listitem> | ||
766 | |||
767 | <listitem> | ||
768 | <para>Get access to the VNF specific VNF Manager for day 1 and 2 | ||
769 | configuration (in cloud or for local deployment).</para> | ||
770 | </listitem> | ||
771 | |||
772 | <listitem> | ||
773 | <para>Procure the Getting Started Guide from the VNF vendor, | ||
774 | preferably for KVM deployment for VNF specific configuration | ||
775 | information.</para> | ||
776 | </listitem> | ||
777 | </orderedlist> | ||
778 | </section> | ||
779 | |||
780 | <section id="onboard_prep"> | ||
781 | <title>Preparation</title> | ||
782 | |||
783 | <para>Once all needed downloadables, documentation and more have been | ||
784 | attained, preparation for onboarding must be completed:</para> | ||
785 | |||
786 | <orderedlist> | ||
787 | <listitem> | ||
788 | <para>Determine the use-case and performance requirements of the | ||
789 | VNF you wish to deploy.</para> | ||
790 | |||
791 | <itemizedlist> | ||
792 | <listitem> | ||
793 | <para>This decides what resources the VNF is configured for, | ||
794 | along with networking and day zero configurations.</para> | ||
795 | |||
796 | <para>Generally, the Getting Started Guide for the VNF | ||
797 | provides guidelines for resource allocation, but since | ||
798 | performance is dependent on hardware capacity, the right | ||
799 | resource allocation for deployment is typically determined | ||
800 | through benchmarking.</para> | ||
801 | </listitem> | ||
802 | |||
803 | <listitem> | ||
804 | <para>Determine the amount of hardware resources needed for | ||
805 | the VNF (RAM, CPUs and Disk size).</para> | ||
806 | </listitem> | ||
807 | |||
808 | <listitem> | ||
809 | <para>Determine how many Network Interfaces the VNF shall | ||
810 | use.</para> | ||
811 | </listitem> | ||
812 | </itemizedlist> | ||
813 | </listitem> | ||
814 | |||
815 | <listitem> | ||
816 | <para>Determine the day zero configuration method from the VNF | ||
817 | Getting Started guidelines.</para> | ||
818 | |||
819 | <note> | ||
820 | <para>For many VNFs, day zero configuration can be skipped in | ||
821 | early onboarding efforts when automation is not of | ||
822 | importance.</para> | ||
823 | </note> | ||
824 | </listitem> | ||
825 | |||
826 | <listitem> | ||
827 | <para>Determine any requirements needed by the Cloud-Init file | ||
828 | structure and the content needed for the VNF when Cloud-Init is | ||
829 | used.</para> | ||
830 | </listitem> | ||
831 | </orderedlist> | ||
832 | </section> | ||
833 | |||
834 | <section id="onboarding2"> | ||
835 | <title>Onboarding the VNF</title> | ||
836 | |||
837 | <orderedlist> | ||
838 | <listitem> | ||
839 | <para>Enter the Enea uCPE Manager and choose VNF->Descriptors | ||
840 | in the GUI.</para> | ||
841 | </listitem> | ||
842 | |||
843 | <listitem> | ||
844 | <para>Click <literal>Onboard</literal> to start the onboarding | ||
845 | procedure.</para> | ||
846 | </listitem> | ||
847 | |||
848 | <listitem> | ||
849 | <para>Fill in all mandatory fields in the popup menu: Name, Image, | ||
850 | RAM, CPUs, Disk.</para> | ||
851 | </listitem> | ||
852 | |||
853 | <listitem> | ||
854 | <para>Define the VNF's Network Interfaces and give them | ||
855 | descriptive names.</para> | ||
856 | </listitem> | ||
857 | |||
858 | <listitem> | ||
859 | <para>Configure the Cloud-Init settings, starting with the | ||
860 | Datasource:</para> | ||
861 | |||
862 | <itemizedlist spacing="compact"> | ||
863 | <listitem> | ||
864 | <para>Choose <literal>None</literal> if Cloud-Init is not | ||
865 | used.</para> | ||
866 | </listitem> | ||
867 | |||
868 | <listitem> | ||
869 | <para>Choose <literal>ConfigDrive</literal>, | ||
870 | <literal>NoCloud</literal> or <literal>ISO</literal> depending | ||
871 | on the VNF specific Cloud-Init implementation.</para> | ||
872 | </listitem> | ||
873 | |||
874 | <listitem> | ||
875 | <para>Choose the Cloud-Init mount method based on the VNF | ||
876 | specific Cloud-Init implementation.</para> | ||
877 | </listitem> | ||
878 | |||
879 | <listitem> | ||
880 | <para>Configure any VNF specific Cloud-Init files according to | ||
881 | VNF specific documentation.</para> | ||
882 | </listitem> | ||
883 | </itemizedlist> | ||
884 | </listitem> | ||
885 | |||
886 | <listitem> | ||
887 | <para>Additional Properties (in the Properties Tab) are typically | ||
888 | not needed and can be ignored.</para> | ||
889 | </listitem> | ||
890 | |||
891 | <listitem> | ||
892 | <para>Click <literal>Onboard</literal> to add the VNF to the Enea | ||
893 | uCPE Manager VNF Catalog.</para> | ||
894 | </listitem> | ||
895 | </orderedlist> | ||
896 | |||
897 | <para>When the onboarding is complete, the VNF will appear in the VNF | ||
898 | Catalog and can be used for deploying services on the uCPE | ||
899 | devices.</para> | ||
900 | </section> | ||
901 | </section> | ||
902 | |||
903 | <section id="instantiating_a_vnf"> | 705 | <section id="instantiating_a_vnf"> |
904 | <title>Instantiating a VNF (old)</title> | 706 | <title>Instantiating a VNF</title> |
905 | 707 | ||
906 | <para>Once the VNF has been onboarded, you can instantiate a VNF on a | 708 | <para>When a VNF is onboarded and available in the VNF catalog, it can |
907 | specific uCPE device.</para> | 709 | be instantiated on connected uCPE devices. The configurations |
908 | 710 | provided when the VNF is onboarded, serve as a template for instantiation. | |
909 | <para><emphasis role="bold">How to instantiate a VNF using the | 711 | Follow the instructions below to instantiate a VNF:</para> |
910 | Wizard</emphasis></para> | ||
911 | 712 | ||
912 | <orderedlist> | 713 | <orderedlist> |
913 | <listitem> | 714 | <listitem> |
914 | <para>Make sure the uCPE device is added and placed on the map in | ||
915 | the uCPE Manager.</para> | ||
916 | </listitem> | ||
917 | |||
918 | <listitem> | ||
919 | <para>Make sure the VNF has been onboarded into the uCPE | ||
920 | Manager.</para> | ||
921 | </listitem> | ||
922 | |||
923 | <listitem> | ||
924 | <para>Select from the top toolbar <literal>VNF</literal> -> | 715 | <para>Select from the top toolbar <literal>VNF</literal> -> |
925 | <literal>Instances</literal></para> | 716 | <literal>Instances</literal></para> |
926 | </listitem> | 717 | </listitem> |
@@ -930,205 +721,91 @@ | |||
930 | </listitem> | 721 | </listitem> |
931 | 722 | ||
932 | <listitem> | 723 | <listitem> |
933 | <para>When prompted by the following UI, fill the required | 724 | <para>Fill out the following mandatory fields:</para> |
934 | fields.</para> | 725 | |
726 | <itemizedlist spacing="compact"> | ||
727 | <listitem> | ||
728 | <para>Name (a descriptive name).</para> | ||
729 | </listitem> | ||
730 | |||
731 | <listitem> | ||
732 | <para>Device (the uCPE device to instantiate the VNF on).</para> | ||
733 | </listitem> | ||
734 | |||
735 | <listitem> | ||
736 | <para>Networking Configuration:</para> | ||
737 | |||
738 | <itemizedlist spacing="compact"> | ||
739 | <listitem> | ||
740 | <para>Connect each configured NIC with a bridge, SR-IOV or | ||
741 | PCI Passthrough.</para> | ||
742 | </listitem> | ||
743 | |||
744 | <listitem> | ||
745 | <para>Set up each NIC with a driver method (DPDK or | ||
746 | e1000).</para> | ||
747 | </listitem> | ||
748 | </itemizedlist> | ||
749 | |||
750 | <note> | ||
751 | <para>All configured NICs must be set up before instantiating | ||
752 | a VNF. Failure to do so will end in a failed | ||
753 | instantiation.</para> | ||
754 | </note> | ||
755 | </listitem> | ||
756 | </itemizedlist> | ||
935 | </listitem> | 757 | </listitem> |
936 | </orderedlist> | ||
937 | |||
938 | <figure> | ||
939 | <title>Instantiating a VNF</title> | ||
940 | 758 | ||
941 | <mediaobject> | ||
942 | <imageobject> | ||
943 | <imagedata align="center" fileref="images/instantiate_a_vnf.png" | ||
944 | scale="70" /> | ||
945 | </imageobject> | ||
946 | </mediaobject> | ||
947 | </figure> | ||
948 | |||
949 | <para>There are a number of parameters to be supplied before the VNF can | ||
950 | be instantiated:</para> | ||
951 | |||
952 | <itemizedlist> | ||
953 | <listitem> | 759 | <listitem> |
954 | <para><emphasis role="bold">Name</emphasis>. The name of the | 760 | <para>Add VNF-specific configuration data by uploading a Cloud-Init file |
955 | VNF.</para> | 761 | (when the Cloud-Init is used).</para> |
956 | </listitem> | 762 | </listitem> |
957 | 763 | ||
958 | <listitem> | 764 | <listitem> |
959 | <para><emphasis role="bold">VNF Type</emphasis>. The name of the | 765 | <para>Add any VNF-specific files (e.g license files).</para> |
960 | onboarded VNF. In this case <literal>VProbe</literal> VNF.</para> | ||
961 | </listitem> | 766 | </listitem> |
962 | 767 | ||
963 | <listitem> | 768 | <listitem> |
964 | <para><emphasis role="bold">Flavour</emphasis>. The flavour of VNF | 769 | <para>Hit the <literal>Create</literal> button to deploy the |
965 | (as specified in the descriptor) you would like to | 770 | VNF and run it on the specified uCPE device.</para> |
966 | instantiate.</para> | ||
967 | </listitem> | 771 | </listitem> |
968 | 772 | </orderedlist> | |
969 | <listitem> | ||
970 | <para><emphasis role="bold">Device</emphasis>. The uCPE device on | ||
971 | which to instantiate a VNF, i.e. the uCPE device that will run this | ||
972 | VNF.</para> | ||
973 | </listitem> | ||
974 | |||
975 | <listitem> | ||
976 | <para><emphasis role="bold">Auto-start</emphasis>. If checked, the | ||
977 | VNF will be stopped and started when unreachable. When the device | ||
978 | reports that it has lost connection to the VNF, the uCPE Manager | ||
979 | will ask the device to terminate the VM and then start it up again. | ||
980 | If unchecked, only a <literal>Disconnected</literal> notification | ||
981 | will appear in the uCPE Manager.</para> | ||
982 | </listitem> | ||
983 | </itemizedlist> | ||
984 | |||
985 | <para>Hitting the <literal>Create</literal> button will cause the VNF to | ||
986 | be instantiated and run on the specified uCPE device.</para> | ||
987 | 773 | ||
988 | <para>Selecting the<literal> VNF -> Events</literal> menu will show | 774 | <para>Selecting the<literal> VNF -> Events</literal> menu will show |
989 | that the VNF was created and a connection was established:</para> | 775 | that the VNF was created and a connection was established.</para> |
990 | |||
991 | <figure> | ||
992 | <title>VNF Events menu</title> | ||
993 | |||
994 | <mediaobject> | ||
995 | <imageobject> | ||
996 | <imagedata align="center" fileref="images/instantiate_a_vnf4.png" | ||
997 | scale="70" /> | ||
998 | </imageobject> | ||
999 | </mediaobject> | ||
1000 | </figure> | ||
1001 | </section> | 776 | </section> |
1002 | 777 | ||
1003 | <section id="instantiating_a_vnf2"> | 778 | <section id="enter_console"> |
1004 | <title>Instantiating a VNF (copied from VNF Onboarding Guide)</title> | 779 | <title>Entering the VNF Console</title> |
1005 | 780 | ||
1006 | <para>When a VNF is onboarded and available in the VNF catalog, it can | 781 | <para>Once the VNF is deployed, the VNF console can be entered using SSH |
1007 | be instantiated (deployed) on connected uCPE devices. The instantiation | 782 | and virsh commands. The VNF Console is a typical starting point for |
1008 | wizard uses the configurations provided when the VNF is onboarded, as a | 783 | determining a successful deployment and configuring a VNF beyond Day |
1009 | template for instantiation. Before the instantiation, however, the uCPE | 784 | Zero.</para> |
1010 | device needs to be prepared:</para> | ||
1011 | 785 | ||
1012 | <orderedlist> | 786 | <orderedlist> |
1013 | <listitem> | 787 | <listitem> |
1014 | <para>Physical NICs used with the VNF directly (through SR-IOV or | 788 | <para>SSH to the uCPE device from the Enea uCPE Manager (<literal>Device->SSH</literal>) |
1015 | PCI Passthrough) or indirectly (through bridges) need to be | 789 | with default user and password: <literal>root</literal>.</para> |
1016 | configured (Device->Configuration->OpenVSwitch->Host | ||
1017 | Interfaces).</para> | ||
1018 | |||
1019 | <note> | ||
1020 | <para>Before configuring any physical NICs determine which is used | ||
1021 | for managing the uCPE device. Altering the configuration of a NIC | ||
1022 | may cause connectivity issues.</para> | ||
1023 | </note> | ||
1024 | </listitem> | 790 | </listitem> |
1025 | 791 | ||
1026 | <listitem> | 792 | <listitem> |
1027 | <para>Add any needed bridges, connecting them to the physical NICs | 793 | <para>In SSH:</para> |
1028 | previously configured or making them integration bridges (without | 794 | |
1029 | physical NIC) for service chaining.</para> | 795 | <orderedlist spacing="compact"> |
796 | <listitem> | ||
797 | <para>Use the <command>virsh list</command> command to list all | ||
798 | running VNFs and to determine the VNF's instance number.</para> | ||
799 | </listitem> | ||
800 | |||
801 | <listitem> | ||
802 | <para>Use the <command>virsh console <instance | ||
803 | number></command> command to enter the VNF-specific | ||
804 | console.</para> | ||
805 | </listitem> | ||
806 | </orderedlist> | ||
1030 | </listitem> | 807 | </listitem> |
1031 | </orderedlist> | 808 | </orderedlist> |
1032 | |||
1033 | <para>Once the physical NICs and bridges are configured, the VNF can be | ||
1034 | instantiated using the Instantiation Wizard.</para> | ||
1035 | |||
1036 | <section id="using_wiz2"> | ||
1037 | <title>Using the Instantiation Wizard</title> | ||
1038 | |||
1039 | <orderedlist> | ||
1040 | <listitem> | ||
1041 | <para>Enter the Instantiation Wizard by accessing | ||
1042 | VNF->Instances and hitting <literal>Add</literal>.</para> | ||
1043 | </listitem> | ||
1044 | |||
1045 | <listitem> | ||
1046 | <para>Fill out the following mandatory fields:</para> | ||
1047 | |||
1048 | <itemizedlist spacing="compact"> | ||
1049 | <listitem> | ||
1050 | <para>Name (a descriptive name).</para> | ||
1051 | </listitem> | ||
1052 | |||
1053 | <listitem> | ||
1054 | <para>Device (the uCPE device to instantiate the VNF | ||
1055 | on).</para> | ||
1056 | </listitem> | ||
1057 | |||
1058 | <listitem> | ||
1059 | <para>Networking Configuration:</para> | ||
1060 | |||
1061 | <itemizedlist spacing="compact"> | ||
1062 | <listitem> | ||
1063 | <para>Connect each configured NIC with a bridge, SR-IOV or | ||
1064 | PCI Passthrough.</para> | ||
1065 | </listitem> | ||
1066 | |||
1067 | <listitem> | ||
1068 | <para>Set up each NIC with a driver method (DPDK or | ||
1069 | e1000).</para> | ||
1070 | </listitem> | ||
1071 | </itemizedlist> | ||
1072 | |||
1073 | <note> | ||
1074 | <para>All configured NICs must be set up before | ||
1075 | instantiating a VNF. Failure to do so will end in a failed | ||
1076 | instantiation.</para> | ||
1077 | </note> | ||
1078 | </listitem> | ||
1079 | </itemizedlist> | ||
1080 | </listitem> | ||
1081 | |||
1082 | <listitem> | ||
1083 | <para>Add VNF specific configuration by uploading a Cloud-Init | ||
1084 | file (when the Cloud-Init is used).</para> | ||
1085 | </listitem> | ||
1086 | |||
1087 | <listitem> | ||
1088 | <para>Add any VNF specific files (e.g license files).</para> | ||
1089 | </listitem> | ||
1090 | |||
1091 | <listitem> | ||
1092 | <para>Hit the <literal>Create</literal> button to deploy the | ||
1093 | VNF.</para> | ||
1094 | </listitem> | ||
1095 | </orderedlist> | ||
1096 | </section> | ||
1097 | |||
1098 | <section id="enter_console"> | ||
1099 | <title>Entering the VNF Console</title> | ||
1100 | |||
1101 | <para>Once the VNF is deployed, the VNF console can be entered using | ||
1102 | SSH and virsh commands. The VNF Console is a typical starting point | ||
1103 | for determining a successful deployment and configuring a VNF beyond | ||
1104 | Day Zero.</para> | ||
1105 | |||
1106 | <orderedlist spacing="compact"> | ||
1107 | <listitem> | ||
1108 | <para>SSH to the uCPE device from the Enea uCPE Manager | ||
1109 | (Device->SSH) with default user and password: | ||
1110 | <literal>root</literal>.</para> | ||
1111 | </listitem> | ||
1112 | |||
1113 | <listitem> | ||
1114 | <para>In SSH:</para> | ||
1115 | |||
1116 | <orderedlist> | ||
1117 | <listitem> | ||
1118 | <para>Use the <command>virsh list</command> command to list | ||
1119 | all running VNFs and to determine the VNF's instance | ||
1120 | number.</para> | ||
1121 | </listitem> | ||
1122 | |||
1123 | <listitem> | ||
1124 | <para>Use the <command>virsh console <instance | ||
1125 | number></command> command to enter the VNF specific | ||
1126 | console.</para> | ||
1127 | </listitem> | ||
1128 | </orderedlist> | ||
1129 | </listitem> | ||
1130 | </orderedlist> | ||
1131 | </section> | ||
1132 | </section> | 809 | </section> |
1133 | </section> | 810 | </section> |
1134 | </chapter> | 811 | </chapter> |