diff options
3 files changed, 95 insertions, 53 deletions
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 2590dec..80ae36b 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 | |||
@@ -291,9 +291,13 @@ userdel postgres</programlisting> | |||
291 | </listitem> | 291 | </listitem> |
292 | 292 | ||
293 | <listitem> | 293 | <listitem> |
294 | <para>Follow the installation instruction for the uCPE Manager | 294 | <para>Follow the installation steps for the uCPE Manager available |
295 | available in section <remark>add olink to section with ID | 295 | in <olink targetdoc="book_enea_nfv_access_getting_started" |
296 | "install_ucpe_mg"</remark></para> | 296 | targetptr="install_ucpe_mg">Installing the uCPE Manager in the |
297 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
298 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
299 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
300 | Manual.</para> | ||
297 | </listitem> | 301 | </listitem> |
298 | </orderedlist> | 302 | </orderedlist> |
299 | </section> | 303 | </section> |
@@ -401,7 +405,7 @@ userdel postgres</programlisting> | |||
401 | 405 | ||
402 | <orderedlist> | 406 | <orderedlist> |
403 | <listitem> | 407 | <listitem> |
404 | <para>Unzip | 408 | <para>Extract |
405 | <literal>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</literal></para> | 409 | <literal>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</literal></para> |
406 | 410 | ||
407 | <para>The directory in which the archive has been unpacked will be | 411 | <para>The directory in which the archive has been unpacked will be |
@@ -430,15 +434,15 @@ userdel postgres</programlisting> | |||
430 | <programlisting>./install.sh /opt/ems \ | 434 | <programlisting>./install.sh /opt/ems \ |
431 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | 435 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> |
432 | 436 | ||
433 | <para>Use the default configuration values specified below in the | 437 | <para>The default configuration values are specified in brackets. |
434 | interactive install command in brackets. For these types of | 438 | If no other value is preferred and typed in, pressing |
435 | entries, pressing <literal>ENTER</literal> will suffice. When | 439 | <literal>ENTER</literal> will keep the default values. When there |
436 | there is an option within brackets (i.e. Y/N), a value must be | 440 | is an option within parentheses (i.e.Y/N), a value must be |
437 | specified.</para> | 441 | specified.</para> |
438 | 442 | ||
439 | <note> | 443 | <note> |
440 | <para>The same configuration values will need to be provided | 444 | <para>The same configuration values set now will need to be |
441 | when upgrading or uninstalling the uCPE Manager.</para> | 445 | provided when upgrading or uninstalling the uCPE Manager.</para> |
442 | </note> | 446 | </note> |
443 | 447 | ||
444 | <itemizedlist> | 448 | <itemizedlist> |
@@ -453,32 +457,32 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
453 | 457 | ||
454 | <listitem> | 458 | <listitem> |
455 | <para>Specify the database process password | 459 | <para>Specify the database process password |
456 | <literal>[postgres]</literal></para> | 460 | <literal>[postgres]:</literal></para> |
457 | </listitem> | 461 | </listitem> |
458 | 462 | ||
459 | <listitem> | 463 | <listitem> |
460 | <para>Specify the database ID (or name) | 464 | <para>Specify the database ID (or name) |
461 | <literal>[ucpemanager]</literal></para> | 465 | <literal>[ucpemanager]:</literal></para> |
462 | </listitem> | 466 | </listitem> |
463 | 467 | ||
464 | <listitem> | 468 | <listitem> |
465 | <para>Specify the database server port | 469 | <para>Specify the database server port |
466 | <literal>[5432]</literal></para> | 470 | <literal>[5432]:</literal></para> |
467 | </listitem> | 471 | </listitem> |
468 | 472 | ||
469 | <listitem> | 473 | <listitem> |
470 | <para>Specify the database user name | 474 | <para>Specify a database user name |
471 | <literal>[postgres]</literal></para> | 475 | <literal>[postgres]:</literal></para> |
472 | </listitem> | 476 | </listitem> |
473 | 477 | ||
474 | <listitem> | 478 | <listitem> |
475 | <para>Specify database password | 479 | <para>Specify a database password |
476 | <literal>[postgres]</literal></para> | 480 | <literal>[postgres]:</literal></para> |
477 | </listitem> | 481 | </listitem> |
478 | 482 | ||
479 | <listitem> | 483 | <listitem> |
480 | <para>Specify database startup thread pool size | 484 | <para>Specify the database startup thread pool size |
481 | <literal>[1]</literal></para> | 485 | <literal>[1]:</literal></para> |
482 | </listitem> | 486 | </listitem> |
483 | </itemizedlist> | 487 | </itemizedlist> |
484 | </listitem> | 488 | </listitem> |
@@ -488,13 +492,13 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
488 | 492 | ||
489 | <itemizedlist spacing="compact"> | 493 | <itemizedlist spacing="compact"> |
490 | <listitem> | 494 | <listitem> |
491 | <para>Specify service username | 495 | <para>Specify a service username |
492 | [<literal>ucpemanager</literal>]</para> | 496 | [<literal>ucpemanager</literal>]:</para> |
493 | </listitem> | 497 | </listitem> |
494 | 498 | ||
495 | <listitem> | 499 | <listitem> |
496 | <para>Specify service password | 500 | <para>Specify a service password |
497 | <literal>[ucpemanager</literal>]</para> | 501 | <literal>[ucpemanager</literal>]:</para> |
498 | </listitem> | 502 | </listitem> |
499 | </itemizedlist> | 503 | </itemizedlist> |
500 | </listitem> | 504 | </listitem> |
@@ -521,8 +525,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
521 | 525 | ||
522 | <itemizedlist spacing="compact"> | 526 | <itemizedlist spacing="compact"> |
523 | <listitem> | 527 | <listitem> |
524 | <para>Please enter the new Maximum Heap Size: <literal>4 | 528 | <para>Please enter the new Maximum Heap Size |
525 | GB</literal>.</para> | 529 | [<literal>4g]</literal>:</para> |
526 | </listitem> | 530 | </listitem> |
527 | </itemizedlist> | 531 | </itemizedlist> |
528 | </listitem> | 532 | </listitem> |
@@ -588,8 +592,14 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
588 | different from the uCPE Manager snapshot obtained during a uCPE | 592 | different from the uCPE Manager snapshot obtained during a uCPE |
589 | Manager Upgrade or Uninstall operation | 593 | Manager Upgrade or Uninstall operation |
590 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed | 594 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed |
591 | for recovery of the uCPE Manager.<remark>add olink to section with | 595 | for recovery of the uCPE Manager. For more details please see <olink |
592 | id "restore_prev_ucpe_install"</remark></para> | 596 | targetdoc="book_enea_nfv_access_getting_started" |
597 | targetptr="restore_prev_ucpe_install">Restoring a previous uCPE | ||
598 | Manager installation in the <xi:include | ||
599 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
600 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
601 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
602 | Manual.</para> | ||
593 | </note> | 603 | </note> |
594 | 604 | ||
595 | <para>To install the uCPE Manager with the restore option provide an | 605 | <para>To install the uCPE Manager with the restore option provide an |
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 fc2350a..9bf8822 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml | |||
@@ -4,9 +4,13 @@ | |||
4 | 4 | ||
5 | <para>The following is a small list of possible NFV Access problems, and | 5 | <para>The following is a small list of possible NFV Access problems, and |
6 | their solutions. <emphasis role="bold">In all scenarios collect the logs if | 6 | their solutions. <emphasis role="bold">In all scenarios collect the logs if |
7 | possible for a later debugging.</emphasis> More information on log | 7 | possible for debugging.</emphasis> More information on log collecting can be |
8 | collecting can be found in <remark>add an olink to the log collector chapter | 8 | found in <olink targetdoc="book_enea_nfv_access_getting_started" |
9 | after the olink update</remark>.</para> | 9 | targetptr="log_collector">Using the Log Collector in the <xi:include |
10 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
11 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
12 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
13 | Manual.</para> | ||
10 | 14 | ||
11 | <para>If you encounter other issues or can't get NFV Access to work | 15 | <para>If you encounter other issues or can't get NFV Access to work |
12 | successfully after consulting the information below, please use the <olink | 16 | successfully after consulting the information below, please use the <olink |
@@ -14,7 +18,7 @@ | |||
14 | targetptr="contacting_enea_support">Enea Support team Form, available in the | 18 | targetptr="contacting_enea_support">Enea Support team Form, available in the |
15 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 19 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
16 | xmlns:xi="http://www.w3.org/2001/XInclude" | 20 | xmlns:xi="http://www.w3.org/2001/XInclude" |
17 | xpointer="element(book_enea_nfv_access_release_info/1)" /></olink> manual | 21 | xpointer="element(book_enea_nfv_access_release_info/1)" /></olink> Manual |
18 | downloaded with your release.</para> | 22 | downloaded with your release.</para> |
19 | 23 | ||
20 | <table> | 24 | <table> |
@@ -43,9 +47,14 @@ | |||
43 | </listitem> | 47 | </listitem> |
44 | 48 | ||
45 | <listitem> | 49 | <listitem> |
46 | <para>Reinitiate the Upgrade procedure according to | 50 | <para>Reinitiate the Upgrade procedure according to the steps |
47 | <remark>(Link to NFV Access Getting Started -Device | 51 | in section <olink |
48 | Upgrade)</remark>.</para> | 52 | targetdoc="book_enea_nfv_access_getting_started" |
53 | targetptr="upgrade_devices">uCPE device upgrades in the | ||
54 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
55 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
56 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
57 | Manual.</para> | ||
49 | </listitem> | 58 | </listitem> |
50 | </orderedlist></entry> | 59 | </orderedlist></entry> |
51 | </row> | 60 | </row> |
@@ -56,9 +65,13 @@ | |||
56 | 65 | ||
57 | <entry>Reinstall NFV Access on the uCPE device and redeploy the | 66 | <entry>Reinstall NFV Access on the uCPE device and redeploy the |
58 | initial configuration and virtualized services, by following the | 67 | initial configuration and virtualized services, by following the |
59 | Getting Started Guide.<remark>add link to Install uCPE Device. | 68 | steps in <olink targetdoc="book_enea_nfv_access_getting_started" |
60 | Retitle it if need be or point to specific chapter in book with | 69 | targetptr="install_ena_device">Installing Enea NFV Access - uCPE |
61 | olink</remark></entry> | 70 | Device installation in the <xi:include |
71 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
72 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
73 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
74 | Manual.</entry> | ||
62 | </row> | 75 | </row> |
63 | 76 | ||
64 | <row> | 77 | <row> |
@@ -76,17 +89,21 @@ | |||
76 | </listitem> | 89 | </listitem> |
77 | 90 | ||
78 | <listitem> | 91 | <listitem> |
79 | <para>Restore the previous installation as described in</para> | 92 | <para>Restore the previous installation as described in <olink |
80 | 93 | targetdoc="book_enea_nfv_access_getting_started" | |
81 | <remark>olink to the section/chapter: link to Restore a | 94 | targetptr="restore_prev_ucpe_install">Restoring a previous |
82 | previous uCPE Manager Installation</remark> | 95 | uCPE Manager installation in the <xi:include |
96 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
97 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
98 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
99 | Manual.</para> | ||
83 | </listitem> | 100 | </listitem> |
84 | </orderedlist></entry> | 101 | </orderedlist></entry> |
85 | </row> | 102 | </row> |
86 | 103 | ||
87 | <row> | 104 | <row> |
88 | <entry>The uCPE Manager upgrade fails and no working snapshot is | 105 | <entry>The uCPE Manager upgrade fails and no working snapshot is |
89 | available.</entry> | 106 | available, but a System Back-up file exists.</entry> |
90 | 107 | ||
91 | <entry><orderedlist> | 108 | <entry><orderedlist> |
92 | <listitem> | 109 | <listitem> |
@@ -96,11 +113,15 @@ | |||
96 | </listitem> | 113 | </listitem> |
97 | 114 | ||
98 | <listitem> | 115 | <listitem> |
99 | <para>Perform a installation with the restore option of a | 116 | <para>Perform an installation with the restore option of a |
100 | previous uCPE Manager configuration as described in</para> | 117 | previous uCPE Manager configuration as described in <olink |
101 | 118 | targetdoc="book_enea_nfv_access_getting_started" | |
102 | <remark>olink to the section/chapter describing: Installing | 119 | targetptr="install_ucpemg_from_backup">Installation of the |
103 | with the restore option.</remark> | 120 | uCPE Manager using a System Back-up in the <xi:include |
121 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
122 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
123 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
124 | Manual.</para> | ||
104 | </listitem> | 125 | </listitem> |
105 | </orderedlist></entry> | 126 | </orderedlist></entry> |
106 | </row> | 127 | </row> |
@@ -129,8 +150,14 @@ | |||
129 | 150 | ||
130 | <listitem> | 151 | <listitem> |
131 | <para>If the above actions do not work, reinstall and | 152 | <para>If the above actions do not work, reinstall and |
132 | reconfigure the device using the steps provided in the | 153 | reconfigure the device using the steps provided in <olink |
133 | <remark>Installing the uCPE device (add link)</remark></para> | 154 | targetdoc="book_enea_nfv_access_getting_started" |
155 | targetptr="install_ena_device">Installing Enea NFV Access - | ||
156 | uCPE Device installation in the <xi:include | ||
157 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
158 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
159 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
160 | Manual.</para> | ||
134 | </listitem> | 161 | </listitem> |
135 | </orderedlist></entry> | 162 | </orderedlist></entry> |
136 | </row> | 163 | </row> |
@@ -141,8 +168,13 @@ | |||
141 | 168 | ||
142 | <entry>Perform a hardware reboot on the uCPE device. If the problem | 169 | <entry>Perform a hardware reboot on the uCPE device. If the problem |
143 | is not fixed, reinstall and reconfigure the device using the steps | 170 | is not fixed, reinstall and reconfigure the device using the steps |
144 | provided in the <remark>Installing the uCPE device (add | 171 | provided in <olink targetdoc="book_enea_nfv_access_getting_started" |
145 | link)</remark></entry> | 172 | targetptr="install_ena_device">Installing Enea NFV Access - uCPE |
173 | Device installation in the <xi:include | ||
174 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
175 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
176 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
177 | Manual.</entry> | ||
146 | </row> | 178 | </row> |
147 | 179 | ||
148 | <row> | 180 | <row> |
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 61e1306..0876709 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 | |||
@@ -17,7 +17,7 @@ | |||
17 | 17 | ||
18 | <orderedlist> | 18 | <orderedlist> |
19 | <listitem> | 19 | <listitem> |
20 | <para>Unzip the | 20 | <para>Extract the |
21 | <filename>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</filename> | 21 | <filename>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</filename> |
22 | folder.</para> | 22 | folder.</para> |
23 | 23 | ||
@@ -77,7 +77,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
77 | 77 | ||
78 | <orderedlist> | 78 | <orderedlist> |
79 | <listitem> | 79 | <listitem> |
80 | <para>Unzip | 80 | <para>Extract |
81 | <filename>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</filename></para> | 81 | <filename>Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</filename></para> |
82 | </listitem> | 82 | </listitem> |
83 | 83 | ||