diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-04-04 14:20:54 +0200 |
---|---|---|
committer | Martin Borg <martin.borg@enea.com> | 2019-04-12 10:10:02 +0200 |
commit | 794b53e0312e4690b926dd9073cf7ef57ecf9047 (patch) | |
tree | bf733a23950b2a8289140261e18baffecc2c9540 | |
parent | 94bef6477db4ba26f7e5fa830a4021ab48e7a2c6 (diff) | |
download | nfv-access-documentation-794b53e0312e4690b926dd9073cf7ef57ecf9047.tar.gz |
GettingStarted: use unified terms
- Use "uCPE device" to refer to target/board/host
- Use Enea NFV Access Run Time Platform in all documentations
- Add Definitions and Acronyms
Change-Id: I4347baf9fa74b40bc6297edeea1b2cd45d373485
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
6 files changed, 200 insertions, 126 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 5943980..1f51d01 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/book.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml | |||
@@ -18,6 +18,9 @@ | |||
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 | 20 | ||
21 | <xi:include href="definitions_and_acronyms.xml" | ||
22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
23 | |||
21 | <xi:include href="getting_started_nfv_access.xml" | 24 | <xi:include href="getting_started_nfv_access.xml" |
22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 25 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
23 | 26 | ||
diff --git a/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml b/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml new file mode 100644 index 0000000..38c71b8 --- /dev/null +++ b/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml | |||
@@ -0,0 +1,78 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="def_and_acr"> | ||
5 | <title>Definitions and Acronyms</title> | ||
6 | |||
7 | <section id="definitions"> | ||
8 | <title>Definitions</title> | ||
9 | |||
10 | <table> | ||
11 | <title>Definitions</title> | ||
12 | |||
13 | <tgroup cols="2"> | ||
14 | <colspec align="left" colname="1" colwidth="1*" /> | ||
15 | |||
16 | <colspec align="left" colname="2" colwidth="3*" /> | ||
17 | |||
18 | <tbody> | ||
19 | <row> | ||
20 | <entry>Enea NFV Access</entry> | ||
21 | |||
22 | <entry>The Enea NFV Access Run Time Platform (with ODM) and uCPE | ||
23 | Manager.</entry> | ||
24 | </row> | ||
25 | |||
26 | <row> | ||
27 | <entry>Enea NFV Access Run Time Platform</entry> | ||
28 | <entry>A lightweight, multi-architecture virtualization platform, | ||
29 | supporting Virtual Machines (KVM / QEMU).</entry> | ||
30 | </row> | ||
31 | |||
32 | <row> | ||
33 | <entry>Enea uCPE Manager</entry> | ||
34 | <entry>Enea Universal Customer Premises Equipment Manager.</entry> | ||
35 | </row> | ||
36 | |||
37 | <row> | ||
38 | <entry>uCPE device</entry> | ||
39 | <entry>A whitebox (e.g. Intel XeonD) running Enea NFV Access Run | ||
40 | Time platform.</entry> | ||
41 | </row> | ||
42 | </tbody> | ||
43 | </tgroup> | ||
44 | </table> | ||
45 | </section> | ||
46 | |||
47 | <section id="acronyms"> | ||
48 | <title>Acronyms</title> | ||
49 | |||
50 | <table> | ||
51 | <title>acronyms</title> | ||
52 | |||
53 | <tgroup cols="2"> | ||
54 | <colspec align="left" colname="1" colwidth="1*" /> | ||
55 | |||
56 | <colspec align="left" colname="2" colwidth="3*" /> | ||
57 | |||
58 | <tbody> | ||
59 | <row> | ||
60 | <entry>ODM</entry> | ||
61 | <entry>On Device Management.</entry> | ||
62 | </row> | ||
63 | |||
64 | <row> | ||
65 | <entry>OVS</entry> | ||
66 | <entry>Open vSwitch.</entry> | ||
67 | </row> | ||
68 | |||
69 | <row> | ||
70 | <entry>VIM</entry> | ||
71 | |||
72 | <entry>Virtual Infrastructure Manager.</entry> | ||
73 | </row> | ||
74 | </tbody> | ||
75 | </tgroup> | ||
76 | </table> | ||
77 | </section> | ||
78 | </chapter> | ||
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 8aa1aeb..1fb5b1c 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 | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="configuration_provision"> | 2 | <chapter id="configuration_provision"> |
3 | <title>Device Configuration and Provisioning</title> | 3 | <title>Device Configuration and Provisioning</title> |
4 | 4 | ||
@@ -6,16 +6,16 @@ | |||
6 | <title>Manual Configuration</title> | 6 | <title>Manual Configuration</title> |
7 | 7 | ||
8 | <para>This section describes how to connect to an instance of NFV Access | 8 | <para>This section describes how to connect to an instance of NFV Access |
9 | installed on a specific target, and how to setup the virtual | 9 | installed on a specific uCPE device, and how to setup the virtual |
10 | infrastructure manually.</para> | 10 | infrastructure manually.</para> |
11 | 11 | ||
12 | <para><emphasis role="bold">How to add a board to the management system | 12 | <para><emphasis role="bold">How to add a uCPE device to the management system |
13 | </emphasis></para> | 13 | </emphasis></para> |
14 | 14 | ||
15 | <para>Add the boards running NFV Access to the management system. This is | 15 | <para>Add the uCPE device running NFV Access Run Time Platform to the management system. This is |
16 | done by using the <literal>Devices -> Manage -> Add</literal> menu. | 16 | done by using the <literal>Devices -> Manage -> Add</literal> menu. |
17 | Supply information about the board running NFV Access, and set the | 17 | Supply information about the uCPE device, and set the |
18 | parameters that will be used to connect to the board. The relevant | 18 | parameters that will be used to connect to the uCPE device. The relevant |
19 | parameters are described below:</para> | 19 | parameters are described below:</para> |
20 | 20 | ||
21 | <itemizedlist> | 21 | <itemizedlist> |
@@ -66,8 +66,9 @@ | |||
66 | <listitem> | 66 | <listitem> |
67 | <para>Device Calls Home. This checkbox indicates the direction of | 67 | <para>Device Calls Home. This checkbox indicates the direction of |
68 | device communications. In the Manual Configuration, leave this box | 68 | device communications. In the Manual Configuration, leave this box |
69 | blank. For more info about how to add a device please refer to | 69 | blank. For more info about how to add a device please refer to <link |
70 | <link linkend="adding_a_device">Zero Touch Provisioning, Adding a Device</link>.</para> | 70 | linkend="adding_a_device">Zero Touch Provisioning, Adding a |
71 | Device</link>.</para> | ||
71 | </listitem> | 72 | </listitem> |
72 | </itemizedlist> | 73 | </itemizedlist> |
73 | 74 | ||
@@ -84,9 +85,10 @@ | |||
84 | <section id="host_int_net_config"> | 85 | <section id="host_int_net_config"> |
85 | <title>Host Interfaces and Network Configuration</title> | 86 | <title>Host Interfaces and Network Configuration</title> |
86 | 87 | ||
87 | <para>The uCPE Manager can list network interfaces found on a device | 88 | <para>The uCPE Manager can list network interfaces found on a device by |
88 | (Device -> Configuration -> OpenVSwitch -> Host Interface | 89 | selecting: <literal>Device</literal> -> |
89 | Caps):</para> | 90 | <literal>Configuration</literal> -> <literal>OpenVSwitch |
91 | </literal>-> <literal>Host Interface Caps</literal>:</para> | ||
90 | 92 | ||
91 | <figure> | 93 | <figure> |
92 | <title>Host Interface Caps</title> | 94 | <title>Host Interface Caps</title> |
@@ -108,9 +110,9 @@ | |||
108 | <para>Configuring a physical interface in DPDK mode will require a | 110 | <para>Configuring a physical interface in DPDK mode will require a |
109 | DPDK-based application (e.g. OVS-DPDK) in order to access and use the | 111 | DPDK-based application (e.g. OVS-DPDK) in order to access and use the |
110 | interface. An interface set as DPDK can be attached to an OVS-DPDK | 112 | interface. An interface set as DPDK can be attached to an OVS-DPDK |
111 | bridge. Select the device, then the Configuration option from the top | 113 | bridge. Select the uCPE device, then from the top toolbar select: |
112 | toolbar: <literal>Configuration</literal>-><literal>OpenVSwitch | 114 | <literal>Configuration</literal> -><literal> OpenVSwitch |
113 | </literal>-><literal>Host Interfaces</literal>-><literal> | 115 | </literal>-> <literal>Host Interfaces</literal> -><literal> |
114 | Add</literal>:</para> | 116 | Add</literal>:</para> |
115 | 117 | ||
116 | <figure> | 118 | <figure> |
@@ -146,10 +148,10 @@ | |||
146 | </itemizedlist> | 148 | </itemizedlist> |
147 | 149 | ||
148 | <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on the | 150 | <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on the |
149 | device that uses a DPDK interface, by selecting the Device, | 151 | device that uses a DPDK interface, by selecting the uCPE device, then |
150 | then the Configuration option from the top toolbar: | 152 | from the top toolbar selecting: <literal>Configuration</literal>-> |
151 | <literal>Configuration</literal>-> <literal>OpenVSwitch</literal> -> | 153 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> -> |
152 | <literal>Bridges</literal> -> <literal>Add</literal>:</para> | 154 | <literal>Add</literal>:</para> |
153 | 155 | ||
154 | <figure> | 156 | <figure> |
155 | <title>OVS bridge</title> | 157 | <title>OVS bridge</title> |
@@ -167,10 +169,10 @@ | |||
167 | <title>SR-IOV Interface Type</title> | 169 | <title>SR-IOV Interface Type</title> |
168 | 170 | ||
169 | <para>SR-IOV mode will create a number of virtual functions on host that | 171 | <para>SR-IOV mode will create a number of virtual functions on host that |
170 | can be used to route traffic to VMs. Select the device, then the Configuration | 172 | can be used to route traffic to VMs. Select the uCPE device, then from |
171 | option from the top toolbar: <literal>Configuration</literal>-><literal>OpenVSwitch | 173 | the top toolbar select: <literal>Configuration</literal> -><literal> |
172 | </literal>-><literal>Host Interfaces</literal>-><literal> | 174 | OpenVSwitch </literal>-> <literal>Host Interfaces |
173 | Add</literal>:</para> | 175 | </literal>-><literal> Add</literal>:</para> |
174 | 176 | ||
175 | <para>For SR-IOV mode, the user must set following fields:</para> | 177 | <para>For SR-IOV mode, the user must set following fields:</para> |
176 | 178 | ||
@@ -192,12 +194,11 @@ | |||
192 | </listitem> | 194 | </listitem> |
193 | 195 | ||
194 | <listitem> | 196 | <listitem> |
195 | <para>sriov-num-vfs: the number of virtual functions to create</para> | 197 | <para>sriov-num-vfs: the number of virtual functions to |
198 | create</para> | ||
196 | </listitem> | 199 | </listitem> |
197 | |||
198 | </itemizedlist> | 200 | </itemizedlist> |
199 | 201 | ||
200 | |||
201 | <figure> | 202 | <figure> |
202 | <title>SR-IOV Interface Type</title> | 203 | <title>SR-IOV Interface Type</title> |
203 | 204 | ||
@@ -247,14 +248,13 @@ | |||
247 | 248 | ||
248 | <para>With the address parameter set, run | 249 | <para>With the address parameter set, run |
249 | <literal>list_deviceID.sh</literal> after NFV Access is installed and | 250 | <literal>list_deviceID.sh</literal> after NFV Access is installed and |
250 | booted, to get the device ID of the target.</para> | 251 | booted, to get the device ID of the uCPE device.</para> |
251 | 252 | ||
252 | <note> | 253 | <note> |
253 | <para>It is possible to let NFV Access know the uCPE Manager IP address | 254 | <para>It is possible to let NFV Access know the uCPE Manager IP address |
254 | at run-time by setting <literal>vcpemgr=<IP></literal> as a kernel | 255 | at run-time by setting <literal>vcpemgr=<IP></literal> as a kernel |
255 | boot parameter in the grub configuration file. Reboot is required after | 256 | boot parameter in the grub configuration file. Reboot is required after |
256 | this update. For additional information about grub configuration, please | 257 | this update.</para> |
257 | refer to the Enea NFV Access Reference Guide provided with your release.</para> | ||
258 | 258 | ||
259 | <para>This step needs to be done each time the uCPE Manager host changes | 259 | <para>This step needs to be done each time the uCPE Manager host changes |
260 | its IP address.</para> | 260 | its IP address.</para> |
@@ -266,15 +266,15 @@ | |||
266 | <section id="adding_a_device"> | 266 | <section id="adding_a_device"> |
267 | <title>Adding a Device</title> | 267 | <title>Adding a Device</title> |
268 | 268 | ||
269 | <para>The uCPE Manager must be configured to bring the target device | 269 | <para>The uCPE Manager must be configured to bring the uCPE device under |
270 | under management. This is done by selecting <literal>Device Calls | 270 | management. This is done by selecting <literal>Device Calls |
271 | Home</literal> checkbox when adding a device. When Device Calls | 271 | Home</literal> checkbox when adding a device. When Device Calls Home |
272 | Home checkbox is checked, the device will initiate a | 272 | checkbox is checked, the device will initiate a connection by opening a |
273 | connection by opening a socket to the uCPE Manager for NETCONF | 273 | socket to the uCPE Manager for NETCONF traffic (over SSH), while the |
274 | traffic (over SSH), while the uCPE Manager waits for device connection.</para> | 274 | uCPE Manager waits for device connection.</para> |
275 | 275 | ||
276 | <para>For more info about how to add a device please refer to | 276 | <para>For more info about how to add a device please refer to <link |
277 | <link linkend="man_config">Manual Configuration</link>.</para> | 277 | linkend="man_config">Manual Configuration</link>.</para> |
278 | </section> | 278 | </section> |
279 | 279 | ||
280 | <section id="offline_configuration"> | 280 | <section id="offline_configuration"> |
@@ -350,7 +350,7 @@ | |||
350 | 350 | ||
351 | <para>As the acting vnf manager, the uCPE Manager is responsible for | 351 | <para>As the acting vnf manager, the uCPE Manager is responsible for |
352 | handling the life-cycles of VNFs that are instantiated and run on the | 352 | handling the life-cycles of VNFs that are instantiated and run on the |
353 | various uCPE hosts. The vnf manager module is written so as to be able to | 353 | various uCPE devices. The vnf manager module is written so as to be able to |
354 | manage multiple VNF types. Along with it is provided a generic | 354 | manage multiple VNF types. Along with it is provided a generic |
355 | infrastructure to allow the end-user to introduce new VNF types | 355 | infrastructure to allow the end-user to introduce new VNF types |
356 | dynamically into the system. This allows for third-party VNFs to be added | 356 | dynamically into the system. This allows for third-party VNFs to be added |
@@ -359,8 +359,8 @@ | |||
359 | 359 | ||
360 | <para>The process of VNF Onboarding consists of providing the system with | 360 | <para>The process of VNF Onboarding consists of providing the system with |
361 | sufficient information and resources related to the VNF such that it can | 361 | sufficient information and resources related to the VNF such that it can |
362 | instantiate a flavor of the VNF on the target, configure and scale it as | 362 | instantiate a flavor of the VNF on the uCPE device, configure and scale it |
363 | appropriate, heal and upgrade it when necessary and tear it down at the | 363 | as appropriate, heal and upgrade it when necessary and tear it down at the |
364 | right moment.</para> | 364 | right moment.</para> |
365 | 365 | ||
366 | <para>The vnf manager subsystem in the uCPE Manager inserts a menu item in | 366 | <para>The vnf manager subsystem in the uCPE Manager inserts a menu item in |
@@ -391,8 +391,7 @@ | |||
391 | 391 | ||
392 | <listitem> | 392 | <listitem> |
393 | <para><literal>Instances</literal>: Choosing this option lets you | 393 | <para><literal>Instances</literal>: Choosing this option lets you |
394 | instantiate (or destroy) VNFs on a given uCPE host (the | 394 | instantiate (or destroy) VNFs on a given uCPE device.</para> |
395 | <literal>target</literal>).</para> | ||
396 | </listitem> | 395 | </listitem> |
397 | 396 | ||
398 | <listitem> | 397 | <listitem> |
@@ -493,12 +492,21 @@ | |||
493 | 492 | ||
494 | <orderedlist> | 493 | <orderedlist> |
495 | <listitem> | 494 | <listitem> |
495 | <para>Select the uCPE Device.</para> | ||
496 | </listitem> | ||
497 | |||
498 | <listitem> | ||
499 | <para>Select from the top toolbar <literal>VNF</literal> -> | ||
500 | <literal>Descriptors</literal></para> | ||
501 | </listitem> | ||
502 | |||
503 | <listitem> | ||
496 | <para>Click the <literal>On-board</literal> button.</para> | 504 | <para>Click the <literal>On-board</literal> button.</para> |
497 | </listitem> | 505 | </listitem> |
498 | 506 | ||
499 | <listitem> | 507 | <listitem> |
500 | <para>When prompted by the following UI, make sure the | 508 | <para>When prompted by the following UI, make sure the <literal>VM |
501 | <literal>VM Image</literal> radio button is selected.</para> | 509 | Image</literal> radio button is selected.</para> |
502 | </listitem> | 510 | </listitem> |
503 | </orderedlist> | 511 | </orderedlist> |
504 | 512 | ||
@@ -697,7 +705,7 @@ | |||
697 | <title>Instantiating a VNF</title> | 705 | <title>Instantiating a VNF</title> |
698 | 706 | ||
699 | <para>Once the VNF bundle has been onboarded, you can instantiate a VNF | 707 | <para>Once the VNF bundle has been onboarded, you can instantiate a VNF |
700 | on a specific uCPE host.</para> | 708 | on a specific uCPE device.</para> |
701 | 709 | ||
702 | <para>Launch the <literal>VNF instance</literal> table by choosing the | 710 | <para>Launch the <literal>VNF instance</literal> table by choosing the |
703 | <literal>Instances</literal> option from the <literal>VNF</literal> | 711 | <literal>Instances</literal> option from the <literal>VNF</literal> |
@@ -737,10 +745,9 @@ | |||
737 | </listitem> | 745 | </listitem> |
738 | 746 | ||
739 | <listitem> | 747 | <listitem> |
740 | <para><emphasis role="bold">VIM</emphasis>. This stands for | 748 | <para><emphasis role="bold">VIM</emphasis>. The uCPE device on which |
741 | <literal> Virtual Infrastructure Manager</literal>, the target host | 749 | to instantiate a VNF, i.e. the uCPE device that will run this |
742 | on which to instantiate a VNF, i.e. the target uCPE host that will | 750 | VNF.</para> |
743 | run this VNF.</para> | ||
744 | </listitem> | 751 | </listitem> |
745 | 752 | ||
746 | <listitem> | 753 | <listitem> |
@@ -763,20 +770,20 @@ | |||
763 | </itemizedlist> | 770 | </itemizedlist> |
764 | 771 | ||
765 | <para>Hitting the <literal>Create</literal> button will cause the VNF to | 772 | <para>Hitting the <literal>Create</literal> button will cause the VNF to |
766 | be instantiated and run on the uCPE target specified above. The | 773 | be instantiated and run on the uCPE device specified above. The |
767 | following operations will now take place:</para> | 774 | following operations will now take place:</para> |
768 | 775 | ||
769 | <orderedlist> | 776 | <orderedlist> |
770 | <listitem> | 777 | <listitem> |
771 | <para>Check if the uCPE already has the VNF Flavor definition in its | 778 | <para>Check if the uCPE device already has the VNF Flavor definition in its |
772 | flavor store; if not create a new Flavor definition on the | 779 | flavor store; if not create a new Flavor definition on the |
773 | uCPE.</para> | 780 | uCPE device.</para> |
774 | </listitem> | 781 | </listitem> |
775 | 782 | ||
776 | <listitem> | 783 | <listitem> |
777 | <para>Check if the uCPE already has the VNF image in its image | 784 | <para>Check if the uCPE device already has the VNF image in its image |
778 | store; if not, upload the image and create a new Image definition on | 785 | store; if not, upload the image and create a new Image definition on |
779 | the uCPE.</para> | 786 | the uCPE device.</para> |
780 | </listitem> | 787 | </listitem> |
781 | 788 | ||
782 | <listitem> | 789 | <listitem> |
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 b3f7645..9b28c88 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,24 +1,24 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
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 | <section id="access_installer"> | 7 | <section id="access_installer"> |
8 | <title>Enea NFV Access Installer</title> | 8 | <title>Enea NFV Access Run Time Platform Installer</title> |
9 | 9 | ||
10 | <para>The current release supports one primary method of installation, | 10 | <para>The current release supports one primary method of installation, |
11 | using the installer, which guarantees a clean installation of NFV Access | 11 | using the installer, which guarantees a clean installation of NFV Access |
12 | on a device.</para> | 12 | on a uCPE device.</para> |
13 | 13 | ||
14 | <section id="prereq"> | 14 | <section id="prereq"> |
15 | <title>Prerequisites</title> | 15 | <title>Prerequisites</title> |
16 | 16 | ||
17 | <para>To install the Enea NFV Access platform, 3 things are required: a | 17 | <para>To install the Enea NFV Access Run Time Platform, 3 things are |
18 | USB stick (16GB or larger), a development machine with root | 18 | required: a USB stick (16GB or larger), a development machine with root |
19 | permissions(Linux or Windows) and a target device.</para> | 19 | permissions (Linux or Windows) and a uCPE device.</para> |
20 | 20 | ||
21 | <para>Minimal requirements for NFV Access:</para> | 21 | <para>Minimal requirements for the uCPE device:</para> |
22 | 22 | ||
23 | <itemizedlist spacing="compact"> | 23 | <itemizedlist spacing="compact"> |
24 | <listitem> | 24 | <listitem> |
@@ -45,7 +45,6 @@ | |||
45 | <para>Following BIOS settings to be enabled:</para> | 45 | <para>Following BIOS settings to be enabled:</para> |
46 | 46 | ||
47 | <itemizedlist spacing="compact"> | 47 | <itemizedlist spacing="compact"> |
48 | |||
49 | <listitem> | 48 | <listitem> |
50 | <para>EFI</para> | 49 | <para>EFI</para> |
51 | </listitem> | 50 | </listitem> |
@@ -67,8 +66,8 @@ | |||
67 | <section condition="hidden" id="man_installer"> | 66 | <section condition="hidden" id="man_installer"> |
68 | <title>Installer Setup and Usage for a manual installation</title> | 67 | <title>Installer Setup and Usage for a manual installation</title> |
69 | 68 | ||
70 | <para><emphasis role="bold">To install Enea NFV Access on a physical | 69 | <para><emphasis role="bold">To install Enea NFV Access Run Time Platform |
71 | drive</emphasis></para> | 70 | on a physical drive</emphasis></para> |
72 | 71 | ||
73 | <orderedlist> | 72 | <orderedlist> |
74 | <listitem> | 73 | <listitem> |
@@ -192,15 +191,16 @@ rootfs_destination=</programlisting></para> | |||
192 | </itemizedlist> | 191 | </itemizedlist> |
193 | 192 | ||
194 | <para>After using the installer and setting up the bootable media, | 193 | <para>After using the installer and setting up the bootable media, |
195 | connect it to the target machine and configure the target machine to use | 194 | connect it to the uCPE device and configure the uCPE device to use it as |
196 | it as a primary boot device.</para> | 195 | a primary boot device.</para> |
197 | </section> | 196 | </section> |
198 | 197 | ||
199 | <section id="auto_installer"> | 198 | <section id="auto_installer"> |
200 | <title>Creating a bootable USB stick</title> | 199 | <title>Creating a bootable USB stick</title> |
201 | 200 | ||
202 | <para>In order to install Enea NFV Access, you must first create a | 201 | <para>In order to install Enea NFV Access Run Time Platform, you must |
203 | bootable USB stick with the image you intend to install.</para> | 202 | first create a bootable USB stick with the image you intend to |
203 | install.</para> | ||
204 | 204 | ||
205 | <para><emphasis role="bold">Create a bootable USB stick | 205 | <para><emphasis role="bold">Create a bootable USB stick |
206 | image</emphasis></para> | 206 | image</emphasis></para> |
@@ -221,13 +221,12 @@ sdb 8:0 0 111.8G 0 disk | |||
221 | </listitem> | 221 | </listitem> |
222 | 222 | ||
223 | <listitem> | 223 | <listitem> |
224 | <para>Copy the HDDIMG image to the USB stick, e.g:<programlisting>sudo dd if=./enea-nfv-access-<target>.hddimg \ | 224 | <para>Copy the HDDIMG image to the USB stick, e.g:<programlisting>sudo dd if=./enea-nfv-access-<machine>.hddimg \ |
225 | of=/dev/sdb bs=4M conv=fsync</programlisting></para> | 225 | of=/dev/sdb bs=4M conv=fsync</programlisting></para> |
226 | </listitem> | 226 | </listitem> |
227 | </orderedlist> | 227 | </orderedlist> |
228 | 228 | ||
229 | <para>Where | 229 | <para>Where <filename>enea-nfv-access-<machine>.hddimg |
230 | <filename>enea-nfv-access-<target>.hddimg | ||
231 | </filename>is the .hddimg file and <literal>sdb</literal> is the | 230 | </filename>is the .hddimg file and <literal>sdb</literal> is the |
232 | assigned USB device name.</para> | 231 | assigned USB device name.</para> |
233 | </section> | 232 | </section> |
@@ -235,58 +234,44 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
235 | <section id="install_ena_stick"> | 234 | <section id="install_ena_stick"> |
236 | <title>Installing Enea NFV Access</title> | 235 | <title>Installing Enea NFV Access</title> |
237 | 236 | ||
238 | <para><emphasis role="bold">How to install Enea NFV Access using a | 237 | <para><emphasis role="bold">How to install Enea NFV Access Run Time |
239 | bootable USB stick image</emphasis></para> | 238 | Platform using a bootable USB stick image</emphasis></para> |
240 | 239 | ||
241 | <orderedlist> | 240 | <orderedlist> |
241 | |||
242 | <listitem> | 242 | <listitem> |
243 | <para>Plug the USB stick into the reference board. Make sure you are | 243 | <para>Plug the USB stick into the reference uCPE device. Make sure |
244 | connected to the serial port.</para> | 244 | you are connected to the serial port.</para> |
245 | </listitem> | 245 | </listitem> |
246 | 246 | ||
247 | <listitem> | 247 | <listitem> |
248 | <para>Power up the board and boot the USB stick. Verify the USB | 248 | <para>Power up the uCPE device and boot the USB stick. Verify the |
249 | stick is selected from the BIOS boot menu.</para> | 249 | USB stick is selected from the BIOS boot menu.</para> |
250 | </listitem> | 250 | </listitem> |
251 | 251 | ||
252 | <listitem> | 252 | <listitem> |
253 | <para>Once the USB stick is properly booted, a GRUB menu appears on | 253 | <para>Once the USB stick is properly booted, a GRUB menu appears on |
254 | the serial console. The following options are available:</para> | 254 | the serial console. The following options are available:</para> |
255 | 255 | ||
256 | <itemizedlist> | 256 | <itemizedlist spacing="compact"> |
257 | <listitem> | 257 | <listitem> |
258 | <para>live-boot. Boots NFV Access directly from the USB | 258 | <para>live-boot. Boots NFV Access Run Time Platform directly |
259 | stick.</para> | 259 | from the USB stick.</para> |
260 | </listitem> | 260 | </listitem> |
261 | 261 | ||
262 | <listitem> | 262 | <listitem> |
263 | <para>installer. Launches the NFV Access installer and uses the | 263 | <para>installer. Launches the NFV Access Run Time Platform |
264 | serial port for output.</para> | 264 | installer and uses the serial port for output.</para> |
265 | </listitem> | 265 | </listitem> |
266 | </itemizedlist> | 266 | </itemizedlist> |
267 | 267 | ||
268 | <note> | 268 | <note> |
269 | <para>The graphical console requires that a display is connected | 269 | <para>The graphical console requires that a display is connected |
270 | to the board.</para> | 270 | to the uCPE device.</para> |
271 | </note> | 271 | </note> |
272 | </listitem> | 272 | </listitem> |
273 | 273 | ||
274 | <listitem> | 274 | <listitem> |
275 | <para>To launch the installer, select the <command>installer</command> | ||
276 | option from the GRUB menu:</para> | ||
277 | |||
278 | <itemizedlist> | ||
279 | <listitem> | ||
280 | <para>Install NFV Access.</para> | ||
281 | </listitem> | ||
282 | |||
283 | <listitem> | ||
284 | <para>Reboot.</para> | ||
285 | </listitem> | ||
286 | </itemizedlist> | ||
287 | </listitem> | ||
288 | |||
289 | <listitem> | ||
290 | <para>Select <command>Install NFV Access</command> from the menu to | 275 | <para>Select <command>Install NFV Access</command> from the menu to |
291 | proceed with the installation.</para> | 276 | proceed with the installation.</para> |
292 | </listitem> | 277 | </listitem> |
@@ -299,14 +284,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
299 | <listitem> | 284 | <listitem> |
300 | <para><emphasis role="bold">Automatic install</emphasis>. This | 285 | <para><emphasis role="bold">Automatic install</emphasis>. This |
301 | option will partition a user-defined drive and install NFV | 286 | option will partition a user-defined drive and install NFV |
302 | Access. You can create 2 or 4 partitions, and choosing either of | 287 | Access Run Time Platform. You can create 2 or 4 partitions, and |
303 | these two options will prompt you for a drive on which to | 288 | choosing either of these two options will prompt you for a drive |
304 | install NFV Access. The 2-partition scheme divides the disk into | 289 | on which to install NFV Access Run Time Platform. The |
305 | one GPT partition containing the GRUB binary and configuration, | 290 | 2-partition scheme divides the disk into one GPT partition |
306 | leaving the rest of the disk for the root filesystem. The | 291 | containing the GRUB binary and configuration, leaving the rest |
307 | 4-partition scheme creates: a GPT partition for GRUB (similar to | 292 | of the disk for the root filesystem. The 4-partition scheme |
308 | the one in the 2-partition scheme), two 20 GB partitions, and | 293 | creates: a GPT partition for GRUB (similar to the one in the |
309 | one containing the remaining free disk space.</para> | 294 | 2-partition scheme), two 20 GB partitions, and one containing |
295 | the remaining free disk space.</para> | ||
310 | 296 | ||
311 | <para>After choosing the Automatic install option and one of the | 297 | <para>After choosing the Automatic install option and one of the |
312 | predefined partitioning actions, the <literal>install | 298 | predefined partitioning actions, the <literal>install |
@@ -332,7 +318,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
332 | <para><emphasis role="bold">Default | 318 | <para><emphasis role="bold">Default |
333 | Parameters</emphasis>:</para> | 319 | Parameters</emphasis>:</para> |
334 | 320 | ||
335 | <itemizedlist spacing="compact"> | 321 | <itemizedlist> |
336 | <listitem> | 322 | <listitem> |
337 | <para>Core isolation. Isolates the selected range of cores | 323 | <para>Core isolation. Isolates the selected range of cores |
338 | from the kernel scheduler.</para> | 324 | from the kernel scheduler.</para> |
@@ -382,7 +368,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
382 | 368 | ||
383 | <listitem> | 369 | <listitem> |
384 | <para>At the end of the installation process, you can choose between | 370 | <para>At the end of the installation process, you can choose between |
385 | running the installer again or rebooting the board.</para> | 371 | running the installer again or rebooting the uCPE device.</para> |
386 | 372 | ||
387 | <note> | 373 | <note> |
388 | <para>The boot log will always be displayed on the serial port. | 374 | <para>The boot log will always be displayed on the serial port. |
@@ -397,8 +383,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
397 | <title>Booting NFV Access</title> | 383 | <title>Booting NFV Access</title> |
398 | 384 | ||
399 | <para>After installing Enea NFV Access on a media storage device (e.g. | 385 | <para>After installing Enea NFV Access on a media storage device (e.g. |
400 | eMMC, HDD or SSD), the target must be reset so that Enea NFV Access can | 386 | eMMC, HDD or SSD), the uCPE device must be reset so that Enea NFV Access |
401 | boot. The user must configure the first stage bootloader (e.g. | 387 | can boot. The user must configure the first stage bootloader (e.g. |
402 | BIOS/UEFI) to boot the system from the media storage device where NFV | 388 | BIOS/UEFI) to boot the system from the media storage device where NFV |
403 | Access was installed.</para> | 389 | Access was installed.</para> |
404 | 390 | ||
@@ -474,7 +460,7 @@ run</programlisting> | |||
474 | 460 | ||
475 | <para>Workaround: If both a USB stick with the Enea NFV Access installer | 461 | <para>Workaround: If both a USB stick with the Enea NFV Access installer |
476 | set up (e.g FS0) and an another media storage device (e.g. FS1), are | 462 | set up (e.g FS0) and an another media storage device (e.g. FS1), are |
477 | connected to a target machine, in order to select the former, the count | 463 | connected to a uCPE device, in order to select the former, the count |
478 | down must be stopped with the default <literal>startup.nsh</literal> | 464 | down must be stopped with the default <literal>startup.nsh</literal> |
479 | script by pressing <command>ESC</command> and then starting GRUB | 465 | script by pressing <command>ESC</command> and then starting GRUB |
480 | manually:</para> | 466 | manually:</para> |
@@ -506,8 +492,8 @@ run</programlisting> | |||
506 | <itemizedlist> | 492 | <itemizedlist> |
507 | <listitem> | 493 | <listitem> |
508 | <para>If a system has an amount of memory up to 8GB, the allocation | 494 | <para>If a system has an amount of memory up to 8GB, the allocation |
509 | algorithm will reserve up to 30%, but no more than 2GB, for the OS | 495 | algorithm will reserve up to 30%, but no more than 2GB, for the OS and |
510 | and rest as 2MB hugepages.</para> | 496 | the rest as 2MB hugepages.</para> |
511 | </listitem> | 497 | </listitem> |
512 | 498 | ||
513 | <listitem> | 499 | <listitem> |
@@ -589,7 +575,7 @@ run</programlisting> | |||
589 | 575 | ||
590 | <listitem> | 576 | <listitem> |
591 | <para>16GB of memory: approximately 2GB will be allocated for the OS | 577 | <para>16GB of memory: approximately 2GB will be allocated for the OS |
592 | and the rest as 1GB hugepages.</para> | 578 | and the rest as 1GB hugepages.</para> |
593 | </listitem> | 579 | </listitem> |
594 | </itemizedlist> | 580 | </itemizedlist> |
595 | 581 | ||
@@ -677,7 +663,7 @@ node0.1048576kB = 3 </programlisting> | |||
677 | /* self-extracting archive installing cross-compilation | 663 | /* self-extracting archive installing cross-compilation |
678 | toolchain for the guest (QEMU x86-64) */</programlisting> | 664 | toolchain for the guest (QEMU x86-64) */</programlisting> |
679 | 665 | ||
680 | <para>For each combination of image and target, the following set of | 666 | <para>For each combination of image and uCPE device, the following set of |
681 | artifacts is available:</para> | 667 | artifacts is available:</para> |
682 | 668 | ||
683 | <programlisting>-- bzImage | 669 | <programlisting>-- bzImage |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml index c31cea3..6f5cdb1 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml | |||
@@ -7,8 +7,8 @@ | |||
7 | <para>In-band Management refers to a model where both the data plane and | 7 | <para>In-band Management refers to a model where both the data plane and |
8 | control plane flow over the same network path.</para> | 8 | control plane flow over the same network path.</para> |
9 | 9 | ||
10 | <para>In some situations, In-Band Management is the only option available to | 10 | <para>In some situations, In-band Management is the only option available to |
11 | both control and configure the device, while also allowing for data-path | 11 | both control and configure the uCPE device, while also allowing for data-path |
12 | traffic to pass over the same physical interface.</para> | 12 | traffic to pass over the same physical interface.</para> |
13 | 13 | ||
14 | <para>The main requirement for this use case solution is to have all traffic | 14 | <para>The main requirement for this use case solution is to have all traffic |
@@ -50,7 +50,7 @@ | |||
50 | 50 | ||
51 | <para>All network traffic, with the exception of any received from the uCPE | 51 | <para>All network traffic, with the exception of any received from the uCPE |
52 | Manager, will be sent towards the VNF or dropped if there is no VNF | 52 | Manager, will be sent towards the VNF or dropped if there is no VNF |
53 | instantiated on the NFV Access device. The VNF connected to the WAN bridge | 53 | instantiated on the uCPE device. The VNF connected to the WAN bridge |
54 | must be configured for In-band management since traffic from the VNF manager | 54 | must be configured for In-band management since traffic from the VNF manager |
55 | and data-path will be sent to only to one port (WAN) of the VNF.</para> | 55 | and data-path will be sent to only to one port (WAN) of the VNF.</para> |
56 | 56 | ||
@@ -83,7 +83,7 @@ | |||
83 | <row> | 83 | <row> |
84 | <entry>uCPE Manager</entry> | 84 | <entry>uCPE Manager</entry> |
85 | 85 | ||
86 | <entry>uCPE Manager IP address must be public (accessible for target) | 86 | <entry>uCPE Manager IP address must be public (accessible for the uCPE device) |
87 | and static</entry> | 87 | and static</entry> |
88 | </row> | 88 | </row> |
89 | </tbody> | 89 | </tbody> |
@@ -95,7 +95,7 @@ | |||
95 | 95 | ||
96 | <orderedlist> | 96 | <orderedlist> |
97 | <listitem> | 97 | <listitem> |
98 | <para>Select the device.</para> | 98 | <para>Select the uCPE device.</para> |
99 | </listitem> | 99 | </listitem> |
100 | 100 | ||
101 | <listitem> | 101 | <listitem> |
@@ -147,11 +147,11 @@ | |||
147 | </tgroup> | 147 | </tgroup> |
148 | </table> | 148 | </table> |
149 | 149 | ||
150 | <para>The connection between the device and uCPE Manager will be recreated | 150 | <para>The connection between the uCPE device and uCPE Manager will be recreated |
151 | and all traffic will pass through the new bridge (ibm-wan-br). The user | 151 | and all traffic will pass through the new bridge (ibm-wan-br). The user |
152 | should be able to continue device configuration. The WAN port of the very | 152 | should be able to continue device configuration. The WAN port of the very |
153 | first instantiated VNF must be connected to ibm-wan-br and it should receive | 153 | first instantiated VNF must be connected to ibm-wan-br and it should receive |
154 | the same IP address as the WAN interfaces of the device.</para> | 154 | the same IP address as the WAN interfaces of the uCPE device.</para> |
155 | 155 | ||
156 | <figure> | 156 | <figure> |
157 | <title>Enea In-band Management solution</title> | 157 | <title>Enea In-band Management solution</title> |
@@ -164,7 +164,7 @@ | |||
164 | </mediaobject> | 164 | </mediaobject> |
165 | </figure> | 165 | </figure> |
166 | 166 | ||
167 | <para>The VNF can be reached on the same IP address as the device, e.g. | 167 | <para>The VNF can be reached on the same IP address as the uCPE device, e.g. |
168 | <literal>https://<WAN_IP></literal> if a HTTP server is present | 168 | <literal>https://<WAN_IP></literal> if a HTTP server is present |
169 | on that VNF.</para> | 169 | on that VNF.</para> |
170 | 170 | ||
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 bdaa534..e2e9802 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml | |||
@@ -21,7 +21,7 @@ | |||
21 | 21 | ||
22 | <itemizedlist> | 22 | <itemizedlist> |
23 | <listitem> | 23 | <listitem> |
24 | <para>The Enea NFV Access runtime platform, which acts as the host for | 24 | <para>The Enea NFV Access Run Time Platform, which acts as the host for |
25 | Virtualized Network Functions (VNFs) and provides management over | 25 | Virtualized Network Functions (VNFs) and provides management over |
26 | NETCONF.</para> | 26 | NETCONF.</para> |
27 | </listitem> | 27 | </listitem> |
@@ -34,9 +34,9 @@ | |||
34 | </itemizedlist> | 34 | </itemizedlist> |
35 | 35 | ||
36 | <section id="nfv_access"> | 36 | <section id="nfv_access"> |
37 | <title>Enea NFV Access runtime platform</title> | 37 | <title>Enea NFV Access Run Time Platform</title> |
38 | 38 | ||
39 | <para>Enea NFV Access runtime platform is a lightweight, | 39 | <para>Enea NFV Access Run Time Platform is a lightweight, |
40 | multi-architecture virtualization platform, supporting Virtual Machines | 40 | multi-architecture virtualization platform, supporting Virtual Machines |
41 | (KVM / QEMU) and container(s) (Docker). Designed for a low footprint and | 41 | (KVM / QEMU) and container(s) (Docker). Designed for a low footprint and |
42 | fast boot by only providing essential functionality.</para> | 42 | fast boot by only providing essential functionality.</para> |