From cee51d7325df5826cb5ae7f330f60b45acbd47fb Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Tue, 10 Sep 2019 13:04:46 +0200 Subject: GettingStarted: fix the new structure Fix the new structure according the review meeting comments: 1. Intro 2. Definition + Acro 3. Getting started with ENA 4. Getting started with uCPE Manager 4.1 Prerequisites 4.2 Install the Enea uCPE Manager 4.3 Device Configuration and Provisioning 4.4 VNF Management 5. Secure Boot 6. Bare Metal Provisioning 7. In-Band Management Change-Id: I1a571db07f32430609d1a167a1bd41cdbd2eb322 Signed-off-by: Sona Sarmadi --- .../doc/book.xml | 13 +- .../doc/device_configuration_and_provisioning.xml | 765 -------------------- .../doc/getting_started_ucpe_manager.xml | 772 ++++++++++++++++++++- 3 files changed, 773 insertions(+), 777 deletions(-) delete mode 100644 doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.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 abce2c2..9289fe8 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/book.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml @@ -23,18 +23,15 @@ - - - - - - + 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 deleted file mode 100644 index a1ebf64..0000000 --- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml +++ /dev/null @@ -1,765 +0,0 @@ - - - Device Configuration and Provisioning - -
- Manual Configuration - - This section describes how to connect to an instance of NFV Access - installed on a specific uCPE device, and how to setup the virtual - infrastructure manually. - - How to add a uCPE device to the management - system - - Add the uCPE device running the NFV Access Run Time Platform to the - management system: Devices -> Manage -> Add. Supply - information about the uCPE device, and set the parameters that will be used - to connect to it. - - The relevant parameters are: - - - - Type. The type of device to be added, i.e Enea - universal uCPE. - - - - - - Name. The name by which the device is referred to in the uCPE - Manager. - - - - - - IP Address. IP address of the device. If a device is installed - under a local/private network and not directly visible to the uCPE - Manager machine, the Gateway IP of the private network must be - used. - - - - - - SSH Port. The NETCONF Port used for communications. This is a - relevant parameter if the standard NETCONF SSH (i.e. not Call-Home) is - being used. Default is set to 830. - - - - - - SSH User Name. The user name for SSH connectivity. Default user - is root. - - - - - - SSH Password. Leave this blank. - - - - - - 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. - - - - - - Device ID. The unique instance ID of the device. This is what - links a device to its day-0 configuration (stored in the offline - configuration system). It is a required field if you want to perform - Zero-Touch Provisioning. - - -
- -
- Host Interfaces and Network Configuration - - The uCPE Manager can list network interfaces found on a device by - selecting: Device -> - Configuration -> OpenVSwitch - -> Host Interface Caps: - -
- Host Interface Caps - - - - - - -
- - Network interfaces can be set in three modes: DPDK, SR-IOV and - PCI-Passthrough. - -
- DPDK Interface Type - - 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 uCPE device, then from the top toolbar select: - Configuration -> OpenVSwitch - -> Host Interfaces -> - Add: - -
- DPDK Host Interface - - - - - - -
- - For DPDK mode, the user must set following fields: - - - - Source: PCI address of the physical interface - - - - Type: dpdk - - - - Networking-type: dpdk - - - - Dpdk-type: kernel module that allow user space access of - physical interface - - - - Create an OpenVSwitch bridge (ovsbr0) on the - device that uses a DPDK interface, by selecting the uCPE device, then - from the top toolbar selecting: Configuration-> - OpenVSwitch -> Bridges -> - Add: - -
- OVS bridge - - - - - - -
-
- -
- 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 uCPE device, then from - the top toolbar select: Configuration -> - OpenVSwitch -> Host Interfaces - -> Add: - - For SR-IOV mode, the user must set following fields: - - - - Source: PCI address of the physical interface - - - - Type: sr-iov - - - - Networking-type: srIov - - - - sriov-mode: adapter-pool - - - - sriov-num-vfs: the number of virtual functions to - create - - - -
- SR-IOV Interface Type - - - - - - -
-
- -
- PCI Passthrough Interface Type - - For PCI Passthrough the user does not have to configure a physical - interface, instead simply select the PCI address and connect it to a - virtual port at the VNF instantiation step. -
-
- -
- Zero Touch Provisioning - - Zero-Touch Provisioning (ZTP) is an alternative to Manual - configuration. ZTP refers to the process by which, when a device starts up - for the first time, its initial configuration is pushed down by an - external management system, so that it is setup for proper operation - without additional manual intervention by an operator. - - A variety of operations can occur as part of ZTP such as initial - device setup, configuration of managed objects, etc. The goal is to set up - a device to the maximum possible extent without forcing an operator to be - physically present (initially) to manage the device. - - In order to create a static configuration supporting ZTP, the uCPE - Manager user needs to identify the Device ID of the - machine running NFV Access. - - During the automatic installation process when the - Automatic install step is reached, enter the option - menu Customize kernel parameters and set the - uCPE Manager IP address. Please check , for how to set the uCPE Manager IP address - at boot time. The Device ID will be listed in the installer under the - Customize kernel parameters menu. - - With the address parameter set, run - list_deviceID.sh after NFV Access is installed and - 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. - - This step needs to be done each time the uCPE Manager host changes - its IP address. - - - An offline configuration can be prepared in advance for the uCPE - Manager to setup the infrastructure on the device. - -
- Adding a Device - - 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. -
- -
- Offline Configuration - - The Offline Configuration subsystem is used to pre-populate a - configuration for a device that will be brought under management at a - future point in time. When creating an offline configuration store, an - optional Device ID can be specified - this ID - uniquely identifies the device to be initialized. - - Use the GUI (shown below) launched by the Applications - -> Offline Config -> Add menu: - -
- Onboard New VNF - - - - - - -
- - Specify the exact value of the Device ID in the - required field. This will tag the device needed for the initial - configuration provided by the offline configuration store. Choose - Merge as the Default Upload Method if you do not want - any boot configuration set on the device, to be wiped out. Selecting - Replace will set the entire device configuration to - match values in the offline configuration. - - After creating the Offline Config Store, access the device through - Applications -> offline config -> Config App - and provision it with the required initial configuration. This operation - mirrors what happens during regular offline configuration. - - Now that the store has been provisioned successfully, it is ready - to send this configuration to the device when it first comes - online. -
- -
- Initial Communications - - There are two possible paths to this process, depending upon - whether or not NETCONF Call-Home functionality is used: - - - - If Call-Home is not enabled/supported, the uCPE Manager - creates a SSH session to the device over the port configured through - the Add Device process (default 830). It then - initiates NETCONF communications over this session. - - - - If the device uses Call-Home, it creates a socket connection - to port 4334 on the management system which runs the uCPE Manager. - The uCPE Manager then creates a SSH session over this socket and - initiates NETCONF communications as a client. - - - - Once communications with the device have been established, the - Device Manager will try and connect to it. -
-
- -
- VNF Management - - 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 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 - over time to an existing network infrastructure without having to perform - an expensive upgrade of the vnf manager itself. - - 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 flavour 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 - the toolbar, called VNF as shown in the screen-shot - below. - -
- VNF Management - - - - - - -
- - Selecting this menu item gives you the following options: - - - - Descriptors: Choosing this option lets you - manage the VNF Descriptors catalog. The vnf manager maintains a - catalog of all VNFs that can be instantiated and managed by the - system. Before you can use a new VNF, you need to onboard it into the - catalog. - - - - Instances: Choosing this option lets you - instantiate (or destroy) VNFs on a given uCPE device. - - - - Events: Choosing this option displays all the - events that are related to VNF lifecycle management. Whenever a VNF - state changes (i.e. it is - created/destroyed/stopped/started/paused/resumed), a state change - event is generated in the uCPE Manager. The screen shown when this - option is chosen displays all events in the system, filtered to show - only VNF state change notifications. - - - -
- Onboarding a VNF - - The VNF descriptor catalog table provides a button that allows you - to onboard a new (third-party) VNF into the catalog. - -
- Onboard New VNF - - - - - - -
- -
- Onboarding a VNF VM Image using the Onboarding Wizard - - How to onboard a VNF into the uCPE Manager - using the Onboarding Wizard - - - - Make sure the uCPE device is added and placed on the map in - the uCPE Manager. - - - - 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. - - - - If you click the VM Image radio button at the - top of the onboarding screen, you will get a pop-up containing fields - which you can fill, suppling the necessary information about the VNF. - After providing the information and pressing the onboard button, the - uCPE Manager will create the VNF package and onboard it. - -
- Onboard a VNF using the Wizard - - - - - - -
- - Main fields - - - - VM Image File. This is the - Virtual Machine image file for the VNF itself. Typically, it is a - QCOW image. Press Choose File and select the - image to be uploaded. - - - - Image Format. Select the - format which matches the image file. - - - - VNF Type Name. This is the - name that will be used to identify this VNF. It will be shown in - the VNF tables. - - - - Description. This field - contains any description you want to provide. It is only displayed - in the GUI tables in the uCPE Manager. - - - - Version. This is the - version of the current VNF that you are hosting. It's used to - distinguish this VNF from other versions of the same type. - - - - Memory in MB. This is the - 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. - - - - Num of CPUs. The number of - CPUs that will be dedicated to an instance of this VNF when - created. To determine the value for this field, consult the VNF - vendor. - - - - Storage in GB. How much - disk space to provide an instance of this VNF. To determine the - value for this field, consult the VNF vendor. - - - - Interfaces Tab - -
- Interfaces Table - - - - - - -
- - Click on the Interfaces tab to show the - Interfaces table. - - This table will contain the interfaces required by this VNF to - be configured, when creating an instance. Consult the VNF vendor to - determine which and how many are required. Each interface requires a - name, and optionally a description, used by the uCPE Manager - only. - - Cloud Init Tab - - Click the Clout Init tab to provide the - Clout-Init configuration. - -
- Cloud-Init Tab - - - - - - -
- - As shown in the picture above, there are three fields that need - to be populated: - - - - Cloud-Init - Datasource - - 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: - - - - None. If there is no - 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). - - - - ISO. Pre-cooked - cloud-init image. This image must be created by the user - according to VNF requirements. - - - - - - Cloud-Init Disk Type - - 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. - - - - Content Files Table - - The Content Files Table is ONLY used if - you choose 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. - - - -
- Content Files Table example - - - - - - -
- - Consult with the VNF vendor to determine what is required for - the VNF you are onboarding. - - 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 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 - - - - - - -
- - Property Values - - numHugePages defines the number of huge - memory pages the VNF uses (for DPDK). -
-
- -
- Instantiating a VNF - - Once the VNF has been onboarded, you can instantiate a VNF on a - specific uCPE device. - - How to instantiate a VNF using the - Wizard - - - - Make sure the uCPE device is added and placed on the map in - the uCPE Manager. - - - - Make sure the VNF has been onboarded into the uCPE - Manager. - - - - Select from the top toolbar VNF -> - Instances - - - - Click the Add button. - - - - When prompted by the following UI, fill the required - fields. - - - -
- Instantiating a VNF - - - - - - -
- - There are a number of parameters to be supplied before the VNF can - be instantiated: - - - - Name. The name of the - VNF. - - - - VNF Type. The name of the - onboarded VNF. In this case VProbe VNF. - - - - Flavour. The flavour of VNF - (as specified in the descriptor) you would like to - instantiate. - - - - Device. The uCPE device on which - to instantiate a VNF, i.e. the uCPE device that will run this - VNF. - - - - Auto-start. If checked, the - VNF will be stopped and started when unreachable. When the uCPE Device reports that it has lost connection to the VNF, the uCPE Manager - will ask it to terminate the VM and then start it up again. If - unchecked, only a Disconnected notification will - appear in the uCPE Manager. - - - - Hitting the Create button will cause the VNF to - be instantiated and run on the specified uCPE device. - - Selecting the VNF -> Events menu will show - that the VNF was created and a connection was established: - -
- VNF Events menu - - - - - - -
-
-
- 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 2704fc8..80595e6 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 @@ -1,5 +1,5 @@ - + Getting Started with Enea uCPE Manager
@@ -25,7 +25,7 @@ Unpack the uCPE Manager and install it by following the instructions provided within the release archive: - [unpacked_folder]/dist/README. + [unpacked_folder]/dist/README. There are a few things to consider during the installation phase, as there are a few steps where user input is required. In most cases, the @@ -35,8 +35,9 @@ defaults to Y), and not the machine as part of a cluster (which defaults to N). Installing on a Windows machine, will require the user to follow the Windows password policies when defining the password for the ucpemanager service. A good example for an acceptable - password would be:_1ucpe#2manager!3_. + role="bold">ucpemanager service. A good example for an + acceptable password would + be:_1ucpe#2manager!3_. Check that the Windows or CentOS machine where the uCPE Manager is installed has the firewall disabled. To disable the firewall, if using @@ -60,4 +61,767 @@
+ +
+ Device Configuration and Provisioning + +
+ Add a uCPE device to the Management System + + This section describes how to connect to an instance of NFV Access + installed on a specific uCPE device, and how to setup the virtual + infrastructure. + +
+ Manual Addition + + Add the uCPE device running the NFV Access Run Time Platform to + the management system: Devices -> Manage -> + Add. Supply information about the uCPE device, and set the + parameters that will be used to connect to it. + + The relevant parameters are: + + + + Type. The type of device to be added, i.e Enea + universal uCPE. + + + + + + Name. The name by which the device is referred to in the + uCPE Manager. + + + + + + IP Address. IP address of the device. If a device is + installed under a local/private network and not directly visible + to the uCPE Manager machine, the Gateway IP of the private network + must be used. + + + + + + SSH Port. The NETCONF Port used for communications. This is + a relevant parameter if the standard NETCONF SSH (i.e. not + Call-Home) is being used. Default is set to 830. + + + + + + SSH User Name. The user name for SSH connectivity. Default + user is root. + + + + + + SSH Password. Leave this blank. + + + + + + Device Calls Home. This checkbox indicates the direction of + device communications. In the Manual Configuration, leave this box + blank. + + + + + + Device ID. The unique instance ID of the device. This is + what links a device to its day-0 configuration (stored in the + offline configuration system). It is a required field if you want + to perform Zero-Touch Provisioning. + + +
+ +
+ Using Call-Home + + 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. +
+
+ +
+ Prepare uCPE device for VNF onboarding + + The uCPE Manager can list network interfaces found on a device by + selecting: Device -> + Configuration -> OpenVSwitch + -> Host Interface Caps: + +
+ Host Interface Caps + + + + + + +
+ + Network interfaces can be set in three modes: DPDK, SR-IOV and + PCI-Passthrough. + +
+ DPDK Interface Type + + 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 uCPE device, then from the top toolbar select: + Configuration -> OpenVSwitch + -> Host Interfaces -> + Add: + +
+ DPDK Host Interface + + + + + + +
+ + For DPDK mode, the user must set following fields: + + + + Source: PCI address of the physical interface + + + + Type: dpdk + + + + Networking-type: dpdk + + + + Dpdk-type: kernel module that allow user space access of + physical interface + + + + Create an OpenVSwitch bridge (ovsbr0) on the + device that uses a DPDK interface, by selecting the uCPE device, then + from the top toolbar selecting: Configuration-> + OpenVSwitch -> Bridges -> + Add: + +
+ OVS bridge + + + + + + +
+
+ +
+ 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 uCPE device, then + from the top toolbar select: Configuration + -> OpenVSwitch -> Host Interfaces + -> Add: + + For SR-IOV mode, the user must set following fields: + + + + Source: PCI address of the physical interface + + + + Type: sr-iov + + + + Networking-type: srIov + + + + sriov-mode: adapter-pool + + + + sriov-num-vfs: the number of virtual functions to + create + + + +
+ SR-IOV Interface Type + + + + + + +
+
+ +
+ PCI Passthrough Interface Type + + For PCI Passthrough the user does not have to configure a + physical interface, instead simply select the PCI address and connect + it to a virtual port at the VNF instantiation step. +
+
+ +
+ Zero Touch Provisioning + + Zero-Touch Provisioning (ZTP) is an alternative to Manual + configuration. ZTP refers to the process by which, when a device starts + up for the first time, its initial configuration is pushed down by an + external management system, so that it is setup for proper operation + without additional manual intervention by an operator. + + A variety of operations can occur as part of ZTP such as initial + device setup, configuration of managed objects, etc. The goal is to set + up a device to the maximum possible extent without forcing an operator + to be physically present (initially) to manage the device. + + In order to create a static configuration supporting ZTP, the uCPE + Manager user needs to identify the Device ID of the + machine running NFV Access. + + During the automatic installation process when the + Automatic install step is reached, enter the option + menu Customize kernel parameters and set the + uCPE Manager IP address. Please check , for how to set the uCPE Manager IP + address at boot time. The Device ID will be listed in the installer + under the Customize kernel parameters menu. + + With the address parameter set, run + list_deviceID.sh after NFV Access is installed and + 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. + + This step needs to be done each time the uCPE Manager host + changes its IP address. + + + An offline configuration can be prepared in advance for the uCPE + Manager to setup the infrastructure on the device. + +
+ Offline Configuration + + The Offline Configuration subsystem is used to pre-populate a + configuration for a device that will be brought under management at a + future point in time. When creating an offline configuration store, an + optional Device ID can be specified - this ID + uniquely identifies the device to be initialized. + + Use the GUI (shown below) launched by the Applications + -> Offline Config -> Add menu: + +
+ Onboard New VNF + + + + + + +
+ + Specify the exact value of the Device ID in + the required field. This will tag the device needed for the initial + configuration provided by the offline configuration store. Choose + Merge as the Default Upload Method if you do not + want any boot configuration set on the device, to be wiped out. + Selecting Replace will set the entire device + configuration to match values in the offline configuration. + + After creating the Offline Config Store, access the device + through Applications -> offline config -> Config + App and provision it with the required initial + configuration. This operation mirrors what happens during regular + offline configuration. + + Now that the store has been provisioned successfully, it is + ready to send this configuration to the device when it first comes + online. +
+ +
+ Initial Communications + + There are two possible paths to this process, depending upon + whether or not NETCONF Call-Home functionality is used: + + + + If Call-Home is not enabled/supported, the uCPE Manager + creates a SSH session to the device over the port configured + through the Add Device process (default 830). + It then initiates NETCONF communications over this session. + + + + If the device uses Call-Home, it creates a socket connection + to port 4334 on the management system which runs the uCPE Manager. + The uCPE Manager then creates a SSH session over this socket and + initiates NETCONF communications as a client. + + + + Once communications with the device have been established, the + Device Manager will try and connect to it. +
+
+
+ +
+ VNF Management + + 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 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 + over time to an existing network infrastructure without having to perform + an expensive upgrade of the vnf manager itself. + + 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 flavour 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 + the toolbar, called VNF as shown in the screen-shot + below. + +
+ VNF Management + + + + + + +
+ + Selecting this menu item gives you the following options: + + + + Descriptors: Choosing this option lets you + manage the VNF Descriptors catalog. The vnf manager maintains a + catalog of all VNFs that can be instantiated and managed by the + system. Before you can use a new VNF, you need to onboard it into the + catalog. + + + + Instances: Choosing this option lets you + instantiate (or destroy) VNFs on a given uCPE device. + + + + Events: Choosing this option displays all the + events that are related to VNF lifecycle management. Whenever a VNF + state changes (i.e. it is + created/destroyed/stopped/started/paused/resumed), a state change + event is generated in the uCPE Manager. The screen shown when this + option is chosen displays all events in the system, filtered to show + only VNF state change notifications. + + + +
+ Onboarding a VNF + + The VNF descriptor catalog table provides a button that allows you + to onboard a new (third-party) VNF into the catalog. + +
+ Onboard New VNF + + + + + + +
+ +
+ Onboarding a VNF VM Image using the Onboarding Wizard + + How to onboard a VNF into the uCPE Manager + using the Onboarding Wizard + + + + Make sure the uCPE device is added and placed on the map in + the uCPE Manager. + + + + 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. + + + + If you click the VM Image radio button at the + top of the onboarding screen, you will get a pop-up containing fields + which you can fill, suppling the necessary information about the VNF. + After providing the information and pressing the onboard button, the + uCPE Manager will create the VNF package and onboard it. + +
+ Onboard a VNF using the Wizard + + + + + + +
+ + Main fields + + + + VM Image File. This is the + Virtual Machine image file for the VNF itself. Typically, it is a + QCOW image. Press Choose File and select the + image to be uploaded. + + + + Image Format. Select the + format which matches the image file. + + + + VNF Type Name. This is the + name that will be used to identify this VNF. It will be shown in + the VNF tables. + + + + Description. This field + contains any description you want to provide. It is only displayed + in the GUI tables in the uCPE Manager. + + + + Version. This is the + version of the current VNF that you are hosting. It's used to + distinguish this VNF from other versions of the same type. + + + + Memory in MB. This is the + 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. + + + + Num of CPUs. The number of + CPUs that will be dedicated to an instance of this VNF when + created. To determine the value for this field, consult the VNF + vendor. + + + + Storage in GB. How much + disk space to provide an instance of this VNF. To determine the + value for this field, consult the VNF vendor. + + + + Interfaces Tab + +
+ Interfaces Table + + + + + + +
+ + Click on the Interfaces tab to show the + Interfaces table. + + This table will contain the interfaces required by this VNF to + be configured, when creating an instance. Consult the VNF vendor to + determine which and how many are required. Each interface requires a + name, and optionally a description, used by the uCPE Manager + only. + + Cloud Init Tab + + Click the Clout Init tab to provide the + Clout-Init configuration. + +
+ Cloud-Init Tab + + + + + + +
+ + As shown in the picture above, there are three fields that need + to be populated: + + + + Cloud-Init + Datasource + + 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: + + + + None. If there is no + 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). + + + + ISO. Pre-cooked + cloud-init image. This image must be created by the user + according to VNF requirements. + + + + + + Cloud-Init Disk Type + + 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. + + + + Content Files Table + + The Content Files Table is ONLY used if + you choose 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. + + + +
+ Content Files Table example + + + + + + +
+ + Consult with the VNF vendor to determine what is required for + the VNF you are onboarding. + + 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 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 + + + + + + +
+ + Property Values + + numHugePages defines the number of huge + memory pages the VNF uses (for DPDK). +
+
+ +
+ Instantiating a VNF + + Once the VNF has been onboarded, you can instantiate a VNF on a + specific uCPE device. + + How to instantiate a VNF using the + Wizard + + + + Make sure the uCPE device is added and placed on the map in + the uCPE Manager. + + + + Make sure the VNF has been onboarded into the uCPE + Manager. + + + + Select from the top toolbar VNF -> + Instances + + + + Click the Add button. + + + + When prompted by the following UI, fill the required + fields. + + + +
+ Instantiating a VNF + + + + + + +
+ + There are a number of parameters to be supplied before the VNF can + be instantiated: + + + + Name. The name of the + VNF. + + + + VNF Type. The name of the + onboarded VNF. In this case VProbe VNF. + + + + Flavour. The flavour of VNF + (as specified in the descriptor) you would like to + instantiate. + + + + Device. The uCPE device on + which to instantiate a VNF, i.e. the uCPE device that will run this + VNF. + + + + Auto-start. If checked, the + VNF will be stopped and started when unreachable. When the device + reports that it has lost connection to the VNF, the uCPE Manager + will ask the device to terminate the VM and then start it up again. + If unchecked, only a Disconnected notification + will appear in the uCPE Manager. + + + + Hitting the Create button will cause the VNF to + be instantiated and run on the specified uCPE device. + + Selecting the VNF -> Events menu will show + that the VNF was created and a connection was established: + +
+ VNF Events menu + + + + + + +
+
+
-- cgit v1.2.3-54-g00ecf