The Ribbon Virtual Network Function Manager (VNFM) is an ETSI standards-aligned virtualized application you can use to orchestrate and manage the lifecycle of SBC SWe deployments in an OpenStack cloud environment. VNFM provides an alternative to the use of Heat templates to deploy integrated SBC (I-SBC), media SBC (M-SBC), and signaling SBC (S-SBC) VM clusters.

VNFM processes a VNF Descriptor (VNFD) file to define the main properties and resources required to deploy a VNF. You "onboard" an SBC VNFD file into VNFM for your deployment type as part of a Cloud Service Archive (CSAR) package file. Sonus provides a script and VNFD template file you use to generate a CSAR package file for the type of SBC cluster you want to deploy. The VNFD file within the CSAR file cannot be edited; during orchestration, VNFM will prompt for allowed customizations such as the system name and associated EMS system details.

(SR-IOV only) - additional prerequisites and configuration steps required for SR-IOV deployment are preceded with this notation. If you are implementing SR-IOV interfaces, be sure to complete these steps.

Note:

Orchestration using VNFM does not support implementing a second management port for the SBC or the packet port redundancy feature.

Prerequisites

Prior to using VNFM to instantiate SBC VNFs: make sure to:

  • Download the required CSAR script file, VNFD template file and .qcow2 image file. Refer to the latest release notes.
  • Complete the procedure to generate a CSAR package file for the type of SBC instances you want to deploy. Refer to Creating a CSAR Package File.
  • Prepare the OpenStack cloud environment in which the VNF will be deployed. Refer to Pre-Instantiation Requirements of OpenStack.
  • (SR-IOV only) Make sure that the networks you created for the packet ports support SR-IOV and that you know the IP address for each SR-IOV interface.
  • Install VNFM and prepare it for operation. This includes adding clouds, tenants, and users to VNFM. Refer to VNFM Documentation for more information.
  • Instantiate the EMS system you plan to use to configure and manage your SBC clusters. Refer to EMS Documentation for more information.
  • Create the clusters you will use to manage and configure your SBC clusters in the EMS. Refer to Creating an SBC Cluster in EMS documentation.
Note

Due to a current issue with RHEL 7.5, the following procedure must be run once on any compute hosts where SWe instances which require multi-queue virtio interfaces will be deployed. These steps enable such instances to spawn. The procedure confirms that the failure to spawn is due to the underlying RHEL 7.5 issue and then provides steps to work around this issue.

  1. Spawn an SBC SWe instance which requires multi-queue virtio interface support. The instance will fail to come up.
  2. Log into the compute host as the root user.
  3. Change to the directory: /var/log/audit
  4. Open the audit.log file and confirm that the following denial is reported by SELinux:
    avc:  denied  { attach_queue }
  5. Use the following commands to update the local policy of SELINUX to allow spawning of instances with multi-queue enabled:
    audit2allow -a -M attach_queue
    semodule -i attach_queue.pp
  6. Retry spawning a multi-queue virtio interface instance. The instance should now come up.

Onboarding the SBC CSAR Package File

The CSAR file you created for your deployment must be onboarded on VNFM before you can orchestrate a new SBC cluster. Make sure the CSAR file is in a location accessible from VNFM. 

  1. Log into VNFM with credentials provided by the VNFM administrator.
  2. Click Settings > VNF Onboarding. The VNF Onboarding window opens.

    VNF Onboarding Window

  3. In the Upload the CSAR files area, click Browse to open a file window where you can locate and select the CSAR file.
  4. Click Upload. The package is added to the VNFs Available to Onboard list.
  5. Click Onboard adjacent to the package.
  6. Confirm the onboard procedure when prompted. The VNF package is now listed in the Your Onboarded VNFs list.

Deploying SBC VNFs

After the CSAR file is onboarded the SBC VNF can be deployed. Note that you must have previously created an OpenStack Glance image using the SBC application software .qcow2 file. Refer to Creating a Glance Image within the pre-instantiation requirements for OpenStack.   

  1. Log into VNFM if necessary.
  2. Click VNF Deployment. The Deploy Virtual Network Functions window opens.
  3. Click Deploy adjacent to the VNF you want to deploy. The VNF Deployment Wizard window opens with the VNF Config tab in view. 

    VNF Deployment Wizard - VNF Config Tab

  4. Enter a unique name for the instance in VNF Instance Name.
  5. Select a cloud from the Cloud Name drop-down list. The Tenant Name list appears.
  6. Select a tenant for the instance in the Tenant Name drop-down list. 

    Note:

    This tab also includes a Reuse Pre-allocated IPs check box which enables using the VNFM pre-allocated floating IP feature. Refer to Deploying a VNF with Preallocated Floating IPs for more information and procedures.

  7. Click the Network tab. 

    VNF Deployment Wizard - Network Tab

  8. Using the drop-down lists in the three network fields, select the names of the networks that you want to use as the management network and the two packet networks for the cluster. The networks must have already been defined in your environment. Refer to Creating Tenant Networks for more information. The lists contain the names of the existing networks in your environment. 
    (SR-IOV only) If you are implementing SR-IOV interfaces, make sure the signaling/media networks you select (Pkt0 and Pkt1) support SR-IOV.
  9. Click the Environment tab. The fields on this tab show user data required to instantiate the SBC as it is provided in the VNFD file. Editing values on this tab override the default values in the VNFD file allowing you to specify the values appropriate for your deployment.

    VNF Deployment Wizard - Environment Tab

  10. (Optional) To specify a specific zone for the instance, click Select a Zone and choose a zone from the list. The nova zone is selected by default.   
  11. Use the following table to edit the values in the VM Type section of the Environment tab, as necessary. Some values cannot be changed while other fields can be edited during orchestration, as noted in the table. Interface values (IF0 to IF3) can be edited, for example, if you need to specify VLAN IDs for your deployment. Take care to use the correct parameter names and maintain the syntax as shown. Refer to the Interface Definition Parameters Table for more information on the parameters that can be used to define the properties of an interface.

    FieldEditable?Description
    System NameyesUser-assigned name for the instance. You must enter a name.
    SBC PersonalitynoSpecifies an integrated (isbc), signaling (ssbc) or media (msbc) SBC deployment.
    The HA model selected in the VNFD filenoSpecifies an active_standby HA deployment or an N:1 HA deployment.
    Properties of IF0yesParameters associated with IF0. By default IF0 is configured as the management interface.
    Properties of IF1yesParameters associated with IF1. By default IF1 is configured as the HA interface.
    Properties of IF2yesParameters associated with IF2. By default IF2 is configured as the Pkt0 interface.
    (SR-IOV only) Edit
    the “PrefixVn:” and "VLANId:" values (shown below) to the appropriate values for your interface. Take care to only add the values and do not add additional characters or whitespace.
    Properties of IF3yesParameters associated with IF3. By default IF3 is configured as the Pkt1 interface.
    (SR-IOV only) Edit the “PrefixVn:” and "VLANId:" parameters (shown above) to the appropriate values for your interface. Take care to only add the values and do not add additional characters or whitespace.
    EMS UsernameyesEnter the username credentials to use when registering with the EMS.
    EMS PasswordyesEnter the password to use when registering with the EMS.
    EMS IP[0]yesEnter the IP address of the EMS-0 (primary) instance.
    EMS IP[1]yesEnter the IP address of the EMS-1 instance.
    EmsDownloadConfigyesSpecifies whether the cluster downloads configuration from the EMS. By default this value is set to True.
    EmsPrivateNodeParametersyesOptionally specifies an EMS cluster ID.
  12. Depending on the version of VNFM you are using, the Cloud Config Init Data section of the Environment tab (shown below) might not be populated. If the section is empty, then the initial contents must be manually copied into it. The default data to copy is located in the file: Scripts/*sbc-7.2-cloud-initdata.cfg. A copy of this file is located in the directory where the CSAR file was created and also within the contents of the CSAR package (after you unzip the CSAR). Open this text file, from either location, and copy its contents (including all leading spaces) into the Cloud Config Init Data section. This copy step is not required if the Cloud Config Init Data section is already populated.

    VNF Deployment Wizard - Cloud Config Init Data


  13.  In the Cloud Config Init Data section, replace the default public key with the public key of your own self-generated ssh key pair to be used for logging into SBC. The previous figure shows an SSH key for the "admin" user account. To generate the key, you can use the ssh-keygen command and use the contents of the id_rsa.pub file that it generates in your /home/<user>/.ssh directory to replace the default. Refer to man ssh-keygen for more information. You also have the option to enter passwords for the user accounts defined in this section. Take care to maintain the formatting of this section when you replace the default content. The data must be provided in a proper YAML format.

  14. (SR-IOV and Provider Networks only) For each interface, enter the required IPv4 or IPv6 address. Or, if this configuration has been done for a previous orchestration, you will have the option to select the name of a previous instance whose IP address configuration you want to reuse from the Select from the previous Orchestrations list.

    Manual IP tab for SR-IOV interfaces

  15. (Optional)  If your VNFD file supports manual port configuration and you want to select the port for the SBC VNF, click the Manual Ports tab and select the port. If you choose not to specify the neutron port, VNFM creates the port and attaches it to the VM. If your VNFD file does not support manual ports, the Manual Ports tab will show a message that manual port configuration is not required.
  16. (Optional). If your VNFD file supports Cinder storage device configuration (other than a Cinder boot device) and you want to specify a storage volume you created manually, click the Storage Volumes tab and select the volume disk type you created for the SBC on your cloud server. If you do not specify a storage volume, one is automatically created and attached to the instance during instantiation. If the VNFD file does not include a Cinder storage device then the Storage Volumes tab will show a message that storage volume configuration is not required. 
  17. Click Deploy VNF when you have completed your customizations. 

VNFM begins the process of orchestrating the SBC VNFs. VNFM opens the VNF Status window where you can watch the status progression as the VNFs are deployed. When the process is complete the VNF status changes to Ready.   

Note

 If you are deploying an N:1 M-SBC, the newly orchestrated VNF remains in a “degraded” state until you configure a Load Balancing Service (LBS). An alarm saying that the VNF cannot connect to VNFM may be triggered. However, once LBS is configured the active and standby roles for the VMs are determined and the VNF registers successfully with VNFM. Configuring LBS is a part of the initial configuration of an M-SBC. Refer to Configuring M-SBC.

After Orchestration

During orchestration VNFM creates basic security rules and a security group. These basic rules do not restrict access to and from the SBC nodes. If you have not already created the specific security rules required for your deployment, refer to the following page for the list of rules you should create: Creating Security Group Rules.

After orchestration the SBC nodes are created but have no associated configuration. Refer to Configuring SBC SWe on OpenStack using SBC Configuration Manager for procedures to configure the SBC. 

SR-IOV Interface IP Address Example

If you completed the steps required for implementing SR-IOV interfaces and you used the example input data shown in the previous procedure, the following figure shows the IP address assignments that would be made for the packet interfaces during orchestration. This output appears for the VMs within an VNF when you click on a VNF name within the VNF Status page. 

SR-IOV IP Address Example