From 794b53e0312e4690b926dd9073cf7ef57ecf9047 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Thu, 4 Apr 2019 14:20:54 +0200 Subject: GettingStarted: use unified terms - Use "uCPE device" to refer to target/board/host - Use Enea NFV Access Run Time Platform in all documentations - Add Definitions and Acronyms Change-Id: I4347baf9fa74b40bc6297edeea1b2cd45d373485 Signed-off-by: Sona Sarmadi --- .../doc/book.xml | 3 + .../doc/definitions_and_acronyms.xml | 78 ++++++++++++++ .../doc/device_configuration_and_provisioning.xml | 115 +++++++++++---------- .../doc/getting_started_nfv_access.xml | 108 +++++++++---------- .../doc/in_band_management.xml | 16 +-- .../doc/introduction.xml | 6 +- 6 files changed, 200 insertions(+), 126 deletions(-) create mode 100644 doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml diff --git a/doc/book-enea-nfv-access-getting-started/doc/book.xml b/doc/book-enea-nfv-access-getting-started/doc/book.xml index 5943980..1f51d01 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/book.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml @@ -18,6 +18,9 @@ + + diff --git a/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml b/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml new file mode 100644 index 0000000..38c71b8 --- /dev/null +++ b/doc/book-enea-nfv-access-getting-started/doc/definitions_and_acronyms.xml @@ -0,0 +1,78 @@ + + + + Definitions and Acronyms + +
+ Definitions + + + Definitions + + + + + + + + + Enea NFV Access + + The Enea NFV Access Run Time Platform (with ODM) and uCPE + Manager. + + + + Enea NFV Access Run Time Platform + A lightweight, multi-architecture virtualization platform, + supporting Virtual Machines (KVM / QEMU). + + + + Enea uCPE Manager + Enea Universal Customer Premises Equipment Manager. + + + + uCPE device + A whitebox (e.g. Intel XeonD) running Enea NFV Access Run + Time platform. + + + +
+
+ +
+ Acronyms + + + acronyms + + + + + + + + + ODM + On Device Management. + + + + OVS + Open vSwitch. + + + + VIM + + Virtual Infrastructure Manager. + + + +
+
+ diff --git a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml index 8aa1aeb..1fb5b1c 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml @@ -1,4 +1,4 @@ - + Device Configuration and Provisioning @@ -6,16 +6,16 @@ Manual Configuration This section describes how to connect to an instance of NFV Access - installed on a specific target, and how to setup the virtual + installed on a specific uCPE device, and how to setup the virtual infrastructure manually. - How to add a board to the management system + How to add a uCPE device to the management system - Add the boards running NFV Access to the management system. This is + Add the uCPE device running NFV Access Run Time Platform to the management system. This is done by using the Devices -> Manage -> Add menu. - Supply information about the board running NFV Access, and set the - parameters that will be used to connect to the board. The relevant + Supply information about the uCPE device, and set the + parameters that will be used to connect to the uCPE device. The relevant parameters are described below: @@ -66,8 +66,9 @@ Device Calls Home. This checkbox indicates the direction of device communications. In the Manual Configuration, leave this box - blank. For more info about how to add a device please refer to - Zero Touch Provisioning, Adding a Device. + blank. For more info about how to add a device please refer to Zero Touch Provisioning, Adding a + Device. @@ -84,9 +85,10 @@
Host Interfaces and Network Configuration - The uCPE Manager can list network interfaces found on a device - (Device -> Configuration -> OpenVSwitch -> Host Interface - Caps): + The uCPE Manager can list network interfaces found on a device by + selecting: Device -> + Configuration -> OpenVSwitch + -> Host Interface Caps:
Host Interface Caps @@ -108,9 +110,9 @@ Configuring a physical interface in DPDK mode will require a DPDK-based application (e.g. OVS-DPDK) in order to access and use the interface. An interface set as DPDK can be attached to an OVS-DPDK - bridge. Select the device, then the Configuration option from the top - toolbar: Configuration->OpenVSwitch - ->Host Interfaces-> + bridge. Select the uCPE device, then from the top toolbar select: + Configuration -> OpenVSwitch + -> Host Interfaces -> Add:
@@ -146,10 +148,10 @@ Create an OpenVSwitch bridge (ovsbr0) on the - device that uses a DPDK interface, by selecting the Device, - then the Configuration option from the top toolbar: - Configuration-> OpenVSwitch -> - Bridges -> Add: + device that uses a DPDK interface, by selecting the uCPE device, then + from the top toolbar selecting: Configuration-> + OpenVSwitch -> Bridges -> + Add:
OVS bridge @@ -167,10 +169,10 @@ SR-IOV Interface Type SR-IOV mode will create a number of virtual functions on host that - can be used to route traffic to VMs. Select the device, then the Configuration - option from the top toolbar: Configuration->OpenVSwitch - ->Host Interfaces-> - Add: + can be used to route traffic to VMs. Select the uCPE device, then from + the top toolbar select: Configuration -> + OpenVSwitch -> Host Interfaces + -> Add: For SR-IOV mode, the user must set following fields: @@ -192,12 +194,11 @@ - sriov-num-vfs: the number of virtual functions to create + sriov-num-vfs: the number of virtual functions to + create - -
SR-IOV Interface Type @@ -247,14 +248,13 @@ With the address parameter set, run list_deviceID.sh after NFV Access is installed and - booted, to get the device ID of the target. + booted, to get the device ID of the uCPE device. It is possible to let NFV Access know the uCPE Manager IP address at run-time by setting vcpemgr=<IP> as a kernel boot parameter in the grub configuration file. Reboot is required after - this update. For additional information about grub configuration, please - refer to the Enea NFV Access Reference Guide provided with your release. + this update. This step needs to be done each time the uCPE Manager host changes its IP address. @@ -266,15 +266,15 @@
Adding a Device - The uCPE Manager must be configured to bring the target device - under management. This is done by selecting Device Calls - Home checkbox when adding a device. When Device Calls - Home checkbox is checked, the device will initiate a - connection by opening a socket to the uCPE Manager for NETCONF - traffic (over SSH), while the uCPE Manager waits for device connection. - - For more info about how to add a device please refer to - Manual Configuration. + The uCPE Manager must be configured to bring the uCPE device under + management. This is done by selecting Device Calls + Home checkbox when adding a device. When Device Calls Home + checkbox is checked, the device will initiate a connection by opening a + socket to the uCPE Manager for NETCONF traffic (over SSH), while the + uCPE Manager waits for device connection. + + For more info about how to add a device please refer to Manual Configuration.
@@ -350,7 +350,7 @@ As the acting vnf manager, the uCPE Manager is responsible for handling the life-cycles of VNFs that are instantiated and run on the - various uCPE hosts. The vnf manager module is written so as to be able to + various uCPE devices. The vnf manager module is written so as to be able to manage multiple VNF types. Along with it is provided a generic infrastructure to allow the end-user to introduce new VNF types dynamically into the system. This allows for third-party VNFs to be added @@ -359,8 +359,8 @@ The process of VNF Onboarding consists of providing the system with sufficient information and resources related to the VNF such that it can - instantiate a flavor of the VNF on the target, configure and scale it as - appropriate, heal and upgrade it when necessary and tear it down at the + instantiate a flavor of the VNF on the uCPE device, configure and scale it + as appropriate, heal and upgrade it when necessary and tear it down at the right moment. The vnf manager subsystem in the uCPE Manager inserts a menu item in @@ -391,8 +391,7 @@ Instances: Choosing this option lets you - instantiate (or destroy) VNFs on a given uCPE host (the - target). + instantiate (or destroy) VNFs on a given uCPE device. @@ -492,13 +491,22 @@ using the Onboarding Wizard + + Select the uCPE Device. + + + + Select from the top toolbar VNF -> + Descriptors + + Click the On-board button. - When prompted by the following UI, make sure the - VM Image radio button is selected. + When prompted by the following UI, make sure the VM + Image radio button is selected. @@ -697,7 +705,7 @@ Instantiating a VNF Once the VNF bundle has been onboarded, you can instantiate a VNF - on a specific uCPE host. + on a specific uCPE device. Launch the VNF instance table by choosing the Instances option from the VNF @@ -737,10 +745,9 @@ - VIM. This stands for - Virtual Infrastructure Manager, the target host - on which to instantiate a VNF, i.e. the target uCPE host that will - run this VNF. + VIM. The uCPE device on which + to instantiate a VNF, i.e. the uCPE device that will run this + VNF. @@ -763,20 +770,20 @@ Hitting the Create button will cause the VNF to - be instantiated and run on the uCPE target specified above. The + be instantiated and run on the uCPE device specified above. The following operations will now take place: - Check if the uCPE already has the VNF Flavor definition in its + Check if the uCPE device already has the VNF Flavor definition in its flavor store; if not create a new Flavor definition on the - uCPE. + uCPE device. - Check if the uCPE already has the VNF image in its image + Check if the uCPE device already has the VNF image in its image store; if not, upload the image and create a new Image definition on - the uCPE. + the uCPE device. 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 b3f7645..9b28c88 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 @@ -1,24 +1,24 @@ - + Getting Started with Enea NFV Access
- Enea NFV Access Installer + Enea NFV Access Run Time Platform Installer The current release supports one primary method of installation, using the installer, which guarantees a clean installation of NFV Access - on a device. + on a uCPE device.
Prerequisites - To install the Enea NFV Access platform, 3 things are required: a - USB stick (16GB or larger), a development machine with root - permissions(Linux or Windows) and a target device. + To install the Enea NFV Access Run Time Platform, 3 things are + required: a USB stick (16GB or larger), a development machine with root + permissions (Linux or Windows) and a uCPE device. - Minimal requirements for NFV Access: + Minimal requirements for the uCPE device: @@ -45,7 +45,6 @@ Following BIOS settings to be enabled: - EFI @@ -67,8 +66,8 @@
Installer Setup and Usage for a manual installation - To install Enea NFV Access on a physical - drive + To install Enea NFV Access Run Time Platform + on a physical drive @@ -192,15 +191,16 @@ rootfs_destination= After using the installer and setting up the bootable media, - connect it to the target machine and configure the target machine to use - it as a primary boot device. + connect it to the uCPE device and configure the uCPE device to use it as + a primary boot device.
Creating a bootable USB stick - In order to install Enea NFV Access, you must first create a - bootable USB stick with the image you intend to install. + In order to install Enea NFV Access Run Time Platform, you must + first create a bootable USB stick with the image you intend to + install. Create a bootable USB stick image @@ -221,13 +221,12 @@ sdb 8:0 0 111.8G 0 disk - Copy the HDDIMG image to the USB stick, e.g:sudo dd if=./enea-nfv-access-<target>.hddimg \ + Copy the HDDIMG image to the USB stick, e.g:sudo dd if=./enea-nfv-access-<machine>.hddimg \ of=/dev/sdb bs=4M conv=fsync - Where - enea-nfv-access-<target>.hddimg + Where enea-nfv-access-<machine>.hddimg is the .hddimg file and sdb is the assigned USB device name.
@@ -235,57 +234,43 @@ of=/dev/sdb bs=4M conv=fsync
Installing Enea NFV Access - How to install Enea NFV Access using a - bootable USB stick image + How to install Enea NFV Access Run Time + Platform using a bootable USB stick image + - Plug the USB stick into the reference board. Make sure you are - connected to the serial port. + Plug the USB stick into the reference uCPE device. Make sure + you are connected to the serial port. - Power up the board and boot the USB stick. Verify the USB - stick is selected from the BIOS boot menu. + Power up the uCPE device and boot the USB stick. Verify the + USB stick is selected from the BIOS boot menu. Once the USB stick is properly booted, a GRUB menu appears on the serial console. The following options are available: - + - live-boot. Boots NFV Access directly from the USB - stick. + live-boot. Boots NFV Access Run Time Platform directly + from the USB stick. - installer. Launches the NFV Access installer and uses the - serial port for output. + installer. Launches the NFV Access Run Time Platform + installer and uses the serial port for output. The graphical console requires that a display is connected - to the board. + to the uCPE device. - - To launch the installer, select the installer - option from the GRUB menu: - - - - Install NFV Access. - - - - Reboot. - - - - Select Install NFV Access from the menu to proceed with the installation. @@ -299,14 +284,15 @@ of=/dev/sdb bs=4M conv=fsync Automatic install. This option will partition a user-defined drive and install NFV - Access. You can create 2 or 4 partitions, and choosing either of - these two options will prompt you for a drive on which to - install NFV Access. The 2-partition scheme divides the disk into - one GPT partition containing the GRUB binary and configuration, - leaving the rest of the disk for the root filesystem. The - 4-partition scheme creates: a GPT partition for GRUB (similar to - the one in the 2-partition scheme), two 20 GB partitions, and - one containing the remaining free disk space. + Access Run Time Platform. You can create 2 or 4 partitions, and + choosing either of these two options will prompt you for a drive + on which to install NFV Access Run Time Platform. The + 2-partition scheme divides the disk into one GPT partition + containing the GRUB binary and configuration, leaving the rest + of the disk for the root filesystem. The 4-partition scheme + creates: a GPT partition for GRUB (similar to the one in the + 2-partition scheme), two 20 GB partitions, and one containing + the remaining free disk space. After choosing the Automatic install option and one of the predefined partitioning actions, the install @@ -332,7 +318,7 @@ of=/dev/sdb bs=4M conv=fsync Default Parameters: - + Core isolation. Isolates the selected range of cores from the kernel scheduler. @@ -382,7 +368,7 @@ of=/dev/sdb bs=4M conv=fsync At the end of the installation process, you can choose between - running the installer again or rebooting the board. + running the installer again or rebooting the uCPE device. The boot log will always be displayed on the serial port. @@ -397,8 +383,8 @@ of=/dev/sdb bs=4M conv=fsync Booting NFV Access After installing Enea NFV Access on a media storage device (e.g. - eMMC, HDD or SSD), the target must be reset so that Enea NFV Access can - boot. The user must configure the first stage bootloader (e.g. + eMMC, HDD or SSD), the uCPE device must be reset so that Enea NFV Access + can boot. The user must configure the first stage bootloader (e.g. BIOS/UEFI) to boot the system from the media storage device where NFV Access was installed. @@ -474,7 +460,7 @@ run Workaround: If both a USB stick with the Enea NFV Access installer set up (e.g FS0) and an another media storage device (e.g. FS1), are - connected to a target machine, in order to select the former, the count + connected to a uCPE device, in order to select the former, the count down must be stopped with the default startup.nsh script by pressing ESC and then starting GRUB manually: @@ -506,8 +492,8 @@ run If a system has an amount of memory up to 8GB, the allocation - algorithm will reserve up to 30%, but no more than 2GB, for the OS - and rest as 2MB hugepages. + algorithm will reserve up to 30%, but no more than 2GB, for the OS and + the rest as 2MB hugepages. @@ -589,7 +575,7 @@ run 16GB of memory: approximately 2GB will be allocated for the OS - and the rest as 1GB hugepages. + and the rest as 1GB hugepages. @@ -677,7 +663,7 @@ node0.1048576kB = 3 /* self-extracting archive installing cross-compilation toolchain for the guest (QEMU x86-64) */ - For each combination of image and target, the following set of + For each combination of image and uCPE device, the following set of artifacts is available: -- bzImage diff --git a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml index c31cea3..6f5cdb1 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml @@ -7,8 +7,8 @@ In-band Management refers to a model where both the data plane and control plane flow over the same network path. - In some situations, In-Band Management is the only option available to - both control and configure the device, while also allowing for data-path + In some situations, In-band Management is the only option available to + both control and configure the uCPE device, while also allowing for data-path traffic to pass over the same physical interface. The main requirement for this use case solution is to have all traffic @@ -50,7 +50,7 @@ All network traffic, with the exception of any received from the uCPE Manager, will be sent towards the VNF or dropped if there is no VNF - instantiated on the NFV Access device. The VNF connected to the WAN bridge + instantiated on the uCPE device. The VNF connected to the WAN bridge must be configured for In-band management since traffic from the VNF manager and data-path will be sent to only to one port (WAN) of the VNF. @@ -83,7 +83,7 @@ uCPE Manager - uCPE Manager IP address must be public (accessible for target) + uCPE Manager IP address must be public (accessible for the uCPE device) and static @@ -95,7 +95,7 @@ - Select the device. + Select the uCPE device. @@ -147,11 +147,11 @@ - The connection between the device and uCPE Manager will be recreated + The connection between the uCPE device and uCPE Manager will be recreated and all traffic will pass through the new bridge (ibm-wan-br). The user should be able to continue device configuration. The WAN port of the very first instantiated VNF must be connected to ibm-wan-br and it should receive - the same IP address as the WAN interfaces of the device. + the same IP address as the WAN interfaces of the uCPE device.
Enea In-band Management solution @@ -164,7 +164,7 @@
- The VNF can be reached on the same IP address as the device, e.g. + The VNF can be reached on the same IP address as the uCPE device, e.g. https://<WAN_IP> if a HTTP server is present on that VNF. diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml index bdaa534..e2e9802 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml @@ -21,7 +21,7 @@ - The Enea NFV Access runtime platform, which acts as the host for + The Enea NFV Access Run Time Platform, which acts as the host for Virtualized Network Functions (VNFs) and provides management over NETCONF. @@ -34,9 +34,9 @@
- Enea NFV Access runtime platform + Enea NFV Access Run Time Platform - Enea NFV Access runtime platform is a lightweight, + Enea NFV Access Run Time Platform is a lightweight, multi-architecture virtualization platform, supporting Virtual Machines (KVM / QEMU) and container(s) (Docker). Designed for a low footprint and fast boot by only providing essential functionality. -- cgit v1.2.3-54-g00ecf