summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2021-02-26 12:15:04 +0100
committerMiruna Paun <mrpa@enea.se>2021-02-26 13:11:57 +0100
commit0bc629f35e117d173decd1a21ecdd78daa8df601 (patch)
treea0b6654015e4cf70fd33139e2c021717eda5424c
parent58507abed96e1bfd96cbd6d2689774b5b87fa14e (diff)
downloadnfv-access-documentation-0bc629f35e117d173decd1a21ecdd78daa8df601.tar.gz
Updated the Getting Started Manual with a few key edits.
Change-Id: Ia2c25f865de87149828864d3af2c3ce3ff1c42f0 Signed-off-by: mrpa <miruna.paun@enea.com>
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml2
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml31
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml6
3 files changed, 21 insertions, 18 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 be4342f..a6f01bd 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
@@ -481,7 +481,7 @@ userdel postgres</programlisting>
481 </listitem> 481 </listitem>
482 482
483 <listitem> 483 <listitem>
484 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para> 484 <para>Enter <literal>&lt;uCPEM-installdir&gt;/dist</literal>.</para>
485 </listitem> 485 </listitem>
486 486
487 <listitem> 487 <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 1b714f2..69e3b5d 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
@@ -28,7 +28,7 @@
28 </listitem> 28 </listitem>
29 29
30 <listitem> 30 <listitem>
31 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para> 31 <para>Enter <literal>&lt;uCPEM-installdir&gt;/dist</literal>.</para>
32 </listitem> 32 </listitem>
33 33
34 <listitem> 34 <listitem>
@@ -53,7 +53,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
53 <para>Create a compressed file of the <literal>ucpemanager</literal> 53 <para>Create a compressed file of the <literal>ucpemanager</literal>
54 application folder 54 application folder
55 (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which 55 (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which
56 contains a snapshot of the existing installation.</para> 56 contains a snapshot of the existing installation in the
57 <literal>&lt;uCPEM-installdir&gt;/dist</literal> directory.</para>
57 58
58 <note> 59 <note>
59 <para>The snapshot file created during the upgrade can be used for 60 <para>The snapshot file created during the upgrade can be used for
@@ -70,6 +71,14 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
70 <para>Start the <literal>ucpemanager</literal> service.</para> 71 <para>Start the <literal>ucpemanager</literal> service.</para>
71 </listitem> 72 </listitem>
72 </itemizedlist> 73 </itemizedlist>
74
75 <para><olink
76 targetdoc="book_enea_nfv_access_getting_started"
77 targetptr="fresh_ucpemg_install">Fresh Installation of the Enea uCPE Manager in the
78 <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
79 xpointer="element(book_enea_nfv_access_getting_started/1)"
80 xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual contains information
81 about the input required to be entered during the execution of the upgrade script.</para>
73 82
74 <para>For an example on how to upgrade an Enea uCPE Manager installation in a 83 <para>For an example on how to upgrade an Enea uCPE Manager installation in a
75 High Availability setup, consult <olink 84 High Availability setup, consult <olink
@@ -101,11 +110,11 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
101 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) 110 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>)
102 created during a previous Enea uCPE Manager Upgrade or Enea uCPE 111 created during a previous Enea uCPE Manager Upgrade or Enea uCPE
103 Manager Uninstall Operation into the 112 Manager Uninstall Operation into the
104 <literal>&lt;uCPEM-installdir&gt;</literal> directory.</para> 113 <literal>&lt;uCPEM-installdir&gt;/dist</literal> directory.</para>
105 </listitem> 114 </listitem>
106 115
107 <listitem> 116 <listitem>
108 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para> 117 <para>Enter <literal>&lt;uCPEM-installdir&gt;/dist</literal>.</para>
109 </listitem> 118 </listitem>
110 119
111 <listitem> 120 <listitem>
@@ -144,8 +153,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
144 153
145 <orderedlist> 154 <orderedlist>
146 <listitem> 155 <listitem>
147 <para>Navigate to the folder where the Enea uCPE Manager is 156 <para>Navigate to the folder where the Enea uCPE Manager was
148 installed: <filename>&lt;uCPEM-installdir&gt;</filename>.</para> 157 unpacked: <filename>&lt;uCPEM-installdir&gt;/dist</filename>.</para>
149 </listitem> 158 </listitem>
150 159
151 <listitem> 160 <listitem>
@@ -259,10 +268,6 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
259 </listitem> 268 </listitem>
260 </itemizedlist> 269 </itemizedlist>
261 270
262 <para>Press <emphasis role="bold">Close</emphasis> when the message
263 <literal>File Uploaded Successfully</literal> appears on the <emphasis
264 role="bold">File Upload</emphasis> screen.</para>
265
266 <note> 271 <note>
267 <para>The uCPE Device upgrade is done with image files of the type 272 <para>The uCPE Device upgrade is done with image files of the type
268 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the 273 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the
@@ -385,7 +390,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
385 can accept an image file is populated when the image file is 390 can accept an image file is populated when the image file is
386 chosen.</para> 391 chosen.</para>
387 392
388 <para>Press the <emphasis role="bold">&gt;</emphasis> button to 393 <para>Mark the uCPE devices that you wish to upgrade and
394 press the <emphasis role="bold">&gt;</emphasis> button to
389 move the uCPE devices to the right side of the selector. Those 395 move the uCPE devices to the right side of the selector. Those
390 chosen form the list of uCPE devices that will be upgraded.</para> 396 chosen form the list of uCPE devices that will be upgraded.</para>
391 </listitem> 397 </listitem>
@@ -414,6 +420,9 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
414 </listitem> 420 </listitem>
415 </itemizedlist> 421 </itemizedlist>
416 </listitem> 422 </listitem>
423
424 <listitem><para>To start the upgrade, click
425 <emphasis role="bold">ok</emphasis>.</para></listitem>
417 </itemizedlist> 426 </itemizedlist>
418 427
419 <note> 428 <note>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
index e8c65eb..8690818 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
@@ -123,12 +123,6 @@
123 <listitem> 123 <listitem>
124 <para>Click the <emphasis role="bold">On-board</emphasis> button.</para> 124 <para>Click the <emphasis role="bold">On-board</emphasis> button.</para>
125 </listitem> 125 </listitem>
126
127 <listitem>
128 <para>When prompted by the UI, make sure the <emphasis role="bold">VM
129 Image</emphasis> radio button at the top of the onboarding screen is
130 selected, it will trigger a popup menu window.</para>
131 </listitem>
132 </orderedlist> 126 </orderedlist>
133 127
134 <para>This window contains data fields where both necessary and optional 128 <para>This window contains data fields where both necessary and optional