From 5b9afc6f840a0d3e47694162a321c39e6433f195 Mon Sep 17 00:00:00 2001 From: mrpa Date: Fri, 19 Feb 2021 03:04:09 +0100 Subject: Last edit to the scripting phrasing made. Change-Id: I979f9fb673c46a10ae4f279e2e9c76612da698a2 Signed-off-by: mrpa --- .../doc/net_config_options.xml | 286 ++++++++++++--------- 1 file changed, 162 insertions(+), 124 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml index 53f45c9..f610651 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml @@ -1,4 +1,4 @@ - + Network Configuration Options @@ -43,16 +43,18 @@ In use cases where CPU capacity is very limited, disabling DPDK can free up CPU capacity and overall performance can improve. Navigate - to Configuration, then DPDK and - deselect Enable DPDK to disable the DPDK. + to Configuration, then DPDK and deselect Enable + DPDK to disable the DPDK. Disabling the DPDK cannot be done after other network configurations have been made. - In Configuration, select DPDK - where DPDK resources can also be configured such as: + In Configuration, select + DPDK where DPDK resources can also be + configured such as: @@ -89,9 +91,12 @@ management system. To add an interface into the Enea uCPE Manager, select the uCPE - device, then from the top toolbar select Configuration, then - External Interfaces, Configuration, -and click the Add button. The available Interface types are detailed below. + device, then from the top toolbar select Configuration, then External Interfaces, Configuration, and click the Add button. The available Interface types are + detailed below.
DPDK Interface Type @@ -102,10 +107,12 @@ and click the Add button. The available Interfa bridge. - Make sure the Enable DPDK checkbox is - selected by accessing Device, -Configuration and choosing -DPDK, otherwise no interface can be assigned as DPDK. + Make sure the Enable DPDK + checkbox is selected by accessing Device, Configuration and choosing DPDK, otherwise no interface can be assigned + as DPDK. To add a DPDK interface under the management system, set @@ -202,18 +209,19 @@ and click the Add button. The available Interfa To edit an interface configuration type from the Enea uCPE Manager, select the uCPE device, then from the top toolbar select - the Configuration menu, then External - Interfaces and Configuration. - The already configured interfaces are displayed here, as seen in the figure above. + the Configuration menu, then + External Interfaces and Configuration. The already configured + interfaces are displayed here, as seen in the figure above. In order to edit an already configured interface, (as in the example popup shown below, a WAN interface) double click on the desired one and a popup will appear. A different popup appears for - each type of interface. From the Host Interface - window, a user can change the networking type and the IP address - assignment: + each type of interface. From the Host + Interface window, a user can change the networking type + and the IP address assignment:
Editing an Interface @@ -241,9 +249,10 @@ and click the Add button. The available Interfa
Wap Interface Type - Wireless Access Point (Wap) interfaces are used to create Wireless - Access Points. Only interfaces with wap-capable - capabilities can be added as WAP interfaces. + Wireless Access Point (Wap) interfaces are used to create + Wireless Access Points. Only interfaces with + wap-capable capabilities can be added as WAP + interfaces. How to edit the Configuration of a Wap Interface @@ -252,30 +261,32 @@ and click the Add button. The available Interfa To edit an interface configuration from the Enea uCPE Manager, select the uCPE device, then from the top toolbar select - the Configuration menu then - External Interfaces and select - Configuration. The already configured - interfaces will be displayed here. + the Configuration menu then + External Interfaces and select + Configuration. The already + configured interfaces will be displayed here. In order to edit an already configured interface, (as in the example popup shown below, a WAP interface) double click on the - desired one and a pop-up will appear. A different pop-up appears for - each type of interface. From the Host Interface - window, the following parameters are configurable: - - - - Country Code: the country code, a 2 letter identifier. - + desired one and a pop-up will appear. A different pop-up appears + for each type of interface. From the Host + Interface window, the following parameters are + configurable: - - Wireless Band: 2.4 GHz or 5 GHz. Depending on the band - selection, the correct Wireless Mode and - Radio Channel must be provided. - - + + + Country Code: the country code, a 2 letter + identifier. + + + + Wireless Band: 2.4 GHz or 5 GHz. Depending on the band + selection, the correct Wireless Mode and + Radio Channel must be provided. + +
Editing an Interface @@ -291,20 +302,22 @@ and click the Add button. The available Interfa - Correct Country Code selection is mandatory. - All configuration options are available in the Enea uCPE Manager GUI but only the - Radio Settings that conform with the selected country's official regulatory laws - will be applied when the Wireless AP is started on the uCPE Device. + Correct Country Code + selection is mandatory. All configuration options are available in + the Enea uCPE Manager GUI but only the Radio Settings that conform + with the selected country's official regulatory laws will be applied + when the Wireless AP is started on the uCPE Device.
Manual Configuration - - For Manual Configuration of uCPE networking, select the uCPE device first, then - access the Configuration menu, and choose - External Interfaces, where a list of - available network interfaces and their capabilities can be found. + + For Manual Configuration of uCPE networking, select the uCPE + device first, then access the Configuration menu, and choose External Interfaces, where a list of available + network interfaces and their capabilities can be found. After networking interfaces have been added to the Enea uCPE Manager, the user can change the interface type (DPDK, SR-IOV, @@ -357,16 +370,16 @@ and click the Add button. The available Interfa - Select the Bridges option, then click - Add. + Select the Bridges option, + then click Add. - Depending on the settings found when accessing - Configuration, OpenVSwitch - and selecting DPDK, OVS bridges with or without DPDK - support will be used on the uCPE device. + Depending on the settings found when accessing the Configuration menu and selecting DPDK, OVS bridges with or without DPDK support + will be used on the uCPE device. There are three types of bridges which can be created, each one @@ -474,8 +487,9 @@ and click the Add button. The available Interfa - Allows for creation of Wireless Access Points. - This bridge type does not need a physical port attached to it. + Allows for creation of Wireless Access + Points. This bridge type does not need a physical + port attached to it. @@ -492,14 +506,16 @@ and click the Add button. The available Interfa - name: name of the bridge. + name: name of the + bridge. - ovs-bridge-type: select - communication or integration, - depending on intended usage. For communication bridges, physical - interfaces can be added to the bridge. + ovs-bridge-type: select + communication or + integration, depending on intended usage. For + communication bridges, physical interfaces can be added to the + bridge.
@@ -543,10 +559,11 @@ and click the Add button. The available Interfa which occurs when the uCPE device connects to the Enea uCPE Manager informing that the ZTP setup failed for the specific uCPE device. - To create an offline configuration, select from the top toolbar - the Applications menu, then Offline - Config and choose Add. The following fields - should be filled: + To create an offline configuration, select from the top toolbar + the Applications menu, then Offline Config and choose Add. The following fields should be + filled: @@ -606,9 +623,10 @@ and click the Add button. The available Interfa 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 by selecting - Applications, then offline config - and clicking Config App, to provision it with the required + After creating the Offline Config Store, access the device by + selecting Applications, then offline config and clicking Config App, to provision it with the required initial configuration. This operation mirrors what happens during manual configuration described previously. @@ -617,9 +635,10 @@ and click the Add button. The available Interfa connects to the Enea uCPE Manager. Just changing an offline configuration will not push the new changes to the device. If an offline configuration is changed after uCPE device registration, a - factory reset can be executed to force a new ZTP to execute. -Select the device, then access the Operations menu -and select factory reset. + factory reset can be executed to force a new ZTP to execute. Select + the device, then access the Operations menu and select factory reset.
@@ -643,32 +662,43 @@ and select factory reset. - Once-before-startup. This script will only - execute once during the startup. + Once-before-startup. This script will only + execute once after the system has rebooted, prior to processing any + device configuration. - Always-before-startup. This script will - always execute during the startup. + Always-before-startup. This script will always + execute after the system has rebooted, prior to processing any device + configuration. - Once-after-startup. This script will only - execute once after the system has been started. + Once-after-startup. The script will always + execute after the system has rebooted, after all device configuration + processes have completed. Always-after-startup. This script will - always execute after the system has been started. + always execute after all device configuration processes have + completed after the system has rebooted. + + After a factory reset, any of the + Once-before-* or Once-after-* + scripts will be re-run as described above. + + Follow the instruction below to upload scripts: - Access the Devices menu, then Custom - Scripts and choose Configure. + Access the Devices menu, then + Custom Scripts and choose Configure. @@ -676,13 +706,14 @@ and select factory reset. - In the Script Type menu, select the type - the uploaded script should have. + In the Script Type menu, + select the type the uploaded script should have. - Press Choose File to select the scripts - needed, and then click Send. + Press Choose File to select + the scripts needed, and then click Send. @@ -694,15 +725,16 @@ and select factory reset. - Access the Devices menu, then Custom - Scripts and select Configure. + Access the Devices menu, then + Custom Scripts and select Configure. - Select the script you want to delete from the - Uploaded Scripts tab and then click - Delete, which will remove the script immediately - from the Enea uCPE Manager. + Select the script you want to delete from the Uploaded Scripts tab and then click Delete, which will remove the script + immediately from the Enea uCPE Manager. @@ -715,13 +747,14 @@ and select factory reset. - Access the Devices menu, choose Custom - Scripts and select Configure. + Access the Devices menu, + choose Custom Scripts and select + Configure. - Select the Configuration tab and specify a - new loacation to store the scripts. + Select the Configuration tab + and specify a new loacation to store the scripts. Change the script storage location only if you have many @@ -739,16 +772,18 @@ and select factory reset. - Access the Devices menu, choose Custom - Scripts and select Apply Scripts. + Access the Devices menu, + choose Custom Scripts and select + Apply Scripts. - In the Script Config Screen pop up, select - the devices from the device(s) chooser list on which to run the - scripts. Press the > button to move the - devices to the right side of the chooser, which is the list of - devices that will execute the selected scripts. + In the Script Config Screen + pop up, select the devices from the device(s) chooser list on which + to run the scripts. Press the > + button to move the devices to the right side of the chooser, which + is the list of devices that will execute the selected + scripts. @@ -764,15 +799,16 @@ and select factory reset. - Check the Reboot devices checkbox if you - want to reboot and execute the scripts at once and then select -ok. + Check the Reboot devices + checkbox if you want to reboot and execute the scripts at once and + then select ok. The status of execution for the scripts can be seen by - accessing Fault, opening the -Events screen and filtering by device and/or - the event name CustomScriptExecuted. + accessing Fault, opening the + Events screen and filtering by + device and/or the event name + CustomScriptExecuted. @@ -782,19 +818,19 @@ and select factory reset.
Wireless Access Point - The Wireless AP Screen from the Enea uCPE Manager - Configuration menu allows users to configure a Wireless Access - Point. A wap-capable interface and a LAN - bridge must be added before doing the Wireless AP configuration. For more details - see sections Wap interface Type - and Data-plane bridge. + The Wireless AP Screen from the Enea uCPE Manager Configuration menu + allows users to configure a Wireless Access Point. A + wap-capable interface and a LAN bridge must be added + before doing the Wireless AP configuration. For more details see sections + Wap interface Type and Data-plane bridge. The following parameters are configurable: - SSID: the Wireless network name - any string with a max. length of 32 - octets. + SSID: the Wireless network name - any string with a max. length + of 32 octets. @@ -811,15 +847,16 @@ and select factory reset. WAP Security Mode: open or wpa2Psk. When choosing wpa2Psk, a password and an encryption - must be provided. The password can be any string - with a minimum length of 8 and a maximum length of 63 characters. + must be provided. The password can be any string + with a minimum length of 8 and a maximum length of 63 + characters. DHCP Server: disabled or - enabled. When enabled is selected, - the range of IPs (IP Address Start - IP - Address End), Netmask and + enabled. When enabled is + selected, the range of IPs (IP Address Start - + IP Address End), Netmask and Gateway values must be provided. @@ -829,7 +866,7 @@ and select factory reset. - @@ -839,9 +876,10 @@ and select factory reset. Only a single Wireless AP is allowed on a physical interface. The validation of the wap-capable interface is done when adding the Wireless AP, so, in case of an error, the parameters of the - wap-capable interface must be rechecked. This can be done by - accessing the Configuration menu and selecting - External Interfaces. + wap-capable interface must be rechecked. This can be + done by accessing the Configuration + menu and selecting External + Interfaces.
\ No newline at end of file -- cgit v1.2.3-54-g00ecf