Page History

Use the following steps The following procedures are provided to launch the SBC virtual machine (VM) on the VMware vCenter using the Open Virtual Appliance ( OVA ) package:

Creating the Template for the Virtual Machine

package and Guest OS customization.  The Customization Specification and the Day-0 config drive ISO are used to customize the SBC VM.

Prerequisites

• Download the SBC OVA software bundle. 
• Download the createConfigDrive-1.0.0.tar.gz tool.

Workflow

Create the Customization Specification

This procedure is based on VMware documentation. For more details, see VMware Docs.

Start

1. In the vSphere Client, select the Policies and Profiles option from the drop-down Menu.
2. Select New to create a new customization specification.
   Image Added
   
   
3. Create a name for the customization specification and select Linux as the Target guest OS. Click Next.
   Image Added
   
   
4. Select the option Use the virtual machine name in the Computer Name Window and provide the domain name. Click Next.
5. Select the appropriate time zone. Click Next.
6. In the Network window, select the Manually select custom settings option, add four NICs for the SBC, and edit the settings. Click Next.
   Image Added
   
   For the first NIC, select the Prompt the user for an IPv4 address when the specification is used option.
   Image Added
   
   
7. Provide the DNS settings if applicable.
8. Click Finish in the Ready to Complete window  to create the customization specification.

Create the SBC VM Template

Create a virtual template from the OVA package. 

Start

1. Download the SBC release software bundle, which contains the OVA Package.
AnchorISO FileISO FileThe software bundle contains the tarball createConfigDrive-1.0.0.tar.gz. Follow the steps in the wiki page Installation and Image Replacement Upgrade on KVM Using a QCOW2 File to create the config drive ISO file using this package.
2. Copy the ISO file (.iso) (created using the createConfigDrive utility) to the datastore of the VMware vCenter.

3. Create the virtual machine template from the OVA package using the option Deploy OVF Template on the vCenter.

   Caption

   0	Figure
   1	Create Virtual Machine Template

   Select the Deploy OVF Template option in vCenter.
   Image Modified
   
   
4. Select the SBC OVA package using via the URL or Local File as downloaded in Step 1.
   Caption

   0	Figure
   1	Select SBC OVA Package

   Image Modified
   
   
5. Enter the virtual machine template name, for example, SBCTemplate, host infoinformation, and other details, and then click Finish.
6. After you create the virtual machineWhen the Deploy OVF template task (virtual machine creation) is complete, right-click on the virtual machine, select Edit Settings to edit the guest OS version, and select Ubuntu Linux (64-bit) in the VM Options tab.
   Image Added
   
   
7. Click the Power On icon to power on the virtual machine and then select Template > Convert to Template.

   Caption
   0 Figure 1 Convert to Template
   Image Removed

Creating a New Virtual Machine from the Template

1. .
   Image Added
   
   

2. Log in to the SBC VM and run the/opt/sonus/sbx/scripts/configureSystemForCustomSpec.shscript to configure the SBC system to apply customization specifications as shown below:
   Image Added
   
   

   Info
   title Note
   This step is needed with the VMware vSphere 6.7 version as the Customization Script option is only available in the VMware vSphere 7.0 version.

   
   

3. Power off the virtual machine by clicking the Shut Down Guest OS icon.
   Image Added
   
   
4. When the virtual machine shuts down, right-click on the the virtual machine and select Template > Convert to Template.
   Image Added
   

Create the SBC VM from the Template

After creating the template, follow the steps below to create the SBC virtual machine.

Start

1. Create

1. a new virtual machine from the template

1. After you create the template, right. Right-click on the data center the template name and select New Virtual Machine  New VM from this Template.
   Image Added
   
   
2. Follow the steps in the template to create a new virtual machine from the template. 
   Caption0Figure1Create New Virtual Machine
   1. Specify the Virtual Machine Name. Click Next.
   1. 
      Image Modified
      

3. In Select a creation type, select the Deploy From Template option. A Data Center folder with a list of template options displays.

Select the template created previously from the data center options.

Caption
0 Figure 1 Select the Template
Image Removed

Specify the virtual machine name and then click Next. 

Caption
0 Figure 1 Provide Virtual Machine Name
Image Removed

In Select a computer resource, select the host and then click Next. 

Caption
0 Figure 1 Select Host (Computer Resource)
Image Removed

4. Select datastore for the host in Select storage and then click Next.

In Select deploy options, select Customize this virtual machine’s hardware and then click Next.

Caption
0 Figure 1 Select Deploy Options
Image Removed

5. Select CPU, Memory, Disk space, network adaptors for mgt0, ha, pkt0 and pkt1.

Click Add New Device to add the device for CD/DVD Drive. 

Caption
0 Figure 1 Add Device
Image Removed

6. For the CD/DVD Drive, select Datastore ISO File from the drop-down menu.
7. Navigate the datastore and select the ISO file (.iso) for the config drive already created and kept in the datastore for this VM.

If you are launching the SBC in "1to1" mode, add an additional hard disk for the DRBD device using the Add New Device option. 

Info
title Note
The minimum disk size for the additional disk is 35 GB.

8. Click Finish to create the VM.

After the VM is created, power on the VM. The VM boots up and the system configures itself using the config drive, and the SBC application starts.

Caption
0 Figure 1 VM Created
Image Removed

9. Use the default credentials (linuxadmin/sonus) to log in the Console.

1. 1. 
      
   2. Select the host and datastore as applicable. Click Next.
   3. For Select clone options, click Customize the operating system > Next.
      Image Added
      
      
   4. For the Customize guest OS section, select SBCSpec .
   5. For User Settings, select Network Adaptor 1 and provide the IP address/netmask/gateway for the management interface of the SBC as shown below:
      Image Added
      
      
   6. Click Finish to create the SBC virtual machine.
2. When the virtual machine is created, right-click on the virtual machine name and select Edit Settings to add an additional disk for the virtual machine.
3. In the Edit Settings window, select Add New Device > Hard Disk at the top right part of the window.
   Image Added
   
   

4. Edit the New Hard Disk size to change it to 40 GB and click OK to close the window.

   Info
   title Note
   40 GB is the minimum accepted disk size. Larger disk sizes can be selected based on client storage requirements for logs, CDRs etc.

   
   

5. Power on the virtual machine by clicking the Power On icon.
   Image Added
   
   
6. Check Events under the Monitor tab to apply customization specifications correctly.
   Image Added
   
   
7. When the virtual machine boots up, log in using the linuxadmin user or try to SSH into the VM using the linuxadmin user and management IP address on port 2024.  After logging in, change to the root user with the sudo su- command.
   Image Added
   
   Image Added

Create the SBC Config Drive ISO

Start

1. Create the config drive ISO for the SBC VM using the tool: createConfigDrive-1.0.0.tar.gz.  Refer to the README.md file inside the tarball for packages required to run the tool. The ISO file will be created inside the output directory as config_drive_<lower_case_ce_name>.iso (For example: output/config_drive_sbcvmwithcustomspec.iso). 
2. The tool can be run in two modes: --cli and --file mode. 
   • The --cli option provides screen prompts to enter the configuration data for the deployment.
   • The --file option requires you to provide a file, sbx.json, to the script.  The file must contain all the necessary configuration data in JSON format.  A sample input file for reference is available in the tarball input/sbx.json.    

Apply the VM Specific Config to the SBC VM

Start

1. When the ISO file is created in the output directory, copy the ISO file (.iso) to the VM and save the file to this path inside the VM: /mnt/sbxConfigDrive.iso.
2. Reboot the VM, and the SBC application will automatically configure with the configuration provided in the ISO file.