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.xml666
1 files changed, 275 insertions, 391 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 1940eb1..fc349ac 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
@@ -254,12 +254,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
254 254
255 <note> 255 <note>
256 <para>The service will be automatically started when the computer 256 <para>The service will be automatically started when the computer
257 boots up. The user may enable the firewall in order to allow access 257 boots up. The user may enable the firewall in order to allow access to
258 to these specific ports: 80 (TCP), 443 (TCP), 54327 (UDP) and 258 these specific ports: 80 (TCP), 443 (TCP), 54327 (UDP) and 5701:5708
259 5701:5708 (TCP). If callhome is used access to the following ports 259 (TCP). If callhome is used access to the following ports must also be
260 must also be allowed: 4334 (TCP) and 2021:2040 (TCP). Otherwise, 260 allowed: 4334 (TCP) and 2021:2040 (TCP). Otherwise, the user should
261 the user should check that the CentOS machine where the uCPE Manager is 261 check that the CentOS machine where the uCPE Manager is installed has
262 installed has the firewall disabled.</para> 262 the firewall disabled.</para>
263 </note> 263 </note>
264 264
265 <para>Verify that the installation has succeeded by:</para> 265 <para>Verify that the installation has succeeded by:</para>
@@ -535,50 +535,32 @@ 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 </itemizedlist> 538
539 539 <listitem>
540 <itemizedlist>
541 <listitem>
542 <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
543 uCPE Manager.</para> 541 uCPE Manager.</para>
544 </listitem> 542 </listitem>
545 </itemizedlist> 543
546
547 <itemizedlist>
548 <listitem>
549 <para>IP Address. IP address of the uCPE device.</para>
550 </listitem>
551 </itemizedlist>
552
553 <itemizedlist>
554 <listitem> 544 <listitem>
555 <para>SSH Port. The NETCONF Port used for communications. Default 545 <para>SSH Port. The NETCONF Port used for communications. Default
556 is set to 830.</para> 546 is set to 830.</para>
557 </listitem> 547 </listitem>
558 </itemizedlist>
559 548
560 <itemizedlist>
561 <listitem> 549 <listitem>
562 <para>SSH User Name. The user name for SSH connectivity. Default 550 <para>SSH User Name. The user name for SSH connectivity. Default
563 user is root.</para> 551 user is root.</para>
564 </listitem> 552 </listitem>
565 </itemizedlist>
566 553
567 <itemizedlist>
568 <listitem> 554 <listitem>
569 <para>SSH Password. Leave this blank.</para> 555 <para>SSH Password. Leave this blank.</para>
570 </listitem> 556 </listitem>
571 </itemizedlist>
572 557
573 <itemizedlist>
574 <listitem> 558 <listitem>
575 <para>Device Calls Home. This checkbox indicates the direction of 559 <para>Device Calls Home. This checkbox indicates the direction of
576 device communications. For Direct Connection, leave this flag 560 device communications. For Direct Connection, leave this flag
577 unchecked.</para> 561 unchecked.</para>
578 </listitem> 562 </listitem>
579 </itemizedlist>
580 563
581 <itemizedlist>
582 <listitem> 564 <listitem>
583 <para>Device ID. The unique identifier of the uCPE device.</para> 565 <para>Device ID. The unique identifier of the uCPE device.</para>
584 </listitem> 566 </listitem>
@@ -590,13 +572,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
590 572
591 <para>Follow the same steps as described in the previous section, 573 <para>Follow the same steps as described in the previous section,
592 making sure that the <literal>Device Calls Home</literal> checkbox is 574 making sure that the <literal>Device Calls Home</literal> checkbox is
593 selected this time. The <literal>IP Address</literal> of the uCPE device 575 selected this time.</para>
594 is not required.</para>
595 576
596 <para>When using this mechanism, the device will initiate a connection 577 <para>When using this mechanism, the device will initiate a connection
597 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE 578 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
598 Manager waits for a device connection. For more information please 579 Manager waits for a device connection. For more information please see
599 see section <link linkend="install_ena_stick">Installing Enea NFV 580 section <link linkend="install_ena_stick">Installing Enea NFV
600 Access</link> for more details.</para> 581 Access</link> for more details.</para>
601 </section> 582 </section>
602 </section> 583 </section>
@@ -611,295 +592,189 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
611 592
612 <para>Available network interfaces can be added to the management 593 <para>Available network interfaces can be added to the management
613 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>
614 599
615 <section id="man_configuration"> 600 <para>To add an interface into the uCPE Manager, select the uCPE
616 <title>Manual Configuration</title> 601 device, then from the top toolbar select <literal>Configuration
602 -&gt; External Interfaces -&gt; Configuration -&gt; Add</literal>. The available
603 Interface types are detailed below.</para>
617 604
618 <para>For Manual Configuration of uCPE networking, select the uCPE 605 <section id="dpdk_interface_type">
619 device first and then <literal>Configuration</literal> -&gt; 606 <title>DPDK Interface Type</title>
620 <literal>External Interfaces</literal>, where one can find a list of
621 available network interfaces and their capabilities.</para>
622 607
623 <section id="configure_interfaces"> 608 <para>Configuring a physical interface in DPDK mode will require a
624 <title>Configuring Interfaces</title> 609 DPDK-based application (e.g. OVS-DPDK) in order to access and use
610 the interface. An interface set as the DPDK can be attached to an
611 OVS-DPDK bridge.</para>
625 612
626 <para>After networking interfaces have been added to the uCPE 613 <note>
627 Manager, the user can change the interface type (DPDK, SR-IOV, 614 <para>Make sure the <literal>Enable DPDK</literal> checkbox is
628 Standard, wan).</para> 615 selected in <literal>Device -&gt; Configuration -&gt;
616 DPDK</literal>, otherwise no interface can be assigned to the
617 DPDK.</para>
618 </note>
629 619
630 <para><emphasis role="bold">How to Edit the Configuration of an 620 <para>To add a DPDK interface under the management system, set
631 Interface</emphasis></para> 621 appropriate values for the following fields:</para>
632 622
633 <orderedlist> 623 <itemizedlist>
634 <listitem> 624 <listitem>
635 <figure> 625 <para>Source: name of the physical interface.</para>
636 <title>Configuration of External Interfaces</title> 626 </listitem>
637 627
638 <mediaobject> 628 <listitem>
639 <imageobject> 629 <para>Type: dpdk</para>
640 <imagedata align="center" contentwidth="500" 630 </listitem>
641 fileref="images/edit_inter_config.png" />
642 </imageobject>
643 </mediaobject>
644 </figure>
645 631
646 <para>To edit an interface configuration type from the uCPE 632 <listitem>
647 Manager, select the uCPE device, then from the top toolbar 633 <para>Networking-type: dpdk</para>
648 select the <literal>Configuration</literal> menu then 634 </listitem>
649 <literal>External Interfaces -&gt; Configuration</literal>. The
650 already configured interfaces are displayed here, as can be seen
651 in the figure above.</para>
652 </listitem>
653 635
654 <listitem> 636 <listitem>
655 <para>In order to edit an already configured interface, double 637 <para>Dpdk-type: the kernel module that allows user space
656 click on the desired one and a popup will appear as shown in the 638 access to the physical interface. The <literal>vfio-pci</literal>
657 figure below. From the Host Interface window, a user can change 639 driver is used.</para>
658 the networking type and the IP address assignment:</para> 640 </listitem>
641 </itemizedlist>
642 </section>
659 643
660 <figure> 644 <section id="sriov_interface_type">
661 <title>Editing an Interface</title> 645 <title>SR-IOV Interface Type</title>
662 646
663 <mediaobject> 647 <para>SR-IOV technology allows for the creation of a number of
664 <imageobject> 648 virtual functions on the host interface, which can be used by VNFs
665 <imagedata align="center" contentwidth="500" 649 running on the uCPE device.</para>
666 fileref="images/edit_inter.png" />
667 </imageobject>
668 </mediaobject>
669 </figure>
670 </listitem>
671 </orderedlist>
672 650
673 <para><emphasis role="bold">Set the IP address assignment of the 651 <para>For SR-IOV mode configuration, the user must set values for
674 Management Interface to static</emphasis></para> 652 the following fields:</para>
675 653
676 <orderedlist> 654 <itemizedlist>
677 <listitem> 655 <listitem>
678 <para>To change an interface type from the uCPE Manager, select 656 <para>Source: name of the physical interface.</para>
679 the uCPE device, then from the top toolbar select 657 </listitem>
680 <literal>Configuration</literal> and then <literal>External
681 Interfaces -&gt; Configuration</literal>. The already configured
682 interfaces are displayed here.</para>
683 </listitem>
684 658
685 <listitem> 659 <listitem>
686 <para>From the interfaces' list, edit the interface which has 660 <para>Type: sr-iov</para>
687 the "Management" flag set to "true", by double clicking on it, 661 </listitem>
688 triggering a popup window:</para>
689 662
690 <figure> 663 <listitem>
691 <title>Editing the Management Interface</title> 664 <para>Networking-type: srIov</para>
665 </listitem>
692 666
693 <mediaobject> 667 <listitem>
694 <imageobject> 668 <para>sriov-mode: adapter-pool</para>
695 <imagedata align="center" contentwidth="500" 669 </listitem>
696 fileref="images/edit_mg_inter.png" />
697 </imageobject>
698 </mediaobject>
699 </figure>
700 </listitem>
701 670
702 <listitem> 671 <listitem>
703 <para>From the Host Interface window, change the <literal>IP 672 <para>sriov-num-vfs: the number of virtual functions to
704 address-assignment</literal> to "static". After the address 673 create.</para>
705 assignment is set, the user needs to set the <literal>IP 674 </listitem>
706 address</literal>, <literal>netmask</literal> and the 675 </itemizedlist>
707 <literal>gateway</literal> of the interface. The user can use 676 </section>
708 the dropdown list to set the type of the IP version:
709 <literal>IPv4</literal> or <literal>IPv6</literal>
710 address:</para>
711 677
712 <figure> 678 <section id="standard_interface_type">
713 <title>Setting the IP version</title> 679 <title>Standard Interface Type</title>
714 680
715 <mediaobject> 681 <para>Some of the physical network interfaces available on a uCPE
716 <imageobject> 682 device, including Ethernet interfaces, do not have DPDK or SR-IOV
717 <imagedata align="center" contentwidth="500" 683 support. Instead, the Linux kernel driver has to be used. Wi-Fi
718 fileref="images/setting_ip_version.png" /> 684 and 4G/LTE modems can also be configured and used for
719 </imageobject> 685 virtualization infrastructure and VNFs.</para>
720 </mediaobject>
721 </figure>
722 </listitem>
723 </orderedlist>
724 686
725 <para><emphasis role="bold">Set the IP address assignment of the 687 <para>To add Standard interfaces under the management system, the
726 Management Interface to DHCP</emphasis></para> 688 user must set values for the following fields:</para>
727 689
728 <orderedlist> 690 <itemizedlist>
729 <listitem> 691 <listitem>
730 <para>To change an interface type from the uCPE Manager, select 692 <para>Source: the name of physical interface.</para>
731 the uCPE device, then from the top toolbar select 693 </listitem>
732 <literal>Configuration</literal> and then <literal>External
733 Interfaces -&gt; Configuration</literal>. The already configured
734 interfaces are displayed here.</para>
735 </listitem>
736 694
737 <listitem> 695 <listitem>
738 <para>From the interfaces' list, edit the interface which has 696 <para>Networking-type: standard</para>
739 the "Management" flag set to "true", by double clicking on it, 697 </listitem>
740 triggering a popup window. Within the Host Interface window 698 </itemizedlist>
741 change the <literal>IP address assignment</literal> to 699 </section>
742 "dhcp".</para>
743 700
744 <figure> 701 <section condition="hidden" id="pci_passthrough_interface_type">
745 <title>Editing the Management Interface to DHCP</title> 702 <title>PCI Passthrough Interface Type</title>
703
704 <para>For the PCI Passthrough a user does not have to configure a
705 physical interface, instead simply select the PCI address and
706 connect it to a virtual port when the VNF instantiation step is
707 reached.</para>
708 </section>
709
710 <section id="man_configuration">
711 <title>Manual Configuration</title>
712
713 <para>For Manual Configuration of uCPE networking, select the uCPE
714 device first and then <literal>Configuration</literal> -&gt;
715 <literal>External Interfaces</literal>, where one can find a list of
716 available network interfaces and their capabilities.</para>
717
718 <section id="configure_interfaces">
719 <title>Configuring Interfaces</title>
720
721 <para>After networking interfaces have been added to the uCPE
722 Manager, the user can change the interface type (DPDK, SR-IOV,
723 Standard, WAN).</para>
724
725 <note><para>WAN interfaces, which are configured during the
726 installation of the device, do not need to be added, they will
727 be automatically listed as such in the uCPE manager when the
728 device connects.</para></note>
729
730 <figure>
731 <title>Configuration of External Interfaces</title>
746 732
747 <mediaobject> 733 <mediaobject>
748 <imageobject> 734 <imageobject>
749 <imagedata align="center" contentwidth="500" 735 <imagedata align="center" contentwidth="600"
750 fileref="images/setting_ip_version_dhcp.png" /> 736 fileref="images/edit_inter_config.png" />
751 </imageobject> 737 </imageobject>
752 </mediaobject> 738 </mediaobject>
753 </figure> 739 </figure>
754 </listitem>
755 </orderedlist>
756 740
757 <para><emphasis role="bold">Changing the static IP of the Management 741 <para><emphasis role="bold">How to Edit the Configuration of an
758 Interface</emphasis></para> 742 Interface</emphasis></para>
759 743
760 <orderedlist> 744 <orderedlist>
761 <listitem> 745 <listitem>
762 <para>To change an interface type from the uCPE Manager, select 746 <para>To edit an interface configuration type from the uCPE
763 the uCPE device, then from the top toolbar select 747 Manager, select the uCPE device, then from the top toolbar
764 <literal>Configuration</literal> and then <literal>External 748 select the <literal>Configuration</literal> menu then
765 Interfaces -&gt; Configuration</literal>. The already configured 749 <literal>External Interfaces -&gt; Configuration</literal>. The
766 interfaces are displayed here.</para> 750 already configured interfaces are displayed here, as can be seen
751 in the figure above.</para>
767 </listitem> 752 </listitem>
768 753
769 <listitem> 754 <listitem>
770 <para>From the interfaces' list, edit the interface which has 755 <para>In order to edit an already configured interface, (as in
771 the "Management" flag set to "true", by double clicking on it, 756 the example popup shown below, a WAN interface) double click
772 triggering a popup window. Within the Host Interface window 757 on the desired one and a popup will appear. A different popup
773 change the "static" <literal>IP address</literal> as well as the 758 appears for each type of interface. From the Host Interface window, a user can
774 <literal>netmask</literal> and the 759 change the networking type and the IP address assignment:</para>
775 <literal>gateway</literal>.</para>
776 760
777 <figure> 761 <figure>
778 <title>Changing the Static, Netmask and Gateway IPs</title> 762 <title>Editing an Interface</title>
779 763
780 <mediaobject> 764 <mediaobject>
781 <imageobject> 765 <imageobject>
782 <imagedata align="center" contentwidth="500" 766 <imagedata align="center" contentwidth="500"
783 fileref="images/changing_ips.png" /> 767 fileref="images/edit_inter.png" />
784 </imageobject> 768 </imageobject>
785 </mediaobject> 769 </mediaobject>
786 </figure> 770 </figure>
787
788 <note>
789 <para>The user can use the dropdown list to set the type of
790 the IP version: <literal>IPv4</literal> or
791 <literal>IPv6</literal> address.</para>
792 </note>
793 </listitem> 771 </listitem>
794 </orderedlist> 772 </orderedlist>
795 773
796 <para>In order to make physical network interfaces available to the
797 virtualization infrastructure and VNFs, they must be configured into
798 the management system.</para>
799
800 <para>To add an interface into the uCPE Manager, select the uCPE
801 device, then from the top toolbar select <literal>Configuration
802 -&gt; OpenVSwitch -&gt; Host Interfaces</literal>. The available
803 Interface types are detailed below.</para>
804
805 <para><emphasis role="bold">DPDK Interface Type</emphasis></para>
806
807 <para>Configuring a physical interface in DPDK mode will require a
808 DPDK-based application (e.g. OVS-DPDK) in order to access and use
809 the interface. An interface set as the DPDK can be attached to an
810 OVS-DPDK bridge.</para>
811
812 <note> 774 <note>
813 <para>Make sure the <literal>Enable DPDK</literal> checkbox is 775 <para>The IP address assignment of an interface can be set as
814 selected in <literal>Device -&gt; Configuration -&gt; 776 static or dynamic for each type of interface.</para>
815 DPDK</literal>, otherwise no interface can be assigned to the
816 DPDK.</para>
817 </note> 777 </note>
818
819 <para>To add a DPDK interface under the management system, set
820 appropriate values for the following fields:</para>
821
822 <itemizedlist>
823 <listitem>
824 <para>Source: name of the physical interface.</para>
825 </listitem>
826
827 <listitem>
828 <para>Type: dpdk</para>
829 </listitem>
830
831 <listitem>
832 <para>Networking-type: dpdk</para>
833 </listitem>
834
835 <listitem>
836 <para>Dpdk-type: the kernel module that allows user space access
837 to the physical interface. Enea recommends using the
838 <literal>vfio-pci</literal> driver.</para>
839 </listitem>
840 </itemizedlist>
841
842 <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para>
843
844 <para>SR-IOV technology allows for the creation of a number of
845 virtual functions on the host interface, which can be used by VNFs
846 running on the uCPE device.</para>
847
848 <para>For SR-IOV mode configuration, the user must set values for
849 the following fields:</para>
850
851 <itemizedlist>
852 <listitem>
853 <para>Source: name of the physical interface.</para>
854 </listitem>
855
856 <listitem>
857 <para>Type: sr-iov</para>
858 </listitem>
859
860 <listitem>
861 <para>Networking-type: srIov</para>
862 </listitem>
863
864 <listitem>
865 <para>sriov-mode: adapter-pool</para>
866 </listitem>
867
868 <listitem>
869 <para>sriov-num-vfs: the number of virtual functions to
870 create.</para>
871 </listitem>
872 </itemizedlist>
873
874 <para><emphasis role="bold">Standard Interface
875 Type</emphasis></para>
876
877 <para>Some of the physical network interfaces available on a uCPE
878 device, including Ethernet interfaces, do not have DPDK or SR-IOV
879 support. Instead, the Linux kernel driver has to be used. Wi-Fi and
880 4G/LTE modems can also be configured and used for virtualization
881 infrastructure and VNFs.</para>
882
883 <para>To add Standard interfaces under the management system, the
884 user must set values for the following fields:</para>
885
886 <itemizedlist>
887 <listitem>
888 <para>Source: the name of physical interface.</para>
889 </listitem>
890
891 <listitem>
892 <para>Networking-type: standard</para>
893 </listitem>
894 </itemizedlist>
895
896 <para condition="hidden"><emphasis role="bold">PCI Passthrough
897 Interface Type</emphasis></para>
898
899 <para condition="hidden">For the PCI Passthrough a user does not
900 have to configure a physical interface, instead simply select the
901 PCI address and connect it to a virtual port when the VNF
902 instantiation step is reached.</para>
903 </section> 778 </section>
904 779
905 <section id="configure_bridges"> 780 <section id="configure_bridges">
@@ -908,6 +783,17 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
908 <para>After networking interfaces have been added to the uCPE 783 <para>After networking interfaces have been added to the uCPE
909 Manager, the user can create the necessary OVS bridges.</para> 784 Manager, the user can create the necessary OVS bridges.</para>
910 785
786 <figure>
787 <title>OVS Bridges</title>
788
789 <mediaobject>
790 <imageobject>
791 <imagedata align="center" contentwidth="600"
792 fileref="images/ovs_bridges_tab.png" />
793 </imageobject>
794 </mediaobject>
795 </figure>
796
911 <para><emphasis role="bold">How to add OVS bridges in the uCPE 797 <para><emphasis role="bold">How to add OVS bridges in the uCPE
912 Manager</emphasis></para> 798 Manager</emphasis></para>
913 799
@@ -936,145 +822,139 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
936 </note> 822 </note>
937 823
938 <para>There are three types of bridges which can be created, each 824 <para>There are three types of bridges which can be created, each
939 one fulfiling a different role:</para> 825 one fulfiling a different role.</para>
940 826
941 <para><emphasis role="bold">uCPE In-band Management 827 <section id="inband_mg_bridge">
942 bridge</emphasis></para> 828 <title>uCPE In-band Management bridge</title>
943 829
944 <para>In-band Management refers to a model where both the data plane 830 <para>In-band Management refers to a model where both the data
945 and control plane flow over the same network path. In some 831 plane and control plane flow over the same network path. In some
946 situations (e.g. the uCPE device has only one routable IP address), 832 situations (e.g. the uCPE device has only one routable IP
947 this is the only option available to both control and configure the 833 address), this is the only option available to both control and
948 uCPE device, while also allowing for data-path traffic to pass over 834 configure the uCPE device, while also allowing for data-path
949 the same physical interface.</para> 835 traffic to pass over the same physical interface.</para>
950 836
951 <para>The solution provided by Enea for in-band management is based 837 <para>The solution provided by Enea for in-band management is
952 upon an OpenvSwitch bridge fielding all traffic passing through the 838 based upon an OpenvSwitch bridge fielding all traffic passing
953 WAN physical port. As a prerequisite, the WAN physical port has to 839 through the WAN physical port. Any standard
954 be configured to get its IP through DHCP. Any standard or 840 or DPDK-assigned network interface can be used for the In-Band
955 DPDK-assigned network interface can be used for the In-Band 841 management bridge.</para>
956 management bridge.</para>
957 842
958 <note> 843 <note>
959 <para>The In-Band Management bridge must be recreated each time 844 <para>The In-Band Management bridge must be recreated each time
960 the uCPE Manager IP address is changed.</para> 845 the uCPE Manager IP address is changed.</para>
961 </note> 846 </note>
962 847
963 <para>To create the In-Band Management bridge, the user must set 848 <para>To create the In-Band Management bridge, the user must set
964 values for the following fields:</para> 849 values for the following fields:</para>
965 850
966 <itemizedlist> 851 <itemizedlist>
967 <listitem> 852 <listitem>
968 <para>name: name of the bridge.</para> 853 <para>name: name of the bridge.</para>
969 </listitem> 854 </listitem>
970
971 <listitem>
972 <para>ovs-bridge-type: inbandMgmt</para>
973 </listitem>
974 855
975 <listitem> 856 <listitem>
976 <para>mgmt-address: select IPv4 as the type and fill in the IP 857 <para>ovs-bridge-type: inbandMgmt</para>
977 address of the uCPE Manager.</para> 858 </listitem>
978 </listitem> 859 </itemizedlist>
979 860
980 <listitem> 861 <note>
981 <para>mgmt-port: the NETCONF management port. Enea recommeneds 862 <para>The first VNF instantiated on the uCPE device must be
982 leaving this field unchanged.</para> 863 connected to the In-Band Management bridge and its WAN interface
983 </listitem> 864 must be configured as the DHCP client.</para>
984 </itemizedlist> 865 </note>
866 </section>
985 867
986 <note> 868 <section id="inband_mg_br_vnfs">
987 <para>The first VNF instantiated on the uCPE device must be 869 <title>In-band Management bridge for VNFs</title>
988 connected to the In-Band Management bridge and its WAN interface
989 must be configured as the DHCP client.</para>
990 </note>
991 870
992 <para><emphasis role="bold">In-band Management bridge for 871 <para>If VNF management can be done over a dedicated virtual
993 VNFs</emphasis></para> 872 interface, its possible to extend the networking infrastructure
873 configuration to also access the VNF's management interface over
874 the WAN port.</para>
994 875
995 <para>If VNF management can be done over a dedicated virtual 876 <para>For this setup, three types of traffic will pass over the
996 interface, its possible to extend the networking infrastructure 877 WAN physical interface:</para>
997 configuration to also access the VNF's management interface over the
998 WAN port.</para>
999 878
1000 <para>For this setup, three types of traffic will pass over the WAN 879 <itemizedlist>
1001 physical interface:</para> 880 <listitem>
881 <para>Device management. Part of the device configuration done
882 by the uCPE Manager.</para>
883 </listitem>
1002 884
1003 <itemizedlist> 885 <listitem>
1004 <listitem> 886 <para>VNF(s) management. Enabling or disabling features of a
1005 <para>Device management. Part of the device configuration done 887 VNF. E.g. enabling/disabling the firewall or VPN setup.</para>
1006 by the uCPE Manager.</para> 888 </listitem>
1007 </listitem>
1008 889
1009 <listitem> 890 <listitem>
1010 <para>VNF(s) management. Enabling or disabling features of a 891 <para>Data-path. All other traffic that is not used in the
1011 VNF. E.g. enabling/disabling the firewall or VPN setup.</para> 892 control plane and needs to reach a LAN network.</para>
1012 </listitem> 893 </listitem>
894 </itemizedlist>
1013 895
1014 <listitem> 896 <para>To create a VNF In-Band Management bridge, the user must set
1015 <para>Data-path. All other traffic that is not used in the 897 values for the following fields:</para>
1016 control plane and needs to reach a LAN network.</para>
1017 </listitem>
1018 </itemizedlist>
1019 898
1020 <para>To create a VNF In-Band Management bridge, the user must set 899 <itemizedlist>
1021 values for the following fields:</para> 900 <listitem>
901 <para>name: name of the bridge.</para>
902 </listitem>
1022 903
1023 <itemizedlist> 904 <listitem>
1024 <listitem> 905 <para>ovs-bridge-type: vnfMgmt</para>
1025 <para>name: name of the bridge.</para> 906 </listitem>
1026 </listitem>
1027 907
1028 <listitem> 908 <listitem>
1029 <para>ovs-bridge-type: vnfMgmt</para> 909 <para>vnf-mgmt-address: select IPv4 as the type and fill in
1030 </listitem> 910 the IP address for management network, e.g 10.0.0.1.</para>
911 </listitem>
912 </itemizedlist>
1031 913
1032 <listitem> 914 <note>
1033 <para>vnf-mgmt-address: select IPv4 as the type and fill in the 915 <para>VNF management interfaces must be configured in same
1034 IP address for management network, e.g 10.0.0.1.</para> 916 network as the <literal>vnf-mgmt-address</literal> of the
1035 </listitem> 917 bridge. For more information, please see 4.4 <link
1036 </itemizedlist> 918 linkend="vnf_management">VNF Management</link>.</para>
919 </note>
920 </section>
1037 921
1038 <note> 922 <section id="dataplane_bridge">
1039 <para>VNF management interfaces must be configured in same network 923 <title>Data-plane Bridge</title>
1040 as the <literal>vnf-mgmt-address</literal> of the bridge. For more
1041 information, please see 4.4 <link linkend="vnf_management">VNF
1042 Management</link>.</para>
1043 </note>
1044 924
1045 <para><emphasis role="bold">Data-plane Bridge</emphasis> Data-plane 925 <para>Data-plane bridges are generic bridges used for the VNF
1046 bridges are generic bridges used for the VNF data-plane. There are 926 data-plane. There are two supported sub-types:</para>
1047 two supported sub-types:</para>
1048 927
1049 <itemizedlist> 928 <itemizedlist>
1050 <listitem> 929 <listitem>
1051 <para>communication: allows for VNF communication towards 930 <para>communication: allows for VNF communication towards
1052 LAN/WAN networks. This bridge type has at least one physical 931 LAN/WAN networks. This bridge type has at least one physical
1053 port attached to it.</para> 932 port attached to it.</para>
1054 </listitem> 933 </listitem>
1055 934
1056 <listitem> 935 <listitem>
1057 <para>integration: allows for VNF-to-VNF communication (usually 936 <para>integration: allows for VNF-to-VNF communication
1058 for service function chaining). This bridge type does not have 937 (usually for service function chaining). This bridge type does
1059 any physical port attached.</para> 938 not have any physical port attached.</para>
1060 </listitem> 939 </listitem>
1061 </itemizedlist> 940 </itemizedlist>
1062 941
1063 <para>To create a Data-plane bridge, the user must set values for 942 <para>To create a Data-plane bridge, the user must set values for
1064 the following fields:</para> 943 the following fields:</para>
1065 944
1066 <itemizedlist> 945 <itemizedlist>
1067 <listitem> 946 <listitem>
1068 <para>name: name of the bridge.</para> 947 <para>name: name of the bridge.</para>
1069 </listitem> 948 </listitem>
1070 949
1071 <listitem> 950 <listitem>
1072 <para>ovs-bridge-type: select <literal>communication</literal> 951 <para>ovs-bridge-type: select <literal>communication</literal>
1073 or <literal>integration</literal>, depending on intended usage. 952 or <literal>integration</literal>, depending on intended
1074 For communication bridges, physical interfaces can be added to 953 usage. For communication bridges, physical interfaces can be
1075 the bridge.</para> 954 added to the bridge.</para>
1076 </listitem> 955 </listitem>
1077 </itemizedlist> 956 </itemizedlist>
957 </section>
1078 </section> 958 </section>
1079 </section> 959 </section>
1080 960
@@ -1138,7 +1018,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1138 </listitem> 1018 </listitem>
1139 1019
1140 <listitem> 1020 <listitem>
1141 <para>Device Grouping Tags: a tag to group devices.</para> 1021 <para>Device Grouping Tags: a tag to group devices. These tags match
1022 the customer tags provided during the installation of the device.</para>
1142 </listitem> 1023 </listitem>
1143 </itemizedlist> 1024 </itemizedlist>
1144 1025
@@ -1413,9 +1294,10 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1413 1294
1414 <listitem> 1295 <listitem>
1415 <para>Click on <literal>Choose File</literal> to provide the path 1296 <para>Click on <literal>Choose File</literal> to provide the path
1416 to the image file (must be of type <literal>rootfs.ostree.tar.bz2</literal>). 1297 to the image file (must be of type
1417 Select the target hardware platform corresponding to the image 1298 <literal>rootfs.ostree.tar.bz2</literal>). Select the target
1418 being uploaded (xeon-d or atomc-3000).</para> 1299 hardware platform corresponding to the image being uploaded
1300 (xeon-d or atomc-3000).</para>
1419 </listitem> 1301 </listitem>
1420 1302
1421 <listitem> 1303 <listitem>
@@ -1481,7 +1363,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1481 minute for when to run the upgrade.</para> 1363 minute for when to run the upgrade.</para>
1482 1364
1483 <note> 1365 <note>
1484 <para>The hour represents the local uCPE Manager server hour.</para> 1366 <para>The hour represents the local uCPE Manager server
1367 hour.</para>
1485 </note> 1368 </note>
1486 </listitem> 1369 </listitem>
1487 1370
@@ -1888,8 +1771,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1888 Manager.</para> 1771 Manager.</para>
1889 1772
1890 <note> 1773 <note>
1891 <para>CAUTION: The user MUST conserve the same order for the 1774 <para>CAUTION: The user MUST conserve the same order for the virtual
1892 virtual interfaces during both onboarding and instantiation phases.</para> 1775 interfaces during both onboarding and instantiation phases.</para>
1893 </note> 1776 </note>
1894 1777
1895 <para><emphasis role="bold">Cloud Init Tab</emphasis></para> 1778 <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
@@ -2046,7 +1929,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
2046 </listitem> 1929 </listitem>
2047 1930
2048 <listitem> 1931 <listitem>
2049 <para>uCPE Device: the uCPE device to instantiate the VNF on.</para> 1932 <para>uCPE Device: the uCPE device to instantiate the VNF
1933 on.</para>
2050 </listitem> 1934 </listitem>
2051 1935
2052 <listitem> 1936 <listitem>
@@ -2125,4 +2009,4 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
2125 </orderedlist> 2009 </orderedlist>
2126 </section> 2010 </section>
2127 </section> 2011 </section>
2128</chapter> 2012</chapter> \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-07 12:28:41 +0000