summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-getting-started
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started')
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml20
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.pngbin133962 -> 127794 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_execution.pngbin128469 -> 121264 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml29
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/introduction.xml16
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml14
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml2
7 files changed, 37 insertions, 44 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
index c03f657..6be1205 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
@@ -12,7 +12,7 @@
12 <title>Bare Metal Provisioning</title> 12 <title>Bare Metal Provisioning</title>
13 13
14 <para>Bare Metal Provisioning can be used for automated deployment of the 14 <para>Bare Metal Provisioning can be used for automated deployment of the
15 Enea NFV Access Run Time Platform on a large number of uCPE devices. The 15 Enea NFV Access Runtime Platform on a large number of uCPE devices. The
16 uCPE devices may have no previous operating system installed, or are 16 uCPE devices may have no previous operating system installed, or are
17 reinstalled without preserving any existing data. Enea NFV Access Bare 17 reinstalled without preserving any existing data. Enea NFV Access Bare
18 Metal Provisioning is based on standardized Pre-Boot Execution environment 18 Metal Provisioning is based on standardized Pre-Boot Execution environment
@@ -20,12 +20,12 @@
20 20
21 <para>The Bare Metal Provisioning process begins by PXE booting an Enea 21 <para>The Bare Metal Provisioning process begins by PXE booting an Enea
22 NFV Access installer <literal>initramfs</literal> image. The installer 22 NFV Access installer <literal>initramfs</literal> image. The installer
23 downloads a configuration file, as well as the Enea NFV Access Run Time 23 downloads a configuration file, as well as the Enea NFV Access Runtime
24 Platform image and then proceeds to install the system by dividing the 24 Platform image and then proceeds to install the system by dividing the
25 disk into 2 partitions: a GPT partition containing the GRUB boot loader 25 disk into 2 partitions: a GPT partition containing the GRUB boot loader
26 and a second partition containing the Enea NFV Access Run Time Platform 26 and a second partition containing the Enea NFV Access Runtime Platform
27 root filesystem. When the installation is complete, the uCPE device is 27 root filesystem. When the installation is complete, the uCPE device is
28 automatically rebooted into Enea NFV Access Run Time Platform.</para> 28 automatically rebooted into Enea NFV Access Runtime Platform.</para>
29 29
30 <note> 30 <note>
31 <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and 31 <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and
@@ -56,7 +56,7 @@
56 56
57 <listitem> 57 <listitem>
58 <para>The uCPE devices are preconfigured in BIOS to boot from the 58 <para>The uCPE devices are preconfigured in BIOS to boot from the
59 hard drive where the Enea NFV Access Run Time Platform will be 59 hard drive where the Enea NFV Access Runtime Platform will be
60 installed.</para> 60 installed.</para>
61 </listitem> 61 </listitem>
62 62
@@ -93,7 +93,7 @@
93 </listitem> 93 </listitem>
94 94
95 <listitem> 95 <listitem>
96 <para>Compress the Enea NFV Access Run Time Platform 96 <para>Compress the Enea NFV Access Runtime Platform
97 <literal>.hddimg</literal> image for the uCPE device architecture 97 <literal>.hddimg</literal> image for the uCPE device architecture
98 using <literal>gzip</literal> and copy the resulting 98 using <literal>gzip</literal> and copy the resulting
99 <literal>hddimg.gz</literal> file to the HTTP server.</para> 99 <literal>hddimg.gz</literal> file to the HTTP server.</para>
@@ -113,7 +113,7 @@
113 <itemizedlist> 113 <itemizedlist>
114 <listitem> 114 <listitem>
115 <para><literal>image_url</literal>. The HTTP server URL used for 115 <para><literal>image_url</literal>. The HTTP server URL used for
116 downloading the Enea NFV Access Run Time Platform image.</para> 116 downloading the Enea NFV Access Runtime Platform image.</para>
117 </listitem> 117 </listitem>
118 </itemizedlist> 118 </itemizedlist>
119 119
@@ -122,7 +122,7 @@
122 <itemizedlist> 122 <itemizedlist>
123 <listitem> 123 <listitem>
124 <para><literal>install_drive</literal>. The name of the drive 124 <para><literal>install_drive</literal>. The name of the drive
125 where the Enea NFV Access Run Time Platform will be installed (e.g 125 where the Enea NFV Access Runtime Platform will be installed (e.g
126 <literal>/dev/sda</literal>). If not set, the installer will use 126 <literal>/dev/sda</literal>). If not set, the installer will use
127 the largest detected (non-USB) drive on the uCPE device.</para> 127 the largest detected (non-USB) drive on the uCPE device.</para>
128 </listitem> 128 </listitem>
@@ -180,7 +180,7 @@ ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&
180 180
181 <para>The uCPE devices should be configured in BIOS to boot from the 181 <para>The uCPE devices should be configured in BIOS to boot from the
182 installation drive first in order to automatically start the Enea NFV 182 installation drive first in order to automatically start the Enea NFV
183 Access Run Time Platform when the installation is finished.</para> 183 Access Runtime Platform when the installation is finished.</para>
184 </section> 184 </section>
185 </section> 185 </section>
186 186
@@ -247,7 +247,7 @@ ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&
247 </itemizedlist> 247 </itemizedlist>
248 248
249 <para>The Enea UEFI Secure Boot certificates are installed together 249 <para>The Enea UEFI Secure Boot certificates are installed together
250 with the Enea NFV Access Run Time Platform onto the hard drive. They 250 with the Enea NFV Access Runtime Platform onto the hard drive. They
251 can be found on the EFI partition (usually the first partition of the 251 can be found on the EFI partition (usually the first partition of the
252 drive) under <literal>/uefi_sb_keys</literal>.</para> 252 drive) under <literal>/uefi_sb_keys</literal>.</para>
253 253
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 4cd5015..2db2487 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 5851621..404760b 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 d7771ca..b82d48b 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
@@ -30,7 +30,7 @@
30 <listitem> 30 <listitem>
31 <para>One or more uCPE devices.</para> 31 <para>One or more uCPE devices.</para>
32 32
33 <para>Whitebox devices where the Enea NFV Access Run Time Platform 33 <para>Whitebox devices where the Enea NFV Access Runtime Platform
34 will be installed, containing a minimum of 2 cores and 4 GB RAM and at 34 will be installed, containing a minimum of 2 cores and 4 GB RAM and at
35 least two ethernet ports that will be configured as WAN and LAN during 35 least two ethernet ports that will be configured as WAN and LAN during
36 deployment.</para> 36 deployment.</para>
@@ -38,7 +38,7 @@
38 <para>When hosting an entire solution including one or several network 38 <para>When hosting an entire solution including one or several network
39 services, the hardware must also have the resources to host one or 39 services, the hardware must also have the resources to host one or
40 more VNFs. During a typical evaluation, a dual VNF service on the Enea 40 more VNFs. During a typical evaluation, a dual VNF service on the Enea
41 NFV Access Run Time Platform needs a CPU with 4-8 cores and at least 8 41 NFV Access Runtime Platform needs a CPU with 4-8 cores and at least 8
42 GB RAM. The supported Intel CPUs of Enea NFV Access are documented in 42 GB RAM. The supported Intel CPUs of Enea NFV Access are documented in
43 the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 43 the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
44 xmlns:xi="http://www.w3.org/2001/XInclude" 44 xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -57,7 +57,7 @@
57 57
58 <itemizedlist> 58 <itemizedlist>
59 <listitem> 59 <listitem>
60 <para>Installing the Enea NFV Access Run Time Platform on uCPE 60 <para>Installing the Enea NFV Access Runtime Platform on uCPE
61 Devices.</para> 61 Devices.</para>
62 </listitem> 62 </listitem>
63 63
@@ -96,7 +96,7 @@
96 96
97 <programlisting>sudo systemctl stop firewalld 97 <programlisting>sudo systemctl stop firewalld
98sudo systemctl disable firewalld 98sudo systemctl disable firewalld
99sudo systemctl mask -now firewalld</programlisting> 99sudo systemctl mask now firewalld</programlisting>
100 100
101 <para>For an advanced firewall configuration, the following ports need 101 <para>For an advanced firewall configuration, the following ports need
102 to be opened:</para> 102 to be opened:</para>
@@ -368,7 +368,7 @@ userdel postgres</programlisting>
368 </itemizedlist> 368 </itemizedlist>
369 369
370 <para>The boot order may also need to be modified to support 370 <para>The boot order may also need to be modified to support
371 installation and execution of the Enea NFV Access Run Time Platform on 371 installation and execution of the Enea NFV Access Runtime Platform on
372 the uCPE device.</para> 372 the uCPE device.</para>
373 373
374 <para>The following boot order is recommended for a base 374 <para>The following boot order is recommended for a base
@@ -617,9 +617,9 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
617 617
618 <section id="prep_usb_ena"> 618 <section id="prep_usb_ena">
619 <title>Preparing the USB stick for installation of the Enea NFV Access 619 <title>Preparing the USB stick for installation of the Enea NFV Access
620 Run Time Platform</title> 620 Runtime Platform</title>
621 621
622 <para>To install the Enea NFV Access Run Time Platform, create a 622 <para>To install the Enea NFV Access Runtime Platform, create a
623 bootable USB stick with the image you intend to install.</para> 623 bootable USB stick with the image you intend to install.</para>
624 624
625 <para>In the example below, step by step instructions are provided for 625 <para>In the example below, step by step instructions are provided for
@@ -682,7 +682,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
682 </figure> 682 </figure>
683 683
684 <para>While the uCPE device is powered off, in order to install and 684 <para>While the uCPE device is powered off, in order to install and
685 configure the Enea NFV Access Run Time using the prepared USB stick, 685 configure the Enea NFV Access Runtime using the prepared USB stick,
686 connect the laptop to a uCPE device LAN port. For this purpose, a Layer 686 connect the laptop to a uCPE device LAN port. For this purpose, a Layer
687 2 switch or direct cable connection can be used.</para> 687 2 switch or direct cable connection can be used.</para>
688 </section> 688 </section>
@@ -690,7 +690,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
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 Runtime
694 Platform do the following:</para> 694 Platform do the following:</para>
695 695
696 <orderedlist> 696 <orderedlist>
@@ -754,17 +754,6 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
754 <para>Plug-in additional WAN interfaces (if applicable) and 754 <para>Plug-in additional WAN interfaces (if applicable) and
755 provide their Layer 3 configuration.</para> 755 provide their Layer 3 configuration.</para>
756 </listitem> 756 </listitem>
757
758 <listitem>
759 <para>The Static or Dynamic IP.</para>
760
761 <note>
762 <para>No LAN ports should be connected nor configured at this
763 time. The LAN port used to access the Web-installer from the
764 laptop will not be shown and cannot be configured in the
765 Web-Installer.</para>
766 </note>
767 </listitem>
768 </itemizedlist> 757 </itemizedlist>
769 </listitem> 758 </listitem>
770 </orderedlist> 759 </orderedlist>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
index d403abf..5f8a5ad 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
@@ -32,7 +32,7 @@
32 32
33 <itemizedlist> 33 <itemizedlist>
34 <listitem> 34 <listitem>
35 <para>The Enea NFV Access Run Time Platform, which acts as the host 35 <para>The Enea NFV Access Runtime Platform, which acts as the host
36 for Virtualized Network Functions (VNFs) and provides management over 36 for Virtualized Network Functions (VNFs) and provides management over
37 NETCONF.</para> 37 NETCONF.</para>
38 </listitem> 38 </listitem>
@@ -58,9 +58,9 @@
58 with your release.</para> 58 with your release.</para>
59 59
60 <section id="nfv_access"> 60 <section id="nfv_access">
61 <title>Enea NFV Access Run Time Platform</title> 61 <title>Enea NFV Access Runtime Platform</title>
62 62
63 <para>Enea NFV Access Run Time Platform is a lightweight, 63 <para>Enea NFV Access Runtime Platform is a lightweight,
64 multi-architecture virtualization platform built on de-facto standards 64 multi-architecture virtualization platform built on de-facto standards
65 in an SDN/NFV ecosystem. It is designed for a high networking 65 in an SDN/NFV ecosystem. It is designed for a high networking
66 performance with minimal hardware footprint, by only providing relevant 66 performance with minimal hardware footprint, by only providing relevant
@@ -99,6 +99,10 @@
99 99
100 <itemizedlist> 100 <itemizedlist>
101 <listitem> 101 <listitem>
102 <para>Enea NFV Access Runtime Platform Software Management</para>
103 </listitem>
104
105 <listitem>
102 <para>VNF Onboarding</para> 106 <para>VNF Onboarding</para>
103 </listitem> 107 </listitem>
104 108
@@ -139,12 +143,12 @@
139 <row> 143 <row>
140 <entry>Enea NFV Access</entry> 144 <entry>Enea NFV Access</entry>
141 145
142 <entry>The Enea NFV Access Run Time Platform and the Enea uCPE 146 <entry>The Enea NFV Access Runtime Platform and the Enea uCPE
143 Manager.</entry> 147 Manager.</entry>
144 </row> 148 </row>
145 149
146 <row> 150 <row>
147 <entry>Enea NFV Access Run Time Platform</entry> 151 <entry>Enea NFV Access Runtime Platform</entry>
148 152
149 <entry>A lightweight, multi-architecture virtualization 153 <entry>A lightweight, multi-architecture virtualization
150 platform, supporting Virtual Machines.</entry> 154 platform, supporting Virtual Machines.</entry>
@@ -160,7 +164,7 @@
160 <row> 164 <row>
161 <entry>uCPE device</entry> 165 <entry>uCPE device</entry>
162 166
163 <entry>A whitebox running the Enea NFV Access Run Time 167 <entry>A whitebox running the Enea NFV Access Runtime
164 Platform.</entry> 168 Platform.</entry>
165 </row> 169 </row>
166 </tbody> 170 </tbody>
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 effe3da..1d51537 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
@@ -230,12 +230,12 @@
230 </orderedlist> 230 </orderedlist>
231 231
232 <note> 232 <note>
233 <para>When changing the <literal>address-assignment</literal> from 233 <para>When changing the <literal>address-assignment</literal> from
234 static to DHCP, if any of the <literal>ip-address</literal>, 234 static to DHCP, if any of the <literal>ip-address</literal>,
235 <literal>netmask</literal> or <literal>gateway</literal> fields 235 <literal>netmask</literal> or <literal>gateway</literal> fields have
236 have invalid values a validation error will be triggered. 236 invalid values a validation error will be triggered. These fields
237 These fields must be empty or have the valid values for their 237 must be empty or have the valid values for their respective address
238 respective address assignment.</para> 238 assignment.</para>
239 </note> 239 </note>
240 </section> 240 </section>
241 241
@@ -702,7 +702,7 @@
702 <para>The status of execution for the scripts can be seen by 702 <para>The status of execution for the scripts can be seen by
703 opening the <literal>Fault</literal> -&gt; 703 opening the <literal>Fault</literal> -&gt;
704 <literal>Events</literal> screen and filtering by device and/or 704 <literal>Events</literal> screen and filtering by device and/or
705 the event name <filename>Custom</filename>.</para> 705 the event name <filename>CustomScriptExecuted</filename>.</para>
706 </note> 706 </note>
707 </listitem> 707 </listitem>
708 </orderedlist> 708 </orderedlist>
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 42589e0..01fd8ec 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
@@ -4,7 +4,7 @@
4 4
5 <para>Enea provides regular releases that will require the upgrading of Enea 5 <para>Enea provides regular releases that will require the upgrading of Enea
6 NFV Access components. The Enea uCPE Manager must be upgraded first, 6 NFV Access components. The Enea uCPE Manager must be upgraded first,
7 followed by upgrading Enea NFV Access Run Time on the uCPE devices.</para> 7 followed by upgrading Enea NFV Access Runtime on the uCPE devices.</para>
8 8
9 <section id="upgrade_mg"> 9 <section id="upgrade_mg">
10 <title>Upgrading the Enea uCPE Manager</title> 10 <title>Upgrading the Enea uCPE Manager</title>