summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml')
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml244
1 files changed, 124 insertions, 120 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 fc349ac..85ee5a3 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
@@ -217,7 +217,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
217 </listitem> 217 </listitem>
218 218
219 <listitem> 219 <listitem>
220 <para><filename>ReleaseNotes</filename></para> 220 <para><filename>doc/ReleaseNotes</filename></para>
221 </listitem> 221 </listitem>
222 </itemizedlist> 222 </itemizedlist>
223 </listitem> 223 </listitem>
@@ -302,7 +302,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
302 additional argument as shown below:</para> 302 additional argument as shown below:</para>
303 303
304 <programlisting>./install.sh \ 304 <programlisting>./install.sh \
305 /opt/ems ucpemanager-1.0-Build8-Linux.tar.gz \ 305 /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz \
306 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> 306 SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
307 307
308 <para>The other steps are exactly the same as specified in the 308 <para>The other steps are exactly the same as specified in the
@@ -339,7 +339,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
339 <listitem> 339 <listitem>
340 <para>Run the following command:</para> 340 <para>Run the following command:</para>
341 341
342 <programlisting>./upgrade.sh /opt/ems ucpemanager-1.0-Build8-Linux.tar.gz</programlisting> 342 <programlisting>./upgrade.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting>
343 </listitem> 343 </listitem>
344 </orderedlist> 344 </orderedlist>
345 345
@@ -535,12 +535,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
535 <para>Type. The type of device to be added, i.e <literal>Enea 535 <para>Type. The type of device to be added, i.e <literal>Enea
536 universal CPE</literal>.</para> 536 universal CPE</literal>.</para>
537 </listitem> 537 </listitem>
538 538
539 <listitem> 539 <listitem>
540 <para>Name. The name by which the device is referred to in the 540 <para>Name. The name by which the device is referred to in the
541 uCPE Manager.</para> 541 uCPE Manager.</para>
542 </listitem> 542 </listitem>
543 543
544 <listitem> 544 <listitem>
545 <para>SSH Port. The NETCONF Port used for communications. Default 545 <para>SSH Port. The NETCONF Port used for communications. Default
546 is set to 830.</para> 546 is set to 830.</para>
@@ -592,120 +592,120 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
592 592
593 <para>Available network interfaces can be added to the management 593 <para>Available network interfaces can be added to the management
594 system, for use by the networking virtualization infrastructure.</para> 594 system, for use by the networking virtualization infrastructure.</para>
595
596 <para>In order to make physical network interfaces available to the
597 virtualization infrastructure and VNFs, they must be configured into
598 the management system.</para>
599 595
600 <para>To add an interface into the uCPE Manager, select the uCPE 596 <para>In order to make physical network interfaces available to the
601 device, then from the top toolbar select <literal>Configuration 597 virtualization infrastructure and VNFs, they must be configured into the
602 -&gt; External Interfaces -&gt; Configuration -&gt; Add</literal>. The available 598 management system.</para>
603 Interface types are detailed below.</para>
604 599
605 <section id="dpdk_interface_type"> 600 <para>To add an interface into the uCPE Manager, select the uCPE device,
606 <title>DPDK Interface Type</title> 601 then from the top toolbar select <literal>Configuration -&gt; External
602 Interfaces -&gt; Configuration -&gt; Add</literal>. The available
603 Interface types are detailed below.</para>
607 604
608 <para>Configuring a physical interface in DPDK mode will require a 605 <section id="dpdk_interface_type">
609 DPDK-based application (e.g. OVS-DPDK) in order to access and use 606 <title>DPDK Interface Type</title>
610 the interface. An interface set as the DPDK can be attached to an
611 OVS-DPDK bridge.</para>
612 607
613 <note> 608 <para>Configuring a physical interface in DPDK mode will require a
614 <para>Make sure the <literal>Enable DPDK</literal> checkbox is 609 DPDK-based application (e.g. OVS-DPDK) in order to access and use the
615 selected in <literal>Device -&gt; Configuration -&gt; 610 interface. An interface set as the DPDK can be attached to an OVS-DPDK
616 DPDK</literal>, otherwise no interface can be assigned to the 611 bridge.</para>
617 DPDK.</para>
618 </note>
619 612
620 <para>To add a DPDK interface under the management system, set 613 <note>
621 appropriate values for the following fields:</para> 614 <para>Make sure the <literal>Enable DPDK</literal> checkbox is
615 selected in <literal>Device -&gt; Configuration -&gt;
616 DPDK</literal>, otherwise no interface can be assigned to the
617 DPDK.</para>
618 </note>
622 619
623 <itemizedlist> 620 <para>To add a DPDK interface under the management system, set
624 <listitem> 621 appropriate values for the following fields:</para>
625 <para>Source: name of the physical interface.</para>
626 </listitem>
627 622
628 <listitem> 623 <itemizedlist>
629 <para>Type: dpdk</para> 624 <listitem>
630 </listitem> 625 <para>Source: name of the physical interface.</para>
626 </listitem>
631 627
632 <listitem> 628 <listitem>
633 <para>Networking-type: dpdk</para> 629 <para>Type: dpdk</para>
634 </listitem> 630 </listitem>
635 631
636 <listitem> 632 <listitem>
637 <para>Dpdk-type: the kernel module that allows user space 633 <para>Networking-type: dpdk</para>
638 access to the physical interface. The <literal>vfio-pci</literal> 634 </listitem>
639 driver is used.</para>
640 </listitem>
641 </itemizedlist>
642 </section>
643 635
644 <section id="sriov_interface_type"> 636 <listitem>
645 <title>SR-IOV Interface Type</title> 637 <para>Dpdk-type: the kernel module that allows user space access
638 to the physical interface. The <literal>vfio-pci</literal> driver
639 is used.</para>
640 </listitem>
641 </itemizedlist>
642 </section>
646 643
647 <para>SR-IOV technology allows for the creation of a number of 644 <section id="sriov_interface_type">
648 virtual functions on the host interface, which can be used by VNFs 645 <title>SR-IOV Interface Type</title>
649 running on the uCPE device.</para>
650 646
651 <para>For SR-IOV mode configuration, the user must set values for 647 <para>SR-IOV technology allows for the creation of a number of virtual
652 the following fields:</para> 648 functions on the host interface, which can be used by VNFs running on
649 the uCPE device.</para>
653 650
654 <itemizedlist> 651 <para>For SR-IOV mode configuration, the user must set values for the
655 <listitem> 652 following fields:</para>
656 <para>Source: name of the physical interface.</para>
657 </listitem>
658 653
659 <listitem> 654 <itemizedlist>
660 <para>Type: sr-iov</para> 655 <listitem>
661 </listitem> 656 <para>Source: name of the physical interface.</para>
657 </listitem>
662 658
663 <listitem> 659 <listitem>
664 <para>Networking-type: srIov</para> 660 <para>Type: sr-iov</para>
665 </listitem> 661 </listitem>
666 662
667 <listitem> 663 <listitem>
668 <para>sriov-mode: adapter-pool</para> 664 <para>Networking-type: srIov</para>
669 </listitem> 665 </listitem>
670 666
671 <listitem> 667 <listitem>
672 <para>sriov-num-vfs: the number of virtual functions to 668 <para>sriov-mode: adapter-pool</para>
673 create.</para> 669 </listitem>
674 </listitem>
675 </itemizedlist>
676 </section>
677 670
678 <section id="standard_interface_type"> 671 <listitem>
679 <title>Standard Interface Type</title> 672 <para>sriov-num-vfs: the number of virtual functions to
673 create.</para>
674 </listitem>
675 </itemizedlist>
676 </section>
680 677
681 <para>Some of the physical network interfaces available on a uCPE 678 <section id="standard_interface_type">
682 device, including Ethernet interfaces, do not have DPDK or SR-IOV 679 <title>Standard Interface Type</title>
683 support. Instead, the Linux kernel driver has to be used. Wi-Fi
684 and 4G/LTE modems can also be configured and used for
685 virtualization infrastructure and VNFs.</para>
686 680
687 <para>To add Standard interfaces under the management system, the 681 <para>Some of the physical network interfaces available on a uCPE
688 user must set values for the following fields:</para> 682 device, including Ethernet interfaces, do not have DPDK or SR-IOV
683 support. Instead, the Linux kernel driver has to be used. Wi-Fi and
684 4G/LTE modems can also be configured and used for virtualization
685 infrastructure and VNFs.</para>
689 686
690 <itemizedlist> 687 <para>To add Standard interfaces under the management system, the user
691 <listitem> 688 must set values for the following fields:</para>
692 <para>Source: the name of physical interface.</para>
693 </listitem>
694 689
695 <listitem> 690 <itemizedlist>
696 <para>Networking-type: standard</para> 691 <listitem>
697 </listitem> 692 <para>Source: the name of physical interface.</para>
698 </itemizedlist> 693 </listitem>
699 </section>
700 694
701 <section condition="hidden" id="pci_passthrough_interface_type"> 695 <listitem>
702 <title>PCI Passthrough Interface Type</title> 696 <para>Networking-type: standard</para>
697 </listitem>
698 </itemizedlist>
699 </section>
703 700
704 <para>For the PCI Passthrough a user does not have to configure a 701 <section condition="hidden" id="pci_passthrough_interface_type">
705 physical interface, instead simply select the PCI address and 702 <title>PCI Passthrough Interface Type</title>
706 connect it to a virtual port when the VNF instantiation step is 703
707 reached.</para> 704 <para>For the PCI Passthrough a user does not have to configure a
708 </section> 705 physical interface, instead simply select the PCI address and connect
706 it to a virtual port when the VNF instantiation step is
707 reached.</para>
708 </section>
709 709
710 <section id="man_configuration"> 710 <section id="man_configuration">
711 <title>Manual Configuration</title> 711 <title>Manual Configuration</title>
@@ -721,22 +721,24 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
721 <para>After networking interfaces have been added to the uCPE 721 <para>After networking interfaces have been added to the uCPE
722 Manager, the user can change the interface type (DPDK, SR-IOV, 722 Manager, the user can change the interface type (DPDK, SR-IOV,
723 Standard, WAN).</para> 723 Standard, WAN).</para>
724 724
725 <note><para>WAN interfaces, which are configured during the 725 <note>
726 installation of the device, do not need to be added, they will 726 <para>WAN interfaces, which are configured during the installation
727 be automatically listed as such in the uCPE manager when the 727 of the device, do not need to be added, they will be automatically
728 device connects.</para></note> 728 listed as such in the uCPE manager when the device
729 729 connects.</para>
730 </note>
731
730 <figure> 732 <figure>
731 <title>Configuration of External Interfaces</title> 733 <title>Configuration of External Interfaces</title>
732 734
733 <mediaobject> 735 <mediaobject>
734 <imageobject> 736 <imageobject>
735 <imagedata align="center" contentwidth="600" 737 <imagedata align="center" contentwidth="600"
736 fileref="images/edit_inter_config.png" /> 738 fileref="images/edit_inter_config.png" />
737 </imageobject> 739 </imageobject>
738 </mediaobject> 740 </mediaobject>
739 </figure> 741 </figure>
740 742
741 <para><emphasis role="bold">How to Edit the Configuration of an 743 <para><emphasis role="bold">How to Edit the Configuration of an
742 Interface</emphasis></para> 744 Interface</emphasis></para>
@@ -752,11 +754,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
752 </listitem> 754 </listitem>
753 755
754 <listitem> 756 <listitem>
755 <para>In order to edit an already configured interface, (as in 757 <para>In order to edit an already configured interface, (as in
756 the example popup shown below, a WAN interface) double click 758 the example popup shown below, a WAN interface) double click on
757 on the desired one and a popup will appear. A different popup 759 the desired one and a popup will appear. A different popup
758 appears for each type of interface. From the Host Interface window, a user can 760 appears for each type of interface. From the Host Interface
759 change the networking type and the IP address assignment:</para> 761 window, a user can change the networking type and the IP address
762 assignment:</para>
760 763
761 <figure> 764 <figure>
762 <title>Editing an Interface</title> 765 <title>Editing an Interface</title>
@@ -836,9 +839,9 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
836 839
837 <para>The solution provided by Enea for in-band management is 840 <para>The solution provided by Enea for in-band management is
838 based upon an OpenvSwitch bridge fielding all traffic passing 841 based upon an OpenvSwitch bridge fielding all traffic passing
839 through the WAN physical port. Any standard 842 through the WAN physical port. Any standard or DPDK-assigned
840 or DPDK-assigned network interface can be used for the In-Band 843 network interface can be used for the In-Band management
841 management bridge.</para> 844 bridge.</para>
842 845
843 <note> 846 <note>
844 <para>The In-Band Management bridge must be recreated each time 847 <para>The In-Band Management bridge must be recreated each time
@@ -1018,8 +1021,9 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1018 </listitem> 1021 </listitem>
1019 1022
1020 <listitem> 1023 <listitem>
1021 <para>Device Grouping Tags: a tag to group devices. These tags match 1024 <para>Device Grouping Tags: a tag to group devices. These tags
1022 the customer tags provided during the installation of the device.</para> 1025 match the customer tags provided during the installation of the
1026 device.</para>
1023 </listitem> 1027 </listitem>
1024 </itemizedlist> 1028 </itemizedlist>
1025 1029