summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2019-10-07 11:59:16 +0200
committerGerrit Code Review <gerrit2@sestogerrit02>2019-10-07 11:59:16 +0200
commit85cf46dbd3a665459e1ac8570f7caa5859cdc526 (patch)
treeeb32fb4b5c2b69a1a47fbd567f5806c942e13692
parent9fab541d47b01d1c7bf0b946ab7240fd31c4ac55 (diff)
parent64180464e41ba5bca69c79e1c387df0dfbb44fb7 (diff)
downloadnfv-access-documentation-85cf46dbd3a665459e1ac8570f7caa5859cdc526.tar.gz
Merge "GettingStarted: update Device Conf & Prov" into rocko
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml634
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.pngbin15222 -> 32885 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml175
3 files changed, 349 insertions, 460 deletions
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 935c9df..5d980fc 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
@@ -2,20 +2,20 @@
2<chapter id="getting_started_ucpe_manager"> 2<chapter id="getting_started_ucpe_manager">
3 <title>Getting Started with Enea uCPE Manager</title> 3 <title>Getting Started with Enea uCPE Manager</title>
4 4
5 <section id="prere"> 5 <section id="prereq_ucpe">
6 <title>Prerequisites</title> 6 <title>Prerequisites</title>
7 7
8 <para>Listed below are the main generic prerequisites required so that 8 <para>Listed below are the main generic prerequisites required so that the
9 uCPE Manager can be deployed on your host platform:</para> 9 uCPE Manager can be deployed on the host platform:</para>
10 10
11 <itemizedlist> 11 <itemizedlist>
12 <listitem> 12 <listitem>
13 <para>A device that is supported by NFV Access.</para> 13 <para>A device that supports NFV Access.</para>
14 </listitem> 14 </listitem>
15 15
16 <listitem> 16 <listitem>
17 <para>A machine running either Windows or CentOS with network access 17 <para>A machine running CentOS with network access to the physical
18 to the physical device.</para> 18 device.</para>
19 </listitem> 19 </listitem>
20 </itemizedlist> 20 </itemizedlist>
21 </section> 21 </section>
@@ -23,35 +23,23 @@
23 <section id="install_ucpe_manager"> 23 <section id="install_ucpe_manager">
24 <title>Install the Enea uCPE Manager</title> 24 <title>Install the Enea uCPE Manager</title>
25 25
26 <para>Unpack the uCPE Manager and install it by following the instructions 26 <para>Unpack the uCPE Manager and install it following the instructions
27 provided within the release archive: 27 provided within the release archive:
28 <literal>[unpacked_folder]/dist/README</literal>.</para> 28 <literal>[unpacked_folder]/dist/README</literal>.</para>
29 29
30 <para>There are a few things to consider during the installation phase, as 30 <para>There are things to consider during the installation phase, as
31 there are a few steps where user input is required. In most cases, the 31 there are a few steps where user input is required. In most cases, the
32 default values should be used.</para> 32 default values should be used.</para>
33 33
34 <para>For demo purposes, use the internal PostgreSQL database (which 34 <note><para>Check that the CentOS machine where the uCPE Manager is installed
35 defaults to Y), and not the machine as part of a cluster (which defaults 35 has the firewall disabled.</para></note>
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
38 role="bold">ucpemanager</emphasis> service. A good example for an
39 acceptable password would
40 be:<emphasis>_1ucpe#2manager!3_</emphasis>.</para>
41
42 <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
44 Windows 10, go to the Control Panel, then inside <literal>Network &amp;
45 Internet</literal> and <literal>Firewall &amp; Network
46 Protection</literal>, disable the firewall for "Domain network" and
47 "Private network".</para>
48 36
49 <para>Verify that the installation has succeeded:</para> 37 <para>Verify that the installation has succeeded:</para>
50 38
51 <orderedlist> 39 <orderedlist>
52 <listitem> 40 <listitem>
53 <para>Point your browser to the server machine running the uCPE 41 <para>Point your browser to the server machine running the uCPE
54 Manager: <literal>https://localhost</literal>.</para> 42 Manager.</para>
55 </listitem> 43 </listitem>
56 44
57 <listitem> 45 <listitem>
@@ -73,10 +61,14 @@
73 infrastructure.</para> 61 infrastructure.</para>
74 62
75 <section id="man_config"> 63 <section id="man_config">
76 <title>Manual Addition</title> 64 <title>Direct Connection</title>
65
66 <para>When using this mechanism, the uCPE Manager will periodically poll
67 the uCPE device, using a specified IP address as the destination, attempting
68 to establish a management connection.</para>
77 69
78 <para>Add the uCPE device running the NFV Access Run Time Platform to 70 <para>Add the uCPE device running the NFV Access Run Time Platform to
79 the management system: <literal>Devices -&gt; Manage -&gt; 71 the management system by selecting <literal>Devices -&gt; Manage -&gt;
80 Add</literal>. Supply information about the uCPE device, and set the 72 Add</literal>. Supply information about the uCPE device, and set the
81 parameters that will be used to connect to it.</para> 73 parameters that will be used to connect to it.</para>
82 74
@@ -85,7 +77,7 @@
85 <itemizedlist> 77 <itemizedlist>
86 <listitem> 78 <listitem>
87 <para>Type. The type of device to be added, i.e <literal>Enea 79 <para>Type. The type of device to be added, i.e <literal>Enea
88 universal uCPE</literal>.</para> 80 universal CPE</literal>.</para>
89 </listitem> 81 </listitem>
90 </itemizedlist> 82 </itemizedlist>
91 83
@@ -98,25 +90,19 @@
98 90
99 <itemizedlist> 91 <itemizedlist>
100 <listitem> 92 <listitem>
101 <para>IP Address. IP address of the device. If a device is 93 <para>IP Address. IP address of the device.</para>
102 installed under a local/private network and not directly visible
103 to the uCPE Manager machine, the Gateway IP of the private network
104 must be used.</para>
105 </listitem> 94 </listitem>
106 </itemizedlist> 95 </itemizedlist>
107 96
108 <itemizedlist> 97 <itemizedlist>
109 <listitem> 98 <listitem>
110 <para>SSH Port. The NETCONF Port used for communications. This is 99 <para>SSH Port. The NETCONF Port used for communications.</para>
111 a relevant parameter if the standard NETCONF SSH (i.e. not
112 Call-Home) is being used. Default is set to 830.</para>
113 </listitem> 100 </listitem>
114 </itemizedlist> 101 </itemizedlist>
115 102
116 <itemizedlist> 103 <itemizedlist>
117 <listitem> 104 <listitem>
118 <para>SSH User Name. The user name for SSH connectivity. Default 105 <para>SSH User Name. The user name for SSH connectivity.</para>
119 user is <literal>root</literal>.</para>
120 </listitem> 106 </listitem>
121 </itemizedlist> 107 </itemizedlist>
122 108
@@ -136,8 +122,8 @@
136 122
137 <itemizedlist> 123 <itemizedlist>
138 <listitem> 124 <listitem>
139 <para>Device ID. The unique instance ID of the device. This is 125 <para>Device ID. The unique instance ID of the device. This links
140 what links a device to its day-0 configuration (stored in the 126 a device to its day-0 configuration (stored in the
141 offline configuration system). It is a required field if you want 127 offline configuration system). It is a required field if you want
142 to perform Zero-Touch Provisioning.</para> 128 to perform Zero-Touch Provisioning.</para>
143 </listitem> 129 </listitem>
@@ -145,22 +131,29 @@
145 </section> 131 </section>
146 132
147 <section id="using_call_home"> 133 <section id="using_call_home">
148 <title>Using Call-Home</title> 134 <title>Device Call Home Connection</title>
149 135
150 <para>The uCPE Manager must be configured to bring the uCPE device 136 <para>Follow the same steps as described in previous section, making sure
151 under management. This is done by selecting the <literal>Device Calls 137 that the <literal>Device Calls Home</literal> checkbox is selected.</para>
152 Home</literal> checkbox when adding a device. When Device Calls Home 138
153 is checked, the device will initiate a connection by opening a socket 139 <para>When using this mechanism, the device will initiate a connection
154 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE 140 to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
155 Manager waits for device connection.</para> 141 Manager waits for a device connection. Make sure the uCPE Manager IP
142 address has been configured on the device. For more information please see section
143 <link linkend="install_ena_stick">Installing Enea NFV Access</link> for more details.</para>
156 </section> 144 </section>
157 </section> 145 </section>
158 146
159 <section id="host_int_net_config"> 147 <section id="host_int_net_config">
160 <title>Prepare uCPE device for VNF onboarding</title> 148 <title>Configure NFV Infrastructure</title>
149
150 <para>Once a management connection with the uCPE device has been established
151 by using any of the supported methods, the virtualization networking
152 infrastructure can be configured either manually or by using Zero Touch
153 Provisioning.</para>
161 154
162 <para>The uCPE Manager can list network interfaces found on a device by 155 <para>The uCPE Manager can list network interfaces found on a device by
163 selecting: <literal>Device</literal> -&gt; 156 selecting the uCPE device first and then selecting
164 <literal>Configuration</literal> -&gt; <literal>OpenVSwitch 157 <literal>Configuration</literal> -&gt; <literal>OpenVSwitch
165 </literal>-&gt; <literal>Host Interface Caps</literal>:</para> 158 </literal>-&gt; <literal>Host Interface Caps</literal>:</para>
166 159
@@ -175,234 +168,301 @@
175 </mediaobject> 168 </mediaobject>
176 </figure> 169 </figure>
177 170
178 <para>Network interfaces can be set in three modes: DPDK, SR-IOV and 171 <para>Available network interfaces can be added to the management
179 PCI-Passthrough.</para> 172 system, for use by the networking virtualization infrastructure.</para>
180 173
181 <section id="dpdk_interface"> 174 <section id="man_configuration">
182 <title>DPDK Interface Type</title> 175 <title>Manual Configuration</title>
183 176
184 <para>Configuring a physical interface in DPDK mode will require a 177 <para>For Manual Configuration of uCPE networking, select the uCPE device
185 DPDK-based application (e.g. OVS-DPDK) in order to access and use the 178 first and then <literal>Configuration</literal> -&gt; <literal>OpenVSwitch</literal>.
186 interface. An interface set as DPDK can be attached to an OVS-DPDK 179 In the <literal>Host Interfaces Caps</literal>, one can find a list of available network
187 bridge. Select the uCPE device, then from the top toolbar select: 180 interfaces and their capabilities.</para>
188 <literal>Configuration</literal> -&gt;<literal> OpenVSwitch
189 </literal>-&gt; <literal>Host Interfaces</literal> -&gt;<literal>
190 Add</literal>:</para>
191 181
192 <figure> 182 <section id="configure_interfaces">
193 <title>DPDK Host Interface</title> 183 <title>Configuring Interfaces</title>
194 184
195 <mediaobject> 185 <para><emphasis role="bold">DPDK Interface Type</emphasis></para>
196 <imageobject>
197 <imagedata align="center"
198 fileref="images/dpdk_interface_type.png" scale="90" />
199 </imageobject>
200 </mediaobject>
201 </figure>
202 186
203 <para>For DPDK mode, the user must set following fields:</para> 187 <para>Configuring a physical interface in DPDK mode will require a
188 DPDK-based application (e.g. OVS-DPDK) in order to access and use
189 the interface. An interface set as the DPDK can be attached to an
190 OVS-DPDK bridge.</para>
191
192 <para>Select the uCPE device, then from the top toolbar
193 select <literal>Configuration</literal> -&gt; <literal>OpenVSwitch
194 </literal> -&gt; <literal>Host Interfaces</literal> -&gt; <literal>
195 Add</literal>.</para>
204 196
205 <itemizedlist> 197 <para>For DPDK mode, the user must set values for the following fields:</para>
206 <listitem>
207 <para>Source: PCI address of the physical interface</para>
208 </listitem>
209 198
210 <listitem> 199 <itemizedlist>
211 <para>Type: dpdk</para> 200 <listitem>
212 </listitem> 201 <para>Source: the PCI address of the physical interface.</para>
202 </listitem>
213 203
214 <listitem> 204 <listitem>
215 <para>Networking-type: dpdk</para> 205 <para>Type: dpdk</para>
216 </listitem> 206 </listitem>
217 207
218 <listitem> 208 <listitem>
219 <para>Dpdk-type: kernel module that allow user space access of 209 <para>Networking-type: dpdk</para>
220 physical interface</para> 210 </listitem>
221 </listitem>
222 </itemizedlist>
223 211
224 <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on the 212 <listitem>
225 device that uses a DPDK interface, by selecting the uCPE device, then 213 <para>Dpdk-type: the kernel module that allows user space access to the
226 from the top toolbar selecting: <literal>Configuration</literal>-&gt; 214 physical interface.</para>
227 <literal>OpenVSwitch</literal> -&gt; <literal>Bridges</literal> -&gt; 215 </listitem>
228 <literal>Add</literal>:</para> 216 </itemizedlist>
229 217
230 <figure> 218 <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on
231 <title>OVS bridge</title> 219 the device that uses a DPDK interface, by selecting the uCPE device,
220 then from the top toolbar selecting <literal>Configuration</literal>
221 -&gt; <literal>OpenVSwitch</literal> -&gt; <literal>Bridges</literal> -&gt;
222 <literal>Add</literal>.</para>
232 223
233 <mediaobject> 224 <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para>
234 <imageobject>
235 <imagedata align="center" fileref="images/ovs_bridge.png"
236 scale="95" />
237 </imageobject>
238 </mediaobject>
239 </figure>
240 </section>
241 225
242 <section id="sriov_interface_type"> 226 <para>SR-IOV mode will create a number of virtual functions on the host
243 <title>SR-IOV Interface Type</title> 227 which can be used to route traffic to VMs. Select the uCPE device,
228 then from the top toolbar select <literal>Configuration</literal>
229 -&gt; <literal>OpenVSwitch</literal> -&gt; <literal>Host Interfaces
230 </literal> -&gt; <literal>Add</literal>.</para>
244 231
245 <para>SR-IOV mode will create a number of virtual functions on host 232 <para>For SR-IOV mode, the user must set values for the following fields:</para>
246 that can be used to route traffic to VMs. Select the uCPE device, then
247 from the top toolbar select: <literal>Configuration</literal>
248 -&gt;<literal> OpenVSwitch </literal>-&gt; <literal>Host Interfaces
249 </literal>-&gt;<literal> Add</literal>:</para>
250 233
251 <para>For SR-IOV mode, the user must set following fields:</para> 234 <itemizedlist>
235 <listitem>
236 <para>Source: the PCI address of the physical interface.</para>
237 </listitem>
252 238
253 <itemizedlist> 239 <listitem>
254 <listitem> 240 <para>Type: sr-iov</para>
255 <para>Source: PCI address of the physical interface</para> 241 </listitem>
256 </listitem>
257 242
258 <listitem> 243 <listitem>
259 <para>Type: sr-iov</para> 244 <para>Networking-type: srIov</para>
260 </listitem> 245 </listitem>
261 246
262 <listitem> 247 <listitem>
263 <para>Networking-type: srIov</para> 248 <para>sriov-mode: adapter-pool</para>
264 </listitem> 249 </listitem>
265 250
266 <listitem> 251 <listitem>
267 <para>sriov-mode: adapter-pool</para> 252 <para>sriov-num-vfs: the number of virtual functions to
268 </listitem> 253 create.</para>
254 </listitem>
255 </itemizedlist>
269 256
270 <listitem> 257 <para><emphasis role="bold">PCI Passthrough Interface
271 <para>sriov-num-vfs: the number of virtual functions to 258 Type</emphasis></para>
272 create</para>
273 </listitem>
274 </itemizedlist>
275 259
276 <figure> 260 <para>For the PCI Passthrough a user does not have to configure a
277 <title>SR-IOV Interface Type</title> 261 physical interface, instead simply select the PCI address and
262 connect it to a virtual port when the VNF instantiation step is reached.</para>
263 </section>
278 264
279 <mediaobject> 265 <section id="configure_bridges">
280 <imageobject> 266 <title>Configuring Bridges</title>
281 <imagedata align="center"
282 fileref="images/sriov_interface_type.png" scale="90" />
283 </imageobject>
284 </mediaobject>
285 </figure>
286 </section>
287 267
288 <section id="pci_interface_type"> 268 <para><emphasis role="bold">In-band Management</emphasis></para>
289 <title>PCI Passthrough Interface Type</title>
290 269
291 <para>For PCI Passthrough the user does not have to configure a 270 <para>In-band Management refers to a model where both the data plane
292 physical interface, instead simply select the PCI address and connect 271 and control plane flow over the same network path.</para>
293 it to a virtual port at the VNF instantiation step.</para>
294 </section>
295 </section>
296 272
297 <section id="zero_touch_prov"> 273 <para>In some situations, In-band Management is the only option
298 <title>Zero Touch Provisioning</title> 274 available to both control and configure the uCPE device, while also
299 275 allowing for data-path traffic to pass over the same physical
300 <para>Zero-Touch Provisioning (ZTP) is an alternative to Manual 276 interface.</para>
301 configuration. ZTP refers to the process by which, when a device starts
302 up for the first time, its initial configuration is pushed down by an
303 external management system, so that it is setup for proper operation
304 without additional manual intervention by an operator.</para>
305
306 <para>A variety of operations can occur as part of ZTP such as initial
307 device setup, configuration of managed objects, etc. The goal is to set
308 up a device to the maximum possible extent without forcing an operator
309 to be physically present (initially) to manage the device.</para>
310
311 <para>In order to create a static configuration supporting ZTP, the uCPE
312 Manager user needs to identify the <literal>Device ID</literal> of the
313 machine running NFV Access.</para>
314
315 <para>During the automatic installation process when the
316 <literal>Automatic install</literal> step is reached, enter the option
317 menu <literal>Customize kernel parameters</literal> and set the
318 <literal>uCPE Manager IP address</literal>. Please check <xref
319 linkend="install_ena_stick" />, for how to set the uCPE Manager IP
320 address at boot time. The Device ID will be listed in the installer
321 under the <literal>Customize kernel parameters</literal> menu.</para>
322
323 <para>With the address parameter set, run
324 <literal>list_deviceID.sh</literal> after NFV Access is installed and
325 booted, to get the device ID of the uCPE device.</para>
326
327 <note>
328 <para>It is possible to let NFV Access know the uCPE Manager IP
329 address at run-time by setting <literal>vcpemgr=&lt;IP&gt;</literal>
330 as a kernel boot parameter in the grub configuration file. Reboot is
331 required after this update.</para>
332
333 <para>This step needs to be done each time the uCPE Manager host
334 changes its IP address.</para>
335 </note>
336
337 <para>An offline configuration can be prepared in advance for the uCPE
338 Manager to setup the infrastructure on the device.</para>
339
340 <section id="offline_configuration">
341 <title>Offline Configuration</title>
342
343 <para>The Offline Configuration subsystem is used to pre-populate a
344 configuration for a device that will be brought under management at a
345 future point in time. When creating an offline configuration store, an
346 optional<literal> Device ID</literal> can be specified - this ID
347 uniquely identifies the device to be initialized.</para>
348
349 <para>Use the GUI (shown below) launched by the <literal>Applications
350 -&gt; Offline Config -&gt; Add</literal> menu:</para>
351 277
352 <figure> 278 <para>The main requirement in order to use this solution is to have all
353 <title>Onboard New VNF</title> 279 traffic pass through a defined WAN physical port.</para>
354 280
355 <mediaobject> 281 <para>Three types of traffic are mentioned hereafter:</para>
356 <imageobject>
357 <imagedata align="center" fileref="images/offline_config.png"
358 scale="80" />
359 </imageobject>
360 </mediaobject>
361 </figure>
362 282
363 <para>Specify the exact value of the <literal>Device ID</literal> in 283 <itemizedlist>
364 the required field. This will tag the device needed for the initial 284 <listitem>
365 configuration provided by the offline configuration store. Choose 285 <para>Device management. Part of the device configuration done by the
366 <literal>Merge</literal> as the Default Upload Method if you do not 286 uCPE Manager.</para>
367 want any boot configuration set on the device, to be wiped out. 287 </listitem>
368 Selecting <literal>Replace</literal> will set the entire device 288
369 configuration to match values in the offline configuration.</para> 289 <listitem>
370 290 <para>VNF(s) configuration. Enabling or disabling features of a
371 <para>After creating the Offline Config Store, access the device 291 VNF. E.g. enabling/disabling the firewall or VPN setup.</para>
372 through <literal> Applications -&gt; offline config -&gt; Config 292 </listitem>
373 App</literal> and provision it with the required initial
374 configuration. This operation mirrors what happens during regular
375 offline configuration.</para>
376
377 <para>Now that the store has been provisioned successfully, it is
378 ready to send this configuration to the device when it first comes
379 online.</para>
380 </section>
381 293
382 <section id="initial_communications"> 294 <listitem>
383 <title>Initial Communications</title> 295 <para>Data-path. All other traffic that is not used in the
296 control plane and needs to reach a LAN network.</para>
297 </listitem>
298 </itemizedlist>
384 299
385 <para>There are two possible paths to this process, depending upon 300 <note>
386 whether or not NETCONF Call-Home functionality is used:</para> 301 <para>For use-cases where latency is very important, it is
302 recommended to use out-of-band management with a dedicated
303 physical interface for the data-path.</para>
304 </note>
305
306 <para>The solution provided by Enea for In-band management is based
307 upon Open vSwitch bridges which control all traffic passing through
308 the WAN physical port. The NFV Access platform will assume the activated
309 connection with the uCPE Manager should be used for In-band management.
310 The physical port used by the active connection will be attached to the
311 In-band management WAN bridge. Communication with the uCPE Manager
312 should not be affected, it is reestablished automatically after In-band management
313 activation.</para>
314
315 <para>All network traffic, with the exception of any received from
316 the uCPE Manager, will be sent to the VNF or dropped if there
317 is no VNF instantiated on the uCPE device. The VNF connected to the
318 WAN bridge must be configured for In-band management since traffic
319 from the VNF manager and data-path will be sent to only one port
320 (WAN) of the VNF.</para>
321
322 <note>
323 <para>Only one VNF must be connected to the In-band management WAN
324 bridge.</para>
325 </note>
326
327 <table>
328 <title>Setup Prerequisites</title>
329
330 <tgroup cols="2">
331 <colspec align="left" colwidth="2*" />
332
333 <colspec align="left" colwidth="4*" />
334
335 <tbody>
336 <row>
337 <entry>WAN port</entry>
338
339 <entry>The physical port supported by DPDK.</entry>
340 </row>
341
342 <row>
343 <entry>Dynamic IP on WAN port</entry>
344
345 <entry>The DHCP server configured to distribute the same IP address
346 for the same MAC.</entry>
347 </row>
348
349 <row>
350 <entry>uCPE Manager</entry>
351
352 <entry>The uCPE Manager IP address must be public (accessible
353 for the uCPE device) and static.</entry>
354 </row>
355 </tbody>
356 </tgroup>
357 </table>
358
359 <para><emphasis role="bold">How to activate In-band Management from
360 the uCPE Manager</emphasis></para>
361
362 <orderedlist>
363 <listitem>
364 <para>Select the uCPE device.</para>
365 </listitem>
387 366
388 <orderedlist> 367 <listitem>
389 <listitem> 368 <para>Select Configuration.</para>
390 <para>If Call-Home is not enabled/supported, the uCPE Manager 369 </listitem>
391 creates a SSH session to the device over the port configured
392 through the <literal>Add Device </literal> process (default 830).
393 It then initiates NETCONF communications over this session.</para>
394 </listitem>
395 370
396 <listitem> 371 <listitem>
397 <para>If the device uses Call-Home, it creates a socket connection 372 <para>Click OpenvSwitch.</para>
398 to port 4334 on the management system which runs the uCPE Manager. 373 </listitem>
399 The uCPE Manager then creates a SSH session over this socket and 374
400 initiates NETCONF communications as a client.</para> 375 <listitem>
401 </listitem> 376 <para>Select the Bridges option, then click Add.</para>
402 </orderedlist> 377 </listitem>
378 </orderedlist>
379
380 <para>
381 <emphasis role="bold">In-band management WAN DPDK bridge configuration</emphasis>
382 </para>
383
384 <itemizedlist>
385 <listitem><para><emphasis role="bold">name</emphasis>. Provide a name for the WAN bridge e.g.
386 "ibm-wan-br".</para></listitem>
387 <listitem><para><emphasis role="bold">ovs-bridge-type</emphasis>. dpdkWan</para></listitem>
388 <listitem><para><emphasis role="bold">mgmt-address</emphasis>. IPv4 (add the IP address of the uCPE Manager machine).</para></listitem>
389 <listitem><para><emphasis role="bold">mgmt-port</emphasis>. 4334</para></listitem>
390 </itemizedlist>
391
392 <para>The connection between the uCPE device and uCPE Manager will
393 be recreated and all traffic will pass through the new bridge
394 (ibm-wan-br). The WAN port of the very first instantiated VNF must
395 be connected to the <literal>ibm-wan-br</literal> bridge and it
396 should receive the same IP address as the WAN interfaces of the uCPE device.</para>
397
398 <figure>
399 <title>Enea In-band Management solution</title>
400
401 <mediaobject>
402 <imageobject>
403 <imagedata align="center"
404 fileref="images/In-bandManagement.png" scale="65" />
405 </imageobject>
406 </mediaobject>
407 </figure>
408
409 <para>The VNF can be reached on the same IP address as the uCPE
410 device, e.g. <literal>https://&lt;WAN_IP&gt;</literal> if a HTTP
411 server is present on that VNF.</para>
412
413 <note>
414 <para>The In-band management bridge must be recreated each time
415 the uCPE Manager IP is changed.</para>
416 </note>
417 </section>
418 </section>
403 419
404 <para>Once communications with the device have been established, the 420 <section id="zero_touch_prov">
405 Device Manager will try and connect to it.</para> 421 <title>Zero Touch Provisioning</title>
422
423 <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device
424 starts up for the first time and its initial configuration is pushed down
425 by an external management system, so that it is setup for proper
426 operation without additional manual intervention by an
427 operator. ZTP is an alternative to Manual configuration.</para>
428
429 <para>A variety of operations can occur as part of ZTP such as initial
430 device setup, configuration of managed objects, etc. The goal is to
431 set up a device to the maximum possible extent without forcing an
432 operator to be physically present (initially) to manage the
433 device.</para>
434
435 <para>An offline configuration can be prepared in advance for the uCPE
436 Manager to setup the infrastructure on the device.</para>
437
438 <section id="offline_configuration">
439 <title>Offline Configuration</title>
440
441 <para>The Offline Configuration subsystem is used to pre-populate a
442 configuration for a device that will be brought under management at
443 a future point in time.</para>
444
445 <para>When creating an offline configuration store a
446 <literal>Device ID</literal> can be specified. This ID
447 uniquely identifies the device to be initialized.</para>
448
449 <para>From the top toolbar menu select <literal>Applications</literal> -&gt;
450 <literal>Offline Config</literal> -&gt; <literal>Add</literal>.
451 Specify the exact value of the <literal>Device ID</literal> in the
452 required field. This will tag the device needed for
453 the initial configuration provided by the
454 offline configuration store. Choose <literal>Merge</literal> as the
455 "Default Upload Method" if you do not want any boot configuration set
456 on the device, to be wiped out. Selecting <literal>Replace</literal>
457 will set the entire device configuration to match values in the
458 offline configuration.</para>
459
460 <para>After creating the Offline Config Store, access the device
461 through <literal>Applications</literal> -&gt; <literal>offline config</literal>
462 -&gt; <literal>Config App</literal> and provision it with the required initial
463 configuration. This operation mirrors what happens during regular
464 offline configuration.</para>
465 </section>
406 </section> 466 </section>
407 </section> 467 </section>
408 </section> 468 </section>
@@ -410,10 +470,9 @@
410 <section id="vnf_management"> 470 <section id="vnf_management">
411 <title>VNF Management</title> 471 <title>VNF Management</title>
412 472
413 <para>The Enea uCPE Manager is responsible for 473 <para>The Enea uCPE Manager is responsible for onboarding, configuring
414 onboarding, configuring (e.g. CloudInit) and ensuring life cycle 474 (e.g. CloudInit) and ensuring life cycle management of VNFs that are
415 management of VNFs that are instantiated and run on the various uCPE 475 instantiated and run on the various uCPE devices.</para>
416 devices.</para>
417 476
418 <section id="onboarding_a_vnf"> 477 <section id="onboarding_a_vnf">
419 <title>Onboarding a VNF</title> 478 <title>Onboarding a VNF</title>
@@ -423,8 +482,8 @@
423 uCPE devices). This is accomplished using the Enea uCPE Manager 482 uCPE devices). This is accomplished using the Enea uCPE Manager
424 Onboarding graphical user interface.</para> 483 Onboarding graphical user interface.</para>
425 484
426 <para>Typically, the Getting Started Guide of a VNF contains all necessary 485 <para>Typically, the Getting Started Guide of a VNF contains all
427 information needed to onboard a VNF.</para> 486 necessary information needed to onboard a VNF.</para>
428 487
429 <section id="retrieve_art"> 488 <section id="retrieve_art">
430 <title>Retrieving Artifacts</title> 489 <title>Retrieving Artifacts</title>
@@ -438,7 +497,8 @@
438 </listitem> 497 </listitem>
439 498
440 <listitem> 499 <listitem>
441 <para>Procure any VNF-specific files from the VNF vendor, e.g. license file.</para> 500 <para>Procure any VNF-specific files from the VNF vendor, e.g.
501 license file.</para>
442 502
443 <note> 503 <note>
444 <para>There are no standard ways of managing VNF licenses, 504 <para>There are no standard ways of managing VNF licenses,
@@ -477,11 +537,13 @@
477 <para>This decides what resources the VNF is configured for, 537 <para>This decides what resources the VNF is configured for,
478 along with networking and day zero configurations.</para> 538 along with networking and day zero configurations.</para>
479 539
480 <note><para>Generally, the Getting Started Guide for the VNF 540 <note>
481 provides guidelines for resource allocation, but since 541 <para>Generally, the Getting Started Guide for the VNF
482 performance is dependent on hardware capacity, the right 542 provides guidelines for resource allocation, but since
483 resource allocation for deployment is determined 543 performance is dependent on hardware capacity, the right
484 through benchmarking.</para></note> 544 resource allocation for deployment is determined through
545 benchmarking.</para>
546 </note>
485 </listitem> 547 </listitem>
486 548
487 <listitem> 549 <listitem>
@@ -533,22 +595,22 @@
533 595
534 <listitem> 596 <listitem>
535 <para>When prompted by the UI, make sure the <literal>VM 597 <para>When prompted by the UI, make sure the <literal>VM
536 Image</literal> radio button at the top of the onboarding 598 Image</literal> radio button at the top of the onboarding screen
537 screen is selected, it will trigger a popup menu.</para> 599 is selected, it will trigger a popup menu.</para>
538 </listitem> 600 </listitem>
539 </orderedlist> 601 </orderedlist>
540 602
541 <para>This menu contains data fields where both necessary and optional 603 <para>This menu contains data fields where both necessary and optional
542 information about the VNF can be supplied. After doing so, press 604 information about the VNF can be supplied. After doing so, press the
543 the onboard button, the uCPE Manager will create the VNF package and onboard it.</para> 605 onboard button, the uCPE Manager will create the VNF package and
606 onboard it.</para>
544 607
545 <figure> 608 <figure>
546 <title>Onboard a VNF</title> 609 <title>Onboard a VNF</title>
547 610
548 <mediaobject> 611 <mediaobject>
549 <imageobject> 612 <imageobject>
550 <imagedata align="center" 613 <imagedata align="center" contentwidth="600"
551 contentwidth="600"
552 fileref="images/onboard_a_vnf_image.png" /> 614 fileref="images/onboard_a_vnf_image.png" />
553 </imageobject> 615 </imageobject>
554 </mediaobject> 616 </mediaobject>
@@ -559,9 +621,9 @@
559 <itemizedlist> 621 <itemizedlist>
560 <listitem> 622 <listitem>
561 <para><emphasis role="bold">VM Image File</emphasis>. This is the 623 <para><emphasis role="bold">VM Image File</emphasis>. This is the
562 Virtual Machine image file for the VNF. Typically, it is a 624 Virtual Machine image file for the VNF. Typically, it is a QCOW
563 QCOW image. Press <literal>Choose File</literal> and select the 625 image. Press <literal>Choose File</literal> and select the image
564 image you wish to upload.</para> 626 you wish to upload.</para>
565 </listitem> 627 </listitem>
566 628
567 <listitem> 629 <listitem>
@@ -577,8 +639,8 @@
577 639
578 <listitem> 640 <listitem>
579 <para><emphasis role="bold">Description</emphasis>. This field 641 <para><emphasis role="bold">Description</emphasis>. This field
580 contains any description provided and is only displayed 642 contains any description provided and is only displayed in the GUI
581 in the GUI tables in the uCPE Manager.</para> 643 tables in the uCPE Manager.</para>
582 </listitem> 644 </listitem>
583 645
584 <listitem> 646 <listitem>
@@ -616,13 +678,14 @@
616 <para>This table will contain the interfaces required by this VNF to 678 <para>This table will contain the interfaces required by this VNF to
617 be configured, when creating an instance. Consult the VNF vendor to 679 be configured, when creating an instance. Consult the VNF vendor to
618 determine which and how many are required. Each interface requires a 680 determine which and how many are required. Each interface requires a
619 name, and optionally a description, used only by the uCPE Manager.</para> 681 name, and optionally a description, used only by the uCPE
682 Manager.</para>
620 683
621 <para><emphasis role="bold">Cloud Init Tab</emphasis></para> 684 <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
622 685
623 <para>Click the <literal>Clout Init</literal> tab to provide the 686 <para>Click the <literal>Clout Init</literal> tab to provide the
624 Clout-Init configuration. There are three fields that need to be 687 Clout-Init configuration. There are three fields that need to be
625 populated:</para> 688 populated:</para>
626 689
627 <orderedlist> 690 <orderedlist>
628 <listitem> 691 <listitem>
@@ -630,9 +693,9 @@
630 Datasource</emphasis></para> 693 Datasource</emphasis></para>
631 694
632 <para>To onboard a VNF you must specify the <literal>Cloud-Init 695 <para>To onboard a VNF you must specify the <literal>Cloud-Init
633 Datasource</literal> that the VNF uses. This 696 Datasource</literal> that the VNF uses. This information is
634 information is procured from the VNF Vendor. Choose one of the following 697 procured from the VNF Vendor. Choose one of the following methods
635 methods to specify the datasource:</para> 698 to specify the datasource:</para>
636 699
637 <itemizedlist spacing="compact"> 700 <itemizedlist spacing="compact">
638 <listitem> 701 <listitem>
@@ -690,10 +753,10 @@
690 753
691 <para>In this table, you can enter values for properties that will be 754 <para>In this table, you can enter values for properties that will be
692 used during instantiation of the VNF. The values will augment the 755 used during instantiation of the VNF. The values will augment the
693 default values in the <filename>Domain.XML</filename> file used 756 default values in the <filename>Domain.XML</filename> file used by
694 by <literal>libvirt/virsh</literal> (running in NFV Access) when 757 <literal>libvirt/virsh</literal> (running in NFV Access) when creating
695 creating an instance of the VNF. Consult with the VNF Vendor 758 an instance of the VNF. Consult with the VNF Vendor or ENEA support
696 or ENEA support for values needed by specific VNFs.</para> 759 for values needed by specific VNFs.</para>
697 760
698 <para><emphasis role="bold">Property Values</emphasis></para> 761 <para><emphasis role="bold">Property Values</emphasis></para>
699 762
@@ -706,9 +769,9 @@
706 <title>Instantiating a VNF</title> 769 <title>Instantiating a VNF</title>
707 770
708 <para>When a VNF is onboarded and available in the VNF catalog, it can 771 <para>When a VNF is onboarded and available in the VNF catalog, it can
709 be instantiated on connected uCPE devices. The configurations 772 be instantiated on connected uCPE devices. The configurations provided
710 provided when the VNF is onboarded, serve as a template for instantiation. 773 when the VNF is onboarded, serve as a template for instantiation. Follow
711 Follow the instructions below to instantiate a VNF:</para> 774 the instructions below to instantiate a VNF:</para>
712 775
713 <orderedlist> 776 <orderedlist>
714 <listitem> 777 <listitem>
@@ -757,8 +820,8 @@
757 </listitem> 820 </listitem>
758 821
759 <listitem> 822 <listitem>
760 <para>Add VNF-specific configuration data by uploading a Cloud-Init file 823 <para>Add VNF-specific configuration data by uploading a Cloud-Init
761 (when the Cloud-Init is used).</para> 824 file (when the Cloud-Init is used).</para>
762 </listitem> 825 </listitem>
763 826
764 <listitem> 827 <listitem>
@@ -766,8 +829,8 @@
766 </listitem> 829 </listitem>
767 830
768 <listitem> 831 <listitem>
769 <para>Hit the <literal>Create</literal> button to deploy the 832 <para>Hit the <literal>Create</literal> button to deploy the VNF and
770 VNF and run it on the specified uCPE device.</para> 833 run it on the specified uCPE device.</para>
771 </listitem> 834 </listitem>
772 </orderedlist> 835 </orderedlist>
773 836
@@ -785,8 +848,9 @@
785 848
786 <orderedlist> 849 <orderedlist>
787 <listitem> 850 <listitem>
788 <para>SSH to the uCPE device from the Enea uCPE Manager (<literal>Device-&gt;SSH</literal>) 851 <para>SSH to the uCPE device from the Enea uCPE Manager
789 with default user and password: <literal>root</literal>.</para> 852 (<literal>Device-&gt;SSH</literal>) with default user and password:
853 <literal>root</literal>.</para>
790 </listitem> 854 </listitem>
791 855
792 <listitem> 856 <listitem>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png
index 5adb5c2..42188a5 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png
Binary files differ
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
deleted file mode 100644
index 6f5cdb1..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
+++ /dev/null
@@ -1,175 +0,0 @@
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="in_band_managemen">
5 <title>In-band Management</title>
6
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>
9
10 <para>In some situations, In-band Management is the only option available to
11 both control and configure the uCPE device, while also allowing for data-path
12 traffic to pass over the same physical interface.</para>
13
14 <para>The main requirement for this use case solution is to have all traffic
15 pass through a defined WAN physical port.</para>
16
17 <para>Three types of traffic are mentioned:</para>
18
19 <itemizedlist>
20 <listitem>
21 <para>Device management - e.g.: device configuration
22 done by the uCPE Manager.</para>
23 </listitem>
24
25 <listitem>
26 <para>VNF(s) configuration - enabling or disabling features of a VNF.
27 E.g. enabling/disabling the firewall or VPN setup.</para>
28 </listitem>
29
30 <listitem>
31 <para>Data-path - all the other traffic that is not used in the control
32 plane and needs to reach a LAN network.</para>
33 </listitem>
34 </itemizedlist>
35
36 <note>
37 <para>For use-cases where latency is very important, it is recommended to
38 use out-of-band management with a dedicated physical interface for the
39 data-path.</para>
40 </note>
41
42 <para>The solution provided by Enea for In-band management is based upon
43 Open vSwitch bridges which control all traffic passing through the WAN
44 physical port. Note that the NFV Access platform will assume that the
45 activated connection with the uCPE Manager should be used for In-band
46 management. The physical port used by the active connection will be attached
47 to the In-band management WAN bridge. Communication with the uCPE Manager
48 should not be affected, it is reestablished automatically after In-band
49 management activation.</para>
50
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
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
55 and data-path will be sent to only to one port (WAN) of the VNF.</para>
56
57 <note>
58 <para>Only one VNF must be connected to the In-band management WAN bridge.</para>
59 </note>
60
61 <table>
62 <title>Setup Prerequisites</title>
63
64 <tgroup cols="2">
65 <colspec align="left" colwidth="2*" />
66
67 <colspec align="left" colwidth="4*" />
68
69 <tbody>
70 <row>
71 <entry>WAN port</entry>
72
73 <entry>Physical port supported by DPDK</entry>
74 </row>
75
76 <row>
77 <entry>Dynamic IP on WAN port</entry>
78
79 <entry>DHCP server configured to distribute same IP address for same
80 MAC</entry>
81 </row>
82
83 <row>
84 <entry>uCPE Manager</entry>
85
86 <entry>uCPE Manager IP address must be public (accessible for the uCPE device)
87 and static</entry>
88 </row>
89 </tbody>
90 </tgroup>
91 </table>
92
93 <para><emphasis role="bold">How to activate In-band Management from the uCPE
94 Manager</emphasis></para>
95
96 <orderedlist>
97 <listitem>
98 <para>Select the uCPE device.</para>
99 </listitem>
100
101 <listitem>
102 <para>Select Configuration.</para>
103 </listitem>
104
105 <listitem>
106 <para>Click OpenvSwitch.</para>
107 </listitem>
108
109 <listitem>
110 <para> Select the Bridges option, then click Add.</para>
111 </listitem>
112 </orderedlist>
113
114 <table>
115 <title>In-band management WAN DPDK bridge configuration</title>
116
117 <tgroup cols="2">
118 <colspec align="left" colwidth="2*" />
119
120 <colspec align="left" colwidth="4*" />
121
122 <tbody>
123 <row>
124 <entry>name</entry>
125
126 <entry>Provide a name for the WAN bridge e.g. "ibm-wan-br"</entry>
127 </row>
128
129 <row>
130 <entry>ovs-bridge-type</entry>
131
132 <entry>dpdkWan</entry>
133 </row>
134
135 <row>
136 <entry>mgmt-address</entry>
137
138 <entry>IPv4 (add IP address of uCPE Manager machine)</entry>
139 </row>
140
141 <row>
142 <entry>mgmt-port</entry>
143
144 <entry>4334</entry>
145 </row>
146 </tbody>
147 </tgroup>
148 </table>
149
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
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
154 the same IP address as the WAN interfaces of the uCPE device.</para>
155
156 <figure>
157 <title>Enea In-band Management solution</title>
158
159 <mediaobject>
160 <imageobject>
161 <imagedata align="center" fileref="images/In-bandManagement.png"
162 scale="65" />
163 </imageobject>
164 </mediaobject>
165 </figure>
166
167 <para>The VNF can be reached on the same IP address as the uCPE device, e.g.
168 <literal>https://&lt;WAN_IP&gt;</literal> if a HTTP server is present
169 on that VNF.</para>
170
171 <note>
172 <para>The In-band management bridge must be recreated each time the uCPE
173 Manager IP is changed.</para>
174 </note>
175</chapter>