diff options
5 files changed, 156 insertions, 17 deletions
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml index 50a90b0..2805d4f 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml | |||
| @@ -22,7 +22,7 @@ | |||
| 22 | </note> | 22 | </note> |
| 23 | 23 | ||
| 24 | <para>The following will detail CPU, RAM and storage requirements for | 24 | <para>The following will detail CPU, RAM and storage requirements for |
| 25 | the Enea Edge Management.</para> | 25 | the Enea Edge Management Application.</para> |
| 26 | 26 | ||
| 27 | <itemizedlist> | 27 | <itemizedlist> |
| 28 | <listitem> | 28 | <listitem> |
| @@ -81,7 +81,7 @@ | |||
| 81 | </itemizedlist> | 81 | </itemizedlist> |
| 82 | 82 | ||
| 83 | <para>The purpose of the CentOS 7 server is to host the Enea Edge | 83 | <para>The purpose of the CentOS 7 server is to host the Enea Edge |
| 84 | Management. Network access between the CentOS 7 server and the uCPE | 84 | Management Application. Network access between the CentOS 7 server and the uCPE |
| 85 | devices is required. The Enea Edge Management and the uCPE devices | 85 | devices is required. The Enea Edge Management and the uCPE devices |
| 86 | will be connected on separate subnets to avoid inconsistencies.</para> | 86 | will be connected on separate subnets to avoid inconsistencies.</para> |
| 87 | </listitem> | 87 | </listitem> |
| @@ -1134,10 +1134,11 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 1134 | <section id="ucpe_monitor"> | 1134 | <section id="ucpe_monitor"> |
| 1135 | <title>uCPE Device Monitorization and Control</title> | 1135 | <title>uCPE Device Monitorization and Control</title> |
| 1136 | 1136 | ||
| 1137 | <para>Once the uCPE device is connected to the Enea Edge Management, it is | 1137 | <para>Once the uCPE device is connected to the Enea Edge Management |
| 1138 | ready for central management. Two important functions available in the | 1138 | application, it is ready for central management. Two important functions |
| 1139 | Enea Edge Management GUI are alarm checking and resource | 1139 | available in the Enea uCPE Management GUI are alarm checking and resource |
| 1140 | allocation.</para> | 1140 | allocation. Additionally, the device can be rebooted, the factory settings |
| 1141 | can be restored or simply the vCPE service can be restarted.</para> | ||
| 1141 | 1142 | ||
| 1142 | <section id="check_alarms"> | 1143 | <section id="check_alarms"> |
| 1143 | <title>Checking Alarms</title> | 1144 | <title>Checking Alarms</title> |
| @@ -1167,6 +1168,41 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 1167 | uCPE device once instantiated.</para> | 1168 | uCPE device once instantiated.</para> |
| 1168 | </section> | 1169 | </section> |
| 1169 | 1170 | ||
| 1171 | <section id="basic_oper_device"> | ||
| 1172 | <title>Basic operations for uCPE device Managememt</title> | ||
| 1173 | |||
| 1174 | <para>When the uCPE device is connected to the Enea Edge Management application, it can | ||
| 1175 | be rebooted, the factory settings can be restored or simply the vCPE | ||
| 1176 | service can be restarted.</para> | ||
| 1177 | |||
| 1178 | <para>Select the uCPE device and go to the <emphasis | ||
| 1179 | role="bold">Operations</emphasis> menu, where the following options are available:</para> | ||
| 1180 | |||
| 1181 | <itemizedlist> | ||
| 1182 | <listitem> | ||
| 1183 | <para><emphasis role="bold">Reboot</emphasis>. Reboots the device. Settings will be preserved.</para> | ||
| 1184 | </listitem> | ||
| 1185 | |||
| 1186 | <listitem> | ||
| 1187 | <para><emphasis role="bold">Factory reset</emphasis>. Resets the device to its | ||
| 1188 | default factory settings. All current configuration settings are lost. All | ||
| 1189 | running VNFs are destroyed. Any installed custom scripts will be removed and | ||
| 1190 | they will need to be reinstalled.</para> | ||
| 1191 | |||
| 1192 | <para>Only the vCPE service will be restarted, the device will not | ||
| 1193 | be rebooted. No reboot is needed.</para> | ||
| 1194 | |||
| 1195 | <para>Once the vCPE service restart completes, appropriate day-0 | ||
| 1196 | provisioning will take place.</para> | ||
| 1197 | </listitem> | ||
| 1198 | |||
| 1199 | <listitem> | ||
| 1200 | <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the | ||
| 1201 | vCPE service on the device. The device will not be rebooted.</para> | ||
| 1202 | </listitem> | ||
| 1203 | </itemizedlist> | ||
| 1204 | </section> | ||
| 1205 | |||
| 1170 | <section id="access_device_cli"> | 1206 | <section id="access_device_cli"> |
| 1171 | <title>Accessing the uCPE device CLI</title> | 1207 | <title>Accessing the uCPE device CLI</title> |
| 1172 | 1208 | ||
diff --git a/doc/book-enea-edge-getting-started/doc/introduction.xml b/doc/book-enea-edge-getting-started/doc/introduction.xml index 8186ff1..5786883 100644 --- a/doc/book-enea-edge-getting-started/doc/introduction.xml +++ b/doc/book-enea-edge-getting-started/doc/introduction.xml | |||
| @@ -257,6 +257,12 @@ | |||
| 257 | 257 | ||
| 258 | <entry>Virtual Network Function.</entry> | 258 | <entry>Virtual Network Function.</entry> |
| 259 | </row> | 259 | </row> |
| 260 | |||
| 261 | <row> | ||
| 262 | <entry>vCPE</entry> | ||
| 263 | |||
| 264 | <entry>Virtual Customer Premises Equipment.</entry> | ||
| 265 | </row> | ||
| 260 | </tbody> | 266 | </tbody> |
| 261 | </tgroup> | 267 | </tgroup> |
| 262 | </table> | 268 | </table> |
diff --git a/doc/book-enea-edge-getting-started/doc/net_config_options.xml b/doc/book-enea-edge-getting-started/doc/net_config_options.xml index dae5b36..344b79b 100644 --- a/doc/book-enea-edge-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-edge-getting-started/doc/net_config_options.xml | |||
| @@ -722,7 +722,8 @@ | |||
| 722 | <section id="remove_scripts"> | 722 | <section id="remove_scripts"> |
| 723 | <title>Removing Scripts</title> | 723 | <title>Removing Scripts</title> |
| 724 | 724 | ||
| 725 | <para>Follow the instruction below to remove scripts:</para> | 725 | <para>Follow the instruction below to remove scripts from the Enea Edge |
| 726 | Management application:</para> | ||
| 726 | 727 | ||
| 727 | <orderedlist> | 728 | <orderedlist> |
| 728 | <listitem> | 729 | <listitem> |
| @@ -744,7 +745,7 @@ | |||
| 744 | <title>Configuring Script Location</title> | 745 | <title>Configuring Script Location</title> |
| 745 | 746 | ||
| 746 | <para>The location where the scripts are staged in the Enea Edge | 747 | <para>The location where the scripts are staged in the Enea Edge |
| 747 | Management can be chanaged as described below:</para> | 748 | Management application can be changed as described below:</para> |
| 748 | 749 | ||
| 749 | <orderedlist> | 750 | <orderedlist> |
| 750 | <listitem> | 751 | <listitem> |
| @@ -814,9 +815,32 @@ | |||
| 814 | </listitem> | 815 | </listitem> |
| 815 | </orderedlist> | 816 | </orderedlist> |
| 816 | </section> | 817 | </section> |
| 818 | |||
| 819 | <section id="remove_script_device"> | ||
| 820 | <title>Removing Scripts from a uCPE Device</title> | ||
| 821 | |||
| 822 | <para>Follow the instructions below to remove scripts from a uCPE | ||
| 823 | Device:</para> | ||
| 824 | |||
| 825 | <orderedlist> | ||
| 826 | <listitem> | ||
| 827 | <para>Access the <emphasis role="bold">Operations</emphasis> menu | ||
| 828 | and select <emphasis role="bold">Delete Custom | ||
| 829 | Script</emphasis>.</para> | ||
| 830 | </listitem> | ||
| 831 | |||
| 832 | <listitem> | ||
| 833 | <para>In the <emphasis role="bold">Delete Custom Script</emphasis> | ||
| 834 | pop up, set the name and the type of the script that should be | ||
| 835 | deleted and press <emphasis role="bold">Execute</emphasis>. If the | ||
| 836 | <emphasis role="bold">Script Type</emphasis> remains unset, the | ||
| 837 | script will be deleted regardless of its type.</para> | ||
| 838 | </listitem> | ||
| 839 | </orderedlist> | ||
| 840 | </section> | ||
| 817 | </section> | 841 | </section> |
| 818 | 842 | ||
| 819 | <section id="wireless_access_point"> | 843 | <section id="wireless_access_point"> |
| 820 | <title>Wireless Access Point</title> | 844 | <title>Wireless Access Point</title> |
| 821 | 845 | ||
| 822 | <para>The Wireless AP Screen from the Enea Edge Management Configuration | 846 | <para>The Wireless AP Screen from the Enea Edge Management Configuration |
diff --git a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml index 14ac049..9680a0c 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | |||
| @@ -245,7 +245,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 245 | <emphasis role="bold">System</emphasis>, <emphasis | 245 | <emphasis role="bold">System</emphasis>, <emphasis |
| 246 | role="bold">Configuration</emphasis>, <emphasis role="bold">Web | 246 | role="bold">Configuration</emphasis>, <emphasis role="bold">Web |
| 247 | Access</emphasis> and checking the <emphasis role="bold">Enable | 247 | Access</emphasis> and checking the <emphasis role="bold">Enable |
| 248 | HTTP</emphasis> box, or installing it manually.</para> | 248 | HTTP</emphasis> box, or install Edge Enea 2.4.0 on the device manually.</para> |
| 249 | </note> | 249 | </note> |
| 250 | </section> | 250 | </section> |
| 251 | 251 | ||
| @@ -576,13 +576,37 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 576 | upgrade image can be chosen from the <emphasis role="bold">Image | 576 | upgrade image can be chosen from the <emphasis role="bold">Image |
| 577 | Files</emphasis> tab by selecting the image file from the list and | 577 | Files</emphasis> tab by selecting the image file from the list and |
| 578 | clicking the <emphasis role="bold">Install on Device</emphasis> | 578 | clicking the <emphasis role="bold">Install on Device</emphasis> |
| 579 | button.</para> | 579 | button. The Image files that appear in the <emphasis role="bold">Image |
| 580 | Library</emphasis> tab can be uploaded to the Enea Edge Management Application | ||
| 581 | by following the steps listed in <link linkend="image_lib">Image Library</link>.</para> | ||
| 580 | 582 | ||
| 581 | <para>Once an image is installed on the uCPE device, the image will be | 583 | <para>Once an image is installed on the uCPE device, the image will be |
| 582 | available on the uCPE device and be visible in the <emphasis | 584 | available on the uCPE device and be visible in the <emphasis |
| 583 | role="bold">Releases</emphasis> tab. It can then be selected from the | 585 | role="bold">Releases</emphasis> tab. There are two ways to make it |
| 584 | list and the upgrade started by clicking the <emphasis | 586 | active, choose one or the other:</para> |
| 585 | role="bold">Upgrade</emphasis> button.</para> | 587 | |
| 588 | <itemizedlist> | ||
| 589 | <listitem> | ||
| 590 | <para>Select it from the list and then start the upgrade by | ||
| 591 | clicking the <emphasis role="bold">Upgrade</emphasis> button.</para> | ||
| 592 | </listitem> | ||
| 593 | |||
| 594 | <listitem> | ||
| 595 | <para>Select <emphasis role="bold">Operations</emphasis>, then | ||
| 596 | <emphasis role="bold">Upgrade</emphasis>, enter the | ||
| 597 | <literal>Release Name</literal> and press <emphasis | ||
| 598 | role="bold">Execute</emphasis>. Filling in the <literal>Restore Archive</literal> | ||
| 599 | text field is optional and should be left unset if the | ||
| 600 | <literal>NFVi Snapshot</literal> feature is disabled.</para> | ||
| 601 | </listitem> | ||
| 602 | </itemizedlist> | ||
| 603 | |||
| 604 | <para>If an installed image is no longer needed, it can be removed | ||
| 605 | from the device by selecting <emphasis | ||
| 606 | role="bold">Operations</emphasis> and <emphasis role="bold">Remove | ||
| 607 | Release</emphasis>. In the <emphasis role="bold">Remove | ||
| 608 | Release</emphasis> window, provide the <literal>Release Name</literal> | ||
| 609 | and press <emphasis role="bold">Execute</emphasis>.</para> | ||
| 586 | </section> | 610 | </section> |
| 587 | </section> | 611 | </section> |
| 588 | </section> | 612 | </section> |
diff --git a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml index bd2fb0b..e3fcde2 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml | |||
| @@ -407,9 +407,58 @@ | |||
| 407 | </listitem> | 407 | </listitem> |
| 408 | </orderedlist> | 408 | </orderedlist> |
| 409 | 409 | ||
| 410 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then | 410 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then choosing <emphasis role="bold">Events</emphasis> |
| 411 | choosing <emphasis role="bold">Events</emphasis> will show that the VNF | 411 | will show that the VNF was created and a connection was established.</para> |
| 412 | was created and a connection was established.</para> | 412 | </section> |
| 413 | |||
| 414 | <section id="vm_operations"> | ||
| 415 | <title>VNF Instance Operations</title> | ||
| 416 | |||
| 417 | <para>Various operations can be done to a VNF instance. It can be paused, | ||
| 418 | resumed, stopped, started or deleted.</para> | ||
| 419 | |||
| 420 | <orderedlist> | ||
| 421 | <listitem> | ||
| 422 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> | ||
| 423 | and choose <emphasis role="bold">Instances</emphasis>.</para> | ||
| 424 | </listitem> | ||
| 425 | |||
| 426 | <listitem> | ||
| 427 | <para>Select an instance that needs to be modified.</para> | ||
| 428 | </listitem> | ||
| 429 | |||
| 430 | <listitem> | ||
| 431 | <para>Depending on the desired action, click the <emphasis | ||
| 432 | role="bold">Delete/ Force Delete / Start / Stop / Pause / | ||
| 433 | Resume</emphasis> button respectively.</para> | ||
| 434 | </listitem> | ||
| 435 | </orderedlist> | ||
| 436 | |||
| 437 | <para>Alternatively, these same operations can be performed by:</para> | ||
| 438 | |||
| 439 | <orderedlist> | ||
| 440 | <listitem> | ||
| 441 | <para>Selecting <emphasis role="bold">Operations</emphasis>.</para> | ||
| 442 | </listitem> | ||
| 443 | |||
| 444 | <listitem> | ||
| 445 | <para>Depending on the desired action, choosing <emphasis | ||
| 446 | role="bold">Destroy / Start / Stop / Pause / Resume | ||
| 447 | VM</emphasis> respectively.</para> | ||
| 448 | </listitem> | ||
| 449 | |||
| 450 | <listitem> | ||
| 451 | <para>The <literal>Id</literal> of the VM that should be modified can | ||
| 452 | be found by selecting <emphasis role="bold">Configuration</emphasis>, then | ||
| 453 | <emphasis role="bold">Virtual Machines</emphasis>, and then accessing the <emphasis | ||
| 454 | role="bold">VMs</emphasis> tab.</para> | ||
| 455 | </listitem> | ||
| 456 | |||
| 457 | <listitem> | ||
| 458 | <para>Provide the <literal>Id</literal> of the VM that should be | ||
| 459 | modified and press <emphasis role="bold">Execute</emphasis>.</para> | ||
| 460 | </listitem> | ||
| 461 | </orderedlist> | ||
| 413 | </section> | 462 | </section> |
| 414 | 463 | ||
| 415 | <section id="enter_console"> | 464 | <section id="enter_console"> |
