summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2020-03-23 21:57:46 +0100
committermrpa <miruna.paun@enea.com>2020-03-23 22:05:01 +0100
commit91121f6abcf3d0f4fa6424b990ded435ffc0e7d2 (patch)
tree046e2d6e840f62eebc39217b37bf2a2788f360c9
parent19fbb2919462c3f62e370dbf6af9ccab590e3bd0 (diff)
downloadel_releases-nfv-access-91121f6abcf3d0f4fa6424b990ded435ffc0e7d2.tar.gz
Interfaces configuration from uCPE Manager_V1 changes
have been added to the manual. Change-Id: Id85ccff847e5324371369db3d728a50cd60254c1 Signed-off-by: mrpa <miruna.paun@enea.com>
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml272
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/changing_ips.pngbin0 -> 23051 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/edit_inter.pngbin0 -> 9000 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.pngbin0 -> 13067 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.pngbin0 -> 12751 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.pngbin0 -> 14815 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.pngbin0 -> 11815 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/setting_static.pngbin0 -> 14815 bytes
8 files changed, 228 insertions, 44 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 609da64..4651698 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
@@ -93,29 +93,41 @@
93 <orderedlist> 93 <orderedlist>
94 <listitem> 94 <listitem>
95 <para>Install Java:</para> 95 <para>Install Java:</para>
96 96
97 <orderedlist> 97 <orderedlist>
98 <listitem><para>Install OpenJDK 11:</para> 98 <listitem>
99 <programlisting>sudo yum install java-11-openjdk-devel</programlisting> 99 <para>Install OpenJDK 11:</para>
100 </listitem> 100
101 <listitem><para>Verify the installation:</para> 101 <programlisting>sudo yum install java-11-openjdk-devel</programlisting>
102<programlisting>java -version 102 </listitem>
103
104 <listitem>
105 <para>Verify the installation:</para>
106
107 <programlisting>java -version
103 108
104openjdk version "11.0.3" 2019-04-16 LTS 109openjdk version "11.0.3" 2019-04-16 LTS
105OpenJDK Runtime Environment 18.9 (build 11.0.3+7-LTS) 110OpenJDK Runtime Environment 18.9 (build 11.0.3+7-LTS)
106OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting></listitem> 111OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting>
107 112 </listitem>
108 <listitem><para>The following system variables need to point to the OpenJDK 11 installation:</para> 113
109<programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac))))) 114 <listitem>
115 <para>The following system variables need to point to the
116 OpenJDK 11 installation:</para>
117
118 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac)))))
110export PATH=$PATH:$JAVA_HOME/bin 119export PATH=$PATH:$JAVA_HOME/bin
111export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar 120export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
112</programlisting> 121</programlisting>
113 </listitem> 122 </listitem>
114 </orderedlist> 123 </orderedlist>
115 124
116 <note><para>If there are multiple java versions installed, switch between them using the 125 <note>
117 following command:</para> 126 <para>If there are multiple java versions installed, switch
118 <programlisting>alternatives --config java</programlisting></note> 127 between them using the following command:</para>
128
129 <programlisting>alternatives --config java</programlisting>
130 </note>
119 </listitem> 131 </listitem>
120 132
121 <listitem> 133 <listitem>
@@ -629,6 +641,177 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
629 <section id="configure_interfaces"> 641 <section id="configure_interfaces">
630 <title>Configuring Interfaces</title> 642 <title>Configuring Interfaces</title>
631 643
644 <para>After networking interfaces have been added to the uCPE
645 Manager, the user can change the interface type (DPDK, SR-IOV,
646 Standard) and the address assignment of the network interfaces
647 (DHCP, Static).</para>
648
649 <para><emphasis role="bold">How to Edit the Configuration of an
650 Interface</emphasis></para>
651
652 <orderedlist>
653 <listitem>
654 <figure>
655 <title>Configuration of External Interfaces</title>
656
657 <mediaobject>
658 <imageobject>
659 <imagedata align="center" contentwidth="500"
660 fileref="images/edit_inter_config.png" />
661 </imageobject>
662 </mediaobject>
663 </figure>
664
665 <para>To edit an interface configuration type from the uCPE
666 Manager, select the uCPE device, then from the top toolbar
667 select the <literal>Configuration</literal> menu then
668 <literal>External Interfaces -&gt; Configuration</literal>. The
669 already configured interfaces are displayed here, as can be seen
670 in the figure above.</para>
671 </listitem>
672
673 <listitem>
674 <para>In order to edit an already configured interface, double
675 click on the desired one and a popup will appear as shown in the
676 figure below. From the Host Interface window, a user can change
677 the networking type and the IP address assignment:</para>
678
679 <figure>
680 <title>Editing an Interface</title>
681
682 <mediaobject>
683 <imageobject>
684 <imagedata align="center" contentwidth="500"
685 fileref="images/edit_inter.png" />
686 </imageobject>
687 </mediaobject>
688 </figure>
689 </listitem>
690 </orderedlist>
691
692 <para><emphasis role="bold">Set the IP address assignment of the
693 Management Interface to static</emphasis></para>
694
695 <orderedlist>
696 <listitem>
697 <para>To change an interface type from the uCPE Manager, select
698 the uCPE device, then from the top toolbar select
699 <literal>Configuration</literal> and then <literal>External
700 Interfaces -&gt; Configuration</literal>. The already configured
701 interfaces are displayed here.</para>
702 </listitem>
703
704 <listitem>
705 <para>From the interfaces' list, edit the interface which has
706 the "Management" flag set to "true", by double clicking on it,
707 triggering a popup window:</para>
708
709 <figure>
710 <title>Editing the Management Interface</title>
711
712 <mediaobject>
713 <imageobject>
714 <imagedata align="center" contentwidth="500"
715 fileref="images/edit_mg_inter.png" />
716 </imageobject>
717 </mediaobject>
718 </figure>
719 </listitem>
720
721 <listitem>
722 <para>From the Host Interface window, change the <literal>IP
723 address-assignment</literal> to "static". After the address
724 assignment is set, the user needs to set the <literal>IP
725 address</literal>, <literal>netmask</literal> and the
726 <literal>gateway</literal> of the interface. The user can use
727 the dropdown list to set the type of the IP version:
728 <literal>IPv4</literal> or <literal>IPv6</literal>
729 address:</para>
730
731 <figure>
732 <title>Setting the IP version</title>
733
734 <mediaobject>
735 <imageobject>
736 <imagedata align="center" contentwidth="500"
737 fileref="images/setting_ip_version.png" />
738 </imageobject>
739 </mediaobject>
740 </figure>
741 </listitem>
742 </orderedlist>
743
744 <para><emphasis role="bold">Set the IP address assignment of the
745 Management Interface to DHCP</emphasis></para>
746
747 <orderedlist>
748 <listitem>
749 <para>To change an interface type from the uCPE Manager, select
750 the uCPE device, then from the top toolbar select
751 <literal>Configuration</literal> and then <literal>External
752 Interfaces -&gt; Configuration</literal>. The already configured
753 interfaces are displayed here.</para>
754 </listitem>
755
756 <listitem>
757 <para>From the interfaces' list, edit the interface which has
758 the "Management" flag set to "true", by double clicking on it,
759 triggering a popup window. Within the Host Interface window
760 change the <literal>IP address assignment</literal> to
761 "dhcp".</para>
762
763 <figure>
764 <title>Editing the Management Interface to DHCP</title>
765
766 <mediaobject>
767 <imageobject>
768 <imagedata align="center" contentwidth="500"
769 fileref="images/setting_ip_version_dhcp.png" />
770 </imageobject>
771 </mediaobject>
772 </figure>
773 </listitem>
774 </orderedlist>
775
776 <para><emphasis role="bold">Changing the static IP of the Management
777 Interface</emphasis></para>
778
779 <orderedlist>
780 <listitem>
781 <para>To change an interface type from the uCPE Manager, select
782 the uCPE device, then from the top toolbar select
783 <literal>Configuration</literal> and then <literal>External
784 Interfaces -&gt; Configuration</literal>. The already configured
785 interfaces are displayed here.</para>
786 </listitem>
787
788 <listitem>
789 <para>From the interfaces' list, edit the interface which has
790 the "Management" flag set to "true", by double clicking on it,
791 triggering a popup window. Within the Host Interface window
792 change the "static" <literal>IP address</literal> as well as the
793 <literal>netmask</literal> and the
794 <literal>gateway</literal>.</para>
795
796 <figure>
797 <title>Changing the Static, Netmask and Gateway IPs</title>
798
799 <mediaobject>
800 <imageobject>
801 <imagedata align="center" contentwidth="500"
802 fileref="images/changing_ips.png" />
803 </imageobject>
804 </mediaobject>
805 </figure>
806
807 <note>
808 <para>The user can use the dropdown list to set the type of
809 the IP version: <literal>IPv4</literal> or
810 <literal>IPv6</literal> address.</para>
811 </note>
812 </listitem>
813 </orderedlist>
814
632 <para>In order to make physical network interfaces available to the 815 <para>In order to make physical network interfaces available to the
633 virtualization infrastructure and VNFs, they must be configured into 816 virtualization infrastructure and VNFs, they must be configured into
634 the management system.</para> 817 the management system.</para>
@@ -963,28 +1146,29 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
963 device, to be wiped out. Selecting <literal>Replace</literal> will 1146 device, to be wiped out. Selecting <literal>Replace</literal> will
964 set the entire device configuration to match values in the offline 1147 set the entire device configuration to match values in the offline
965 configuration.</para> 1148 configuration.</para>
966 1149
967 <para>When a device connects to the uCPE Manager for the first time, it checks the 1150 <para>When a device connects to the uCPE Manager for the first time,
968 device to see if it has been Zero Touch Provisioned (ZTP). If not, it looks for 1151 it checks the device to see if it has been Zero Touch Provisioned
969 an offline configuration that matches these values, in the following order:</para> 1152 (ZTP). If not, it looks for an offline configuration that matches
970 1153 these values, in the following order:</para>
971 <itemizedlist> 1154
972 <listitem> 1155 <itemizedlist>
973 <para>The Device ID.</para> 1156 <listitem>
974 </listitem> 1157 <para>The Device ID.</para>
975 1158 </listitem>
976 <listitem> 1159
977 <para>The set of tags.</para> 1160 <listitem>
978 </listitem> 1161 <para>The set of tags.</para>
979 1162 </listitem>
980 <listitem> 1163
981 <para>A "*" for Device ID (wildcard).</para> 1164 <listitem>
982 </listitem> 1165 <para>A "*" for Device ID (wildcard).</para>
983 </itemizedlist> 1166 </listitem>
984 1167 </itemizedlist>
985 <para>If a match is found, the offline configuration is sent to the device as part 1168
986 of Zero-Touch-Provisioning.</para> 1169 <para>If a match is found, the offline configuration is sent to the
987 1170 device as part of Zero-Touch-Provisioning.</para>
1171
988 <para>After creating the Offline Config Store, access the device 1172 <para>After creating the Offline Config Store, access the device
989 through <literal>Applications</literal> -&gt; <literal>offline 1173 through <literal>Applications</literal> -&gt; <literal>offline
990 config</literal> -&gt; <literal>Config App</literal> and provision 1174 config</literal> -&gt; <literal>Config App</literal> and provision
@@ -1744,11 +1928,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1744 <literal>Path</literal>. When a user uses the uCPE Manager to 1928 <literal>Path</literal>. When a user uses the uCPE Manager to
1745 create an instance for multiple VNFs, they will be prompted to 1929 create an instance for multiple VNFs, they will be prompted to
1746 provide a data file for each entry in this table. Each type of VNF 1930 provide a data file for each entry in this table. Each type of VNF
1747 will require different cloud-init files, e.g.: a license 1931 will require different cloud-init files, e.g.: a license file. The
1748 file. The data files will be added to the cloud-init image that the user 1932 data files will be added to the cloud-init image that the user
1749 provides at the instantiation of the VNF. If the cloud-init image is not 1933 provides at the instantiation of the VNF. If the cloud-init image
1750 provided, no Cloud-Init Data Source will be created for that VNF 1934 is not provided, no Cloud-Init Data Source will be created for
1751 and there will be no warning.</para> 1935 that VNF and there will be no warning.</para>
1752 </listitem> 1936 </listitem>
1753 </orderedlist> 1937 </orderedlist>
1754 1938
@@ -1913,4 +2097,4 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1913 </orderedlist> 2097 </orderedlist>
1914 </section> 2098 </section>
1915 </section> 2099 </section>
1916</chapter> 2100</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/changing_ips.png b/doc/book-enea-nfv-access-getting-started/doc/images/changing_ips.png
new file mode 100755
index 0000000..504fe13
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/changing_ips.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png
new file mode 100755
index 0000000..fddde37
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png
new file mode 100755
index 0000000..211984c
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.png
new file mode 100755
index 0000000..70fd050
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.png b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.png
new file mode 100755
index 0000000..97eb19c
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.png b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.png
new file mode 100755
index 0000000..ab4ad6f
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/setting_static.png b/doc/book-enea-nfv-access-getting-started/doc/images/setting_static.png
new file mode 100755
index 0000000..97eb19c
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/setting_static.png
Binary files differ