OVH Public Cloud For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About OVH Public Cloud For WHMCS

OVH Public Cloud For WHMCS is a module which allows you to automatically provision virtual servers to your customers.

The great advantage of this module is the fact that customers can order and manage virtual servers, backups and many more in your own WHMCS client area.
Additionally, it allows you to conveniently overview and manage all the customers' servers.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Server
✔ Change Package - Supports Configurable Options
✔ View Server Status And Details
✔ View Interface Details
✔ View List Of Scheduled Tasks
✔ Configure Client Area Features Per Product
✔ Define Backup Quantity Limit
✔ Set Security Groups
✔ Enable Backups Routing
✔ Run Extended Connection Test
  • Client Area Features:
✔ View Server Status And Details
✔ Start/Stop/Pause/Unpause/Resume/Rebuild Server
✔ Reboot Server - Soft/Hard
✔ Access noVNC Console
✔ Create/Restore/Delete Backups - Supported By VPS Not Using Cinder Volumes
✔ Download Public & Private SSH Keys
✔ View List Of Scheduled Tasks
  • General Info:
✔ Automated Generation Of SSH Keys - Public SSH Key Is Injected To VM Automatically
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7
  • Available Configurable Options:
✔ Flavor
✔ VM Image
✔ IP Addresses
✔ Backups Files Limit

Installation and Configuration

This tutorial will show you how to successfully install and configure OVH Public Cloud For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to your client area and download the module.
OPC1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

OPC2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Ertr.png
4. When you install OVH Public Cloud For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/OVHPublicCloud/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

OPC3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen.
You can find your license key at your client area → 'My Products'.

OPC4.png
6. Next step is setting up a cron job (each 5 minutes suggested).

Use cron job below but switch 'your_whmcs' with your root WHMCS path.

php -q /your_whmcs/modules/servers/OVHPublicCloud/cron/cron.php

Configuration of Server

7. Now, we will show you how to configure a new product.

Go to the 'Setup' 'Products/Services' 'Servers' and press 'Add New Server'.

OPC5.png
8. Next, enter your server name, hostname, please use the default hostname which is: 'https://auth.cloud.ovh.net/v2.0'.

Then type in username, password and admin tenant ID.
Choose 'OVHPublicCloud' from a dropdown menu and press 'Save Changes' .

OPC6.png
9. After you configure your server correctly, you can check connection with OVHPublicCloud server.

Simply edit previously created server and press 'Test Connection' as shown on the screen below.

OPC7.png
10. It is time to create a server group. To do so, click on 'Create Server Group' .
OPC8.png
11. Enter name, click on your previously created server, press 'Add' and afterwards 'Save Changes' .
OPC9.png

Configuration of Product

12. In order to create and configure a product, go to the 'Setup' 'Products/Services' 'Products/Services'.

Click on 'Create a New Group' .

OPC10.png
13. Enter product group name and press 'Save Changes'.
OPC11.png
14. When you have a product group, you can create your product.

To create a product click on 'Create a New Product'.

OPC12.png
15. Afterwards, choose your product group and type from dropdown menus, enter your product name and press 'Continue'.

'Product Type' should be set to 'Hosting Account'.

OPC13.png
16. Now, go to the 'Module Settings' section, choose both 'OVHPublicCloud' and your previously created server group from dropdown menus.

Next, press 'Save Changes'.

OPC14.png
17. First of all selecting 'Default Tenant'.

'Check access' should return 'OK' if the permissions are set up correctly.

OPC15.png
18. Afterwards, configure network settings. Choose 'Fixed Network', 'Floating Network' and 'Default Number Of IP Addresses'.

You can set up network in two ways. Find more information about the configuration here.
We will set up network without floating IP address as presented on the following screen.
Additionally, choose the number of IP addresses assigned to a product by typing it into 'Default Number Of IP Addresses'.

OPC16.png
19. At this step, you can configure backups.

Mark 'Backups Routing' checkbox if you want to replace the oldest backup with the newest one when backups file limit is reached.
Afterwards, enter limit of backup files into 'Default Backups Files Limit'.

OPC17.png
20. Mark security group from 'Use Security Groups'.

If you wish to use SSH keys, leave 'Inject SSH Key' marked (virtualization must support 'Inject File' feature).
Important:
1. It is recommended to leave 'Delete SSH Private Key' marked.
2. If you leave 'Use Volumes' selected, then 'Backups' option will be disabled!

OPC17 1.png
21. Finish through selecting features that will be available in the client area.

Mark checkbox next to a feature in order to enable it.

OPC18.png
22. Select 'Default Flavor' and 'Default VM Image'.

'Default Flavor' defined resources assigned to VM while 'Default VM Image' allows you to choose VM image used to create new VM.
Press 'Save Changes' when ready.

OPC19.png
23. Do not forget to generate default configurable options. Only then your clients will be allowed to adjust the virtual machine when placing an order.
OPC20.png
Congratulations! You have just finished the installation and configuration of the product!

Management

OVH Public Cloud For WHMCS allows your customers to manage their virtual machines via client area in your WHMCS system.

You can monitor and manage each product from your WHMCS admin area.
1. Configurable options - view current VPS resources and change VPS specifications through changing configurable options and pressing 'Change Package'.
2. Module commands - manage VPS status.
3. VPS details - refresh them through pressing 'Refresh Details' icon.
4. Scheduled tasks status can be found in this table.
5. In marked custom fields you can find IDs of VM and private flavor.

OPC24.png

Ordering

Owing to configurable options, you are able to offer product which your clients can tailor according to their needs.

Additionally, you are able to set up pricing for each configurable option, which make your offer even more competitive.
Important: VPS is not created immediately after 'Create' action, therefore, it is wise to inform your clients about the delay.

OPC25.png

Client Area

Client area interface of OVH Public Cloud VPS should look like the one on the screen below.
As you can see, control panel contains useful options needed for managing VMs.

Module allows your customers to easily start/stop, pause/unpause, soft reboot, hard reboot and reset network of their servers.
Clients can also rebuild the server, access noVNC console, create a backup and view scheduled tasks.
Under 'Tasks', your customers can view all requested tasks that were not completed yet.

OPC26.png

Rebuild

Rebuild feature allows your clients to change server image.

Press 'Rebuild' button as shown on the following screen to continue.

OPC27.png
To reinstall your server, choose an image and press 'Rebuild' button.
OPC28.png

noVNC Console

One of the most interesting functionalities is access to a noVNC console where your clients can remotely manage their servers.

To access it, simply press on the 'Console' button.

OPC29.png
noVNC consoloe is a browser based VNC client. It was implemented using HTML5 Canvas and WebSockets.
OPC30.png

Backups

Your customers can also create backup of VPS. To do so, press 'Backups' button.

Note: Backups are available only if 'Use Volumes' option in 'Module Settings' is disabled.

OPC31.png
Now, type in the backup name and press 'Backup Now' button.
OPC32.png
To restore VPS from backup, simply press 'Restore' button next to it.
OPC33.png

SSH Keys

Due to limitation in WHMCS product creation process, OVH Public Cloud For WHMCS generates SSH key pair automatically.

Public SSH key is automatically implemented into a VM while private key can be downloaded from the client area.
In order to download Unix private SSH key press 'Download Private Key'/
You can easily convert your private Unix key(.rsa) to private PuTTY key(.ppk) using 'PuTTYgen'.

OPC34.png
Public SSH key on the other hand, can be downloaded as many times as your client will need it.

Press 'Download Public Key' as shown on the following screen to save it on your disk.

OPC35.png

Network Configuration Cases

OVH Public Cloud For WHMCS allows you to set up two types of network.

The first one is a network without floating IP address.
To set up this type of a network, choose 'Public' as 'Fixed Network' and 'Disabled' as 'Floating Network' in 'Module Settings'.
On the following screen you can view an exemplary topology of such network.

OPC36.png
The second type of network is a network with floating IP address.

Select 'Shared Network' as 'Fixed Network' and 'Public' as 'Floating Network' in 'Module Settings'.

OPC37.png

Configurable Options

In case standard configuration does not suit your needs, you can adjust it through configurable options.

To do so, go to 'Setup' 'Products/Services' 'Configurable Option' and press edit button next to configurable option used by your product.
Its name is 'Configurable options for your_product_name'.

OPC38.png
Here you can view the products that this configurable option group is assigned to.

Now we will show you how to edit options. Let's say that you want to add an option to order VPS with 5 IP addresses allowed..
To do so, edit 'ipAddresses|IP Addresses' by pressing edit button as shown on the screen below.

OPC39.png
You should see a popup window, make sure that your browser does not block it.

To add a new option, enter it in a textbox under all other options. If you want to replace it with option you currently have, simply edit its textbox.
Next, press 'Save Changes'.

OPC40.png

Tips

1. Due to the fact that some requests may take time to be completed, we implemented 'Scheduled Tasks'.

Tasks visible at 'Scheduled Tasks' are subsequently performed by regular cron jobs.
A full list of tasks supported by 'Scheduled Tasks' are: create, terminate, change package, remove IP address and remove backup.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. In case of persisting connection problems, please make sure you have the following ports open:
35357, 8774, 9292, 5000, 8777, 8776, 9696


Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social