From 0bc629f35e117d173decd1a21ecdd78daa8df601 Mon Sep 17 00:00:00 2001 From: mrpa Date: Fri, 26 Feb 2021 12:15:04 +0100 Subject: Updated the Getting Started Manual with a few key edits. Change-Id: Ia2c25f865de87149828864d3af2c3ce3ff1c42f0 Signed-off-by: mrpa --- .../doc/installation_guide.xml | 2 +- .../doc/upgrade_ena.xml | 31 ++++++++++++++-------- .../doc/vnf_mg.xml | 6 ----- 3 files changed, 21 insertions(+), 18 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index be4342f..a6f01bd 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml @@ -481,7 +481,7 @@ userdel postgres - Enter <uCPEM-installdir>. + Enter <uCPEM-installdir>/dist. diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 1b714f2..69e3b5d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml @@ -28,7 +28,7 @@ - Enter <uCPEM-installdir>. + Enter <uCPEM-installdir>/dist. @@ -53,7 +53,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzCreate a compressed file of the ucpemanager application folder (ucpemanager-Back-up-YYYYddMMHHmm.tar.gz), which - contains a snapshot of the existing installation. + contains a snapshot of the existing installation in the + <uCPEM-installdir>/dist directory. The snapshot file created during the upgrade can be used for @@ -70,6 +71,14 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzStart the ucpemanager service. + + Fresh Installation of the Enea uCPE Manager in the + Manual contains information + about the input required to be entered during the execution of the upgrade script. For an example on how to upgrade an Enea uCPE Manager installation in a High Availability setup, consult ucpemanager-Backup-YYYYddMMHHmm.tar.gz) created during a previous Enea uCPE Manager Upgrade or Enea uCPE Manager Uninstall Operation into the - <uCPEM-installdir> directory. + <uCPEM-installdir>/dist directory. - Enter <uCPEM-installdir>. + Enter <uCPEM-installdir>/dist. @@ -144,8 +153,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Navigate to the folder where the Enea uCPE Manager is - installed: <uCPEM-installdir>. + Navigate to the folder where the Enea uCPE Manager was + unpacked: <uCPEM-installdir>/dist. @@ -259,10 +268,6 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Press Close when the message - File Uploaded Successfully appears on the File Upload screen. - The uCPE Device upgrade is done with image files of the type rootfs.ostree.tar.bz2, which are available in the @@ -385,7 +390,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Press the > button to + Mark the uCPE devices that you wish to upgrade and + press the > button to move the uCPE devices to the right side of the selector. Those chosen form the list of uCPE devices that will be upgraded. @@ -414,6 +420,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz + + To start the upgrade, click + ok. diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml index e8c65eb..8690818 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml @@ -123,12 +123,6 @@ Click the On-board button. - - - When prompted by the UI, make sure the VM - Image radio button at the top of the onboarding screen is - selected, it will trigger a popup menu window. - This window contains data fields where both necessary and optional -- cgit v1.2.3-54-g00ecf From 16e2ca821b7cf572fe4d45d1c5e5aa34d3d5513c Mon Sep 17 00:00:00 2001 From: mrpa Date: Tue, 2 Mar 2021 11:58:47 +0100 Subject: Removed mentions of "Beta" in the rel notes. Change-Id: I19c3919690c66d18d7d5b32227e8510d2efdace4 Signed-off-by: mrpa --- doc/book-enea-nfv-access-release-info/doc/book.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/book-enea-nfv-access-release-info/doc/book.xml b/doc/book-enea-nfv-access-release-info/doc/book.xml index 4a1e390..2a48d5a 100644 --- a/doc/book-enea-nfv-access-release-info/doc/book.xml +++ b/doc/book-enea-nfv-access-release-info/doc/book.xml @@ -9,7 +9,7 @@ Release Version Beta + xmlns:xi="http://www.w3.org/2001/XInclude" /> -- cgit v1.2.3-54-g00ecf From 27c3059578ec3372d69e7c2207ef8041309acd30 Mon Sep 17 00:00:00 2001 From: Toma Bilius Date: Thu, 4 Mar 2021 14:38:53 +0200 Subject: ELCCR-1468 HA: Cannot upgrade NFV Access installation Change-Id: I8a399d43dcfd6e5b845f90bf2e8e2e2c9bac6afc Signed-off-by: Toma Bilius --- .../doc/upgrade_ena.xml | 51 ++++--- .../doc/known_bugs_and_limitations.xml | 167 ++++++++++++--------- 2 files changed, 128 insertions(+), 90 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 69e3b5d..9f9a50d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml @@ -71,22 +71,24 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gzStart the ucpemanager service. - - Fresh Installation of the Enea uCPE Manager in the - Manual contains information - about the input required to be entered during the execution of the upgrade script. - For an example on how to upgrade an Enea uCPE Manager installation in a - High Availability setup, consult Fresh Installation of the Enea uCPE + Manager in the + Manual contains information about the input required to be entered during + the execution of the upgrade script. + + For an example on how to upgrade an Enea uCPE Manager installation + in a High Availability setup, consult Upgrading a High Availability Deployment in the Manual. + xmlns:ns="http://www.w3.org/2001/XInclude" + xpointer="element(book_enea_nfv_access_getting_started/1)" /> + Manual.
Restoring a previous Enea uCPE Manager Installation @@ -235,6 +237,15 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz + + + Upgrading from Enea NFV Access 2.3.0 is not possible when using + the Enea uCPE Manager in HTTPS mode. Either switch to HTTP by accessing + System, Configuration, Web + Access and checking the Enable + HTTP box, or installing it manually. +
@@ -390,10 +401,10 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - Mark the uCPE devices that you wish to upgrade and - press the > button to - move the uCPE devices to the right side of the selector. Those - chosen form the list of uCPE devices that will be upgraded. + Mark the uCPE devices that you wish to upgrade and press the + > button to move the uCPE + devices to the right side of the selector. Those chosen form the + list of uCPE devices that will be upgraded. @@ -420,9 +431,11 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz - - To start the upgrade, click - ok. + + + To start the upgrade, click ok. + diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml index 31d3a03..a1a5db3 100644 --- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml @@ -84,80 +84,94 @@ - ELCCR-912When the Enea uCPE Manager is installed - on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an - upgrade image fails. As a workaround, please update glib2 - to version 2.54.2 or later, using #yum update glib2. + ELCCR-912When the Enea uCPE Manager is installed + on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an + upgrade image fails. As a workaround, please update + glib2 to version 2.54.2 or later, using #yum + update glib2. + + + + ELCCR-854Changing the management interface IP + address will result in a temporary loss of connection with the uCPE + device. If the device is behind a NAT, while using the Call Home + connection, reestablishing the connection automatically could take up to + 20 minutes. Restarting the vCPE Overlay will immediately reestablish the + connection, but that implies the existence of an alternate way to + trigger the vCPE restart operation on the device. + + + + USERDOCAP-641Enea NFV Access does not have + support for IPv6 addresses on both uCPE devices and the Enea uCPE + Manager installation. + + + + ELCCR-1428Wireless AP creation through the REST + API does not validate that the wireless interface and LAN bridge are + configured. Using these parameters may result in undefined + behavior. + + + + ELCCR-1351The updated + .Keystore and server.xml files + from the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/ + folder are overwritten during a product upgrade. As a workaround for + this issue, after an upgrade, copy the updated + .Keystore and server.xml files + into the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/ + folder and restart the ucpemanager service. + + + + ELCCR-1371The current self-signed certificate for + the Enea uCPE Manager is generated at build time, with a hard-coded + common-name causing the uCPE device upgrade to fail in HTTPS mode. As a + workaround, another certificate (containing an IP based common-name) + must be generated. + + Perform the following the steps to generate the + certificate: + + + + Stop the uCPE Manager service. + + + + Create the certificate using the + createCertificate.sh script from distribution + folder. This will create a new .Keystore file + and copy it into the + /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates + folder. + + + + Start the Enea uCPE Manager, the new certificate should now + take effect. + + + + + ELCCR-1378Modifying the type of the external + interfaces can lead to errors. Instead of modifying, it is recommended + to delete the old interfaces and recreate them with the desired + type. + - ELCCR-854Changing the management interface IP address - will result in a temporary loss of connection with the uCPE device. If the - device is behind a NAT, while using the Call Home connection, - reestablishing the connection automatically could take up to 20 minutes. - Restarting the vCPE Overlay will immediately reestablish the connection, - but that implies the existence of an alternate way to trigger the vCPE - restart operation on the device. - - - - USERDOCAP-641Enea NFV Access does not have support - for IPv6 addresses on both uCPE devices and the Enea uCPE Manager - installation. - - - - ELCCR-1428Wireless AP creation through the REST - API does not validate that the wireless interface and LAN bridge are - configured. Using these parameters may result in undefined behavior. - - - - ELCCR-1351The updated .Keystore - and server.xml files from the - /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/ - folder are overwritten during a product upgrade. As a workaround for - this issue, after an upgrade, copy the updated .Keystore - and server.xml files into the - /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/ - folder and restart the ucpemanager service. - - - - ELCCR-1371The current self-signed certificate for - the Enea uCPE Manager is generated at build time, with a hard-coded common-name - causing the uCPE device upgrade to fail in HTTPS mode. As a workaround, - another certificate (containing an IP based common-name) must be generated. - - Perform the following the steps to generate the certificate: - - - Stop the uCPE Manager service. - - Create the certificate using the - createCertificate.sh script from distribution - folder. This will create a new .Keystore file - and copy it into the - /opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates - folder. - - Start the Enea uCPE Manager, the new certificate - should now take effect. - - - - - ELCCR-1378Modifying the type of the external interfaces can lead - to errors. Instead of modifying, it is recommended to delete the old - interfaces and recreate them with the desired type. - - - - ELCCR-907At times the VIP address is not acquired - by any of the backup nodes if a power failure happens on primary node - in a High Availability setup. To recover, follow the official documentation - available at Galera Cluster Recovery. + ELCCR-907At times the VIP address is not acquired + by any of the backup nodes if a power failure happens on primary node in + a High Availability setup. To recover, follow the official documentation + available at Galera Cluster + Recovery. @@ -168,6 +182,17 @@ configured to open PDF files in an external PDF reader. As a workaround, open the HTML version of the document.LXCR-3283 + + + ELCCR-1468When using the Enea uCPE Manager in HTTPS + mode, upgrading a device from NFV Access 2.3.0 is not possible. Either + switch to HTTP mode (for more details see The uCPE device Upgrade Process in the +Manual) or install it manually. + -- cgit v1.2.3-54-g00ecf From 08b98f72daca6cd3eb881f56be58815273d8d3c1 Mon Sep 17 00:00:00 2001 From: mrpa Date: Thu, 4 Mar 2021 17:06:29 +0100 Subject: Removed the CMC Manual, obsolete now, Updated order of building components in Makefile, Update Evalkit title. Change-Id: Ie1e921cd90173a1e3558eee48811d82bcb9fe29b Signed-off-by: mrpa --- doc/Makefile | 2 +- .../doc/128t_vnf_router.xml | 728 ------------- .../doc/appendix_1.xml | 63 -- .../doc/appendix_2.xml | 326 ------ .../doc/appendix_3.xml | 7 - .../doc/appendix_4.xml | 52 - .../doc/appendix_5.xml | 213 ---- .../doc/book.xml | 47 - .../doc/enea_vnf_examples.xml | 289 ------ .../doc/general_env_prerequisites.xml | 163 --- .../doc/images/kontron_me1100.png | Bin 88944 -> 0 bytes .../doc/images/kontron_me1100_servicechain.png | Bin 41444 -> 0 bytes .../doc/introduction.xml | 152 --- .../doc/service_chaining_128t_fortigate.xml | 1087 -------------------- .../doc/usecases_autoframe.xml | 46 - .../swcomp.mk | 10 - doc/book-enea-nfv-access-evalkit/doc/book.xml | 2 +- doc/book-enea-nfv-access-evalkit/swcomp.mk | 2 +- 18 files changed, 3 insertions(+), 3186 deletions(-) delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml delete mode 100755 doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png delete mode 100755 doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml delete mode 100644 doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml delete mode 100755 doc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk diff --git a/doc/Makefile b/doc/Makefile index a0956d4..58d90a8 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -50,7 +50,7 @@ DOCBOOK_TO_BOOKDIR ?= yes DOCBOOK_CLEANTMP ?= yes #Components (books) in this subsystem. Now use all books found here -COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-platform-open-source book-enea-nfv-access-getting-started book-enea-nfv-access-ucpem-open-source book-enea-nfv-access-telemetry-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-evalkit +COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-evalkit book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-platform-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-telemetry-open-source book-enea-nfv-access-ucpem-open-source # -------------------------------------------------------------- diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml deleted file mode 100644 index be7efb9..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml +++ /dev/null @@ -1,728 +0,0 @@ - - - 128T VNF Router Example Use-case - - The 128T Networking Platform (128T) natively provides network-based - security, control, and insight across data centers, wide-area networks - (WAN), and edge locations for enterprises, service providers, and cloud - companies alike. - -
- Prerequisites - - The following are needed for this example use case: - - - - 1 in band management port for device management. - - - - 1 in band management port for 128T VNF. - - - - 1 WAN interface for 128T. - - - - 1 LAN interface for 128T. - - -
- -
- 128T VNF Router - -
- 128T VNF Router Setup Overview - - - - - - -
- -
- Use-case Setup - - Configuring Network Interfaces on uCPE - devices: - - Log into the uCPE Manager with both username and password - values: admin. - - - - Add the Kontron me1100 uCPE device into the uCPE Manager: - Devices -> Manage -> Add. - - Fill in the required fields with the following data: - - - Device Details - - - - - - - - - - - Field - - Value - - - - - - Type - - Enea universal CPE - - - - Release - - 1.0 - - - - Name - - me1100 - - - - IP/DNS Address - - <unspecified> - Please do not add the IP, it will be updated - automatically by new communication protocol. - - - - - Description - - Kontron Target 1 - - - - Device ID - - The value of the Device ID must be the same as the - one used during the NFV Access installation. - - - - SSH Port - - 830 - - - - SSH User Name - - root - - - - Password - - null - - - - OK - - Green status indicates connection with uCPE device - was established. - - - -
- - - - Add the device on the map: Right-Click on Map -> - Place Device -> me1100. - - - In order for the device to connect to the uCPE Manager, it - must be added to the uCPE Manager and be powered on, having the - NFV Access platform started, otherwise it must be rebooted. - - - - - Configure the virtualization infrastructure for 128T VNF by - creating three OVS bridges and a host interface. - - Select the me1100 device then: Configuration -> - OpenVSwitch -> Bridges -> Add. Fill in the - required fields for each bridge with the following data from each - table: - - - ibm_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - ibm_br - - - - ovs-bridge-type - - inbandMgmt - - - - mgmt-address - - Provide the IP address of the uCPE Manager machine - (E.g. 172.24.3.109). - - - - mgmt-port - - 830 - - - - Create - - The system will automatically select the - physical interface that has access to the uCPE - Manager. - - - -
- - - vnf_mgmt_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - vnf_mgmt_br - - - - ovs-bridge-type - - vnfMgmt - - - - vnf-mgmt-address - - 10.0.0.1 - - - - Create - - - - - -
- - - lan_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - lan_br - - - - ovs-bridge-type - - dataPlane - - - - sub-type - - communication - - - - + - - Name: enp4s0f1 OK - - - - Create - - - - - -
- - Add the Host Interface by selecting the - me1100 device, then Configuration - -> External Interface -> Configuration -> Add. - Fill in the required fields with the following data: - - - Host Interface Details - - - - - - - - - - - Field - - Value - - - - - - Source - - enp4s0f1. The only interface - available for LAN connection. - - - - type - - dpdk - - - - networking-type - - dpdk - - - - dpdk-type - - vfio-pci - - - - Create - - <interface enp4s0f1 ready to be used in a LAN - bridge.> - - - -
- - - - Onboarding the VNFs: - - Onboard the VM Image through VNF -> Descriptors -> - On-board -> VM Image, and fill in the required fields with - the following values: - - - VM Image Details - - - - - - - - - - - Field - - Value - - - - - - VM image file - - centos_128t_with_ci.qcow2 - - - - Image format - - QCOW2 - - - - VNF Type Name - - 128T - - - - Description - - 128T Router - - - - Version - - 1.0 - - - - Memory in MB - - 8192. More memory can be allocated if required - (<28672). - - - - Num. of CPUs - - 2. More CPUs can be reserved if required - (<15). - - - - Interfaces -> + - - Name: mgmt - - - - Interfaces -> + - - Name: wan - - - - Interfaces -> + - - Name: lan - - - - Cloud Init -> Cloud-Init Datasource - - ISO - - - - Cloud Init -> Cloud-Init Disk Type - - cdrom - - - - Properties -> + - - Name: vnfMgmtIpAddress. Value: 10.0.0.2 - - - - Properties -> + - - Name: internalMgmtPort. Value: 443 - - - - Properties -> + - - Name: externalMgmtPort. Value: 60001 - - - - Onboard - - <Wait for message: VNF package onboarded - successfully> - - - - Close - - - - - -
- - - - - HTTPS access (443) can be changed with another type of - access. Please consult official 128T documentation and make sure - the 128T VNF is configured to accept another type of connection - before changing the port number. - - - - externalMgmtPort (60001) represents the - external port on which the user can access the VNF management - interface via HTTPS. Another port can be selected if needed. There - are no other changes required or components affected by this - change. - - - - vnfMgmtIpAddress (10.0.0.2) represents - the IP address of the management interface of the 128T VNF. - Changing this value requires an update to the 128T configuration - to match the new IP address. - - - - - Instantiating the VNFs: - - Instantiate the 128T VNF by selecting the me1100 device, then - VNF -> Instances -> Add. - - Fill in the required fields with the following values: - - - 128T VNF Instantiation - - - - - - - - - - - Field - - Value - - - - - - Name - - 128T_me1100_1 - - - - VNF Type - - 128T - - - - VNFD Version - - 1.0 - - - - Flavour - - Canonical - - - - uCPE Device - - me1100 - - - - Cloud Init File - - centos_128t_internet_ci.iso - - - - Domain Update Script - - - - - - Interfaces - - - - - - ID - - IF Name - - - - mgmt (dpdk) - - Bridge: vnf_mgmt_br - - - - wan (dpdk) - - Bridge: ibm_br - - - - lan (dpdk) - - Bridge: lan_br - - - - Create - - - - - -
-
- -
- Testing the Use-case - - In order to access the web interface of the 128T VNF, open a - browser from a machine connected on the same network with the WAN port - of the me1100 uCPE device and browse to: - https://<public_me1100_WAN_IP>:60001. Log in - using the following credentials: - - - - Username: admin - - - - Password: 128Tadmin - - - - In order to validate the data path, connect a test machine to the - LAN physical port, assign the static IP and a route:> ifconfig eth3 192.168.64.2 netmask 255.255.255.0 -> ip route add default via 192.168.64.1 dev eth3 -> ping 8.8.8.8For data path validation, it may be required - to generate a new cloud-init image to match your network configuration. - Please check Appendix A: How to create 128T cloud-init iso image (day-0 - configuration), for more details. -
- -
- Use-case Clean-up - - In order to remove the setup created previously all components - need to be deleted in reverse order: - - - - Select the me1100 uCPE device -> VNF -> Instances -> - 128T -> Delete. - - - - Select the me1100 uCPE device -> Configuration -> - OpenVSwitch -> Bridges. Select all bridges -> Delete. - - - - Select the me1100 uCPE device -> Configuration -> - OpenVSwitch -> Host Interfaces. Select all interfaces -> - Delete. - - - - VNF -> Descriptors, select all bundles -> - Offboard. - - -
-
- \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml deleted file mode 100644 index 023f798..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - How to create a 128T cloud-init iso image (day-0 - configuration) - - Prerequisites: - - Development host with Linux shell. - - - - genisoimage tool installed. - - - - Unpack the 128T/128t-cloud-init-example.tar.gz - archive and check the README file for more details: - - >tar -zxf 128t-cloud-init-example.tar.gz ->cd 128T/cloud-init-example/ ->ls ./ -README -user-data -meta-data -t128-running.xml - - To generate the cloud-init iso image: - - >genisoimage -output centos_128t_ci.iso -volid cidata -joliet \ --rock user-data meta-data t128-running.xml - - Notes: - - user-data and meta-data - files must be kept unchanged. - - - - To update the 128T configuration change the - t128-runing.xml file. - - - - XML is the same file downloaded from 128T web access: - configuration -> Import and Export Configuration -> - Export Configuration -> Download Configuration. The - configuration can be updated from a web interface, downloaded onto the - development host and used in generating a new cloud-init iso - image. - - - - By default, t128-running.xml is configured to pass - all traffic from the LAN to the WAN interface. There is only one change - required for the 128T VNF to work on the user's network: - - <rt:next-hop>172.24.15.254</rt:next-hop> - - Please change <172.24.15.254> with the IP address of your - Gateway in the t128-running.xml file and generate a new - iso image as described above. For more details about configuring the 128T - VNF please contact 128 Technologies. - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml deleted file mode 100644 index e3da67f..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml +++ /dev/null @@ -1,326 +0,0 @@ - - - How to create the 128T image for NFV Access - - The following steps were used by Enea to generate the 128T qcow2 image - used as the VNF image on NFV Access. - - - Follow the 128tISO-Install.pdf document and - keep in mind a Virtual Machine was used instead of a physical host. - - - Prerequisites: - - 128T-3.2.7-1.el7.centos.x86_64.iso provided - by 128 Technologies. - - - - A Linux development host with internet access. - - - - A least one of the TAP interfaces connected to a bridge with - Internet access. - - How to create the 128T image for NFV - Access: - - >qemu-img create -f qcow2 128t.qcow2 128G ->qemu-system-x86_64 -enable-kvm -m 8G -cpu host -smp cores=3,sockets=1 \ --M q35 -nographic bios /usr/share/qemu/bios.bin -boot order=d,menu=on \ -cdrom 128T-3.2.7-1.el7.centos.x86_64.iso \ -hdb 128t.qcow2 \ -device e1000,netdev=net1,mac=52:52:01:02:03:01 \ -netdev tap,id=net1,ifname=tap1,script=no,downscript=no - - - - Press the <ENTER> key to begin the installation - process. - - - - Wait for the distribution and the 128T to install: - - ------------------------------ -128T Packages Installed - -Please Remove Install Media, - -then enter <Yes> to reboot and -continue install process - - <Yes> <No> ------------------------------- - - Press Yes. - - - - Wait to reboot and press CTR+ a+c to enter - the qemu monitor: - - (qemu) quit - - - - Start qemu only with the qcow2 image attached, no installer - image required: - - >qemu-system-x86_64 -enable-kvm -m 8G -cpu host -smp cores=3,sockets=1 \ --M q35 -nographic bios /usr/share/qemu/bios.bin \ --boot order=c,menu=on \ --hda 128t.qcow2 \ --device e1000,netdev=net1,mac=52:52:01:02:03:01 \ --netdev tap,id=net1,ifname=tap1,script=no,downscript=no - ------------------------------------------------------------------------------- -Booting from Hard Disk... -. - - * CentOS Linux (3.10.0-514.2.2.el7.x86_64) 7 (Core) - CentOS Linux (0-rescue-4e73a369e89e466a888c9c77655a1d65) 7 (Core) - - - Use the ^ and v keys to change the selection. - Press 'e' to edit the selected item, or 'c' for a command prompt. ------------------------------------------------------------------------------- - - Select the first option. - - - - |-------------------128T Installer-------------------| -| | -| Configure Linux Networking | -| | -| Before 128T SetUp? | -| | -| | -| < Yes > < No > | -|----------------------------------------------------| - - Select NO. - - - - |----------------------------------------------------| -| Please select a role for this node: | -| |----------------------------------------------| | -| | (*) Router | | -| | ( ) Conductor | | -| |----------------------------------------------| | -| | -|----------------------------------------------------| -| < OK > < Back > | -|----------------------------------------------------|Select - Router and OK. - - - - |-------------------Conductor Info-------------------| -| | -| |----------------------------------------------| | -| |1st Conductor Address | | -| |Conductor Address | | -| |----------------------------------------------| | -| | -|----------------------------------------------------| -| < OK > < Skip > < Back > < Help > | -|----------------------------------------------------| - - Select SKIP. - - - - |----------------------HA Setup----------------------| -| What kind of Router node is this? | -| |----------------------------------------------| | -| |(*) Standalone No HA peer | | -| |( ) 1st HA Node HA peer is not set up | | -| |( ) 2nd HA Node HA peer is already set up | | -| |----------------------------------------------| | -| | -| | -|----------------------------------------------------| -| < OK > < Back > | -|----------------------------------------------------|Select - Standalone and OK. - - - - |---------------------Node Info----------------------| -| |----------------------------------------------| | -| | Node Role Router | | -| | Node Name 128tNode | | -| | Router Name 128tRouter | | -| |----------------------------------------------| | -| | -|----------------------------------------------------| -| < OK > < Advanced > < Back > < Help > | -|----------------------------------------------------| - - Enter a name for the router and node, press OK. - - - - |-------------------Password Setup-------------------| -| Enter the new password for the 128T 'admin' | -| user: | -| |----------------------------------------------| | -| | 128Tadmin | | -| |----------------------------------------------| | -| | | -|----------------------------------------------------| -| < OK > < Back > | -|----------------------------------------------------| - - Enter the password for web access: 128Tadmin - and confirm the password. - - - - |--------------------------Anonymous Data Collection--------------------------| -| The 128T Networking Platform comes packaged with a software process | -|("Roadrunner") that is used to proactively monitor the health and liveliness | -|of the 128T Router and associated components. This watchdog process collects | -|anonymous information from the router and sends it to 128 Technology for | -|storage and analysis. This information helps inform 128 Technology about | -|software usage, to aid in the support and improvement of the 128 Technology | -|Networking Platform. | -| | -|Disabling this feature will prevent the sending of anonymous usage data to | -|128 Technology. | -| | -| | -| < Accept > < Back > < Disable > | -|-----------------------------------------------------------------------------| - - Select Accept. - - - - |-----128T Statistics Table Creator-----| -| Created table for metric 760/827 | -| Created table for metric 770/827 | -| Created table for metric 780/827 | -| Created table for metric 790/827 | -| Created table for metric 800/827 | -| Created table for metric 810/827 | -| Created table for metric 820/827 | -| Finished pre-creating stats tables | -| Creating tables for audit events | -| Finished creating audit event tables | -| Completed in 27.001386642456055 s | -| Shutting down local Cassandra node | -|---------------------------------------| -| < OK > | -|---------------------------------------| - - Select OK. - - - - |--------128T Installer Status----------| -| | -| Install SUCCESS | -| | -| Start 128T Router | -| before proceeding to | -| login prompt? | -|---------------------------------------| -| < Yes > < No > | -|---------------------------------------| - - Select: Yes - - - - localhost login: root -Password: - - The following user accounts and passwords are created during the - ISO installation process: - - - Accounts Created - - - - - - - User - - Password - - - - - - root - - 128tRoutes - - - - t128 - - 128tRoutes - - - -
- - - - GUI login via HTTPS is enabled by default on port 443 - - [root@localhost ~]# dhclient enp0s2 -[root@localhost ~]# echo "nameserver 8.8.8.8" >>/etc/resolv.conf -[root@localhost ~]# yum -y install cloud-init -[root@localhost ~]# reboot - - - - Wait to reboot and press CTR+ a+c to enter in qemu - monitor. - - (qemu) quit -> qemu-img info 128t.qcow2 -image: 128t.qcow2 -file format: qcow2 -virtual size: 128G (137438953472 bytes) -disk size: 5.4G -cluster_size: 65536 -Format specific information: - compat: 1.1 - lazy refcounts: false - refcount bits: 16 - corrupt: false - - - - Compress the generated 128t.qcow2 image to - decrease the size of VNF image: - - qemu-img convert -O qcow2 -c 128t.qcow2 centos_128t_compressed.qcow2 - -> qemu-img info centos_128t_compressed.qcow2 -image: centos_128t_compressed.qcow2 -file format: qcow2 -virtual size: 128G (137438953472 bytes) -disk size: 1.2G -cluster_size: 65536 -Format specific information: - compat: 1.1 - lazy refcounts: false - refcount bits: 16 - corrupt: false - -centos_128t_compressed.qcow2 - Resulted image can be used in NFV Access. - - - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml deleted file mode 100644 index 827e8cd..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - How to configure Fortigate VNF (day-0 configuration) - - Please check the README file from Fortigate folder for more - details. - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml deleted file mode 100644 index 9641f7c..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - Running Enea Automation Framework tests - - The most relevant information from the Automation Framework and Test - Harness structure: - - |---automation_framework -| |---unittestSuite -| | |---128tCleanup.json - Use case 1 - clean up - test. -| | |---128tDeploy.json - Use case 1 - test. -| | |---128t_FG_SFCCleanup.json - Use case 2 - clean up - test. -| | |---128t_FG_SFCDeploy.json - Use case 2 - test. -| | |---config -| | | |---cmc - - Folder containing the configuration files used by tests. -| | |---unittestLoader.py -| | |---unittestSuite.py -|---lab_config -| |---me1100-1 -| | |---enp4s0f0_0000_04_00_0.json -| | |---enp4s0f1_0000_04_00_1.json -| | |---ibm_br.json - In-band management definition. -| | |---lan_br_enp4s0f1.json - Lan bridge definition. -| | |---me1100-1.json - - Target definition - make sure to update the "address". -| | |---sfc_br.json - Service chain bridge definition. -| | |---vnf_mgmt_br.json - VNF management bridge definition. -|---vnf_config -| |---128t -| | |---128tInstance.json - 128T instantiation - used in use case 1. -| | |---128t.json - 128T onboarding. -| | |---128tSFCInstance.json - 128T instantiation - used in use case 2. -| | |---centos_128t_internet_ci.iso - 128T cloud init (day-0) iso image. -| |---fortigate -| | |---fg_basic_fw.conf - Fortigate day-0 configuration. -| | |---fortigateInstance.json - Fortigate instantiantion. -| | |---fortigate.json - Fortigate onboarding. -| | |---fortigateLicense.lic - - Fortigate license - replace it with a valid License file. -|---vnf_image -| |---centos_128t_with_ci.qcow2 - 128T qcow2 image. -| |---fortios.qcow2 - Fortigate qcow2 image. - - Make sure to update the relevant configuration file for your setup. - The essential files to consider are the target configuration - (me1100-1.json), the license for the Fortigate VNF, and - the 128T cloud-init iso image matching your network. - - To run a test:> cd automation_and_systemtest/automation_framework/unittestSuite -> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 -s - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml deleted file mode 100644 index 7c8c042..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - Example Tests Results using the Automation Framework - - Test Host: -Use Case1 - 128T -> cd automation_and_systemtest/automation_framework/unittestSuite -> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \ --s 128tDeploy.json -d "128T Deployment" - -Running 128T Deployment... - -test 001: Add VCPE Agent from me1100-1 device (__main__.UnittestSuite) ... -2019-08-13 12:49:58,091 - INFO: Add uCPE device -2019-08-13 12:49:58,342 - INFO: Done -ok -test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ... -2019-08-13 12:49:58,358 - INFO: Wait uCPE device -2019-08-13 12:50:03,470 - INFO: Done -ok -test 003: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... -2019-08-13 12:50:03,486 - INFO: Bind NIC -2019-08-13 12:50:03,901 - INFO: Done -ok -test 004: Creating ibm bridge (__main__.UnittestSuite) ... -2019-08-13 12:50:03,920 - INFO: New OVS network bridge -2019-08-13 12:50:17,465 - INFO: Done -ok -test 005: Creating VNF Management bridge (__main__.UnittestSuite) ... -2019-08-13 12:50:17,481 - INFO: New OVS network bridge -2019-08-13 12:50:17,626 - INFO: Done -ok -test 006: Creating LAN bridge and attaching enp4s0f1 interface to the bridge \ - (__main__.UnittestSuite) ... -2019-08-13 12:50:17,643 - INFO: New OVS network bridge -2019-08-13 12:50:18,313 - INFO: Done -ok -test 007: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... -2019-08-13 12:50:18,332 - INFO: Onboard wizard -2019-08-13 12:52:52,909 - INFO: Done -ok -test 008: Instantiate 128T VNF (__main__.UnittestSuite) ... -2019-08-13 12:52:52,924 - INFO: Instantiate VNF -2019-08-13 12:54:06,219 - INFO: Done -ok - ----------------------------------------------------------------------- -Ran 8 tests in 248.144s - -OK - - -Clean-up use-case1 -> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \ --s 128tCleanup.json -d "128T Clean-up" - -Running 128T Clean-up... - -test 001: Destroying 128T VNF (__main__.UnittestSuite) ... -2019-08-13 13:03:02,704 - INFO: Destroy VNF -2019-08-13 13:03:03,619 - INFO: Done -ok -test 002: Deleting network bridge LAN (__main__.UnittestSuite) ... -2019-08-13 13:03:03,635 - INFO: Delete OVS network bridge -2019-08-13 13:03:13,857 - INFO: Done -ok -test 003: Deleting VNF management bridge (__main__.UnittestSuite) ... -2019-08-13 13:03:13,877 - INFO: Delete OVS network bridge -2019-08-13 13:03:24,027 - INFO: Done -ok -test 004: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... -2019-08-13 13:03:24,049 - INFO: Delete OVS network bridge -2019-08-13 13:03:48,815 - INFO: Done -ok -test 005: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... -2019-08-13 13:03:48,835 - INFO: Unbind NIC -2019-08-13 13:03:50,274 - INFO: Done -ok -test 006: Offboarding 128t VNF (__main__.UnittestSuite) ... -2019-08-13 13:03:50,294 - INFO: Offboard VNF -2019-08-13 13:03:50,844 - INFO: Done -ok -test 007: Remove VCPE Agent me1100-1 device (__main__.UnittestSuite) ... -2019-08-13 13:03:50,858 - INFO: Remove uCPE device -2019-08-13 13:03:50,998 - INFO: Done -ok - ----------------------------------------------------------------------- -Ran 7 tests in 48.308s - -OK - - -Use-case2 -> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \ --s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" -Running 128T - Fortigate SFC Deployment... - -test 001: Add VCPE Agent from me1100-1 device (__main__.UnittestSuite) ... -2019-08-13 13:09:16,146 - INFO: Add uCPE device -2019-08-13 13:09:16,272 - INFO: Done -ok -test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ... -2019-08-13 13:09:16,287 - INFO: Wait uCPE device -2019-08-13 13:09:23,421 - INFO: Done -ok -test 003: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ... -2019-08-13 13:09:23,445 - INFO: Bind NIC -2019-08-13 13:09:24,226 - INFO: Done -ok -test 004: Creating ibm bridge (__main__.UnittestSuite) ... -2019-08-13 13:09:24,245 - INFO: New OVS network bridge -2019-08-13 13:09:34,720 - INFO: Done -ok -test 005: Creating VNF Management bridge (__main__.UnittestSuite) ... -2019-08-13 13:09:34,741 - INFO: New OVS network bridge -2019-08-13 13:09:34,885 - INFO: Done -ok -test 006: Creating LAN bridge and attaching enp4s0f1 interface to the bridge \ -(__main__.UnittestSuite) ... -2019-08-13 13:09:34,903 - INFO: New OVS network bridge -2019-08-13 13:09:35,566 - INFO: Done -ok -test 007: Creating SFC(service function chaining) bridge (__main__.UnittestSuite) ... -2019-08-13 13:09:35,587 - INFO: New OVS network bridge -2019-08-13 13:09:35,667 - INFO: Done -ok -test 008: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ... -2019-08-13 13:09:35,684 - INFO: Onboard wizard -2019-08-13 13:12:11,845 - INFO: Done -ok -test 009: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ... -2019-08-13 13:12:11,861 - INFO: Onboard wizard -2019-08-13 13:12:16,157 - INFO: Done -ok -test 010: Instantiate 128T VNF (__main__.UnittestSuite) ... -2019-08-13 13:12:16,175 - INFO: Instantiate VNF -2019-08-13 13:13:31,681 - INFO: Done -ok -test 011: Instantiate Fortigate VNF (__main__.UnittestSuite) ... -2019-08-13 13:13:31,738 - INFO: Instantiate VNF -2019-08-13 13:13:35,985 - INFO: Done -ok - ----------------------------------------------------------------------- -Ran 11 tests in 259.854s - -OK - -# Access 128T management interface -https://172.24.12.154:60001 -user: admin -password: 128Tadmin - -# Access Fortigate management interface -https://172.24.12.154:60002 -user: admin -password: - - - -Use case2 clean-up -> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \ --s 128t_FG_SFCCleanup.json -d "128T - Fortigate SFC CleanUp" - -Running 128T - Fortigate SFC CleanUp... - -test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ... -2019-08-13 13:51:30,204 - INFO: Destroy VNF -2019-08-13 13:51:31,781 - INFO: Done -ok -test 002: Destroying 128T VNF (__main__.UnittestSuite) ... -2019-08-13 13:51:31,822 - INFO: Destroy VNF -2019-08-13 13:51:32,729 - INFO: Done -ok -test 003: Deleting network bridge SFC (__main__.UnittestSuite) ... -2019-08-13 13:51:32,756 - INFO: Delete OVS network bridge -2019-08-13 13:51:42,863 - INFO: Done -ok -test 004: Deleting network bridge LAN (__main__.UnittestSuite) ... -2019-08-13 13:51:42,878 - INFO: Delete OVS network bridge -2019-08-13 13:51:53,087 - INFO: Done -ok -test 005: Deleting VNF management bridge (__main__.UnittestSuite) ... -2019-08-13 13:51:53,103 - INFO: Delete OVS network bridge -2019-08-13 13:52:03,251 - INFO: Done -ok -test 006: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ... -2019-08-13 13:52:03,269 - INFO: Delete OVS network bridge -2019-08-13 13:52:29,868 - INFO: Done -ok -test 007: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ... -2019-08-13 13:52:29,885 - INFO: Unbind NIC -2019-08-13 13:52:31,415 - INFO: Done -ok -test 008: Offboarding 128t VNF (__main__.UnittestSuite) ... -2019-08-13 13:52:31,435 - INFO: Offboard VNF -2019-08-13 13:52:32,009 - INFO: Done -ok -test 009: Offboarding Fortigate VNF (__main__.UnittestSuite) ... -2019-08-13 13:52:32,023 - INFO: Offboard VNF -2019-08-13 13:52:32,157 - INFO: Done -ok -test 010: Remove VCPE Agent me1100-1 device (__main__.UnittestSuite) ... -2019-08-13 13:52:32,170 - INFO: Remove uCPE device -2019-08-13 13:52:32,294 - INFO: Done -ok - ----------------------------------------------------------------------- -Ran 10 tests in 62.104s - -OK - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml deleted file mode 100644 index 459aec8..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -]> - - <trademark class="registered">Enea</trademark> NFV Access CMC Networks Example Use-cases - - Release Version - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml deleted file mode 100644 index 8f11107..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml +++ /dev/null @@ -1,289 +0,0 @@ - - - Enea VNF Example Use-cases - - Enea NFV Access is a complete NFV Infrastructure (NFVI) platform - designed for deployment on white box uCPEs at the customer premise, and - optimized for common Virtual Customer Premises Equipment (vCPE) and SD-WAN - use cases. - -
- Prerequisites - - The following file(s) are needed for this example use-case: - enea-nfv-access-vnf-qemux86-64.qcow2. This image is - provided with your release. -
- -
- TestPMD VNF - - In this use-case, uCPE device 1 will run pktgen - (the DPDK application) and uCPE device 2 will onboard - and instantiate two VNFs. One VNF will run testpmd_fwd, - forwarding traffic, and the other will run testpmd_term - which will terminate traffic. - -
- Enea TestPMD VNF Overview - - - - - - -
- -
- Use-case Setup - - Configuring Network Interfaces on uCPE - devices: - - - - Bind the host interfaces to the DPDK by selecting - uCPE device 1 first, then accessing - Configuration -> - OpenVSwitch -> Host - Interfaces -> Add. - - - - Select the network interface that will be used to connect to - the second uCPE device and configure it for the DPDK. - - - - Select the Create button to send the - configuration to uCPE device 1. - - - - Repeat these same steps on uCPE device - 2. - - - - Click the Add button from the Bridges - tab. - - - - Create an Open vSwitch bridge (ovsbr0) on - uCPE device 1 that uses one DPDK interface, by - selecting uCPE device 1, then: - Configuration ->OpenVSwitch - ->Bridges. - - - - Onboarding the VNF: - - - - Select VNF - ->Descriptor -> - On-board. - - - - Select the VM Image radio button. - - - - Provide the path to the qcow image by selecting - Browse from the VM image file - option. - - - - Fill the required fields below and press - Onboard: - - - - Memory in MB: 1024 - - - - Nr. of CPUs: 1 - - - - Storage in GB: 10 - - - - - - Instantiating two VNFs on uCPE device - 2: - - - - Select uCPE device 2, then access VNF -> - Instances -> Add. - - - - Fill-in the required fields and click - Create. - - - - Configure VNF 1 to forward traffic. - - - - Configure VNF 2 to terminate traffic. - - - - Add Open vSwitch flows to control this traffic: - -
- Configuring the FWD flow - - - - - - -
- -
- Configuring the TERM flow - - - - - - -
- - - - Start pktgen on uCPE device 1. Connect to the device by - selecting it first, then access SSH -> - user (root) and perform the following: - - cd /usr/share/apps/pktgen/ -./pktgen -c 0x7 -n 4 --proc-type auto --socket-mem 256 -w 0000:05:00.3 -- \ --P -m "[1:2].0" -Pktgen:/> start 0 - - - The PCI address <0000:05:00.3> used in this example - varies depending on the uCPE device. To determine the exact PCI - address used, look in the uCPE device specific Network - configuration. - - - -
- -
- Testing the Use-case - - Connect to the forwarder VNF in order to check the traffic - statistics, by selecting the uCPE device first, then accessing - SSH -> user (root): - - Virsh list -Virsh console 1 -# Qemux86-64 login: root -tail -f /var/log/testpmd-out - -
- Traffic Statistics - - - - - - -
-
- -
- TestPMD VNF using PCI passthrough - - In this use case, uCPE device 1 will run the Pktgen and uCPE - device 2 will run the TestPMD VNF. Both will be using PCI - passthrough: - -
- TestPMD VNF using PCI passthrough Overview - - - - - - -
- - - - Make sure that neither uCPE device 1 nor uCPE device 2 have - any configured host interfaces by selcting uCPE device : - Configuration -> - OpenVSwitch -> Host - Interfaces. - - - - On uCPE device 1 start the Pktgen VNF. Select - PciPassthrough as the Interface type. - - From the drop-down list, select the PCI interface - corresponding to the NIC which is connected to uCPE device 2: - -
- Selecting the Pktgen VNF Interface - - - - - - -
- - - - On uCPE device 2, start the TestPmdForwarder VNF. Select - "PciPassthrough" as the Interface type. From the drop-down list, - select the PCI interface corresponding to the NIC which is connected - to uCPE device 1: - -
- Selecting the TestPmdForwarder VNF Interface - - - - - - -
- - - - To check that traffic is being forwarded from uCPE device 2, - SSH to the uCPE device and connect to the VNFs console: - - Right click on uCPE device 2 and select SSH. -Run: virsh list -Run: virsh console [VM NAME] -Run: tail -f /opt/testpmd-out - - -
-
- \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml deleted file mode 100644 index c0df438..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - General Environment Setup - -
- Prerequisites - - - General Prerequisites - - - - - - - - - - - Prerequisites - - Observations - - - - - - Kontron me1100 target - - Processor Xeon-D - - - - 2 x 10G SFP/SFP+ - - - - SSD storage - - - - 32 GB RAM - - - - - - This is an example hardware configuration available in - the Enea internal lab. - - - - One of the SFP ports is connected to a network with - DHCP server access (receiving a dynamic IP based on - MAC). - - - - The target has network access to the uCPE - Manager. - - - - Enea NFV Access must be installed on the target. For - details on how to install Enea NFV Access, please see How to install Enea NFV Access - in . - - - - - - Management machine - Linux based - (CentOS) - - - - The uCPE Manager must be installed on this host or - virtual machine. For installation details see, How to Install the uCPE - Manager in . - - - - The uCPE Manager must have access to the me1100 - target. - - - - A web browser must be installed to access the - management interface of the VNFs. The management interface - of any VNF can be accessed from any machine connected on the - same network with the me1100 target. - - - - - - Development machine - Linux based - - - - The Automation Framework and Test Harness must be - installed. Please see the Enea NFV Access Automation - Framework and Test Harness User Guide for more info. - - - - This is a host or virtual machine with network access - to the uCPE Manager and the me1100 target. - - - - It can be used for the 128T VNF installation. Please - see Appendix B for more details. - - - - - -
-
- -
- Release structure - - |---ENEA_NFV_Access -| |---doc -| | |---book-enea-nfv-access-auto-fw-th-user-guide.pdf -| | |---book-enea-nfv-access-cmc-example-usecases -| | |---book-enea-nfv-access-example-usecases.pdf -| | |---book-enea-nfv-access-getting-started.pdf -| | |---book-enea-nfv-access-open-source.pdf -| | |---book-enea-nfv-access-release-info.pdf -| | |---book-enea-nfv-access-vnf-onboarding-guide.pdf -| | |---book-enea-ucpe-manager-open-source.pdf -| | |---book-enea-nfv-access-auto-fw-th-user-guide.pdf -| | |---book-enea-nfv-access-system-test-specification.pdf -| |---enea-nfv-access-edgelink-netconf-xeon-d-20190812201510.hddimg \ - - NFV Access USB installer image -|---automation_and_systemtest.tar.gz - Automation framework and tests -|---book-enea-nfv-access-cmc-example-usecases.pdf -|---128T -| |---128t-cloud-init-example.tar.gz -| |---centos_128t_internet_ci.iso -| |---centos_128t_with_ci.qcow2 -|---Fortigate -| |---fg_basic_fw_example.conf -| |---README -|---uCPE_Manager -| |---ucpeManager_1.0_b10-CentOS.tar.gz -| |---ucpeManager_1.0_b10-CentOS-VM.ova -| |---ucpeManager_1.0_b10-Windows.zip -
- \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png b/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png deleted file mode 100755 index 9ed0203..0000000 Binary files a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png and /dev/null differ diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png b/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png deleted file mode 100755 index e568824..0000000 Binary files a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png and /dev/null differ diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml deleted file mode 100644 index 5365b16..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - Introduction - - Enea NFV Access for universal Customer Premise Equipment (uCPE) is a - virtualization and management platform, which allows end-users to introduce, - instantiate, and run third-party VNFs onto their operating systems. The - solution is comprised of two major components working in close - cooperation: - - - - The Enea NFV Access Runtime Platform, which acts as the host for - Virtualized Network Functions (VNFs) and provides management over - NETCONF. - - - - The Enea uCPE Manager, a solution that runs on an external server, - providing VNF Management functionality and managing large numbers of - uCPEs. - - - - Enea NFV Access for CMC Networks is tailored around the two use cases - agreed upon during initial discussions. The current version of Enea NFV - Access provides a working and deployable configuration example for the 128T - router and the Fortinet Firewall service chained together on a Kontron - ME-1100 Xeon-D based platform. - - This document describes all steps required to replicate the use cases - in the customer environment. The information provided will guide the user in - reproducing the setup using either the uCPE Manager GUI or the Automation - Framework and Test Harness. - - - - - All VNF configurations should be seen as example configurations - made while working in the Enea internal lab. The customer will update - these configurations according to his local network setup. - Particularities are described in the Appendix chapters. - - - - It is assumed that the user is familiar with Enea NFV Access and - has studied the official documentation, namely the "Enea NFV Access - Getting Started" manual before proceeding with this document. - - - - -
- Revision History - - - Revisions - - - - - - - Revision - - Author - - Date - - Purpose of Revision - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
- References - - [1]What does this refer to and what should be listed - here. -
- -
- Definitions and Acronyms - - - Definitions and Acronyms - - - - - - - - - - - Component - - Definition - - - - - - uCPE Manager - - The Enea uCPE Manager is an EMS/NMS platform that provides - the VNF Management capabilities for NFV Access devices. The uCPE - Manager can be deployed on a Linux (CentOS) based physical or - virtual server. Coresident with the uCPE Manager is additional - functionality, which includes the Automation Framework. - - - - Automation Framework - - The Automation Framework consists of a set of tools and a - collection of Python based scripts that can be used to automate - the process of onboarding a VNF with all of the required - configuration for day zero deployment at scale. This tooling calls - the auto-generated REST API that is exposed on the uCPE Manager as - a north bound interface. - - - -
-
- \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml deleted file mode 100644 index 458da7f..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml +++ /dev/null @@ -1,1087 +0,0 @@ - - - Service Chaining 128T - Fortigate Example Use-case - - The term service chaining or service function chaining (SFC) is used - to describe the definition and instantiation of an ordered list of instances - of such service functions and the subsequent "steering" of traffic flows - through those service functions. The set of enabled service function chains - reflects operator service offerings and is designed in conjunction with - application delivery and service and network policy. - - The Network Service Header (NSH - RFC 8300) is a service-chaining - protocol that is added to network traffic, in the packet header, to describe - a sequence of service nodes (PNFs or VNFs) that the packet must be routed to - prior to reaching its destination address, thus creating a service - chain. - -
- Prerequisites - - The 128T router and the Fortinet firewall in a service chain require - the following prequisites for this example use case: - - - - 1 in band management port for device management. - - - - 1 in band management port for the 128T router. - - - - 1 in band management port for Fortinet. - - - - 1 WAN interface for Fortinet. - - - - 1 LAN facing interface for Fortinet. - - - - 1 WAN facing interface for the 128T router. - - - - 1 service chain (SFC Bridged interface) to sit between the - Firewall and vRouter. - - -
- -
- Service Chaining 128T - Fortigate - -
- Service Chaining 128T - Fortigate Setup Overview - - - - - - -
- -
- Use-case Setup - - Configuring Network Interfaces on uCPE - devices: - - Log into the uCPE Manager with both username and password - values: admin. - - - - Add the Kontron me1100 uCPE device into the uCPE Manager: - Devices -> Manage -> Add. - - Fill in the required fields with the following data: - - - Device Details - - - - - - - - - - - Field - - Value - - - - - - Type - - Enea universal CPE - - - - Release - - 1.0 - - - - Name - - me1100 - - - - IP/DNS Address - - <unspecified> - Please do not provide an IP address. - - - - - Description - - Kontron Target 1 - - - - Device ID - - The value of the Device ID must be the same as the - one used during the NFV Access installation. - - - - SSH Port - - 830 - - - - SSH User Name - - root - - - - Password - - null - - - - OK - - Green status indicates connection with uCPE device - was established. - - - -
- - - - In order to add the device on the map: Right-Click on - Map -> Place Device -> me1100. - - - In order for the device to connect to the uCPE Manager, - it must be added to the uCPE Manager and be powered on, - having the NFV Access platform started, otherwise it must - be rebooted. - - - - - Configure the infrastructure for the 128T and Fortigate VNFs - in the service chain by creating four OVS bridges and a host - interface. - - Add the Host Interface by selecting the - me1100 device, then Configuration - -> External Interfaces -> Configuration -> Add. - Fill in the required fields with the following data: - - - Host Interface Details - - - - - - - - - - - Field - - Value - - - - - - Source - - enp4s0f1. The only interface - available for LAN connection. - - - - type - - dpdk - - - - networking-type - - dpdk - - - - dpdk-type - - vfio-pci - - - - Create - - <interface enp4s0f1 ready to be used in a LAN - bridge.> - - - -
- - Add the OVS bridges by selecting the me1100 device then: - Configuration -> OpenVSwitch -> Bridges -> - Add. - - Fill in the required fields for each bridge with the - following data from each table: - - - ibm_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - ibm_br - - - - ovs-bridge-type - - InbandMgmt - - - - mgmt-address - - Provide the IP address of the uCPE Manager machine - (E.g. 172.24.3.109). - - - - mgmt-port - - 830 - - - - Create - - - - - -
- - - vnf_mgmt_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - vnf_mgmt_br - - - - ovs-bridge-type - - vnfMgmt - - - - vnf-mgmt-address - - 10.0.0.1 - - - - Create - - - - - -
- - - lan_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - lan_br - - - - ovs-bridge-type - - dataPlane - - - - sub-type - - communication - - - - + - - Name: enp4s0f1 OK - - - - Create - - - - - -
- - - sfc_br Bridge Details - - - - - - - - - - - Field - - Value - - - - - - id - - <autogenerated - do not change> - - - - Name - - sfc_br - - - - ovs-bridge-type - - dataPlane - - - - sub-type - - integration - - - - Create - - - - - -
- - - - Onboarding the VNFs: - - Onboard the 128T VNF VM Image through VNF -> - Descriptors -> On-board -> VM Image, and fill in the - required fields with the following values: - - - 128T VM Image Details - - - - - - - - - - - Field - - Value - - - - - - VM image file - - centos_128t_with_ci.qcow2 - - - - Image format - - QCOW2 - - - - VNF Type Name - - 128T - - - - Description - - 128T Router - - - - Version - - 1.0 - - - - Memory in MB - - 8192. More memory can be allocated if required - (<28672). - - - - Num. of CPUs - - 2. More CPUs can be reserved if required - (<15). - - - - Interfaces -> + - - Name: mgmt - - - - Interfaces -> + - - Name: wan - - - - Interfaces -> + - - Name: lan - - - - Cloud Init -> Cloud-Init Datasource - - ISO - - - - Cloud Init -> Cloud-Init Disk Type - - cdrom - - - - Properties -> + - - Name: vnfMgmtIpAddress. Value: 10.0.0.2 - - - - Properties -> + - - Name: internalMgmtPort. Value: 443 - - - - Properties -> + - - Name: externalMgmtPort. Value: 60001 - - - - Onboard - - <Wait for message: VNF package onboarded - successfully> - - - - Close - - - - - -
- - - - - HTTPS access (443) can be changed to another type of access. - Please consult official 128T documentation and make sure the 128T - VNF is configured to accept another type of connection before - changing the port number. - - - - externalMgmtPort(60001) represents the - external port on which the user can access the VNF management - interface from the web browser via HTTPS. The user can select - another port if needed. There are no other changes required or - components affected by this change. - - - - vnfMgmtIpAddress (10.0.0.2) represents - the IP address of the management interface of the 128T VNF. - Changing this value requires an update to the 128T configuration - to match the new IP address. - - - - - Onboard the Fortigate VNF VM Image through VNF -> - Descriptors -> On-board -> VM Image, and fill in the - required fields with the following values: - - - Fortigate VM Image Details - - - - - - - - - - - Field - - Value - - - - - - VM image file - - fortios.qcow2. Please make sure to - contact Fortigate for an official Fortigate KVM image. - - - - Image format - - QCOW2 - - - - VNF Type Name - - Fortigate - - - - Description - - Fortigate VNF - - - - Version - - 1.0 - - - - Memory in MB - - 1024. More memory can be allocated if required - (<28672). - - - - Num. of CPUs - - 1. More CPUs can be reserved if required - (<15). - - - - Interfaces -> + - - Name: mgmt - - - - Interfaces -> + - - Name: wan - - - - Interfaces -> + - - Name: lan - - - - Cloud Init -> Cloud-Init Datasource - - ConfigDrive - - - - Cloud Init -> Cloud-Init Disk Type - - cdrom - - - - Cloud Init -> + - - Path: license - - - - Properties -> + - - Name: vnfMgmtIpAddress. Value: 10.0.0.3 - - - - Properties -> + - - Name: internalMgmtPort. Value: 443 - - - - Properties -> + - - Name: externalMgmtPort. Value: 60002 - - - - Onboard - - <Wait for message: VNF package onboarded - successfully> - - - - Close - - - - - -
- - - - - HTTPS access (443) can be changed to another type of access. - Please consult official Fortigate documentation and make sure the - Fortigate VNF is configured to accept another type of connection - before changing the port number. - - - - externalMgmtPort (60002) represents the - external port on which the user can access the VNF management - interface from the web browser via HTTPS. The user can select - another port if needed. There are no other changes required or - components affected by this change. - - - - vnfMgmtIpAddress (10.0.0.3) represents - the IP address of the management interface of the Fortigate VNF. - Changing this value requires an update to the Fortigate - configuration to match with new IP address. - - - - - Instantiating the VNFs: - - Instantiate the 128T VNF by selecting the me1100 device, then - VNF -> Instances -> Add. - - Fill in the required fields with the following values: - - - 128T VNF Instantiation - - - - - - - - - - - Field - - Value - - - - - - Name - - 128T_me1100_1 - - - - VNF Type - - 128T - - - - VNFD Version - - 1.0 - - - - Flavour - - Canonical - - - - uCPE Device - - me1100 - - - - Cloud Init File - - centos_128t_internet_ci.iso. Example - image provided. Please see Appendix A for details on how to - change the configuration and create a new cloud-init iso - image. - - - - Domain Update Script - - - - - - Interfaces - - - - - - ID - - IF Name - - - - mgmt (dpdk) - - Bridge: vnf_mgmt_br - - - - wan (dpdk) - - Bridge: ibm_br - - - - lan (dpdk) - - Bridge: sfc_br - - - - Create - - - - - -
- - Instantiate the Fortigate VNF by selecting the me1100 device, then - VNF -> Instances -> Add. - - Fill in the required fields with the following values: - - - Fortigate VNF Instantiation - - - - - - - - - - - Field - - Value - - - - - - Name - - fg_me1100_1 - - - - VNF Type - - Fortigate - - - - VNFD Version - - 1.0 - - - - Flavour - - Canonical - - - - uCPE Device - - me1100 - - - - Cloud Init File - - fg_cmc_basic_fw.conf - - - - License File - - FGVM08TM00001.lic. Please make sure to - use a valid license file (.lic) received from Fortinet. - - - - Domain Update Script - - - - - - Interfaces - - - - - - ID - - IF Name - - - - mgmt (dpdk) - - Bridge: vnf_mgmt_br - - - - wan (dpdk) - - Bridge: sfc_br - - - - lan (dpdk) - - Bridge: lan_br - - - - Create - - - - - -
-
- -
- Testing the Use-case - - In order to access the web interfaces of the 128T VNF, open a - browser on a machine connected on the same network with the WAN port of - the target and connect to: - https://<publicIP>:60001 using the username: - admin and the password: 128Tadmin. - - In order to access the web interfaces of the Fortigate VNF, open a - browser on a machine connected on the same network with the WAN port of - the target and connect to: - https://<publicIP>:60002 using the username: - admin, and leaving the password blank. - - - Make sure the WAN interface of the me1100 device has access to - the internet. The Fortigate VNF requires internet access to validate - the license. - - - In order to validate the data path connect a test machine to the - LAN physical port and check for a dynamic IP (the Fortigate LAN - interface is configured with a DHCP server):> dhclient eth1 -> ping 8.8.8.8For data path validation, a new cloud-init - image may need to be generated for the 128T VNF to match your network - configuration. Please check Appendix A "How to create 128T cloud-init - iso image (day-0 configuration)" for details. -
- -
- Use-case Clean-up - - In order to remove the setup created in previously, all components - need to be deleted in reverse order: - - - - Select the me1100 uCPE device -> VNF - -> Instances. Select the 128T and Fortigate VNFs -> - Delete. - - - - Select the me1100 uCPE device -> - Configuration -> OpenVSwitch -> Bridges. Select all bridges - -> Delete. - - - - Select the me1100 uCPE device -> - Configuration -> External Interfaces -> Configuration. Select - all interfaces -> Delete. - - - - VNF -> Descriptors. Select all bundles -> - Offboard. - - -
-
- \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml deleted file mode 100644 index 9fb65a0..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - Running Example Use-cases from the Automation Framework - -
- 128T VNF Router Example Use-case - - Deploying the 128T VNF - Router - - > cd automation_and_systemtest/automation_framework/unittestSuite -> python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> -n me1100-1 \ --s AddDevice_uCPEM.json -d "Add Device uCPE Manager" -> python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> -n me1100-1 \ --s 128tDeploy.json -d "128T Deployment"ADCA wants to replace these last two lines. -With what? - - Use-case Clean-up - - > python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> -n me1100-1 \ --s 128tCleanup.json -d "128T Clean-up" -
- -
- Service Chaining 128T - Fortigate Example Use-case - - Deploying the 128T router and Fortigate - VNF - - > cd automation_and_systemtest/automation_framework/unittestSuite -> python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> -n me1100-1 \ --s AddDevice_uCPEM.json -d "Add Device uCPE Manager" -> python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> -n me1100-1 \ --s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" - - Use-case Clean-up - - > python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> -n me1100-1 \ --s 128t_FG_SFCCleanup.json -d "128T - Fortigate SFC CleanUp" - - - Please replace <uCPE_Manager_IP> with the IP address of the - uCPE Manager machine. - -
- \ No newline at end of file diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk b/doc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk deleted file mode 100755 index ca26c5c..0000000 --- a/doc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk +++ /dev/null @@ -1,10 +0,0 @@ -# Component build specification - -# Version of THIS book -BOOK_VER ?= $(REL_VER)-dev - -DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) - -BOOKPACKAGES := book-enea-nfv-access-cmc-example-usecases -BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) for CMC Networks Example Use-cases" -BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) diff --git a/doc/book-enea-nfv-access-evalkit/doc/book.xml b/doc/book-enea-nfv-access-evalkit/doc/book.xml index 04c3dea..90399a7 100644 --- a/doc/book-enea-nfv-access-evalkit/doc/book.xml +++ b/doc/book-enea-nfv-access-evalkit/doc/book.xml @@ -4,7 +4,7 @@ ]> - <trademark class="registered">Enea</trademark> NFV Access EvalKit Manual + <trademark class="registered">Enea</trademark> NFV Access Evaluation Kit Release Version Date: Mon, 8 Mar 2021 15:44:51 +0100 Subject: Network Configuration: Specify wifi country codes standard Change-Id: Ice2f2c5f9b2a65d1beaed6e1ba5116954c529bf2 Signed-off-by: Andreas Wellving --- doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 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 f610651..cfffb1a 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 @@ -278,7 +278,7 @@ Country Code: the country code, a 2 letter - identifier. + ISO3166-alpha2 identifier. @@ -882,4 +882,4 @@ Interfaces.
- \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From c37fc213aede36af5629e1b1eef67f060c11429a Mon Sep 17 00:00:00 2001 From: Andreas Wellving Date: Mon, 8 Mar 2021 16:20:36 +0100 Subject: Installation: Update error reporting note System is not expected to work if reporting errors during installation. Change-Id: I6cbbf27f4a2490c18e608746c923d1d0fd3059df Signed-off-by: Andreas Wellving --- doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index a6f01bd..12b8205 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml @@ -927,7 +927,8 @@ of=/dev/sdb bs=4M conv=fsync If errors are detected during installation, full logs will be available on the last page of the Web-installer. Please contact Enea - for log analysis. + for log analysis. The system is not expected to be usable if errors are + reported during installation. If the USB stick was booted in UEFI mode, a UEFI boot entry is automatically created and the system will start booting from the hard @@ -1184,4 +1185,4 @@ of=/dev/sdb bs=4M conv=fsync - \ No newline at end of file + -- cgit v1.2.3-54-g00ecf From caf139a980f34b872270e161ac19402adf60af27 Mon Sep 17 00:00:00 2001 From: mrpa Date: Wed, 10 Mar 2021 17:11:03 +0100 Subject: Added in two new limitations: - For Wireless AP configuration, - For the VNF storage size parameter. Change-Id: I1dede34506252139e7ff9c4919869fc9586f0061 Signed-off-by: mrpa --- .../doc/known_bugs_and_limitations.xml | 50 ++++++++++++++-------- 1 file changed, 33 insertions(+), 17 deletions(-) diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml index a1a5db3..4104fa3 100644 --- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml @@ -49,6 +49,13 @@ tests where the Juniper VNF is used. + + USERDOCAP-648The storage size + parameter on the VNF onboarding page is ignored. The default storage + size specified when creating the VM image is used when instantiating the + VM and when presenting VM information. + + LXCR-9853The WAN interface of a uCPE device needs to be connected to a network with at least a router/gateway installed @@ -114,6 +121,13 @@ behavior. + + USERDOCAP-651Wireless AP configuration is + optimized for wireless modules that use the ath10k + driver. Using other wireless modules may result in undefined + behavior. + + ELCCR-1351The updated .Keystore and server.xml files @@ -175,23 +189,25 @@ - PDF navigation: When using links - to open other PDFs, or jump to another place in the same PDF, jumping - back sometimes fails. This has been observed when opening a PDF in Adobe - Reader, inside a browser with PDF add-on, as well as when the browser is - configured to open PDF files in an external PDF reader. As a workaround, - open the HTML version of the document.LXCR-3283 - - - - ELCCR-1468When using the Enea uCPE Manager in HTTPS - mode, upgrading a device from NFV Access 2.3.0 is not possible. Either - switch to HTTP mode (for more details see The uCPE device Upgrade Process in the -Manual) or install it manually. + LXCR-3283PDF + navigation: When using links to open other PDFs, or jump to + another place in the same PDF, jumping back sometimes fails. This has + been observed when opening a PDF in Adobe Reader, inside a browser with + PDF add-on, as well as when the browser is configured to open PDF files + in an external PDF reader. As a workaround, open the HTML version of the + document. + + + + ELCCR-1468When using the Enea uCPE Manager in + HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible. + Either switch to HTTP mode (for more details see The uCPE device Upgrade Process in the + + Manual) or install it manually. -- cgit v1.2.3-54-g00ecf From 496d75b3a39e05a16e570210e433b244beb6047f Mon Sep 17 00:00:00 2001 From: Luana Mincu Date: Fri, 12 Mar 2021 16:40:08 +0200 Subject: ELCCR-1442: remove the Base64 encoding of the InfluxDB password Change-Id: If623705391a6aceb34453fa14e680387f52a7072 --- .../doc/grafana.xml | 206 ++++++++++----------- 1 file changed, 103 insertions(+), 103 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml index 0da3855..91e38f3 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml @@ -1,102 +1,103 @@ Using Grafana and InfluxDB - - InfluxDB is essentially a time series database process that runs on a - server, while Grafana is a visualization tool for time series data. - Grafana is a very lightweight server-side application, and most of the - monitoring runs in a browser. + + InfluxDB is essentially a time series database process that runs on a + server, while Grafana is a visualization tool for time series data. Grafana + is a very lightweight server-side application, and most of the monitoring + runs in a browser.
Deploying Grafana and InfluxDB - - Grafana and InfluxDB can be deployed using images for Docker on linux. - These images are provided by Enea along with a deploy script and - predefined dashboards. - - The Grafana and InfluxDB images can be deployed on the same machine - or on separate machines. + + Grafana and InfluxDB can be deployed using images for Docker on + linux. These images are provided by Enea along with a deploy script and + predefined dashboards. + + The Grafana and InfluxDB images can be deployed on the same machine + or on separate machines.
- Prerequisites for Deploying an Image - + Prerequisites for Deploying an Image + The following must be present in order to deploy an image: - - - - CentOS 7 Linux. - - - - Docker for CentOS 7 installed on the machine and set to - autostart as a service. - - - - Superuser rights on the CentOS 7 machine. - - -
- + + + + CentOS 7 Linux. + + + + Docker for CentOS 7 installed on the machine and set to + autostart as a service. + + + + Superuser rights on the CentOS 7 machine. + + +
+
Deploying Grafana and InfluxDB - - On the CentOS 7 server open a terminal, log into a bash shell - with the root account and perform the following: - - - - Extract - Enea_NFV_Access_Telemetry_Deploy_<version>-build<build_number>.tar.gz. - - The directory in which the archive will be unpacked will be - denoted as: <Telemetry-installdir>. - - - - Enter <Telemetry-installdir>. - - - - Run the provided telemetry_deploy.sh script. - - - - When prompted, select what images you want to deploy. - - If an image is already deployed, you will be prompted to replace it. - - - - During the InfluxDB deployment, you will be prompted to provide - a username and password. These must match the ones configured in the - Enea uCPE Manager for Telemetry. - - - - Changing the InfluxDB username and password requires redeploying - the InfluxDB image. - - - - - Verify the installation by running the command docker ps -a. - The Grafana and InfluxDB containers should be present and have - the status Up. - - - -
+ + On the CentOS 7 server open a terminal, log into a bash shell with + the root account and perform the following: + + + + Extract + Enea_NFV_Access_Telemetry_Deploy_<version>-build<build_number>.tar.gz. + + The directory in which the archive will be unpacked will be + denoted as: <Telemetry-installdir>. + + + + Enter <Telemetry-installdir>. + + + + Run the provided telemetry_deploy.sh + script. + + + + When prompted, select what images you want to deploy. + + If an image is already deployed, you will be prompted to + replace it. + + + + During the InfluxDB deployment, you will be prompted to + provide a username and password. These must match the ones + configured in the Enea uCPE Manager for Telemetry. + + + Changing the InfluxDB username and password requires + redeploying the InfluxDB image. + + + + + Verify the installation by running the command docker + ps -a. The Grafana and InfluxDB containers should be + present and have the status Up. + + +
Setting Grafana and InfluxDB parameters Customizing InfluxDB and Grafana parameters can be done by selecting - System, then the Configuration - menu, accessing the Properties tab, and clicking on the - Telemetry tab. The settings that can be changed - are listed in the table below: + System, then the Configuration menu, accessing the Properties tab, and clicking on the Telemetry tab. The settings that can be changed are + listed in the table below: Telemetry settings @@ -183,8 +184,8 @@
When changing any of the settings in the Telemetry tab, the Enea uCPE Manager will inform all - uCPE devices of the change if they have telemetry running. + role="bold">Telemetry tab, the Enea uCPE Manager will inform + all uCPE devices of the change if they have telemetry running.
Telemetry Properties @@ -203,11 +204,11 @@ When a uCPE Device is selected, in the Operations menu, the Start - Telemetry and Stop - Telemetry options are available. + Telemetry and Stop Telemetry + options are available. - When starting Telemetry for a uCPE device, the Enea uCPE Manager sends - the following information about the InfluxDB: + When starting Telemetry for a uCPE device, the Enea uCPE Manager + sends the following information about the InfluxDB: @@ -226,10 +227,9 @@ These fields are read-only and are populated with the values already - set in the System Configuration. If one of the - fields is not set or if it does not have the desired value, modify it in the - System Configuration. The password is sent - encrypted using the Base64 scheme. + set in the System Configuration. If one + of the fields is not set or if it does not have the desired value, modify + it in the System Configuration.
Telemetry Start Dialog @@ -241,25 +241,25 @@
- When the Telemetry status is changed on a uCPE device, a notification is - sent to the Enea uCPE Manager. These notifications can be inspected under - Fault found in the - Event menu. + When the Telemetry status is changed on a uCPE device, a + notification is sent to the Enea uCPE Manager. These notifications can be + inspected under Fault found in the + Event menu.
Launching Grafana When a uCPE Device is selected, the Telemetry button is available. Pressing this - button will open a new window pointing to Grafana. The current uCPE device will + role="bold">Telemetry button is available. Pressing this button + will open a new window pointing to Grafana. The current uCPE device will be selected in Grafana. The hostname or IP Address and the port of the Grafana installation - can be customized by selecting System, then the - Configuration menu, accessing the - Properties tab, and clicking on the - Telemetry tab. The default dashboard available when - launching Grafana can be customized as well. + can be customized by selecting System, + then the Configuration menu, accessing + the Properties tab, and clicking on the + Telemetry tab. The default dashboard + available when launching Grafana can be customized as well.
\ No newline at end of file -- cgit v1.2.3-54-g00ecf From 187a04b578c6a504ca75ea449ab62103a235c317 Mon Sep 17 00:00:00 2001 From: Catalin Iova Date: Wed, 17 Mar 2021 15:47:19 +0100 Subject: Install guide: web-installer: requirements for FQDN Change-Id: Idf1dc3bcabe4b80fe61b13b9761530dbb3dccee7 Signed-off-by: Catalin Iova --- .../doc/installation_guide.xml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index 12b8205..67aff16 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml @@ -858,8 +858,8 @@ of=/dev/sdb bs=4M conv=fsync - The static Enea uCPE Manager IP Address. This can be - either: + The static Enea uCPE Manager IP Address or FQDN. This can + be either: @@ -873,6 +873,11 @@ of=/dev/sdb bs=4M conv=fsync please see Firewall Configuration. + + + The Fully Qualified Domain Name (FQDN) of the Enea + uCPE Manager host machine. + -- cgit v1.2.3-54-g00ecf