From 797fbe8b8565fce92c266a09538ddff3bf08deb6 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Fri, 1 Mar 2019 09:56:24 +0100 Subject: GettingStarted: fix some typo - Rephrase some texts. - add a picure for Grub menu options - When adding a device (sec 6.4.1) the password should be blank when "Device Calls Home" is selected. Make the password filed in the picture blank - enumerate the fields in the order in which they appear in the picture Change-Id: I75ce70666ca2ee6ca7cf42f52ff25fd6df8ff8b4 Signed-off-by: Sona Sarmadi --- .../doc/device_configuration_and_provisioning.xml | 191 +++++++++++---------- .../doc/getting_started_nfv_access.xml | 58 +++---- .../doc/images/add_a_device.png | Bin 28716 -> 28786 bytes .../doc/images/grub_menu_options.png | Bin 0 -> 7877 bytes .../doc/in_band_management.xml | 8 +- 5 files changed, 131 insertions(+), 126 deletions(-) create mode 100755 doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png (limited to 'doc/book-enea-nfv-access-getting-started') 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 d0e25b5..255cfbe 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 @@ -311,13 +311,13 @@ When prompted by the following UI, make sure the - VNF Package radio button is selected. + VNF Package radio button is selected. - Click Choose File and choose the VNF + Click Choose File and choose the VNF Package ZIP archive, e.g VProbe.zip, which - represents the VNF bundle. + represents the VNF bundle. @@ -402,7 +402,7 @@ Memory in MB. This is the - amount of memory (in Megabytes) that will be provided to this type + amount of memory (in megabytes) that will be provided to this type of VNF when it is instantiated. To determine the value for this field, consult the VNF vendor. @@ -435,7 +435,7 @@ Click on the Interfaces tab to show the - Interfaces table. + Interfaces table. This table will contain the interfaces required by this VNF to be configured, when creating an instance. Consult the VNF vendor to @@ -445,8 +445,8 @@ Cloud-Init Tab - You must provide Clout-Init configuration for the VNF. Click the - Clout Init tab. + Click the Clout Init tab to provide the + Clout-Init configuration.
Cloud-Init Tab @@ -459,36 +459,42 @@
- Shown in the picture above are three fields that need to be populated: - Cloud-Init Datasource, Cloud-Init Disk Type and the Content Files Table. - - To onboard the VNF you must specify the Cloud-Init datasource that the VNF - uses. You can get this information from the VNF Vendor. Choose one of the following - methods to specify the datasource: - - - - ConfigDrive. This method allows you to provide - any number of content-data files containing Cloud-Init data. - - - NoCloud. This is a simpler method that uses only - one cloud init file (User-Data). - - - The Cloud-Init Disk Type field must be set to either Disk, - or CD ROM, depending on what the VNF requires. You can get this - information from the VNF Vendor. - - The Content Files Table is used ONLY if you chose ConfigDrive - as the Cloud-Init Datasource. For each content file added, you must provide a - Path. When a user uses the uCPE Manager to create an instance - of one of these VNFs, they will be prompted to provide a data file for each entry - in this table. Each type of VNF will require different cloud-init files, e.g.: - a license file. - - Consult with the VNF vendor to determine what is required for the VNF you - are onboarding. + As shown in the picture above, there are three fields that need + to be populated: Cloud-Init Datasource, Cloud-Init Disk Type and the + Content Files Table. + + To onboard the VNF you must specify the Cloud-Init datasource + that the VNF uses. You can get this information from the VNF Vendor. + Choose one of the following methods to specify the datasource: + + + + ConfigDrive. This method + allows you to provide any number of content-data files containing + Cloud-Init data. + + + + NoCloud. This is a simpler + method that uses only one cloud init file (User-Data). + + + + The Cloud-Init Disk Type field must be set to either + Disk, or CD-ROM, depending on + what the VNF requires. You can get this information from the VNF + Vendor. + + The Content Files Table is used ONLY if you chose + ConfigDrive as the Cloud-Init Datasource. For each + content file added, you must provide a Path. When a + user uses the uCPE Manager to create an instance of one of these VNFs, + they will be prompted to provide a data file for each entry in this + table. Each type of VNF will require different cloud-init files, e.g.: + a license file. + + Consult with the VNF vendor to determine what is required for + the VNF you are onboarding.
Content Files Table example @@ -504,13 +510,12 @@ Properties Tab In this table, you can enter values for properties that will be - used during instantiation of the VNF. The values will augment the default - values in the Domain.XML file used by libvert/virsh (running in NFV Access) - when creating an instance of the VNF. - These property names are well known to the uCPE NFV Access - software, and more will be added in future versions. You will need to - consult with the VNF Vendor or ENEA support for values needed by - specific VNFs. + used during instantiation of the VNF. The values will augment the + default values in the Domain.XML file used by libvirt/virsh (running + in NFV Access) when creating an instance of the VNF. These property + names are well known to the uCPE NFV Access software, and more will be + added in future versions. You will need to consult with the VNF Vendor + or ENEA support for values needed by specific VNFs.
Properties Tab @@ -526,21 +531,21 @@ Property Values numHugePages defines the number of huge - memory pages the VNF uses (for DPDK). Needed for Clavister COS - Stream. + memory pages the VNF uses (for DPDK).
Instantiating a VNF - Once the VNF bundle has been onboarded, you can instantiate a - VNF on a specific uCPE host: + Once the VNF bundle has been onboarded, you can instantiate a VNF + on a specific uCPE host: - Launch the VNF instance table by choosing the - Instances option from the VNF menu. - This will display the table of VNF instances controlled by the VNF Manager. - Hit the Add button to create a new instance, as shown below: + Launch the VNF instance table by choosing the + Instances option from the VNF + menu. This will display the table of VNF instances controlled by the VNF + Manager. Hit the Add button to create a new + instance:
Instantiating a VNF @@ -558,33 +563,34 @@ - VNF Type. The - VProbe VNF, in this case. + Name. The name of the + VNF. - 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. - + VNF Type. The name of the + on-boarded VNF bundle. In this case VProbe + VNF. - Name. The name of the - VNF. + Flavor. The flavor of VNF (as + specified in the descriptor) you would like to instantiate. - VNF Flavor. The flavor of VNF - (as specified in the descriptor) you would like to - instantiate. + 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. Device Name. The name by - which the VNF will be known in the uCPE Manager, if the Manage - Device checkbox is checked. If unchecked, the VNF will not - be shown as a managed device in the uCPE Manager. + which the VNF will be known in the uCPE Manager, if the + Manage Device checkbox is checked. If unchecked, + the VNF will not be shown as a managed device in the uCPE + Manager. @@ -595,17 +601,17 @@ for two separate interfaces (enp0s9 and enp0s10 respectively). Every VNF type will have a different UI section here. This section is populated by the getInstanceGui() method in the - VnfGuiProcessorIf - interface, see Section 6.1 to understand exactly how the VProbe - method causes the above GUI section to be displayed. + VnfGuiProcessorIf interface, see Section 6.1 to + understand exactly how the VProbe method causes the above GUI + section to be displayed. Auto-start. If checked, the VNF will be stopped and started when unreachable. When the VIM - reports that it has lost connection to the VNF, the uCPE Manager will - ask the VIM to terminate the VM and then start it up again. - If unchecked, only a Disconnected notification will + reports that it has lost connection to the VNF, the uCPE Manager + will ask the VIM to terminate the VM and then start it up again. If + unchecked, only a Disconnected notification will appear in the uCPE Manager. @@ -632,36 +638,35 @@ - Networking information. - Use the VnfGuiProcessorIf - class getConnectionInfo() method to - convert user parameters into networking information objects - (refer to Section 6.1 for the VProbe - VNF). + Networking information. + Use the VnfGuiProcessorIf class + getConnectionInfo() method to convert user parameters + into networking information objects (refer to Section 6.1 for + the VProbe VNF). - Cloud-init. - Use generic VNF instance information in - conjunction with the networking information objects from - above and invoke the getCloudInitData() method on the - VnfProcessorIf class (refer to Section 6.2 for how this is done - for the VProbe VNF). The cloud-init data is - the script that will be executed by the VNF when it starts up - for the first time only. It is responsible for setting up the - initial system configuration to what is required by the VNF to - run correctly, setting up the network interfaces, static IP - addresses, etc. + Cloud-init. Use generic + VNF instance information in conjunction with the networking + information objects from above and invoke the + getCloudInitData() method on the + VnfProcessorIf class (refer to Section 6.2 + for how this is done for the VProbe VNF). The + cloud-init data is the script that will be executed by the VNF + when it starts up for the first time only. It is responsible for + setting up the initial system configuration to what is required + by the VNF to run correctly, setting up the network interfaces, + static IP addresses, etc. - Make the uCPE create the VNF with the specified image, - flavor and cloud-init data via a NETCONF request and waits for it to - be created and started up. + Make the uCPE create the VNF with the specified image, flavor + and cloud-init data via a NETCONF request and wait for the VNF to be + created and booted up. @@ -723,7 +728,7 @@ this update. This step needs to be done each time the uCPE Manager host changes - the IP address. + its IP address. An offline configuration can be prepared in advance for the uCPE 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 9e574f6..748ef5c 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 @@ -261,51 +261,47 @@ sdb 8:0 0 111.8G 0 disk Power up the board and boot the USB stick. Verify the USB - stick is selected from BIOS boot menu. + 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: - - Using the serial - console: - - - live-boot serial. Boots NFV Access directly from the USB - stick. - +
+ Installing NFV Access - - installer serial. Launches NFV Access. - - + + + + + +
- Using the graphics - console: - - live-boot graphical. Boots NFV Access directly from the - USB stick. + live-boot. Boots NFV Access directly from the USB stick. A + use case of the live-boot option is to troubleshoot networking + and boot on a new hardware. - installer graphical. Launches NFV Access. + installer. Launches the NFV Access installer and uses the + serial port for output. - A use case of the live-boot is to troubleshoot networking - and boot on a new hardware. + The graphical console requires that a display is connected + to the board. - To launch the installer, select installer - from the GRUB menu. An installation menu will appear, containing the - following options: + To launch the installer, select one of the + installer options below from the GRUB + menu: @@ -443,7 +439,7 @@ sdb 8:0 0 111.8G 0 disk - +
@@ -612,7 +608,7 @@ run 2GB of memory: approximately 30% will be allocated for the OS - and the rest will be allocated as 2MB hugepages. + and the rest will be allocated as 2MB hugepages. @@ -621,11 +617,15 @@ run - 16GB of memory: 2GB allocated for OS and the rest as 1GB Hugepages. + 16GB of memory: 2GB allocated for OS and the rest as 1GB + Hugepages. - The memory allocated for the kernel and hugepages might - vary slightly depending on how much memory is available. + + + The memory allocated for the kernel and hugepages might vary + slightly depending on how much memory is available. +
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png b/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png index cb240b6..8368e61 100755 Binary files a/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png and b/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png differ diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png b/doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png new file mode 100755 index 0000000..0ebf5f0 Binary files /dev/null and b/doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png differ 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 da6b2ee..0173ce6 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 @@ -4,9 +4,8 @@ In-band Management - In-band Management refers to administrative access to systems and - network devices, over the same network used by the traffic being - filtered. + 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 @@ -183,7 +182,8 @@
The VNF can be reached on the same IP address as the device, e.g. - https://<WAN_IP>. + https://<WAN_IP> if a HTTP server is present + on that VNF. The In-band management bridge must be recreated each time the uCPE -- cgit v1.2.3-54-g00ecf