summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2020-12-03 14:39:59 +0100
committerMiruna Paun <mrpa@enea.se>2020-12-03 16:19:29 +0200
commit53035de4d6011e56a06f64399cf1ab1f74aa707a (patch)
tree1216b830d65df64447bd0344efe725f2350a05ff
parent240f4c7b75d836dd6135ff2763cf46ac4a9d8ee9 (diff)
downloadnfv-access-documentation-53035de4d6011e56a06f64399cf1ab1f74aa707a.tar.gz
Updated pictures and titles with CapitalizationEnea_NFV_Access_2.3.0_RC3
in Getting Started. Change-Id: I08afe7fc1e0fe3a753b144bc2fad21fe1a9597a2 Signed-off-by: mrpa <miruna.paun@enea.com>
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.pngbin141376 -> 133962 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_execution.pngbin132829 -> 128469 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml61
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/log_collector.xml10
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml15
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml14
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml2
7 files changed, 49 insertions, 53 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png b/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
index 67b96a9..4cd5015 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
Binary files differ
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 f589495..5851621 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 acd53b4..d7771ca 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
@@ -8,7 +8,7 @@
8 scenarios.</para> 8 scenarios.</para>
9 9
10 <section id="hw_reqs"> 10 <section id="hw_reqs">
11 <title>Hardware requirements</title> 11 <title>Hardware Requirements</title>
12 12
13 <para>The following hardware is needed for deploying the base 13 <para>The following hardware is needed for deploying the base
14 configuration:</para> 14 configuration:</para>
@@ -306,7 +306,7 @@ userdel postgres</programlisting>
306 </section> 306 </section>
307 307
308 <section id="ucpe_config"> 308 <section id="ucpe_config">
309 <title>uCPE Device configuration</title> 309 <title>uCPE Device Configuration</title>
310 310
311 <section id="wan_lan_ports"> 311 <section id="wan_lan_ports">
312 <title>Determining the WAN and LAN ports</title> 312 <title>Determining the WAN and LAN ports</title>
@@ -322,7 +322,7 @@ userdel postgres</programlisting>
322 </section> 322 </section>
323 323
324 <section id="ucpe_identifier"> 324 <section id="ucpe_identifier">
325 <title>Determining the DeviceId</title> 325 <title>Determining the Device ID</title>
326 326
327 <para>Each uCPE device needs a unique identifier. This identifier is 327 <para>Each uCPE device needs a unique identifier. This identifier is
328 used to match the registration in the Enea uCPE Manager and the offline 328 used to match the registration in the Enea uCPE Manager and the offline
@@ -390,7 +390,7 @@ userdel postgres</programlisting>
390 </section> 390 </section>
391 391
392 <section id="prep_deploy"> 392 <section id="prep_deploy">
393 <title>Preparing the deployment</title> 393 <title>Preparing the Deployment</title>
394 394
395 <section id="install_ucpe_mg"> 395 <section id="install_ucpe_mg">
396 <title>Installing the Enea uCPE Manager</title> 396 <title>Installing the Enea uCPE Manager</title>
@@ -669,7 +669,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
669 </section> 669 </section>
670 670
671 <section id="prep_phys_deploy"> 671 <section id="prep_phys_deploy">
672 <title>Preparing physical deployment for installation</title> 672 <title>Preparing Physical Deployment for Installation</title>
673 673
674 <figure> 674 <figure>
675 <title>Preparing for Hardware Installation</title> 675 <title>Preparing for Hardware Installation</title>
@@ -688,7 +688,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
688 </section> 688 </section>
689 689
690 <section id="install_ena_device"> 690 <section id="install_ena_device">
691 <title>Installing Enea NFV Access - uCPE Device installation</title> 691 <title>Installing Enea NFV Access - uCPE Device Installation</title>
692 692
693 <para>To initiate the installation of the Enea NFV Access Run Time 693 <para>To initiate the installation of the Enea NFV Access Run Time
694 Platform do the following:</para> 694 Platform do the following:</para>
@@ -776,14 +776,14 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
776 on the Enea uCPE Manager, as described below.</para> 776 on the Enea uCPE Manager, as described below.</para>
777 777
778 <note> 778 <note>
779 <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is 779 <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is
780 automatically created and the system will start booting from the 780 automatically created and the system will start booting from the hard
781 hard drive without further user configuration.</para> 781 drive without further user configuration.</para>
782 </note> 782 </note>
783 </section> 783 </section>
784 784
785 <section id="prep_phys_exec"> 785 <section id="prep_phys_exec">
786 <title>Preparing physical deployment for execution</title> 786 <title>Preparing Physical Deployment for Execution</title>
787 787
788 <figure> 788 <figure>
789 <title>Preparing for Deployment Execution</title> 789 <title>Preparing for Deployment Execution</title>
@@ -937,36 +937,23 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
937 ID</literal>, the installation is complete, and the connection is 937 ID</literal>, the installation is complete, and the connection is
938 established.</para> 938 established.</para>
939 939
940 <note>
941 <para>In case of failure due to a misconfiguration or if a uCPE device
942 does not appear in the Enea uCPE Manager, a reinstallation is needed
943 .The user should remove all WAN cables, reinsert the USB stick,
944 reconnect the laptop using the ethernet cable, reboot the uCPE device
945 and then access the Web-installer
946 (<literal>http://172.16.1.1</literal>).</para>
947
948 <para>In case of management connection failure (e.g. due to a
949 misconfiguration), the uCPE device status will be seen as RED
950 (disconnected) in Enea uCPE Manager. Please check the accuracy of the
951 information provided when the uCPE device was registered in the Enea
952 uCPE Manager.</para>
953
954 <para>The uCPE device configuration can be amended. In order to do
955 that, please remove the WAN cable(s), reconnect the laptop to the LAN
956 interface of the uCPE device and reboot it. At this point, the
957 Web-installer can be accessed from the laptop as described in <olink
958 targetdoc="book_enea_nfv_access_getting_started"
959 targetptr="install_ena_device">Installing Enea NFV Access - uCPE
960 Device installation in the <xi:include
961 href="../../s_docbuild/olinkdb/pardoc-names.xml"
962 xmlns:xi="http://www.w3.org/2001/XInclude"
963 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
964 Manual.</para>
965 </note>
966
967 <para>When a uCPE device is registered it can be manually added to the 940 <para>When a uCPE device is registered it can be manually added to the
968 map for overview. Right-click on the map and select <literal>Place 941 map for overview. Right-click on the map and select <literal>Place
969 Device</literal> to put the uCPE device on the map.</para> 942 Device</literal> to put the uCPE device on the map.</para>
943
944 <para>In case of management connection failure (e.g. due to a
945 misconfiguration), the uCPE device status will be seen as RED
946 (disconnected) in the Enea uCPE Manager. The uCPE device configuration
947 can be corrected by removing the WAN cable(s), reconnecting the laptop
948 to the LAN interface of the uCPE device and rebooting it. At this point,
949 the Web-installer can be accessed from the laptop as described in <olink
950 targetdoc="book_enea_nfv_access_getting_started"
951 targetptr="install_ena_device">Installing Enea NFV Access - uCPE Device
952 installation in the <xi:include
953 href="../../s_docbuild/olinkdb/pardoc-names.xml"
954 xmlns:xi="http://www.w3.org/2001/XInclude"
955 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
956 Manual.</para>
970 </section> 957 </section>
971 </section> 958 </section>
972 959
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 1c66db0..8b8be31 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
@@ -71,7 +71,7 @@
71 </section> 71 </section>
72 72
73 <section id="view_logs"> 73 <section id="view_logs">
74 <title>View collected logs</title> 74 <title>View collected Logs</title>
75 75
76 <para>A list with the archives containing already collected logs will be 76 <para>A list with the archives containing already collected logs will be
77 shown in the <literal>Device File Listing</literal> table:</para> 77 shown in the <literal>Device File Listing</literal> table:</para>
@@ -144,7 +144,7 @@
144 </section> 144 </section>
145 145
146 <section id="download_logs_locally"> 146 <section id="download_logs_locally">
147 <title>Downloading collected logs locally</title> 147 <title>Downloading collected Logs locally</title>
148 148
149 <para>This option downloads a logs archive from the Enea uCPE Manager to 149 <para>This option downloads a logs archive from the Enea uCPE Manager to
150 a local (user) machine for analysis. The archive must first be available 150 a local (user) machine for analysis. The archive must first be available
@@ -186,7 +186,7 @@
186 </section> 186 </section>
187 187
188 <section id="delete_log_archive_dev"> 188 <section id="delete_log_archive_dev">
189 <title>Deleting a logs archive from a uCPE device</title> 189 <title>Deleting a Logs Archive from a uCPE device</title>
190 190
191 <para>Use this option when you want to delete unnecessary collected logs 191 <para>Use this option when you want to delete unnecessary collected logs
192 on the uCPE device.</para> 192 on the uCPE device.</para>
@@ -236,7 +236,7 @@
236 </section> 236 </section>
237 237
238 <section id="delete_archives_ucpem"> 238 <section id="delete_archives_ucpem">
239 <title>Deleting logs archives from the Enea uCPE Manager</title> 239 <title>Deleting a Logs Archive from the Enea uCPE Manager</title>
240 240
241 <para>This option deletes a logs archive from the Enea uCPE 241 <para>This option deletes a logs archive from the Enea uCPE
242 Manager.</para> 242 Manager.</para>
@@ -320,7 +320,7 @@
320 </section> 320 </section>
321 321
322 <section id="download_ucpemg_logs"> 322 <section id="download_ucpemg_logs">
323 <title>Downloading Enea uCPE Manager logs</title> 323 <title>Downloading Enea uCPE Manager Logs</title>
324 324
325 <para>Often, sending the Enea uCPE Manager logs together with collected 325 <para>Often, sending the Enea uCPE Manager logs together with collected
326 uCPE device logs to the support team provides important information for 326 uCPE device logs to the support team provides important information for
diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
index 873dc28..effe3da 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
@@ -6,7 +6,7 @@
6 uCPE Manager GUI.</para> 6 uCPE Manager GUI.</para>
7 7
8 <section id="device_callhome_nat"> 8 <section id="device_callhome_nat">
9 <title>Device Call Home Connection for deployment behind NAT</title> 9 <title>Device Call Home Connection for Deployment behind NAT</title>
10 10
11 <para>The Device Call Home option enables the initiation of the connection 11 <para>The Device Call Home option enables the initiation of the connection
12 between the uCPE Device and the Enea uCPE Manager, from the uCPE device. 12 between the uCPE Device and the Enea uCPE Manager, from the uCPE device.
@@ -228,6 +228,15 @@
228 </figure> 228 </figure>
229 </listitem> 229 </listitem>
230 </orderedlist> 230 </orderedlist>
231
232 <note>
233 <para>When changing the <literal>address-assignment</literal> from
234 static to DHCP, if any of the <literal>ip-address</literal>,
235 <literal>netmask</literal> or <literal>gateway</literal> fields
236 have invalid values a validation error will be triggered.
237 These fields must be empty or have the valid values for their
238 respective address assignment.</para>
239 </note>
231 </section> 240 </section>
232 241
233 <section id="man_configuration"> 242 <section id="man_configuration">
@@ -389,7 +398,7 @@
389 </section> 398 </section>
390 399
391 <section id="dataplane_bridge"> 400 <section id="dataplane_bridge">
392 <title>Data-plane Bridge</title> 401 <title>Data-plane bridge</title>
393 402
394 <para>Data-plane bridges are generic bridges used for the VNF 403 <para>Data-plane bridges are generic bridges used for the VNF
395 data-plane. There are two supported sub-types:</para> 404 data-plane. There are two supported sub-types:</para>
@@ -428,7 +437,7 @@
428 </section> 437 </section>
429 438
430 <section id="zero_touch_prov"> 439 <section id="zero_touch_prov">
431 <title>Zero Touch Provisioning - Creating an offline configuration</title> 440 <title>Zero Touch Provisioning - Creating an Offline Configuration</title>
432 441
433 <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device 442 <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device
434 starts up for the first time and its initial configuration is pushed down 443 starts up for the first time and its initial configuration is pushed down
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 3706548..42589e0 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
@@ -71,7 +71,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
71 </itemizedlist> 71 </itemizedlist>
72 72
73 <section id="restore_prev_ucpe_install"> 73 <section id="restore_prev_ucpe_install">
74 <title>Restoring a previous Enea uCPE Manager installation</title> 74 <title>Restoring a previous Enea uCPE Manager Installation</title>
75 75
76 <para><emphasis role="bold">How to restore a previous Enea uCPE Manager 76 <para><emphasis role="bold">How to restore a previous Enea uCPE Manager
77 installation</emphasis></para> 77 installation</emphasis></para>
@@ -128,7 +128,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
128 </section> 128 </section>
129 129
130 <section id="uninstall_ucpem_install"> 130 <section id="uninstall_ucpem_install">
131 <title>Uninstalling an existing Enea uCPE Manager installation</title> 131 <title>Uninstalling an existing Enea uCPE Manager Installation</title>
132 132
133 <para><emphasis role="bold">How to uninstall an existing Enea uCPE 133 <para><emphasis role="bold">How to uninstall an existing Enea uCPE
134 Manager installation</emphasis></para> 134 Manager installation</emphasis></para>
@@ -190,13 +190,13 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
190 </section> 190 </section>
191 191
192 <section id="upgrade_devices"> 192 <section id="upgrade_devices">
193 <title>uCPE device upgrades</title> 193 <title>uCPE device Upgrades</title>
194 194
195 <para>A uCPE device can be upgraded using the Enea uCPE Manager 195 <para>A uCPE device can be upgraded using the Enea uCPE Manager
196 GUI.</para> 196 GUI.</para>
197 197
198 <section id="device_up_process"> 198 <section id="device_up_process">
199 <title>The uCPE device upgrade process</title> 199 <title>The uCPE device Upgrade Process</title>
200 200
201 <para>The Device Upgrade/Install option performs the following 201 <para>The Device Upgrade/Install option performs the following
202 operations to the uCPE device:</para> 202 operations to the uCPE device:</para>
@@ -220,7 +220,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
220 </section> 220 </section>
221 221
222 <section id="mg_upgrade"> 222 <section id="mg_upgrade">
223 <title>Managing the Device Upgrade</title> 223 <title>Managing the device Upgrade</title>
224 224
225 <para>Before an installation or upgrade can be completed, certain 225 <para>Before an installation or upgrade can be completed, certain
226 configuration data must be set. Files also need to be uploaded to the 226 configuration data must be set. Files also need to be uploaded to the
@@ -419,7 +419,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
419 </section> 419 </section>
420 420
421 <section id="upgrade_status"> 421 <section id="upgrade_status">
422 <title>uCPE device upgrade status</title> 422 <title>uCPE device Upgrade Status</title>
423 423
424 <para>The status of the installation and upgrade can be viewed in the 424 <para>The status of the installation and upgrade can be viewed in the
425 <literal>Upgrade Operations</literal> tab. Ongoing or scheduled 425 <literal>Upgrade Operations</literal> tab. Ongoing or scheduled
@@ -524,7 +524,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
524 </section> 524 </section>
525 525
526 <section id="related_functionality"> 526 <section id="related_functionality">
527 <title>Related Functionality for a uCPE device upgrade</title> 527 <title>Related Functionality for a uCPE device Upgrade</title>
528 528
529 <para>Each uCPE device can receive image files and use them to 529 <para>Each uCPE device can receive image files and use them to
530 upgrade. This can be done by selecting the uCPE device in the 530 upgrade. This can be done by selecting the uCPE device in the
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 dd90884..2dfe248 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
@@ -445,7 +445,7 @@
445 SSH</literal> configuration panel. By default, the start port will 445 SSH</literal> configuration panel. By default, the start port will
446 be <literal>7000</literal> and the maximum number of ports 446 be <literal>7000</literal> and the maximum number of ports
447 allocated to all devices is 10. Only one port per device is 447 allocated to all devices is 10. Only one port per device is
448 allowed. </para> 448 allowed.</para>
449 449
450 <para>When the SSH window is closed, the tunnel configuration is 450 <para>When the SSH window is closed, the tunnel configuration is
451 deleted on the uCPE device and the tunnel is destroyed, so that 451 deleted on the uCPE device and the tunnel is destroyed, so that