diff options
author | mrpa <miruna.paun@enea.com> | 2020-11-19 19:30:08 +0100 |
---|---|---|
committer | mrpa <miruna.paun@enea.com> | 2020-11-19 19:30:57 +0100 |
commit | adb4c492888c3f9639e03b37dd8ab6178f8eb02a (patch) | |
tree | ecd517003f269d329af01adc8d52802093af419f | |
parent | d78fae86a57e8847e1c52e12aaf7468ff0227815 (diff) | |
download | nfv-access-documentation-adb4c492888c3f9639e03b37dd8ab6178f8eb02a.tar.gz |
Feedback comments from siha, lumc, dape.
Change-Id: Ib05e0ec31d159b46d08ef13378677caf9f80632c
Signed-off-by: mrpa <miruna.paun@enea.com>
-rwxr-xr-x | doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png | bin | 127191 -> 116871 bytes | |||
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml | 459 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/log_collector.xml | 649 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml | 13 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml | 6 |
5 files changed, 577 insertions, 550 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png b/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png index b783076..5d5a355 100755 --- a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png +++ b/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index 19a3397..809213d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml | |||
@@ -38,9 +38,9 @@ | |||
38 | </listitem> | 38 | </listitem> |
39 | 39 | ||
40 | <listitem> | 40 | <listitem> |
41 | <para>Connecting to the Web UI of the uCPE Manager for management | 41 | <para>Connecting to the GUI of the uCPE Manager for management and |
42 | and configuration. Network access between the CentOS 7 server and | 42 | configuration. Network access between the CentOS 7 server and the |
43 | the laptop is required. Please see the <xi:include | 43 | laptop is required. Please see the <xi:include |
44 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 44 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
45 | xmlns:xi="http://www.w3.org/2001/XInclude" | 45 | xmlns:xi="http://www.w3.org/2001/XInclude" |
46 | xpointer="element(book_enea_nfv_access_release_info/1)" /> manual | 46 | xpointer="element(book_enea_nfv_access_release_info/1)" /> manual |
@@ -110,7 +110,7 @@ | |||
110 | 110 | ||
111 | <entry>TCP</entry> | 111 | <entry>TCP</entry> |
112 | 112 | ||
113 | <entry>Required for WEB UI Access.</entry> | 113 | <entry>Required for GUI Access.</entry> |
114 | </row> | 114 | </row> |
115 | 115 | ||
116 | <row> | 116 | <row> |
@@ -118,8 +118,7 @@ | |||
118 | 118 | ||
119 | <entry>TCP</entry> | 119 | <entry>TCP</entry> |
120 | 120 | ||
121 | <entry>Required for WEB UI Access and Device | 121 | <entry>Required for GUI Access and Device Connectivity.</entry> |
122 | Connectivity.</entry> | ||
123 | </row> | 122 | </row> |
124 | 123 | ||
125 | <row> | 124 | <row> |
@@ -127,7 +126,8 @@ | |||
127 | 126 | ||
128 | <entry>UDP</entry> | 127 | <entry>UDP</entry> |
129 | 128 | ||
130 | <entry>TBD.<remark>This needs to be updated</remark></entry> | 129 | <entry>Required for the uCPE Manager High Availability |
130 | Configuration.</entry> | ||
131 | </row> | 131 | </row> |
132 | 132 | ||
133 | <row> | 133 | <row> |
@@ -172,10 +172,11 @@ | |||
172 | <programlisting>sudo firewall-cmd --permanent --add-service=80/tcp | 172 | <programlisting>sudo firewall-cmd --permanent --add-service=80/tcp |
173 | sudo firewall-cmd --permanent --add-service=443/tcp | 173 | sudo firewall-cmd --permanent --add-service=443/tcp |
174 | sudo firewall-cmd --permanent --add-service=54327/udp | 174 | sudo firewall-cmd --permanent --add-service=54327/udp |
175 | sudo firewall-cmd -permanent -add-service=5701-5708/tcp | 175 | sudo firewall-cmd --permanent --add-service=5701-5708/tcp |
176 | sudo firewall-cmd --permanent --add-service=4334/tcp | 176 | sudo firewall-cmd --permanent --add-service=4334/tcp |
177 | sudo firewall-cmd -permanent -add-service=2021-2040/tcp | 177 | sudo firewall-cmd --permanent --add-service=2021-2040/tcp |
178 | sudo firewall-cmd -reload</programlisting> | 178 | sudo firewall-cmd --permanent --add-service=7000-7010/tcp |
179 | sudo firewall-cmd --reload</programlisting> | ||
179 | </section> | 180 | </section> |
180 | 181 | ||
181 | <section id="openjdk_postgresql_config"> | 182 | <section id="openjdk_postgresql_config"> |
@@ -218,14 +219,10 @@ OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing) </progra | |||
218 | <para>The following system variables need to point to the OpenJDK 11 | 219 | <para>The following system variables need to point to the OpenJDK 11 |
219 | installation:</para> | 220 | installation:</para> |
220 | 221 | ||
221 | <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac))))) | 222 | <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac))))) |
222 | export PATH=$PATH:$JAVA_HOME/bin | 223 | export PATH=$PATH:$JAVA_HOME/bin |
223 | export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting> | 224 | export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting> |
224 | 225 | ||
225 | <para>Store updates of the variables <literal>PATH</literal>, | ||
226 | <literal>JAVA_HOME</literal>, and <literal>CLASSPATH</literal> in | ||
227 | the <filename>.bash_profile</filename> file of the root user.</para> | ||
228 | |||
229 | <note> | 226 | <note> |
230 | <para>In order to make these system variables persistent, the | 227 | <para>In order to make these system variables persistent, the |
231 | commands given above should be added to a script in the | 228 | commands given above should be added to a script in the |
@@ -238,7 +235,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
238 | 235 | ||
239 | <para>The uCPE Manager requires a specific PostgreeSQL version. This is | 236 | <para>The uCPE Manager requires a specific PostgreeSQL version. This is |
240 | embedded in the uCPE Manager installation. In order to avoid conflicts, | 237 | embedded in the uCPE Manager installation. In order to avoid conflicts, |
241 | any existing installation needs to be uninstalled.</para> | 238 | any existing PostgreeSQL installation needs to be uninstalled.</para> |
242 | 239 | ||
243 | <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para> | 240 | <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para> |
244 | 241 | ||
@@ -292,7 +289,9 @@ userdel postgres</programlisting> | |||
292 | </listitem> | 289 | </listitem> |
293 | 290 | ||
294 | <listitem> | 291 | <listitem> |
295 | <para>Follow the installation process as described below.</para> | 292 | <para>Follow the installation instruction for the uCPE Manager |
293 | available in section <remark>add olink to section with ID | ||
294 | "install_ucpe_mg"</remark></para> | ||
296 | </listitem> | 295 | </listitem> |
297 | </orderedlist> | 296 | </orderedlist> |
298 | </section> | 297 | </section> |
@@ -385,199 +384,211 @@ userdel postgres</programlisting> | |||
385 | <section id="prep_deploy"> | 384 | <section id="prep_deploy"> |
386 | <title>Preparing the deployment</title> | 385 | <title>Preparing the deployment</title> |
387 | 386 | ||
388 | <section id="instal_ucpe_mg"> | 387 | <section id="install_ucpe_mg"> |
389 | <title>Installing the uCPE Manager</title> | 388 | <title>Installing the uCPE Manager</title> |
390 | 389 | ||
391 | <para>On the CentOS 7 server open a terminal, log into a bash shell with | 390 | <para>The uCPE Manager can be installed using as a fresh/first-time |
392 | the root account and perform the following:</para> | 391 | configuration or using a backup file of a previous installation, created |
393 | 392 | within the uCPE Manager GUI.</para> | |
394 | <orderedlist> | ||
395 | <listitem> | ||
396 | <para>Unzip | ||
397 | <literal>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</literal></para> | ||
398 | |||
399 | <para>The directory in which the archive has been unpacked will be | ||
400 | denoted as: <literal><uCPEM-installdir></literal>.</para> | ||
401 | </listitem> | ||
402 | 393 | ||
403 | <listitem> | 394 | <section id="fresh_ucpemg_install"> |
404 | <para>Enter <literal><uCPEM-installdir></literal>.</para> | 395 | <title>Fresh Installation of the uCPE Manager</title> |
405 | </listitem> | ||
406 | |||
407 | <listitem> | ||
408 | <para>Choose the target installation folder, e.g. | ||
409 | <literal>/opt/ems</literal>. Everything will be installed under a | ||
410 | folder called <literal>/ucpemanager</literal> within the target | ||
411 | installation folder.</para> | ||
412 | 396 | ||
413 | <para>The application files will be installed in | 397 | <para>On the CentOS 7 server open a terminal, log into a bash shell |
414 | <literal>/opt/ems/ucpemanager/application</literal>. The database | 398 | with the root account and perform the following:</para> |
415 | will be installed in | ||
416 | <literal>/opt/ems/ucpemanager/database</literal>.</para> | ||
417 | </listitem> | ||
418 | |||
419 | <listitem> | ||
420 | <para>Run the following interactive command:</para> | ||
421 | |||
422 | <programlisting>./install.sh /opt/ems \ | ||
423 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | ||
424 | |||
425 | <para>Use the default configuration values provided below in the | ||
426 | interactive install command. The same configuration values will need | ||
427 | to be provided when upgrading or uninstalling the uCPE | ||
428 | Manager:</para> | ||
429 | |||
430 | <itemizedlist> | ||
431 | <listitem> | ||
432 | <para>Database Configurations:</para> | ||
433 | |||
434 | <itemizedlist spacing="compact"> | ||
435 | <listitem> | ||
436 | <para>Are you using the embedded PostgreSQL database? [Y/N]: | ||
437 | <literal>Y</literal>.</para> | ||
438 | </listitem> | ||
439 | |||
440 | <listitem> | ||
441 | <para>Specify the database process password: | ||
442 | <literal>postgres</literal>.</para> | ||
443 | </listitem> | ||
444 | |||
445 | <listitem> | ||
446 | <para>Specify the database ID (or name): | ||
447 | <literal>ucpemanager</literal>.</para> | ||
448 | </listitem> | ||
449 | |||
450 | <listitem> | ||
451 | <para>Specify the database server port: | ||
452 | <literal>5432</literal>.</para> | ||
453 | </listitem> | ||
454 | |||
455 | <listitem> | ||
456 | <para>Specify the database user name: | ||
457 | <literal>postgres</literal>.</para> | ||
458 | </listitem> | ||
459 | |||
460 | <listitem> | ||
461 | <para>Specify database password: | ||
462 | <literal>postgres</literal>.</para> | ||
463 | </listitem> | ||
464 | |||
465 | <listitem> | ||
466 | <para>Specify database startup thread pool size: | ||
467 | <literal>1</literal>.</para> | ||
468 | </listitem> | ||
469 | </itemizedlist> | ||
470 | </listitem> | ||
471 | |||
472 | <listitem> | ||
473 | <para>Service Configurations:</para> | ||
474 | |||
475 | <itemizedlist spacing="compact"> | ||
476 | <listitem> | ||
477 | <para>Specify service username: | ||
478 | <literal>ucpemanager</literal>.</para> | ||
479 | </listitem> | ||
480 | |||
481 | <listitem> | ||
482 | <para>Specify service password: | ||
483 | <literal>ucpemanager</literal>.</para> | ||
484 | </listitem> | ||
485 | </itemizedlist> | ||
486 | </listitem> | ||
487 | |||
488 | <listitem> | ||
489 | <para>High Availability Configurations:</para> | ||
490 | |||
491 | <itemizedlist spacing="compact"> | ||
492 | <listitem> | ||
493 | <para>Specify the IP address of the local interface: The | ||
494 | CentOS 7 loopback address: 127.0.0.1.</para> | ||
495 | </listitem> | ||
496 | |||
497 | <listitem> | ||
498 | <para>Is this server part of a cluster? [Y/N]: | ||
499 | <literal>N</literal>.</para> | ||
500 | </listitem> | ||
501 | </itemizedlist> | ||
502 | </listitem> | ||
503 | |||
504 | <listitem> | ||
505 | <para>Heap Configuration:</para> | ||
506 | |||
507 | <itemizedlist spacing="compact"> | ||
508 | <listitem> | ||
509 | <para>Please enter the new Maximum Heap Size: <literal>4 | ||
510 | GB</literal>.<remark>Is this value accurate?</remark></para> | ||
511 | </listitem> | ||
512 | </itemizedlist> | ||
513 | </listitem> | ||
514 | </itemizedlist> | ||
515 | |||
516 | <para>This command will:</para> | ||
517 | |||
518 | <itemizedlist spacing="compact"> | ||
519 | <listitem> | ||
520 | <para>Extract the application files from the compressed | ||
521 | installation kit.</para> | ||
522 | </listitem> | ||
523 | |||
524 | <listitem> | ||
525 | <para>Install the bundled database.</para> | ||
526 | </listitem> | ||
527 | 399 | ||
528 | <listitem> | 400 | <orderedlist> |
529 | <para>Install the uCPE Manager as a service with the name | 401 | <listitem> |
530 | <literal>ucpemanager</literal>.</para> | 402 | <para>Unzip |
531 | </listitem> | 403 | <literal>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</literal></para> |
532 | 404 | ||
533 | <listitem> | 405 | <para>The directory in which the archive has been unpacked will be |
534 | <para>Start the <literal>ucpemanager</literal> service</para> | 406 | denoted as: <literal><uCPEM-installdir></literal>.</para> |
535 | </listitem> | 407 | </listitem> |
536 | </itemizedlist> | ||
537 | </listitem> | ||
538 | 408 | ||
539 | <listitem> | 409 | <listitem> |
540 | <para>Open the IP Address of the CentOS 7 in a web browser on the | 410 | <para>Enter <literal><uCPEM-installdir></literal>.</para> |
541 | laptop and log in with the username and password: | 411 | </listitem> |
542 | <literal>admin</literal>/<literal>admin</literal>.</para> | ||
543 | </listitem> | ||
544 | </orderedlist> | ||
545 | 412 | ||
546 | <note> | 413 | <listitem> |
547 | <para>The IPv4 address of the CentOS 7 server, connected to the same | 414 | <para>Choose the target installation folder, e.g. |
548 | network as the uCPE Devices, will be used as a configuration parameter | 415 | <literal>/opt/ems</literal>. Everything will be installed under a |
549 | both when setting up the uCPE devices and when accessing the uCPE | 416 | folder called <literal>/ucpemanager</literal> within the target |
550 | Manager GUI.</para> | 417 | installation folder.</para> |
551 | </note> | 418 | |
419 | <para>The application files will be installed in | ||
420 | <literal>/opt/ems/ucpemanager/application</literal>. The database | ||
421 | will be installed in | ||
422 | <literal>/opt/ems/ucpemanager/database</literal>.</para> | ||
423 | </listitem> | ||
552 | 424 | ||
553 | <para>The uCPE Manager can be restored if a back-up file has been | 425 | <listitem> |
554 | previously created. A backup file can be created by accessing from the | 426 | <para>Run the following interactive command:</para> |
555 | uCPE Manager GUI: <literal>System</literal> -> <literal>System | ||
556 | Backup</literal>. The resulting zip archive will be located in the | ||
557 | <filename>/opt/ems/ucpemanager/application/backup</filename> folder and | ||
558 | will be named <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> | ||
559 | (e.g System-Backup_Feb19_2013_2257_42.zip). Save the archive to another | ||
560 | location outside the uCPE Manager installation folder for future | ||
561 | use.</para> | ||
562 | 427 | ||
563 | <note> | 428 | <programlisting>./install.sh /opt/ems \ |
564 | <para>The System Back-up file obtained from the uCPE Manager GUI | 429 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> |
565 | (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) must be | ||
566 | used to recover the uCPE Manager during deployment.</para> | ||
567 | |||
568 | <para>This is different from the uCPE Manager snapshot obtained during | ||
569 | a uCPE Manager Upgrade or Uninstall Operation | ||
570 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>).<remark>Why | ||
571 | do both options exist, what makes them different from each | ||
572 | other?</remark></para> | ||
573 | </note> | ||
574 | 430 | ||
575 | <para>To install the uCPE Manager with the restore option provide an | 431 | <para>Use the default configuration values provided below in the |
576 | additional argument as shown below during installation:</para> | 432 | interactive install command. The same configuration values will |
433 | need to be provided when upgrading or uninstalling the uCPE | ||
434 | Manager:</para> | ||
435 | |||
436 | <itemizedlist> | ||
437 | <listitem> | ||
438 | <para>Database Configurations:</para> | ||
439 | |||
440 | <itemizedlist spacing="compact"> | ||
441 | <listitem> | ||
442 | <para>Are you using the embedded PostgreSQL database? | ||
443 | [Y/N]: <literal>Y</literal>.</para> | ||
444 | </listitem> | ||
445 | |||
446 | <listitem> | ||
447 | <para>Specify the database process password: | ||
448 | <literal>postgres</literal>.</para> | ||
449 | </listitem> | ||
450 | |||
451 | <listitem> | ||
452 | <para>Specify the database ID (or name): | ||
453 | <literal>ucpemanager</literal>.</para> | ||
454 | </listitem> | ||
455 | |||
456 | <listitem> | ||
457 | <para>Specify the database server port: | ||
458 | <literal>5432</literal>.</para> | ||
459 | </listitem> | ||
460 | |||
461 | <listitem> | ||
462 | <para>Specify the database user name: | ||
463 | <literal>postgres</literal>.</para> | ||
464 | </listitem> | ||
465 | |||
466 | <listitem> | ||
467 | <para>Specify database password: | ||
468 | <literal>postgres</literal>.</para> | ||
469 | </listitem> | ||
470 | |||
471 | <listitem> | ||
472 | <para>Specify database startup thread pool size: | ||
473 | <literal>1</literal>.</para> | ||
474 | </listitem> | ||
475 | </itemizedlist> | ||
476 | </listitem> | ||
477 | |||
478 | <listitem> | ||
479 | <para>Service Configurations:</para> | ||
480 | |||
481 | <itemizedlist spacing="compact"> | ||
482 | <listitem> | ||
483 | <para>Specify service username: | ||
484 | <literal>ucpemanager</literal>.</para> | ||
485 | </listitem> | ||
486 | |||
487 | <listitem> | ||
488 | <para>Specify service password: | ||
489 | <literal>ucpemanager</literal>.</para> | ||
490 | </listitem> | ||
491 | </itemizedlist> | ||
492 | </listitem> | ||
493 | |||
494 | <listitem> | ||
495 | <para>High Availability Configurations:</para> | ||
496 | |||
497 | <itemizedlist spacing="compact"> | ||
498 | <listitem> | ||
499 | <para>Specify the IP address of the local interface: The | ||
500 | CentOS 7 loopback address: 127.0.0.1.</para> | ||
501 | </listitem> | ||
502 | |||
503 | <listitem> | ||
504 | <para>Is this server part of a cluster? [Y/N]: | ||
505 | <literal>N</literal>.</para> | ||
506 | </listitem> | ||
507 | </itemizedlist> | ||
508 | </listitem> | ||
509 | |||
510 | <listitem> | ||
511 | <para>Heap Configuration:</para> | ||
512 | |||
513 | <itemizedlist spacing="compact"> | ||
514 | <listitem> | ||
515 | <para>Please enter the new Maximum Heap Size: <literal>4 | ||
516 | GB</literal>.<remark>Is this value | ||
517 | accurate?</remark></para> | ||
518 | </listitem> | ||
519 | </itemizedlist> | ||
520 | </listitem> | ||
521 | </itemizedlist> | ||
522 | |||
523 | <para>This command will:</para> | ||
524 | |||
525 | <itemizedlist spacing="compact"> | ||
526 | <listitem> | ||
527 | <para>Extract the application files from the compressed | ||
528 | installation kit.</para> | ||
529 | </listitem> | ||
530 | |||
531 | <listitem> | ||
532 | <para>Install the bundled database.</para> | ||
533 | </listitem> | ||
534 | |||
535 | <listitem> | ||
536 | <para>Install the uCPE Manager as a service with the name | ||
537 | <literal>ucpemanager</literal>.</para> | ||
538 | </listitem> | ||
539 | |||
540 | <listitem> | ||
541 | <para>Start the <literal>ucpemanager</literal> service</para> | ||
542 | </listitem> | ||
543 | </itemizedlist> | ||
544 | </listitem> | ||
577 | 545 | ||
578 | <programlisting>./install.sh \ | 546 | <listitem> |
547 | <para>Open the IP Address of the CentOS 7 in a web browser on the | ||
548 | laptop and log in with the username and password: | ||
549 | <literal>admin</literal>/<literal>admin</literal>.</para> | ||
550 | </listitem> | ||
551 | </orderedlist> | ||
552 | |||
553 | <note> | ||
554 | <para>The IPv4 address of the CentOS 7 server, connected to the same | ||
555 | network as the uCPE Devices, will be used as a configuration | ||
556 | parameter both when setting up the uCPE devices and when accessing | ||
557 | the uCPE Manager GUI.</para> | ||
558 | </note> | ||
559 | </section> | ||
560 | |||
561 | <section id="install_ucpemg_from_backup"> | ||
562 | <title>Installation of the uCPE Manager using a Back-up file</title> | ||
563 | |||
564 | <para>The uCPE Manager can be restored if a back-up file has been | ||
565 | previously created. A backup file can be created by accessing from the | ||
566 | uCPE Manager GUI: <literal>System</literal> -> <literal>System | ||
567 | Backup</literal>. The resulting zip archive will be located in the | ||
568 | <filename>/opt/ems/ucpemanager/application/backup</filename> folder | ||
569 | and will be named | ||
570 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g | ||
571 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another | ||
572 | location outside the uCPE Manager installation folder for future | ||
573 | use.</para> | ||
574 | |||
575 | <note> | ||
576 | <para>The System Back-up file obtained from the uCPE Manager GUI | ||
577 | (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is | ||
578 | different from the uCPE Manager snapshot obtained during a uCPE | ||
579 | Manager Upgrade or Uninstall operation | ||
580 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed | ||
581 | for recovery of the uCPE Manager.<remark>add olink to section with | ||
582 | id "restore_prev_ucpe_install"</remark></para> | ||
583 | </note> | ||
584 | |||
585 | <para>To install the uCPE Manager with the restore option provide an | ||
586 | additional argument as shown below during installation:</para> | ||
587 | |||
588 | <programlisting>./install.sh \ | ||
579 | /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ | 589 | /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ |
580 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | 590 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> |
591 | </section> | ||
581 | </section> | 592 | </section> |
582 | 593 | ||
583 | <section id="prep_usb_ena"> | 594 | <section id="prep_usb_ena"> |
@@ -721,43 +732,41 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
721 | 732 | ||
722 | <itemizedlist> | 733 | <itemizedlist> |
723 | <listitem> | 734 | <listitem> |
724 | <para>The Layer 3 configuration of WAN Interface(s).</para> | 735 | <para>The Management Interface. The network interface used by |
725 | </listitem> | 736 | the uCPE Manager to communicate with the uCPE device.</para> |
726 | |||
727 | <listitem> | ||
728 | <para>The Static or Dynamic IP.</para> | ||
729 | </listitem> | 737 | </listitem> |
730 | 738 | ||
731 | <listitem> | 739 | <listitem> |
732 | <para>During network configuration, WAN cables are plugged into | 740 | <para>During network configuration, WAN cables are plugged into |
733 | the uCPE device to identify ports and make them available for | 741 | the uCPE device to identify ports and make them available for |
734 | configuration. All ports with cable connections will be set as | 742 | configuration. The user needs to connect the same number of |
735 | WAN ports and must be configured (DHCP is the default setting). | 743 | cables as the number of WAN ports that he wishes to configure |
736 | The configured WAN ports cannot be removed after configuration. | 744 | (DHCP is the default setting). The configured WAN cables cannot |
737 | The user needs to connect the same number of cables as the | 745 | be removed after being configured.</para> |
738 | number of WAN ports that he wishes to configure. The configured | ||
739 | WAN cables cannot be removed after being configured.</para> | ||
740 | 746 | ||
741 | <note> | 747 | <note> |
742 | <para>No LAN ports should be connected nor configured at this | 748 | <para>No LAN ports should be connected nor configured at this |
743 | time. The LAN port used to access the Web-installer from the | 749 | time. The LAN port used to access the Web-installer from the |
744 | laptop will not be shown and cannot be configured in the Web | 750 | laptop will not be shown and cannot be configured in the |
745 | Installer.</para> | 751 | Web-Installer.</para> |
746 | </note> | 752 | </note> |
747 | </listitem> | 753 | </listitem> |
748 | 754 | ||
749 | <listitem> | 755 | <listitem> |
750 | <para>The Management Interface. The network interface (IP | 756 | <para>The Layer 3 configuration of WAN Interface(s).</para> |
751 | Address of the uCPE Manager) used by the uCPE Manager to | 757 | </listitem> |
752 | communicate with the uCPE device.</para> | 758 | |
759 | <listitem> | ||
760 | <para>The Static or Dynamic IP.</para> | ||
753 | </listitem> | 761 | </listitem> |
754 | </itemizedlist> | 762 | </itemizedlist> |
755 | </listitem> | 763 | </listitem> |
756 | </orderedlist> | 764 | </orderedlist> |
757 | 765 | ||
758 | <para>When the user has completed the configuration steps in the | 766 | <para>When the user has completed the configuration steps in the |
759 | Web-installer, NFV Access is installed on the hard drive. The largest | 767 | Web-installer, NFV Access is installed on the hard drive (the largest |
760 | drive found on the uCPE device will be used for installation.</para> | 768 | drive found on the uCPE device will be used for installation. Now the |
769 | user must remove USB stick and reboot the device.</para> | ||
761 | </section> | 770 | </section> |
762 | 771 | ||
763 | <section id="prep_phys_exec"> | 772 | <section id="prep_phys_exec"> |
@@ -788,11 +797,6 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
788 | </listitem> | 797 | </listitem> |
789 | 798 | ||
790 | <listitem> | 799 | <listitem> |
791 | <para>One uCPE device LAN connected to the laptop using an ethernet | ||
792 | cable.</para> | ||
793 | </listitem> | ||
794 | |||
795 | <listitem> | ||
796 | <para>The USB is removed from the uCPE device.</para> | 800 | <para>The USB is removed from the uCPE device.</para> |
797 | </listitem> | 801 | </listitem> |
798 | 802 | ||
@@ -845,7 +849,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
845 | </note> | 849 | </note> |
846 | 850 | ||
847 | <para><emphasis role="bold">To create an offline | 851 | <para><emphasis role="bold">To create an offline |
848 | configuration</emphasis><orderedlist> | 852 | configuration</emphasis> <orderedlist> |
849 | <listitem> | 853 | <listitem> |
850 | <para>In a browser access the uCPE Manager, then | 854 | <para>In a browser access the uCPE Manager, then |
851 | <literal>Applications</literal>-><literal>Offline | 855 | <literal>Applications</literal>-><literal>Offline |
@@ -859,9 +863,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
859 | <literal>deviceId</literal>.</para> | 863 | <literal>deviceId</literal>.</para> |
860 | 864 | ||
861 | <para>The name is user defined and can be set to any unique text | 865 | <para>The name is user defined and can be set to any unique text |
862 | string identifying the configuration. The deviceVersion must match | 866 | string identifying the configuration. The |
863 | the Enea NFV Access version of the uCPE device and the deviceId | 867 | <literal>deviceVersion</literal> must match the Enea NFV Access |
864 | must be set to the previously set identifier of the uCPE (uCPE | 868 | version of the uCPE device and the <literal>deviceId</literal> |
869 | must be the previously set identifier of the uCPE device (uCPE | ||
865 | Identifier).</para> | 870 | Identifier).</para> |
866 | </listitem> | 871 | </listitem> |
867 | </orderedlist></para> | 872 | </orderedlist></para> |
@@ -932,10 +937,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
932 | <note> | 937 | <note> |
933 | <para>In case of failure due to a misconfiguration or if a uCPE device | 938 | <para>In case of failure due to a misconfiguration or if a uCPE device |
934 | does not appear in the uCPE Manager, a reinstallation is needed .The | 939 | does not appear in the uCPE Manager, a reinstallation is needed .The |
935 | user should remove all WAN cables, reinsert the USB stick, reattach | 940 | user should remove all WAN cables, reinsert the USB stick, reconnect |
936 | the laptop, reboot the uCPE device and then access the Web-installer | 941 | the laptop using the ethernet cable, reboot the uCPE device and then |
937 | (<literal>http://172.16.1.1</literal>). If the uCPE device does not | 942 | access the Web-installer |
938 | appear in the uCPE Manager then a reinstallation is needed.</para> | 943 | (<literal>http://172.16.1.1</literal>).</para> |
939 | </note> | 944 | </note> |
940 | 945 | ||
941 | <para>When a uCPE device is registered it can be manually added to the | 946 | <para>When a uCPE device is registered it can be manually added to the |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml index 410e692..95a8fa9 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml | |||
@@ -11,355 +11,364 @@ | |||
11 | <title>Log collecting using the uCPE Manager</title> | 11 | <title>Log collecting using the uCPE Manager</title> |
12 | 12 | ||
13 | <para>The uCPE Manager allows for collection of the relevant logs from the | 13 | <para>The uCPE Manager allows for collection of the relevant logs from the |
14 | GUI. Collect the necessary log files and system details, then create an | 14 | GUI.</para> |
15 | archive (a tar file) on the uCPE device in the | ||
16 | <filename>/var/odm/log/archives</filename> folder:</para> | ||
17 | 15 | ||
18 | <orderedlist> | 16 | <section id="log_collect"> |
19 | <listitem> | 17 | <title>Collecting the Logs</title> |
20 | <para>Access <literal>Operations</literal> -> <literal>Collect | ||
21 | Debug Logs</literal>.</para> | ||
22 | </listitem> | ||
23 | 18 | ||
24 | <listitem> | 19 | <para>Collect the necessary log files and system details, then create an |
25 | <para>Provide a file name in the new window.</para> | 20 | archive (a tar file) on the uCPE device in the |
26 | </listitem> | 21 | <filename>/var/odm/log/archives</filename> folder:</para> |
27 | 22 | ||
28 | <listitem> | 23 | <orderedlist> |
29 | <para>Press the <literal>Execute</literal> button.</para> | 24 | <listitem> |
25 | <para>Access <literal>Operations</literal> -> <literal>Collect | ||
26 | Debug Logs</literal>.</para> | ||
27 | </listitem> | ||
30 | 28 | ||
31 | <para>A success message is shown in the same window as shown below. At | 29 | <listitem> |
32 | this moment, the process of collecting logs on the uCPE device | 30 | <para>Provide a file name in the new window.</para> |
33 | starts.</para> | 31 | </listitem> |
34 | </listitem> | ||
35 | 32 | ||
36 | <figure> | 33 | <listitem> |
37 | <title>Collecting Debug Logs</title> | 34 | <para>Press the <literal>Execute</literal> button.</para> |
38 | |||
39 | <mediaobject> | ||
40 | <imageobject> | ||
41 | <imagedata align="center" contentwidth="500" | ||
42 | fileref="images/collect_debug_logs.png" /> | ||
43 | </imageobject> | ||
44 | </mediaobject> | ||
45 | </figure> | ||
46 | </orderedlist> | ||
47 | |||
48 | <note> | ||
49 | <para>It might take some time for the archive to be created. When the | ||
50 | operation completes, a "CollectLogsComplete" notification is sent from | ||
51 | the uCPE device to the uCPE Manager. This can be viewed in the GUI under | ||
52 | the <literal>Faults</literal> -> <literal>Events</literal> toolbar | ||
53 | menu.</para> | ||
54 | |||
55 | <figure> | ||
56 | <title>Collecting Debug Logs</title> | ||
57 | |||
58 | <mediaobject> | ||
59 | <imageobject> | ||
60 | <imagedata align="center" contentwidth="500" | ||
61 | fileref="images/fault_events.png" /> | ||
62 | </imageobject> | ||
63 | </mediaobject> | ||
64 | </figure> | ||
65 | </note> | ||
66 | </section> | ||
67 | 35 | ||
68 | <section id="view_logs"> | 36 | <para>A success message is shown in the same window as shown below. |
69 | <title>View collected logs</title> | 37 | At this moment, the process of collecting logs on the uCPE device |
70 | 38 | starts.</para> | |
71 | <para>A list with the archives containing already collected logs will be | 39 | </listitem> |
72 | shown in the <literal>Device File Listing</literal> table:</para> | ||
73 | |||
74 | <orderedlist> | ||
75 | <listitem> | ||
76 | <para>Access <literal>Files</literal> -> | ||
77 | <literal>Download</literal>.</para> | ||
78 | </listitem> | ||
79 | |||
80 | <listitem> | ||
81 | <para>Press the <literal>List</literal> button.</para> | ||
82 | 40 | ||
83 | <figure> | 41 | <figure> |
84 | <title>Device File Listing Table</title> | 42 | <title>Collecting Debug Logs</title> |
85 | 43 | ||
86 | <mediaobject> | 44 | <mediaobject> |
87 | <imageobject> | 45 | <imageobject> |
88 | <imagedata align="center" contentwidth="500" | 46 | <imagedata align="center" contentwidth="500" |
89 | fileref="images/archive_list.png" /> | 47 | fileref="images/collect_debug_logs.png" /> |
90 | </imageobject> | 48 | </imageobject> |
91 | </mediaobject> | 49 | </mediaobject> |
92 | </figure> | 50 | </figure> |
93 | </listitem> | 51 | </orderedlist> |
94 | </orderedlist> | ||
95 | |||
96 | <note> | ||
97 | <para>If the filename you specified does not appear, it might still be | ||
98 | in the process of creation. Click on the <literal>Refresh</literal> icon | ||
99 | at the bottom of the table until you can see the desired file | ||
100 | listing.</para> | ||
101 | </note> | ||
102 | </section> | ||
103 | |||
104 | <section id="download_fr_dev"> | ||
105 | <title>Downloading Logs from the uCPE Device</title> | ||
106 | |||
107 | <para>This option transfers a debug file archive from the uCPE device to | ||
108 | uCPE Manager machine.</para> | ||
109 | |||
110 | <orderedlist> | ||
111 | <listitem> | ||
112 | <para>Access <literal>Files</literal> -> | ||
113 | <literal>Download</literal>.</para> | ||
114 | </listitem> | ||
115 | |||
116 | <listitem> | ||
117 | <para>Press the <literal>List</literal> button.</para> | ||
118 | </listitem> | ||
119 | |||
120 | <listitem> | ||
121 | <para>In the <literal>Device File Listing</literal> table, select the | ||
122 | archive you want to download from the uCPE device to uCPE | ||
123 | Manager.</para> | ||
124 | </listitem> | ||
125 | |||
126 | <listitem> | ||
127 | <para>Press the <literal>Download from Device</literal> button.</para> | ||
128 | |||
129 | <para>The archive will be downloaded from the uCPE device and stored | ||
130 | on the uCPE Machine.</para> | ||
131 | </listitem> | ||
132 | </orderedlist> | ||
133 | |||
134 | <note> | ||
135 | <para>The archive will not be deleted from the uCPE device after | ||
136 | download.</para> | ||
137 | </note> | ||
138 | </section> | ||
139 | |||
140 | <section id="download_logs_locally"> | ||
141 | <title>Downloading collected logs locally</title> | ||
142 | |||
143 | <para>This option downloads a logs archive from the uCPE Manager to a | ||
144 | local (user) machine for analysis. The archive must first be available in | ||
145 | the uCPE Manager in order to be downloaded.</para> | ||
146 | |||
147 | <orderedlist> | ||
148 | <listitem> | ||
149 | <para>Access <literal>Devices</literal> -> | ||
150 | <literal>Files</literal>.</para> | ||
151 | </listitem> | ||
152 | 52 | ||
153 | <listitem> | 53 | <note> |
154 | <para>Select the <literal>Downloaded Files</literal> tab.</para> | 54 | <para>It might take some time for the archive to be created. When the |
155 | </listitem> | 55 | operation completes, a "CollectLogsComplete" notification is sent from |
156 | 56 | the uCPE device to the uCPE Manager. This can be viewed in the GUI | |
157 | <listitem> | 57 | under the <literal>Faults</literal> -> <literal>Events</literal> |
158 | <para>Select an archive from <literal>Downloaded Files</literal> | 58 | toolbar menu.</para> |
159 | table.</para> | ||
160 | </listitem> | ||
161 | |||
162 | <listitem> | ||
163 | <para>Click the <literal>Download</literal> button.</para> | ||
164 | |||
165 | <para>The file will be downloaded in browser's download folder.</para> | ||
166 | 59 | ||
167 | <figure> | 60 | <figure> |
168 | <title>Downloaded Files Table</title> | 61 | <title>Collecting Debug Logs</title> |
169 | 62 | ||
170 | <mediaobject> | 63 | <mediaobject> |
171 | <imageobject> | 64 | <imageobject> |
172 | <imagedata align="center" contentwidth="500" | 65 | <imagedata align="center" contentwidth="500" |
173 | fileref="images/download_files.png" /> | 66 | fileref="images/fault_events.png" /> |
174 | </imageobject> | 67 | </imageobject> |
175 | </mediaobject> | 68 | </mediaobject> |
176 | </figure> | 69 | </figure> |
177 | </listitem> | 70 | </note> |
178 | </orderedlist> | 71 | </section> |
179 | </section> | 72 | |
180 | 73 | <section id="view_logs"> | |
181 | <section id="delete_log_archive_dev"> | 74 | <title>View collected logs</title> |
182 | <title>Deleting a logs archive from a uCPE device</title> | 75 | |
183 | 76 | <para>A list with the archives containing already collected logs will be | |
184 | <para>Use this option when you want to delete unnecessary collected logs | 77 | shown in the <literal>Device File Listing</literal> table:</para> |
185 | on the uCPE device.</para> | 78 | |
186 | 79 | <orderedlist> | |
187 | <orderedlist> | 80 | <listitem> |
188 | <listitem> | 81 | <para>Access <literal>Files</literal> -> |
189 | <para>Access <literal>Files</literal> -> | 82 | <literal>Download</literal>.</para> |
190 | <literal>Download</literal>.</para> | 83 | </listitem> |
191 | </listitem> | 84 | |
192 | 85 | <listitem> | |
193 | <listitem> | 86 | <para>Press the <literal>List</literal> button.</para> |
194 | <para>Press the <literal>List</literal> button.</para> | 87 | |
195 | </listitem> | 88 | <figure> |
196 | 89 | <title>Device File Listing Table</title> | |
197 | <listitem> | 90 | |
198 | <para>In the <literal>Device File Listing</literal> table, select the | 91 | <mediaobject> |
199 | archive you want to delete from the uCPE device.</para> | 92 | <imageobject> |
200 | </listitem> | 93 | <imagedata align="center" contentwidth="500" |
201 | 94 | fileref="images/archive_list.png" /> | |
202 | <listitem> | 95 | </imageobject> |
203 | <para>Press the <literal>Delete</literal> button.</para> | 96 | </mediaobject> |
204 | 97 | </figure> | |
205 | <para>The archive will be deleted from the uCPE device and the table | 98 | </listitem> |
206 | will be updated.</para> | 99 | </orderedlist> |
207 | </listitem> | 100 | |
208 | </orderedlist> | 101 | <note> |
209 | 102 | <para>If the filename you specified does not appear, it might still be | |
210 | <para>The same can be achieved using these alternative options:</para> | 103 | in the process of creation. Click on the <literal>Refresh</literal> |
211 | 104 | icon at the bottom of the table until you can see the desired file | |
212 | <orderedlist> | 105 | listing.</para> |
213 | <listitem> | 106 | </note> |
214 | <para>Access <literal>Operations</literal> -> <literal>Delete Debug | 107 | </section> |
215 | Log Archive</literal>.</para> | 108 | |
216 | </listitem> | 109 | <section id="download_fr_dev"> |
217 | 110 | <title>Downloading Logs from the uCPE Device</title> | |
218 | <listitem> | 111 | |
219 | <para>Provide a file name in the new window.</para> | 112 | <para>This option transfers a debug file archive from the uCPE device to |
220 | </listitem> | 113 | uCPE Manager machine.</para> |
221 | 114 | ||
222 | <listitem> | 115 | <orderedlist> |
223 | <para>Press the <literal>Execute</literal> button.</para> | 116 | <listitem> |
224 | 117 | <para>Access <literal>Files</literal> -> | |
225 | <para>A success message is displayed if the file is deleted from the | 118 | <literal>Download</literal>.</para> |
226 | uCPE device correctly.</para> | 119 | </listitem> |
227 | </listitem> | 120 | |
228 | </orderedlist> | 121 | <listitem> |
229 | </section> | 122 | <para>Press the <literal>List</literal> button.</para> |
230 | 123 | </listitem> | |
231 | <section id="delete_archives_ucpem"> | 124 | |
232 | <title>Deleting logs archives from the uCPE Manager</title> | 125 | <listitem> |
233 | 126 | <para>In the <literal>Device File Listing</literal> table, select | |
234 | <para>This option deletes a logs archive from the uCPE Manager.</para> | 127 | the archive you want to download from the uCPE device to uCPE |
235 | 128 | Manager.</para> | |
236 | <orderedlist> | 129 | </listitem> |
237 | <listitem> | 130 | |
238 | <para>Access <literal>Devices</literal> -> | 131 | <listitem> |
239 | <literal>Files</literal>.</para> | 132 | <para>Press the <literal>Download from Device</literal> |
240 | </listitem> | 133 | button.</para> |
241 | 134 | ||
242 | <listitem> | 135 | <para>The archive will be downloaded from the uCPE device and stored |
243 | <para>Select the <literal>Downloaded Files</literal> tab.</para> | 136 | on the uCPE Machine.</para> |
244 | </listitem> | 137 | </listitem> |
138 | </orderedlist> | ||
139 | |||
140 | <note> | ||
141 | <para>The archive will not be deleted from the uCPE device after | ||
142 | download.</para> | ||
143 | </note> | ||
144 | </section> | ||
145 | |||
146 | <section id="download_logs_locally"> | ||
147 | <title>Downloading collected logs locally</title> | ||
148 | |||
149 | <para>This option downloads a logs archive from the uCPE Manager to a | ||
150 | local (user) machine for analysis. The archive must first be available | ||
151 | in the uCPE Manager in order to be downloaded.</para> | ||
152 | |||
153 | <orderedlist> | ||
154 | <listitem> | ||
155 | <para>Access <literal>Devices</literal> -> | ||
156 | <literal>Files</literal>.</para> | ||
157 | </listitem> | ||
158 | |||
159 | <listitem> | ||
160 | <para>Select the <literal>Downloaded Files</literal> tab.</para> | ||
161 | </listitem> | ||
162 | |||
163 | <listitem> | ||
164 | <para>Select an archive from <literal>Downloaded Files</literal> | ||
165 | table.</para> | ||
166 | </listitem> | ||
167 | |||
168 | <listitem> | ||
169 | <para>Click the <literal>Download</literal> button.</para> | ||
170 | |||
171 | <para>The file will be downloaded in browser's download | ||
172 | folder.</para> | ||
173 | |||
174 | <figure> | ||
175 | <title>Downloaded Files Table</title> | ||
176 | |||
177 | <mediaobject> | ||
178 | <imageobject> | ||
179 | <imagedata align="center" contentwidth="500" | ||
180 | fileref="images/download_files.png" /> | ||
181 | </imageobject> | ||
182 | </mediaobject> | ||
183 | </figure> | ||
184 | </listitem> | ||
185 | </orderedlist> | ||
186 | </section> | ||
187 | |||
188 | <section id="delete_log_archive_dev"> | ||
189 | <title>Deleting a logs archive from a uCPE device</title> | ||
190 | |||
191 | <para>Use this option when you want to delete unnecessary collected logs | ||
192 | on the uCPE device.</para> | ||
193 | |||
194 | <orderedlist> | ||
195 | <listitem> | ||
196 | <para>Access <literal>Files</literal> -> | ||
197 | <literal>Download</literal>.</para> | ||
198 | </listitem> | ||
199 | |||
200 | <listitem> | ||
201 | <para>Press the <literal>List</literal> button.</para> | ||
202 | </listitem> | ||
203 | |||
204 | <listitem> | ||
205 | <para>In the <literal>Device File Listing</literal> table, select | ||
206 | the archive you want to delete from the uCPE device.</para> | ||
207 | </listitem> | ||
208 | |||
209 | <listitem> | ||
210 | <para>Press the <literal>Delete</literal> button.</para> | ||
211 | |||
212 | <para>The archive will be deleted from the uCPE device and the table | ||
213 | will be updated.</para> | ||
214 | </listitem> | ||
215 | </orderedlist> | ||
216 | |||
217 | <para>The same can be achieved using these alternative options:</para> | ||
218 | |||
219 | <orderedlist> | ||
220 | <listitem> | ||
221 | <para>Access <literal>Operations</literal> -> <literal>Delete | ||
222 | Debug Log Archive</literal>.</para> | ||
223 | </listitem> | ||
224 | |||
225 | <listitem> | ||
226 | <para>Provide a file name in the new window.</para> | ||
227 | </listitem> | ||
228 | |||
229 | <listitem> | ||
230 | <para>Press the <literal>Execute</literal> button.</para> | ||
231 | |||
232 | <para>A success message is displayed if the file is deleted from the | ||
233 | uCPE device correctly.</para> | ||
234 | </listitem> | ||
235 | </orderedlist> | ||
236 | </section> | ||
237 | |||
238 | <section id="delete_archives_ucpem"> | ||
239 | <title>Deleting logs archives from the uCPE Manager</title> | ||
240 | |||
241 | <para>This option deletes a logs archive from the uCPE Manager.</para> | ||
242 | |||
243 | <orderedlist> | ||
244 | <listitem> | ||
245 | <para>Access <literal>Devices</literal> -> | ||
246 | <literal>Files</literal>.</para> | ||
247 | </listitem> | ||
248 | |||
249 | <listitem> | ||
250 | <para>Select the <literal>Downloaded Files</literal> tab.</para> | ||
251 | </listitem> | ||
252 | |||
253 | <listitem> | ||
254 | <para>Select an archive from the <literal>Downloaded Files</literal> | ||
255 | table.</para> | ||
256 | </listitem> | ||
257 | |||
258 | <listitem> | ||
259 | <para>Click the <literal>Delete</literal> button.</para> | ||
260 | |||
261 | <para>The file will be deleted from the uCPE Manager and the table | ||
262 | will be updated.</para> | ||
263 | </listitem> | ||
264 | </orderedlist> | ||
265 | |||
266 | <note> | ||
267 | <para>Deleting the logs file from the uCPE Manager does not affect the | ||
268 | file located on the uCPE device.</para> | ||
269 | </note> | ||
270 | </section> | ||
271 | |||
272 | <section id="enable_disable_via_perms"> | ||
273 | <title>Enabling/Disabling of the Log Collector via Permissions</title> | ||
274 | |||
275 | <para>To disable the ability to access/download the uCPE device's | ||
276 | debug-log files from the uCPE Manager, the appropriate permissions must | ||
277 | be changed:</para> | ||
278 | |||
279 | <orderedlist> | ||
280 | <listitem> | ||
281 | <para>Access <literal>Security</literal> -> | ||
282 | <literal>Configuration</literal>.</para> | ||
283 | </listitem> | ||
284 | |||
285 | <listitem> | ||
286 | <para>Click the <literal>Security Groups</literal> tab.</para> | ||
287 | </listitem> | ||
288 | |||
289 | <listitem> | ||
290 | <para>Click the desired group.</para> | ||
291 | </listitem> | ||
292 | |||
293 | <listitem> | ||
294 | <para>Click the <literal>Permissions</literal> tab on the right | ||
295 | side.</para> | ||
296 | </listitem> | ||
297 | |||
298 | <listitem> | ||
299 | <para>Click the <literal>Devices</literal> tab like in the image | ||
300 | below.</para> | ||
301 | </listitem> | ||
302 | |||
303 | <listitem> | ||
304 | <para>Change the <literal>Device File Management</literal> option to | ||
305 | <literal>none</literal> to disable the feature.</para> | ||
306 | </listitem> | ||
307 | </orderedlist> | ||
245 | 308 | ||
246 | <listitem> | 309 | <figure> |
247 | <para>Select an archive from the <literal>Downloaded Files</literal> | 310 | <title>Device File Management</title> |
248 | table.</para> | ||
249 | </listitem> | ||
250 | |||
251 | <listitem> | ||
252 | <para>Click the <literal>Delete</literal> button.</para> | ||
253 | |||
254 | <para>The file will be deleted from the uCPE Manager and the table | ||
255 | will be updated.</para> | ||
256 | </listitem> | ||
257 | </orderedlist> | ||
258 | 311 | ||
259 | <note> | 312 | <mediaobject> |
260 | <para>Deleting the logs file from the uCPE Manager does not affect the | 313 | <imageobject> |
261 | file located on the uCPE device.</para> | 314 | <imagedata align="center" contentwidth="500" |
262 | </note> | 315 | fileref="images/dev_file_mg.png" /> |
263 | </section> | 316 | </imageobject> |
317 | </mediaobject> | ||
318 | </figure> | ||
319 | </section> | ||
320 | |||
321 | <section id="download_ucpemg_logs"> | ||
322 | <title>Downloading uCPE Manager logs</title> | ||
323 | |||
324 | <para>Often, sending the uCPE Manager logs together with collected uCPE | ||
325 | device logs to the support team provides important information for | ||
326 | troubleshooting (especially in cases of connectivity issues with the | ||
327 | uCPE device and error popups).</para> | ||
328 | |||
329 | <para>uCPE Manager log files are located in | ||
330 | <filename>application/logs/</filename> in the uCPE Manager's | ||
331 | installation folder | ||
332 | (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They | ||
333 | can be copied from that location, or they can be downloaded using the | ||
334 | uCPE Manager GUI by performing the following:</para> | ||
335 | |||
336 | <orderedlist> | ||
337 | <listitem> | ||
338 | <para>Access <literal>Test</literal> -> <literal>Debug | ||
339 | Settings</literal> and select the <literal>Log Files</literal> | ||
340 | tab.</para> | ||
341 | </listitem> | ||
342 | |||
343 | <listitem> | ||
344 | <para>Select the desired log file | ||
345 | (<filename>ucpemanager.log</filename> or | ||
346 | <filename>watchdog.log</filename>) and press the | ||
347 | <literal>Download</literal> button.</para> | ||
348 | </listitem> | ||
349 | |||
350 | <listitem> | ||
351 | <para>A new (blank) popup window opens and the file is downloaded | ||
352 | locally. This popup can be closed after the download.</para> | ||
353 | </listitem> | ||
354 | |||
355 | <listitem> | ||
356 | <para>Repeat steps 2. And 3. Until all the desired log files have | ||
357 | been downloaded</para> | ||
358 | </listitem> | ||
359 | </orderedlist> | ||
264 | 360 | ||
265 | <section id="enable_disable_via_perms"> | 361 | <figure> |
266 | <title>Enabling/Disabling of the Log Collector via Permissions</title> | 362 | <title>Debug Settings</title> |
267 | |||
268 | <para>To disable the ability to access/download the uCPE device's | ||
269 | debug-log files from the uCPE Manager, the appropriate permissions must be | ||
270 | changed:</para> | ||
271 | |||
272 | <orderedlist> | ||
273 | <listitem> | ||
274 | <para>Access <literal>Security</literal> -> | ||
275 | <literal>Configuration</literal>.</para> | ||
276 | </listitem> | ||
277 | |||
278 | <listitem> | ||
279 | <para>Click the <literal>Security Groups</literal> tab.</para> | ||
280 | </listitem> | ||
281 | |||
282 | <listitem> | ||
283 | <para>Click the desired group.</para> | ||
284 | </listitem> | ||
285 | |||
286 | <listitem> | ||
287 | <para>Click the <literal>Permissions</literal> tab on the right | ||
288 | side.</para> | ||
289 | </listitem> | ||
290 | |||
291 | <listitem> | ||
292 | <para>Click the <literal>Devices</literal> tab like in the image | ||
293 | below.</para> | ||
294 | </listitem> | ||
295 | |||
296 | <listitem> | ||
297 | <para>Change the <literal>Device File Management</literal> option to | ||
298 | <literal>none</literal> to disable the feature.</para> | ||
299 | </listitem> | ||
300 | </orderedlist> | ||
301 | |||
302 | <figure> | ||
303 | <title>Device File Management</title> | ||
304 | |||
305 | <mediaobject> | ||
306 | <imageobject> | ||
307 | <imagedata align="center" contentwidth="500" | ||
308 | fileref="images/dev_file_mg.png" /> | ||
309 | </imageobject> | ||
310 | </mediaobject> | ||
311 | </figure> | ||
312 | </section> | ||
313 | 363 | ||
314 | <section id="download_ucpemg_logs"> | 364 | <mediaobject> |
315 | <title>Downloading uCPE Manager logs</title> | 365 | <imageobject> |
316 | 366 | <imagedata align="center" contentwidth="500" | |
317 | <para>Often, sending the uCPE Manager logs together with collected uCPE | 367 | fileref="images/debug_settings.png" /> |
318 | device logs to the support team provides important information for | 368 | </imageobject> |
319 | troubleshooting (especially in cases of connectivity issues with the uCPE | 369 | </mediaobject> |
320 | device and error popups).</para> | 370 | </figure> |
321 | 371 | </section> | |
322 | <para>uCPE Manager log files are located in | ||
323 | <filename>application/logs/</filename> in the uCPE Manager's installation | ||
324 | folder (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). | ||
325 | They can be copied from that location, or they can be downloaded using the | ||
326 | uCPE Manager GUI by performing the following:</para> | ||
327 | |||
328 | <orderedlist> | ||
329 | <listitem> | ||
330 | <para>Access <literal>Test</literal> -> <literal>Debug | ||
331 | Settings</literal> and select the <literal>Log Files</literal> | ||
332 | tab.</para> | ||
333 | </listitem> | ||
334 | |||
335 | <listitem> | ||
336 | <para>Select the desired log file | ||
337 | (<filename>ucpemanager.log</filename> or | ||
338 | <filename>watchdog.log</filename>) and press the | ||
339 | <literal>Download</literal> button.</para> | ||
340 | </listitem> | ||
341 | |||
342 | <listitem> | ||
343 | <para>A new (blank) popup window opens and the file is downloaded | ||
344 | locally. This popup can be closed after the download.</para> | ||
345 | </listitem> | ||
346 | |||
347 | <listitem> | ||
348 | <para>Repeat steps 2. And 3. Until all the desired log files have been | ||
349 | downloaded</para> | ||
350 | </listitem> | ||
351 | </orderedlist> | ||
352 | |||
353 | <figure> | ||
354 | <title>Debug Settings</title> | ||
355 | |||
356 | <mediaobject> | ||
357 | <imageobject> | ||
358 | <imagedata align="center" contentwidth="500" | ||
359 | fileref="images/debug_settings.png" /> | ||
360 | </imageobject> | ||
361 | </mediaobject> | ||
362 | </figure> | ||
363 | </section> | 372 | </section> |
364 | 373 | ||
365 | <section id="log_collect_no_ucpem"> | 374 | <section id="log_collect_no_ucpem"> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml index b3173e6..fc2350a 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml | |||
@@ -90,14 +90,14 @@ | |||
90 | 90 | ||
91 | <entry><orderedlist> | 91 | <entry><orderedlist> |
92 | <listitem> | 92 | <listitem> |
93 | <para>Cleanup the current upgrade attempt with: </para> | 93 | <para>Cleanup the current upgrade attempt with:</para> |
94 | 94 | ||
95 | <programlisting>./cleanup.sh /opt/ems</programlisting> | 95 | <programlisting>./cleanup.sh /opt/ems</programlisting> |
96 | </listitem> | 96 | </listitem> |
97 | 97 | ||
98 | <listitem> | 98 | <listitem> |
99 | <para>Perform a installation with the restore option of a | 99 | <para>Perform a installation with the restore option of a |
100 | previous uCPE Manager configuration as described in </para> | 100 | previous uCPE Manager configuration as described in</para> |
101 | 101 | ||
102 | <remark>olink to the section/chapter describing: Installing | 102 | <remark>olink to the section/chapter describing: Installing |
103 | with the restore option.</remark> | 103 | with the restore option.</remark> |
@@ -117,7 +117,14 @@ | |||
117 | 117 | ||
118 | <listitem> | 118 | <listitem> |
119 | <para>Use the <literal>Reconnect</literal> button from the | 119 | <para>Use the <literal>Reconnect</literal> button from the |
120 | uCPE Manager's WEB-UI.</para> | 120 | uCPE Manager's GUI.</para> |
121 | </listitem> | ||
122 | |||
123 | <listitem> | ||
124 | <para>Connect to uCPE Device console and run the factory reset | ||
125 | script:</para> | ||
126 | |||
127 | <programlisting>/usr/local/odm/bin/factory_reset.sh</programlisting> | ||
121 | </listitem> | 128 | </listitem> |
122 | 129 | ||
123 | <listitem> | 130 | <listitem> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 4b1a7dc..23d2f1d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml | |||
@@ -9,6 +9,12 @@ | |||
9 | <section id="upgrade_mg"> | 9 | <section id="upgrade_mg"> |
10 | <title>Upgrading the uCPE Manager</title> | 10 | <title>Upgrading the uCPE Manager</title> |
11 | 11 | ||
12 | <note> | ||
13 | <para>It is recommended to create a system backup, by accessing from the | ||
14 | uCPE Manager GUI: <literal>System</literal> -> <literal>System | ||
15 | Backup</literal> for recovery in case of an upgrade failure.</para> | ||
16 | </note> | ||
17 | |||
12 | <orderedlist> | 18 | <orderedlist> |
13 | <listitem> | 19 | <listitem> |
14 | <para>Unzip the | 20 | <para>Unzip the |