WHMCS OpenVZ/Virtuozzo Module

WHMCS OpenVZ/Virtuozzo Automation Module

Specifications
Introduction
Installation
Prepare OpenVZ or Virtuozzo server (HN)
Usage OpenVZ/Virtuozzo module in WHMCS
- Server configuration
- Product / Service configuration
OS Selection Creation
Test
Manual order confirmation
Links

Specifications

WHMCS modules for OpenVZ and Virtuozzo are provided
Automatically create a VPS on a sale
Automatically suspend a VPS on non-payment
Automatically delete a VPS when a client closes a sevice
Automatically terminate a VPS
IP pools in WHMCS server configuration
Allows Client to select Operating System for VPS (Linux Only)
Windows and Linux Vritozzo Servers can be managed
Works with WHMCS 3.8 or higher
Cost $59.95/year
7-day demo

Introduction

Convenient automation
Actually two WHMCS automation modules are implemented: for OpenVZ and for Virtuozzo to sell OpenVZ or Virtuozzo virtual machines ("containers"). IP pools and server groops can be specified directly in WHMCS, so high automation level is reached with these WHMCS modules.
Low cost license
It's enough to buy one license for both modules per WHMCS server to use OpenVZ and Virtuozzo module.

Installation

Two ways to install:

using installer script in Linux
manual installation

Requirements

WHMCS
PHP 5 with xsl and curl modules
Ioncube loader (new version)

Installation with installer script

Installer script can be run on WHMCS for Linux server. This is recommended way to install OpenVZ/Virtuozzo module.

Upload installation script whmcsvz-X.Y.Z.run to WHMCS server (X.Y.Z is the product version e.g. 1.3.1). Use binary mode for uploading via FTP.
Login as root, make the script executable and run:
# chmod 700 whmcsvz-X.Y.Z.run
# ./whmcsvz-X.Y.Z.run

Installer will try to detect WHMCS directory using "locate" utility. You can select from the list of found directories or enter WHMCS path manually:

  Type full path to WHMCS directory:

  q -- quit installer
  1 -- /var/www/whmcs  (update)
  2 -- /var/www/whmcs1  (install)
  3 -- /var/www/whmcs2  (update: vzmod142ae89209ae865)

  WHMCS directory [/var/www/whmcs]: /var/www/whmcs1

Then you will be asked to enter license key:

  Type license key of OpenVZ/Virtuozzo module for WHMCS.
  License key: vzmod123abcd456def78

  Virtuozzo module X.Y.Z for WHMCS has been installed.
  OpenVZ module X.Y.Z for WHMCS has been installed.

Manual installation

Download Module from the website
Log into server FTP or SSH, change current directory to WHMCS
Go into modules/servers/ directory
# cd modules/servers/
Upload zip file to modules/servers/ directory
# wget http://helixdevelopment.com/dl/vzmod/1.3/setup/whmcvz_vX.Y.Z_php5.zip
where X.Y.Z is the product version e.g. 1.3.1.
Unzip files. Two directories "openvz" and "virtuozzo" will be created or updated.
# unzip whmcvz_vX.Y.Z_php5.zip
Remove zip file.
# rm -f whmcvz_vX.Y.Z_php5.zip
Edit the file config.inc.php in the directories "openvz" and "virtuozzo". Insert in quotes after $licensekey= the key given to you. The modules will not function if you do not do this.

Prepare OpenVZ or Virtuozzo server (HN)

Install OS templates for VPS
Create sample configurations. If sample configuration contains OS template name, you don't need to specify OS in WHMCS configuration.
It's convenient to setup'IP pools in WHMCS server configuration. However if you prefer to use native Virtuozzo IP pools, create IP pool on Virtuozzo HN. Native IP pools can not be configured in OpenVZ.

Usage Virtuozzo/OpenVZ module in WHMCS

Server configuration

Go into your WHMCS Server Configuration: WHMCS -> Setup -> Servers
Click "Add New Server" to create new OpenVZ or Virtuozzo server ("hardware node") configuration.
Click on Edit icon to edit OpenVZ or Virtuozzo server configuration.
Fill out the form:
- Name
- Hostname (optional)
- IP Address
- Maximum No. of Accounts should be specified to prevent overselling and provide VPS number balancing between servers.
- Primary/Secondary Name Server
- Type: select OpenVZ or Virtuozzo.
- Username of system administrator login (usually "root" for Linux or "administrator" for Windows)
- Password
- "Access Hash" field: IP pool should be specified here. One IP address or IP range can be used in each line of IP pool. Example:
  # IP range:
  10.0.2.68-10.0.2.77
  # One IP address:
  10.0.2.133
Save Changes

Product / Service configuration

This is the last thing we have to touch here, Next step involves setting up the products.

Go into your WHMCS Products/Services Configuration: WHMCS -> Setup -> Products/Services
Create a new product

This is the confusing part, Because WHMCS does not allow to select servers with Dedicated/ VPS Product Type, We have to choose Shared Hosting account, or Reseller Hosting Account. Rest of this page is self explanatory.
Modules Tab
- Select "Openvz" or "Virtuozzo" as Module Name
- Select your default server or srever group you want this package to provision.
- Sample Configuration: This is what you want VZ Module to provision. You can select which packages you want it to provision with create function.
- NS1/NS2: Name servers you want the machine to use when its provisioned.
- Save Changes.
Adding in some Custom Fields.
- Field Name = "VPS ID", Field Type = "Text", Field Validation = none, "Admin Only" is checked.
- Field Name = "VPS IP", Field Type = "Text", Field Validation = none, "Admin Only" is checked.
- Field Name = "Operating System", Field Type = "Drop Down", Select Options = comma separated OS list for VPS.
  This field is required in OpenVZ or Virtuozzo for Linux if sample configuration does not include OS. Also if you would like client to select OS during checkout procedure, mark "Show in Order Form" checkbox.

OS Selection Creation

We've had more than a few people ask about allowing the customers to select which OS they want created. We've done this, and updated our files.

1. There is a new config.inc.php file. It looks like this.

<?php
# Get Variables from storage (retrieve from wherever it's stored - DB, file, etc...)
$licensekey = "vzmod123ab45678cdef9";

/** DO NOT EDIT BELOW THIS LINE **/
$os_templates = array (
        "CentOS 4 32bit"        =>      "centos-4-x86",
        "CentOS 4 64bit"        =>      "centos-4-x86_64",
        "CentOS 5 32bit"        =>      "centos-5-x86",
        "CentOS 5 64bit"        =>      "centos-5-x86_64",
        "Debian 5 32bit"        =>      "debian-5.0-x86",
        "Debian 5 64bit"        =>      "debian-5.0-x86_64",
        "Debian 6 32bit"        =>      "debian-6.0-x86",
        "Debian 6 64bit"        =>      "debian-6.0-x86_64",
        "Fedora Core 11 32bit"  =>      "fedora-core-11-x86",
        "Fedora Core 11 64bit"  =>      "fedora-core-11-x86_64",
        "RedHat EL 5 32bit"     =>      "redhat-el-5-x86",
        "RedHat EL 5 64bit"     =>      "redhat-el-5-x86_64",
        "RedHat EL 6 32bit"     =>      "redhat-el-6-x86",
        "RedHat EL 6 64bit"     =>      "redhat-el-6-x86_64",
        "SuSE 11.3 32bit"       =>      "suse-11.3-x86",
        "SuSE 11.3 64bit"       =>      "suse-11.3-x86_64",
        "SuSE 11.4 32bit"       =>      "suse-11.4-x86",
        "SuSE 11.4 64bit"       =>      "suse-11.4-x86_64",
        "Ubuntu 9.04 32bit"     =>      "ubuntu-9.04-x86",
        "Ubuntu 9.04 64bit"     =>      "ubuntu-9.04-x86_64",
        "Ubuntu 10.04 32bit"    =>      "ubuntu-10.04-x86",
        "Ubuntu 10.04 64bit"    =>      "ubuntu-10.04-x86_64",
);
?>

With OpenVZ/Virtuozzo they use their template name (For Example, "centos-5-x86_64"). We did it this way so it can translate "CentOS 5 64bit" to "centos-5-x86_64" This will allow your customers to choose which OS they want when they purchase an item on your site.

Windows: Virtuozzo for Windows does not allow templates from one to the other. If your hardware node is Windows 32 bit Enterprise ALL of your containers are going to be Windows 32 bit Enterprise. There is no way to change this in windows.

2. Setting up products and services.

You will notice here, we named the Custom Field "Operating System", Field Type "Drop Down", and Field Options "CentOS 4 32bit, CentOS 4 64bit, CentOS 5 32bit, CentOS 5 64bit, Fedora 9 64bit" (Comma separated OS list).

NOTE: Field options have to match the config.inc.php file. If your template name in config.inc.php is "CentOS 5 32Bit", It has to match EXACTLY in the Field Options. (caps matter) You also have to remember that if you want to use this option. In Virtuozzo you have to go into your sample config, you have to remove the Application templates, save, then set the OS to "None".

We are working on a work around to be able to allow you to select this stuff given the OS they want. But right now this is a problem with Virtuozzo, and how it handles ez templates with given the operating system.

Test

This really concludes everything.

Lets do a test run to see if it works!

Add the product to your cart.
Checkout

Our Container was created and works.

Manual order confirmation

If auto-configuration is not setup for a product or something prevents it after order creation and payment, the order takes Pending status. Such orders require manual intervention to be accepted.