diff options
8 files changed, 73 insertions, 114 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/book.xml b/doc/book-enea-nfv-access-getting-started/doc/book.xml index aa58335..6dde8db 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/book.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml | |||
@@ -17,8 +17,6 @@ | |||
17 | 17 | ||
18 | <xi:include href="introduction.xml" | 18 | <xi:include href="introduction.xml" |
19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
20 | <xi:include href="documentation.xml" | ||
21 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
22 | 20 | ||
23 | <xi:include href="getting_started_nfv_access.xml" | 21 | <xi:include href="getting_started_nfv_access.xml" |
24 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml index 861c739..d68a342 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml | |||
@@ -45,7 +45,7 @@ | |||
45 | <listitem> | 45 | <listitem> |
46 | <para>SSH Port. The NETCONF Port used for communications. This is a | 46 | <para>SSH Port. The NETCONF Port used for communications. This is a |
47 | relevant parameter if the standard NETCONF SSH (i.e. not Call-Home) is | 47 | relevant parameter if the standard NETCONF SSH (i.e. not Call-Home) is |
48 | being used. Default is set to 22.</para> | 48 | being used. Default is set to 830.</para> |
49 | </listitem> | 49 | </listitem> |
50 | </itemizedlist> | 50 | </itemizedlist> |
51 | 51 | ||
@@ -713,14 +713,6 @@ | |||
713 | </listitem> | 713 | </listitem> |
714 | 714 | ||
715 | <listitem> | 715 | <listitem> |
716 | <para><emphasis role="bold">Device Name</emphasis>. The name by | ||
717 | which the VNF will be known in the uCPE Manager, if the | ||
718 | <literal>Manage Device</literal> checkbox is checked. If unchecked, | ||
719 | the VNF will not be shown as a managed device in the uCPE | ||
720 | Manager.</para> | ||
721 | </listitem> | ||
722 | |||
723 | <listitem> | ||
724 | <para><emphasis role="bold">Instantiation Parameters</emphasis>. | 716 | <para><emphasis role="bold">Instantiation Parameters</emphasis>. |
725 | This section contains all the parameters a user needs to supply when | 717 | This section contains all the parameters a user needs to supply when |
726 | instantiating a VNF of this type. The <literal>VProbe</literal> VNF | 718 | instantiating a VNF of this type. The <literal>VProbe</literal> VNF |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/documentation.xml b/doc/book-enea-nfv-access-getting-started/doc/documentation.xml deleted file mode 100644 index fb84322..0000000 --- a/doc/book-enea-nfv-access-getting-started/doc/documentation.xml +++ /dev/null | |||
@@ -1,35 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="documentation"> | ||
3 | <title>Documentation</title> | ||
4 | |||
5 | <para>User guides and development documentation are available for download | ||
6 | on the <ulink url="https://portal.enea.com/">portal</ulink>:</para> | ||
7 | |||
8 | <orderedlist> | ||
9 | <listitem> | ||
10 | <para>Log in with the credentials provided by Enea.</para> | ||
11 | </listitem> | ||
12 | |||
13 | <listitem> | ||
14 | <para>In the top right menu, select <emphasis | ||
15 | role="bold">Access</emphasis> and choose a release version from those | ||
16 | listed on the left, (Enea NFV Access X.Y.Z). The newest is always at the | ||
17 | top. Enter that version by clicking the blue name text and scroll down | ||
18 | until you see the documentation file(s) you wish to download.</para> | ||
19 | |||
20 | <para>The documents listed below are the primary ones to consult:</para> | ||
21 | |||
22 | <itemizedlist> | ||
23 | <listitem> | ||
24 | <para>Enea NFV Access Reference Guide. <remark>make this into an | ||
25 | olink</remark></para> | ||
26 | </listitem> | ||
27 | |||
28 | <listitem> | ||
29 | <para>Enea NFV Access Getting Started (the present document).</para> | ||
30 | </listitem> | ||
31 | |||
32 | </itemizedlist> | ||
33 | </listitem> | ||
34 | </orderedlist> | ||
35 | </chapter> | ||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml index 661b951..3fdedad 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | |||
@@ -1,42 +1,13 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
4 | <chapter id="plat-release-content"> | 4 | <chapter id="plat-release-content"> |
5 | <title>Getting Started with Enea NFV Access</title> | 5 | <title>Getting Started with Enea NFV Access</title> |
6 | 6 | ||
7 | <para>Using Enea NFV Access requires access to a Linux machine, which is | 7 | <para>Enea NFV Access is a virtualization and management platform for white |
8 | used for preparing a bootable drive or for developing applications.</para> | 8 | box uCPEs. It scales from ultra-low to high end CPEs, providing minimal |
9 | 9 | footprint and maximum networking performance. NFV Access can be deployed on | |
10 | <section id="sysshell_config"> | 10 | large number of devices with various hardware configurations.</para> |
11 | <title>Default Shell Configuration</title> | ||
12 | |||
13 | <para>Before installing Enea NFV Access, make sure that <emphasis | ||
14 | role="bold">bash</emphasis> is the default shell.</para> | ||
15 | |||
16 | <para><emphasis role="bold">To verify the default system | ||
17 | shell</emphasis></para> | ||
18 | |||
19 | <itemizedlist> | ||
20 | <listitem> | ||
21 | <para>If your system runs Ubuntu, use list to verify if | ||
22 | <filename>/bin/sh</filename> is a symbolic link to | ||
23 | <literal>bash</literal>:</para> | ||
24 | |||
25 | <programlisting># ls -l /bin/sh | ||
26 | lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash</programlisting> | ||
27 | </listitem> | ||
28 | |||
29 | <listitem> | ||
30 | <para>Optionally, in case the link points to <literal>dash</literal>, | ||
31 | change it through the following steps:</para> | ||
32 | |||
33 | <programlisting># ls -l /bin/sh | ||
34 | lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> dash | ||
35 | # sudo dpkg-reconfigure dash | ||
36 | Use dash as the default system shell (/bin/sh)? No</programlisting> | ||
37 | </listitem> | ||
38 | </itemizedlist> | ||
39 | </section> | ||
40 | 11 | ||
41 | <section id="access_installer"> | 12 | <section id="access_installer"> |
42 | <title>Enea NFV Access Installer</title> | 13 | <title>Enea NFV Access Installer</title> |
@@ -49,22 +20,51 @@ Use dash as the default system shell (/bin/sh)? No</programlisting> | |||
49 | <title>Prerequisites</title> | 20 | <title>Prerequisites</title> |
50 | 21 | ||
51 | <para>To install the Enea NFV Access platform, 3 things are required: a | 22 | <para>To install the Enea NFV Access platform, 3 things are required: a |
52 | USB stick (16GB or larger), a development machine (Linux or Windows) and | 23 | USB stick (16GB or larger), a development machine with root |
53 | a target device.</para> | 24 | permissions(Linux or Windows) and a target device.</para> |
54 | 25 | ||
55 | <para>The target device requires:</para> | 26 | <para>Minimal requirements for white box for NFV Access:</para> |
27 | |||
28 | <itemizedlist> | ||
29 | <listitem> | ||
30 | <para>EFI and virtualization support</para> | ||
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para>2 cores</para> | ||
35 | </listitem> | ||
36 | |||
37 | <listitem> | ||
38 | <para>4GB RAM</para> | ||
39 | </listitem> | ||
40 | |||
41 | <listitem> | ||
42 | <para>Stoarge Device (SSD recommended)</para> | ||
43 | </listitem> | ||
44 | |||
45 | <listitem> | ||
46 | <para>2 physical interfaces</para> | ||
47 | </listitem> | ||
48 | </itemizedlist> | ||
49 | |||
50 | <para>Following BIOS settings to be enabled:</para> | ||
56 | 51 | ||
57 | <itemizedlist spacing="compact"> | 52 | <itemizedlist spacing="compact"> |
53 | |||
58 | <listitem> | 54 | <listitem> |
59 | <para>Root permissions</para> | 55 | <para>EFI</para> |
60 | </listitem> | 56 | </listitem> |
61 | 57 | ||
62 | <listitem> | 58 | <listitem> |
63 | <para>EFI is enabled in BIOS</para> | 59 | <para>Intel Virtualization Technology (VT-x )</para> |
64 | </listitem> | 60 | </listitem> |
65 | 61 | ||
66 | <listitem> | 62 | <listitem> |
67 | <para>KVM support is enabled in BIOS</para> | 63 | <para>Intel Virtualization Technology for Directed I/O (VT-d)</para> |
64 | </listitem> | ||
65 | |||
66 | <listitem> | ||
67 | <para>SR-IOV</para> | ||
68 | </listitem> | 68 | </listitem> |
69 | </itemizedlist> | 69 | </itemizedlist> |
70 | </section> | 70 | </section> |
@@ -212,8 +212,8 @@ rootfs_destination=</programlisting></para> | |||
212 | 212 | ||
213 | <orderedlist> | 213 | <orderedlist> |
214 | <listitem> | 214 | <listitem> |
215 | <para>Download the HDDIMG file from the download portal onto a Linux | 215 | <para>Download the HDDIMG file from the download portal onto a |
216 | machine or Cygwin.</para> | 216 | development machine (Linux or Windows with Cygwin support).</para> |
217 | </listitem> | 217 | </listitem> |
218 | 218 | ||
219 | <listitem> | 219 | <listitem> |
@@ -260,7 +260,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
260 | 260 | ||
261 | <itemizedlist> | 261 | <itemizedlist> |
262 | <listitem> | 262 | <listitem> |
263 | <para>live-boot. Boots NFV Access directly from the USB stick.</para> | 263 | <para>live-boot. Boots NFV Access directly from the USB |
264 | stick.</para> | ||
264 | </listitem> | 265 | </listitem> |
265 | 266 | ||
266 | <listitem> | 267 | <listitem> |
@@ -276,9 +277,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
276 | </listitem> | 277 | </listitem> |
277 | 278 | ||
278 | <listitem> | 279 | <listitem> |
279 | <para>To launch the installer, select one of the | 280 | <para>To launch the installer, select <command>installer</command> |
280 | <command>installer</command> options below from the GRUB | 281 | option from the GRUB menu:</para> |
281 | menu:</para> | ||
282 | 282 | ||
283 | <itemizedlist> | 283 | <itemizedlist> |
284 | <listitem> | 284 | <listitem> |
@@ -407,9 +407,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
407 | BIOS/UEFI) to boot the system from the media storage device where NFV | 407 | BIOS/UEFI) to boot the system from the media storage device where NFV |
408 | Access was installed.</para> | 408 | Access was installed.</para> |
409 | 409 | ||
410 | <para>Once set, GRUB will start automatically when the device is | 410 | <para>Once set, GRUB will start automatically and a menu will appear to |
411 | connected and a menu will appear to let the user select one of the boot | 411 | let the user select one of the boot options:</para> |
412 | options:</para> | ||
413 | 412 | ||
414 | <figure> | 413 | <figure> |
415 | <title>Booting NFV Access</title> | 414 | <title>Booting NFV Access</title> |
@@ -423,8 +422,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
423 | 422 | ||
424 | <itemizedlist> | 423 | <itemizedlist> |
425 | <listitem> | 424 | <listitem> |
426 | <para><literal>Enea NFV Access 2.2 (rocko) (ostre:0)</literal>: | 425 | <para><literal>Enea NFV Access 2.2 (rocko) (ostre:0)</literal>: The |
427 | The recommended configuration boot commands.</para> | 426 | recommended configuration boot commands.</para> |
428 | </listitem> | 427 | </listitem> |
429 | 428 | ||
430 | <listitem> | 429 | <listitem> |
@@ -511,9 +510,9 @@ run</programlisting> | |||
511 | 510 | ||
512 | <itemizedlist> | 511 | <itemizedlist> |
513 | <listitem> | 512 | <listitem> |
514 | <para>If a system has an amount of memory up to 8GB, the allocation | 513 | <para>If a system has an amount of memory that's higher than 8GB, the |
515 | algorithm will reserve up to 30%, but no more than 2GB, for the OS and | 514 | allocation algorithm will reserve 2GB of memory for OS and the rest of |
516 | the rest as huge pages.</para> | 515 | memory will try to allocate as 1GB hugepages.</para> |
517 | </listitem> | 516 | </listitem> |
518 | 517 | ||
519 | <listitem> | 518 | <listitem> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 72c4b32..2704fc8 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | |||
@@ -5,8 +5,8 @@ | |||
5 | <section id="prere"> | 5 | <section id="prere"> |
6 | <title>Prerequisites</title> | 6 | <title>Prerequisites</title> |
7 | 7 | ||
8 | <para>Listed below are the main generic prerequisites required so that NFV | 8 | <para>Listed below are the main generic prerequisites required so that |
9 | Access can be deployed on your host platform:</para> | 9 | uCPE Manager can be deployed on your host platform:</para> |
10 | 10 | ||
11 | <itemizedlist> | 11 | <itemizedlist> |
12 | <listitem> | 12 | <listitem> |
@@ -35,9 +35,8 @@ | |||
35 | defaults to Y), and not the machine as part of a cluster (which defaults | 35 | defaults to Y), and not the machine as part of a cluster (which defaults |
36 | to N). Installing on a Windows machine, will require the user to follow | 36 | to N). Installing on a Windows machine, will require the user to follow |
37 | the Windows password policies when defining the password for the <emphasis | 37 | the Windows password policies when defining the password for the <emphasis |
38 | role="bold">ucpemanager</emphasis> service. A default password will not be | 38 | role="bold">ucpemanager</emphasis> service. A good example for an acceptable |
39 | accepted. A good example for an acceptable password would be: | 39 | password would be:<emphasis>_1ucpe#2manager!3_</emphasis>.</para> |
40 | <emphasis>_1ucpe#2manager!3_</emphasis>.</para> | ||
41 | 40 | ||
42 | <para>Check that the Windows or CentOS machine where the uCPE Manager is | 41 | <para>Check that the Windows or CentOS machine where the uCPE Manager is |
43 | installed has the firewall disabled. To disable the firewall, if using | 42 | installed has the firewall disabled. To disable the firewall, if using |
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 9913aaf..c0496e7 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml | |||
@@ -97,6 +97,13 @@ | |||
97 | <para>In-band management</para> | 97 | <para>In-band management</para> |
98 | </listitem> | 98 | </listitem> |
99 | </itemizedlist> | 99 | </itemizedlist> |
100 | <para>For additional information about features provided in Enea NFV | ||
101 | Access, refer to the <olink targetdoc= | ||
102 | "book_enea_nfv_access_reference_guide_intel">Enea NFV Access Reference Guide</olink> | ||
103 | provided with your release. For how to install and run Enea | ||
104 | NFV Access on supported devices, please refer to <xref | ||
105 | linkend="plat-release-content"> | ||
106 | Chapter 4, Getting Started with Enea NFV Access</xref>.</para> | ||
100 | 107 | ||
101 | </section> | 108 | </section> |
102 | 109 | ||
@@ -133,12 +140,5 @@ | |||
133 | </listitem> | 140 | </listitem> |
134 | </itemizedlist> | 141 | </itemizedlist> |
135 | 142 | ||
136 | <para>For additional information about features provided in Enea NFV | ||
137 | Access, refer to the <olink targetdoc= | ||
138 | "book_enea_nfv_access_reference_guide_intel">Enea NFV Access Reference Guide</olink> | ||
139 | provided with your release. For how to install and run Enea | ||
140 | NFV Access on supported devices, please refer to <xref | ||
141 | linkend="plat-release-content"> | ||
142 | Chapter 4, Getting Started with Enea NFV Access</xref>.</para> | ||
143 | </section> | 143 | </section> |
144 | </chapter> | 144 | </chapter> |
diff --git a/doc/book-enea-nfv-access-reference-guide-intel/doc/ostree.xml b/doc/book-enea-nfv-access-reference-guide-intel/doc/ostree.xml index c1af593..dc6a693 100755 --- a/doc/book-enea-nfv-access-reference-guide-intel/doc/ostree.xml +++ b/doc/book-enea-nfv-access-reference-guide-intel/doc/ostree.xml | |||
@@ -2,8 +2,9 @@ | |||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
4 | <chapter id="ostree"> | 4 | <chapter id="ostree"> |
5 | <title>OSTree</title> | 5 | <title>Software Update</title> |
6 | 6 | ||
7 | <para>Enea's Software Update solution is based on OSTree.</para> | ||
7 | <para>OSTree is an upgrade system for Linux-based operating systems that | 8 | <para>OSTree is an upgrade system for Linux-based operating systems that |
8 | performs atomic upgrades of complete filesystem trees. The underlying | 9 | performs atomic upgrades of complete filesystem trees. The underlying |
9 | architecture might be summarized as "git for operating system binaries". It | 10 | architecture might be summarized as "git for operating system binaries". It |
diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml index 86244f6..792a1a1 100644 --- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml +++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml | |||
@@ -18,7 +18,12 @@ | |||
18 | </listitem> | 18 | </listitem> |
19 | 19 | ||
20 | <listitem> | 20 | <listitem> |
21 | <para>OSTree-based upgrade system support.</para> | 21 | <para>OSTree-based Software upgrade system support.</para> |
22 | </listitem> | ||
23 | |||
24 | <listitem> | ||
25 | <para>4G/LTE modems support (can be used as device management | ||
26 | interface).</para> | ||
22 | </listitem> | 27 | </listitem> |
23 | 28 | ||
24 | <listitem> | 29 | <listitem> |