From 567f90c2ee40491666ae35b0da1297884861124e Mon Sep 17 00:00:00 2001 From: Andreas Wellving Date: Mon, 9 Mar 2020 18:22:31 +0100 Subject: Clarify Web-installer success state Change-Id: I163f69b7f058010dba7dd54bf199ae332f5d131e Signed-off-by: Andreas Wellving --- .../doc/getting_started_nfv_access.xml | 100 ++++++++++----------- .../doc/getting_started_ucpe_manager.xml | 23 ++++- 2 files changed, 68 insertions(+), 55 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 @@ The current release supports two methods of installation: - Manual installation using the Enea Installer, which - guarantees a clean installation of NFV Access on a uCPE device. + Manual installation from a USB stick using the Enea NFV Access Web-installer, + which guarantees a clean installation of NFV Access on a uCPE device. Mass installation and automated deployment using Bare Metal Provisioning. @@ -245,9 +245,8 @@ of=/dev/sdb bs=4M conv=fsync - To install and configure a device using the Web-installer, - the user must first connect a laptop directly into one of the LAN ports. - No other ports should be connected. + Plug the USB stick into the uCPE device. Connect a laptop directly into one of the ports that will + not later be chosen as a WAN port. No other ports should be connected. @@ -258,10 +257,9 @@ of=/dev/sdb bs=4M conv=fsync Once the USB stick is properly booted, the Web-installer application starts automatically and can be accessed in a web browser at http://192.168.1.1 (port 80). - A DHCP Server is started on the device to serve the connected LAN port, in order to give - the laptop an IP-address. + - From there, the user can configure the device with things such as: + On the first page of the Web-installer, the user should fill in: @@ -269,52 +267,47 @@ of=/dev/sdb bs=4M conv=fsync - The Device ID. The device must be previously - added to the uCPE Manager with a unique ID. The Device ID must be the same as the one - previously added in the uCPE Manager for he device. - - - To be able to connect, the same Device ID must first be added for the device - in uCPE Manager. - + The Device ID. The unique identifier of the + uCPE device. + - Customer Tags. They can be left empty. + Customer Tags. They are used for + Zero Touch Provisining (ZTP) and can be left + empty. What can be entered here (as needed), are the tag(s) specified when + creating an offline configuration in the uCPE Manager. + + + On the second page of the Web-installer, the user should fill in: + The Layer 3 configuration of WAN Interface(s). Static or Dynamic IP must be specified. During network configuration, WAN cables will be plugged into the device - in order to identify the ports and make them available for configuration. Each - connected port will automatically be set as a WAN port and must be configured - (DHCP is the default setting). + in order to identify ports and make them available for configuration. Each + port with a physically connected cable will be automatically set as a WAN port and must be + configured (DHCP is the default setting). The user needs to connect the same quantity of + cables as the number of WAN ports that he wishes to configure. No LAN ports should be + connected nor configured at this time. The configured WAN cables cannot be removed + after being configured. - 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. + The LAN port used to access the Web-installer from the laptop will not be shown + and cannot be configured. The Management Interface. The interface that will be used by the uCPE Manager to communicate with the device. - The IP address of this interface will be listed for the device in the uCPE - Manager. The WAN and management interfaces will be marked as such in the - capabilities view and are restricted in use. The user can change - the Layer 3 configuration of WAN interfaces and add new ones from the uCPE manager - as needed. - - The Web-installer stores the user provided configuration in a json metadata file located - in /boot/enea/install_data.json. There is also a command line tool that can - be used to access metadata entries: nfva-cfgtool. - - When the user has completed the configuration steps in the Web-installer, NFV Access is installed on the hard drive. The largest drive found on the device will be used for @@ -328,31 +321,30 @@ of=/dev/sdb bs=4M conv=fsync Booting NFV Access When the installation has finished successfully, the user should remove the USB stick - and ensure that BIOS is configured to boot from the hard drive. - - When the NFV Access installation is booted from the hard drive, it will first check - that the configuration metadata is complete. If any mandatory information is missing, the - Web-installer will be launched on port 82 for post-installation configuration: - http://192.168.1.1:82. The WAN cable needs to be removed and the device rebooted, - enabling the device's DHCP server to give the laptop an IP address over the LAN connection. - - When all mandatory fields have been filled in, the new configuration is saved, stored - and the device will be rebooted. - + before confirming the reboot of the device in Web-installer and ensure that BIOS is configured + to boot from the hard drive. + + When configured with the Web-installer GUI, the uCPE device start-up sequence will + configure the interfaces accordingly and try to register the device in the uCPE manager. + If connectivity is established with the uCPE manager server and a device with a matching + Device ID is found, the configuration is successful, and the connection is established. + - If NFV Access was installed by some other means, such as a PXE mass installation or by - simply writing an image to a partition, no /boot/enea/install_data.json - metadata file will exist and the Web-installer will launch at start-up expecting the - user to provide the post-installation configuration. + If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at + start-up expecting the user to provide the post-installation configuration. The Web-installer will + be launched on port 82 for post-installation configuration: + http://192.168.1.1:82. - - Once the configuration is complete, the system proceeds to launch the ODM/vCPE which will - configure the interfaces accordingly and try to register the device in the uCPE manager. If - connectivity is established with the uCPE manager server and a device with a matching Device ID is - found, the configuration is marked as successful, and the connection is established. In case of - failure, the Web-installer will be launched for reconfiguration. - + In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot + the device and then access the Web-installer on http://192.168.1.1:82. + + + + After having established a successful connection with the uCPE Manager, the user will + connect any LAN cable(s) that should be connected to the device. + +
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 186c304..27a5632 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 @@ -936,7 +936,28 @@ device, to be wiped out. Selecting Replace will set the entire device configuration to match values in the offline configuration. - + + When a device connects to the uCPE Manager for the first time, it checks the + device to see if it has been Zero Touch Provisioned (ZTP). If not, it looks for + an offline configuration that matches these values, in the following order: + + + + The Device ID. + + + + The set of tags. + + + + A "*" for Device ID (wildcard). + + + + If a match is found, the offline configuration is sent to the device as part + of Zero-Touch-Provisioning. + After creating the Offline Config Store, access the device through Applications -> offline config -> Config App and provision -- cgit v1.2.3-54-g00ecf