summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <mrpa@enea.se>2020-04-17 04:01:46 +0200
committerGerrit Code Review <gerrit2@sestogerrit02>2020-04-17 04:01:46 +0200
commitadd42b9bd9bd4525fa65a8afbb08ed25977e42c5 (patch)
treeb967ea17915ddb0070677769d6bb596942c6d987
parent5bb6dea2fe92a3797e9ae21b40eb5eef27592dd2 (diff)
parent7b4b3aa65052b4459d6b35549b06351c55f47062 (diff)
downloadel_releases-nfv-access-add42b9bd9bd4525fa65a8afbb08ed25977e42c5.tar.gz
Merge "doc: getting-started - updates" into rocko
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml43
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml8
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml103
3 files changed, 56 insertions, 98 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
index 160190f..afcdec6 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
@@ -346,33 +346,11 @@ node0.1048576kB = 3 </programlisting>
346 </listitem> 346 </listitem>
347 </itemizedlist> 347 </itemizedlist>
348 348
349 <para>Optional parameters for sending status notifications to a
350 server. All three must be provided if used:</para>
351
352 <itemizedlist>
353 <listitem>
354 <para><literal>notify_user</literal>. Server SSH username.</para>
355 </listitem>
356
357 <listitem>
358 <para><literal>notify_pass</literal>. Server SSH password.</para>
359 </listitem>
360
361 <listitem>
362 <para><literal>notify_path</literal>. Location where notification
363 files will be placed, specified in <literal>Server
364 IP:directory</literal> format.</para>
365 </listitem>
366 </itemizedlist>
367
368 <para>Installation Configuration File Example:</para> 349 <para>Installation Configuration File Example:</para>
369 350
370 <programlisting> 351 <programlisting>
371 image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz 352 image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz
372 install_drive = /dev/sda 353 install_drive = /dev/sda
373 notify_user = username
374 notify_pass = password
375 notify_path = 192.168.1.100:/home/user/status_notifications
376 354
377</programlisting> 355</programlisting>
378 </section> 356 </section>
@@ -415,27 +393,6 @@ node0.1048576kB = 3 </programlisting>
415 <para>The uCPE devices should be configured in BIOS to boot from the 393 <para>The uCPE devices should be configured in BIOS to boot from the
416 installation drive first in order to automatically start the Enea NFV 394 installation drive first in order to automatically start the Enea NFV
417 Access Run Time Platform when the installation is finished.</para> 395 Access Run Time Platform when the installation is finished.</para>
418
419 <section>
420 <title>Server Notifications</title>
421
422 <para>Optionally, the uCPE devices can send a notification file to a
423 server once the installation is complete and Enea NFV Access Run Time
424 Platform has successfully booted. Notifications are enabled by
425 providing the <literal>notify_*</literal> parameters in the
426 installation configuration file.</para>
427
428 <para>Each uCPE device will push a file to the server location
429 specified in the installation configuration file. The file name will
430 be the MAC address of the PXE boot network interface in order to
431 uniquely identify the device.</para>
432
433 <note>
434 <para>Note that the status notification will only be sent on the
435 first boot after installation is done, subsequent reboots of the
436 uCPE device will not cause any new notifications to be sent.</para>
437 </note>
438 </section>
439 </section> 396 </section>
440 </section> 397 </section>
441</chapter> 398</chapter>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
index 796c386..bb488a1 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
@@ -256,7 +256,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
256 256
257 <listitem> 257 <listitem>
258 <para>Once the USB stick is properly booted, the Web-installer application starts 258 <para>Once the USB stick is properly booted, the Web-installer application starts
259 automatically and can be accessed in a web browser at <literal>http://192.168.1.1</literal> (port 80). 259 automatically and can be accessed in a web browser at <literal>http://172.16.1.1</literal> (port 80).
260 </para> 260 </para>
261 261
262 <para>On the first page of the Web-installer, the user should fill in:</para> 262 <para>On the first page of the Web-installer, the user should fill in:</para>
@@ -332,12 +332,12 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
332 <note> 332 <note>
333 <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at 333 <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at
334 start-up expecting the user to provide the post-installation configuration. The Web-installer will 334 start-up expecting the user to provide the post-installation configuration. The Web-installer will
335 be launched on port 82 for post-installation configuration: <literal> 335 be launched on port 80 for post-installation configuration: <literal>
336 http://192.168.1.1:82</literal>.</para> 336 http://172.168.1.1</literal>.</para>
337 </note> 337 </note>
338 338
339 <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot 339 <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot
340 the device and then access the Web-installer on <literal>http://192.168.1.1:82</literal>. 340 the device and then access the Web-installer on <literal>http://172.16.1.1</literal>.
341 </para> 341 </para>
342 342
343 <note> 343 <note>
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 733f61e..1940eb1 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
@@ -546,7 +546,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
546 546
547 <itemizedlist> 547 <itemizedlist>
548 <listitem> 548 <listitem>
549 <para>IP Address. IP address of the ucPE device.</para> 549 <para>IP Address. IP address of the uCPE device.</para>
550 </listitem> 550 </listitem>
551 </itemizedlist> 551 </itemizedlist>
552 552
@@ -580,10 +580,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
580 580
581 <itemizedlist> 581 <itemizedlist>
582 <listitem> 582 <listitem>
583 <para>Device ID. The unique identifier of the uCPE device. This 583 <para>Device ID. The unique identifier of the uCPE device.</para>
584 links a device to its Day-0 configuration (stored in the offline
585 configuration system). It is a required field if you want to
586 perform Zero-Touch Provisioning.</para>
587 </listitem> 584 </listitem>
588 </itemizedlist> 585 </itemizedlist>
589 </section> 586 </section>
@@ -593,12 +590,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
593 590
594 <para>Follow the same steps as described in the previous section, 591 <para>Follow the same steps as described in the previous section,
595 making sure that the <literal>Device Calls Home</literal> checkbox is 592 making sure that the <literal>Device Calls Home</literal> checkbox is
596 selected this time.</para> 593 selected this time. The <literal>IP Address</literal> of the uCPE device
594 is not required.</para>
597 595
598 <para>When using this mechanism, the device will initiate a connection 596 <para>When using this mechanism, the device will initiate a connection
599 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE 597 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
600 Manager waits for a device connection. Make sure the uCPE Manager IP 598 Manager waits for a device connection. For more information please
601 address has been configured on the device. For more information please
602 see section <link linkend="install_ena_stick">Installing Enea NFV 599 see section <link linkend="install_ena_stick">Installing Enea NFV
603 Access</link> for more details.</para> 600 Access</link> for more details.</para>
604 </section> 601 </section>
@@ -612,22 +609,6 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
612 networking infrastructure can be configured either manually or by using 609 networking infrastructure can be configured either manually or by using
613 Zero Touch Provisioning.</para> 610 Zero Touch Provisioning.</para>
614 611
615 <para>The uCPE Manager can list network interfaces found on a device by
616 selecting the uCPE device first and then selecting
617 <literal>Configuration</literal> -&gt; <literal>OpenVSwitch
618 </literal>-&gt; <literal>Host Interface Caps</literal>:</para>
619
620 <figure>
621 <title>Host Interface Caps</title>
622
623 <mediaobject>
624 <imageobject>
625 <imagedata align="center" contentwidth="600"
626 fileref="images/host_interface_caps.png" />
627 </imageobject>
628 </mediaobject>
629 </figure>
630
631 <para>Available network interfaces can be added to the management 612 <para>Available network interfaces can be added to the management
632 system, for use by the networking virtualization infrastructure.</para> 613 system, for use by the networking virtualization infrastructure.</para>
633 614
@@ -636,17 +617,15 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
636 617
637 <para>For Manual Configuration of uCPE networking, select the uCPE 618 <para>For Manual Configuration of uCPE networking, select the uCPE
638 device first and then <literal>Configuration</literal> -&gt; 619 device first and then <literal>Configuration</literal> -&gt;
639 <literal>OpenVSwitch</literal>. In <literal>Host Interfaces 620 <literal>External Interfaces</literal>, where one can find a list of
640 Caps</literal>, one can find a list of available network interfaces 621 available network interfaces and their capabilities.</para>
641 and their capabilities.</para>
642 622
643 <section id="configure_interfaces"> 623 <section id="configure_interfaces">
644 <title>Configuring Interfaces</title> 624 <title>Configuring Interfaces</title>
645 625
646 <para>After networking interfaces have been added to the uCPE 626 <para>After networking interfaces have been added to the uCPE
647 Manager, the user can change the interface type (DPDK, SR-IOV, 627 Manager, the user can change the interface type (DPDK, SR-IOV,
648 Standard) and the address assignment of the network interfaces 628 Standard, wan).</para>
649 (DHCP, Static).</para>
650 629
651 <para><emphasis role="bold">How to Edit the Configuration of an 630 <para><emphasis role="bold">How to Edit the Configuration of an
652 Interface</emphasis></para> 631 Interface</emphasis></para>
@@ -860,13 +839,6 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
860 </listitem> 839 </listitem>
861 </itemizedlist> 840 </itemizedlist>
862 841
863 <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on
864 the device that uses a DPDK interface type, by selecting the uCPE
865 device, then from the top toolbar selecting
866 <literal>Configuration</literal> -&gt;
867 <literal>OpenVSwitch</literal> -&gt; <literal>Bridges</literal>
868 -&gt; <literal>Add</literal>.</para>
869
870 <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para> 842 <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para>
871 843
872 <para>SR-IOV technology allows for the creation of a number of 844 <para>SR-IOV technology allows for the creation of a number of
@@ -1141,13 +1113,34 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1141 1113
1142 <para>To create an offline configuration, from the top toolbar menu 1114 <para>To create an offline configuration, from the top toolbar menu
1143 select <literal>Applications</literal> -&gt; <literal>Offline 1115 select <literal>Applications</literal> -&gt; <literal>Offline
1144 Config</literal> -&gt; <literal>Add</literal>. Specify the value of 1116 Config</literal> -&gt; <literal>Add</literal>. The following fields
1145 the <literal>Device ID</literal> in the required field or wildcard 1117 are available:</para>
1146 if appropriate. Choose <literal>Merge</literal> as the "Default 1118
1147 Upload Method" if you do not want any boot configuration set on the 1119 <itemizedlist>
1148 device, to be wiped out. Selecting <literal>Replace</literal> will 1120 <listitem>
1149 set the entire device configuration to match values in the offline 1121 <para>Name: name of the device.</para>
1150 configuration.</para> 1122 </listitem>
1123
1124 <listitem>
1125 <para>Device type: Enea universal CPE.</para>
1126 </listitem>
1127
1128 <listitem>
1129 <para>Device version: 2.2.2</para>
1130 </listitem>
1131
1132 <listitem>
1133 <para>Config Set: uCPE Config</para>
1134 </listitem>
1135
1136 <listitem>
1137 <para>Device ID: device ID or a wildcard(*).</para>
1138 </listitem>
1139
1140 <listitem>
1141 <para>Device Grouping Tags: a tag to group devices.</para>
1142 </listitem>
1143 </itemizedlist>
1151 1144
1152 <para>When a device connects to the uCPE Manager for the first time, 1145 <para>When a device connects to the uCPE Manager for the first time,
1153 it checks the device to see if it has been Zero Touch Provisioned 1146 it checks the device to see if it has been Zero Touch Provisioned
@@ -1420,9 +1413,9 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1420 1413
1421 <listitem> 1414 <listitem>
1422 <para>Click on <literal>Choose File</literal> to provide the path 1415 <para>Click on <literal>Choose File</literal> to provide the path
1423 to the image file. Select the target hardware platform 1416 to the image file (must be of type <literal>rootfs.ostree.tar.bz2</literal>).
1424 corresponding to the image being uploaded (xeon-d or 1417 Select the target hardware platform corresponding to the image
1425 atomc-3000).</para> 1418 being uploaded (xeon-d or atomc-3000).</para>
1426 </listitem> 1419 </listitem>
1427 1420
1428 <listitem> 1421 <listitem>
@@ -1488,8 +1481,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1488 minute for when to run the upgrade.</para> 1481 minute for when to run the upgrade.</para>
1489 1482
1490 <note> 1483 <note>
1491 <para>The time zone is set to Eastern Standard Time 1484 <para>The hour represents the local uCPE Manager server hour.</para>
1492 (EST). The hour represents the local uCPE Manager server hour.</para>
1493 </note> 1485 </note>
1494 </listitem> 1486 </listitem>
1495 1487
@@ -1895,6 +1887,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
1895 name, and optionally a description, used only by the uCPE 1887 name, and optionally a description, used only by the uCPE
1896 Manager.</para> 1888 Manager.</para>
1897 1889
1890 <note>
1891 <para>CAUTION: The user MUST conserve the same order for the
1892 virtual interfaces during both onboarding and instantiation phases.</para>
1893 </note>
1894
1898 <para><emphasis role="bold">Cloud Init Tab</emphasis></para> 1895 <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
1899 1896
1900 <para>Click the <literal>Clout Init</literal> tab to provide the 1897 <para>Click the <literal>Clout Init</literal> tab to provide the
@@ -2045,7 +2042,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
2045 </listitem> 2042 </listitem>
2046 2043
2047 <listitem> 2044 <listitem>
2048 <para>Device: the uCPE device to instantiate the VNF on.</para> 2045 <para>VNF Type: a list of onboarded VNFs.</para>
2046 </listitem>
2047
2048 <listitem>
2049 <para>uCPE Device: the uCPE device to instantiate the VNF on.</para>
2049 </listitem> 2050 </listitem>
2050 2051
2051 <listitem> 2052 <listitem>
@@ -2101,8 +2102,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
2101 <orderedlist> 2102 <orderedlist>
2102 <listitem> 2103 <listitem>
2103 <para>SSH to the uCPE device from the Enea uCPE Manager 2104 <para>SSH to the uCPE device from the Enea uCPE Manager
2104 (<literal>Device-&gt;SSH</literal>) with default user and password: 2105 (<literal>Device-&gt;SSH</literal>) using user:
2105 <literal>root</literal>.</para> 2106 <literal>root</literal> and no password.</para>
2106 </listitem> 2107 </listitem>
2107 2108
2108 <listitem> 2109 <listitem>