From 79b10d0dd06d511d87130385cdafe3e7cd945c27 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Mon, 16 Sep 2019 13:27:37 +0200 Subject: GettingStarted: move ch 2 & 3 from VNF Onboarding - Move ch 2 & ch 3 from VNF Onboarding Guide to the Getting Started chapter 4.4 VNF Management - Update the doc version to 2.2.1 Change-Id: I19353d7d70b526652b5867d0e7abe04d0edb3e18 Signed-off-by: Sona Sarmadi --- .../doc/eltf_params_updated.xml | 2 +- .../doc/getting_started_ucpe_manager.xml | 319 ++++++++++++++++++++- 2 files changed, 314 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml index 0386515..7fe09ec 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml @@ -42,7 +42,7 @@ export PATH=~/bin:$PATH correct also compared to the "previous" REL VER in pardoc-distro.xml "prev_baseline". - 2.2 + 2.2.1 2.4 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 80595e6..afb6ee3 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 @@ -130,7 +130,7 @@ Device Calls Home. This checkbox indicates the direction of device communications. In the Manual Configuration, leave this box - blank. + blank. @@ -150,9 +150,9 @@ The uCPE Manager must be configured to bring the uCPE device under management. This is done by selecting the Device Calls Home checkbox when adding a device. When Device Calls Home - 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. + 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. @@ -468,7 +468,7 @@
- Onboarding a VNF + Onboarding a VNF (old) The VNF descriptor catalog table provides a button that allows you to onboard a new (third-party) VNF into the catalog. @@ -724,8 +724,184 @@
+
+ Onboarding a VNF (copied from VNF Onboarding Guide) + + The onboarding of a VNF means adding it to the Enea uCPE Manager + VNF Catalog and preparing it for instantiation (deployment on connected + uCPE devices). This is accomplished using the Enea uCPE Manager + Onboarding Wizard, a graphical user interface specifically designed to + make VNF onboarding simple and fast. + + Typically, the VNF's Getting Started Guide contains all necessary + information needed to onboard a VNF using the Onboarding Wizard. This + present guide however, provides a number of examples of how to onboard + specific commercial VNFs. + + The following sections detail the basic steps needed to + successfully onboard a VNF in the Enea uCPE Manager. + +
+ Retrieving Artifacts + + The user must first retrieve the necessary artifacts from the + VNF vendor: + + + + Download the VNF from the commercial vendor. + + + + Get any VNF specific license from the VNF vendor. + + + There are no standard ways of managing VNF licenses, + therefore no general guidelines can be provided. One example of + license handling that can be employed in the uCPE Manager is the + adding of a license during the Cloud-Init setup. The ConfigDrive + value is provided in the Fortios specific guidelines. + + + + + Get access to the VNF specific VNF Manager for day 1 and 2 + configuration (in cloud or for local deployment). + + + + Procure the Getting Started Guide from the VNF vendor, + preferably for KVM deployment for VNF specific configuration + information. + + +
+ +
+ Preparation + + Once all needed downloadables, documentation and more have been + attained, preparation for onboarding must be completed: + + + + Determine the use-case and performance requirements of the + VNF you wish to deploy. + + + + This decides what resources the VNF is configured for, + along with networking and day zero configurations. + + Generally, the Getting Started Guide for the VNF + provides guidelines for resource allocation, but since + performance is dependent on hardware capacity, the right + resource allocation for deployment is typically determined + through benchmarking. + + + + Determine the amount of hardware resources needed for + the VNF (RAM, CPUs and Disk size). + + + + Determine how many Network Interfaces the VNF shall + use. + + + + + + Determine the day zero configuration method from the VNF + Getting Started guidelines. + + + For many VNFs, day zero configuration can be skipped in + early onboarding efforts when automation is not of + importance. + + + + + Determine any requirements needed by the Cloud-Init file + structure and the content needed for the VNF when Cloud-Init is + used. + + +
+ +
+ Onboarding the VNF + + + + Enter the Enea uCPE Manager and choose VNF->Descriptors + in the GUI. + + + + Click Onboard to start the onboarding + procedure. + + + + Fill in all mandatory fields in the popup menu: Name, Image, + RAM, CPUs, Disk. + + + + Define the VNF's Network Interfaces and give them + descriptive names. + + + + Configure the Cloud-Init settings, starting with the + Datasource: + + + + Choose None if Cloud-Init is not + used. + + + + Choose ConfigDrive, + NoCloud or ISO depending + on the VNF specific Cloud-Init implementation. + + + + Choose the Cloud-Init mount method based on the VNF + specific Cloud-Init implementation. + + + + Configure any VNF specific Cloud-Init files according to + VNF specific documentation. + + + + + + Additional Properties (in the Properties Tab) are typically + not needed and can be ignored. + + + + Click Onboard to add the VNF to the Enea + uCPE Manager VNF Catalog. + + + + When the onboarding is complete, the VNF will appear in the VNF + Catalog and can be used for deploying services on the uCPE + devices. +
+
+
- Instantiating a VNF + Instantiating a VNF (old) Once the VNF has been onboarded, you can instantiate a VNF on a specific uCPE device. @@ -823,5 +999,136 @@
+ +
+ Instantiating a VNF (copied from VNF Onboarding Guide) + + When a VNF is onboarded and available in the VNF catalog, it can + be instantiated (deployed) on connected uCPE devices. The instantiation + wizard uses the configurations provided when the VNF is onboarded, as a + template for instantiation. Before the instantiation, however, the uCPE + device needs to be prepared: + + + + Physical NICs used with the VNF directly (through SR-IOV or + PCI Passthrough) or indirectly (through bridges) need to be + configured (Device->Configuration->OpenVSwitch->Host + Interfaces). + + + Before configuring any physical NICs determine which is used + for managing the uCPE device. Altering the configuration of a NIC + may cause connectivity issues. + + + + + Add any needed bridges, connecting them to the physical NICs + previously configured or making them integration bridges (without + physical NIC) for service chaining. + + + + Once the physical NICs and bridges are configured, the VNF can be + instantiated using the Instantiation Wizard. + +
+ Using the Instantiation Wizard + + + + Enter the Instantiation Wizard by accessing + VNF->Instances and hitting Add. + + + + Fill out the following mandatory fields: + + + + Name (a descriptive name). + + + + Device (the uCPE device to instantiate the VNF + on). + + + + Networking Configuration: + + + + Connect each configured NIC with a bridge, SR-IOV or + PCI Passthrough. + + + + Set up each NIC with a driver method (DPDK or + e1000). + + + + + All configured NICs must be set up before + instantiating a VNF. Failure to do so will end in a failed + instantiation. + + + + + + + Add VNF specific configuration by uploading a Cloud-Init + file (when the Cloud-Init is used). + + + + Add any VNF specific files (e.g license files). + + + + Hit the Create button to deploy the + VNF. + + +
+ +
+ Entering the VNF Console + + Once the VNF is deployed, the VNF console can be entered using + SSH and virsh commands. The VNF Console is a typical starting point + for determining a successful deployment and configuring a VNF beyond + Day Zero. + + + + SSH to the uCPE device from the Enea uCPE Manager + (Device->SSH) with default user and password: + root. + + + + In SSH: + + + + Use the virsh list command to list + all running VNFs and to determine the VNF's instance + number. + + + + Use the virsh console <instance + number> command to enter the VNF specific + console. + + + + +
+
-- cgit v1.2.3-54-g00ecf