KVM Environment

Introduction

Different VPS providers may support different installation images for KVM. E-MetroTel currently only provide QCOW2 images.

Using Luna Node as an example of a VPS provider that supports QCOW2 images, this page describes the procedure to create a UCx virtual machine using the Luna Node management interface.

Pre-Requisites

  • An account with Luna Node
  • Credit to create and run virtual machines
  • One UCX-KVM asset must be purchased for each virtual machine that is to be started

Procedure

Step 1 - Create a Security Group for UCx Virtual Machines

You need at least one security group that will be used for UCx virtual machines.  You can create several security groups that will be used for different types of customers (e.g., customers who use only SIP phones and SIP trunks, customers who use only Nortel phones and SIP trunks, etc.).

To create a security group for UCx VM in the Luna Node management interface, perform the following:

  1. Login to the Luna Node management interface
  2. Press the Security Groups link from the left column
  3. In the Add a security group section, enter the desired region (e.g., Toronto) and a group name (e.g., UCx)
  4. Press the Manage button of the newly created security group
  5. Use the Add a new rule button to add rules listed in the table below
Traffic direction Type Protocol Port Range Label
Ingress IPv4 TCP 22 SSH
Ingress IPv4 TCP 443 HTTPS
Ingress IPv4 UDP 5060 SIP
Ingress IPv4 UDP 7000 UNISTIM
Ingress IPv4 UDP 10000-13999 RTP
Ingress IPv4 TCP 21324 WebRTC
Ingress IPv4 TCP 5038 AMI

Note: Do not delete default Egress rules automatically defined when you create the new security group!

The following diagram is an example of rules that should be defined in a security group for UCx systems.

Note: If you do not plan to use SIP phones, do not create the SIP rule (registration based SIP trunks do not need the SIP rule). If you plan to use SIP phones, it is recommended to change the default SIP port value of 5060 to a different value (e.g. 5090) for security reasons.  If you change the SIP port to a non-default value, configuration on the UCx and SIP phones must also be changed to use that port number.

Step 2 - Download UCx KVM Image

To download a UCx KVM image to the Luna Node management interface, perform the following:

  1. Login to the Luna Node management interface
  2. Press the Images link from the left column
  3. Press the Add a new image button, and then
    • Select the desired region (e.g., Toronto)
    • Enter a name for the image (e.g. UCx 5.0)
    • Select QCOW2 as the Disk Format
    • Enter the link to the UCx KVM image (provided by E-MetroTel) in the Location field
    • Press the Add image button to download the image
  4. Wait for the image download to complete (i.e. the image status becomes Active)

Note: UCx VM images are time limited (they can be used for 2 to 4 weeks from the time of the image download).  If you already have an image older than 2 weeks, you should delete the old image and download an up-to-date image.

Step 3 - Create Volume

Luna Node supports regular VM instances and volume-backed VM instances.  To minimize potential downtime and to achieve maximum flexibility, the use of volume-backed instances is recommended.

To create a volume for a UCx virtual machine, perform the following:

  1. Login to the Luna Node management interface
  2. Press the Volumes link from the left column
  3. Select the region to which you downloaded the UCx KVM image in Step 2 above (e.g., Toronto)
  4. Enter a volume name (using the same name for the volume and the VM instance is recommended as a simple way to create a logical association of the volume and the instance) - e.g., UCx001
  5. Enter the size of storage provided by the plan you intend to use for the VM instance.  If you have not decided what plan you want to use yet, you can enter 20 (20 GB is the minimum size required by the UCx KVM image).
  6. In the Source list box, scroll all the way down, and select the image you downloaded in Step 2 above (e.g. UCx 5.0)
  7. Press on the Create volume button to create the volume
  8. Press the Manage button of the newly created volume to open the volume management page.  Refresh the page after a minute or two to check if the download and creation of the image is complete (the image status should be available).

Note:  You can return to the volume management page to increase the volume size later after you select a plan for the VM and know the size of the disk storage included with the selected plan.

Step 4 - Create Virtual Machine 

To create a new UCx virtual machine, perform the following:

  1. Login to the Luna Node management interface
  2. Press the link Create VM from the left column
  3. Select the region where you created the volume in Step 3 above (e.g., Toronto)
  4. Enter the following information:
    • Enter a name you want to use for the new virtual machine in the Hostname field (e.g. UCx001)
    • Select the desired plan - e.g. SSD 1024 (UCx VMs require at the very least 1024 MB RAM,  2 vCPU and 20 GB storage).  Check the Server Requirements for UCx 5.0 Software to select a plan with sufficient resources for your needs.
    • In the Image section, select the My Volumes tab and then select the volume you created in Step 3 above (e.g. UCx001)
    • In the Security Groups section, select the security group created in Step 1 above
    • Press the Create virtual machine button to launch the virtual machine instance
  5. Press on the Manage button of the newly created virtual machine to open the VM management page
  6. Refresh the page in a few seconds - the status will be Online and the External IP field will contain the external IP address of your new UCx virtual machine
  7. Use the external IP address to login to the UCx Web-based Management utility:
    • From your browser, type https:// followed by the external IP address of the virtual machine
    • Login with the UCx default admin account credentials
  8. IMPORTANT: Immediately change the password of the admin user!  If you do not change the password, hackers could discover your UCx VM and compromize the system using the default password!
  9. Login to the UCx Web-based Management utility again using the new admin account password
  10. Navigate to the System - Updates page and update the software to the latest version

Step 5 - Obtain UCx License

To obtain a license for your UCx virtual machine, perform the following:

  1. Login to the UCx Web-based Management utility
  2. In your browser, type https:// followed by the external IP address of the virtual machine
  3. Login using the admin account credentials
  4. Navigate to the System - Licenses page
  5. Copy the entire host ID string
  6. Send an email to activate@emetrotel.com with the following information:
    • Name of your company
    • UCX-KVM asset number that is to be used for the UCx virtual machine
    • Paste the entire host ID string copied from the licenses page
  7. Once your receive the license string from E-MetroTel, follow instructions on the Enter License page to install the new license
Page Tags: 
virtualization
KVM
virtual machine