diff options
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml')
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | 100 |
1 files changed, 46 insertions, 54 deletions
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 552e317..796c386 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 | |||
@@ -10,8 +10,8 @@ | |||
10 | <para>The current release supports two methods of installation:</para> | 10 | <para>The current release supports two methods of installation:</para> |
11 | 11 | ||
12 | <itemizedlist> | 12 | <itemizedlist> |
13 | <listitem><para>Manual installation using the Enea Installer, which | 13 | <listitem><para>Manual installation from a USB stick using the Enea NFV Access Web-installer, |
14 | guarantees a clean installation of NFV Access on a uCPE device.</para></listitem> | 14 | which guarantees a clean installation of NFV Access on a uCPE device.</para></listitem> |
15 | <listitem><para>Mass installation and automated deployment using | 15 | <listitem><para>Mass installation and automated deployment using |
16 | Bare Metal Provisioning.</para></listitem> | 16 | Bare Metal Provisioning.</para></listitem> |
17 | </itemizedlist> | 17 | </itemizedlist> |
@@ -245,9 +245,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
245 | 245 | ||
246 | <orderedlist> | 246 | <orderedlist> |
247 | <listitem> | 247 | <listitem> |
248 | <para>To install and configure a device using the Web-installer, | 248 | <para>Plug the USB stick into the uCPE device. Connect a laptop directly into one of the ports that will |
249 | the user must first connect a laptop directly into one of the LAN ports. | 249 | not later be chosen as a WAN port. No other ports should be connected.</para> |
250 | No other ports should be connected.</para> | ||
251 | </listitem> | 250 | </listitem> |
252 | 251 | ||
253 | <listitem> | 252 | <listitem> |
@@ -258,10 +257,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
258 | <listitem> | 257 | <listitem> |
259 | <para>Once the USB stick is properly booted, the Web-installer application starts | 258 | <para>Once the USB stick is properly booted, the Web-installer application starts |
260 | automatically and can be accessed in a web browser at <literal>http://192.168.1.1</literal> (port 80). | 259 | automatically and can be accessed in a web browser at <literal>http://192.168.1.1</literal> (port 80). |
261 | A DHCP Server is started on the device to serve the connected LAN port, in order to give | 260 | </para> |
262 | the laptop an IP-address.</para> | ||
263 | 261 | ||
264 | <para>From there, the user can configure the device with things such as:</para> | 262 | <para>On the first page of the Web-installer, the user should fill in:</para> |
265 | 263 | ||
266 | <itemizedlist> | 264 | <itemizedlist> |
267 | <listitem> | 265 | <listitem> |
@@ -269,53 +267,48 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
269 | </listitem> | 267 | </listitem> |
270 | 268 | ||
271 | <listitem> | 269 | <listitem> |
272 | <para><emphasis role="bold">The Device ID</emphasis>. The device must be previously | 270 | <para><emphasis role="bold">The Device ID</emphasis>. The unique identifier of the |
273 | added to the uCPE Manager with a unique ID. The Device ID must be the same as the one | 271 | uCPE device.</para> |
274 | previously added in the uCPE Manager for he device.</para> | 272 | |
275 | |||
276 | <note> | ||
277 | <para>To be able to connect, the same Device ID must first be added for the device | ||
278 | in uCPE Manager.</para> | ||
279 | </note> | ||
280 | </listitem> | 273 | </listitem> |
281 | 274 | ||
282 | <listitem> | 275 | <listitem> |
283 | <para><emphasis role="bold">Customer Tags</emphasis>. They can be left empty.</para> | 276 | <para><emphasis role="bold">Customer Tags</emphasis>. They are used for |
277 | <link linkend="zero_touch_prov">Zero Touch Provisining (ZTP)</link> and can be left | ||
278 | empty. What can be entered here (as needed), are the tag(s) specified when | ||
279 | creating an offline configuration in the uCPE Manager.</para> | ||
284 | </listitem> | 280 | </listitem> |
281 | </itemizedlist> | ||
282 | |||
283 | <para>On the second page of the Web-installer, the user should fill in:</para> | ||
285 | 284 | ||
285 | <itemizedlist> | ||
286 | <listitem> | 286 | <listitem> |
287 | <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. | 287 | <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. |
288 | Static or Dynamic IP must be specified.</para> | 288 | Static or Dynamic IP must be specified.</para> |
289 | 289 | ||
290 | <para>During network configuration, WAN cables will be plugged into the device | 290 | <para>During network configuration, WAN cables will be plugged into the device |
291 | in order to identify the ports and make them available for configuration. Each | 291 | in order to identify ports and make them available for configuration. Each |
292 | connected port will automatically be set as a WAN port and must be configured | 292 | port with a physically connected cable will be automatically set as a WAN port and must be |
293 | (DHCP is the default setting).</para> | 293 | configured (DHCP is the default setting). The user needs to connect the same quantity of |
294 | cables as the number of WAN ports that he wishes to configure. No LAN ports should be | ||
295 | connected nor configured at this time. The configured WAN cables cannot be removed | ||
296 | after being configured.</para> | ||
294 | 297 | ||
295 | <note> | 298 | <note> |
296 | <para>A WAN cable now needs to be added to the device. The LAN port used to access the Web-installer from the laptop will not be shown and cannot be configured.</para></note> | 299 | <para>The LAN port used to access the Web-installer from the laptop will not be shown |
300 | and cannot be configured.</para></note> | ||
297 | </listitem> | 301 | </listitem> |
298 | 302 | ||
299 | <listitem> | 303 | <listitem> |
300 | <para><emphasis role="bold">The Management Interface</emphasis>. The interface that | 304 | <para><emphasis role="bold">The Management Interface</emphasis>. The interface that |
301 | will be used by the uCPE Manager to communicate with the device.</para> | 305 | will be used by the uCPE Manager to communicate with the device.</para> |
302 | 306 | ||
303 | <para>The IP address of this interface will be listed for the device in the uCPE | ||
304 | Manager. The WAN and management interfaces will be marked as such in the | ||
305 | <literal>capabilities</literal> view and are restricted in use. The user can change | ||
306 | the Layer 3 configuration of WAN interfaces and add new ones from the uCPE manager | ||
307 | as needed.</para> | ||
308 | </listitem> | 307 | </listitem> |
309 | </itemizedlist> | 308 | </itemizedlist> |
310 | </listitem> | 309 | </listitem> |
311 | 310 | ||
312 | <listitem> | 311 | <listitem> |
313 | <para>The Web-installer stores the user provided configuration in a json metadata file located | ||
314 | in <filename>/boot/enea/install_data.json</filename>. There is also a command line tool that can | ||
315 | be used to access metadata entries: <literal>nfva-cfgtool</literal>.</para> | ||
316 | </listitem> | ||
317 | |||
318 | <listitem> | ||
319 | <para>When the user has completed the configuration steps in the Web-installer, NFV Access | 312 | <para>When the user has completed the configuration steps in the Web-installer, NFV Access |
320 | is installed on the hard drive. The largest drive found on the device will be used for | 313 | is installed on the hard drive. The largest drive found on the device will be used for |
321 | installation.</para> | 314 | installation.</para> |
@@ -328,31 +321,30 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para> | |||
328 | <title>Booting NFV Access</title> | 321 | <title>Booting NFV Access</title> |
329 | 322 | ||
330 | <para>When the installation has finished successfully, the user should remove the USB stick | 323 | <para>When the installation has finished successfully, the user should remove the USB stick |
331 | and ensure that BIOS is configured to boot from the hard drive.</para> | 324 | before confirming the reboot of the device in Web-installer and ensure that BIOS is configured |
332 | 325 | to boot from the hard drive.</para> | |
333 | <para>When the NFV Access installation is booted from the hard drive, it will first check | 326 | |
334 | that the configuration metadata is complete. If any mandatory information is missing, the | 327 | <para>When configured with the Web-installer GUI, the uCPE device start-up sequence will |
335 | Web-installer will be launched on port 82 for post-installation configuration: <literal> | 328 | configure the interfaces accordingly and try to register the device in the uCPE manager. |
336 | http://192.168.1.1:82</literal>. The WAN cable needs to be removed and the device rebooted, | 329 | If connectivity is established with the uCPE manager server and a device with a matching |
337 | enabling the device's DHCP server to give the laptop an IP address over the LAN connection.</para> | 330 | Device ID is found, the configuration is successful, and the connection is established.</para> |
338 | 331 | ||
339 | <para>When all mandatory fields have been filled in, the new configuration is saved, stored | ||
340 | and the device will be rebooted.</para> | ||
341 | |||
342 | <note> | 332 | <note> |
343 | <para>If NFV Access was installed by some other means, such as a PXE mass installation or by | 333 | <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at |
344 | simply writing an image to a partition, no <filename>/boot/enea/install_data.json</filename> | 334 | start-up expecting the user to provide the post-installation configuration. The Web-installer will |
345 | metadata file will exist and the Web-installer will launch at start-up expecting the | 335 | be launched on port 82 for post-installation configuration: <literal> |
346 | user to provide the post-installation configuration.</para> | 336 | http://192.168.1.1:82</literal>.</para> |
347 | </note> | 337 | </note> |
348 | |||
349 | <para>Once the configuration is complete, the system proceeds to launch the ODM/vCPE which will | ||
350 | configure the interfaces accordingly and try to register the device in the uCPE manager. If | ||
351 | connectivity is established with the uCPE manager server and a device with a matching Device ID is | ||
352 | found, the configuration is marked as successful, and the connection is established. In case of | ||
353 | failure, the Web-installer will be launched for reconfiguration. | ||
354 | </para> | ||
355 | 338 | ||
339 | <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot | ||
340 | the device and then access the Web-installer on <literal>http://192.168.1.1:82</literal>. | ||
341 | </para> | ||
342 | |||
343 | <note> | ||
344 | <para>After having established a successful connection with the uCPE Manager, the user will | ||
345 | connect any LAN cable(s) that should be connected to the device. | ||
346 | </para> | ||
347 | </note> | ||
356 | </section> | 348 | </section> |
357 | 349 | ||
358 | <section condition="hidden" id="examples"> | 350 | <section condition="hidden" id="examples"> |