diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-05-24 09:22:06 +0200 |
---|---|---|
committer | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-05-27 11:53:50 +0200 |
commit | d507303d02e7e0db023c1d60a35586779e6ecfe7 (patch) | |
tree | 34736c634aa14ad79cb778c6cf31b2f355b552b7 | |
parent | 9b97864a55e2720ac5c1c81570b09974f34c20ef (diff) | |
download | el_releases-nfv-access-d507303d02e7e0db023c1d60a35586779e6ecfe7.tar.gz |
GettingStarted: remove bundle example and references
- Add some small steps to make onboarding and instantiating more clear.
- Restructure the "Cloud Init Tab" description to make the steps more clear.
- Remove description about what operations will take place internally
Change-Id: I03772c9708e8c4c92f0a641fb972c66be7a4b18b
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml | 298 |
1 files changed, 109 insertions, 189 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 1fb5b1c..6632834 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 | |||
@@ -9,14 +9,15 @@ | |||
9 | installed on a specific uCPE device, and how to setup the virtual | 9 | installed on a specific uCPE device, and how to setup the virtual |
10 | infrastructure manually.</para> | 10 | infrastructure manually.</para> |
11 | 11 | ||
12 | <para><emphasis role="bold">How to add a uCPE device to the management system | 12 | <para><emphasis role="bold">How to add a uCPE device to the management |
13 | </emphasis></para> | 13 | system </emphasis></para> |
14 | 14 | ||
15 | <para>Add the uCPE device running NFV Access Run Time Platform to the management system. This is | 15 | <para>Add the uCPE device running the NFV Access Run Time Platform to the |
16 | done by using the <literal>Devices -> Manage -> Add</literal> menu. | 16 | management system: <literal>Devices -> Manage -> Add</literal>. Supply |
17 | Supply information about the uCPE device, and set the | 17 | information about the uCPE device, and set the parameters that will be used |
18 | parameters that will be used to connect to the uCPE device. The relevant | 18 | to connect to it.</para> |
19 | parameters are described below:</para> | 19 | |
20 | <para>The relevant parameters are:</para> | ||
20 | 21 | ||
21 | <itemizedlist> | 22 | <itemizedlist> |
22 | <listitem> | 23 | <listitem> |
@@ -350,8 +351,8 @@ | |||
350 | 351 | ||
351 | <para>As the acting vnf manager, the uCPE Manager is responsible for | 352 | <para>As the acting vnf manager, the uCPE Manager is responsible for |
352 | handling the life-cycles of VNFs that are instantiated and run on the | 353 | handling the life-cycles of VNFs that are instantiated and run on the |
353 | various uCPE devices. The vnf manager module is written so as to be able to | 354 | various uCPE devices. The vnf manager module is written so as to be able |
354 | manage multiple VNF types. Along with it is provided a generic | 355 | to manage multiple VNF types. Along with it is provided a generic |
355 | infrastructure to allow the end-user to introduce new VNF types | 356 | infrastructure to allow the end-user to introduce new VNF types |
356 | dynamically into the system. This allows for third-party VNFs to be added | 357 | dynamically into the system. This allows for third-party VNFs to be added |
357 | over time to an existing network infrastructure without having to perform | 358 | over time to an existing network infrastructure without having to perform |
@@ -359,9 +360,9 @@ | |||
359 | 360 | ||
360 | <para>The process of VNF Onboarding consists of providing the system with | 361 | <para>The process of VNF Onboarding consists of providing the system with |
361 | sufficient information and resources related to the VNF such that it can | 362 | sufficient information and resources related to the VNF such that it can |
362 | instantiate a flavor of the VNF on the uCPE device, configure and scale it | 363 | instantiate a flavour of the VNF on the uCPE device, configure and scale |
363 | as appropriate, heal and upgrade it when necessary and tear it down at the | 364 | it as appropriate, heal and upgrade it when necessary and tear it down at |
364 | right moment.</para> | 365 | the right moment.</para> |
365 | 366 | ||
366 | <para>The vnf manager subsystem in the uCPE Manager inserts a menu item in | 367 | <para>The vnf manager subsystem in the uCPE Manager inserts a menu item in |
367 | the toolbar, called <literal>VNF</literal> as shown in the screen-shot | 368 | the toolbar, called <literal>VNF</literal> as shown in the screen-shot |
@@ -409,7 +410,7 @@ | |||
409 | <title>Onboarding a VNF</title> | 410 | <title>Onboarding a VNF</title> |
410 | 411 | ||
411 | <para>The VNF descriptor catalog table provides a button that allows you | 412 | <para>The VNF descriptor catalog table provides a button that allows you |
412 | to onboard a new (third-party) VNF bundle into the catalog.</para> | 413 | to onboard a new (third-party) VNF into the catalog.</para> |
413 | 414 | ||
414 | <figure> | 415 | <figure> |
415 | <title>Onboard New VNF</title> | 416 | <title>Onboard New VNF</title> |
@@ -422,82 +423,21 @@ | |||
422 | </mediaobject> | 423 | </mediaobject> |
423 | </figure> | 424 | </figure> |
424 | 425 | ||
425 | <para>You can onboard using one of the following methods:</para> | 426 | <section id="onboarding_a_vnf_wizard"> |
426 | |||
427 | <itemizedlist> | ||
428 | <listitem> | ||
429 | <para>Onboard a VNF Package.</para> | ||
430 | </listitem> | ||
431 | |||
432 | <listitem> | ||
433 | <para>Directly onboard a VNF VM Image (such as a QCOW) using the | ||
434 | onboarding wizard.</para> | ||
435 | </listitem> | ||
436 | </itemizedlist> | ||
437 | |||
438 | <section id="onboarding_a_bundled_vnf"> | ||
439 | <title>Onboarding a bundled VNF package</title> | ||
440 | |||
441 | <para><emphasis role="bold">How to onboard a VNF onto the uCPE | ||
442 | Manager</emphasis></para> | ||
443 | |||
444 | <orderedlist> | ||
445 | <listitem> | ||
446 | <para>Click the <literal>On-board</literal> button.</para> | ||
447 | </listitem> | ||
448 | |||
449 | <listitem> | ||
450 | <para>When prompted by the following UI, make sure the | ||
451 | <literal>VNF Package</literal> radio button is selected.</para> | ||
452 | </listitem> | ||
453 | |||
454 | <listitem> | ||
455 | <para>Click <literal>Choose File</literal> and choose the VNF | ||
456 | Package ZIP archive, e.g <literal>VProbe.zip</literal>, which | ||
457 | represents the VNF bundle.</para> | ||
458 | </listitem> | ||
459 | |||
460 | <listitem> | ||
461 | <para>Click <literal>Send</literal>.</para> | ||
462 | </listitem> | ||
463 | </orderedlist> | ||
464 | |||
465 | <figure> | ||
466 | <title>Onboarding a bundled VNF package</title> | ||
467 | |||
468 | <mediaobject> | ||
469 | <imageobject> | ||
470 | <imagedata align="center" | ||
471 | fileref="images/onboard_a_vnf_send.png" scale="70" /> | ||
472 | </imageobject> | ||
473 | </mediaobject> | ||
474 | </figure> | ||
475 | |||
476 | <para>This will cause the vnf manager to do the following: Upload the | ||
477 | ZIP file and stage it in a temporary location. Unzip it and verify its | ||
478 | contents. Extract the various components and stash them in the | ||
479 | appropriate location(s) for use by the uCPE Manager, so that the VNF | ||
480 | can be treated by the uCPE Manager as a device. Then to add the VNF | ||
481 | descriptor to the VNF Descriptor Catalog.</para> | ||
482 | |||
483 | <para>Once these operations are complete, you will be provided with a | ||
484 | success message.</para> | ||
485 | </section> | ||
486 | |||
487 | <section id="onboarding_a_bundled_vnf_wizard"> | ||
488 | <title>Onboarding a VNF VM Image using the Onboarding Wizard</title> | 427 | <title>Onboarding a VNF VM Image using the Onboarding Wizard</title> |
489 | 428 | ||
490 | <para><emphasis role="bold">How to onboard a VNF onto the uCPE Manager | 429 | <para><emphasis role="bold">How to onboard a VNF into the uCPE Manager |
491 | using the Onboarding Wizard</emphasis></para> | 430 | using the Onboarding Wizard</emphasis></para> |
492 | 431 | ||
493 | <orderedlist> | 432 | <orderedlist> |
494 | <listitem> | 433 | <listitem> |
495 | <para>Select the uCPE Device.</para> | 434 | <para>Make sure the uCPE device is added and placed on the map in |
435 | the uCPE Manager.</para> | ||
496 | </listitem> | 436 | </listitem> |
497 | 437 | ||
498 | <listitem> | 438 | <listitem> |
499 | <para>Select from the top toolbar <literal>VNF</literal> -> | 439 | <para>Select from the top toolbar <literal>VNF</literal> -> |
500 | <literal>Descriptors</literal></para> | 440 | <literal>Descriptors.</literal></para> |
501 | </listitem> | 441 | </listitem> |
502 | 442 | ||
503 | <listitem> | 443 | <listitem> |
@@ -581,7 +521,7 @@ | |||
581 | </listitem> | 521 | </listitem> |
582 | </itemizedlist> | 522 | </itemizedlist> |
583 | 523 | ||
584 | <para><emphasis role="bold">Interfaces Table</emphasis></para> | 524 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> |
585 | 525 | ||
586 | <figure> | 526 | <figure> |
587 | <title>Interfaces Table</title> | 527 | <title>Interfaces Table</title> |
@@ -620,47 +560,66 @@ | |||
620 | </figure> | 560 | </figure> |
621 | 561 | ||
622 | <para>As shown in the picture above, there are three fields that need | 562 | <para>As shown in the picture above, there are three fields that need |
623 | to be populated: Cloud-Init Datasource, Cloud-Init Disk Type and the | 563 | to be populated:</para> |
624 | Content Files Table.</para> | ||
625 | |||
626 | <para>To onboard the VNF you must specify the Cloud-Init datasource | ||
627 | that the VNF uses. You can get this information from the VNF Vendor. | ||
628 | Choose one of the following methods to specify the datasource:</para> | ||
629 | 564 | ||
630 | <itemizedlist> | 565 | <orderedlist> |
631 | <listitem> | 566 | <listitem> |
632 | <para><emphasis role="bold">ConfigDrive</emphasis>. This method | 567 | <para><emphasis role="bold">Cloud-Init |
633 | allows you to provide any number of content-data files containing | 568 | Datasource</emphasis></para> |
634 | Cloud-Init data.</para> | 569 | |
570 | <para>To onboard the VNF you must specify the<literal> Cloud-Init | ||
571 | Datasource</literal> that the VNF uses. You can get this | ||
572 | information from the VNF Vendor. Choose one of the following | ||
573 | methods to specify the datasource:</para> | ||
574 | |||
575 | <itemizedlist> | ||
576 | <listitem> | ||
577 | <para><emphasis role="bold">None</emphasis>. If there is no | ||
578 | datasource.</para> | ||
579 | </listitem> | ||
580 | |||
581 | <listitem> | ||
582 | <para><emphasis role="bold">ConfigDrive</emphasis>. This | ||
583 | method allows you to provide any number of content-data files | ||
584 | containing Cloud-Init data.</para> | ||
585 | </listitem> | ||
586 | |||
587 | <listitem> | ||
588 | <para><emphasis role="bold">NoCloud</emphasis>. This is a | ||
589 | simpler method that uses only one cloud init file | ||
590 | (User-Data).</para> | ||
591 | </listitem> | ||
592 | |||
593 | <listitem> | ||
594 | <para><emphasis role="bold">ISO</emphasis>. Pre-cooked | ||
595 | cloud-init image. This image must be created by the user | ||
596 | according to VNF requirements.</para> | ||
597 | </listitem> | ||
598 | </itemizedlist> | ||
635 | </listitem> | 599 | </listitem> |
636 | 600 | ||
637 | <listitem> | 601 | <listitem> |
638 | <para><emphasis role="bold">NoCloud</emphasis>. This is a simpler | 602 | <para><emphasis role="bold">Cloud-Init Disk Type</emphasis></para> |
639 | method that uses only one cloud init file (User-Data).</para> | 603 | |
604 | <para>The <literal>Cloud-Init Disk Type </literal>field must be | ||
605 | set to either <literal>Disk</literal>, or | ||
606 | <literal>CD-ROM</literal>, depending on what the VNF requires. You | ||
607 | can get this information from the VNF Vendor.</para> | ||
640 | </listitem> | 608 | </listitem> |
641 | 609 | ||
642 | <listitem> | 610 | <listitem> |
643 | <para><emphasis role="bold">ISO</emphasis>. Pre-cooked cloud-init | 611 | <para><emphasis role="bold">Content Files Table</emphasis></para> |
644 | image. This image must be created by user according to VNF | 612 | |
645 | requirements.</para> | 613 | <para>The <literal>Content Files Table </literal>is ONLY used if |
614 | you choose <literal>ConfigDrive</literal> as the Cloud-Init | ||
615 | Datasource. For each content file added, you must provide a | ||
616 | <literal>Path</literal>. When a user uses the uCPE Manager to | ||
617 | create an instance of one of these VNFs, they will be prompted to | ||
618 | provide a data file for each entry in this table. Each type of VNF | ||
619 | will require different cloud-init files, e.g.: a license | ||
620 | file.</para> | ||
646 | </listitem> | 621 | </listitem> |
647 | </itemizedlist> | 622 | </orderedlist> |
648 | |||
649 | <para>The Cloud-Init Disk Type field must be set to either | ||
650 | <literal>Disk</literal>, or <literal>CD-ROM</literal>, depending on | ||
651 | what the VNF requires. You can get this information from the VNF | ||
652 | Vendor.</para> | ||
653 | |||
654 | <para>The Content Files Table is used ONLY if you chose | ||
655 | <literal>ConfigDrive</literal> as the Cloud-Init Datasource. For each | ||
656 | content file added, you must provide a <literal>Path</literal>. When a | ||
657 | user uses the uCPE Manager to create an instance of one of these VNFs, | ||
658 | they will be prompted to provide a data file for each entry in this | ||
659 | table. Each type of VNF will require different cloud-init files, e.g.: | ||
660 | a license file.</para> | ||
661 | |||
662 | <para>Consult with the VNF vendor to determine what is required for | ||
663 | the VNF you are onboarding.</para> | ||
664 | 623 | ||
665 | <figure> | 624 | <figure> |
666 | <title>Content Files Table example</title> | 625 | <title>Content Files Table example</title> |
@@ -673,6 +632,9 @@ | |||
673 | </mediaobject> | 632 | </mediaobject> |
674 | </figure> | 633 | </figure> |
675 | 634 | ||
635 | <para>Consult with the VNF vendor to determine what is required for | ||
636 | the VNF you are onboarding.</para> | ||
637 | |||
676 | <para><emphasis role="bold">Properties Tab</emphasis></para> | 638 | <para><emphasis role="bold">Properties Tab</emphasis></para> |
677 | 639 | ||
678 | <para>In this table, you can enter values for properties that will be | 640 | <para>In this table, you can enter values for properties that will be |
@@ -704,14 +666,37 @@ | |||
704 | <section id="instantiating_a_vnf"> | 666 | <section id="instantiating_a_vnf"> |
705 | <title>Instantiating a VNF</title> | 667 | <title>Instantiating a VNF</title> |
706 | 668 | ||
707 | <para>Once the VNF bundle has been onboarded, you can instantiate a VNF | 669 | <para>Once the VNF has been onboarded, you can instantiate a VNF on a |
708 | on a specific uCPE device.</para> | 670 | specific uCPE device.</para> |
671 | |||
672 | <para><emphasis role="bold">How to instantiate a VNF using the | ||
673 | Wizard</emphasis></para> | ||
709 | 674 | ||
710 | <para>Launch the <literal>VNF instance</literal> table by choosing the | 675 | <orderedlist> |
711 | <literal>Instances</literal> option from the <literal>VNF</literal> | 676 | <listitem> |
712 | menu. This will display the table of VNF instances controlled by the VNF | 677 | <para>Make sure the uCPE device is added and placed on the map in |
713 | Manager. Hit the <literal>Add</literal> button to create a new | 678 | the uCPE Manager.</para> |
714 | instance:</para> | 679 | </listitem> |
680 | |||
681 | <listitem> | ||
682 | <para>Make sure the VNF has been onboarded into the uCPE | ||
683 | Manager.</para> | ||
684 | </listitem> | ||
685 | |||
686 | <listitem> | ||
687 | <para>Select from the top toolbar <literal>VNF</literal> -> | ||
688 | <literal>Instances</literal></para> | ||
689 | </listitem> | ||
690 | |||
691 | <listitem> | ||
692 | <para>Click the <literal>Add</literal> button.</para> | ||
693 | </listitem> | ||
694 | |||
695 | <listitem> | ||
696 | <para>When prompted by the following UI, fill the required | ||
697 | fields.</para> | ||
698 | </listitem> | ||
699 | </orderedlist> | ||
715 | 700 | ||
716 | <figure> | 701 | <figure> |
717 | <title>Instantiating a VNF</title> | 702 | <title>Instantiating a VNF</title> |
@@ -735,13 +720,13 @@ | |||
735 | 720 | ||
736 | <listitem> | 721 | <listitem> |
737 | <para><emphasis role="bold">VNF Type</emphasis>. The name of the | 722 | <para><emphasis role="bold">VNF Type</emphasis>. The name of the |
738 | on-boarded VNF bundle. In this case <literal>VProbe</literal> | 723 | onboarded VNF. In this case <literal>VProbe</literal> VNF.</para> |
739 | VNF.</para> | ||
740 | </listitem> | 724 | </listitem> |
741 | 725 | ||
742 | <listitem> | 726 | <listitem> |
743 | <para><emphasis role="bold">Flavor</emphasis>. The flavor of VNF (as | 727 | <para><emphasis role="bold">Flavour</emphasis>. The flavour of VNF |
744 | specified in the descriptor) you would like to instantiate.</para> | 728 | (as specified in the descriptor) you would like to |
729 | instantiate.</para> | ||
745 | </listitem> | 730 | </listitem> |
746 | 731 | ||
747 | <listitem> | 732 | <listitem> |
@@ -751,15 +736,6 @@ | |||
751 | </listitem> | 736 | </listitem> |
752 | 737 | ||
753 | <listitem> | 738 | <listitem> |
754 | <para><emphasis role="bold">Instantiation Parameters</emphasis>. | ||
755 | This section contains all the parameters a user needs to supply when | ||
756 | instantiating a VNF of this type. The <literal>VProbe</literal> VNF | ||
757 | needs to specify network information (network name and IP address) | ||
758 | for two separate interfaces. Every VNF type will have a different UI | ||
759 | section here.</para> | ||
760 | </listitem> | ||
761 | |||
762 | <listitem> | ||
763 | <para><emphasis role="bold">Auto-start</emphasis>. If checked, the | 739 | <para><emphasis role="bold">Auto-start</emphasis>. If checked, the |
764 | VNF will be stopped and started when unreachable. When the VIM | 740 | VNF will be stopped and started when unreachable. When the VIM |
765 | reports that it has lost connection to the VNF, the uCPE Manager | 741 | reports that it has lost connection to the VNF, the uCPE Manager |
@@ -770,63 +746,7 @@ | |||
770 | </itemizedlist> | 746 | </itemizedlist> |
771 | 747 | ||
772 | <para>Hitting the <literal>Create</literal> button will cause the VNF to | 748 | <para>Hitting the <literal>Create</literal> button will cause the VNF to |
773 | be instantiated and run on the uCPE device specified above. The | 749 | be instantiated and run on the specified uCPE device.</para> |
774 | following operations will now take place:</para> | ||
775 | |||
776 | <orderedlist> | ||
777 | <listitem> | ||
778 | <para>Check if the uCPE device already has the VNF Flavor definition in its | ||
779 | flavor store; if not create a new Flavor definition on the | ||
780 | uCPE device.</para> | ||
781 | </listitem> | ||
782 | |||
783 | <listitem> | ||
784 | <para>Check if the uCPE device already has the VNF image in its image | ||
785 | store; if not, upload the image and create a new Image definition on | ||
786 | the uCPE device.</para> | ||
787 | </listitem> | ||
788 | |||
789 | <listitem> | ||
790 | <para>Take in the user parameters and create the following:</para> | ||
791 | |||
792 | <itemizedlist> | ||
793 | <listitem> | ||
794 | <para><emphasis role="bold">Networking information.</emphasis> | ||
795 | Use the <literal>VnfGuiProcessorIf</literal> class<literal> | ||
796 | getConnectionInfo()</literal> method to convert user parameters | ||
797 | into networking information objects (refer to Section 6.1 for | ||
798 | the <literal>VProbe</literal> VNF).</para> | ||
799 | </listitem> | ||
800 | </itemizedlist> | ||
801 | |||
802 | <itemizedlist> | ||
803 | <listitem> | ||
804 | <para><emphasis role="bold">Cloud-init.</emphasis> Use generic | ||
805 | VNF instance information in conjunction with the networking | ||
806 | information objects from above and invoke the | ||
807 | <literal>getCloudInitData()</literal> method on the | ||
808 | <literal>VnfProcessorIf</literal> class (refer to Section 6.2 | ||
809 | for how this is done for the <literal>VProbe</literal> VNF). The | ||
810 | cloud-init data is the script that will be executed by the VNF | ||
811 | when it starts up for the first time only. It is responsible for | ||
812 | setting up the initial system configuration to what is required | ||
813 | by the VNF to run correctly, setting up the network interfaces, | ||
814 | static IP addresses, etc.</para> | ||
815 | </listitem> | ||
816 | </itemizedlist> | ||
817 | </listitem> | ||
818 | |||
819 | <listitem> | ||
820 | <para>Make the uCPE create the VNF with the specified image, flavor | ||
821 | and cloud-init data via a NETCONF request and wait for the VNF to be | ||
822 | created and booted up.</para> | ||
823 | </listitem> | ||
824 | |||
825 | <listitem> | ||
826 | <para>If successful, optionally add the newly created VNF as a | ||
827 | device in the uCPE Manager.</para> | ||
828 | </listitem> | ||
829 | </orderedlist> | ||
830 | 750 | ||
831 | <para>Selecting the<literal> VNF -> Events</literal> menu will show | 751 | <para>Selecting the<literal> VNF -> Events</literal> menu will show |
832 | that the VNF was created and a connection was established:</para> | 752 | that the VNF was created and a connection was established:</para> |