From 1b64e9b4819aa960257aa2e5290b8582b51010c2 Mon Sep 17 00:00:00 2001 From: mrpa Date: Mon, 24 Aug 2020 14:03:13 +0200 Subject: Final 2.2.3 edits. Change-Id: Ic391ab17dd0ebd8483598be84eb9051aec5f0546 Signed-off-by: mrpa --- .../doc/automation_framework_test_harness.xml | 166 +++++++----------- .../doc/getting_started.xml | 4 +- .../doc/128t_vnf_router.xml | 51 ++++-- .../doc/appendix_2.xml | 4 +- .../doc/forti_vnf_examples.xml | 39 ++--- .../doc/service_chaining_128t_fortigate.xml | 75 +++++--- .../doc/vnf_chaining.xml | 38 ++-- .../doc/advanced_configurations.xml | 27 +-- .../doc/getting_started_nfv_access.xml | 192 ++++++++++++--------- .../doc/getting_started_ucpe_manager.xml | 23 ++- .../doc/about_release.xml | 8 +- .../doc/known_bugs_and_limitations.xml | 7 + .../doc/main_changes.xml | 8 +- .../doc/sample_test_cases.xml | 49 ++++-- 14 files changed, 386 insertions(+), 305 deletions(-) diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index 4f94422..2a4cc8a 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml @@ -12,7 +12,14 @@ The /device folder contains Python scripts for adding uCPE device(s), receiving uCPE events' reports, removing a uCPE device, waiting for a uCPE device to connect to the uCPE Manager, as well - as scripts for adding and removing an offline configuration store. + as scripts for adding and removing an offline configuration store. This + folder also contains scripts for uploading and removing an NFVA image into + the uCPE Manager, and for installing and activating a NFVA image on a uCPE + Device. + + The /customScripts folder contains Python scripts + for uploading custom scripts onto the uCPE Manager and uCPE device(s), for + removing custom scripts from the uCPE Manager and uCPE device(s). The /network folder contains Python scripts for binding or unbinding a network interface to and from a uCPE device (DPDK @@ -25,16 +32,19 @@ Commands within the network folder that include the option -o allow the user to perform the action in an offline configuration store alternative available for use at a - later setup time. All options contain either -n, -o or both. - One of them must always be provided, if both are provided, -o has - priority, and -n is thus ignored. + later setup time. Commands that include the -n option refer to a uCPE device, with the + operation being performed on uCPE device. All options contain either + -n, -o + or both. One of them must always be provided, if both are provided, -o + has priority, and -n is thus ignored. - The /unittestSuite folder contains Python - unit-test class and loader scripts for generating specific test cases for - the available Python scripts. The generated test cases are injected into - the Python unit-test suite class to be run using the Python unit-test + The /unittestSuite folder contains JSON files for + complex scenarios (multiple operations), as well as Python unit-test class + and loader scripts for generating specific test cases for the available + Python scripts. The generated test cases are injected into the Python + unit-test suite class to be run using the Python unit-test framework. The /unittestSuite/config folder contains @@ -43,6 +53,10 @@ that must contain the test case name and arguments to be passed to the Python script for running the test case. + The /unittestSuite/vnf_config directory contains + symlinks for the Fortigate license file and for the + /vnf_config/fortigateImage folder. + The /vnf folder contains Python scripts for onboarding and offboarding a VNF image, instantiating a VNF, controlling a VNF instance or destroying an existing one. @@ -107,7 +121,8 @@ Options: Below is a sample unit-test configuration file, describing the Fortigate deployment scenario - fortigateDeploy.json: + fortigateDeploy.json, found in + <AF-TH-install-dir>/automation_framework/unittestSuite: [ { @@ -1346,78 +1361,6 @@ Options: -
- Onboarding a VNF Image - - The specifics of how to Onboard a VNF image onto the Enea uCPE - Manager is detailed below. - -
- Script Options - - $ python onboardVNF.py -h -Usage: onboardVNF.py [options] - -Onboard a VNF to Enea uCPE Manager. - -Options: - --version show program's version number and exit - -h, --help show this help message and exit - -u USERNAME, --username=USERNAME - Enea uCPE Manager login username - -p PASSWORD, --password=PASSWORD - Enea uCPE Manager login password - -H HOST, --host=HOST Enea uCPE Manager host name or IP address - -f FTPUSERNAME, --ftpUsername=FTPUSERNAME - Username for FTP - -w FTPPASSWORD, --ftpPassword=FTPPASSWORD - FTP password - -P FTPPORT, --ftpPort=FTPPORT - FTP port - -b VNFBUNDLE, --bundle=VNFBUNDLE - File name of VNF bundle in ZIP format - - Mandatory options: - -H/--host, -b/--bundle -
- -
- Configuring the JSON File - - The JSON configuration file needed to onboard a VNF image should - contain a list of dictionaries. Each dictionary indicates the test - case name and the test case arguments passed to the - onboardVNF Python module. - - Sample unit-test JSON file - format:[ - { - "name": "Onboarding Fortigate VNF ", - "args": "-b ../../vnf_images/Fortigate.zip" - } -] -
- -
- Running the Python Module - - The onboardVNF Python module can be - executed individually by running the following command line: - - $ python onboardVNF.py -u admin -p admin -f ftp -w ftp -H localhost -b -../../vnf_images/Fortigate.zip -2019-02-25 16:00:53,890 - DEBUG: Started logging -2019-02-25 16:00:53,890 - INFO: Onboard VNF -2019-02-25 16:00:53,985 - DEBUG: Login successful on host 'localhost' -2019-02-25 16:00:53,985 - DEBUG: Session token is: c421cd03-3905-11e9-a81f525400d08e1d -2019-02-25 16:00:53,994 - DEBUG: FTP file '../../vnf_images/Fortigate.zip' on host -'localhost', port '2021' -2019-02-25 16:00:54,229 - DEBUG: Onboard VNF: Fortigate -2019-02-25 16:00:56,836 - INFO: Done -2019-02-25 16:00:56,861 - DEBUG: Logging out and exiting... -
-
-
Onboarding a VNF Image Raw @@ -2562,34 +2505,41 @@ Options: The setup_env.sh script sets up the testHarness test environment by creating testHarness-venv python virtualenv, executing requests - needed by Automation Framework python modules and installing Ansible. The - playbooks directory contains all the implemented Ansible Playbooks. For - more details please refer to chapter "Sample Test Cases" from the Enea NFV - Access System Test Specification document need an olink to that - chapter here.. - - The uCPEM_config directory stores JSON + needed by Automation Framework python modules and installing + Ansible. + + The /playbooks directory contains all the + implemented Ansible Playbooks. For more details please refer to the Sample Test Cases Chapter in the + Manual. + + The /uCPEM_config directory stores JSON configuration files needed for the setup of the uCPE Manager used by TH. One configuration file is needed per uCPE Manager installation, to be used - in the TH. The vnf_image directory stores the VNF - Images needed by the Ansible Playbooks (i.e. the sample test - cases). - - The lab_config directory stores the JSON - configuration files related to a device (devicesclarify this - please, what devices do you mean?, NICs and bridges). Each - subfolder should be named exactly like the device name and should contain - all the related configuration files needed for the test cases to be run on - it. - - The vnf_config directory stores the configuration - files related to a VNF Descriptor. Typically these include a VNF Image - JSON, VNF Instance JSON, VNF license and any other files required by the - type of the VNF. Each subfolder should be named exactly like the name of - the VNF Descriptor and should contain all the related configuration files - needed for test cases to be run using this VNF. - - The log directory is created when the + in the TH. + + The /vnf_image directory stores the VNF Images + needed by the Ansible Playbooks (i.e. the sample test cases). + + The /lab_config directory stores the JSON + configuration files related to a device (devices, NICs and bridges) as + well as sample custom scripts. Each subfolder should be named exactly like + the device name and should contain all the related configuration files + needed for the test cases to be run on it. + + The /vnf_config directory stores the + configuration files related to a VNF Descriptor and VNF instances. + Typically these include a VNF Image JSON, VNF Instance JSON, VNF license + and any other files required by the type of the VNF. Each subfolder should + be named exactly like the name of the VNF Descriptor and should contain + all the related configuration files needed for test cases to be run using + this VNF. + + The /log directory is created when the setup_env.sh is run. When test cases are run, the Ansible and the Python logs are stored in the ansible.log and debug.log files, diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml index 18e7048..68e6f12 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml @@ -159,8 +159,8 @@ Unzip the - nfvaccess<version>_af-th.zip archive file, - provided by Enea, on a supported host machine. + Enea_NFV_Access_AF-TH_<version>-build<build_number>.zip + archive file, provided by Enea, on a supported host machine. The directory in which the archive has been unpacked will be denoted as <AF-TH-installdir>. diff --git a/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml b/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml index 9b63248..d58f101 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/128t_vnf_router.xml @@ -29,6 +29,38 @@ 1 LAN interface for 128T. + + The following files are needed for this example use-case: + + + + 128T router VNF image. Please contact 128 Technology to get a + VNF image and its license file. + + + + cloud-init iso image. Please check Appendix A: How to create a 128T + cloud-init iso image (day-0 configuration) in the + Manual for more details. + + + + + For 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) in the + Manual for more details. +
@@ -49,11 +81,6 @@ Configuring Network Interfaces on uCPE devices: - - Log into the uCPE Manager with both username and password - values: admin. - - Add the trgt uCPE device into the uCPE Manager: Devices -> Manage -> Add. @@ -375,8 +402,8 @@ Onboarding the VNFs: Onboard the VM Image through VNF -> Descriptors -> - On-board -> VM Image, and fill in the required fields with - the following values: + On-board, and fill in the required fields with the following + values: VM Image Details @@ -637,6 +664,11 @@
+ + + To procure the VNF image files and their licenses, please + contact each respective VNF provider. +
@@ -661,10 +693,7 @@ 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.3 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. +> ping 8.8.8.8
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml b/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml index b0a90b2..2458d99 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/appendix_2.xml @@ -6,8 +6,8 @@ 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. + Keep in mind a Virtual Machine was used instead of a physical + host. Prerequisites: diff --git a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml index b5e7803..36c7114 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/forti_vnf_examples.xml @@ -166,7 +166,7 @@ Cloud-init content file: Add - a license file entry. + a file entry where Path: license. @@ -249,13 +249,13 @@ The FortiGate VNF management interface is accessible through the WAN interface. The WAN IP address can be used from a web browser on the - Lab Machine to access the FortiGate VNF Management Web UI. Please check + Lab Machine to access the FortiGate VNF Management Web UI. See section FortiGate VNF web managementFortiGate VNF web management in the + - for more information. + Manual for more information.
@@ -343,13 +343,13 @@ - Connect the VNFMgr interfaces to the Lab - Network for VNF management access. + Connect the VNF Management interfaces to + the Lab Network for VNF management access. - Directly connect the WAN interfaces back to - back (using a cable) or connected via VPN. + Connect the WAN interfaces back to back or + via VPN. @@ -434,7 +434,7 @@ Cloud-init content file: Add - a license file entry. + a file entry where Path: license. @@ -502,9 +502,8 @@ sdwan1 example configuration file. To complete the branch-to-branch setup, configure uCPE - device 2 in the same way as uCPE device 1. - Make sure to use the sdwan2 configuration file for - the second VNF instantiation. + device 2 in the same way as uCPE device + 1. The names of the ports used during instantiation need to be the @@ -520,15 +519,13 @@ be established between the two uCPE devices. The Test Machines can be connected to the LAN interface on each uCPE device. - The connected Test Machine can be a laptop or a uCPE device that - has one interface configured to get a dynamic IP from a DHCP server. The - dhclient <interface> command can be used to - request an IP address. - - The received IP must be in the 172.16.1.2 - 172.16.1.255 range - for Test Machine-1 and in the 172.16.2.2 - 172.16.2.255 range for Test - Machine-2. + The connected Test Machine can be a laptop or a uCPE device that + has one interface configured to get a dynamic IP from a DHCP server. + The dhclient <interface> command can be used + to request an IP address.The received IP must be in the 172.16.1.2 - + 172.16.1.255 range for Test Machine-1 and in the 172.16.2.2 - + 172.16.2.255 range for Test Machine-2. The Test Machine connected to uCPE device 1 diff --git a/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml b/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml index 4719399..43c3fce 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/service_chaining_128t_fortigate.xml @@ -2,12 +2,9 @@ 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 following is an example of how to setup and configure a service + chain on top of the Enea NFV Access virtualization platform, using the + following commercial VNFs: 128T router and FortiGate.
Prerequisites @@ -45,6 +42,36 @@ Firewall and vRouter. + + The following files are needed for this example use-case: + + + + FortiGate VNF image. Please contact Fortinet to get a VNF image + and its license file. + + + + 128T router VNF image. Please contact 128 Technology to get a + VNF image and its license file. + + + + Cloud-init iso image. Please check Appendix A: How to create a 128T + cloud-init iso image (day-0 configuration) in the + Manual for more details. + + + + + To procure the VNF image files and their licenses, please contact + each respective VNF provider. +
@@ -65,11 +92,6 @@ Configuring Network Interfaces on uCPE devices: - - Log into the uCPE Manager with both username and password - values: admin. - - Add the trgt uCPE device into the uCPE Manager: Devices -> Manage -> Add, and fill in the @@ -225,10 +247,8 @@ Add the OVS bridges by selecting the trgt device then: Configuration -> OpenVSwitch -> Bridges -> - Add. - - Fill in the required fields for each bridge with the - following data from each table: + Add. Fill in the required fields for each bridge with + the following data from each table: ibm_br Bridge Details @@ -276,6 +296,8 @@
+ + vnf_mgmt_br Bridge Details @@ -443,8 +465,8 @@ 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: + Descriptors -> On-board, and fill in the required fields + with the following values:
128T VM Image Details @@ -600,8 +622,8 @@ Onboard the Fortigate VNF VM Image through VNF -> - Descriptors -> On-board -> VM Image, and fill in the - required fields with the following values: + Descriptors -> On-board, and fill in the required fields + with the following values:
Fortigate VM Image Details @@ -626,7 +648,7 @@ VM image filefortios.qcow2. Please make sure to - contact Fortigate for an official Fortigate KVM image. + contact Fortinet for an official FortiGate KVM image. @@ -822,10 +844,7 @@ 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. + centos_128t_internet_ci.iso. @@ -873,6 +892,11 @@
+ + To procure the VNF image files and their licenses, please + contact each respective VNF provider. + + Instantiate the Fortigate VNF by selecting the trgt device, then VNF -> Instances -> Add. @@ -936,8 +960,7 @@ License File - FGVM08TM00001.lic. Please make sure to - use a valid license file (.lic) received from Fortinet. + The FortiGate license file provided by Fortinet. diff --git a/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml b/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml index b8b0d5e..8b82337 100644 --- a/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml +++ b/doc/book-enea-nfv-access-example-usecases/doc/vnf_chaining.xml @@ -2,6 +2,13 @@ VNF Chaining 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 following is an example of how to setup and configure a branch-to-branch service comprised on two commercial VNFs (SD-WAN + Firewall). This service will run in a service chain on top of the Enea NFV @@ -40,11 +47,6 @@ The following files are needed for this example use-case: - - To procure the VNF image files and their licenses, please - contact each respective VNF provider. - - Fortigate VNF image file. @@ -54,6 +56,10 @@ Juniper vSRX VNF image file. + + vSRX-Site<x>.iso Cloud-init files. + + VNF Configuration files, provided with your Enea NFV Access Release: @@ -63,16 +69,19 @@ vSRX-domain-update-script. - - vSRX-Site<x>.iso. - - FortiFW-Site<x>.conf. + + + To procure the VNF image files and their licenses, please + contact each respective VNF provider. To create the + vSRX-Site<x>.iso file, please follow the documentation provided + by Juniper. +
@@ -205,8 +214,8 @@ - Add license as the Cloud-Init content - in the Cloud-Init tab files. + In the Cloud-init content files field add an entry where + Path: license. @@ -222,11 +231,6 @@ Use vSRX-Site1.iso as the Cloud-Init file. - - - Please follow Juniper's documentation to create the - vSRX-Site1.iso file. - @@ -239,7 +243,7 @@ Add virtual interfaces: - + Management interface added to vnf_mgmt_br. diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml index 47c4ea4..649a80d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml @@ -253,6 +253,14 @@ node0.1048576kB = 3 root filesystem. When the installation is complete, the uCPE device is automatically rebooted into Enea NFV Access Run Time Platform. + + The .hddimg, initramfs, and + bzImage files are available in the + Enea_NFV_Access_Run_Time_Platform_ + <processor>_<version>-<build_number>.tar.gz file you + downloaded with your release. + +
Prerequisites @@ -303,9 +311,10 @@ node0.1048576kB = 3 Compress the Enea NFV Access Run Time Platform - hddimg image for the uCPE device architecture - using gzip and copy the resulting - hddimg.gz file to the HTTP server. + .hddimg image for the uCPE + device architecture using gzip and copy the + resulting hddimg.gz file to the HTTP + server. @@ -348,14 +357,12 @@ node0.1048576kB = 3 Installation Configuration File Example: - - image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz - install_drive = /dev/sda + image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz +install_drive = /dev/sda - - - The installation configuration file needs to use the Linux end-of-line - format (\n), not the Windows format (\r\n). + + The installation configuration file needs to use the Linux + end-of-line format (\n), not the Windows format (\r\n).
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml index bb7b525..d46b4c7 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml @@ -8,16 +8,24 @@ Enea NFV Access Run Time Platform Installer The current release supports two methods of installation: - + - Manual installation from a USB stick using the Enea NFV Access Web-installer, - which guarantees a clean installation of NFV Access on a uCPE device. - Mass installation and automated deployment using - Bare Metal Provisioning. + + Manual installation from a USB stick using the Enea NFV Access + Web-installer, which guarantees a clean installation of NFV Access on + a uCPE device. + + + + Mass installation and automated deployment using Bare Metal + Provisioning. + - - For more information about Bare Metal Provisioning please refer - to 5.3, Bare Metal Provisioning". + + For more information about Bare Metal Provisioning please refer to + + 5.3, Bare Metal Provisioning" + .
Prerequisites @@ -202,149 +210,167 @@ rootfs_destination=
Creating a bootable USB stick - In order to install the Enea NFV Access Run Time Platform, you must - first create a bootable USB stick with the image you intend to + In order to install the Enea NFV Access Run Time Platform, you + must first create a bootable USB stick with the image you intend to install. Follow the example below to proceed. + + The .hddimg image is available in the + Enea_NFV_Access_Run_Time_Platform_ + <processor>_<version>-build<build_number>.tar.gz file you + downloaded with your release. + + Create a bootable USB stick image - Copy the HDDIMG image file provided by Enea, onto a - development machine. + Copy the .hddimg image file provided by + Enea, onto a development machine. Connect the USB stick to the development machine and identify - the device name given by the system with - lsblk: - NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT + the device name given by the system with lsblk: + NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT sda 8:0 1 28.7G 0 disk sdb 8:0 0 111.8G 0 disk |-sdb1 8:1 0 111.8G 0 part - Copy the HDDIMG image onto the USB stick, e.g: - sudo dd if=./enea-nfv-access-<machine>.hddimg \ + Copy the .hddimg image onto the USB stick, + e.g: sudo dd if=./enea-nfv-access-<machine>.hddimg \ of=/dev/sdb bs=4M conv=fsync Where enea-nfv-access-<machine>.hddimg - is the .hddimg file and sdb is the - assigned USB device name. + is the .hddimg file and + sdb is the assigned USB device name.
Installing Enea NFV Access - + How to install the Enea NFV Access Run Time Platform using a bootable USB stick image - Plug the USB stick into the uCPE device. Connect a laptop directly into one of the ports that will - not later be chosen as a WAN port. No other ports should be connected. + Plug the USB stick into the uCPE device. Connect a laptop + directly into one of the ports that will not later be chosen as a + WAN port. No other ports should be connected. - Power up the uCPE device and boot the USB stick. Verify that the - USB stick is selected from the BIOS boot menu. + Power up the uCPE device and boot the USB stick. Verify that + the USB stick is selected from the BIOS boot menu. - Once the USB stick is properly booted, the Web-installer application starts - automatically and can be accessed in a web browser at http://172.16.1.1 (port 80). - - - On the first page of the Web-installer, the user should fill in: + Once the USB stick is properly booted, the Web-installer + application starts automatically and can be accessed in a web + browser at http://172.16.1.1 (port 80). + + On the first page of the Web-installer, the user should fill + in: - The uCPE Manager IP Address. + The uCPE Manager IP + Address. - The Device ID. The unique identifier of the - uCPE device. - + The Device ID. The unique + identifier of the uCPE device. - Customer Tags. They are used for - Zero Touch Provisining (ZTP) and can be left - empty. What can be entered here (as needed), are the tag(s) specified when - creating an offline configuration in the uCPE Manager. + Customer Tags. They are + used for Zero Touch Provisining + (ZTP) and can be left empty. What can be entered here (as + needed), are the tag(s) specified when creating an offline + configuration in the uCPE Manager. - On the second page of the Web-installer, the user should fill in: + On the second page of the Web-installer, the user should fill + in: - + - The Layer 3 configuration of WAN Interface(s). - Static or Dynamic IP must be specified. - - During network configuration, WAN cables will be plugged into the device - in order to identify ports and make them available for configuration. Each - port with a physically connected cable will be automatically set as a WAN port and must be - configured (DHCP is the default setting). The user needs to connect the same quantity of - cables as the number of WAN ports that he wishes to configure. No LAN ports should be - connected nor configured at this time. The configured WAN cables cannot be removed - after being configured. - - - The LAN port used to access the Web-installer from the laptop will not be shown - and cannot be configured. + The Layer 3 configuration of WAN + Interface(s). Static or Dynamic IP must be + specified. + + During network configuration, WAN cables will be plugged + into the device in order to identify ports and make them + available for configuration. Each port with a physically + connected cable will be automatically set as a WAN port and must + be configured (DHCP is the default setting). The user needs to + connect the same quantity of cables as the number of WAN ports + that he wishes to configure. No LAN ports should be connected + nor configured at this time. The configured WAN cables cannot be + removed after being configured. + + + The LAN port used to access the Web-installer from the + laptop will not be shown and cannot be configured. + - - The Management Interface. The interface that - will be used by the uCPE Manager to communicate with the device. - - + + The Management Interface. + The interface that will be used by the uCPE Manager to + communicate with the device. + - When the user has completed the configuration steps in the Web-installer, NFV Access - is installed on the hard drive. The largest drive found on the device will be used for - installation. + When the user has completed the configuration steps in the + Web-installer, NFV Access is installed on the hard drive. The + largest drive found on the device will be used for + installation. -
Booting NFV Access - When the installation has finished successfully, the user should remove the USB stick - before confirming the reboot of the device in Web-installer and ensure that BIOS is configured - to boot from the hard drive. + When the installation has finished successfully, the user should + remove the USB stick before confirming the reboot of the device in + Web-installer and ensure that BIOS is configured to boot from the hard + drive. + + When configured with the Web-installer GUI, the uCPE device + start-up sequence will configure the interfaces accordingly and try to + register the device in the uCPE manager. If connectivity is established + with the uCPE manager server and a device with a matching Device ID is + found, the configuration is successful, and the connection is + established. - When configured with the Web-installer GUI, the uCPE device start-up sequence will - configure the interfaces accordingly and try to register the device in the uCPE manager. - If connectivity is established with the uCPE manager server and a device with a matching - Device ID is found, the configuration is successful, and the connection is established. - - If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at - start-up expecting the user to provide the post-installation configuration. The Web-installer will - be launched on port 80 for post-installation configuration: + If NFV Access was installed by Bare Metal Provisioning, the + Web-installer will launch at start-up expecting the user to provide + the post-installation configuration. The Web-installer will be + launched on port 80 for post-installation configuration: http://172.16.1.1. - In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot - the device and then access the Web-installer on http://172.16.1.1. - - - - After having established a successful connection with the uCPE Manager, the user will - connect any LAN cable(s) that should be connected to the device. - - + In case of failure, the user should remove all WAN cables, + re-attach the laptop, reboot the device and then access the + Web-installer on http://172.16.1.1. + + + After having established a successful connection with the uCPE + Manager, the user will connect any LAN cable(s) that should be + connected to the device. +
@@ -684,4 +710,4 @@ ssh root@<target_ip> "cd /mnt/sda6; tar -zxf -"
- + \ No newline at end of file diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 818bd52..dda71bb 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml @@ -228,11 +228,11 @@ userdel postgres - configureHA.sh + configureHA.sh - ucpemanager-x.y-Buildz-Linux.tar.gz + Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz @@ -244,7 +244,8 @@ userdel postgres Run the following command: - ./install.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz + ./install.sh /opt/ems \ + Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz @@ -321,7 +322,7 @@ userdel postgres additional argument as shown below: ./install.sh \ - /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz \ + /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ SystemBackup_MMMDD_YYYY_HHMM_SS.zip The other steps are exactly the same as specified in the @@ -350,7 +351,7 @@ userdel postgres - ucpemanager-x.y-Buildz-Linux.tar.gz + Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz @@ -358,7 +359,8 @@ userdel postgres Run the following command: - ./upgrade.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz + ./upgrade.sh /opt/ems \ + Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz @@ -1298,6 +1300,13 @@ userdel postgres Uploaded Successfully appears on the File Upload Screen. + + The image file of type rootfs.ostree.tar.bz2 + is available in the + Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz + file you downloaded with your release. + +
Image Library @@ -1320,7 +1329,7 @@ userdel postgres to the image file (must be of type rootfs.ostree.tar.bz2). Select the target hardware platform corresponding to the image being uploaded - (xeon-d or atomc-3000). + (xeon-d or atom-c3000). diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml index ed7394c..ef46843 100644 --- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml +++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml @@ -20,19 +20,19 @@ - Enea_NFV_Access_Run_Time_Platform_XeonD_2.2.3.tar.gz + Enea_NFV_Access_Run_Time_Platform_C3000_<version>-build<build_number>.tar.gz - Enea_NFV_Access_Run_Time_Platform_C3000_2.2.3.tar.gz + Enea_NFV_Access_Run_Time_Platform_XeonD_<version>-build<build_number>.tar.gz - ucpeManager_2.2.3_b1-CentOS.tar.gz + Enea_NFV_Access_AF-TH_<version>-build<build_number>.zip - nfvaccess2.2.3_af-th.zip (Automation and Test Harness) + Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz 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 007c150..c1d7de5 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 @@ -86,6 +86,13 @@ triggered, even if the delete operation succeeds. + + ELCCR-847The Juniper VNF cannot be instantiated + on the XeonD architecture because the domain XML file cannot be modified + prior to creating a Virtual Machine. This impacts all Examples Use Cases + and AF&TH Tests where Juniper VNF is used. + + LXCR-????The Call Home functionality does not support having multiple interfaces/routes that go from the device to the diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml index c373d39..a9a360c 100644 --- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml +++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml @@ -12,7 +12,13 @@
New Features - No new features were added in this release. + + Added support for running the uCPE Manager behind a NAT. + The Domain Upgrade Script supplied during VNF instantiation is now executed + after the virsh define command, in order to perform additional system configurations. + Corrections and improvements towards the content of previous NFV Access + release. +
diff --git a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml index 3443883..b55b9bc 100644 --- a/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml +++ b/doc/book-enea-nfv-access-system-test-specification/doc/sample_test_cases.xml @@ -304,8 +304,13 @@ Duplicate entry - Release already installed - The playbook imports the previously described - playbooks: + The playbook imports the previously described playbooks: + + + + playbooks/waitDeviceUp.yml + + playbook/uploadImage.yml @@ -321,7 +326,7 @@ Duplicate entry - Release already installed playbook/clearCompletedUpgradesInfo.yml - + @@ -334,8 +339,8 @@ Duplicate entry - Release already installed - A device JSON configuration file must be created: - <AF-TH-install-dir>/lab_config/<Device-name>/<Device-name>.json + A device JSON configuration file must be created: + <AF-TH-install-dir>/lab_config/<Device-name>/<Device-name>.json @@ -344,7 +349,9 @@ Duplicate entry - Release already installed <Image-path>, <Image-name>, <Upgrade-type>, and the - <Device-name> as extra-vars:ansible-playbook playbooks/installNFVAImage.yml -e \ + <Device-name> as extra-vars: + + ansible-playbook playbooks/installNFVAImage.yml -e \ device="<Device-name>" -e image_path="<Image-path>" -e \ image_name="<Image-name>" -e upgrade_type="<Upgrade-type>" @@ -832,10 +839,17 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< - Precondition: + Precondition: + + The Offline Configuration Store should not already exist on + the uCPE Manager. If it exists, the test will report a + duplicate. + - The Offline Configuration Store should not already exist on the - uCPE Manager. If it exists, the test will report a duplicate. + + A store JSON file needs to exist: <AF-TH-install-dir>/lab_config/<device-name>/store.json + + Action: Run the addConfigStore.yml Ansible Playbook with the @@ -909,8 +923,17 @@ DEBUG: "{{ scriptName }} from phase {{ phase }} was removed from {{ device }}!"< Precondition: - The Offline Configuration Store should exist in the uCPE Manager. - If it does not, the test will say so. + + + The Offline Configuration Store should exist in the uCPE + Manager. If it does not, the test will say so. + + + + A Bridge JSON configuration file needs to exist: + <AF-TH-install-dir>/lab_config/<device-name>/<bridge-name>.json + + Action: Run the addOfflineBridge.yml Ansible Playbook with the @@ -1115,8 +1138,8 @@ vnfi=<VNFI-name>"This test case was implemented in two different ways to exemplify both methods supported by the AF and TH to deploy such services. - Prerequisites needed in order to deploy the FortiGate VNF as a - Firewall: + How to deploy the FortiGate VNF as a + Firewall: -- cgit v1.2.3-54-g00ecf